Class ShrikeBTMethod

java.lang.Object

com.ibm.wala.classLoader.ShrikeBTMethod

All Implemented Interfaces:

IMember, IMethod, ContextItem, IClassHierarchyDweller, BytecodeConstants

Direct Known Subclasses:

ShrikeCTMethod

public abstract class ShrikeBTMethod
extends Object
implements IMethod, BytecodeConstants

A wrapper around a Shrike object that represents a method

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ShrikeBTMethod.BytecodeInfo

Nested classes/interfaces inherited from interface ContextItem

ContextItem.Value<T>

Nested classes/interfaces inherited from interface IMethod

IMethod.SourcePosition

Field Summary

Fields

Modifier and Type	Field	Description
protected final IClass	declaringClass	A wrapper around the declaring class.

Fields inherited from interface BytecodeConstants

JBC_aaload, JBC_aastore, JBC_aconst_null, JBC_aload, JBC_aload_0, JBC_aload_1, JBC_aload_2, JBC_aload_3, JBC_anewarray, JBC_areturn, JBC_arraylength, JBC_astore, JBC_astore_0, JBC_astore_1, JBC_astore_2, JBC_astore_3, JBC_athrow, JBC_baload, JBC_bastore, JBC_bipush, JBC_caload, JBC_castore, JBC_checkcast, JBC_d2f, JBC_d2i, JBC_d2l, JBC_dadd, JBC_daload, JBC_dastore, JBC_dcmpg, JBC_dcmpl, JBC_dconst_0, JBC_dconst_1, JBC_ddiv, JBC_dload, JBC_dload_0, JBC_dload_1, JBC_dload_2, JBC_dload_3, JBC_dmul, JBC_dneg, JBC_drem, JBC_dreturn, JBC_dstore, JBC_dstore_0, JBC_dstore_1, JBC_dstore_2, JBC_dstore_3, JBC_dsub, JBC_dup, JBC_dup_x1, JBC_dup_x2, JBC_dup2, JBC_dup2_x1, JBC_dup2_x2, JBC_f2d, JBC_f2i, JBC_f2l, JBC_fadd, JBC_faload, JBC_fastore, JBC_fcmpg, JBC_fcmpl, JBC_fconst_0, JBC_fconst_1, JBC_fconst_2, JBC_fdiv, JBC_fload, JBC_fload_0, JBC_fload_1, JBC_fload_2, JBC_fload_3, JBC_fmul, JBC_fneg, JBC_frem, JBC_freturn, JBC_fstore, JBC_fstore_0, JBC_fstore_1, JBC_fstore_2, JBC_fstore_3, JBC_fsub, JBC_getfield, JBC_getstatic, JBC_goto, JBC_goto_w, JBC_i2d, JBC_i2f, JBC_i2l, JBC_iadd, JBC_iaload, JBC_iand, JBC_iastore, JBC_iconst_0, JBC_iconst_1, JBC_iconst_2, JBC_iconst_3, JBC_iconst_4, JBC_iconst_5, JBC_iconst_m1, JBC_idiv, JBC_if_acmpeq, JBC_if_acmpne, JBC_if_icmpeq, JBC_if_icmpge, JBC_if_icmpgt, JBC_if_icmple, JBC_if_icmplt, JBC_if_icmpne, JBC_ifeq, JBC_ifge, JBC_ifgt, JBC_ifle, JBC_iflt, JBC_ifne, JBC_ifnonnull, JBC_ifnull, JBC_iinc, JBC_iload, JBC_iload_0, JBC_iload_1, JBC_iload_2, JBC_iload_3, JBC_impdep1, JBC_impdep2, JBC_imul, JBC_ineg, JBC_instanceof, JBC_int2byte, JBC_int2char, JBC_int2short, JBC_invokeinterface, JBC_invokespecial, JBC_invokestatic, JBC_invokevirtual, JBC_ior, JBC_irem, JBC_ireturn, JBC_ishl, JBC_ishr, JBC_istore, JBC_istore_0, JBC_istore_1, JBC_istore_2, JBC_istore_3, JBC_isub, JBC_iushr, JBC_ixor, JBC_jsr, JBC_jsr_w, JBC_l2d, JBC_l2f, JBC_l2i, JBC_ladd, JBC_laload, JBC_land, JBC_lastore, JBC_lcmp, JBC_lconst_0, JBC_lconst_1, JBC_ldc, JBC_ldc_w, JBC_ldc2_w, JBC_ldiv, JBC_length, JBC_lload, JBC_lload_0, JBC_lload_1, JBC_lload_2, JBC_lload_3, JBC_lmul, JBC_lneg, JBC_lookupswitch, JBC_lor, JBC_lrem, JBC_lreturn, JBC_lshl, JBC_lshr, JBC_lstore, JBC_lstore_0, JBC_lstore_1, JBC_lstore_2, JBC_lstore_3, JBC_lsub, JBC_lushr, JBC_lxor, JBC_monitorenter, JBC_monitorexit, JBC_multianewarray, JBC_name, JBC_new, JBC_newarray, JBC_nop, JBC_pop, JBC_pop2, JBC_putfield, JBC_putstatic, JBC_ret, JBC_return, JBC_saload, JBC_sastore, JBC_sipush, JBC_swap, JBC_tableswitch, JBC_wide, JBC_xxxunusedxxx

Constructor Summary

Constructors

Constructor	Description
ShrikeBTMethod(IClass klass)

Method Summary

Modifier and Type	Method	Description
void	clearCaches()	Clear all optional cached data associated with this class.
boolean	equals(Object obj)
Iterator<TypeReference>	getArraysRead()
Iterator<TypeReference>	getArraysWritten()
protected ShrikeBTMethod.BytecodeInfo	getBCInfo()
int	getBytecodeIndex(int instructionIndex)	Return the program counter (bytecode index) for a particular Shrike instruction index.
protected abstract byte[]	getBytecodes()
BytecodeStream	getBytecodeStream()	Method getBytecodeStream.
Collection<CallSiteReference>	getCallSites()
Iterator<TypeReference>	getCastTypes()
Set<TypeReference>	getCaughtExceptionTypes()
TypeReference[]	getDeclaredExceptions()	Clients should not modify the returned array.
protected abstract String[]	getDeclaredExceptionTypeNames()
IClass	getDeclaringClass()	Return the object that represents the declaring class for this member.
Descriptor	getDescriptor()	something like: (IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;
Iterator<FieldReference>	getFieldsRead()
Iterator<FieldReference>	getFieldsWritten()
ExceptionHandler[][]	getHandlers()
Collection<TypeReference>	getImplicitExceptionTypes()
int	getInstructionIndex(int bcIndex)	Return the Shrike instruction index for a particular valid program counter (bytecode index), or -1 if the Shrike instruction index could not be determined.
IInstruction[]	getInstructions()
int	getLineNumber(int bcIndex)
abstract String	getLocalVariableName(int bcIndex, int localNumber)
abstract int	getMaxLocals()
abstract int	getMaxStackHeight()
protected abstract String	getMethodName()
protected abstract String	getMethodSignature()
protected abstract int	getModifiers()
Atom	getName()
Collection<NewSiteReference>	getNewSites()
int	getNumberOfParameters()	Method getNumberOfParameters.
int	getNumShrikeInstructions()	Return the number of Shrike instructions for this method.
IMethod.SourcePosition	getParameterSourcePosition(int paramNum)
TypeReference	getParameterType(int i)	By convention, for a non-static method, getParameterType(0) is the this pointer
MethodReference	getReference()
Selector	getSelector()	something like: foo(Ljava/langString;)Ljava/lang/Class;
String	getSignature()	something like: com.foo.bar.createLargeOrder(IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;
IMethod.SourcePosition	getSourcePosition(int bcIndex)
abstract boolean	hasExceptionHandler()
int	hashCode()
abstract boolean	hasLocalVariableTable()
boolean	hasMonitorOp()
boolean	isAbstract()	Is this method abstract?
boolean	isAnnotation()
boolean	isBridge()	Is this method a bridge method? See JLS 3rd Edition 15.12.4.5
boolean	isClinit()	Is this method a class initializer?
boolean	isEnum()
boolean	isFinal()	Is this method final?
boolean	isInit()	Is this method an object initializer?
boolean	isModule()
boolean	isNative()	Is this method native?
boolean	isPrivate()	Is this method private?
boolean	isProtected()	Is this method protected?
boolean	isPublic()	Is this method public?
boolean	isStatic()	Is this member static?
boolean	isSynchronized()	Is this method synchronized?
boolean	isSynthetic()	Is this method synthetic, i.e., compiler-generated (this refers to the synthetic flag in java/dex bytecode)
boolean	isWalaSynthetic()	Is the implementation of this method a model generated by WALA? For compiler-generated synthetic methods, refer to IMethod.isSynthetic()
protected abstract Decoder	makeDecoder()	Find the decoder object for this method, or create one if necessary.
protected abstract void	processDebugInfo(ShrikeBTMethod.BytecodeInfo bcInfo)	Walk through the bytecodes and collect trivial information.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IClassHierarchyDweller

getClassHierarchy

Methods inherited from interface IMember

getAnnotations

Methods inherited from interface IMethod

getNumberOfDefaultParameters, getReturnType

Field Details

declaringClass

protected final IClass declaringClass

A wrapper around the declaring class.

Constructor Details

ShrikeBTMethod

public ShrikeBTMethod(IClass klass)

Method Details

getBCInfo

protected ShrikeBTMethod.BytecodeInfo getBCInfo()
                                         throws InvalidClassFileException

Throws:

InvalidClassFileException

getBytecodeIndex

public int getBytecodeIndex(int instructionIndex)
                     throws InvalidClassFileException

Return the program counter (bytecode index) for a particular Shrike instruction index.

Throws:

InvalidClassFileException

getInstructionIndex

public int getInstructionIndex(int bcIndex)
                        throws InvalidClassFileException

Return the Shrike instruction index for a particular valid program counter (bytecode index), or -1 if the Shrike instruction index could not be determined.

This ShrikeBTMethod must not be native.

Throws:

InvalidClassFileException

getNumShrikeInstructions

public int getNumShrikeInstructions()
                             throws InvalidClassFileException

Return the number of Shrike instructions for this method.

Throws:

InvalidClassFileException

getCallSites

public Collection<CallSiteReference> getCallSites()
                                           throws InvalidClassFileException

Throws:

InvalidClassFileException

getNewSites

public Collection<NewSiteReference> getNewSites()
                                         throws InvalidClassFileException

Throws:

InvalidClassFileException

getImplicitExceptionTypes

public Collection<TypeReference> getImplicitExceptionTypes()
                                                    throws InvalidClassFileException

Returns:

Set<TypeReference>, the exceptions that statements in this method may throw,

Throws:

InvalidClassFileException

hasMonitorOp

public boolean hasMonitorOp()
                     throws InvalidClassFileException

Returns:

true iff this method has a monitorenter or monitorexit

Throws:

InvalidClassFileException

getFieldsWritten

public Iterator<FieldReference> getFieldsWritten()
                                          throws InvalidClassFileException

Returns:

Set of FieldReference

Throws:

InvalidClassFileException

getFieldsRead

public Iterator<FieldReference> getFieldsRead()
                                       throws InvalidClassFileException

Returns:

Iterator of FieldReference

Throws:

InvalidClassFileException

getArraysRead

public Iterator<TypeReference> getArraysRead()
                                      throws InvalidClassFileException

Returns:

Iterator of TypeReference

Throws:

InvalidClassFileException

getArraysWritten

public Iterator<TypeReference> getArraysWritten()
                                         throws InvalidClassFileException

Returns:

Iterator of TypeReference

Throws:

InvalidClassFileException

getCastTypes

public Iterator<TypeReference> getCastTypes()
                                     throws InvalidClassFileException

Returns:

Iterator of TypeReference

Throws:

InvalidClassFileException

getBytecodes

protected abstract byte[] getBytecodes()

getBytecodeStream

public BytecodeStream getBytecodeStream()

Method getBytecodeStream.

Returns:

the bytecode stream for this method, or null if no bytecodes.

getMethodName

protected abstract String getMethodName()
                                 throws InvalidClassFileException

Throws:

InvalidClassFileException

getMethodSignature

protected abstract String getMethodSignature()
                                      throws InvalidClassFileException

Throws:

InvalidClassFileException

getReference

public MethodReference getReference()

Specified by:

getReference in interface IMethod

Returns:

canonical MethodReference corresponding to this method

isClinit

public boolean isClinit()

Description copied from interface: IMethod

Is this method a class initializer?

Specified by:

isClinit in interface IMethod

isInit

public boolean isInit()

Description copied from interface: IMethod

Is this method an object initializer?

Specified by:

isInit in interface IMethod

getModifiers

protected abstract int getModifiers()

isNative

public boolean isNative()

Description copied from interface: IMethod

Is this method native?

Specified by:

isNative in interface IMethod

isAbstract

public boolean isAbstract()

Description copied from interface: IMethod

Is this method abstract?

Specified by:

isAbstract in interface IMethod

isPrivate

public boolean isPrivate()

Description copied from interface: IMethod

Is this method private?

Specified by:

isPrivate in interface IMethod

isProtected

public boolean isProtected()

Description copied from interface: IMethod

Is this method protected?

Specified by:

isProtected in interface IMethod

isPublic

public boolean isPublic()

Description copied from interface: IMethod

Is this method public?

Specified by:

isPublic in interface IMethod

isFinal

public boolean isFinal()

Description copied from interface: IMethod

Is this method final?

Specified by:

isFinal in interface IMethod

isBridge

public boolean isBridge()

Description copied from interface: IMethod

Is this method a bridge method? See JLS 3rd Edition 15.12.4.5

Specified by:

isBridge in interface IMethod

isSynchronized

public boolean isSynchronized()

Description copied from interface: IMethod

Is this method synchronized?

Specified by:

isSynchronized in interface IMethod

isStatic

public boolean isStatic()

Description copied from interface: IMember

Is this member static?

Specified by:

isStatic in interface IMember

isSynthetic

public boolean isSynthetic()

Description copied from interface: IMethod

Is this method synthetic, i.e., compiler-generated (this refers to the synthetic flag in java/dex bytecode)

Specified by:

isSynthetic in interface IMethod

isAnnotation

public boolean isAnnotation()

Specified by:

isAnnotation in interface IMethod

isEnum

public boolean isEnum()

Specified by:

isEnum in interface IMethod

isModule

public boolean isModule()

Specified by:

isModule in interface IMethod

isWalaSynthetic

public boolean isWalaSynthetic()

Description copied from interface: IMethod

Is the implementation of this method a model generated by WALA? For compiler-generated synthetic methods, refer to IMethod.isSynthetic()

Specified by:

isWalaSynthetic in interface IMethod

getDeclaringClass

public IClass getDeclaringClass()

Description copied from interface: IMember

Return the object that represents the declaring class for this member.

Specified by:

getDeclaringClass in interface IMember

Returns:

the object that represents the declaring class for this member.

makeDecoder

protected abstract Decoder makeDecoder()

Find the decoder object for this method, or create one if necessary.

Returns:

null if the method has no code.

processDebugInfo

protected abstract void processDebugInfo(ShrikeBTMethod.BytecodeInfo bcInfo)
                                  throws InvalidClassFileException

Walk through the bytecodes and collect trivial information.

Throws:

InvalidClassFileException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMaxLocals

public abstract int getMaxLocals()

See Also:

• SyntheticMethod.getMaxLocals()

getMaxStackHeight

public abstract int getMaxStackHeight()

getName

public Atom getName()

Specified by:

getName in interface IMember

Returns:

the name of this member

getDescriptor

public Descriptor getDescriptor()

Description copied from interface: IMethod

something like: (IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;

Specified by:

getDescriptor in interface IMethod

getInstructions

public IInstruction[] getInstructions()
                               throws InvalidClassFileException

Throws:

InvalidClassFileException

getHandlers

public ExceptionHandler[][] getHandlers()
                                 throws InvalidClassFileException

Throws:

InvalidClassFileException

getParameterType

public TypeReference getParameterType(int i)

By convention, for a non-static method, getParameterType(0) is the this pointer

Specified by:

getParameterType in interface IMethod

getNumberOfParameters

public int getNumberOfParameters()

Method getNumberOfParameters. This result includes the "this" pointer if applicable

Specified by:

getNumberOfParameters in interface IMethod

Returns:

int

hasExceptionHandler

public abstract boolean hasExceptionHandler()

Specified by:

hasExceptionHandler in interface IMethod

Returns:

true iff this method has at least one exception handler

getDeclaredExceptions

public TypeReference[] getDeclaredExceptions()
                                      throws InvalidClassFileException

Clients should not modify the returned array. TODO: clone to avoid the problem?

Specified by:

getDeclaredExceptions in interface IMethod

Returns:

an array of the exception types declared by the throws clause for this method, or null if there are none

Throws:

InvalidClassFileException

getDeclaredExceptionTypeNames

protected abstract String[] getDeclaredExceptionTypeNames()
                                                   throws InvalidClassFileException

Throws:

InvalidClassFileException

getSourcePosition

public IMethod.SourcePosition getSourcePosition(int bcIndex)
                                         throws InvalidClassFileException

Specified by:

getSourcePosition in interface IMethod

Throws:

InvalidClassFileException

getParameterSourcePosition

public IMethod.SourcePosition getParameterSourcePosition(int paramNum)
                                                  throws InvalidClassFileException

Specified by:

getParameterSourcePosition in interface IMethod

Throws:

InvalidClassFileException

getLineNumber

public int getLineNumber(int bcIndex)

Specified by:

getLineNumber in interface IMethod

Returns:

the source line number corresponding to a particular bytecode index, or -1 if the information is not available.

getCaughtExceptionTypes

public Set<TypeReference> getCaughtExceptionTypes()
                                           throws InvalidClassFileException

Returns:

Set<TypeReference>

Throws:

InvalidClassFileException

getSignature

public String getSignature()

Description copied from interface: IMethod

something like: com.foo.bar.createLargeOrder(IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;

Specified by:

getSignature in interface IMethod

getSelector

public Selector getSelector()

Description copied from interface: IMethod

something like: foo(Ljava/langString;)Ljava/lang/Class;

Specified by:

getSelector in interface IMethod

getLocalVariableName

public abstract String getLocalVariableName(int bcIndex,
 int localNumber)

Specified by:

getLocalVariableName in interface IMethod

Returns:

the (source code) name of the local variable of a given number at the specified program counter, or null if the information is not available.

hasLocalVariableTable

public abstract boolean hasLocalVariableTable()

Specified by:

hasLocalVariableTable in interface IMethod

Returns:

true iff the local variable table information for this method is available

clearCaches

public void clearCaches()

Clear all optional cached data associated with this class.