GeomPointsTo

java.lang.Object
- soot.jimple.spark.pag.PAG
- - soot.jimple.spark.geom.geomPA.GeomPointsTo

All Implemented Interfaces:

PointsToAnalysis
```
public class GeomPointsTo
extends PAG
```
The main interface for the points-to analysis with geometric encodings. Since we need SPARK to bootstrap our analysis, thus, we identify ourself to be a subclass of SPARK.

Field Summary

Fields
Modifier and Type	Field and Description
`ZArrayNumberer<IVarAbstraction>`	`allocations`
`int[]`	`block_num`
`protected CgEdge[]`	`call_graph`
`java.util.Map<Node,IVarAbstraction>`	`consG`
`ZArrayNumberer<PlainConstraint>`	`constraints`
`long[]`	`context_size`
`java.lang.String`	`dump_dir`
`protected java.util.Map<Edge,CgEdge>`	`edgeMapping`
`protected java.util.Map<SootMethod,java.lang.Integer>`	`func2int`
`protected int[]`	`indeg_cg`
`protected java.util.Map<java.lang.Integer,SootMethod>`	`int2func`
`protected int[]`	`low_cg`
`long[]`	`max_context_size_block`
`int`	`max_scc_id`
`int`	`max_scc_size`
`java.util.Set<Stmt>`	`multiCallsites`
`int`	`n_calls`
`int`	`n_func`
`int`	`n_init_constraints`
`int`	`n_reach_methods`
`int`	`n_reach_spark_user_methods`
`int`	`n_reach_user_methods`
`protected IEncodingBroker`	`nodeGenerator`
`protected java.util.Vector<CgEdge>`	`obsoletedEdges`
`protected OfflineProcessor`	`offlineProcessor`
`ZArrayNumberer<IVarAbstraction>`	`pointers`
`protected int`	`pre_cnt`
`java.io.PrintStream`	`ps`
`protected java.util.Deque<java.lang.Integer>`	`queue_cg`
`protected int[]`	`rep_cg`
`protected java.util.Map<java.lang.Integer,java.util.LinkedList<CgEdge>>`	`rev_call_graph`
`protected int[]`	`scc_size`
`java.util.Set<Stmt>`	`thread_run_callsites`
`protected TypeManager`	`typeManager`
`protected java.util.Map<java.lang.String,java.lang.Boolean>`	`validMethods`
`protected int[]`	`vis_cg`
`protected IWorklist`	`worklist`

Fields inherited from class soot.jimple.spark.pag.PAG
accessibilityOracle, alloc, allocInv, assign2edges, assignInstance, assignInstanceInv, callAssigns, callToMethod, cgOpts, edgeQueue, EMPTY_NODE_ARRAY, load, loadInv, maxFinishNumber, nativeMethodDriver, newInstance, newInstanceInv, opts, setFactory, simple, simpleInv, somethingMerged, store, storeInv, virtualCallsToReceivers

Constructor Summary

Constructors
Constructor and Description

GeomPointsTo(SparkOptions opts)

Constructors
Constructor and Description
`GeomPointsTo(SparkOptions opts)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`castNeverFails(Type src, Type dst)` Type compatibility test.
`void`	`cleanResult()` We thoroughly delete the geometric points-to result for space saving.
`java.io.FileOutputStream`	`createOutputFile(java.lang.String file_name)` Create all output files under the uniform location.
`void`	`ddSolve(java.util.Set<Node> qryNodes)` The demand-driven mode for precisely computing points-to information for given pointers.
`IVarAbstraction`	`findAndInsertInstanceField(AllocNode obj, SparkField field)` Obtain or create an internal representation of an object field.
`IVarAbstraction`	`findInstanceField(AllocNode obj, SparkField field)` Obtain the internal representation of an object field.
`IVarAbstraction`	`findInternalNode(Node v)` Find our representation for the SPARK node @param v.
`java.util.Set<SootMethod>`	`getAllReachableMethods()` A replacement of the Scene.v().getReachableMethods.
`java.util.LinkedList<CgEdge>`	`getCallEdgesInto(int fid)` Get the call edges calling into the method @param fid.
`CgEdge`	`getCallEgesOutFrom(int fid)` Get the call edges calling from the method @param fid.
`int`	`getIDFromSootMethod(SootMethod sm)` Get Internal ID for soot method @param sm
`CgEdge`	`getInternalEdgeFromSootEdge(Edge e)` Obtain the edge representation internal to geomPTA.
`int`	`getMethodIDFromPtr(IVarAbstraction pn)` Get the index of the enclosing function of the specified node.
`int`	`getNumberOfMethods()` Return the number of functions that are reachable after the geometric points-to analysis.
`int`	`getNumberOfObjects()` Get the number of valid objects current in the container.
`int`	`getNumberOfPointers()` Get the number of valid pointers currently reachable by geomPTA.
`int`	`getNumberOfSparkMethods()` Return the number of functions that are reachable by SPARK.
`SootMethod`	`getSootMethodFromID(int fid)` Get soot method from given internal ID @param fid
`IWorklist`	`getWorklist()`
`boolean`	`hasGeomExecuted()` Is this a Spark or Geom?
`boolean`	`isExceptionPointer(Node v)`
`boolean`	`isReachableMethod(int fid)` Deciding if the given method represented by @param fid is reachable.
`boolean`	`isReachableMethod(SootMethod sm)` Deciding if the given method represented by @param sm is reachable.
`boolean`	`isValidGeometricNode(Node sparkNode)` Given a valid SPARK node, we test if it is still valid after the geometric analysis.
`boolean`	`isValidMethod(SootMethod sm)` Telling if the given method is in the file given by the option "cg.spark geom-verify-name".
`void`	`keepOnly(java.util.Set<IVarAbstraction> usefulPointers)` Keep only the pointers the users are interested in.
`IVarAbstraction`	`makeInternalNode(Node v)` Transform the SPARK node @param v representation to our representation.
`void`	`outputNotEvaluatedMethods()`
`void`	`parametrize(double spark_run_time)` Using the user specified arguments to parameterize the geometric points-to solver.
`PointsToSet`	`reachingObjects(AllocNode an, SootField f)`
`PointsToSet`	`reachingObjects(Context c, Local l)` Returns the set of objects pointed to by variable l in context c.
`PointsToSet`	`reachingObjects(Context c, Local l, SootField f)` Returns the set of objects pointed to by instance field f of the objects pointed to by l in context c.
`PointsToSet`	`reachingObjects(Local l)` Returns the set of objects pointed to by variable l.
`PointsToSet`	`reachingObjects(Local l, SootField f)` Returns the set of objects pointed to by instance field f of the objects pointed to by l.
`PointsToSet`	`reachingObjects(PointsToSet s, SootField f)` Returns the set of objects pointed to by instance field f of the objects in the PointsToSet s.
`PointsToSet`	`reachingObjects(SootField f)` Returns the set of objects pointed to by static field f.
`PointsToSet`	`reachingObjectsOfArrayElement(PointsToSet s)` Returns the set of objects pointed to by elements of the arrays in the PointsToSet s.
`void`	`solve()` The starting point of the geometric points-to analysis engine.
`java.lang.String`	`toString()`
`void`	`transformToCIResult()` For many applications, they only need the context insensitive points-to result.

Methods inherited from class soot.jimple.spark.pag.PAG
addAllocEdge, addAssignInstanceEdge, addCallTarget, addCallTarget, addDereference, addEdge, addInterproceduralAssignment, addLoadEdge, addNewInstanceEdge, addSimpleEdge, addStoreEdge, addToMap, allocInvLookup, allocInvSources, allocInvSourcesIterator, allocLookup, allocNodeListener, allocSources, allocSourcesIterator, assignInstanceLookup, assignInstanceSources, cleanPAG, cleanUpMerges, doAddAllocEdge, doAddAssignInstanceEdge, doAddLoadEdge, doAddNewInstanceEdge, doAddSimpleEdge, doAddStoreEdge, edgeReader, findAllocDotField, findContextVarNode, findGlobalFieldRefNode, findGlobalVarNode, findLocalFieldRefNode, findLocalVarNode, getAllocDotFieldNodeNumberer, getAllocNodeNumberer, getCGOpts, getDereferences, getFieldRefNodeNumberer, getNodeTags, getNumAllocNodes, getOnFlyCallGraph, getOpts, getSetFactory, getTypeManager, getVarNodeNumberer, loadInvLookup, loadInvSources, loadInvSourcesIterator, loadLookup, loadSources, loadSourcesIterator, lookup, lookupEdgesForAssignment, makeAllocDotField, makeAllocNode, makeClassConstantNode, makeContextVarNode, makeContextVarNode, makeFieldRefNode, makeGlobalFieldRefNode, makeGlobalVarNode, makeLocalFieldRefNode, makeLocalVarNode, makeNewInstanceNode, makeStringConstantNode, newInstanceLookup, newInstanceSources, nodeFactory, ofcg, setOnFlyCallGraph, simpleInvLookup, simpleInvSources, simpleInvSourcesIterator, simpleLookup, simpleSources, simpleSourcesIterator, storeInvLookup, storeInvSources, storeInvSourcesIterator, storeLookup, storeSources, storeSourcesIterator

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

- Field Detail
  - worklist
```
protected IWorklist worklist
```
  - nodeGenerator
```
protected IEncodingBroker nodeGenerator
```
  - typeManager
```
protected TypeManager typeManager
```
  - offlineProcessor
```
protected OfflineProcessor offlineProcessor
```
  - consG
```
public java.util.Map<Node,IVarAbstraction> consG
```
  - pointers
```
public ZArrayNumberer<IVarAbstraction> pointers
```
  - allocations
```
public ZArrayNumberer<IVarAbstraction> allocations
```
  - constraints
```
public ZArrayNumberer<PlainConstraint> constraints
```
  - thread_run_callsites
```
public java.util.Set<Stmt> thread_run_callsites
```
  - multiCallsites
```
public java.util.Set<Stmt> multiCallsites
```
  - context_size
```
public long[] context_size
```
  - max_context_size_block
```
public long[] max_context_size_block
```
  - block_num
```
public int[] block_num
```
  - max_scc_size
```
public int max_scc_size
```
  - max_scc_id
```
public int max_scc_id
```
  - n_func
```
public int n_func
```
  - n_calls
```
public int n_calls
```
  - n_reach_methods
```
public int n_reach_methods
```
  - n_reach_user_methods
```
public int n_reach_user_methods
```
  - n_reach_spark_user_methods
```
public int n_reach_spark_user_methods
```
  - n_init_constraints
```
public int n_init_constraints
```
  - dump_dir
```
public java.lang.String dump_dir
```
  - ps
```
public java.io.PrintStream ps
```
  - validMethods
```
protected java.util.Map<java.lang.String,java.lang.Boolean> validMethods
```
  - call_graph
```
protected CgEdge[] call_graph
```
  - obsoletedEdges
```
protected java.util.Vector<CgEdge> obsoletedEdges
```
  - rev_call_graph
```
protected java.util.Map<java.lang.Integer,java.util.LinkedList<CgEdge>> rev_call_graph
```
  - queue_cg
```
protected java.util.Deque<java.lang.Integer> queue_cg
```
  - vis_cg
```
protected int[] vis_cg
```
  - low_cg
```
protected int[] low_cg
```
  - rep_cg
```
protected int[] rep_cg
```
  - indeg_cg
```
protected int[] indeg_cg
```
  - scc_size
```
protected int[] scc_size
```
  - pre_cnt
```
protected int pre_cnt
```
  - func2int
```
protected java.util.Map<SootMethod,java.lang.Integer> func2int
```
  - int2func
```
protected java.util.Map<java.lang.Integer,SootMethod> int2func
```
  - edgeMapping
```
protected java.util.Map<Edge,CgEdge> edgeMapping
```
- Constructor Detail
  - GeomPointsTo
```
public GeomPointsTo(SparkOptions opts)
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - parametrize
```
public void parametrize(double spark_run_time)
```
    Using the user specified arguments to parameterize the geometric points-to solver.
    
    Parameters:
    
    spark_run_time -
  - transformToCIResult
```
public void transformToCIResult()
```
    For many applications, they only need the context insensitive points-to result. We provide a way to transfer our result back to SPARK. After the transformation, we discard the context sensitive points-to information. Therefore, if context sensitive queries are needed in future, please call ddSolve() for queried pointers first.
  - solve
```
public void solve()
```
    The starting point of the geometric points-to analysis engine. This function computes the whole program points-to information.
  - ddSolve
```
public void ddSolve(java.util.Set<Node> qryNodes)
```
    The demand-driven mode for precisely computing points-to information for given pointers. Call graph will not be updated in this mode.
    
    Parameters:
    
    qryNodes: - the set of nodes that would be refined by geomPA.
  - cleanResult
```
public void cleanResult()
```
    We thoroughly delete the geometric points-to result for space saving. Some applications such as those needing the call graph only may want to clean the points-to result.
  - keepOnly
```
public void keepOnly(java.util.Set<IVarAbstraction> usefulPointers)
```
    Keep only the pointers the users are interested in. Just used for reducing memory occupation.
  - getIDFromSootMethod
```
public int getIDFromSootMethod(SootMethod sm)
```
    Get Internal ID for soot method @param sm
    
    Returns:
    
    -1 if the given method is unreachable
  - getSootMethodFromID
```
public SootMethod getSootMethodFromID(int fid)
```
    Get soot method from given internal ID @param fid
    
    Returns:
    
    null if such ID is illegal.
  - isReachableMethod
```
public boolean isReachableMethod(int fid)
```
    Deciding if the given method represented by @param fid is reachable.
  - isReachableMethod
```
public boolean isReachableMethod(SootMethod sm)
```
    Deciding if the given method represented by @param sm is reachable.
  - isValidMethod
```
public boolean isValidMethod(SootMethod sm)
```
    Telling if the given method is in the file given by the option "cg.spark geom-verify-name".
  - outputNotEvaluatedMethods
```
public void outputNotEvaluatedMethods()
```
  - getAllReachableMethods
```
public java.util.Set<SootMethod> getAllReachableMethods()
```
    A replacement of the Scene.v().getReachableMethods.
    
    Returns:
  - getCallEgesOutFrom
```
public CgEdge getCallEgesOutFrom(int fid)
```
    Get the call edges calling from the method @param fid.
  - getCallEdgesInto
```
public java.util.LinkedList<CgEdge> getCallEdgesInto(int fid)
```
    Get the call edges calling into the method @param fid.
  - getMethodIDFromPtr
```
public int getMethodIDFromPtr(IVarAbstraction pn)
```
    Get the index of the enclosing function of the specified node.
  - makeInternalNode
```
public IVarAbstraction makeInternalNode(Node v)
```
    Transform the SPARK node @param v representation to our representation.
  - findInternalNode
```
public IVarAbstraction findInternalNode(Node v)
```
    Find our representation for the SPARK node @param v. We don't create a new node if nothing found.
  - castNeverFails
```
public boolean castNeverFails(Type src,
                              Type dst)
```
    Type compatibility test.
    
    Parameters:
    
    src -
    
    dst -
  - getNumberOfPointers
```
public int getNumberOfPointers()
```
    Get the number of valid pointers currently reachable by geomPTA.
  - getNumberOfObjects
```
public int getNumberOfObjects()
```
    Get the number of valid objects current in the container.
    
    Returns:
  - getNumberOfSparkMethods
```
public int getNumberOfSparkMethods()
```
    Return the number of functions that are reachable by SPARK.
  - getNumberOfMethods
```
public int getNumberOfMethods()
```
    Return the number of functions that are reachable after the geometric points-to analysis.
  - getWorklist
```
public IWorklist getWorklist()
```
  - findInstanceField
```
public IVarAbstraction findInstanceField(AllocNode obj,
                                         SparkField field)
```
    Obtain the internal representation of an object field.
  - findAndInsertInstanceField
```
public IVarAbstraction findAndInsertInstanceField(AllocNode obj,
                                                  SparkField field)
```
    Obtain or create an internal representation of an object field.
  - getInternalEdgeFromSootEdge
```
public CgEdge getInternalEdgeFromSootEdge(Edge e)
```
    Obtain the edge representation internal to geomPTA.
  - isExceptionPointer
```
public boolean isExceptionPointer(Node v)
```
  - isValidGeometricNode
```
public boolean isValidGeometricNode(Node sparkNode)
```
    Given a valid SPARK node, we test if it is still valid after the geometric analysis.
  - hasGeomExecuted
```
public boolean hasGeomExecuted()
```
    Is this a Spark or Geom?
    
    Returns:
  - createOutputFile
```
public java.io.FileOutputStream createOutputFile(java.lang.String file_name)
                                          throws java.io.FileNotFoundException
```
    Create all output files under the uniform location.
    
    Parameters:
    
    file_name -
    
    Returns:
    
    Throws:
    
    java.io.FileNotFoundException
  - reachingObjects
```
public PointsToSet reachingObjects(Local l)
```
    Description copied from class: PAG
    
    Returns the set of objects pointed to by variable l.
    
    Specified by:
    
    reachingObjects in interface PointsToAnalysis
    
    Overrides:
    
    reachingObjects in class PAG
  - reachingObjects
```
public PointsToSet reachingObjects(Context c,
                                   Local l)
```
    Description copied from class: PAG
    
    Returns the set of objects pointed to by variable l in context c.
    
    Specified by:
    
    reachingObjects in interface PointsToAnalysis
    
    Overrides:
    
    reachingObjects in class PAG
  - reachingObjects
```
public PointsToSet reachingObjects(SootField f)
```
    Description copied from class: PAG
    
    Returns the set of objects pointed to by static field f.
    
    Specified by:
    
    reachingObjects in interface PointsToAnalysis
    
    Overrides:
    
    reachingObjects in class PAG
  - reachingObjects
```
public PointsToSet reachingObjects(PointsToSet s,
                                   SootField f)
```
    Description copied from class: PAG
    
    Returns the set of objects pointed to by instance field f of the objects in the PointsToSet s.
    
    Specified by:
    
    reachingObjects in interface PointsToAnalysis
    
    Overrides:
    
    reachingObjects in class PAG
  - reachingObjects
```
public PointsToSet reachingObjects(Local l,
                                   SootField f)
```
    Description copied from class: PAG
    
    Returns the set of objects pointed to by instance field f of the objects pointed to by l.
    
    Specified by:
    
    reachingObjects in interface PointsToAnalysis
    
    Overrides:
    
    reachingObjects in class PAG
  - reachingObjects
```
public PointsToSet reachingObjects(Context c,
                                   Local l,
                                   SootField f)
```
    Description copied from class: PAG
    
    Returns the set of objects pointed to by instance field f of the objects pointed to by l in context c.
    
    Specified by:
    
    reachingObjects in interface PointsToAnalysis
    
    Overrides:
    
    reachingObjects in class PAG
  - reachingObjectsOfArrayElement
```
public PointsToSet reachingObjectsOfArrayElement(PointsToSet s)
```
    Description copied from class: PAG
    
    Returns the set of objects pointed to by elements of the arrays in the PointsToSet s.
    
    Specified by:
    
    reachingObjectsOfArrayElement in interface PointsToAnalysis
    
    Overrides:
    
    reachingObjectsOfArrayElement in class PAG
  - reachingObjects
```
public PointsToSet reachingObjects(AllocNode an,
                                   SootField f)
```

Class GeomPointsTo

Field Summary

Fields inherited from class soot.jimple.spark.pag.PAG

Fields inherited from interface soot.PointsToAnalysis

Constructor Summary

Method Summary

Methods inherited from class soot.jimple.spark.pag.PAG

Methods inherited from class java.lang.Object

Field Detail

worklist

nodeGenerator

typeManager

offlineProcessor

consG

pointers

allocations

constraints

thread_run_callsites

multiCallsites

context_size

max_context_size_block

block_num

max_scc_size

max_scc_id

n_func

n_calls

n_reach_methods

n_reach_user_methods

n_reach_spark_user_methods

n_init_constraints

dump_dir

ps

validMethods

call_graph

obsoletedEdges

rev_call_graph

queue_cg

vis_cg

low_cg

rep_cg

indeg_cg

scc_size

pre_cnt

func2int

int2func

edgeMapping

Constructor Detail

GeomPointsTo

Method Detail

toString

parametrize

transformToCIResult

solve

ddSolve

cleanResult

keepOnly

getIDFromSootMethod

getSootMethodFromID

isReachableMethod

isReachableMethod

isValidMethod

outputNotEvaluatedMethods

getAllReachableMethods

getCallEgesOutFrom

getCallEdgesInto

getMethodIDFromPtr

makeInternalNode

findInternalNode

castNeverFails

getNumberOfPointers

getNumberOfObjects

getNumberOfSparkMethods

getNumberOfMethods

getWorklist

findInstanceField

findAndInsertInstanceField

getInternalEdgeFromSootEdge

isExceptionPointer

isValidGeometricNode

hasGeomExecuted