Static Extraction of Hierarchical Runtime Object Graphs...

Static Extraction of Hierarchical Runtime Object Graphs –Tool Demonstration

Marwan Abi-Antoun Jonathan Aldrich

School of Computer Science

Carnegie Mellon University

Object-Oriented Code vs. Runtime Structure

“An object-oriented program's runtime structureoften bears little resemblance to its code structure.

The code structure [...] consists of classes in fixed inheritance relationships.

A program's runtime structure consists of [...]

networks of communicating objects [...]

Trying to understand one from the other is like trying

to understand the dynamism of living ecosystems from the static taxonomy of plants and animals, and

vice versa.” (Gamma et al., 1994)

Object Diagram: a diagram of object structures which shows object instances exclusively.

Source: E. Gamma, R. Helm, R. Johnson, and J. Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley, 1994. (CD-ROM edition)

ToolButton

SelectionTool

JavaDrawApp

fListener

PaletteIcon

ToolButton

SelectionTool

JavaDrawApp

fListener

ToolButton

SelectionTool

JavaDrawApp

fListener

ToolButton

Undoable

SelectionTool

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

AbstractTool$EventDispatchermyEventDispatcher

Object

SelectionTool

myUndoActivity

myDrawingEditorfChild

SelectionTool

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

AbstractTool$EventDispatcher

myEventDispatcher

SelectionTool

myUndoActivity

myDrawingEditor

ToolfChild

myUndoActivitymyDrawingEditor

fChild

myEventDispatcher

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

myEventDispatcher

JavaDrawApp

fSelectedToolButton

fDefaultToolButton

Animator

fAnimator

DrawingView

Vector

mdiListeners

JComponent

desktop

JTextField

fStatusLine

EventListenerListlistenerList

AnimatablefAnimatable

fDefaultToolButton

fSelectedToolButton

fAnimator

Vector

mdiListeners

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

fAnimator

Vector

mdiListeners

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

mdiListeners::elts

fAnimator

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

mdiListeners::elts

fAnimator

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

fAnimator

mdiListeners

desktop

fStatusLine

listenerList

Rectangle

UndoableHandle

DrawingEditor

fSelectGroup

fAnchorHandle

myDrawingEditor

myEventDispatcher

DragTrackermyWrappedTool

fSelectGroup

fAnchorHandle

myDrawingEditor

myWrappedTool

fSelectGroup

fAnchorHandle

myDrawingEditor

myEventDispatcher DragTracker

myWrappedTool

fSelected

fNormal

fPressed

DimensionfSize

Vector

Object[]elementData

myRegisteredListeners

myObservedTool

ToolListener

myRegisteredListeners::elts

myObservedTool

myUndoActivity

myDrawingEditor

myEventDispatcher

Figure

fAnchorFigure

listenerList[]

NULL_ARRAY[]

Tool support to extract runtime structure less mature

• Low-level objects

• No architectural abstraction

• Some analyses incorrectlyhandle aliasing

JavaDrawApp,

DrawingEditor,

represent one

runtime object.

Output of Womble on JHotDraw (15 KLOC)

Key Insight

Ownership domain annotations enable the extraction of sound hierarchical object graphs using static analysis.

Extracting sound hierarchical object graphs using static analysis

• Why static analysis?• Dynamic analysis shows object graphs for

a few program runs, not all

• Why sound?• To be most useful, show all objects and

relations that could exist at runtime

Controller

figureChangeEvent(+):DrawingChangeEvent

fPoly(+):Shape

textFigure1(+):Drawing

myBorderOffset(+):Point2D

polyLineConnector(+):Connector

fStartDecoration(+):AbstractLineDecoration

fLocator(+):Locator

undoableHandle(+):Handle

myDrawingView(+):DrawingView

myUndoableActivity(+):UndoableAdapter

myAlignment(+):Alignment

myUndoManager(+):UndoManager

fStorageFormatManager(+):StorageFormatManager

myDefaultStorageFormat(+):StorageFormat

fAnimator(+):Thread

autoscrollInsets(+):Insets

app(+):DrawingEditor

fDefaultToolButton(+):ToolListener

textTool(+):Tool

bufferedUpdateStrategy(+):Painter

constrainer(+):PointConstrainer

menu(+):CommandListener

cmd(+):Command

system:Main

Extracting sound hierarchical object graphs using static analysis

• Hierarchical graphs• Flat graphs do not

provide architectural abstraction or scale

ToolButton

SelectionTool

JavaDrawApp

fListener

PaletteIcon

ToolButton

SelectionTool

JavaDrawApp

fListener

ToolButton

SelectionTool

JavaDrawApp

fListener

ToolButton

Undoable

SelectionTool

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

Object

SelectionTool

myUndoActivity

SelectionTool

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

myEventDispatcher

SelectionTool

myUndoActivity

myDrawingEditor

ToolfChild

fChild

myEventDispatcher

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

myEventDispatcher

JavaDrawApp

fSelectedToolButton

fDefaultToolButton

Animator

fAnimator

DrawingView

Vector

mdiListeners

JComponent

desktop

JTextField

fStatusLine

fDefaultToolButton

fSelectedToolButton

fAnimator

Vector

mdiListeners

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

fAnimator

Vector

mdiListeners

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

mdiListeners::elts

fAnimator

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

mdiListeners::elts

fAnimator

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

fAnimator

mdiListeners

desktop

fStatusLine

listenerList

Rectangle

UndoableHandle

DrawingEditor

fSelectGroup

fAnchorHandle

myDrawingEditor

myEventDispatcher

fSelectGroup

fAnchorHandle

myDrawingEditor

myWrappedTool

fSelectGroup

fAnchorHandle

myDrawingEditor

myWrappedTool

fSelected

fNormal

fPressed

DimensionfSize

Vector

Object[]elementData

myObservedTool

ToolListener

myObservedTool

myUndoActivity

myDrawingEditor

myEventDispatcher

Figure

fAnchorFigure

listenerList[]

NULL_ARRAY[]

Demonstration Outline

• Ownership annotations• Adding annotations

• Typechecking annotations

• Runtime structure• Extraction tool

• Real-World Example• JHotDraw

• Additional material• Static analysis

Ownership Domains

Ownership domains[Aldrich and Chambers, ECOOP’04]

• Each object defines conceptual groups (ownership domains) to hold its state

• Separate object’s internals from object’s boundary (accessible to outside)

• Ensure private state not leaked

• Distinguish different “subsystems” within object

Example: Sequence

head iterator

@Domains@Domains@Domains@Domains({“ownedownedownedowned”, “itersitersitersiters”})

classclassclassclass Sequence {

@Domain@Domain@Domain@Domain(“ownedownedownedowned”) Cons head;

public public public public @Domain@Domain@Domain@Domain(“itersitersitersiters”)

Iterator iterator() {return new return new return new return new Iterator(head);

Object

LEGEND

• Sequence has private state (head)• Should not be accessible to outside

• Sequence has iterators that are accessible to outside• Can also access private state

seq: Sequence

Sequence Code Structure

Sequence: Private Domain

• Each object has one or more domains• E.g., Sequence declares domains owned and iters

• Each object is in exactly one domain• E.g., head in domain owned; iterator in domain iters

seq: Sequence

Object

LEGEND

Domain

Sequence: Public Domain

• Each object has one or more domains• E.g., Sequence declares domains owned and iters

• Each object is in exactly one domain• E.g., head in domain owned; iterator in domain iters

head iterator

owned iters

seq: Sequence

Object

Domain

LEGEND

Sequence Runtime Structure

object:Object

it:Iterator

cons:Cons

seq:Sequence

system:SequenceClient

Sequence Runtime Structure

• Collapse Sequence’s sub-structure

statelist

object:

Object

seq(+):

Sequencesystem:

SequenceClient

Encapsulation and Containment

(1) Strict encapsulation(private domain)

(2) Logical containment(public domain)

seq:Sequence

head:ConsX

seq:Sequence

it:Iterator

Annotation Tool Support

• Use Java 1.5 annotations

• Typechecker uses Eclipse JDT

• Warnings in Eclipse’s problem window

Demo: Checking Sequence

• Cannot return head of list• Head of list in private domain

• Stronger than making field private

• Cannot nullify head of list• Stronger than Java visibility (e.g., private)

• Iterate over list• Iterator in public domain

Ownership Domain Parameters

@DomainParams@DomainParams@DomainParams@DomainParams({“elemselemselemselems”})classclassclassclass Sequence {@Domain@Domain@Domain@Domain(“ownedownedownedowned<elemselemselemselems>”)Cons head;

…………}

@DomainParams@DomainParams@DomainParams@DomainParams({“elemselemselemselems”})classclassclassclass Cons {

@@@@DomainDomainDomainDomain(“elemselemselemselems”) Object obj; @@@@DomainDomainDomainDomain(“ownerownerownerowner<elemselemselemselems>”) Cons next;

• To share objects across domains• Add domain parameter to hold elements in list• Implicit domain parameter “owner”

(Same as me, a.k.a. “peer” or “same”)

ownedclientobjects

seq : Sequence

Demo: Annotating Listeners

(Iteration 1)

Listeners Example

• Listeners tricky in object-oriented code

• Reuse annotated Sequence• Disguised as ArrayList

Listeners Code Structure

interfaceinterfaceinterfaceinterface Listener { }

classclassclassclass BaseChart implementsimplementsimplementsimplements Listener {

List< Listener> listeners;}classclassclassclass BarChart extendsextendsextendsextends BaseChart { }

classclassclassclass PieChart extendsextendsextendsextends BaseChart { }

classclassclassclass Model implementsimplementsimplementsimplements Listener {List<Listener> listeners;}

classclassclassclass Main {Model model;BarChart barChart;PieChart pieChart;

Class diagram by Eclipse UML.

Demo: Listeners example

• Tool to add default annotations• Declare owned private domain• Private field à place in domain owned

• owned: object fully encapsulated

• String à mark shared• shared: shared persistently or globally

• Method parameter à mark lent• lent: temporary alias within method

• Not a smart inference tool!

Standard and third-party libraries

• Annotate external code• Ideally, library provider adds annotations• Annotations shared amongst authors

• Only annotate parts of library in use

• Wizard to generate skeleton XML file

Listeners Runtime Structure (version 1)

• Listeners at the top-level

DOCUMENT VIEW

model:

listeners:

List<Listener>

barChart:

BarChart

pieChart:

PieChart

listeners:

List<Listener>

Runtime Structure

Code Structure – Take 1

Class diagram extracted by Eclipse UML.

Code Structure – Take 2

}Class diagram by AgileJ.

• Who points to who?

• Do not distinguish between conceptually different instances of same class

• Extra details: abstract classes, interfaces, etc.

• No hierarchy

Code vs. Runtime Structure

DOCUMENT

Class diagram extracted by AgileJ.

Demo: Annotating Listeners

(Iteration 2)

Change annotations

• Instance encapsulation

• May require changing code to avoid representation exposure, e.g., • Return copy instead of alias to internal List• Pass object linearly

Listeners Runtime Structure (version 2)

DOCUMENT

listeners:List<Listener>

barChart:BarChart

pieChart:PieChart

model:Model

listeners:List<Listener>

pieChart.OWNED != barChart.OWNED

Abstraction by Ownership Hierarchy

• Push secondary objects underprimary objects using

(1) Strict encapsulation(private domain)

(2) Logical containment(public domain)

seq:Sequence

head:ConsX

seq:Sequence

it:Iterator

Hierarchy Provides Abstraction

• Can collapse object sub-structure

• Summary edges account for hidden objects

DOCUMENT

model(+):Model

barChart(+):BarChart

pieChart(+):PieChart

Tool Features

• Control projection depth

• Collapse/expand substructure• Selected domain or • Selected object

• Summary edges

• Elide private domains

• Control object labeling

Case Study: JHotDraw

Extract As-BuiltRuntime Graph

AnnotationsAnnotations

1. Add

3. Refine and iterate

CodeCode

Annotation/Extraction Process

2. Control Display4. (Optional) Change

code and refine

Annotation/Extraction Process

1. Choose top-level domains

2. Achieve desired number of objects in top-level domainsa) Push secondary objects under primary objectsb) Use abstraction by types to merge objects

3. Achieve appropriate visual detaila) Collapse or expand substructure of objectsb) Change projection depth across all objects

ConnectionFigure

Connector

DecoratorFigure

Handle

NullHandle TrackHandle

Locator

Painter

PointConstrainer

DrawingEditor

DrawingView

CreationTool SelectionToolHandleTracker

Figure

Drawing

CompositeFigure

JHotDraw: Code Structure

Manually generated UML Class Diagram for JHotDraw [Riehle, Thesis 2000].

Controller

ConnectionFigure

Connector

DecoratorFigure

Handle

NullHandle TrackHandle

Locator

Painter

PointConstrainer

DrawingEditor

DrawingView

CreationTool SelectionToolHandleTracker

Figure

Drawing

CompositeFigure

JHotDraw: Model-View-Controller (MVC)

JHotDraw: Adding Annotations to Code

File: Main.java

JHotDraw: “30-second Architecture”

• Hide contents of domains• Dotted edges summarize field references

• Interestingly: no callback from M to C

Controller

JHotDraw: “30-minute Architecture”

Controller

fPoly(+):Shape

textFigure1(+):Drawing

fLocator(+):Locator

fAnimator(+):Thread

textTool(+):Tool

cmd(+):Command

system:Main

Showing top-

level domains

and objects

LEGEND

formal_domain

domain1

domain2

Object:DeclaredType

Object1_with_Substructure (+):DeclaredType1

Object2:DeclaredType2

domain link

RootObject:Type

field reference

Controller

fPoly(+):Shape

fFigures:Vector<Figure>

textFigure1:Drawing

_theQuadTree(+):QuadTree

fMap:MapfAttributes:

FigureAttributes

fDisplayBox:Shape

fPoints:Vector<Point>

fListeners:Vector<DrawingChangeListener>

fDrawingLockHolder:Runnable

fLocator(+):Locator

fAnimator(+):Thread

textTool(+):Tool

cmd(+):Command

system:Main

JHotDraw: “30-minute Architecture”

Showing Drawing’s sub-

structure

ToolButton

SelectionTool

JavaDrawApp

fListener

PaletteIcon

ToolButton

SelectionTool

JavaDrawApp

fListener

ToolButton

SelectionTool

JavaDrawApp

fListener

ToolButton

Undoable

SelectionTool

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

Object

SelectionTool

myUndoActivity

SelectionTool

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

myEventDispatcher

SelectionTool

myUndoActivity

myDrawingEditor

ToolfChild

fChild

myEventDispatcher

myUndoActivity

JavaDrawApp

myDrawingEditor

fChild

myEventDispatcher

JavaDrawApp

fSelectedToolButton

fDefaultToolButton

Animator

fAnimator

DrawingView

Vector

mdiListeners

JComponent

desktop

JTextField

fStatusLine

fDefaultToolButton

fSelectedToolButton

fAnimator

Vector

mdiListeners

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

fAnimator

Vector

mdiListeners

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

mdiListeners::elts

fAnimator

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

mdiListeners::elts

fAnimator

desktop

fStatusLine

listenerList

fSelectedToolButton

fDefaultToolButton

fAnimator

mdiListeners

desktop

fStatusLine

listenerList

Rectangle

UndoableHandle

DrawingEditor

fSelectGroup

fAnchorHandle

myDrawingEditor

myEventDispatcher

fSelectGroup

fAnchorHandle

myDrawingEditor

myWrappedTool

fSelectGroup

fAnchorHandle

myDrawingEditor

myWrappedTool

fSelected

fNormal

fPressed

DimensionfSize

Vector

Object[]elementData

myObservedTool

ToolListener

myObservedTool

myUndoActivity

myDrawingEditor

myEventDispatcher

Figure

fAnchorFigure

listenerList[]

NULL_ARRAY[]

Output of Womble

JHotDraw Runtime Object Graph

Static Analysis

Static analysis

• Build TypeGraph from program’s AST

• Convert to ObjectGraph that soundly approximates all runtime object graphs (ROG)

ROG: graph where nodes represent runtime objects, edges represent reference or usage relations

● Problem ● Approach ● Analysis ● Evaluation ● Conclusion

TypeGraph: show types, domains inside types, and objects in domains

BarChart

listeners: List<Listener>

DOCUMENT

pieChart: PieChart

barChart:BarChart

model:Model List<Listener>

obj: Listener

Is-Aobj: Type

Object

Type Type

Formal Domain

Actual Domain

ObjectGraph: instantiate types, starting with root

BarChart

DOCUMENT

pieChart: PieChart

barChart:BarChart

obj: Listener

Is-Aobj: Type

Object

Type Type

Formal Domain

Actual Domain

ObjectGraph: instantiate types, starting with root

BarChart

main: Main

DOCUMENT

pieChart: PieChart

barChart:BarChart

obj: Listener

Is-Aobj: Type

Object

Type Type

Formal Domain

Actual Domain

BarChart

ObjectGraph: instantiate types, show domains and objects inside domains

main: Main

DOCUMENT

pieChart: PieChart

barChart:BarChart

obj: Listener

Is-Aobj: Type

Object

Type Type

Formal Domain

Actual Domain

main: Main

DOCUMENT

pieChart: PieChart

barChart:BarChart

obj: Listener

BarChart

Is-Aobj: Type

Object

Type Type

Formal Domain

Actual Domain

main: Main

pieChart: PieChart…

barChart: BarChart

List<Listener>

obj: Listener

obj: Type

Object

Type Type

Formal Domain

Actual Domain

DOCUMENT

model: Model…

main: Main

barChart: BarChart

List<Listener>

obj: Listener

obj: Type

Object

Type Type

Formal Domain

Actual Domain

DOCUMENT

model: Model…

main: Main

barChart: BarChart

List<Listener>

obj: Listener

obj: Type

Object

Type Type

Formal Domain

Actual Domain

DOCUMENT

model: Model…

main: Main

DOCUMENT

model: Model…

barChart: BarChart

obj: Listener obj:

TypeObject

Formal Domain

Actual Domain

main: Main

DOCUMENT

ObjectGraph: pull objects from formal domains to actual domains

model: Model…

barChart: BarChart

obj: Listener obj:

TypeObject

Formal Domain

Actual Domain

main: Main

DOCUMENT

model: Model…

barChart: BarChart

obj: Listener obj:

TypeObject

Formal Domain

Actual Domain

obj: Listener

main: Main

DOCUMENT

model: Model…

barChart: BarChart

obj: Listener obj:

TypeObject

Formal Domain

Actual Domain

obj: Listener

main: Main

DOCUMENT

ObjectGraph: merge objects, in one domain, that may alias, based on types

{model: Model, obj:Listener}…

barChart: BarChart

obj: Listener obj:

TypeObject

Formal Domain

Actual Domain

obj: Listener

class Model implements Listener {…}

main: Main

DOCUMENT

ObjectGraph: add edges to represent field references

{model: Model, obj:Listener}…

barChart: BarChart

obj: Listener obj:

TypeObject

Formal Domain

Actual Domain

obj: Listener

Conclusion

• Ownership domain annotationsenable extraction of hierarchicalruntime object graphs using static analysis

• Provide architectural abstraction by ownership hierarchy and by types

Static Extraction of Hierarchical Runtime Object Graphs...

Documents

Proceedings of the 3rd International Conference ... · multidimensional Hierarchical Clustering (CHA) and Discriminant analysis. These methods are suitable for knowledge extraction

D4.1 - AllScale runtime system interface … - AllScale runtime system...D4.1 – AllScale runtime system interface specification WP4: Unified runtime system for extreme scales Version:

Experience with Simulating Real TCP/IP-Protocol · PDF fileAbstract model Reimplementation Code extraction Stack integration Runtime ... OppBSD for OMNeT++ FreeBSD 6.0 o ... Source

Fast Plane Extraction in Organized Point Clouds Using … · 2019. 10. 22. · Fast Plane Extraction in Organized Point Clouds Using Agglomerative Hierarchical Clustering Chen Feng1),

Parallel Performance of Hierarchical Multipole Algorithms for Inductance Extraction Ananth Grama, Purdue University Vivek Sarin, Texas A&M University Hemant

Runtime Data Areas - Amazon S3 · 2015-10-21 · Runtime Data Areas ㈜엑셈 컨설팅본부/APM팀 임 대호 Runtime Data Area 구조 Runtime Data Area는 JVM이 프로그램을

Weiping Shi Department of Computer Science University of North Texas HiCap: A Fast Hierarchical Algorithm for 3D Capacitance Extraction

Runtime presentatie

Fast Plane Extraction in Organized Point Clouds Using ... · Fast Plane Extraction in Organized Point Clouds Using Agglomerative Hierarchical Clustering ... (BIM) [15]. Extracting

Large-scale value extraction in mobile applicationsseminaire-dga.gforge.inria.fr/2015/20160513_EricBodden.pdf · Harvesting Runtime Values in Android Applications That Feature Anti-Analysis

I< iCHARM: HIERARCHICAL I CMOS CIRCUIT EXTRACTION WITH ... · I September 1990 UILU-ENG-90-2242 0 DAC-25 Analog and Digital Circuits 00 II I< iCHARM: HIERARCHICAL I CMOS CIRCUIT EXTRACTION

Runtime evolution

Research on static image feature extraction based on ...journal.it.cas.cz/61(2016)-4A/Paper02 Juan Xiong.pdfResearch on static image feature extraction based on hierarchical structure

Hierarchical Bayesian Methods For Recognition And ...€” This paper introduces a new uncertainty reasoning-based method for identiﬁcation and extraction of manufactur-ing features

Electronic Supplementary Information1 Electronic Supplementary Information 3D hierarchical porous amidoxime fibers speed up uranium extraction from seawater Xiao Xu1,3, Hongjun Zhang2,

A Field Study in Static Extraction of Runtime Architectures1

Newspaper Article Extraction Using Hierarchical Fixed Point Modelsumantra/publications/das14_fixed... · 2014. 1. 7. · Newspaper Article Extraction Using Hierarchical Fixed Point

Hierarchical Plane Extraction (HPE): An Efficient Method

From Hierarchical Partitions to Hierarchical Covers:

Static Extraction of Object-Oriented Runtime Architecturesmabianto/papers/CMU-ISR-08-127.pdf · 2009-01-06 · Static Extraction of Object-Oriented Runtime Architectures1 Marwan Abi-Antoun