Class AnalysisScope

java.lang.Object

com.ibm.wala.ipa.callgraph.AnalysisScope

Direct Known Subclasses:

CAstAnalysisScope, HybridAnalysisScope, JavaSourceAnalysisScope

public class AnalysisScope
extends Object

Base class that represents a set of files to analyze.

The analysis scope is partitioned by class loader. There are three pre-defined class loader scopes:

• Primordial (for rt.jar, the core classes)
• Extension (for extension libraries in $JRE/lib/ext)
• Application (for the classes of the application)

Each class loader will load a set of classes described by a Module.

Field Summary

Fields

Modifier and Type	Field	Description
static final Atom	APPLICATION
static final Atom	EXTENSION
final LinkedHashMap<Atom, ClassLoaderReference>	loadersByName
static final Atom	PRIMORDIAL
static final Atom	SYNTHETIC

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AnalysisScope(Collection<? extends Language> languages)

Method Summary

Modifier and Type	Method	Description
void	addClassFileToScope(ClassLoaderReference loader, File file)	Add a class file to the scope for a loader
void	addInputStreamForJarToScope(ClassLoaderReference loader, InputStream stream)	Add a jar file to the scope via an InputStream.
void	addJDKModuleToScope(String moduleName)	Adds a module from the Java standard library to the analysis scope.
void	addSourceFileToScope(ClassLoaderReference loader, File file, String fileName)	Add a class file to the scope for a loader
void	addToScope(AnalysisScope other)	Add all modules from another scope
void	addToScope(ClassLoaderReference loader, Module m)	Add a module to the scope for a loader
void	addToScope(ClassLoaderReference loader, JarFile file)	Add a jar file to the scope for a loader
void	addToScopeHead(ClassLoaderReference loader, Module m)	Add a module file to the scope for a loader.
protected ClassLoaderReference	classLoaderName2Ref(String clName)
static AnalysisScope	createJavaAnalysisScope()	Create an analysis scope initialized for analysis of Java
MethodReference	findMethod(Atom loader, String klass, Atom name, ImmutableByteArray desc)	Utility function.
ClassLoaderReference	getApplicationLoader()	Return the information regarding the application loader.
ArrayClassLoader	getArrayClassLoader()
Set<Language>	getBaseLanguages()
StringFilter	getExclusions()
protected Object	getExclusionString()
ClassLoaderReference	getExtensionLoader()	Return the information regarding the extension loader.
String	getJavaLibraryVersion()
Language	getLanguage(Atom name)
Collection<Language>	getLanguages()
ClassLoaderReference	getLoader(Atom name)
String	getLoaderImpl(ClassLoaderReference ref)
Collection<ClassLoaderReference>	getLoaders()
List<Module>	getModules(ClassLoaderReference loader)
int	getNumberOfLoaders()
ClassLoaderReference	getPrimordialLoader()	Return the information regarding the primordial loader.
ClassLoaderReference	getSyntheticLoader()	Return the information regarding the application loader.
protected void	initCoreForJava()	Initialize the standard 3 class loaders for java analysis
protected void	initForJava()	Initialize a scope for java analysis
protected void	initSynthetic(ClassLoaderReference parent)	Create the class loader for synthetic classes.
boolean	isApplicationLoader(IClassLoader loader)
boolean	isJava14Libraries()
boolean	isJava15Libraries()
boolean	isJava16Libraries()
boolean	isJava17Libraries()
boolean	isJava18Libraries()
void	setExclusions(SetOfClasses classes)	Deprecated, for removal: This API element is subject to removal in a future version. Use setExclusions(StringFilter)} instead.
void	setExclusions(StringFilter classes)
void	setLoaderImpl(ClassLoaderReference ref, String implClass)
String	toJson()	An AnalysisScope is converted to a JSON formatted variable using the loaders and exclusions hierarchy using ToJson.
ShallowAnalysisScope	toShallowAnalysisScope()	Creates a "serializable" version of the analysis scope.
String	toString()

Methods inherited from class Object

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

Field Details

PRIMORDIAL

public static final Atom PRIMORDIAL

EXTENSION

public static final Atom EXTENSION

APPLICATION

public static final Atom APPLICATION

SYNTHETIC

public static final Atom SYNTHETIC

loadersByName

public final LinkedHashMap<Atom, ClassLoaderReference> loadersByName

Constructor Details

AnalysisScope

protected AnalysisScope(Collection<? extends Language> languages)

Method Details

createJavaAnalysisScope

public static AnalysisScope createJavaAnalysisScope()

Create an analysis scope initialized for analysis of Java

initForJava

protected void initForJava()

Initialize a scope for java analysis

initCoreForJava

protected void initCoreForJava()

Initialize the standard 3 class loaders for java analysis

initSynthetic

protected void initSynthetic(ClassLoaderReference parent)

Create the class loader for synthetic classes.

getLanguage

public Language getLanguage(Atom name)

isApplicationLoader

public boolean isApplicationLoader(IClassLoader loader)

getPrimordialLoader

public ClassLoaderReference getPrimordialLoader()

Return the information regarding the primordial loader.

getExtensionLoader

public ClassLoaderReference getExtensionLoader()

Return the information regarding the extension loader.

getApplicationLoader

public ClassLoaderReference getApplicationLoader()

Return the information regarding the application loader.

getSyntheticLoader

public ClassLoaderReference getSyntheticLoader()

Return the information regarding the application loader.

getLanguages

public Collection<Language> getLanguages()

Returns:

the set of languages to be processed during this analysis session.

getBaseLanguages

public Set<Language> getBaseLanguages()

Returns:

the set of "base languages," each of which defines a family of compatible languages, and therefore induces a distinct ClassHierarchy

addSourceFileToScope

public void addSourceFileToScope(ClassLoaderReference loader,
 File file,
 String fileName)
                          throws IllegalArgumentException

Add a class file to the scope for a loader

Throws:

IllegalArgumentException

addClassFileToScope

public void addClassFileToScope(ClassLoaderReference loader,
 File file)
                         throws IllegalArgumentException,
InvalidClassFileException

Add a class file to the scope for a loader

Throws:

IllegalArgumentException

InvalidClassFileException

addJDKModuleToScope

public void addJDKModuleToScope(String moduleName)
                         throws IOException

Adds a module from the Java standard library to the analysis scope.

Parameters:

moduleName - the name of the module, e.g., "java.sql"

Throws:

IOException - if a module by that name cannot successfully be loaded

addInputStreamForJarToScope

public void addInputStreamForJarToScope(ClassLoaderReference loader,
 InputStream stream)
                                 throws IOException

Add a jar file to the scope via an InputStream. NOTE: The InputStream should *not* be a JarInputStream; it should be a regular InputStream for the raw bytes of the jar file.

Throws:

IOException

addToScope

public void addToScope(ClassLoaderReference loader,
 JarFile file)

Add a jar file to the scope for a loader

addToScope

public void addToScope(ClassLoaderReference loader,
 Module m)

Add a module to the scope for a loader

addToScope

public void addToScope(AnalysisScope other)

Add all modules from another scope

addToScopeHead

public void addToScopeHead(ClassLoaderReference loader,
 Module m)

Add a module file to the scope for a loader. The classes in the added jar file will override classes added to the scope so far.

getLoader

public ClassLoaderReference getLoader(Atom name)
                               throws IllegalArgumentException

Returns:

the ClassLoaderReference specified by name.

Throws:

IllegalArgumentException - if name is null

classLoaderName2Ref

protected ClassLoaderReference classLoaderName2Ref(String clName)

getLoaderImpl

public String getLoaderImpl(ClassLoaderReference ref)

setLoaderImpl

public void setLoaderImpl(ClassLoaderReference ref,
 @Language("jvm-class-name")
 String implClass)

getLoaders

public Collection<ClassLoaderReference> getLoaders()

getNumberOfLoaders

public int getNumberOfLoaders()

getExclusions

public StringFilter getExclusions()

setExclusions

@Deprecated(since="1.6.12",
            forRemoval=true)
public void setExclusions(SetOfClasses classes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setExclusions(StringFilter)} instead.

setExclusions

public void setExclusions(StringFilter classes)

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

An AnalysisScope is converted to a JSON formatted variable using the loaders and exclusions hierarchy using ToJson. (Loaders) Primordial, Extension, Application, and Synthetic are the loaders keys; each one contains an arraylist of Strings. The exclusions contains an arraylist of strings.

Returns:

json variable containing contents of the AnalysisScope

getExclusionString

protected Object getExclusionString()

Returns:

a String that describes exclusions from the analysis scope.

findMethod

public MethodReference findMethod(Atom loader,
 String klass,
 Atom name,
 ImmutableByteArray desc)

Utility function. Useful when parsing input.

getModules

public List<Module> getModules(ClassLoaderReference loader)

getArrayClassLoader

public ArrayClassLoader getArrayClassLoader()

Returns:

Returns the arrayClassLoader.

getJavaLibraryVersion

public String getJavaLibraryVersion()
                             throws IllegalStateException

Throws:

IllegalStateException

isJava18Libraries

public boolean isJava18Libraries()
                          throws IllegalStateException

Throws:

IllegalStateException

isJava17Libraries

public boolean isJava17Libraries()
                          throws IllegalStateException

Throws:

IllegalStateException

isJava16Libraries

public boolean isJava16Libraries()
                          throws IllegalStateException

Throws:

IllegalStateException

isJava15Libraries

public boolean isJava15Libraries()
                          throws IllegalStateException

Throws:

IllegalStateException

isJava14Libraries

public boolean isJava14Libraries()
                          throws IllegalStateException

Throws:

IllegalStateException

toShallowAnalysisScope

public ShallowAnalysisScope toShallowAnalysisScope()
                                            throws NotSerializableException

Creates a "serializable" version of the analysis scope.

Returns:

a "serializable" version of the analysis scope.

Throws:

NotSerializableException