com.ibm.wala.ipa.callgraph.impl

Class Util

java.lang.Object

com.ibm.wala.ipa.callgraph.impl.Util

public class Util
extends java.lang.Object

Call graph utilities

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	nativeSpec TODO: Make these properties?

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static void	addBypassLogic(AnalysisOptions options, AnalysisScope scope, java.lang.ClassLoader cl, java.lang.String xmlFile, IClassHierarchy cha) Modify an options object to include bypass logic as specified by a an XML file.
static void	addBypassLogic(AnalysisOptions options, AnalysisScope scope, java.lang.ClassLoader cl, XMLMethodSummaryReader summary, IClassHierarchy cha)
static void	addDefaultBypassLogic(AnalysisOptions options, AnalysisScope scope, java.lang.ClassLoader cl, IClassHierarchy cha)
static void	addDefaultSelectors(AnalysisOptions options, IClassHierarchy cha) Set up an AnalysisOptions object with default selectors, corresponding to class hierarchy lookup
static <T> void	checkGraphSubset(com.ibm.wala.util.graph.Graph<T> supG, com.ibm.wala.util.graph.Graph<T> subG)
static java.lang.String	getNativeSpec()
static java.lang.Iterable<Entrypoint>	makeMainEntrypoints(AnalysisScope scope, IClassHierarchy cha)
static java.lang.Iterable<Entrypoint>	makeMainEntrypoints(AnalysisScope scope, IClassHierarchy cha, java.lang.String className)
static java.lang.Iterable<Entrypoint>	makeMainEntrypoints(AnalysisScope scope, IClassHierarchy cha, java.lang.String[] classNames)
static java.lang.Iterable<Entrypoint>	makeMainEntrypoints(ClassLoaderReference clr, IClassHierarchy cha)
static java.lang.Iterable<Entrypoint>	makeMainEntrypoints(ClassLoaderReference loaderRef, IClassHierarchy cha, java.lang.String[] classNames)
static SSAPropagationCallGraphBuilder	makeNCFABuilder(int n, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope) make a CallGraphBuilder that uses call-string context sensitivity, with call-string length limited to n, and a context-sensitive allocation-site-based heap abstraction.
static SSAPropagationCallGraphBuilder	makeNObjBuilder(int n, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope) make a CallGraphBuilder that uses object context sensitivity, with allocation-string length limited to n
static CallGraphBuilder<InstanceKey>	makeRTABuilder(AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope)
static SSAPropagationCallGraphBuilder	makeVanillaNCFABuilder(int n, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope) make a CallGraphBuilder that uses call-string context sensitivity, with call-string length limited to n, and a context-sensitive allocation-site-based heap abstraction.
static SSAPropagationCallGraphBuilder	makeVanillaNObjBuilder(int n, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope) make a CallGraphBuilder that uses object context sensitivity, with allocation-string length limited to n
static SSAPropagationCallGraphBuilder	makeVanillaZeroOneCFABuilder(Language l, AnalysisOptions options, IAnalysisCacheView analysisCache, IClassHierarchy cha, AnalysisScope scope)
static SSAPropagationCallGraphBuilder	makeVanillaZeroOneCFABuilder(Language l, AnalysisOptions options, IAnalysisCacheView analysisCache, IClassHierarchy cha, AnalysisScope scope, ContextSelector customSelector, SSAContextInterpreter customInterpreter)
static SSAPropagationCallGraphBuilder	makeVanillaZeroOneContainerCFABuilder(AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope)
static SSAPropagationCallGraphBuilder	makeZeroCFABuilder(Language l, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope)
static SSAPropagationCallGraphBuilder	makeZeroCFABuilder(Language l, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope, ContextSelector customSelector, SSAContextInterpreter customInterpreter)
static SSAPropagationCallGraphBuilder	makeZeroContainerCFABuilder(AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope)
static SSAPropagationCallGraphBuilder	makeZeroOneCFABuilder(Language l, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope)
static SSAPropagationCallGraphBuilder	makeZeroOneCFABuilder(Language l, AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope, ContextSelector customSelector, SSAContextInterpreter customInterpreter)
static SSAPropagationCallGraphBuilder	makeZeroOneContainerCFABuilder(AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope)
static SSAPropagationCallGraphBuilder	makeZeroOneContainerCFABuilder(AnalysisOptions options, IAnalysisCacheView cache, IClassHierarchy cha, AnalysisScope scope, ContextSelector appSelector, SSAContextInterpreter appInterpreter)
static <T> java.util.Set<T>	setify(java.util.Iterator<? extends T> x) create a set holding the contents of an Iterator
static void	setNativeSpec(java.lang.String xmlFile)

Methods inherited from class java.lang.Object

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

Field Detail

nativeSpec

public static java.lang.String nativeSpec

TODO: Make these properties?

Constructor Detail

Util

public Util()

Method Detail

setNativeSpec

public static void setNativeSpec(java.lang.String xmlFile)

getNativeSpec

public static java.lang.String getNativeSpec()

addDefaultSelectors

public static void addDefaultSelectors(AnalysisOptions options,
                                       IClassHierarchy cha)

Set up an AnalysisOptions object with default selectors, corresponding to class hierarchy lookup

Throws:

java.lang.IllegalArgumentException - if options is null

addBypassLogic

public static void addBypassLogic(AnalysisOptions options,
                                  AnalysisScope scope,
                                  java.lang.ClassLoader cl,
                                  java.lang.String xmlFile,
                                  IClassHierarchy cha)
                           throws java.lang.IllegalArgumentException

Modify an options object to include bypass logic as specified by a an XML file.

Throws:

java.lang.IllegalArgumentException - if scope is null

java.lang.IllegalArgumentException - if cl is null

java.lang.IllegalArgumentException - if options is null

java.lang.IllegalArgumentException - if scope is null

addBypassLogic

public static void addBypassLogic(AnalysisOptions options,
                                  AnalysisScope scope,
                                  java.lang.ClassLoader cl,
                                  XMLMethodSummaryReader summary,
                                  IClassHierarchy cha)
                           throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

makeMainEntrypoints

public static java.lang.Iterable<Entrypoint> makeMainEntrypoints(AnalysisScope scope,
                                                                 IClassHierarchy cha)

Returns:

set of all eligible Main classes in the class hierarchy

Throws:

java.lang.IllegalArgumentException - if scope is null

makeMainEntrypoints

public static java.lang.Iterable<Entrypoint> makeMainEntrypoints(ClassLoaderReference clr,
                                                                 IClassHierarchy cha)

makeMainEntrypoints

public static java.lang.Iterable<Entrypoint> makeMainEntrypoints(AnalysisScope scope,
                                                                 IClassHierarchy cha,
                                                                 java.lang.String className)

Returns:

Entrypoints object for a Main J2SE class

makeMainEntrypoints

public static java.lang.Iterable<Entrypoint> makeMainEntrypoints(AnalysisScope scope,
                                                                 IClassHierarchy cha,
                                                                 java.lang.String[] classNames)

makeMainEntrypoints

public static java.lang.Iterable<Entrypoint> makeMainEntrypoints(ClassLoaderReference loaderRef,
                                                                 IClassHierarchy cha,
                                                                 java.lang.String[] classNames)
                                                          throws java.lang.IllegalArgumentException,
                                                                 java.lang.IllegalArgumentException,
                                                                 java.lang.IllegalArgumentException

Returns:

Entrypoints for a set of J2SE Main classes

Throws:

java.lang.IllegalArgumentException - if classNames == null

java.lang.IllegalArgumentException - if (classNames != null) and (0 < classNames.length) and (classNames[0] == null)

java.lang.IllegalArgumentException - if classNames.length == 0

setify

public static <T> java.util.Set<T> setify(java.util.Iterator<? extends T> x)

create a set holding the contents of an Iterator

checkGraphSubset

public static <T> void checkGraphSubset(com.ibm.wala.util.graph.Graph<T> supG,
                                        com.ibm.wala.util.graph.Graph<T> subG)

Throws:

java.lang.IllegalArgumentException - if subG is null

java.lang.IllegalArgumentException - if supG is null

makeRTABuilder

public static CallGraphBuilder<InstanceKey> makeRTABuilder(AnalysisOptions options,
                                                           IAnalysisCacheView cache,
                                                           IClassHierarchy cha,
                                                           AnalysisScope scope)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

Returns:

an RTA Call Graph builder.

makeZeroCFABuilder

public static SSAPropagationCallGraphBuilder makeZeroCFABuilder(Language l,
                                                                AnalysisOptions options,
                                                                IAnalysisCacheView cache,
                                                                IClassHierarchy cha,
                                                                AnalysisScope scope)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

Returns:

a 0-CFA Call Graph Builder.

makeZeroCFABuilder

public static SSAPropagationCallGraphBuilder makeZeroCFABuilder(Language l,
                                                                AnalysisOptions options,
                                                                IAnalysisCacheView cache,
                                                                IClassHierarchy cha,
                                                                AnalysisScope scope,
                                                                ContextSelector customSelector,
                                                                SSAContextInterpreter customInterpreter)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

customSelector - user-defined context selector, or null if none

customInterpreter - user-defined context interpreter, or null if none

Returns:

a 0-CFA Call Graph Builder.

Throws:

java.lang.IllegalArgumentException - if options is null

makeZeroOneCFABuilder

public static SSAPropagationCallGraphBuilder makeZeroOneCFABuilder(Language l,
                                                                   AnalysisOptions options,
                                                                   IAnalysisCacheView cache,
                                                                   IClassHierarchy cha,
                                                                   AnalysisScope scope)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

Returns:

a 0-1-CFA Call Graph Builder.

makeVanillaZeroOneCFABuilder

public static SSAPropagationCallGraphBuilder makeVanillaZeroOneCFABuilder(Language l,
                                                                          AnalysisOptions options,
                                                                          IAnalysisCacheView analysisCache,
                                                                          IClassHierarchy cha,
                                                                          AnalysisScope scope,
                                                                          ContextSelector customSelector,
                                                                          SSAContextInterpreter customInterpreter)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

customSelector - user-defined context selector, or null if none

customInterpreter - user-defined context interpreter, or null if none

Returns:

a 0-1-CFA Call Graph Builder.

Throws:

java.lang.IllegalArgumentException - if options is null

makeVanillaZeroOneCFABuilder

public static SSAPropagationCallGraphBuilder makeVanillaZeroOneCFABuilder(Language l,
                                                                          AnalysisOptions options,
                                                                          IAnalysisCacheView analysisCache,
                                                                          IClassHierarchy cha,
                                                                          AnalysisScope scope)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

Returns:

a 0-1-CFA Call Graph Builder.

makeZeroOneCFABuilder

public static SSAPropagationCallGraphBuilder makeZeroOneCFABuilder(Language l,
                                                                   AnalysisOptions options,
                                                                   IAnalysisCacheView cache,
                                                                   IClassHierarchy cha,
                                                                   AnalysisScope scope,
                                                                   ContextSelector customSelector,
                                                                   SSAContextInterpreter customInterpreter)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

customSelector - user-defined context selector, or null if none

customInterpreter - user-defined context interpreter, or null if none

Returns:

a 0-1-CFA Call Graph Builder.

Throws:

java.lang.IllegalArgumentException - if options is null

makeZeroContainerCFABuilder

public static SSAPropagationCallGraphBuilder makeZeroContainerCFABuilder(AnalysisOptions options,
                                                                         IAnalysisCacheView cache,
                                                                         IClassHierarchy cha,
                                                                         AnalysisScope scope)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

Returns:

a 0-CFA Call Graph Builder augmented with extra logic for containers

Throws:

java.lang.IllegalArgumentException - if options is null

makeZeroOneContainerCFABuilder

public static SSAPropagationCallGraphBuilder makeZeroOneContainerCFABuilder(AnalysisOptions options,
                                                                            IAnalysisCacheView cache,
                                                                            IClassHierarchy cha,
                                                                            AnalysisScope scope)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

Returns:

a 0-1-CFA Call Graph Builder augmented with extra logic for containers

Throws:

java.lang.IllegalArgumentException - if options is null

makeZeroOneContainerCFABuilder

public static SSAPropagationCallGraphBuilder makeZeroOneContainerCFABuilder(AnalysisOptions options,
                                                                            IAnalysisCacheView cache,
                                                                            IClassHierarchy cha,
                                                                            AnalysisScope scope,
                                                                            ContextSelector appSelector,
                                                                            SSAContextInterpreter appInterpreter)

makeNCFABuilder

public static SSAPropagationCallGraphBuilder makeNCFABuilder(int n,
                                                             AnalysisOptions options,
                                                             IAnalysisCacheView cache,
                                                             IClassHierarchy cha,
                                                             AnalysisScope scope)

make a CallGraphBuilder that uses call-string context sensitivity, with call-string length limited to n, and a context-sensitive allocation-site-based heap abstraction.

makeNObjBuilder

public static SSAPropagationCallGraphBuilder makeNObjBuilder(int n,
                                                             AnalysisOptions options,
                                                             IAnalysisCacheView cache,
                                                             IClassHierarchy cha,
                                                             AnalysisScope scope)

make a CallGraphBuilder that uses object context sensitivity, with allocation-string length limited to n

makeVanillaNObjBuilder

public static SSAPropagationCallGraphBuilder makeVanillaNObjBuilder(int n,
                                                                    AnalysisOptions options,
                                                                    IAnalysisCacheView cache,
                                                                    IClassHierarchy cha,
                                                                    AnalysisScope scope)

make a CallGraphBuilder that uses object context sensitivity, with allocation-string length limited to n

makeVanillaNCFABuilder

public static SSAPropagationCallGraphBuilder makeVanillaNCFABuilder(int n,
                                                                    AnalysisOptions options,
                                                                    IAnalysisCacheView cache,
                                                                    IClassHierarchy cha,
                                                                    AnalysisScope scope)

make a CallGraphBuilder that uses call-string context sensitivity, with call-string length limited to n, and a context-sensitive allocation-site-based heap abstraction. Standard optimizations in the heap abstraction like smushing of strings are disabled.

makeVanillaZeroOneContainerCFABuilder

public static SSAPropagationCallGraphBuilder makeVanillaZeroOneContainerCFABuilder(AnalysisOptions options,
                                                                                   IAnalysisCacheView cache,
                                                                                   IClassHierarchy cha,
                                                                                   AnalysisScope scope)

Parameters:

options - options that govern call graph construction

cha - governing class hierarchy

scope - representation of the analysis scope

Returns:

a 0-1-CFA Call Graph Builder augmented with extra logic for containers

Throws:

java.lang.IllegalArgumentException - if options is null

addDefaultBypassLogic

public static void addDefaultBypassLogic(AnalysisOptions options,
                                         AnalysisScope scope,
                                         java.lang.ClassLoader cl,
                                         IClassHierarchy cha)