---

Home | DMP | Project | Journal | Contact
Relevant Java Classes | Delete Call Site | Template Call Graph | Research | Final Report
FLEX Javadoc Documentation | Java 2 Platform SE v. 1.4

---

CALL - Represents a method invocation (call site).
CallGraph (harpoon.Analysis) - A general IR-independent interface for a call graph. IR-specific subclasses (see harpoon.Analysis.Quads.CallGraph) can provide call-site information.
CallGraph (harpoon.Analysis.Quads) - A general interface that should be implemented by a call graph.
CFGEdge - Connects two CFGraphables in a graph structure.
CFGraphable - Defines an interface for intermediate representations that are inherently interconnected in a directed control flow graph.
Edge - Connects Quad nodes in the control flow graph.
FakeMetaCallGraph - Converts a classic CallGraph to a MetaCallGraph. Offers a MetaMethods view of the call graph without doing any specialization.
GenType - Models a type.
HClass - Instances of HClass represent classes and interfaces of a java program.
HCode - Abstract class that all views of a particular method's executable code should extend. Corresponds roughly to a list of instructions.
HCodeEdge - Connects two HCodeElements in a graph structure.
HCodeElement - An interface that all views of a particular method's executable instructions should implement. Components of an HCode.
HMethod - Provides information about, and access to, a single method on a class or interface.
Map - Maps keys to values. Cannot contain duplicate keys.
MetaAllCallers - Computes the callers (MetaMethods) of each meta-method from the program. Inverts the edges of the graph computed in MetaCallGraph.
MetaCallGraph - MetaCallGraph is for meta methods what CallGraph is for "normal" methods. It provides information on what meta methods are called by a given meta method (at a specific call site).
MetaCallGraphAbstr - Abstract implementation of the MetaCallGraph interface.
MetaCallGraphImpl - Full-power implementation of the MetaCallGraph interface.
MetaMethod - Specialization of a method; a function of the types of its arguments.
Quad - The base class for the quadruple representation.
ReachingDefs - Defines an abstract class for analyzing reching definitions.
ReachingDefsAltImpl - An implementation of ReachingDefs
ReachingDefsImpl - Defines an implementation for analyzing reaching definitions.
Relation - A mathematical relation; accepts 1-many and many-1 mappings.
RETURN - Indicates a method return, with an optional return value.
SCComponent - Models a strongly connected component of a graph.
Set - A collection that contains no duplicate elements. Models the mathematical set abstraction.
SetHClass - Represents concrete type.
SmartCallGraph - Smart call graph.
Temp - Represents a temporary variable.
TypeInference - A simple type inference module. Can be used to compute the types of a set of ExactTemps.
TypeInfo - A simple type analysis tool for quad-ssi form.

CALL

• DESCRIPTION
  • CALL objects represent method invocations.
  • The retval field will be null for void methods.
  • For non-static methods, the method receiver is the first parameter in the params array.
  • CALL behaves like a conditional branch. If no exception is thrown by the called method, the Temp specified by retval will be assigned the return value, if any, and execution will follow the first outgoing edge, nextEdge(0). If an exception is thrown, the Temp specified by retex will be assigned the non-null reference to the thrown exception and execution will follow the second outgoing edge, nextEdge(1). Calls with explicit exception handling always have exactly two outgoing edges.
  • In quad-with-try form, the CALL has only one outgoing edge, and exceptions are handled by an implicit control transfer to an appropriate HANDLER quad. The retex field should be null in this case (and only in this case).
  • Note that exactly one of { retval, retex } will be defined after the execution of CALL; thus, it is perfectly valid for retval and retex to be identical. Of course, for type safety, the return type cannot be primitive if this is so. The Temp not defined by the CALL (if the retex and retval Temps are different) is undefined; it may have any value at all after the CALL. Both IR.LowQuad.PCALL and IR.Tree.CALL also behave this way.
• LOCATION / INHERITANCE
  • harpoon.IR.Quads
  • public class
  • extends SIGMA
  • All implemented interfaces - CFGraphable, Cloneable, Comparable, HCodeElement, Serializable, UseDefable
• FIELDS
  • protected final HMethod method
    The method to invoke.
  • protected Temp[] params
    Parameters to pass to the method. The receiver object (object on which to invoke the method) is the first element in the parameter list of a virtual method.
  • protected Temp retval
    Destination for the method's return value; null for void methods.
  • protected Temp retex
    Destination for any exception thrown by the method. If null exceptions are thrown, not caught.
  • protected final boolean isVirtual
    Special flag for non-virtual methods. (INVOKESPECIAL has different invocation semantics.)
  • protected final boolean isTailCall
    Special flag for tail calls.
  • Fields inherited from class harpoon.IR.Quads.SIGMA - dst, src
  • Fields inherited from class harpoon.IR.Quads.Quad - arrayFactory
• METHODS
  • Constructors
    • public CALL(QuadFactory qf, HCodeElement source, HMethod method, Temp[] params, Temp retval, Temp retex, boolean isVirtual, boolean isTailCall, Temp[][] dst, Temp[] src)
      Creates a CALL quad representing a method invocation with explicit exception handling.
    • public CALL(QuadFactory qf, HCodeElement source, HMethod method, Temp[] params, Temp retval, Temp retex, boolean isVirtual, boolean isTailCall, Temp[] src)
      Creates a CALL with an empty dst array of the proper size.
    • Parameters:
      • method - the method to invoke
      • params - an array of Temps containing the parameters to pass to the method. The receiver is the first element in the parameter list of a non-static method; static methods do not need to specify a receiver. For static methods, params should match exactly the number and types of parameters in the method descriptor. For non-static methods, the receiver object (which is not included in the descriptor) is element zero of the params array.
      • retval - the destination Temp for the method's return value, or null if the method returns no value (return type is void).
      • retex - the destination Temp for any exception thrown by the called method. If null, then this CALL has arity one and handles exceptions implicitly; otherwise, it has arity two and exception handling is explicit.
      • isVirtual - true if invocation semantics are that of a virtual method; false for constructors, private methods, and static initializers, which have non-virtual invocation semantics. Value doesn't matter for static methods; the isVirtual() method will always return false in this case.
      • isTailCall - true if this method should return the same value the callee returns or throw whatever exception the callee throws (in which case we can get rid of our stack and let the callee return directly to our caller). Usually false.
      • dst - the elements of the pairs on the left-hand side of the sigma function assignment block associated with this CALL.
      • src - the arguments to the sigma functions associated with this CALL.
  • method
    public HMethod method()
    Returns the method invoked by this CALL.
  • params
    public Temp[] params()
    Returns the parameters of this method invocation.
  • params
    public Temp params(int i)
    Returns a specified parameter (at index i?) in the params array.
  • paramsLength
    public int paramsLength()
    Returns the number of parameters in the params array.
  • paramType
    public HClass paramType(int i)
    Returns the type of the specified parameter.
  • retval
    public Temp retval()
    Returns the Temp that will hold the return value of the method, or the value null if the method returns no value.
  • retex
    public Temp retex()
    Returns the Temp that will get any exception thrown by the called method, or null if exceptions are not caught.
  • isVirtual
    public boolean isVirtual()
    Returns true if the method is dispatched virtually, false otherwise. Static methods return false, constructors and static initializers return false, and all other method types return true.
  • isTailCall
    public boolean isTailCall()
    Returns true if this method should return the same value the callee returns or throw whatever exception the callee throws (in which case we can get rid of our stack and let the callee return directly to our caller). Usually false.
  • use
    public Temp[] use()
    Returns all the Temps used by this Quad.
    Specified by: use in interface UseDefable
    Overrides: use in class SIGMA
    Returns: the params array
  • def
    public Temp[] def()
    Returns all the Temps defined by this Quad.
    Specified by: def in interface UseDefable
    Overrides: def in class SIGMA
    Returns: the non-null members of { retval, retex }
    
  • kind
    public int kind()
    Returns an integer enumeration of the kind of this Quad. The enumerated values are defined in QuadKind.
    Specified by: kind in class Quad
  • rename
    public Quad rename(QuadFactory qqf, TempMap defMap, TempMap useMap)
    Creates a new Quad identical to the receiver but with all Temps renamed according to a mapping. The new Quad will have no edges and will come from the specified QuadFactory qqf.
    Specified by: rename in class Quad
  • accept
    public void accept(QuadVisitor v)
    Accept a visitor.
    Overrides: accept in class SIGMA
  • toString
    public String toString()
    Returns human-readable representation of the receiver object.
    Overrides: toString in class SIGMA
  • isInterfaceMethod
    public boolean isInterfaceMethod()
    Determines whether this CALL is to an interface method.
  • isStatic
    public boolean isStatic()
    Determines whether this CALL is to a static method.
  • Methods inherited from class harpoon.IR.Quads.SIGMA - arity, assign, dst, dst, dst, numSigmas, removeSigma, src, src
  • Methods inherited from class harpoon.IR.Quads.Quad - addEdge, addEdges, addHandlers, clone, clone, clone, compareTo, defC, edgeC, edges, getFactory, getID, getLineNumber, getSourceFile, handlers, hashCode, map, map, map, next, next, nextEdge, nextEdge, nextLength, pred, predC, prev, prev, prevEdge, prevEdge, prevLength, remove, removeHandlers, rename, replace, succ, succC, transferHandlers, useC

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

CallGraph (harpoon.Analysis)

• DESCRIPTION
  • General IR-independent interface for a call graph
  • IR-specific subclasses (see harpoon.Analysis.Quads.CallGraph) can provide call-site information.
• LOCATION / INHERITANCE
  • harpoon.Analysis
  • public interface
  • All known subinterfaces - harpoon.Analysis.Quads.CallGraph
  • All known implementing classes - CachingCallGraph, CallGraphImpl, CallGraphImpl2, SmartCallGraph
• METHOD
  • calls
    public HMethod[] calls(HMethod hm)
    Returns an array containing all possible methods called by method hm. If hm doesn't call any methods, return an array of length 0.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

CallGraph (harpoon.Analysis.Quads)

• DESCRIPTION
  • General interface that should be implemented by a call graph
• LOCATION / INHERITANCE
  • harpoon.Analysis.Quads
  • public interface
  • extends CallGraph (harpoon.Analysis.CallGraph)
  • All known implementing classes - CachingCallGraph, CallGraphImpl, SmartCallGraph
• METHODS
  • calls
    public HMethod[] calls(HMethod hm, CALL cs)
    Returns an array containing all possible methods called by method m at the call site cs. If there is no known callee for the call site cs, or if cs doesn't belong to the code of hm, return an array of length 0.
  • getCallSites
    public CALL[] getCallSites(HMethod hm)
    Returns a list of all the CALLs quads in the code of hm.
  • callableMethods
    public Set callableMethods()
    Returns the set of all the methods that can be called in the execution of the program.
  • Methods inherited from interface harpoon.Analysis.CallGraph - calls

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

CFGEdge

• DESCRIPTION
  • Connects two CFGraphables in a graph structure
• LOCATION / INHERITANCE
  • harpoon.IR.Properties
  • public abstract class
  • extends Object
  • implements HCodeEdge
  • Direct known subclasses - Edge, InstrEdge
• METHODS
  • Constructor
    public CFGEdge()
  • from
    public HCodeElement from()
    Returns the source of this CFGEdge. The return value is guaranteed to implement to CFGraphable interface.
    Specified by: from in interface HCodeEdge
  • fromCFG
    public abstract CFGraphable fromCFG()
    Returns the source of this CFGEdge.
  • to
    public HCodeElement to()
    Returns the destination of this HCodeEdge. The return value is guaranteed to implement to CFGraphable interface.
    Specified by: to in interface HCodeEdge
  • toCFG
    public abstract CFGraphable toCFG()
    Returns the destination of this HCodeEdge.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

CFGraphable

• DESCRIPTION
  • Defines an interface for intermediate representations that are inherenly interconnected in a directed control flow graph.
• LOCATION / INHERITANCE
  • harpoon.IR.Properties
  • public interface
  • extends HCodeElement
  • All known implementing classes - Instr, Instr, Quad
• METHODS
  • edges
    public CFGEdge[] edges()
    Returns an array of all the edges to and from this CFGraphable.
  • pred
    public CFGEdge[] pred()
    Returns an array of all the edges entering this CFGraphable.
  • succ
    public CFGEdge[] succ()
    Returns an array of all the edges leaving this CFGraphable.
  • edgeC
    public Collection edgeC()
    Returns a Collection of all the edges to and from this HCodeElement.
  • predC
    public Collection predC()
    Returns a Collection of all the edges to this HCodeElement. Each CFGEdge returned is guaranteed to return this in response to a call to to(); the actual predecessor will be returned from from().
  • succC
    public Collection succC()
    Returns a Collection of all the edges from this HCodeElement. Each CFGEdge returned is guaranteed to return this in response to a call to from(); the actual successor to this will be returned from to().
  • Methods inherited from interface harpoon.ClassFile.HCodeElement - getID, getLineNumber, getSourceFile

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

Edge

• DESCRIPTION
  • Edge objects connect Quad nodes in the control flow graph.
  • The hashCode and equals methods of Edge have been implemented so that Edges can be used as hash table keys to associate analysis data with control flow edges.
• LOCATION / INHERITANCE
  • harpoon.IR.Quads
  • public class
  • extends CFGEdge
  • implements Serializable
  • All implemented interfaces - HCodeEdge, Serializable
• FIELD
  • public static final ArrayFactory arrayFactory
    Returns new Edge[].
• METHODS
  • fromCFG
    public CFGraphable fromCFG()
    Returns the source vertex of this Edge.
    Specified by: fromCFG in class CFGEdge
  • toCFG
    public CFGraphable toCFG()
    Returns the destination vertex of this Edge.
    Specified by: toCFG in class CFGEdge
  • which_pred
    public int which_pred()
    Returns the predecessor index of this Edge in to.
    this.to().prevEdge(this.which_pred()) == this.
  • which_succ
    public int which_succ()
    Returns the successor index of this Edge in from.
    this.from().nextEdge(this.which_succ()) == this.
  • equals
    public boolean equals(Object obj)
    Compares two Edges for equality.
    Overrides: equals in class Object
  • hashCode
    public int hashCode()
    Returns a hash code value for this object.
    Overrides: hashCode in class Object
  • toString
    public String toString()
    Returns a human-readable representation of the Edge.
    Overrides: toString in class Object
  • Methods inherited from class harpoon.IR.Properties.CFGEdge - from, to

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

FakeMetaCallGraph

• DESCRIPTION
  • Converts a classic CallGraph to a MetaCallGraph
  • Offers a MetaMethods view of the call graph without doing any specialization. This is possible because there is an obvious mapping from each method of the program to an unspecialized meta-method consisting of that method plus its declared parameter types (marked as polymorphic to cope with all the possible ways that method could be called).
  • Doesn't offer any additional power but allows the use of components that require "meta-methods" even without specializing methods to meta-methods.
  • Allows you to run things that need meta-method representation of the program without generating them by providing a meta-methods-like interface for the standard CallGraph.
• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public class
  • extends MetaCallGraphAbstr
  • All implemented interfaces - MetaCallGraph, Serializable
• METHODS
  • Constructor
    FakeMetaCallGraph(CallGraph cg, Set methods, Set runs)
    Creates a FakeMetaCallGraph.
  • Methods inherited from class harpoon.Analysis.MetaMethods.MetaCallGraphAbstr - getAllMetaMethods, getCallees, getCallees, getCallSites, getRunMetaMethods, getSplitRelation, getTransCallees, print

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

GenType

• DESCRIPTION
  • Models a type
  • Although we can always record the possible types of a variable as a set of HClasses, this is inefficient in many cases. GenType represents both monomorphic (corresponding to a single HCode) and polymorphic (corresponding to a set of HClasses, a type cone rooted in a specific HClass) types.
• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public class
  • extends Object
  • implements Serializable
• FIELDS
  • public static final int MONO
    Monomorphic type. This is an exact type - just the point hclass into the type space.
  • public static final int POLY
    Polymorphic type. This is a cone into the type space, rooted in hclass and containing hclass and all its subtypes (subclasses).
• METHODS
  • Constructors
    • public GenType(HClass hclass, int kind)
      Creates a GenType. kind should be MONO or POLY.
    • public GenType(HClass hclass)
      Creates a polymorphic type with hclass as superclass.
  • isPOLY
    public boolean isPOLY()
    Checks whether this is a polymorphic type.
  • getHClass
    public HClass getHClass()
    Returns the underlying HClass. If this general type represents a monomorphic type, the result is exactly that type. For polymorphic types, the result is the root of the type cone.
  • equals
    public boolean equals(Object o)
    Checks the equality of this object with object o.
    Overrides: equals in class Object
  • hashCode
    public int hashCode()
    Computes the hash code of this object.
    Overrides: hashCode in class Object
  • included
    public boolean included(GenType gt2, ClassHierarchy ch)
    Checks whether this general type is included into the set of types abstracted by the general type gt2.
  • toString
    public String toString()
    Pretty printer for debug purposes.
    Overrides: toString in class Object

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

HClass

• DESCRIPTION
  • Instances represent classes and interfaces of a Java program.
  • Every array belongs to a class that is reflected as an HClass object shared by all arrays with the same element type and number of dimensions.
  • The primitive types and the keyword void are also represented as HClass objects.
  • No public constructor. HClass objects are created with the forName, forDescriptor and forClass methods of this class.
• LOCATION / INHERITANCE
  • harpoon.ClassFile
  • public abstract class
  • extends harpoon.ClassFile.HPointer
  • implements Comparable, ReferenceUnique
• FIELDS
  • public static final HClass Boolean
    The HClass object representing the primitive type boolean.
  • public static final HClass Byte
    The HClass object representing the primitive type byte.
  • public static final HClass Short
    The HClass object representing the primitive type short.
  • public static final HClass Int
    The HClass object representing the primitive type int.
  • public static final HClass Long
    The HClass object representing the primitive type long.
  • public static final HClass Float
    The HClass object representing the primitive type float.
  • public static final HClass Double
    The HClass object representing the primitive type double.
  • public static final HClass Char
    The HClass object representing the primitive type char.
  • public static final HClass Void
    The HClass object representing the primitive type void.
  • public static final ArrayFactory arrayFactory
    Array factory - returns new HClass[].
• METHODS
  • getLinker
    public final Linker getLinker()
    Returns the linker responsible for the resolution of this HClass object.
  • getMutator
    public HClassMutator getMutator()
    Returns a mutator for this HClass, or null if this object is immutable.
  • hasBeenModified
    public boolean hasBeenModified()
    Determines whether any part of this HClass has been modified from its originally loaded state.
  • getComponentType
    public abstract HClass getComponentType()
    If this class represents an array type, returns the HClass object representing the component type of the array; otherwise returns null.
  • getName
    public abstract String getName()
    Returns a string representing the fully-qualified name of the type (class, interface, array, or primitive) represented by this HClass object.
    Overrides: getName in class harpoon.ClassFile.HPointer
    
  • getPackage
    public abstract String getPackage()
    Returns the package name of this HClass. If this HClass represents a primitive or array type, then returns null. Returns "" (a zero-length string) if this class is not in a package.
  • getDescriptor
    public abstract String getDescriptor()
    Returns a ComponentType descriptor for the type represented by this HClass object.
    Overrides: getDescriptor in class harpoon.ClassFile.HPointer
  • getDeclaredField
    public abstract HField getDeclaredField(String name) throws NoSuchFieldError
    Returns a HField object that reflects the specified declared field of the class or interface represented by this HClass object. The name parameter is a String that specifies the simple name of the desired field.
    Throws: NoSuchFieldError if a field with the specified name is not found
  • getDeclaredFields
    public abstract HField[] getDeclaredFields()
    Returns an array of HField objects reflecting all the fields declared by the class or interface represented by this HClass object. This includes public, protected, default (package) access, and private fields, but excludes inherited fields. Returns an array of length 0 if the class or interface declares no fields, or if this HClass object represents a primitive type.
  • getField
    public final HField getField(String name) throws NoSuchFieldError
    Returns a HField object that reflects the specified accessible member field of the class or interface represented by this HClass object. The name parameter is a String specifying the simple name of the desired field. The field to be reflected is located by searching all member fields of the class or interface represented by this HClass object (and its superclasses and interfaces) for an accessible field with the specified name.
    Throws: NoSuchFieldError if a field with the specified name is not found
  • getFields
    public HField[] getFields()
    Returns an array containing HField objects reflecting all the accessible fields of the class or interface represented by this HClass object. Returns an array of length 0 if the class or interface has no accessible fields, or if it represents an array type or a primitive type. Specifically, if this HClass object represents a class, returns the accessible fields of this class and of all its superclasses. If this HClass object represents an interface, returns the accessible fields of this interface and of all its superinterfaces. If this HClass object represents an array type or a primitive type, returns an array of length 0. The implicit length field for array types is not reflected by this method.
  • getDeclaredMethod
    public abstract HMethod getDeclaredMethod(String name, HClass[] parameterTypes) throws NoSuchMethodError
    Returns a HMethod object that reflects the specified declared method of the class or interface represented by this HClass object. The name parameter is a String that specifies the simple name of the desired method, and the parameterTypes parameter is an array of HClass objects that identify the method's formal parameter types, in declared order. Throws: NoSuchMethodError if a matching method is not found
  • getDeclaredMethod
    public abstract HMethod getDeclaredMethod(String name, String descriptor) throws NoSuchMethodError
    Returns a HMethod object that reflects the specified declared method of the class or interface represented by this HClass object. The name parameter is a String that specifies the simple name of the desired method, and descriptor is a string describing the parameter types and return value of the method.
    Throws: NoSuchMethodError if a matching method is not found
  • getDeclaredMethods
    public abstract HMethod[] getDeclaredMethods()
    Returns an array of HMethod objects reflecting all the methods declared by the class or interface represented by this HClass object. This includes public, protected, default (package) access, and private methods, but excludes inherited methods. Returns an array of length 0 if the class or interface declares no methods, or if this HClass object represents a primitive type. Constructors are included.
  • getMethod
    public final HMethod getMethod(String name, HClass[] parameterTypes) throws NoSuchMethodError
    Returns an HMethod object that reflects the specified accessible method of the class or interface represented by this HClass object. The name parameter is a string specifying the simple name of the desired method, and the parameterTypes parameter is an array of HClass objects that identify the method's formal parameter types, in declared order. The method to reflect is located by searching all the member methods of the class or interface represented by this HClass object for an accessible method with the specified name and exactly the same formal parameter types.
    Throws: NoSuchMethodError if a matching method is not found
  • getMethod
    public final HMethod getMethod(String name, String descriptor) throws NoSuchMethodError
    Returns an HMethod object that reflects the specified accessible method of the class or interface represented by this HClass object. The name parameter is a string specifying the simple name of the desired method, and the descriptor is a string describing the parameter types and return value of the method. The method is located by searching all the member methods of the class or interface represented by this HClass object for an accessible method with the specified name and exactly the same descriptor.
    Throws: NoSuchMethodError if a matching method is not found
  • getMethods
    public HMethod[] getMethods()
    Returns an array containing HMethod objects reflecting all accessible member methods of the class or interface represented by this HClass object, including those declared by the class or interface and those inherited from superclasses and superinterfaces. Returns an array of length 0 if the class or interface has no public member methods, or if the HClass corresponds to a primitive type or array type. Constructors are included.
  • getConstructor
    public abstract HConstructor getConstructor(HClass[] parameterTypes) throws NoSuchMethodError
    Returns an HConstructor object that reflects the specified declared constructor of the class or interface represented by this HClass object. The parameterTypes parameter is an array of HClass objects that identify the constructor's formal parameter types, in declared order.
    Throws: NoSuchMethodError if a matching method is not found
  • getConstructors
    public abstract HConstructor[] getConstructors()
    Returns an array of HConstructor objects reflecting all the constructors declared by the class represented by the HClass object. These are public, protected, default (package) access, and private constructors. Returns an array of length 0 if this HClass object represents an interface or a primitive type.
  • getClassInitializer
    public abstract HInitializer getClassInitializer()
    Returns the class initializer method, if there is one; otherwise null.
  • getModifiers
    public abstract int getModifiers()
    Returns the Java language modifiers for this class or interface, encoded in an integer. The modifiers consist of the Java Virtual Machine's constants for public, protected, private, final, and interface; they should be decoded using the methods of class Modifier.
  • getSuperclass
    public abstract HClass getSuperclass()
    If this object represents any class other than the class Object, then the object that represents the superclass of that class is returned. If this object is the one that represents the class Object or this object represents an interface, null is returned. If this object represents an array, then the HClass representing java.lang.Object is returned.
  • getInterfaces
    public abstract HClass[] getInterfaces()
    Determines the interfaces implemented by the class or interface represented by this object. If this object represents a class, the return value is an array containing objects representing all interfaces implemented by the class. The order of the interface objects in the array corresponds to the order of the interface names in the implements clause of the declaration of the class represented by this object. If the object represents an interface, the array contains objects representing all interfaces extended by the interface. The order of the interface objects in the array corresponds to the order of the interface names in the extends clause of the declaration of the interface represented by this object. If the class or interface implements no interfaces, the method returns an array of length 0.
    NOTE THAT the array returned does NOT contain interfaces implemented by superclasses. Thus the interface list may be incomplete. This is pretty bogus behaviour, but it's what the FLEX prototype, java.lang.Class, does.
  • getSourceFile
    public abstract String getSourceFile()
    Return the name of the source file for this class, or a zero-length string if the information is not available.
  • getWrapper
    public final HClass getWrapper(Linker l)
    If this HClass is a primitive type, return the wrapper class for values of this type. For example, HClass.forDescriptor("I").getWrapper() will return l.forName("java.lang.Integer"). Calling getWrapper with a non-primitive HClass will return the value null.
  • isArray
    public abstract boolean isArray()
    If this HClass object represents an array type, returns true, otherwise returns false.
  • isInterface
    public abstract boolean isInterface()
    Determines if the specified HClass object represents an interface type. Returns true if this object represents an interface, false otherwise.
  • isPrimitive
    public abstract boolean isPrimitive()
    Determines if the specified HClass object represents a primitive Java type. There are nine predefined HClass objects to represent the eight primitive Java types and void.
  • isAssignableFrom
    public final boolean isAssignableFrom(HClass cls)
    Determines if the class or interface represented by this HClass object is either the same as, or is a superclass or superinterface of, the class or interface represented by the specified HClass parameter. It returns true if so, false otherwise. If this HClass object represents a primitive type, returns true if the specified HClass parameter is exactly this HClass object, false otherwise. Specifically, this method tests whether the type represented by the specified HClass parameter can be converted to the type represented by this HClass object via an identity conversion or via a widening reference conversion. Throws: NullPointerException if the specified HClass parameter is null
  • isSuperclassOf
    public final boolean isSuperclassOf(HClass hc)
    Determines if this HClass is a superclass of a given HClass hc. (Does not look at interface information.) Returns true if this is a superclass of hc, false otherwise.
  • isSuperinterfaceOf
    public final boolean isSuperinterfaceOf(HClass hc)
    Determines if this HClass is a superinterface of a given HClass hc. (Does not look at superclass information.) Returns true if this is a superinterface of hc, false otherwise.
  • isInstanceOf
    public final boolean isInstanceOf(HClass hc)
    Determines if this HClass is an instance of the given HClass hc.
  • hashCode
    public int hashCode()
    Description copied from class: harpoon.ClassFile.HPointer
    Returns a hashcode value for this HClass. The hashcode is identical to the hashcode for the class descriptor string.
    Overrides: hashCode in class harpoon.ClassFile.HPointer
  • toString
    public final String toString()
    Returns a string representation of this class object. Converts the object to a string. The string representation is the string "class" or "interface" followed by a space and then the fully qualified name of the class. If this HClass object represents a primitive type, returns the name of the primitive type.
    Overrides: toString in class Object
    
  • print
    public final void print(PrintWriter pw)
    Prints a formatted representation of this class. Output is pseudo-Java source.
  • compareTo
    public final int compareTo(Object o)
    Compares two HClasses by lexicographic order of their descriptors.
    Specified by: compareTo in interface Comparable
  • Methods inherited from class java.lang.Object - clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

HCode

• DESCRIPTION
  • Abstract class that all views of a particular method's executable code should extend
  • Corresponds roughly to a "list of instructions"
• LOCATION / INHERITANCE
  • harpoon.ClassFile
  • public abstract class
  • extends Object
  • Direct known subclasses - Code, Code, Code, Code
• NESTED CLASS
  • HCode.PrintCallback
    Callback interface for annotating pretty prints of HCodes
• METHODS
  • Constructor
    public HCode()
  • getMethod
    public abstract HMethod getMethod()
    Return the HMethod to which this HCode belongs.
  • getName
    public abstract String getName()
    Return the name of this code view. The default bytecode view is named "bytecode". It is suggested that additional views be named in a similarly human-friendly fashion.
  • getElements
    public HCodeElement[] getElements()
    Deprecated. use getElementsL() instead.
    Return an ordered list of the component objects making up this code view. If there is a "root" to the code view, it should occupy index 0 of the HCodeElement array. Either getElementsI() or getElementsE() must have been implemented for the default implementation to work properly.
  • getElementsL
    public List getElementsL()
    Return an ordered Collection (a List) of the component objects making up this code view. If there is a "root" to the code view, it should be the first element in the List. Either getElementsI() or getElementsE() must have been implemented for the default implementation to work properly.
  • getElementsE
    public Enumeration getElementsE()
    Deprecated. use getElementsI() instead.
    Return an Enumeration of the component objects making up this code view. If there is a "root" to the code view, it should be the first element enumerated. Implementations must implement either getElementsE() or getElementsI() (or both).
  • getElementsI
    public Iterator getElementsI()
    Return an Iterator over the component objects making up this code view. If there is a "root" to the code view, it should be the first element enumerated. Implementations must implement either of getElementsE() or getElementsI() (or both).
  • getRootElement
    public HCodeElement getRootElement()
    Return the "root" element of this code view, or null if this notion is not applicable.
  • getLeafElements
    public HCodeElement[] getLeafElements()
    Return the "leaves" of this code view; that is, the elements with no successors. Returns leaves of the code view, or null if this notion is not applicable.
  • elementArrayFactory
    public abstract ArrayFactory elementArrayFactory()
    Return an ArrayFactory for the HCodeElements composing this HCode.
  • elementIndexer
    public Indexer elementIndexer()
    Return an Indexer for the HCodeElements composing this HCode. The default Indexer returned does not implement Indexer.getByID().
  • clone
    public HCodeAndMaps clone(HMethod newMethod) throws CloneNotSupportedException
    Clone this HCode, possibly moving it to a different method. Throws CloneNotSupportedException if not overridden.
    Throws: CloneNotSupportedException if it is not possible to clone this HCode.
  • clone
    public Object clone() throws CloneNotSupportedException
    Clone this HCode and all associated HCodeElements. Calls clone(getMethod()).
    Overrides: clone in class Object, CloneNotSupportedException
  • print
    public final void print(PrintWriter pw)
    Pretty-print this code view using an empty callback.
  • print
    public void print(PrintWriter pw, HCode.PrintCallback callback)
    Pretty-print this code view using the specified callback.
  • toString
    public String toString()
    Returns a human-readable representation of this HCode.
    Overrides: toString in class Object

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

HCodeEdge

• DESCRIPTION
  • Connects two HCodeElements in a graph structure
• LOCATION / INHERITANCE
  • harpoon.ClassFile
  • public interface
  • All known implementing classes - CFGEdge
• METHODS
  • from
    public HCodeElement from()
    Returns the source of this HCodeEdge.
  • to
    public HCodeElement to()
    Returns the destination of this HCodeEdge.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

HCodeElement

• DESCRIPTION
  • An interface that all views of a particular method's executable instructions should implement
  • HCodeElements are "components" of an HCode. They correspond roughly to an "instruction" in the HCode "list of instructions".
  • Each HCodeElement should be traceable to an original source file and line number and possess a unique numeric identifier.
• LOCATION / INHERITANCE
  • harpoon.ClassFile
  • public interface
  • All known subinterfaces - CFGraphable, UseDefable
  • All known implementing classes - Instr, Instr, Quad, Tree
• METHODS
  • getSourceFile
    public String getSourceFile()
    Get the original source file name from which this element is derived.
  • getLineNumber
    public int getLineNumber()
    Get the line in the original source file to which this element is traceable.
  • getID
    public int getID()
    Returns a unique numeric identifier for this element.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

HMethod

• DESCRIPTION
  • An HMethod provides information about, and access to, a single method on a class or interface. The reflected method may be a class method or an instance method (including an abstract method).
• LOCATION / INHERITANCE
  • harpoon.ClassFile
  • public interface
  • extends HMember
  • All superinterfaces - Comparable, HMember
  • All known subinterfaces - HConstructor, HInitializer
• NESTED CLASS
  • HMember.MemberComparator - inherited from harpoon.ClassFile.HMember
• FIELDS
  • public static final ArrayFactory arrayFactory
    Array factory - returns new HMethod[].
  • Field inherited from interface harpoon.ClassFile.HMember - memberComparator
• METHODS
  • getDeclaringClass
    public HClass getDeclaringClass()
    Returns the HClass object representing the class or interface that declares the method represented by this HMethod object.
    Specified by: getDeclaringClass in interface HMember
  • getName
    public String getName()
    Returns the name of the method represented by this HMethod object, as a String.
    Specified by: getName in interface HMember
  • getModifiers
    public int getModifiers()
    Returns the Java language modifiers for the method represented by this HMethod object, as an integer. The java.lang.reflect.Modifier class should be used to decode the modifiers.
    Specified by: getModifiers in interface HMember
  • getReturnType
    public HClass getReturnType()
    Returns a HClass object that represents the formal return type of the method represented by this HMethod object. Returns HClass.Void if the method returns no value.
  • getDescriptor
    public String getDescriptor()
    Returns the descriptor for this method.
    Specified by: getDescriptor in interface HMember
  • getParameterTypes
    public HClass[] getParameterTypes()
    Returns an array of HClass objects that represent the formal parameter types, in declaration order, of the method represented by this HMethod object. Returns an array of length 0 is the underlying method takes no parameters.
  • getParameterNames
    public String[] getParameterNames()
    Returns an array of String objects giving the declared names of the formal parameters of the method. The length of the returned array is equal to the number of formal parameters. If there is no LocalVariableTable attribute available for this method, then every element of the returned array will be null.
  • getExceptionTypes
    public HClass[] getExceptionTypes()
    Returns an array of HClass objects that represent the types of the checked exceptions thrown by the underlying method represented by this HMethod object. Returns an array of length 0 if the method throws no checked exceptions.
  • isSynthetic
    public boolean isSynthetic()
    Determines whether this HMethod is synthetic, in the sense of "associated with an inner-class; not programmer declared".
    Specified by: isSynthetic in interface HMember
  • isInterfaceMethod
    public boolean isInterfaceMethod()
    Determines whether this HMethod is an interface method. Returns true if the declaring class is an interface, unless this method represents the static class initializer of the interface.
  • isStatic
    public boolean isStatic()
    Determines whether this is a static method.
  • getMutator
    public HMethodMutator getMutator()
    Returns a mutator for this HMethod, or null if the object is immutable.
  • equals
    public boolean equals(Object obj)
    Compares this HMethod against the specified object. Returns true if the objects are the same. Two HMethods are the same if they were declared by the same class and have the same name and formal parameter types.
    Overrides: equals in class Object
  • toString
    public String toString()
    Returns a string describing this HMethod. The string is formatted as the method access modifiers, if any, followed by the method return type, followed by a space, followed by the class declaring the method, followed by a period, followed by the method name, followed by a parenthesized, comma-separated list of the method's formal parameter types. If the method throws checked exceptions, the parameter list is followed by a space, followed by the word throws followed by a comma-separated list of the throws exception types. For example: public boolean java.lang.Object.equals(java.lang.Object) The access modifiers are placed in canonical order as specified by "The Java Language Specification." This is public, protected, or private first, and then other modifiers in the following order: abstract, static, final, synchronized, native.
    Overrides: toString in class Object

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

Map

• DESCRIPTION
  • Maps keys to values
  • Cannot contain duplicate keys; each key can map to at most one value.
  • Provides three collection views - allows Map contents to be viewed as a set of keys, a collection of values, or a set of key-value mappings
  • Order of a Map = the order in which the iterators on the Map's collection views return their elements
  • Great care should be taken if mutable objects are used as keys.
  • All implementations should provide the two standard constructors - the default constructor, which creates an empty Map; and a copy constructor with one argument of type Map, which creates a new Map with the same key-value mappings as the argument
  • Some implementations place restrictions on the keys and values they may contain.
• LOCATION / INHERITANCE
  • java.util
  • public interface
  • All known subinterfaces - SortedMap
  • All known implementing classes - AbstractMap, Attributes, HashMap, Hashtable, IdentityHashMap, RenderingHints, TreeMap, WeakHashMap
• NESTED CLASS
  • Map.Entry
    • static interface
    • A Map entry (key-value pair)
• METHODS
  • size
    public int size()
    Returns the number of key-value mappings in this Map. If the Map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
  • isEmpty
    public boolean isEmpty()
    Returns true if this Map contains no key-value mappings.
  • containsKey
    public boolean containsKey(Object key)
    Returns true if this Map contains a mapping for the specified key. More formally, returns true if and only if this Map contains a mapping for a key k such that (key == null ? k == null : key.equals(k)). (There can be at most one such mapping.)
    Parameters:
    • key - key whose presence in this Map is to be tested.
    Throws:
    • ClassCastException - if the key is of an inappropriate type for this Map (optional).
    • NullPointerException - if the key is null and this Map does not not permit null keys (optional).
  • containsValue
    public boolean containsValue(Object value)
    Returns true if this Map maps one or more keys to the specified value. More formally, returns true if and only if this Map contains at least one mapping to a value v such that (value == null ? v == null : value.equals(v)).
    Parameters:
    • value - value whose presence in this Map is to be tested.
    Throws:
    • ClassCastException - if the value is of an inappropriate type for this Map (optional).
    • NullPointerException - if the value is null and this Map does not not permit null values (optional).
  • get
    public Object get(Object key)
    Returns the value to which this Map maps the specified key. Returns null if the Map contains no mapping for this key. A return value of null does not necessarily indicate that the Map contains no mapping for the key; it's also possible that the Map explicitly maps the key to null. The containsKey operation may be used to distinguish between these two cases. More formally, if this Map contains a mapping from a key k to a value v such that (key == null ? k == null : key.equals(k)), then this method returns v; otherwise, it returns null. (There can be at most one such mapping.)
    Parameters:
    • key - key whose associated value is to be returned.
    Throws:
    • ClassCastException - if the key is of an inappropriate type for this Map (optional).
    • NullPointerException - key is null and this Map does not not permit null keys (optional).
  • put
    public Object put(Object key, Object value)
    Associates the specified value with the specified key in this Map (optional operation). If the Map previously contained a mapping for this key, the old value is replaced by the specified value. (A Map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)
    Parameters:
    • key - key with which the specified value is to be associated.
    • value - value to be associated with the specified key.
    Returns:
    • previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the Map previously associated null with the specified key, if the implementation supports null values.
    Throws:
    • UnsupportedOperationException - if the put operation is not supported by this Map.
    • ClassCastException - if the class of the specified key or value prevents it from being stored in this Map.
    • IllegalArgumentException - if some aspect of this key or value prevents it from being stored in this Map.
    • NullPointerException - if this Map does not permit null keys or values, and the specified key or value is null.
  • remove
    public Object remove(Object key)
    Removes the mapping for this key from this Map if it is present (optional operation). More formally, if this Map contains a mapping from key k to value v such that (key == null ? k == null : key.equals(k)), that mapping is removed. (The Map can contain at most one such mapping.) Returns the value to which the Map previously associated the key, or null if the Map contained no mapping for this key. (A null return can also indicate that the Map previously associated null with the specified key if the implementation supports null values.) The Map will not contain a mapping for the specified key once this call returns.
    Parameters:
    • key - key whose mapping is to be removed from the Map.
    Throws:
    • ClassCastException - if the key is of an inappropriate type for this Map (optional).
    • NullPointerException - if the key is null and this Map does not not permit null keys (optional).
    • UnsupportedOperationException - if the remove method is not supported by this Map.
  • putAll
    public void putAll(Map t)
    Copies all of the mappings from the specified Map to this Map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this Map once for each mapping from key k to value v in the specified Map. The behavior of this operation is unspecified if the specified Map is modified while the operation is in progress.
    Parameters:
    • t - Mappings to be stored in this Map.
    Throws:
    • UnsupportedOperationException - if the putAll method is not supported by this Map.
    • ClassCastException - if the class of a key or value in the specified Map prevents it from being stored in this Map.
    • IllegalArgumentException - some aspect of a key or value in the specified Map prevents it from being stored in this Map.
    • NullPointerException - if the specified Map is null, or if this Map does not permit null keys or values, and the specified Map contains null keys or values.
  • clear
    public void clear()
    Removes all mappings from this Map (optional operation).
    Throws:
    • UnsupportedOperationException - clear is not supported by this Map.
  • keySet
    public Set keySet()
    Returns a set view of the keys contained in this Map. The Set is backed by the Map, so changes to the Map are reflected in the Set, and vice-versa. If the Map is modified while an iteration over the Set is in progress, the results of the iteration are undefined. The Set supports element removal, which removes the corresponding mapping from the Map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
  • values
    public Collection values()
    Returns a collection view of the values contained in this Map. The Collection is backed by the Map, so changes to the Map are reflected in the Collection, and vice-versa. If the Map is modified while an iteration over the Collection is in progress, the results of the iteration are undefined. The Collection supports element removal, which removes the corresponding mapping from the Map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
  • entrySet
    public Set entrySet()
    Returns a set view of the mappings contained in this Map. Each element in the returned Set is a Map.Entry. The Set is backed by the Map, so changes to the Map are reflected in the Set, and vice-versa. If the Map is modified while an iteration over the Set is in progress, the results of the iteration are undefined. The Set supports element removal, which removes the corresponding mapping from the Map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
  • equals
    public boolean equals(Object o)
    Compares the specified object with this Map for equality. Returns true if the given object is also a Map and the two Maps represent the same mappings. More formally, two Maps t1 and t2 represent the same mappings if t1.entrySet().equals(t2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.
    Overrides: equals in class Object
    Parameters:
    • o - object to be compared for equality with this map.
  • hashCode
    public int hashCode()
    Returns the hash code value for this Map. The hash code of a Map is defined to be the sum of the hashCodes of each entry in the Map's entrySet view. This ensures that t1.equals(t2) implies that t1.hashCode() == t2.hashCode() for any two Maps t1 and t2, as required by the general contract of Object.hashCode.
    Overrides: hashCode in class Object
    

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

MetaAllCallers

• DESCRIPTION
  • The dual of MetaCallGraph
  • Computes the callers (MetaMethods) of each meta-method in the program
  • Bulk of computation done in MetaCallGraph; MetaAllCallers just inverts the edges of a precomputed graph
• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public class
  • extends Object
  • implements Serializable
• METHODS
  Constructor
  public MetaAllCallers(MetaCallGraph mcg)
  Creates a MetaAllCallers object. Receives as a parameter the MetaCallGraph that computes the possible callees of each meta-method.
  • getCallers
    public MetaMethod[] getCallers(MetaMethod mm_callee)
    Returns the callers of the meta method mm_callee. The returned set is a set of MetaMethods.
  • getTransCallers
    public MetaMethod[] getTransCallers(MetaMethod mm_callee)
    Returns the meta-methods that transitively call the meta-method mm_callee. The transitive closure of getCallers.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

MetaCallGraph

• DESCRIPTION
  • Provides information on what meta methods are called by a given meta method (at a specific call site).
  • For meta methods what a CallGraph is for "normal" methods
• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public interface
  • extends Serializable
  • implemented by MetaCallGraphAbstr
• METHODS
  • getCallees
    public MetaMethod[] getCallees(MetaMethod mm)
    Returns the meta-methods that can be called by mm.
  • getCallees
    public MetaMethod[] getCallees(MetaMethod mm, CALL cs)
    Returns the meta-methods that can be called by mm at the call site cs.
  • getCallSites
    public Set getCallSites(MetaMethod mm)
    Returns the set of all the call sites in the code of the meta-method mm.
  • getAllMetaMethods
    public Set getAllMetaMethods()
    Returns the set of all the meta-methods that might be called during the execution of the program.
  • getTransCallees
    public Set getTransCallees(MetaMethod mm)
    Returns the set of all the meta-methods that might be called, directly or indirectly, by the meta-method mm. The transitive closure of the getCallees method.
  • getSplitRelation
    public Relation getSplitRelation()
    Computes the split relation, a Relation that associates to each HMethod the set of MetaMethods specialized from it.
  • getRunMetaMethods
    public Set getRunMetaMethods()
    Returns the set of the meta-methods that could be called as the body of some thread.
  • print
    public void print(PrintWriter pw, boolean detailed_view, MetaMethod root)
    Pretty-printer for debug purposes.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

MetaCallGraphAbstr

• DESCRIPTION
  • Abstract implementation of the MetaCallGraph interface
• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public abstract class
  • extends Object
  • implements MetaCallGraph
  • All implemented interfaces - MetaCallGraph, Serializable
  • Direct known subclasses - FakeMetaCallGraph, MetaCallGraphImpl
• FIELDS
  • protected final Map callees1_cmpct
  • protected final Map callees2_cmpct
  • protected final Set all_meta_methods
  • protected Set run_mms
• METHODS
  • Constructor
    public MetaCallGraphAbstr()
  • getCallees
    public MetaMethod[] getCallees(MetaMethod mm)
    Returns the meta-methods that can be called by mm.
    Specified by: getCallees in interface MetaCallGraph
  • getCallees
    public MetaMethod[] getCallees(MetaMethod mm, CALL cs)
    Returns the meta-methods that can be called by mm at the call site cs.
    Specified by: getCallees in interface MetaCallGraph
  • getTransCallees
    public Set getTransCallees(MetaMethod mm)
    Returns the set of all the meta-methods that might be called, directly or indirectly, by the meta-method mm.
    Specified by: getTransCallees in interface MetaCallGraph
  • getCallSites
    public Set getCallSites(MetaMethod mm)
    Returns the set of all the call sites in the code of the meta-method mm.
    Specified by: getCallSites in interface MetaCallGraph
  • getAllMetaMethods
    public Set getAllMetaMethods()
    Returns the set of all the meta-methods that might be called during the execution of the program.
    Specified by: getAllMetaMethods in interface MetaCallGraph
  • getSplitRelation
    public Relation getSplitRelation()
    Computes the split relation. This is a Relation that associates to each HMethod the set of MetaMethods specialized from it.
    Specified by: getSplitRelation in interface MetaCallGraph
  • getRunMetaMethods
    public Set getRunMetaMethods()
    Returns the set of the meta-methods that could be called as the body of some thread.
    Specified by: getRunMetaMethods in interface MetaCallGraph
  • print
    public void print(PrintWriter pw, boolean detailed_view, MetaMethod root)
    Pretty-printer for debug purposes.
    Specified by: print in interface MetaCallGraph

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

MetaCallGraphImpl

• DESCRIPTION
  • Full-power implementation of the MetaCallGraph interface
• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public class
  • extends MetaCallGraphAbstr
  • All implemented interfaces - MetaCallGraph, Serializable
• FIELDS
  • public static final boolean DETERMINISTIC
    Make sure the results of the query methods (getCalles-like) don't depend on the run; facilitate the debugging.
  • Fields inherited from class harpoon.Analysis.MetaMethods.MetaCallGraphAbstr - all_meta_methods, callees1_cmpct, callees2_cmpct, run_mms
• METHODS
  • Constructor
    public MetaCallGraphImpl(CachingCodeFactory hcf, ClassHierarchy ch, Set hmroots)
    Creates a MetaCallGraphImpl. Must receive, as its last parameter, the main method of the program.
  • Methods inherited from harpoon.Analysis.MetaMethods.MetaCallGraphAbstr - getAllMetaMethods, getCallees, getCallees, getCallSites, getRunMetaMethods, getSplitRelation, getTransCallees, print

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

MetaMethod

• DESCRIPTION
  • Specialization of a method; function of the types of its arguments
  • A method plus types for its parameters. These types should be identical to or, preferably, narrower than the declared types for the method.
  • Many meta-methods can be generated through specialization from a single method. To modify only one of them, first make a copy of it, perform optimizations, etc. on the copy, and modify the concerned call sites to point to it.
  • Example: If we have a method foo declared as having a single parameter of type Object, if we know that at a specific call site it is called with an argument of type A and at some other call site with an argument of type B, then we can say that in the first case we call the meta-method consisting of method <foo,A>, while in the second one we call the meta-method <foo,B>.
  • In languages that rely heavily on inheritance and dynamic dispatch/virtual methods, MetaMethods lead to a sparser call graph, removing some unrealizable call chains. Will simply or even remove some artifical strongly connected components of pseudo-mutually recursive methods.
• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public class
  • extends Object
  • implements Serializable
• METHODS
  • Constructors
    • public MetaMethod(HMethod hm, GenType[] types)
      Creates a MetaMethod corresponding to the method hm and the types from the array "types".
    • public MetaMethod(HMethod hm, boolean polymorphic)
      Creates a MetaMethod corresponding to the method hm and the types declared for it. The types appearing in the declaration of the method are considered to be polymorphic or not, depending whether polymorphic is switched on/off.
    • public MetaMethod(HMethod hm)
      Creates a MetaMethod corresponding to the method hm and the types declared for it. All the types appearing in the declaration of the method are considered to be polymorphic; that is, the FLEX designers are maximally conservative in their initial estimation. The types of can be specialized to by using setType.
  • getHMethod
    public HMethod getHMethod()
    Returns the HMethod of which this meta-method is a specialization.
  • getType
    public GenType getType(int i)
    Returns the type of the ith parameter.
  • setType
    public void setType(int i, GenType gt)
    Set the type of the i-th argument of this meta-method. The arguments are 0-indexed, with the receiver of the method in the first place if the method is non-static. This method should be used to specialize the types of the arguments.
  • nbParams
    public int nbParams()
    Returns the number of parameters of this MetaMethod.
  • hashCode
    public int hashCode()
    Computes the hash code of this object.
    Overrides: hashCode in class Object
  • equals
    public boolean equals(Object o)
    Checks the equality of this object with object o.
    Overrides: equals in class Object
  • identical
    public static boolean identical(MetaMethod mm1, MetaMethod mm2)
    Checks whether two MetaMethods are equal or not. Handles null arguments.
  • toString
    public String toString()
    Pretty printer for debug purposes.
    Overrides: toString in class Object

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

Quad

• DESCRIPTION
  • The base class for the quadruple representation.
• LOCATION / INHERITANCE
  • harpoon.IR.Quads
  • public abstract class
  • extends Object
  • implements HCodeElement, UseDefable, CFGraphable, Cloneable, Comparable, Serializable
  • Direct known subclasses - AGET, ALENGTH, ANEW, ARRAYINIT, ASET, COMPONENTOF, CONST, DEBUG, FOOTER, GET, HANDLER, HEADER, INSTANCEOF, LowQuad, METHOD, MONITORENTER, MONITOREXIT, MOVE, NEW, NOP, OPER, PHI, RETURN, SET, SIGMA, THROW
• FIELD
  • public static final ArrayFactory arrayFactory
    Array factory - returns Quad[]s
• METHODS
  • Constructors
    • protected Quad(QuadFactory qf, HCodeElement source, int prev_arity, int next_arity)
      Initializes a quad with prev_arity input edges and next_arity output edges.
    • protected Quad(QuadFactory qf, HCodeElement source)
      Initializes a quad with exactly one input edge and exactly one output edge.
  • hashCode
    public int hashCode()
    Overrides: hashCode in class Object
  • getFactory
    public QuadFactory getFactory()
    Returns the QuadFactory that generated this Quad.
  • getSourceFile
    public String getSourceFile()
    Returns the original source file name that this Quad is derived from.
    Specified by: getSourceFile in interface HCodeElement
  • getLineNumber
    public int getLineNumber()
    Returns the line in the original source file that this Quad is derived from.
    Specified by: getLineNumber in interface HCodeElement
  • getID
    public int getID()
    Returns a unique numeric identifier for this Quad.
    Specified by: getID in interface HCodeElement
  • toString
    public abstract String toString()
    Force derived classes to reimplement toString()
    Overrides: toString in class Object
  • accept
    public abstract void accept(QuadVisitor v)
    Accept a visitor.
  • kind
    public abstract int kind()
    Return an integer enumeration of the kind of this Quad. The enumerated values are defined in QuadKind.
  • rename
    public abstract Quad rename(QuadFactory qf, TempMap defMap, TempMap useMap)
    Create a new Quad identical to the receiver, but with all Temps renamed according to a mapping. The new Quad will have no edges and will come from the specified QuadFactory.
  • rename
    public final Quad rename(TempMap defMap, TempMap useMap)
    Create a new Quad identical to the receiver, but with all Temps renamed according to a mapping. The new Quad will have no edges and will come from the same QuadFactory as the receiver.
  • use
    public Temp[] use()
    Return all the Temps used by this Quad.
    Specified by: use in interface UseDefable
  • def
    public Temp[] def()
    Return all the Temps defined by this Quad.
    Specified by: def in interface UseDefable
  • useC
    public Collection useC()
    Returns a Collection of all the Temps read in this HCodeElement.
    Specified by: useC in interface UseDefable
  • defC
    public Collection defC()
    Returns a Collection of all the Temps defined in this HCodeElement.
    Specified by: defC in interface UseDefable
  • next
    public Quad next(int i)
    Returns the ith successor of this quad.
  • prev
    public Quad prev(int i)
    Returns the ith predecessor of this quad.
  • nextLength
    public int nextLength()
    Return the number of successors of this quad.
  • prevLength
    public int prevLength()
    Return the number of predecessors of this quad.
  • next
    public Quad[] next()
    Returns an array containing all the successors of this quad, in order.
  • prev
    public Quad[] prev()
    Returns an array containing all the predecessors of this quad, in order.
  • nextEdge
    public Edge[] nextEdge()
    Returns an array containing all the outgoing edges from this quad.
  • prevEdge
    public Edge[] prevEdge()
    Returns an array containing all the incoming edges of this quad.
  • nextEdge
    public Edge nextEdge(int i)
    Returns the ith outgoing edge for this quad.
  • prevEdge
    public Edge prevEdge(int i)
    Returns the ith incoming edge of this quad.
  • edges
    public CFGEdge[] edges()
    Returns an array of all the edges to and from this CFGraphable.
    Specified by: edges in interface CFGraphable
  • pred
    public CFGEdge[] pred()
    Returns an array of all the edges entering this CFGraphable.
    Specified by: pred in interface CFGraphable
  • succ
    public CFGEdge[] succ()
    Returns an array of all the edges leaving this CFGraphable.
    Specified by: succ in interface CFGraphable
  • edgeC
    public Collection edgeC()
    Returns a Collection of all the edges to and from this HCodeElement.
    Specified by: edgeC in interface CFGraphable
  • predC
    public Collection predC()
    Returns a Collection of all the edges to this HCodeElement. Each CFGEdge returned is guaranteed to return this in response to a call to to(); the actual predecessor will be returned from from().
    Specified by: predC in interface CFGraphable
  • succC
    public Collection succC()
    Returns a Collection of all the edges from this HCodeElement. Each CFGEdge returned is guaranteed to return this in response to a call to from(); the actual successor to this will be returned from to().
    Specified by: succC in interface CFGraphable
  • addEdge
    public static Edge addEdge(Quad from, int from_index, Quad to, int to_index)
    Adds an edge between two Quads. The from_indexed outgoing edge of from is connected to the to_indexed incoming edge of to. Returns the added Edge.
  • addEdges
    public static void addEdges(Quad[] quadlist)
    Add edges between a string of Quads. The first outgoing edge is connected to the first incoming edge for all edges added. The same as multiple addEdge(q[i], 0, q[i+1], 0) calls.
  • replace
    public static void replace(Quad oldQ, Quad newQ)
    Replace one quad with another. The number of in and out edges of the new and old quads must match exactly.
  • remove
    public Edge remove()
    Remove this quad from the graph. The given quad must have exactly one predecessor and one successor. Also removes the quad from any handler sets it may belong to. Returns the new edge which replaces this quad.
  • transferHandlers
    public static void transferHandlers(Quad oldQ, Quad newQ)
    Update the handlers for newQ to match the handlers for oldQ, removing handlers from oldQ in the process.
  • addHandlers
    public final void addHandlers(HandlerSet handlers)
    Add this quad to the given handler sets.
  • removeHandlers
    public final void removeHandlers(HandlerSet handlers)
    Remove this quad from the given handler sets.
  • handlers
    public final HandlerSet handlers()
    Return a set of all the handlers guarding this Quad.
  • compareTo
    public int compareTo(Object o)
    Specified by: compareTo in interface Comparable
  • clone
    public final Object clone()
    Overrides: clone in class Object
  • clone
    public final Object clone(QuadFactory qf, CloningTempMap tm)
    Clone a quad into a new quad factory, renaming all of the temps according to tm (which ought to ensure that all the new temps belong to the TempFactory of the new QuadFactory).
  • clone
    public static Quad clone(QuadFactory qf, Quad header)
    Create a new copy of a string of Quads starting at the given header using QuadFactory.
  • map
    protected static final Temp map(TempMap tm, Temp t)
    Apply TempMap tm to Temp t. Returns tm.tempMap(t) if t is non-null, null if t is null.
  • map
    protected static final Temp[] map(TempMap tm, Temp[] ta)
    Apply TempMap to array of Temps. Null Temps get mapped to null.
  • map
    protected static final Temp[][] map(TempMap tm, Temp[][] taa)
    Apply TempMap to 2-d array of Temps. Null Temps get mapped to null.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

ReachingDefs

• DESCRIPTION
  • Defines an abstract class for analyzing reaching definitions
• LOCATION / INHERITANCE
  • harpoon.Analysis
  • public abstract class
  • extends Object
  • Direct known subclasses - ReachingDefsAltImpl, ReachingDefsImpl, SSxReachingDefsImpl
• FIELDS
  • public static final boolean TIME
  • protected final HCode hc
    The HCode for which this object contains analysis results
• METHODS
  • Constructor
    public ReachingDefs(HCode hc)
    Creates a ReachingDefs object for the provided HCode
  • reachingDefs
    public abstract Set reachingDefs(HCodeElement hce, Temp t)
    Returns the Set of HCodeElements providing definitions of Temp t that reach HCodeElement hce

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

ReachingDefsAltImpl

• LOCATION / INHERITANCE
  • harpoon.Analysis
  • public class
  • extends ReachingDefs
  • Direct known subclasses - ReachingDefsCachingImpl
• FIELDS
  • protected final BasicBlock.Factory bbf
  • protected final harpoon.Analysis.ReachingDefsAltImpl.AugSetFactory bsf
  • protected final Map tempToAllDefs
  • protected final Map cache
  • protected final boolean check_typecast
  • protected final UseDefer ud
  • Fields inherited from class harpoon.Analysis.ReachingDefs - hc, TIME
• METHODS
  • Constructors
    • public ReachingDefsAltImpl(HCode hc)
      Creates a ReachingDefsImpl object for the provided HCode using CFGrapher.DEFAULT and UseDefer.DEFAULT. This may take a while since the analysis is done at this time.
    • public ReachingDefsAltImpl(HCode hc, CFGrapher cfger)
      Creates a ReachingDefsImpl object for the provided HCode for an IR implementing UseDefable using the provided CFGrapher. This may take a while since the analysis is done at this time.
    • public ReachingDefsAltImpl(HCode hc, CFGrapher cfger, UseDefer ud)
      Creates a ReachingDefsImpl object for the provided HCode using the provided CFGrapher and UseDefer. This may take a while since the analysis is done at this time.
  • reachingDefs
    public Set reachingDefs(HCodeElement hce, Temp t)
    Returns the Set of HCodeElements providing definitions of Temp t which reach HCodeElement hce. Any use that is not explicitly defined is assumed to be implicitly defined by the root element of the HCode for this.
    Specified by: reachingDefs in class ReachingDefs

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

ReachingDefsImpl

• DESCRIPTION
  • Defines an implementation for analyzing reaching definitions
  • Since results are cached, a new ReachingDefsImpl should be created if the code has been modified.
• LOCATION / INHERITANCE
  • harpoon.Analysis
  • public class
  • extends ReachingDefs
• FIELDS
  • protected final BasicBlock.Factory bbf
  • protected final Map Temp_to_BitSetFactories
  • protected final Map cache
  • protected final boolean check_typecast
  • protected final UseDefer ud
  • Fields inherited from class harpoon.Analysis.ReachingDefs - hc, TIME
• METHODS
  • Constructors
    • public ReachingDefsImpl(HCode hc, CFGrapher cfger)
      Creates a ReachingDefsImpl object for the provided HCode for an IR implementing UseDefable using the provided CFGrapher. This may take a while since the analysis is done at this time.
    • public ReachingDefsImpl(HCode hc, CFGrapher cfger, UseDefer ud)
      Creates a ReachingDefsImpl object for the provided HCode using the provided CFGrapher and UseDefer. This may take a while since the analysis is done at this time.
    • public ReachingDefsImpl(HCode hc)
      Creates a ReachingDefsImpl object for the provided HCode using CFGrapher.DEFAULT. This may take a while since the analysis is done at this time.
  • reachingDefs
    public Set reachingDefs(HCodeElement hce, Temp t)
    Returns the Set of HCodeElements providing definitions of Temp t which reach HCodeElement hce. Returns the empty Set if the given HCodeElement is unreachable.
    Specified by: reachingDefs in class ReachingDefs

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

Relation

• DESCRIPTION
  • A mathematical relation, accepting 1-many and many-1 mappings
  • Similar to harpoon.Util.Collections.MultiMap but intended to be simpler and better tailored for the implementation of the Pointer Analysis algorithm.
• LOCATION / INHERITANCE
  • harpoon.Util.DataStructs
  • public interface
  • All known implementing classes - AbstrRelation, RelationImpl
• METHODS
  • add
    public boolean add(Object key, Object value)
    Adds the pair to the Relation. Returns true if the new Relation is bigger.
  • addAll
    public boolean addAll(Object key, Collection values)
    Adds a Relation from key to each element of the set values. values should not contain duplicated elements. Returns true if the new Relation is bigger.
  • remove
    public void remove(Object key, Object value)
    Removes the Relation between key and value.
  • removeAll
    public void removeAll(Object key, Collection values)
    Removes the Relation between key and any element from values.
  • removeKey
    public void removeKey(Object key)
    Removes all the Relations attached to key.
  • removeKeys
    public void removeKeys(PredicateWrapper predicate)
    Removes all the keys that satisfy predicate.check().
  • removeValues
    public void removeValues(PredicateWrapper predicate)
    Removes all the values that satisfy predicate.check().
  • removeObjects
    public void removeObjects(PredicateWrapper predicate)
    Removes all the Relations involving at least one object that satisfy predicate.check().
  • contains
    public boolean contains(Object key, Object value)
    Checks for the existence of the Relation .
  • containsKey
    public boolean containsKey(Object key)
    Checks for the existence of the key "key" in this Relation.
  • isEmpty
    public boolean isEmpty()
    Tests if this Relation is empty or not.
  • getValues
    public Set getValues(Object key)
    Returns the image of key through this Relation. The returned collection is guaranteed not to contain duplicates. Can return null if no value is attached to key. If the result is non-null, additions and removals on the returned collection take effect on the Relation.
  • keys
    public Set keys()
    Returns all the keys appearing in this Relation. The result is guaranted not to contain duplicates.
    
  • values
    public Set values()
    Returns all the values appearing in this Relation.
  • union
    public void union(Relation rel)
    Combines this Relation with a new one. A null parameter is considered to be an empty Relation.
  • equals
    public boolean equals(Object o)
    Checks the equality of two relations.
    Overrides: equals in class Object
  • select
    public Relation select(Collection selected_keys)
    Returns the subrelation of this Relation that contains only the keys that appear in selected_keys.
  • forAllEntries
    public void forAllEntries(RelationEntryVisitor visitor)
    Visits all the entries of this Relation and calls visitor.visit on each of them.
  • clone
    public Object clone()
    Clones this relation.
    Overrides: clone in class Object
  • revert
    public void revert(Relation result)
    Revert this Relation and store the result into the Relation result. (a,b) appears in the Reverse relation iff (b,a) appears in this Relation.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

RETURN

• DESCRIPTION
  • RETURN objects indicate a method return, with an optional return value.
• LOCATION / INHERITANCE
  • harpoon.IR.Quads
  • public class
  • extends Quad
  • All implemented interfaces - CFGraphable, Cloneable, Comparable, HCodeElement, Serializable, UseDefable
• FIELDS
  • protected Temp retval
    Holds the return value for the method, null if there is no return value.
  • Fields inherited from class harpoon.IR.Quads.Quad - arrayFactory
• METHODS
  • Constructor
    public RETURN(QuadFactory qf, HCodeElement source, Temp retval)
    Creates a RETURN representing a method return.
    Parameters:
    • retval - the Temp holding the return value for the method. The retval field should be null if the method does not return a value.
  • retval
    public Temp retval()
    Returns the Temp that holds the method return value, or returns null if the method returns no value.
  • use
    public Temp[] use()
    Returns all the Temps used by this Quad. The array is either empty (if the retval is null) or contains one element, the retval Temp.
    Specified by: use in interface UseDefable
    Overrides: use in class Quad
  • kind
    public int kind()
    Returns an integer enumeration of the kind of this Quad. The enumerated values are defined in QuadKind.
    Specified by: kind in class Quad
  • rename
    public Quad rename(QuadFactory qqf, TempMap defMap, TempMap useMap)
    Creates a new Quad identical to the receiver but with all Temps renamed according to a mapping. The new Quad will have no edges and will come from the specified QuadFactory. Specified by: rename in class Quad
  • accept
    public void accept(QuadVisitor v)
    Accept a visitor.
    Specified by: accept in class Quad
  • toString
    public String toString()
    Returns a human-readable representation of this Quad.
    Specified by: toString in class Quad
  • Methods inherited from class harpoon.IR.Quads.Quad - addEdge, addEdges, addHandlers, clone, clone, clone, compareTo, def, defC, edgeC, edges, getFactory, getID, getLineNumber, getSourceFile, handlers, hashCode, map, map, map, next, next, nextEdge, nextEdge, nextLength, pred, predC, prev, prev, prevEdge, prevEdge, prevLength, remove, removeHandlers, rename, replace, succ, succC, transferHandlers, useC

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

SCComponent

• DESCRIPTION
  • Models a strongly connected component of a graph
  • The only way to split a graph into SCComponents is though buildSSC. It needs a root node (or a set of root nodes) and a Navigator - an object implementing the SCCoomponent.Navigator interface that provides the edges coming into/going out of a given Object. So, it can build strongly connected components even for graphs that are not built from CFGraphable nodes, a good example being the set of methods where the edges represent the caller-callee relation (in this case, the strongly connected components group together sets of mutually recursive methods).
• LOCATION / INHERITANCE
  • harpoon.Util.Graphs
  • public final class
  • extends Object
  • implements Comparable, Serializable
• NESTED CLASS
  • SCComponent.Navigator
    static interface; identical to harpoon.Util.Graphs.Navigator
• METHODS
  • buildSCC
    public static final SCComponent buildSCC(Object root, SCComponent.Navigator navigator)
    Convenient version for the single root case (see the other buildSCC for details). Returns the single element of the set of top level SCCs.
  • buildSCC
    public static final Set buildSCC(Object[] roots, SCComponent.Navigator navigator)
    Constructs the strongly connected components of the graph containing all the nodes reachable on paths that originate in nodes from roots. The edges are indicated by navigator. Returns the set of the root SCComponents, the components that are not pointed by any other component. This constraint is actively used in the topological sorting agorithm (see SCCTopSortedGraph).
  • getId
    public int getId()
    Returns the numeric ID of this SCComponent. Solely for debug purposes.
  • isLoop
    public final boolean isLoop()
    Checks whether this strongly connected component corresponds to a loop, ie. it has at least one arc to itself.
  • compareTo
    public int compareTo(Object o)
    Specified by: compareTo in interface Comparable
  • nextLength
    public final int nextLength()
    Returns the number of successors.
  • next
    public final SCComponent next(int i)
    Returns the ith successor.
  • prevLength
    public final int prevLength()
    Returns the number of predecessors.
  • prev
    public final SCComponent prev(int i)
    Returns the ith predecessor.
  • nodeSet
    public final Set nodeSet()
    Returns the nodes of this strongly connected component (set version).
  • nodes
    public final Object[] nodes()
    Returns the nodes of this strongly connected component; array version - good for iterating over the elements of the SCC.
  • size
    public final int size()
    Returns the number of nodes in this strongly connected component.
  • contains
    public final boolean contains(Object node)
    Checks whether node belongs to this strongly connected component.
  • nextTopSort
    public final SCComponent nextTopSort()
    Returns the next SCComponent according to the decreasing topological order.
  • prevTopSort
    public final SCComponent prevTopSort()
    Returns the previous SCComponent according to the decreasing topological order.
  • toString
    public final String toString()
    Pretty print debug function.
    Overrides: toString in class Object
  • toString
    public final String toString(MetaCallGraph mcg)
    Pretty print debug function for SCCs of MetaMethods.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

Set

• DESCRIPTION
  • Collection that contains no duplicate elements. More formally, sets contain no pair of elements e1 and e2 such that e1.equals(e2) and at most one null element.
  • Models the mathematical set abstraction
  • The Set interface places additional stipulations, beyond those inherited from the Collection interface, on the contracts of all constructors and on the contracts of the add, equals and hashCode methods. All constructors must create a set that contains no duplicate elements.
  • Declarations for other inherited methods are also included here for convenience. (The specifications accompanying these declarations have been tailored to the Set interface, but they do not contain any additional stipulations.)
  • Great care must be exercised if mutable objects are used as set elements. The behavior of a set is not specified if the value of an object is changed in a manner that affects equals comparisons while the object is an element in the set. A special case of this prohibition is that it is not permissible for a set to contain itself as an element.
• LOCATION / INHERITANCE
  • java.util
  • public interface
  • extends Collection
  • All known subinterfaces - SortedSet
  • All known implementing classes - AbstractSet, HashSet
• METHODS
  • size
    public int size()
    Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    Specified by: size in interface Collection
  • isEmpty
    public boolean isEmpty()
    Returns true if this set contains no elements.
    Specified by: isEmpty in interface Collection
  • contains
    public boolean contains(Object o)
    Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that (o==null ? e==null : o.equals(e)).
    Specified by: contains in interface Collection
  • iterator
    public Iterator iterator()
    Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).
    Specified by: iterator in interface Collection
  • toArray
    public Object[] toArray()
    Returns an array containing all of the elements in this set. Obeys the general contract of the Collection.toArray method.
    Specified by: toArray in interface Collection
  • toArray
    public Object[] toArray(Object[] a)
    Returns an array containing all of the elements in this set whose runtime type is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method.
    Specified by: toArray in interface Collection
    Parameters:
    • a - the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
    Throws:
    • ArrayStoreException - the runtime type of a is not a supertype of the runtime type of every element in this set.
  • add
    public boolean add(Object o)
    Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element, o, to this set if this set contains no element e such that (o==null ? e==null : o.equals(e)). If this set already contains the specified element, the call leaves this set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throwing an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the the elements that they may contain.
    Specified by: add in interface Collection
    Parameters:
    • o - element to be added to this set.
    Returns: true if this set did not already contain the specified element.
    Throws:
    • UnsupportedOperationException - if the add method is not supported by this set.
    • ClassCastException - if the class of the specified element prevents it from being added to this set.
    • IllegalArgumentException - if some aspect of this element prevents it from being added to this set.
  • remove
    public boolean remove(Object o)
    Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the set contains such an element. Returns true if the set contained the specified element (or equivalently, if the set changed as a result of the call). (The set will not contain the specified element once the call returns.)
    Specified by: remove in interface Collection
    Parameters:
    • o - object to be removed from this set, if present.
    Throws:
    • UnsupportedOperationException - if the remove method is not supported by this set.
  • containsAll
    public boolean containsAll(Collection c)
    Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.
    Specified by: containsAll in interface Collection
    Parameters:
    • c - collection to be checked for containment in this set.
  • addAll
    public boolean addAll(Collection c)
    Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress.
    Specified by: addAll in interface Collection
    Parameters:
    • c - collection whose elements are to be added to this set.
    Returns: true if this set changed as a result of the call.
    Throws:
    • UnsupportedOperationException - if the addAll method is not supported by this set.
    • ClassCastException - if the class of some element of the specified collection prevents it from being added to this set.
    • IllegalArgumentException - if some aspect of some element of the specified collection prevents it from being added to this set.
  • retainAll
    public boolean retainAll(Collection c)
    Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.
    Specified by: retainAll in interface Collection
    Parameters:
    • c - collection that defines which elements this set will retain.
    Returns: true if this collection changed as a result of the call.
    Throws:
    • UnsupportedOperationException - if the retainAll method is not supported by this Collection.
  • removeAll
    public boolean removeAll(Collection c)
    Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.
    Specified by: removeAll in interface Collection
    Parameters:
    • c - collection that defines which elements will be removed from this set.
    Returns: true if this set changed as a result of the call.
    Throws:
    • UnsupportedOperationException - if the removeAll method is not supported by this Collection.
  • clear
    public void clear()
    Removes all of the elements from this set (optional operation). This set will be empty after this call returns (unless it throws an exception).
    Specified by: clear in interface Collection
    Throws:
    • UnsupportedOperationException - if the clear method is not supported by this set.
  • equals
    public boolean equals(Object o)
    Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.
    Specified by: equals in interface Collection
    Overrides: equals in class Object
    Parameters:
    • o - Object to be compared for equality with this set.
  • hashCode
    public int hashCode()
    Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hashcode of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of the Object.hashCode method.
    Specified by: hashCode in interface Collection
    Overrides: hashCode in class Object

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

SetHClass

• DESCRIPTION
  • Represents concrete type!
  • Currently (v. 1.2), it is simply a Set of HClasses, but optimized ways of representing a cone of classes (a class and all its subclasses) can be considered.
• LOCATION / INHERITANCE
  • harpoon.Analysis.TypeInference
  • public class
  • extends HashSet
  • All implemented interfaces - Cloneable, Collection, Serializable, Set
• METHODS
  • Constructors
    • public SetHClass()
    • public SetHClass(HClass c)
    • public SetHClass(SetHClass s)
  • Methods inherited from class java.util.HashSet - add, clear, clone, contains, isEmpty, iterator, remove, size
  • Methods inherited from class java.util.AbstractSet - equals, hashCode, removeAll
  • Methods inherited from class java.util.AbstractCollection - addAll, containsAll, retainAll, toArray, toArray, toString
  • Methods inherited from class java.lang.Object - finalize, getClass, notify, notifyAll, wait, wait, wait
  • Methods inherited from interface java.util.Set - addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

SmartCallGraph

• LOCATION / INHERITANCE
  • harpoon.Analysis.MetaMethods
  • public class
  • extends Object
  • implements CallGraph (interface harpoon.Analysis.Quads.CallGraph)
  • All implemented interfaces - harpoon.Analysis.Quads.CallGraph, harpoon.Analysis.CallGraph
• METHODS
  • Constructor
    public SmartCallGraph(MetaCallGraph mcg)
    Creates a SmartCallGraph.
  • calls
    public final HMethod[] calls(HMethod hm)
    Returns an array containing all possible methods called by method m. If hm doesn't call any methods, returns an array of length 0.
    Specified by: calls in interface CallGraph (harpoon.Analysis)
  • calls
    public final HMethod[] calls(HMethod hm, CALL cs)
    Returns an array containing all possible methods called by method m at the call site cs. If there is no known callee for the call site cs>, or if cs doesn't belong to the code of hm, returns an array of length 0.
    Specified by: calls in interface CallGraph (harpoon.Analysis.Quads)
  • getCallSites
    public CALL[] getCallSites(HMethod hm)
    Returns a list of all the CALLs quads in the code of hm.
    Specified by: getCallSites in interface CallGraph (harpoon.Analysis.Quads)
  • callableMethods
    public Set callableMethods()
    Returns the set of all the methods that can be called in the execution of the program.
    Specified by: callableMethods in interface CallGraph (harpoon.Analysis.Quads)

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

Temp

• DESCRIPTION
  • Represents a temporary variable
  • The Temp class maintains static state to allow allocation of guaranteed unique names for the Temps
• LOCATION / INHERITANCE
  • harpoon.Temp.Temp
  • public class
  • extends Object
  • implements Cloneable, Comparable, ReferenceUnique, Serializable
  • Direct known subclasses - LocalCffRegAlloc.PreassignTemp, TempChain, TwoWordTemp
• FIELDS
  • public static Indexer INDEXER
    A harpoon.Util.Indexer specifically for working only with Temps generated by this.tempFactory().
  • public static final ArrayFactory arrayFactory
    Returns an array of Temps.
  • public static final ArrayFactory doubleArrayFactory
    Returns an array of Temp[]s.
• METHODS
  • Constructors
    • public Temp(TempFactory tf)
      Creates a unique temporary variable, using default prefix ("t").
    • public Temp(Temp t)
      Creates a new temp based on the name of an existing temp.
    • public Temp(TempFactory tf, String prefix)
      Creates a unique temporary with a suggested name. Trailing digits will be stripped from the suggested name, and a digit string will be appended to make the name unique within the scope of the TempFactory.
      Parameters: prefix - the name prefix. prefix may not be null.
  • fullname
    public String fullname()
    Returns the full name of this temporary, including scope information.
  • name
    public String name()
    Returns the common name of this Temp; scope information not included.
  • toString
    public String toString()
    Returns a string representation of this temporary.
    Overrides: toString in class Object
  • tempFactory
    public TempFactory tempFactory()
    Returns the tempFactory of this temporary.
  • clone
    public Temp clone(TempFactory tf)
    Clones a Temp into a different TempFactory.
  • clone
    public Object clone()
    Clones a Temp using the same TempFactory.
    Overrides: clone in class Object
  • hashCode
    public int hashCode()
    Returns a hashcode for this temporary. The hashcode is formed from the scope name and the temporary name.
    Overrides: hashCode in class Object
  • compareTo
    public int compareTo(Object o)
    Comparable interface: sorted by fullname().
    Specified by: compareTo in interface Comparable
  • tempFactory
    public static TempFactory tempFactory(String scope)
    Returns a new TempFactory with the given scope.

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

TypeInference

• DESCRIPTION
  • Simple type inference module
  • Written to satisfy immediate needs in pointer analysis - determining if a Temp could point to an array of non-primitive objects
  • Very general - can be used to compute the types of some arbitrary set of ExactTemps (not necessarily all the Temps from a method body)
  • Works for quad-no-ssa only
• LOCATION / INHERITANCE
  • harpoon.Util.TypeInference
  • public class
  • extends Object
  • implements Serializable
• FIELD
  • public static boolean DEBUG
• METHODS
  • Constructor
    public TypeInference(HMethod hm, HCode hcode, Set ietemps)
    Creates a TypeInference. This object is supposed to provide type information about the ExactTemps from the set ietemps. All these exact temps should be defined in hcode.
  • getType
    public Set getType(ExactTemp et)
    Returns the possible types for the temp et.t in the quad et.q. This method should be called only for ExactTemp that were in the ietemps set passed to the constructor of this object.
  • isArrayOfNonPrimitives
    public boolean isArrayOfNonPrimitives(ExactTemp et)
    Checks whether the temp et.t in instruction et.q points to an array of non-primitive type components (ie. not an int[]). This is useful in PointerAnalysis to see if an AGET deserves to be introduced (and possibly a new LOAD node).

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo

TypeInfo

• DESCRIPTION
  • A simple type analysis tool for quad-ssi form
• LOCATION / INHERITANCE
  • harpoon.Analysis.Quads
  • public class
  • extends Object
  • implements ExactTypeMap
  • All implemented interfaces - ExactTypeMap, TypeMap
• NESTED CLASSES
  • ExactTypeMap.ExactType
    Inherited from class harpoon.Analysis.Maps.ExactTypeMap
  • TypeMap.TypeNotKnownException
    Inherited from class harpoon.Analysis.Maps.TypeMap
• METHODS
  • Constructors
    • public TypeInfo(Code hc, UseDefMap usedef)
      Creates a TypeInfo analyzer for the specified HCode, which must be in quad-ssi form.
    • public TypeInfo(Code hc, UseDefMap usedef, boolean vBehavior)
      Creates a TypeInfo analyzer for the specified HCode, which must be in quad-ssi form. If vBehavior is true, the TypeInfo pass's IQ drops to the same level as a typical bytecode verifier; i.e. it gathers no information from instanceof's and such. Because of the IQ drop, the verifier sometimes can't determine that the operand of an AGET is really an array; with vBehavior true the TypeInfo handles this case gracefully, rather than failing an assertion.
    • public TypeInfo(Code hc)
      Creates a TypeInfo analyzer for the specified HCode, which must be in quad-ssi form.
  • typeMap
    public HClass typeMap(HCodeElement hce, Temp t) throws TypeMap.TypeNotKnownException
    Returns the type of a given temporary t, as defined at the definition point hce. Iff the type of the temporary is not known, or if hce does not define t, throws TypeNotKnownException. If the temporary represents a derived pointer, null should be returned; in which case the Derivation must return a non-null value. Obviously, TypeMaps for high-level representations without derived pointers should never return null. As a special case, HClass.Void may be returned in low-level IRs to indicate an opaque pointer value which does not correspond to a java object pointer or some derivation thereof --- for example, a pointer into a method dispatch table. The only other time HClass.Void should be returned is for known-null pointer values.
    Specified by: typeMap in interface TypeMap
    Parameters:
    • hce - The HCodeElement defining t.
    • t - The temporary to examine.
    Returns: the static type of t.
    Throws:
    • TypeMap.TypeNotKnownException - if the TypeMap does not have any information about t as defined at hc.
  • isExactType
    public boolean isExactType(HCodeElement hce, Temp t) throws TypeMap.TypeNotKnownException
    Returns true if temporary t defined at definition point hce contains an object of the type returned by typeMap(hce, t) and not a subtype of that type. Returns false if the object in t can be a subtype of the type returned by typeMap(hce, t). If typeMap() returns a primitive type, then isExactType() should return true.
    Specified by: isExactType in interface ExactTypeMap
    Parameters:
    • hce - The HCodeElement defining t for this request.
    • t - The Temp to examine.
    Returns:
    • true if t's type is exact, false otherwise.
    • TypeMap.TypeNotKnownException

Top | CALL | CallGraph | CallGraph | CFGEdge | CFGraphable | Edge | FakeMetaCallGraph | GenType | HClass | HCode | HCodeEdge | HCodeElement | HMethod | Map | MetaAllCallers | MetaCallGraph | MetaCallGraphAbstr | MetaCallGraphImpl | MetaMethod | Quad | ReachingDefs | ReachingDefsAltImpl | ReachingDefsImpl | Relation | RETURN | SCComponent | Set | SetHClass | SmartCallGraph | Temp | TypeInference | TypeInfo