Class JSSSAPropagationCallGraphBuilder

java.lang.Object

com.ibm.wala.ipa.callgraph.propagation.PropagationCallGraphBuilder

com.ibm.wala.ipa.callgraph.propagation.SSAPropagationCallGraphBuilder

com.ibm.wala.cast.ipa.callgraph.AstSSAPropagationCallGraphBuilder

com.ibm.wala.cast.js.ipa.callgraph.JSSSAPropagationCallGraphBuilder

All Implemented Interfaces:

CallGraphBuilder<InstanceKey>, HeapModel, InstanceKeyFactory, PointerKeyFactory

Direct Known Subclasses:

JSCFABuilder

public class JSSSAPropagationCallGraphBuilder
extends AstSSAPropagationCallGraphBuilder

Specialized pointer analysis constraint generation for JavaScript.

Global object handling

The global object is represented by a GlobalObjectKey stored in globalObject. AstGlobalRead and AstGlobalWrite instructions are treated as accessing properties of the global object; see JSSSAPropagationCallGraphBuilder.JSConstraintVisitor.visitAstGlobalRead(AstGlobalRead), JSSSAPropagationCallGraphBuilder.JSConstraintVisitor.visitAstGlobalWrite(AstGlobalWrite), and JSSSAPropagationCallGraphBuilder.JSPointerAnalysisImpl.JSImplicitPointsToSetVisitor.visitAstGlobalRead(AstGlobalRead). Finally, we need to represent direct flow of the global object to handle receiver argument semantics (see RhinoToAstTranslator). To do so, we create a reference to a global named GLOBAL_OBJ_VAR_NAME, which is handled specially in JSSSAPropagationCallGraphBuilder.JSConstraintVisitor.visitAstGlobalRead(AstGlobalRead).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JSSSAPropagationCallGraphBuilder.JSConstraintVisitor
static class	JSSSAPropagationCallGraphBuilder.JSInterestingVisitor
static class	JSSSAPropagationCallGraphBuilder.JSPointerAnalysisImpl

Nested classes/interfaces inherited from class AstSSAPropagationCallGraphBuilder

AstSSAPropagationCallGraphBuilder.AstConstraintVisitor, AstSSAPropagationCallGraphBuilder.AstInterestingVisitor, AstSSAPropagationCallGraphBuilder.AstPointerAnalysisImpl

Nested classes/interfaces inherited from class SSAPropagationCallGraphBuilder

SSAPropagationCallGraphBuilder.ConstraintVisitor, SSAPropagationCallGraphBuilder.InterestingVisitor

Nested classes/interfaces inherited from class PropagationCallGraphBuilder

PropagationCallGraphBuilder.ArrayLoadOperator, PropagationCallGraphBuilder.ArrayStoreOperator, PropagationCallGraphBuilder.FilterOperator, PropagationCallGraphBuilder.GetFieldOperator, PropagationCallGraphBuilder.InstanceArrayStoreOperator, PropagationCallGraphBuilder.InstancePutFieldOperator, PropagationCallGraphBuilder.InverseFilterOperator, PropagationCallGraphBuilder.MutableBoolean, PropagationCallGraphBuilder.PutFieldOperator, PropagationCallGraphBuilder.TypedPointerKey

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEBUG_LEXICAL
static final boolean	DEBUG_TYPE_INFERENCE
static final String	GLOBAL_OBJ_VAR_NAME	name to be used internally to pass around the global object

Fields inherited from class AstSSAPropagationCallGraphBuilder

DEBUG_PROPERTIES

Fields inherited from class SSAPropagationCallGraphBuilder

monitor, PERIODIC_WIPE_SOFT_CACHES, SHORT_CIRCUIT_SINGLE_USES, WIPE_SOFT_CACHE_INTERVAL

Fields inherited from class PropagationCallGraphBuilder

assignOperator, callGraph, cha, contextSelector, DEBUG_GENERAL, entrypointCallSites, filterOperator, instanceKeyFactory, inverseFilterOperator, options, pointerKeyFactory, system

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JSSSAPropagationCallGraphBuilder(AbstractRootMethod abstractRootMethod, AnalysisOptions options, IAnalysisCacheView cache, PointerKeyFactory pointerKeyFactory)

Method Summary

Modifier and Type	Method	Description
protected void	addAssignmentsForCatchPointerKey(PointerKey exceptionVar, Set<IClass> catchClasses, PointerKey e)	Generate a set of constraints to represent assignment to an exception variable in a catch clause.
protected ExplicitCallGraph	createEmptyCallGraph(IMethod fakeRootClass, AnalysisOptions options)
protected AbstractFieldPointerKey	fieldKeyForUnknownWrites(AbstractFieldPointerKey fieldKey)	If the given fieldKey represents a concrete field, return the corresponding field key that represents all writes to unknown fields that could potentially alias fieldKey
URL	getBaseURL()
GlobalObjectKey	getGlobalObject(Atom language)
PointerKey	getPointerKeyForGlobalVar(String varName)
static CAstSourcePositionMap.Position	getSomePositionForMethod(IR ir, AstMethod method)
protected boolean	isConstantRef(SymbolTable symbolTable, int valueNumber)
protected boolean	isUncataloguedField(IClass type, String fieldName)	each language can specify whether a particular field name should be stored in object catalogs or not.
protected SSAPropagationCallGraphBuilder.InterestingVisitor	makeInterestingVisitor(CGNode node, int vn)
protected PropagationSystem	makeSystem(AnalysisOptions options)
protected TypeInference	makeTypeInference(IR ir, IClassHierarchy cha)
JSSSAPropagationCallGraphBuilder.JSConstraintVisitor	makeVisitor(CGNode node)
protected void	processCallingConstraints(CGNode caller, SSAAbstractInvokeInstruction instruction, CGNode target, InstanceKey[][] constParams, PointerKey uniqueCatchKey)
static void	processCallingConstraintsInternal(AstSSAPropagationCallGraphBuilder builder, CGNode caller, SSAAbstractInvokeInstruction instruction, CGNode target, InstanceKey[][] constParams, PointerKey uniqueCatchKey)
protected boolean	sameMethod(CGNode opNode, String definingMethod)	Is definingMethod the same as the method represented by opNode? We need this since the names for methods in some languages don't map in the straightforward way to the CGNode
void	setBaseURL(URL url)
protected boolean	useObjectCatalog()	should we maintain an object catalog for each instance key, storing the names of all known properties of the instance key? required to handle EachElementGetInstructions.

Methods inherited from class AstSSAPropagationCallGraphBuilder

hasNoInterestingUses, makeDefaultContextInterpreters

Methods inherited from class SSAPropagationCallGraphBuilder

addBlockInstructionConstraints, addConstraintsFromNode, addNodeInstructionConstraints, addNodePassthruExceptionConstraints, addNodeValueConstraints, contentsAreInvariant, contentsAreInvariant, getCaughtExceptionTypes, getCFAContextInterpreter, getIncomingPEIs, getInstanceKeyForPEI, getInstanceKeyForPEI, getInvariantContents, getInvariantContents, getTargetPointerKey, getTargetsForCall, getUniqueCatchKey, hasUniqueCatchBlock, iterateCrossProduct, iteratePointerKeys, makeSolver, unconditionallyAddConstraintsFromNode

Methods inherited from class PropagationCallGraphBuilder

addConstraintsFromChangedNode, addConstraintsFromNewNodes, assignInstanceToCatch, catches, customInit, filterForClass, getAnalysisCache, getCallGraph, getClassHierarchy, getContextInterpreter, getContextSelector, getFilteredPointerKeyForLocal, getFilteredPointerKeyForLocal, getFilteredPointerKeyForLocal, getInstanceKeyForAllocation, getInstanceKeyForConstant, getInstanceKeyForMetadataObject, getInstanceKeyForMultiNewArray, getInstanceKeys, getInstanceKeysForClass, getJavaLangObject, getMutableInstanceKeysForClass, getOptions, getPointerAnalysis, getPointerKeyFactory, getPointerKeyForArrayContents, getPointerKeyForExceptionalReturnValue, getPointerKeyForInstanceField, getPointerKeyForLocal, getPointerKeyForReturnValue, getPointerKeyForStaticField, getPropagationSystem, getSolver, getSystem, getTargetForCall, haveAlreadyVisited, isJavaLangObject, makeCallGraph, makeCallGraph, markAlreadyVisited, markChanged, markDiscovered, representsNullType, setContextInterpreter, setContextSelector, setInstanceKeys, setPointerKeyFactory, wasChanged

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface HeapModel

getClassHierarchy

Methods inherited from interface InstanceKeyFactory

getInstanceKeyForAllocation, getInstanceKeyForConstant, getInstanceKeyForMetadataObject, getInstanceKeyForMultiNewArray

Methods inherited from interface PointerKeyFactory

getFilteredPointerKeyForLocal, getPointerKeyForArrayContents, getPointerKeyForExceptionalReturnValue, getPointerKeyForInstanceField, getPointerKeyForLocal, getPointerKeyForReturnValue, getPointerKeyForStaticField

Field Details

DEBUG_LEXICAL

public static final boolean DEBUG_LEXICAL

See Also:

• Constant Field Values

DEBUG_TYPE_INFERENCE

public static final boolean DEBUG_TYPE_INFERENCE

See Also:

• Constant Field Values

GLOBAL_OBJ_VAR_NAME

public static final String GLOBAL_OBJ_VAR_NAME

name to be used internally to pass around the global object

See Also:

• Constant Field Values

Constructor Details

JSSSAPropagationCallGraphBuilder

protected JSSSAPropagationCallGraphBuilder(AbstractRootMethod abstractRootMethod,
 AnalysisOptions options,
 IAnalysisCacheView cache,
 PointerKeyFactory pointerKeyFactory)

Method Details

getGlobalObject

public GlobalObjectKey getGlobalObject(Atom language)

Specified by:

getGlobalObject in class AstSSAPropagationCallGraphBuilder

getBaseURL

public URL getBaseURL()

setBaseURL

public void setBaseURL(URL url)

isConstantRef

protected boolean isConstantRef(SymbolTable symbolTable,
 int valueNumber)

Overrides:

isConstantRef in class SSAPropagationCallGraphBuilder

useObjectCatalog

protected boolean useObjectCatalog()

Description copied from class: AstSSAPropagationCallGraphBuilder

should we maintain an object catalog for each instance key, storing the names of all known properties of the instance key? required to handle EachElementGetInstructions.

Specified by:

useObjectCatalog in class AstSSAPropagationCallGraphBuilder

See Also:

• AstSSAPropagationCallGraphBuilder.AstConstraintVisitor.visitPut(SSAPutInstruction)
• AstSSAPropagationCallGraphBuilder.AstConstraintVisitor.visitEachElementGet(EachElementGetInstruction)

isUncataloguedField

protected boolean isUncataloguedField(IClass type,
 String fieldName)

Description copied from class: AstSSAPropagationCallGraphBuilder

each language can specify whether a particular field name should be stored in object catalogs or not. By default, always return false.

Overrides:

isUncataloguedField in class AstSSAPropagationCallGraphBuilder

fieldKeyForUnknownWrites

protected AbstractFieldPointerKey fieldKeyForUnknownWrites(AbstractFieldPointerKey fieldKey)

Description copied from class: AstSSAPropagationCallGraphBuilder

If the given fieldKey represents a concrete field, return the corresponding field key that represents all writes to unknown fields that could potentially alias fieldKey

Specified by:

fieldKeyForUnknownWrites in class AstSSAPropagationCallGraphBuilder

getPointerKeyForGlobalVar

public PointerKey getPointerKeyForGlobalVar(String varName)

createEmptyCallGraph

protected ExplicitCallGraph createEmptyCallGraph(IMethod fakeRootClass,
 AnalysisOptions options)

Overrides:

createEmptyCallGraph in class AstSSAPropagationCallGraphBuilder

makeTypeInference

protected TypeInference makeTypeInference(IR ir,
 IClassHierarchy cha)

addAssignmentsForCatchPointerKey

protected void addAssignmentsForCatchPointerKey(PointerKey exceptionVar,
 Set<IClass> catchClasses,
 PointerKey e)

Description copied from class: PropagationCallGraphBuilder

Generate a set of constraints to represent assignment to an exception variable in a catch clause. Note that we use FilterOperator to filter out types that the exception handler doesn't catch.

Overrides:

addAssignmentsForCatchPointerKey in class PropagationCallGraphBuilder

Parameters:

exceptionVar - points-to set for a variable representing a caught exception

catchClasses - set of TypeReferences that the exceptionVar may catch

e - points-to-set representing a thrown exception that might be caught.

makeInterestingVisitor

protected SSAPropagationCallGraphBuilder.InterestingVisitor makeInterestingVisitor(CGNode node,
 int vn)

Overrides:

makeInterestingVisitor in class AstSSAPropagationCallGraphBuilder

makeSystem

protected PropagationSystem makeSystem(AnalysisOptions options)

Overrides:

makeSystem in class AstSSAPropagationCallGraphBuilder

makeVisitor

public JSSSAPropagationCallGraphBuilder.JSConstraintVisitor makeVisitor(CGNode node)

Overrides:

makeVisitor in class AstSSAPropagationCallGraphBuilder

Returns:

a visitor to examine instructions in the ir

getSomePositionForMethod

public static CAstSourcePositionMap.Position getSomePositionForMethod(IR ir,
 AstMethod method)

processCallingConstraints

protected void processCallingConstraints(CGNode caller,
 SSAAbstractInvokeInstruction instruction,
 CGNode target,
 InstanceKey[][] constParams,
 PointerKey uniqueCatchKey)

Overrides:

processCallingConstraints in class SSAPropagationCallGraphBuilder

processCallingConstraintsInternal

public static void processCallingConstraintsInternal(AstSSAPropagationCallGraphBuilder builder,
 CGNode caller,
 SSAAbstractInvokeInstruction instruction,
 CGNode target,
 InstanceKey[][] constParams,
 PointerKey uniqueCatchKey)

sameMethod

protected boolean sameMethod(CGNode opNode,
 String definingMethod)

Description copied from class: AstSSAPropagationCallGraphBuilder

Is definingMethod the same as the method represented by opNode? We need this since the names for methods in some languages don't map in the straightforward way to the CGNode

Specified by:

sameMethod in class AstSSAPropagationCallGraphBuilder