PAG (SootUp Qilin 1.3.0 API)

java.lang.Object
- qilin.core.pag.PAG

```
public class PAG
extends Object
```
Pointer assignment graph.

Author:

Ondrej Lhotak

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<MethodPAG,Set<Context>>`	`addedContexts`
`protected Map<AllocNode,Set<VarNode>>`	`alloc`
`protected Map<VarNode,Set<AllocNode>>`	`allocInv`
`protected ArrayNumberer<AllocNode>`	`allocNodeNumberer`
`protected Map<AllocNode,Map<Context,ContextAllocNode>>`	`contextAllocNodeMap`
`protected Map<Context,Map<SparkField,ContextField>>`	`contextFieldMap`
`protected Map<SootMethod,Map<Context,ContextMethod>>`	`contextMethodMap`
`protected Map<VarNode,Map<Context,ContextVarNode>>`	`contextVarNodeMap`
`protected ChunkedQueue<Node>`	`edgeQueue`
`protected ArrayNumberer<FieldRefNode>`	`fieldRefNodeNumberer`
`protected Set<FieldSignature>`	`globals`
`protected Map<FieldRefNode,Set<VarNode>>`	`load`
`protected Map<VarNode,Set<FieldRefNode>>`	`loadInv`
`protected Set<Triple<SootMethod,Local,Type>>`	`locals`
`protected Map<SootMethod,MethodPAG>`	`methodToPag`
`protected NativeMethodDriver`	`nativeDriver`
`protected PTA`	`pta`
`protected ReflectionModel`	`reflectionModel`
`protected Map<ValNode,Set<ValNode>>`	`simple`
`protected Map<ValNode,Set<ValNode>>`	`simpleInv`
`protected Map<VarNode,Set<FieldRefNode>>`	`store`
`protected Map<FieldRefNode,Set<VarNode>>`	`storeInv`
`protected ArrayNumberer<ValNode>`	`valNodeNumberer`
`protected Map<Object,AllocNode>`	`valToAllocNode`
`protected Map<Object,ValNode>`	`valToValNode`

Constructor Summary

Constructors
Constructor and Description

PAG(PTA pta)

Constructors
Constructor and Description
`PAG(PTA pta)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEdge(Node from, Node to)` Adds an edge to the graph, returning false if it was already there.
`void`	`addGlobalPAGEdge(Node from, Node to)`
`protected <K,V> boolean`	`addToMap(Map<K,Set<V>> m, K key, V value)`
`Set<AllocNode>`	`allocInvLookup(VarNode key)`
`Set<VarNode>`	`allocLookup(AllocNode key)`
`protected ReflectionModel`	`createReflectionModel()`
`QueueReader<Node>`	`edgeReader()`
`AllocNode`	`findAllocNode(Object obj)`
`ContextVarNode`	`findContextVarNode(SootMethod m, Local baseValue, Context context)` Finds the ContextVarNode for base variable value and context context, or returns null.
`GlobalVarNode`	`findGlobalVarNode(Object value)` Finds the GlobalVarNode for the variable value, or returns null.
`LocalVarNode`	`findLocalVarNode(SootMethod m, Object value, Type type)` Finds the LocalVarNode for the variable value, or returns null.
`ValNode`	`findValNode(Object value, SootMethod containingMethod)` Finds the ValNode for the variable value, or returns null.
`Map<AllocNode,Set<VarNode>>`	`getAlloc()`
`AllocNode`	`getAllocNode(Object val)`
`ArrayNumberer<AllocNode>`	`getAllocNodeNumberer()`
`Collection<AllocNode>`	`getAllocNodes()`
`CallGraphBuilder`	`getCgb()`
`Map<AllocNode,Map<Context,ContextAllocNode>>`	`getContextAllocNodeMap()`
`Collection<ContextField>`	`getContextFields()`
`Map<Context,Map<SparkField,ContextField>>`	`getContextFieldVarNodeMap()`
`Map<SootMethod,Map<Context,ContextMethod>>`	`getContextMethodMap()`
`Map<VarNode,Map<Context,ContextVarNode>>`	`getContextVarNodeMap()`
`ArrayNumberer<FieldRefNode>`	`getFieldRefNodeNumberer()`
`Set<FieldSignature>`	`getGlobalPointers()`
`Map<FieldRefNode,Set<VarNode>>`	`getLoad()`
`Set<Triple<SootMethod,Local,Type>>`	`getLocalPointers()`
`Map<MethodPAG,Set<Context>>`	`getMethod2ContextsMap()`
`MethodPAG`	`getMethodPAG(SootMethod m)`
`PTA`	`getPta()`
`Map<ValNode,Set<ValNode>>`	`getSimple()`
`Map<ValNode,Set<ValNode>>`	`getSimpleInv()`
`Map<FieldRefNode,Set<VarNode>>`	`getStoreInv()`
`ArrayNumberer<ValNode>`	`getValNodeNumberer()`
`Collection<ValNode>`	`getValNodes()`
`Collection<VarNode>`	`getVarNodes(SootMethod m, Local local)`
`Set<FieldRefNode>`	`loadInvLookup(VarNode key)`
`Set<VarNode>`	`loadLookup(FieldRefNode key)`
`protected <K,V> Set<V>`	`lookup(Map<K,Set<V>> m, K key)`
`AllocNode`	`makeAllocNode(Object newExpr, Type type, SootMethod m)`
`AllocNode`	`makeClassConstantNode(ClassConstant cc)`
`ContextAllocNode`	`makeContextAllocNode(AllocNode allocNode, Context context)` Finds or creates the ContextAllocNode for base alloc site and context.
`ContextField`	`makeContextField(Context context, FieldValNode fieldValNode)`
`ContextMethod`	`makeContextMethod(Context context, SootMethod method)` Finds or creates the ContextMethod for method and context.
`ContextVarNode`	`makeContextVarNode(VarNode base, Context context)` Finds or creates the ContextVarNode for base variable base and context.
`FieldRefNode`	`makeFieldRefNode(VarNode base, SparkField field)` Finds or creates the FieldRefNode for base variable base and field field, of type type.
`FieldValNode`	`makeFieldValNode(SparkField field)` Finds or creates the FieldVarNode for the Java field or array element.
`GlobalVarNode`	`makeGlobalVarNode(Object value, Type type)` Finds or creates the GlobalVarNode for the variable value, of type type.
`LocalVarNode`	`makeLocalVarNode(Object value, Type type, SootMethod method)` Finds or creates the LocalVarNode for the variable value, of type type.
`AllocNode`	`makeStringConstantNode(StringConstant sc)`
`static int`	`nextFinishNumber()`
`void`	`resetPointsToSet()`
`void`	`setEdgeQueue(ChunkedQueue<Node> edgeQueue)`
`Set<ValNode>`	`simpleInvLookup(ValNode key)`
`Set<ValNode>`	`simpleLookup(ValNode key)`
`Set<VarNode>`	`storeInvLookup(FieldRefNode key)`
`Set<FieldRefNode>`	`storeLookup(VarNode key)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nativeDriver

protected final NativeMethodDriver nativeDriver

reflectionModel

protected final ReflectionModel reflectionModel

contextVarNodeMap

protected final Map<VarNode,Map<Context,ContextVarNode>> contextVarNodeMap

contextAllocNodeMap

protected final Map<AllocNode,Map<Context,ContextAllocNode>> contextAllocNodeMap

contextMethodMap

protected final Map<SootMethod,Map<Context,ContextMethod>> contextMethodMap

addedContexts

protected final Map<MethodPAG,Set<Context>> addedContexts

contextFieldMap

protected final Map<Context,Map<SparkField,ContextField>> contextFieldMap

allocNodeNumberer

protected ArrayNumberer<AllocNode> allocNodeNumberer

valNodeNumberer

protected ArrayNumberer<ValNode> valNodeNumberer

fieldRefNodeNumberer

protected ArrayNumberer<FieldRefNode> fieldRefNodeNumberer

valToAllocNode

protected final Map<Object,AllocNode> valToAllocNode

valToValNode

protected final Map<Object,ValNode> valToValNode

methodToPag

protected final Map<SootMethod,MethodPAG> methodToPag

globals

protected final Set<FieldSignature> globals

locals

protected final Set<Triple<SootMethod,Local,Type>> locals

edgeQueue
```
protected ChunkedQueue<Node> edgeQueue
```

simple

protected final Map<ValNode,Set<ValNode>> simple

simpleInv

protected final Map<ValNode,Set<ValNode>> simpleInv

load

protected final Map<FieldRefNode,Set<VarNode>> load

loadInv

protected final Map<VarNode,Set<FieldRefNode>> loadInv

alloc

protected final Map<AllocNode,Set<VarNode>> alloc

allocInv

protected final Map<VarNode,Set<AllocNode>> allocInv

store

protected final Map<VarNode,Set<FieldRefNode>> store

storeInv

protected final Map<FieldRefNode,Set<VarNode>> storeInv

pta
```
protected final PTA pta
```

Constructor Detail
- PAG
```
public PAG(PTA pta)
```

Method Detail

setEdgeQueue

public void setEdgeQueue(ChunkedQueue<Node> edgeQueue)

getAlloc

public Map<AllocNode,Set<VarNode>> getAlloc()

getSimple

public Map<ValNode,Set<ValNode>> getSimple()

getSimpleInv

public Map<ValNode,Set<ValNode>> getSimpleInv()

getLoad

public Map<FieldRefNode,Set<VarNode>> getLoad()

getStoreInv

public Map<FieldRefNode,Set<VarNode>> getStoreInv()

getPta
```
public PTA getPta()
```

getCgb
```
public CallGraphBuilder getCgb()
```

edgeReader
```
public QueueReader<Node> edgeReader()
```

addToMap

protected <K,V> boolean addToMap(Map<K,Set<V>> m,
                                 K key,
                                 V value)

addGlobalPAGEdge

public void addGlobalPAGEdge(Node from,
                             Node to)

addEdge

public final void addEdge(Node from,
                          Node to)

Adds an edge to the graph, returning false if it was already there.

lookup

protected <K,V> Set<V> lookup(Map<K,Set<V>> m,
                              K key)

allocLookup

public Set<VarNode> allocLookup(AllocNode key)

allocInvLookup

public Set<AllocNode> allocInvLookup(VarNode key)

simpleLookup

public Set<ValNode> simpleLookup(ValNode key)

simpleInvLookup

public Set<ValNode> simpleInvLookup(ValNode key)

loadInvLookup

public Set<FieldRefNode> loadInvLookup(VarNode key)

loadLookup

public Set<VarNode> loadLookup(FieldRefNode key)

storeLookup

public Set<FieldRefNode> storeLookup(VarNode key)

storeInvLookup

public Set<VarNode> storeInvLookup(FieldRefNode key)

nextFinishNumber
```
public static int nextFinishNumber()
```

getAllocNodeNumberer

public ArrayNumberer<AllocNode> getAllocNodeNumberer()

getFieldRefNodeNumberer

public ArrayNumberer<FieldRefNode> getFieldRefNodeNumberer()

getValNodeNumberer

public ArrayNumberer<ValNode> getValNodeNumberer()

getValNodes

public Collection<ValNode> getValNodes()

getAllocNodes

public Collection<AllocNode> getAllocNodes()

getGlobalPointers

public Set<FieldSignature> getGlobalPointers()

getLocalPointers

public Set<Triple<SootMethod,Local,Type>> getLocalPointers()

findValNode

public ValNode findValNode(Object value,
                           SootMethod containingMethod)

Finds the ValNode for the variable value, or returns null.

findAllocNode

public AllocNode findAllocNode(Object obj)

makeAllocNode

public AllocNode makeAllocNode(Object newExpr,
                               Type type,
                               SootMethod m)

makeStringConstantNode

public AllocNode makeStringConstantNode(StringConstant sc)

makeClassConstantNode

public AllocNode makeClassConstantNode(ClassConstant cc)

makeGlobalVarNode

public GlobalVarNode makeGlobalVarNode(Object value,
                                       Type type)

Finds or creates the GlobalVarNode for the variable value, of type type.

makeLocalVarNode

public LocalVarNode makeLocalVarNode(Object value,
                                     Type type,
                                     SootMethod method)

Finds or creates the LocalVarNode for the variable value, of type type.

makeFieldValNode
```
public FieldValNode makeFieldValNode(SparkField field)
```
Finds or creates the FieldVarNode for the Java field or array element. Treat Java field and array element as normal local variable.

makeFieldRefNode

public FieldRefNode makeFieldRefNode(VarNode base,
                                     SparkField field)

Finds or creates the FieldRefNode for base variable base and field field, of type type.

makeContextVarNode

public ContextVarNode makeContextVarNode(VarNode base,
                                         Context context)

Finds or creates the ContextVarNode for base variable base and context.

makeContextAllocNode

public ContextAllocNode makeContextAllocNode(AllocNode allocNode,
                                             Context context)

Finds or creates the ContextAllocNode for base alloc site and context.

makeContextMethod

public ContextMethod makeContextMethod(Context context,
                                       SootMethod method)

Finds or creates the ContextMethod for method and context.

getAllocNode

public AllocNode getAllocNode(Object val)

getMethod2ContextsMap

public Map<MethodPAG,Set<Context>> getMethod2ContextsMap()

getContextFields

public Collection<ContextField> getContextFields()

getContextVarNodeMap

public Map<VarNode,Map<Context,ContextVarNode>> getContextVarNodeMap()

getContextAllocNodeMap

public Map<AllocNode,Map<Context,ContextAllocNode>> getContextAllocNodeMap()

getContextMethodMap

public Map<SootMethod,Map<Context,ContextMethod>> getContextMethodMap()

getContextFieldVarNodeMap

public Map<Context,Map<SparkField,ContextField>> getContextFieldVarNodeMap()

makeContextField

public ContextField makeContextField(Context context,
                                     FieldValNode fieldValNode)

getVarNodes

public Collection<VarNode> getVarNodes(SootMethod m,
                                       Local local)

findGlobalVarNode
```
public GlobalVarNode findGlobalVarNode(Object value)
```
Finds the GlobalVarNode for the variable value, or returns null.

findLocalVarNode

public LocalVarNode findLocalVarNode(SootMethod m,
                                     Object value,
                                     Type type)

Finds the LocalVarNode for the variable value, or returns null.

findContextVarNode

public ContextVarNode findContextVarNode(SootMethod m,
                                         Local baseValue,
                                         Context context)

Finds the ContextVarNode for base variable value and context context, or returns null.

createReflectionModel

protected ReflectionModel createReflectionModel()

getMethodPAG

public MethodPAG getMethodPAG(SootMethod m)

resetPointsToSet
```
public void resetPointsToSet()
```

Class PAG