com.ibm.wala.cfg

Class AbstractCFG<I,T extends IBasicBlock<I>>

java.lang.Object

com.ibm.wala.cfg.AbstractCFG<I,T>

All Implemented Interfaces:

ControlFlowGraph<I,T>, MinimalCFG<T>, com.ibm.wala.shrikeBT.Constants, com.ibm.wala.util.graph.EdgeManager<T>, com.ibm.wala.util.graph.Graph<T>, com.ibm.wala.util.graph.NodeManager<T>, com.ibm.wala.util.graph.NumberedEdgeManager<T>, com.ibm.wala.util.graph.NumberedGraph<T>, com.ibm.wala.util.graph.NumberedNodeManager<T>, java.lang.Iterable<T>

Direct Known Subclasses:

InducedCFG, ShrikeCFG

public abstract class AbstractCFG<I,T extends IBasicBlock<I>>
extends java.lang.Object
implements ControlFlowGraph<I,T>, MinimalCFG<T>, com.ibm.wala.shrikeBT.Constants

Common functionality for ControlFlowGraph implementations.

Field Summary

Fields inherited from interface com.ibm.wala.shrikeBT.Constants

ACC_ABSTRACT, ACC_FINAL, ACC_INTERFACE, 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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCFG(IMethod method)

Method Summary

Modifier and Type	Method and Description
void	addEdge(T src, T dst)
void	addExceptionalEdge(T src, T dst)
void	addNode(T n)
void	addNormalEdge(T src, T dst)
boolean	containsNode(T N)
T	entry() Return the entry basic block for the CFG.
abstract boolean	equals(java.lang.Object o)
T	exit() Return the exit basic block for the CFG.
com.ibm.wala.util.intset.BitVector	getCatchBlocks() Returns the catchBlocks.
java.util.Collection<T>	getExceptionalPredecessors(T b) The order of blocks returned should be arbitrary but deterministic.
java.util.List<T>	getExceptionalSuccessors(T b) The order of blocks returned must indicate the exception-handling scope.
com.ibm.wala.util.intset.FixedSizeBitVector	getExceptionalToExit()
int	getMaxNumber()
IMethod	getMethod()
T	getNode(int number)
java.util.Collection<T>	getNormalPredecessors(T b) The order of blocks returned should be arbitrary but deterministic.
java.util.Collection<T>	getNormalSuccessors(T b) The order of blocks returned should be arbitrary but deterministic.
com.ibm.wala.util.intset.FixedSizeBitVector	getNormalToExit()
int	getNumber(T N)
int	getNumberOfExceptionalIn(T N)
int	getNumberOfExceptionalOut(int number)
int	getNumberOfExceptionalOut(T N)
int	getNumberOfNodes()
int	getNumberOfNormalIn(T N)
int	getNumberOfNormalOut(T N)
int	getPredNodeCount(T N)
com.ibm.wala.util.intset.IntSet	getPredNodeNumbers(T node)
java.util.Iterator<T>	getPredNodes(T N)
int	getSuccNodeCount(T N)
com.ibm.wala.util.intset.IntSet	getSuccNodeNumbers(T node)
java.util.Iterator<T>	getSuccNodes(T N)
boolean	hasEdge(T src, T dst)
boolean	hasExceptionalEdge(T src, T dst)
abstract int	hashCode()
boolean	hasNormalEdge(T src, T dst)
protected void	init() subclasses must call this before calling addEdge, but after creating the nodes
boolean	isCatchBlock(int i)
java.util.Iterator<T>	iterateNodes(com.ibm.wala.util.intset.IntSet s)
java.util.Iterator<T>	iterator()
void	removeAllIncidentEdges(T node)
void	removeEdge(T src, T dst)
void	removeIncomingEdges(T node)
void	removeNode(T n)
void	removeNodeAndEdges(T N)
void	removeOutgoingEdges(T node)
protected void	setCatchBlock(int i) record that basic block i is a catch block
java.util.stream.Stream<T>	stream()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.wala.cfg.ControlFlowGraph

getBlockForInstruction, getInstructions, getProgramCounter

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractCFG

protected AbstractCFG(IMethod method)

Method Detail

init

protected void init()

subclasses must call this before calling addEdge, but after creating the nodes

equals

public abstract boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

entry

public T entry()

Return the entry basic block for the CFG.

Specified by:

entry in interface MinimalCFG<T extends IBasicBlock<I>>

exit

public T exit()

Return the exit basic block for the CFG.

Specified by:

exit in interface MinimalCFG<T extends IBasicBlock<I>>

Returns:

the synthetic exit block for the cfg

getPredNodeCount

public int getPredNodeCount(T N)

Specified by:

getPredNodeCount in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

getNumberOfNormalIn

public int getNumberOfNormalIn(T N)

getNumberOfExceptionalIn

public int getNumberOfExceptionalIn(T N)

getNumberOfExceptionalOut

public int getNumberOfExceptionalOut(int number)

Parameters:

number - number of a basic block in this cfg

getNumberOfNormalOut

public int getNumberOfNormalOut(T N)

getNumberOfExceptionalOut

public int getNumberOfExceptionalOut(T N)

getPredNodes

public java.util.Iterator<T> getPredNodes(T N)

Specified by:

getPredNodes in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

getSuccNodeCount

public int getSuccNodeCount(T N)

Specified by:

getSuccNodeCount in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

getSuccNodes

public java.util.Iterator<T> getSuccNodes(T N)

Specified by:

getSuccNodes in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

addNode

public void addNode(T n)

Specified by:

addNode in interface com.ibm.wala.util.graph.NodeManager<T extends IBasicBlock<I>>

getMaxNumber

public int getMaxNumber()

Specified by:

getMaxNumber in interface com.ibm.wala.util.graph.NumberedNodeManager<T extends IBasicBlock<I>>

getNode

public T getNode(int number)

Specified by:

getNode in interface com.ibm.wala.util.graph.NumberedNodeManager<T extends IBasicBlock<I>>

getNumber

public int getNumber(T N)

Specified by:

getNumber in interface com.ibm.wala.util.graph.NumberedNodeManager<T extends IBasicBlock<I>>

getNumberOfNodes

public int getNumberOfNodes()

Specified by:

getNumberOfNodes in interface com.ibm.wala.util.graph.NodeManager<T extends IBasicBlock<I>>

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface com.ibm.wala.util.graph.NodeManager<T extends IBasicBlock<I>>

Specified by:

iterator in interface java.lang.Iterable<T extends IBasicBlock<I>>

stream

public java.util.stream.Stream<T> stream()

Specified by:

stream in interface com.ibm.wala.util.graph.NodeManager<T extends IBasicBlock<I>>

addEdge

public void addEdge(T src,
                    T dst)
             throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

addEdge in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

removeEdge

public void removeEdge(T src,
                       T dst)
                throws java.lang.UnsupportedOperationException

Specified by:

removeEdge in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

Throws:

java.lang.UnsupportedOperationException

hasEdge

public boolean hasEdge(T src,
                       T dst)

Specified by:

hasEdge in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

hasExceptionalEdge

public boolean hasExceptionalEdge(T src,
                                  T dst)

hasNormalEdge

public boolean hasNormalEdge(T src,
                             T dst)

addNormalEdge

public void addNormalEdge(T src,
                          T dst)

Throws:

java.lang.IllegalArgumentException - if src or dst is null

addExceptionalEdge

public void addExceptionalEdge(T src,
                               T dst)

Throws:

java.lang.IllegalArgumentException - if dst is null

removeNodeAndEdges

public void removeNodeAndEdges(T N)
                        throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

removeNodeAndEdges in interface com.ibm.wala.util.graph.Graph<T extends IBasicBlock<I>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

removeNode

public void removeNode(T n)
                throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

removeNode in interface com.ibm.wala.util.graph.NodeManager<T extends IBasicBlock<I>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

containsNode

public boolean containsNode(T N)

Specified by:

containsNode in interface com.ibm.wala.util.graph.NodeManager<T extends IBasicBlock<I>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setCatchBlock

protected void setCatchBlock(int i)

record that basic block i is a catch block

isCatchBlock

public boolean isCatchBlock(int i)

Returns:

true iff block i is a catch block

getCatchBlocks

public com.ibm.wala.util.intset.BitVector getCatchBlocks()

Returns the catchBlocks.

Specified by:

getCatchBlocks in interface ControlFlowGraph<I,T extends IBasicBlock<I>>

Returns:

the indices of the catch blocks, as a bit vector

getMethod

public IMethod getMethod()

Specified by:

getMethod in interface ControlFlowGraph<I,T extends IBasicBlock<I>>

Returns:

the Method this CFG represents

removeAllIncidentEdges

public void removeAllIncidentEdges(T node)
                            throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

removeAllIncidentEdges in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

getExceptionalSuccessors

public java.util.List<T> getExceptionalSuccessors(T b)

Description copied from interface: MinimalCFG

The order of blocks returned must indicate the exception-handling scope. So the first block is the first candidate catch block, and so on. With this invariant one can compute the exceptional control flow for a given exception type.

Specified by:

getExceptionalSuccessors in interface MinimalCFG<T extends IBasicBlock<I>>

Returns:

the basic blocks which may be reached from b via exceptional control flow

getNormalSuccessors

public java.util.Collection<T> getNormalSuccessors(T b)

Description copied from interface: MinimalCFG

The order of blocks returned should be arbitrary but deterministic.

Specified by:

getNormalSuccessors in interface MinimalCFG<T extends IBasicBlock<I>>

Returns:

the basic blocks which may be reached from b via normal control flow

iterateNodes

public java.util.Iterator<T> iterateNodes(com.ibm.wala.util.intset.IntSet s)

Specified by:

iterateNodes in interface com.ibm.wala.util.graph.NumberedNodeManager<T extends IBasicBlock<I>>

removeIncomingEdges

public void removeIncomingEdges(T node)
                         throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

removeIncomingEdges in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

removeOutgoingEdges

public void removeOutgoingEdges(T node)
                         throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

removeOutgoingEdges in interface com.ibm.wala.util.graph.EdgeManager<T extends IBasicBlock<I>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

getExceptionalToExit

public com.ibm.wala.util.intset.FixedSizeBitVector getExceptionalToExit()

getNormalToExit

public com.ibm.wala.util.intset.FixedSizeBitVector getNormalToExit()

getExceptionalPredecessors

public java.util.Collection<T> getExceptionalPredecessors(T b)

Description copied from interface: MinimalCFG

The order of blocks returned should be arbitrary but deterministic.

Specified by:

getExceptionalPredecessors in interface MinimalCFG<T extends IBasicBlock<I>>

Returns:

the basic blocks from which b may be reached via exceptional control flow

getNormalPredecessors

public java.util.Collection<T> getNormalPredecessors(T b)

Description copied from interface: MinimalCFG

The order of blocks returned should be arbitrary but deterministic.

Specified by:

getNormalPredecessors in interface MinimalCFG<T extends IBasicBlock<I>>

Returns:

the basic blocks from which b may be reached via normal control flow

getPredNodeNumbers

public com.ibm.wala.util.intset.IntSet getPredNodeNumbers(T node)
                                                   throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

getPredNodeNumbers in interface com.ibm.wala.util.graph.NumberedEdgeManager<T extends IBasicBlock<I>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

getSuccNodeNumbers

public com.ibm.wala.util.intset.IntSet getSuccNodeNumbers(T node)

Specified by:

getSuccNodeNumbers in interface com.ibm.wala.util.graph.NumberedEdgeManager<T extends IBasicBlock<I>>