Class DexCFG

java.lang.Object

com.ibm.wala.cfg.AbstractCFG<Instruction, DexCFG.BasicBlock>

com.ibm.wala.dalvik.classLoader.DexCFG

All Implemented Interfaces:

BytecodeCFG, ControlFlowGraph<Instruction, DexCFG.BasicBlock>, MinimalCFG<DexCFG.BasicBlock>, Constants, EdgeManager<DexCFG.BasicBlock>, Graph<DexCFG.BasicBlock>, NodeManager<DexCFG.BasicBlock>, NumberedEdgeManager<DexCFG.BasicBlock>, NumberedGraph<DexCFG.BasicBlock>, NumberedNodeManager<DexCFG.BasicBlock>, Iterable<DexCFG.BasicBlock>

public class DexCFG
extends AbstractCFG<Instruction, DexCFG.BasicBlock>
implements BytecodeCFG

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	DexCFG.BasicBlock

Field Summary

Fields inherited from interface Constants

ACC_ABSTRACT, ACC_ANNOTATION, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_MODULE, ACC_NATIVE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_VOLATILE, CONSTANT_Class, CONSTANT_Double, CONSTANT_FieldRef, CONSTANT_Float, CONSTANT_Integer, CONSTANT_InterfaceMethodRef, CONSTANT_InvokeDynamic, CONSTANT_Long, CONSTANT_MethodHandle, CONSTANT_MethodRef, CONSTANT_MethodType, CONSTANT_NameAndType, CONSTANT_String, CONSTANT_Utf8, indexedTypes, indexedTypes_T, MAYBE, NO, OP_aaload, OP_aastore, OP_aconst_null, OP_aload, OP_aload_0, OP_aload_1, OP_aload_2, OP_aload_3, OP_anewarray, OP_areturn, OP_arraylength, OP_astore, OP_astore_0, OP_astore_1, OP_astore_2, OP_astore_3, OP_athrow, OP_baload, OP_bastore, OP_bipush, OP_caload, OP_castore, OP_checkcast, OP_d2f, OP_d2i, OP_d2l, OP_dadd, OP_daload, OP_dastore, OP_dcmpg, OP_dcmpl, OP_dconst_0, OP_dconst_1, OP_ddiv, OP_dload, OP_dload_0, OP_dload_1, OP_dload_2, OP_dload_3, OP_dmul, OP_dneg, OP_drem, OP_dreturn, OP_dstore, OP_dstore_0, OP_dstore_1, OP_dstore_2, OP_dstore_3, OP_dsub, OP_dup, OP_dup_x1, OP_dup_x2, OP_dup2, OP_dup2_x1, OP_dup2_x2, OP_f2d, OP_f2i, OP_f2l, OP_fadd, OP_faload, OP_fastore, OP_fcmpg, OP_fcmpl, OP_fconst_0, OP_fconst_1, OP_fconst_2, OP_fdiv, OP_fload, OP_fload_0, OP_fload_1, OP_fload_2, OP_fload_3, OP_fmul, OP_fneg, OP_frem, OP_freturn, OP_fstore, OP_fstore_0, OP_fstore_1, OP_fstore_2, OP_fstore_3, OP_fsub, OP_getfield, OP_getstatic, OP_goto, OP_goto_w, OP_i2b, OP_i2c, OP_i2d, OP_i2f, OP_i2l, OP_i2s, OP_iadd, OP_iaload, OP_iand, OP_iastore, OP_iconst_0, OP_iconst_1, OP_iconst_2, OP_iconst_3, OP_iconst_4, OP_iconst_5, OP_iconst_m1, OP_idiv, OP_if_acmpeq, OP_if_acmpne, OP_if_icmpeq, OP_if_icmpge, OP_if_icmpgt, OP_if_icmple, OP_if_icmplt, OP_if_icmpne, OP_ifeq, OP_ifge, OP_ifgt, OP_ifle, OP_iflt, OP_ifne, OP_ifnonnull, OP_ifnull, OP_iinc, OP_iload, OP_iload_0, OP_iload_1, OP_iload_2, OP_iload_3, OP_imul, OP_ineg, OP_instanceof, OP_invokedynamic, OP_invokeinterface, OP_invokespecial, OP_invokestatic, OP_invokevirtual, OP_ior, OP_irem, OP_ireturn, OP_ishl, OP_ishr, OP_istore, OP_istore_0, OP_istore_1, OP_istore_2, OP_istore_3, OP_isub, OP_iushr, OP_ixor, OP_jsr, OP_jsr_w, OP_l2d, OP_l2f, OP_l2i, OP_ladd, OP_laload, OP_land, OP_lastore, OP_lcmp, OP_lconst_0, OP_lconst_1, OP_ldc, OP_ldc_w, OP_ldc2_w, OP_ldiv, OP_lload, OP_lload_0, OP_lload_1, OP_lload_2, OP_lload_3, OP_lmul, OP_lneg, OP_lookupswitch, OP_lor, OP_lrem, OP_lreturn, OP_lshl, OP_lshr, OP_lstore, OP_lstore_0, OP_lstore_1, OP_lstore_2, OP_lstore_3, OP_lsub, OP_lushr, OP_lxor, OP_monitorenter, OP_monitorexit, OP_multianewarray, OP_new, OP_newarray, OP_nop, OP_pop, OP_pop2, OP_putfield, OP_putstatic, OP_ret, OP_return, OP_saload, OP_sastore, OP_sipush, OP_swap, OP_tableswitch, OP_wide, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_SHORT, TYPE_boolean, TYPE_boolean_index, TYPE_byte, TYPE_byte_index, TYPE_char, TYPE_char_index, TYPE_Class, TYPE_double, TYPE_double_index, TYPE_Error, TYPE_Exception, TYPE_float, TYPE_float_index, TYPE_int, TYPE_int_index, TYPE_long, TYPE_long_index, TYPE_MethodHandle, TYPE_MethodType, TYPE_null, TYPE_Object, TYPE_Object_index, TYPE_RuntimeException, TYPE_short, TYPE_short_index, TYPE_String, TYPE_Throwable, TYPE_unknown, TYPE_void, YES

Modifier and Type	Field	Description
static final char	ACC_ABSTRACT
static final char	ACC_ANNOTATION
static final char	ACC_ENUM
static final char	ACC_FINAL
static final char	ACC_INTERFACE
static final char	ACC_MODULE
static final char	ACC_NATIVE
static final char	ACC_PRIVATE
static final char	ACC_PROTECTED
static final char	ACC_PUBLIC
static final char	ACC_STATIC
static final char	ACC_STRICT
static final char	ACC_SUPER
static final char	ACC_SYNCHRONIZED
static final char	ACC_SYNTHETIC
static final char	ACC_TRANSIENT
static final char	ACC_VOLATILE
static final byte	CONSTANT_Class
static final byte	CONSTANT_Double
static final byte	CONSTANT_FieldRef
static final byte	CONSTANT_Float
static final byte	CONSTANT_Integer
static final byte	CONSTANT_InterfaceMethodRef
static final byte	CONSTANT_InvokeDynamic
static final byte	CONSTANT_Long
static final byte	CONSTANT_MethodHandle
static final byte	CONSTANT_MethodRef
static final byte	CONSTANT_MethodType
static final byte	CONSTANT_NameAndType
static final byte	CONSTANT_String
static final byte	CONSTANT_Utf8
static final String[]	indexedTypes
static final byte[]	indexedTypes_T
static final int	MAYBE
static final int	NO
static final short	OP_aaload
static final short	OP_aastore
static final short	OP_aconst_null
static final short	OP_aload
static final short	OP_aload_0
static final short	OP_aload_1
static final short	OP_aload_2
static final short	OP_aload_3
static final short	OP_anewarray
static final short	OP_areturn
static final short	OP_arraylength
static final short	OP_astore
static final short	OP_astore_0
static final short	OP_astore_1
static final short	OP_astore_2
static final short	OP_astore_3
static final short	OP_athrow
static final short	OP_baload
static final short	OP_bastore
static final short	OP_bipush
static final short	OP_caload
static final short	OP_castore
static final short	OP_checkcast
static final short	OP_d2f
static final short	OP_d2i
static final short	OP_d2l
static final short	OP_dadd
static final short	OP_daload
static final short	OP_dastore
static final short	OP_dcmpg
static final short	OP_dcmpl
static final short	OP_dconst_0
static final short	OP_dconst_1
static final short	OP_ddiv
static final short	OP_dload
static final short	OP_dload_0
static final short	OP_dload_1
static final short	OP_dload_2
static final short	OP_dload_3
static final short	OP_dmul
static final short	OP_dneg
static final short	OP_drem
static final short	OP_dreturn
static final short	OP_dstore
static final short	OP_dstore_0
static final short	OP_dstore_1
static final short	OP_dstore_2
static final short	OP_dstore_3
static final short	OP_dsub
static final short	OP_dup
static final short	OP_dup_x1
static final short	OP_dup_x2
static final short	OP_dup2
static final short	OP_dup2_x1
static final short	OP_dup2_x2
static final short	OP_f2d
static final short	OP_f2i
static final short	OP_f2l
static final short	OP_fadd
static final short	OP_faload
static final short	OP_fastore
static final short	OP_fcmpg
static final short	OP_fcmpl
static final short	OP_fconst_0
static final short	OP_fconst_1
static final short	OP_fconst_2
static final short	OP_fdiv
static final short	OP_fload
static final short	OP_fload_0
static final short	OP_fload_1
static final short	OP_fload_2
static final short	OP_fload_3
static final short	OP_fmul
static final short	OP_fneg
static final short	OP_frem
static final short	OP_freturn
static final short	OP_fstore
static final short	OP_fstore_0
static final short	OP_fstore_1
static final short	OP_fstore_2
static final short	OP_fstore_3
static final short	OP_fsub
static final short	OP_getfield
static final short	OP_getstatic
static final short	OP_goto
static final short	OP_goto_w
static final short	OP_i2b
static final short	OP_i2c
static final short	OP_i2d
static final short	OP_i2f
static final short	OP_i2l
static final short	OP_i2s
static final short	OP_iadd
static final short	OP_iaload
static final short	OP_iand
static final short	OP_iastore
static final short	OP_iconst_0
static final short	OP_iconst_1
static final short	OP_iconst_2
static final short	OP_iconst_3
static final short	OP_iconst_4
static final short	OP_iconst_5
static final short	OP_iconst_m1
static final short	OP_idiv
static final short	OP_if_acmpeq
static final short	OP_if_acmpne
static final short	OP_if_icmpeq
static final short	OP_if_icmpge
static final short	OP_if_icmpgt
static final short	OP_if_icmple
static final short	OP_if_icmplt
static final short	OP_if_icmpne
static final short	OP_ifeq
static final short	OP_ifge
static final short	OP_ifgt
static final short	OP_ifle
static final short	OP_iflt
static final short	OP_ifne
static final short	OP_ifnonnull
static final short	OP_ifnull
static final short	OP_iinc
static final short	OP_iload
static final short	OP_iload_0
static final short	OP_iload_1
static final short	OP_iload_2
static final short	OP_iload_3
static final short	OP_imul
static final short	OP_ineg
static final short	OP_instanceof
static final short	OP_invokedynamic
static final short	OP_invokeinterface
static final short	OP_invokespecial
static final short	OP_invokestatic
static final short	OP_invokevirtual
static final short	OP_ior
static final short	OP_irem
static final short	OP_ireturn
static final short	OP_ishl
static final short	OP_ishr
static final short	OP_istore
static final short	OP_istore_0
static final short	OP_istore_1
static final short	OP_istore_2
static final short	OP_istore_3
static final short	OP_isub
static final short	OP_iushr
static final short	OP_ixor
static final short	OP_jsr
static final short	OP_jsr_w
static final short	OP_l2d
static final short	OP_l2f
static final short	OP_l2i
static final short	OP_ladd
static final short	OP_laload
static final short	OP_land
static final short	OP_lastore
static final short	OP_lcmp
static final short	OP_lconst_0
static final short	OP_lconst_1
static final short	OP_ldc
static final short	OP_ldc_w
static final short	OP_ldc2_w
static final short	OP_ldiv
static final short	OP_lload
static final short	OP_lload_0
static final short	OP_lload_1
static final short	OP_lload_2
static final short	OP_lload_3
static final short	OP_lmul
static final short	OP_lneg
static final short	OP_lookupswitch
static final short	OP_lor
static final short	OP_lrem
static final short	OP_lreturn
static final short	OP_lshl
static final short	OP_lshr
static final short	OP_lstore
static final short	OP_lstore_0
static final short	OP_lstore_1
static final short	OP_lstore_2
static final short	OP_lstore_3
static final short	OP_lsub
static final short	OP_lushr
static final short	OP_lxor
static final short	OP_monitorenter
static final short	OP_monitorexit
static final short	OP_multianewarray
static final short	OP_new
static final short	OP_newarray
static final short	OP_nop
static final short	OP_pop
static final short	OP_pop2
static final short	OP_putfield
static final short	OP_putstatic
static final short	OP_ret
static final short	OP_return
static final short	OP_saload
static final short	OP_sastore
static final short	OP_sipush
static final short	OP_swap
static final short	OP_tableswitch
static final short	OP_wide
static final byte	T_BOOLEAN
static final byte	T_BYTE
static final byte	T_CHAR
static final byte	T_DOUBLE
static final byte	T_FLOAT
static final byte	T_INT
static final byte	T_LONG
static final byte	T_SHORT
static final String	TYPE_boolean
static final byte	TYPE_boolean_index
static final String	TYPE_byte
static final byte	TYPE_byte_index
static final String	TYPE_char
static final byte	TYPE_char_index
static final String	TYPE_Class
static final String	TYPE_double
static final byte	TYPE_double_index
static final String	TYPE_Error
static final String	TYPE_Exception
static final String	TYPE_float
static final byte	TYPE_float_index
static final String	TYPE_int
static final byte	TYPE_int_index
static final String	TYPE_long
static final byte	TYPE_long_index
static final String	TYPE_MethodHandle
static final String	TYPE_MethodType
static final String	TYPE_null	This represents the type of "null", which can be any object.
static final String	TYPE_Object
static final byte	TYPE_Object_index
static final String	TYPE_RuntimeException
static final String	TYPE_short
static final byte	TYPE_short_index
static final String	TYPE_String
static final String	TYPE_Throwable
static final String	TYPE_unknown	This represents a type which is unknown.
static final String	TYPE_void
static final int	YES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DexCFG(DexIMethod method, Context context)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DexCFG.BasicBlock	getBlockForInstruction(int index)	Return an instruction's basic block in the CFG given the index of the instruction in the CFG's instruction array.
DexIMethod	getDexMethod()
Set<ExceptionHandler>	getExceptionHandlers()
Instruction[]	getInstructions()
int	getMaxLocals()
int	getMaxStackHeight()
int	getProgramCounter(int index)	TODO: move this into IR?
static int	getTotalEdges()
int	hashCode()
String	toString()

Methods inherited from class AbstractCFG

addEdge, addExceptionalEdge, addNode, addNormalEdge, containsNode, entry, exit, getCatchBlocks, getExceptionalPredecessors, getExceptionalSuccessors, getExceptionalToExit, getMaxNumber, getMethod, getNode, getNormalPredecessors, getNormalSuccessors, getNormalToExit, getNumber, getNumberOfExceptionalIn, getNumberOfExceptionalOut, getNumberOfExceptionalOut, getNumberOfNodes, getNumberOfNormalIn, getNumberOfNormalOut, getPredNodeCount, getPredNodeNumbers, getPredNodes, getSuccNodeCount, getSuccNodeNumbers, getSuccNodes, hasEdge, hasExceptionalEdge, hasNormalEdge, init, isCatchBlock, iterateNodes, iterator, removeAllIncidentEdges, removeEdge, removeIncomingEdges, removeNode, removeNodeAndEdges, removeOutgoingEdges, setCatchBlock, stream

Modifier and Type	Method	Description
void	addEdge(DexCFG.BasicBlock src, DexCFG.BasicBlock dst)
void	addExceptionalEdge(DexCFG.BasicBlock src, DexCFG.BasicBlock dst)
void	addNode(DexCFG.BasicBlock n)	add a node to this graph
void	addNormalEdge(DexCFG.BasicBlock src, DexCFG.BasicBlock dst)
boolean	containsNode(DexCFG.BasicBlock N)
DexCFG.BasicBlock	entry()	Return the entry basic block for the CFG.
DexCFG.BasicBlock	exit()	Return the exit basic block for the CFG.
BitVector	getCatchBlocks()	Returns the catchBlocks.
Collection<DexCFG.BasicBlock>	getExceptionalPredecessors(DexCFG.BasicBlock b)	The order of blocks returned should be arbitrary but deterministic.
List<DexCFG.BasicBlock>	getExceptionalSuccessors(DexCFG.BasicBlock b)	The order of blocks returned must indicate the exception-handling scope.
FixedSizeBitVector	getExceptionalToExit()
int	getMaxNumber()
IMethod	getMethod()
DexCFG.BasicBlock	getNode(int number)
Collection<DexCFG.BasicBlock>	getNormalPredecessors(DexCFG.BasicBlock b)	The order of blocks returned should be arbitrary but deterministic.
Collection<DexCFG.BasicBlock>	getNormalSuccessors(DexCFG.BasicBlock b)	The order of blocks returned should be arbitrary but deterministic.
FixedSizeBitVector	getNormalToExit()
int	getNumber(DexCFG.BasicBlock N)
int	getNumberOfExceptionalIn(DexCFG.BasicBlock N)
int	getNumberOfExceptionalOut(int number)
int	getNumberOfExceptionalOut(DexCFG.BasicBlock N)
int	getNumberOfNodes()
int	getNumberOfNormalIn(DexCFG.BasicBlock N)
int	getNumberOfNormalOut(DexCFG.BasicBlock N)
int	getPredNodeCount(DexCFG.BasicBlock N)	Return the number of immediate predecessor nodes of n
IntSet	getPredNodeNumbers(DexCFG.BasicBlock node)
Iterator<DexCFG.BasicBlock>	getPredNodes(DexCFG.BasicBlock N)	Return an Iterator over the immediate predecessor nodes of n
int	getSuccNodeCount(DexCFG.BasicBlock N)	Return the number of immediate successor nodes of this Node in the Graph
IntSet	getSuccNodeNumbers(DexCFG.BasicBlock node)
Iterator<DexCFG.BasicBlock>	getSuccNodes(DexCFG.BasicBlock N)	Return an Iterator over the immediate successor nodes of n
boolean	hasEdge(DexCFG.BasicBlock src, DexCFG.BasicBlock dst)
boolean	hasExceptionalEdge(DexCFG.BasicBlock src, DexCFG.BasicBlock dst)
boolean	hasNormalEdge(DexCFG.BasicBlock src, DexCFG.BasicBlock dst)
protected void	init()	subclasses must call this before calling addEdge, but after creating the nodes
boolean	isCatchBlock(int i)
Iterator<DexCFG.BasicBlock>	iterateNodes(IntSet s)
Iterator<DexCFG.BasicBlock>	iterator()
void	removeAllIncidentEdges(DexCFG.BasicBlock node)
void	removeEdge(DexCFG.BasicBlock src, DexCFG.BasicBlock dst)
void	removeIncomingEdges(DexCFG.BasicBlock node)
void	removeNode(DexCFG.BasicBlock n)	remove a node from this graph
void	removeNodeAndEdges(DexCFG.BasicBlock N)	remove a node and all its incident edges
void	removeOutgoingEdges(DexCFG.BasicBlock node)
protected void	setCatchBlock(int i)	record that basic block i is a catch block
Stream<DexCFG.BasicBlock>	stream()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

DexCFG

protected DexCFG(DexIMethod method,
 Context context)
          throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

getDexMethod

public DexIMethod getDexMethod()

getTotalEdges

public static int getTotalEdges()

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractCFG<Instruction, DexCFG.BasicBlock>

equals

public boolean equals(Object o)

Specified by:

equals in class AbstractCFG<Instruction, DexCFG.BasicBlock>

getInstructions

public Instruction[] getInstructions()

Specified by:

getInstructions in interface ControlFlowGraph<Instruction, DexCFG.BasicBlock>

Returns:

the instructions of this CFG, as an array.

getBlockForInstruction

public DexCFG.BasicBlock getBlockForInstruction(int index)

Return an instruction's basic block in the CFG given the index of the instruction in the CFG's instruction array.

Specified by:

getBlockForInstruction in interface ControlFlowGraph<Instruction, DexCFG.BasicBlock>

Parameters:

index - an instruction index

Returns:

the basic block which contains this instruction.

toString

public String toString()

Overrides:

toString in class AbstractCFG<Instruction, DexCFG.BasicBlock>

getMaxStackHeight

public int getMaxStackHeight()

getMaxLocals

public int getMaxLocals()

getExceptionHandlers

public Set<ExceptionHandler> getExceptionHandlers()

Specified by:

getExceptionHandlers in interface BytecodeCFG

getProgramCounter

public int getProgramCounter(int index)

Description copied from interface: ControlFlowGraph

TODO: move this into IR?

Specified by:

getProgramCounter in interface ControlFlowGraph<Instruction, DexCFG.BasicBlock>

Parameters:

index - an instruction index

Returns:

the program counter (bytecode index) corresponding to that instruction

See Also:

• ControlFlowGraph.getProgramCounter(int)