Package com.pnfsoftware.jeb.core.units.code.android.controlflow

Class BasicBlock<InsnType extends ILocatedInstruction>

java.lang.Object

com.pnfsoftware.jeb.core.units.code.android.controlflow.BasicBlock<InsnType>

Type Parameters:

InsnType - located instruction type

All Implemented Interfaces:

IBasicBlock<InsnType>, Iterable<InsnType>

@Ser
public class BasicBlock<InsnType extends ILocatedInstruction>
extends Object
implements IBasicBlock<InsnType>

This class represents a basic block of generic instructions.

See Also:

• CFG

Constructor Summary

Constructors

Constructor	Description
BasicBlock()	Create a new empty basic block.
BasicBlock(Collection<InsnType> insnlist)	Create a new basic block with the provided instructions.

Method Summary

Modifier and Type	Method	Description
void	add(int index, InsnType insn)	DANGEROUS! Add an instruction to the block.
void	add(InsnType insn)	DANGEROUS! Append an instruction to the block.
void	addAll(Collection<InsnType> insnlist)	DANGEROUS! Append instructions to the block.
int	allinsize()	Get the total number of input edges to this block.
int	alloutsize()	Get the total number of output edges from this block.
boolean	canThrow()	Determine whether this block can throw an exception.
InsnType	get(int index)	Get the instruction at the specified index.
long	getAddress()	Get the block address.
long	getAddressOfInstruction(int index)	Get the address of an instruction by index.
List<BasicBlock<InsnType>>	getAllInputBlocks()	Get regular and irregular input blocks.
Iterable<BasicBlock<InsnType>>	getAllInputs()	Retrieve a read-only iterable of regular and irregular input blocks.
List<BasicBlock<InsnType>>	getAllOutputBlocks()	Get regular and irregular output blocks.
Iterable<BasicBlock<InsnType>>	getAllOutputs()	Retrieve a read-only iterable of regular and irregular output blocks.
long	getBase()	Address of first instruction in the block.
long	getEndAddress()	Address following the last instruction of the block (ie, last exclusive address).
long	getFirstAddress()	Address of first instruction in the block.
int	getIndexOfInstruction(long address)	Get the index of an instruction by address.
int	getIndexOfInstruction(long address, boolean precise)	Get the index of an instruction by address.
BasicBlock<InsnType>	getInputBlock(int index)	Get a regular input block.
List<BasicBlock<InsnType>>	getInputBlocks()	Get the regular input blocks.
List<Long>	getInputOffsets()	Get the addresses of regular input blocks.
List<BasicBlock<InsnType>>	getInputs()	Retrieve a read-only list of input blocks (regular).
InsnType	getInstruction(long address)	Get the instruction located at the exact address.
List<InsnType>	getInstructions()	Get a copy of the list of instructions that make up this basic block.
BasicBlock<InsnType>	getIrregularInputBlock(int index)	Get an irregular input block.
List<BasicBlock<InsnType>>	getIrregularInputBlocks()	Get irregular input blocks.
List<Long>	getIrregularInputOffsets()	Get the addresses of irregular input blocks.
List<BasicBlock<InsnType>>	getIrregularInputs()	Retrieve a read-only list of irregular input blocks.
BasicBlock<InsnType>	getIrregularOutputBlock(int index)	Get an irregular output block.
List<BasicBlock<InsnType>>	getIrregularOutputBlocks()	Get irregular output blocks.
List<Long>	getIrregularOutputOffsets()	Get the addresses of irregular output blocks.
List<BasicBlock<InsnType>>	getIrregularOutputs()	Retrieve a read-only list of irregular output blocks.
InsnType	getLast()	Get the last instruction of the block.
long	getLastAddress()	Address of last instruction in the block.
BasicBlock<InsnType>	getOutputBlock(int index)	Get a regular output block.
List<BasicBlock<InsnType>>	getOutputBlocks()	Get the regular output blocks.
List<Long>	getOutputOffsets()	Get the addresses of regular output blocks.
List<BasicBlock<InsnType>>	getOutputs()	Retrieve a read-only list of output blocks (regular).
int	getSizeOfInstructions()	Get the total size of instructions in the block.
int	insize()	Get the number of regular input edges to this block.
int	irrinsize()	Get the number of irregular input edges to this block.
int	irroutsize()	Get the number of irregular output edges from this block.
boolean	isEmpty()	Determine if the block has 0 instruction.
Iterator<InsnType>	iterator()
int	outsize()	Get the number of regular output edges from this block.
InsnType	remove(int index)	DANGEROUS! Remove an instruction from the block.
void	removeAll()	DANGEROUS! Remove all instructions from the block.
InsnType	set(int index, InsnType insn)	Replace an instruction.
InsnType	set(int index, InsnType insn, boolean verifySize, boolean verifyOffset)	Replace an instruction.
int	size()	Get the number of instructions in the block.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

BasicBlock

public BasicBlock()

Create a new empty basic block.

BasicBlock

public BasicBlock(Collection<InsnType> insnlist)

Create a new basic block with the provided instructions.

Parameters:

insnlist - instructions to add to the block

Method Details

size

public int size()

Description copied from interface: IBasicBlock

Get the number of instructions in the block.

Specified by:

size in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

instruction count

isEmpty

public boolean isEmpty()

Description copied from interface: IBasicBlock

Determine if the block has 0 instruction.

Specified by:

isEmpty in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

true if the block has no instruction

get

public InsnType get(int index)

Description copied from interface: IBasicBlock

Get the instruction at the specified index.

Specified by:

get in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

index - instruction index

Returns:

instruction

getLast

public InsnType getLast()

Description copied from interface: IBasicBlock

Get the last instruction of the block.

Specified by:

getLast in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

last instruction

getInstructions

public List<InsnType> getInstructions()

Description copied from interface: IBasicBlock

Get a copy of the list of instructions that make up this basic block.

Specified by:

getInstructions in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

instruction list

getSizeOfInstructions

public int getSizeOfInstructions()

Description copied from interface: IBasicBlock

Get the total size of instructions in the block.

Specified by:

getSizeOfInstructions in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

instruction size

getBase

public long getBase()

Description copied from interface: IBasicBlock

Address of first instruction in the block.

Specified by:

getBase in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

first instruction address

getAddress

public long getAddress()

Get the block address.

Returns:

the first instruction address

getFirstAddress

public long getFirstAddress()

Description copied from interface: IBasicBlock

Address of first instruction in the block.

Specified by:

getFirstAddress in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

first instruction address

getLastAddress

public long getLastAddress()

Description copied from interface: IBasicBlock

Address of last instruction in the block.

Specified by:

getLastAddress in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

last instruction address

getEndAddress

public long getEndAddress()

Description copied from interface: IBasicBlock

Address following the last instruction of the block (ie, last exclusive address).

Specified by:

getEndAddress in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

end address

getAddressOfInstruction

public long getAddressOfInstruction(int index)

Description copied from interface: IBasicBlock

Get the address of an instruction by index.

Specified by:

getAddressOfInstruction in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

index - instruction index

Returns:

instruction address

getIndexOfInstruction

public int getIndexOfInstruction(long address)

Description copied from interface: IBasicBlock

Get the index of an instruction by address.

Specified by:

getIndexOfInstruction in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

address - instruction address

Returns:

-1 if there is no instruction starting at the provided address

getIndexOfInstruction

public int getIndexOfInstruction(long address,
 boolean precise)

Get the index of an instruction by address.

Parameters:

address - instruction address

precise - if true, the address must match the instruction start; otherwise, any address within the instruction is accepted

Returns:

the instruction index, or -1 if none was found

getInstruction

public InsnType getInstruction(long address)

Description copied from interface: IBasicBlock

Get the instruction located at the exact address.

Specified by:

getInstruction in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

address - instruction address

Returns:

instruction, or null

canThrow

public boolean canThrow()

Description copied from interface: IBasicBlock

Determine whether this block can throw an exception.

Specified by:

canThrow in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

true if the block can throw

remove

public InsnType remove(int index)

DANGEROUS! Remove an instruction from the block.

The instruction is removed from the block. The edges are not updated. The block may end up empty.

Parameters:

index - instruction index

Returns:

true if the CFG need refreshing

removeAll

public void removeAll()

DANGEROUS! Remove all instructions from the block.

The edges are not updated. The block may end up empty.

add

public void add(InsnType insn)

DANGEROUS! Append an instruction to the block.

The instruction is appended to the block. The edges are not updated.
The caller is responsible for maintaining the consistency of the block and of the CFG.

Parameters:

insn - the instruction to be appended

addAll

public void addAll(Collection<InsnType> insnlist)

DANGEROUS! Append instructions to the block.

The instructions are appended to the block. The edges are not updated.
The caller is responsible for maintaining the consistency of the block and of the CFG.

Parameters:

insnlist - the collection of instructions to be appended

add

public void add(int index,
 InsnType insn)

DANGEROUS! Add an instruction to the block.

The instruction is inserted in the block. The edges are not updated.
The caller is responsible for maintaining the consistency of the block and of the CFG.

Parameters:

index - insertion index

insn - the instruction to be inserted

set

public InsnType set(int index,
 InsnType insn)

Replace an instruction. The size is validated, the offset is not validated.

Parameters:

index - index in the block

insn - instruction to set at index

Returns:

the instruction that was replaced

set

public InsnType set(int index,
 InsnType insn,
 boolean verifySize,
 boolean verifyOffset)

Replace an instruction. The size and offset may be validated.

Parameters:

index - index in the block

insn - instruction to set at index

verifySize - if false, validating and updating the instruction size is the responsibility of the caller; else, the size is validated and must match the replaced instruction's

verifyOffset - if false, validating and updating the instruction offset is the responsibility of the caller; else, the offset is validated and must match the replaced instruction's

Returns:

the instruction that was replaced

insize

public int insize()

Description copied from interface: IBasicBlock

Get the number of regular input edges to this block.

Specified by:

insize in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

regular input edge count

irrinsize

public int irrinsize()

Description copied from interface: IBasicBlock

Get the number of irregular input edges to this block.

Specified by:

irrinsize in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

irregular input edge count

allinsize

public int allinsize()

Description copied from interface: IBasicBlock

Get the total number of input edges to this block.

Specified by:

allinsize in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

input edge count

getInputBlock

public BasicBlock<InsnType> getInputBlock(int index)

Description copied from interface: IBasicBlock

Get a regular input block.

Specified by:

getInputBlock in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

index - block index

Returns:

a block

getInputBlocks

public List<BasicBlock<InsnType>> getInputBlocks()

Description copied from interface: IBasicBlock

Get the regular input blocks.

Specified by:

getInputBlocks in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

a copy of the list of regular input blocks

getInputOffsets

public List<Long> getInputOffsets()

Get the addresses of regular input blocks.

Returns:

a list of input block addresses

getIrregularInputBlock

public BasicBlock<InsnType> getIrregularInputBlock(int index)

Description copied from interface: IBasicBlock

Get an irregular input block.

Specified by:

getIrregularInputBlock in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

index - block index

Returns:

a block

getIrregularInputBlocks

public List<BasicBlock<InsnType>> getIrregularInputBlocks()

Description copied from interface: IBasicBlock

Get irregular input blocks.

Specified by:

getIrregularInputBlocks in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

a copy of the list of irregular input blocks

getIrregularInputOffsets

public List<Long> getIrregularInputOffsets()

Get the addresses of irregular input blocks.

Returns:

a list of irregular input block addresses

getAllInputBlocks

public List<BasicBlock<InsnType>> getAllInputBlocks()

Description copied from interface: IBasicBlock

Get regular and irregular input blocks.

Specified by:

getAllInputBlocks in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

a copy of the list of all input blocks

outsize

public int outsize()

Description copied from interface: IBasicBlock

Get the number of regular output edges from this block.

Specified by:

outsize in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

regular output edge count

irroutsize

public int irroutsize()

Description copied from interface: IBasicBlock

Get the number of irregular output edges from this block.

Specified by:

irroutsize in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

irregular output edge count

alloutsize

public int alloutsize()

Description copied from interface: IBasicBlock

Get the total number of output edges from this block.

Specified by:

alloutsize in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

output edge count

getOutputBlock

public BasicBlock<InsnType> getOutputBlock(int index)

Description copied from interface: IBasicBlock

Get a regular output block.

Specified by:

getOutputBlock in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

index - block index

Returns:

output block

getOutputBlocks

public List<BasicBlock<InsnType>> getOutputBlocks()

Description copied from interface: IBasicBlock

Get the regular output blocks.

Specified by:

getOutputBlocks in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

a copy of the list of regular output blocks

getOutputOffsets

public List<Long> getOutputOffsets()

Get the addresses of regular output blocks.

Returns:

a list of output block addresses

getIrregularOutputBlock

public BasicBlock<InsnType> getIrregularOutputBlock(int index)

Description copied from interface: IBasicBlock

Get an irregular output block.

Specified by:

getIrregularOutputBlock in interface IBasicBlock<InsnType extends ILocatedInstruction>

Parameters:

index - block index

Returns:

irregular output block

getIrregularOutputBlocks

public List<BasicBlock<InsnType>> getIrregularOutputBlocks()

Description copied from interface: IBasicBlock

Get irregular output blocks.

Specified by:

getIrregularOutputBlocks in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

a copy of the list of irregular output blocks

getIrregularOutputOffsets

public List<Long> getIrregularOutputOffsets()

Get the addresses of irregular output blocks.

Returns:

a list of irregular output block addresses

getAllOutputBlocks

public List<BasicBlock<InsnType>> getAllOutputBlocks()

Description copied from interface: IBasicBlock

Get regular and irregular output blocks.

Specified by:

getAllOutputBlocks in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

a copy of the list of all output blocks

getInputs

public List<BasicBlock<InsnType>> getInputs()

Retrieve a read-only list of input blocks (regular).

NOTE: This method is faster than getInputBlocks() since it does not provide a copy of the list.

Specified by:

getInputs in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

an unmodifiable view of regular input blocks

getIrregularInputs

public List<BasicBlock<InsnType>> getIrregularInputs()

Retrieve a read-only list of irregular input blocks.

NOTE: This method is faster than getIrregularInputBlocks() since it does not provide a copy of the list.

Specified by:

getIrregularInputs in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

an unmodifiable view of irregular input blocks

getOutputs

public List<BasicBlock<InsnType>> getOutputs()

Retrieve a read-only list of output blocks (regular).

NOTE: This method is faster than getOutputBlocks() since it does not provide a copy of the list.

Specified by:

getOutputs in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

an unmodifiable view of regular output blocks

getIrregularOutputs

public List<BasicBlock<InsnType>> getIrregularOutputs()

Retrieve a read-only list of irregular output blocks.

NOTE: This method is faster than getIrregularOutputBlocks() since it does not provide a copy of the list.

Specified by:

getIrregularOutputs in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

an unmodifiable view of irregular output blocks

getAllInputs

public Iterable<BasicBlock<InsnType>> getAllInputs()

Description copied from interface: IBasicBlock

Retrieve a read-only iterable of regular and irregular input blocks.

NOTE: This method is faster than IBasicBlock.getAllInputBlocks() since it does not provide a copy of the list.

Specified by:

getAllInputs in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

all input blocks view

getAllOutputs

public Iterable<BasicBlock<InsnType>> getAllOutputs()

Description copied from interface: IBasicBlock

Retrieve a read-only iterable of regular and irregular output blocks.

NOTE: This method is faster than IBasicBlock.getAllOutputBlocks() since it does not provide a copy of the list.

Specified by:

getAllOutputs in interface IBasicBlock<InsnType extends ILocatedInstruction>

Returns:

all output blocks view

iterator

public Iterator<InsnType> iterator()

Specified by:

iterator in interface Iterable<InsnType extends ILocatedInstruction>

toString

public String toString()

Overrides:

toString in class Object