de.rwth.i2.attestor.programState

Class GeneralProgramState

java.lang.Object

de.rwth.i2.attestor.programState.GeneralProgramState

All Implemented Interfaces:

LabelledProgramState, ProgramState, State, Cloneable

Direct Known Subclasses:

DefaultProgramState, IndexedState

public abstract class GeneralProgramState
extends Object
implements ProgramState

A general implementation of program states that comprises most functionality when analyzing Jimple programs.

Author:

Christoph

Field Summary

Fields

Modifier and Type	Field and Description
protected HeapConfiguration	heap The heap configuration that determines the shape of the heap and the assignment of program variables underlying this program state.
protected int	programCounter The program location corresponding to this program state.

Fields inherited from interface de.rwth.i2.attestor.stateSpaceGeneration.State

INVALID_STATE_SPACE_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GeneralProgramState(GeneralProgramState state) Creates a shallow copy of a program state.
protected	GeneralProgramState(HeapConfiguration heap) Initializes a state with the initial program location 0.

Method Summary

Modifier and Type	Method and Description
void	addAP(String ap) Adds an atomic proposition.
abstract GeneralProgramState	clone()
void	flagAsContinueState()
Set<String>	getAPs()
GeneralConcreteValue	getConstant(String constantName) Gets the requested constant
StateSpace	getContainingStateSpace()
HeapConfiguration	getHeap()
protected abstract SelectorLabel	getNewSelector(SelectorLabel oldSelectorLabel)
int	getProgramCounter()
GeneralConcreteValue	getSelectorTarget(ConcreteValue from, SelectorLabel selectorLabel) Gets the target of the given selector starting at a given object on the heap.
protected abstract int	getSelectorTargetOf(int sourceNode, SelectorLabel selectorLabel)
int	getStateSpaceId()
GeneralConcreteValue	getUndefined() Gets an undefined value.
GeneralConcreteValue	getVariableTarget(String variableName) Gets the target of the variable in the current scopes.
int	hashCode()
GeneralConcreteValue	insertNewElement(Type type) Adds a new element on the heap to the executable and returns it.
boolean	isContinueState() determines whether this state is just about to be continued (partial state space) This is a necessary information to merge duplicate applications of previously known contracts
boolean	isFromTopLevelStateSpace() determines whether this state is part of the top level statespace (and not of the state space of a method call)
ProgramState	prepareHeap() Adds all required constants if not yet present, converts variables from the semantics format to the format used inside the heap, etc.
GeneralConcreteValue	removeIntermediate(String name) Intermediates are internally equal to variables.
protected abstract void	removeSelector(int sourceNode, SelectorLabel selectorLabel)
void	removeVariable(String variableName) Removes the variable (in the current scopes) from the executable.
boolean	satisfiesAP(String ap) Checks whether this object satisfies an atomic proposition.
void	setContainingStateSpace(StateSpace containingStateSpace)
void	setIntermediate(String name, ConcreteValue value) Intermediates are internally equal to variables.
void	setProgramCounter(int pc)
void	setSelector(ConcreteValue from, SelectorLabel selectorLabel, ConcreteValue to) (Re)sets the given selector starting at the given object on the heap to a (new) target.
void	setStateSpaceId(int id)
void	setVariable(String variableName, ConcreteValue value) Sets the variable of the given name to the given value.
ProgramState	shallowCopyWithUpdateHeap(HeapConfiguration newHeap) Creates a shallow copy in which the underlying heap is set to newHeap without creating a copy first.
int	size()
String	toString() Creates a human readable string representation for debugging purposes.
void	unflagContinueState()

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.rwth.i2.attestor.stateSpaceGeneration.ProgramState

shallowCopy, shallowCopyUpdatePC

Field Detail

heap

protected HeapConfiguration heap

The heap configuration that determines the shape of the heap and the assignment of program variables underlying this program state.

programCounter

protected int programCounter

The program location corresponding to this program state.

Constructor Detail

GeneralProgramState

protected GeneralProgramState(HeapConfiguration heap)

Initializes a state with the initial program location 0.

Parameters:

heap - The initial heap configuration.

GeneralProgramState

protected GeneralProgramState(GeneralProgramState state)

Creates a shallow copy of a program state.

Parameters:

state - The state that should be copied.

Method Detail

clone

public abstract GeneralProgramState clone()

Specified by:

clone in interface ProgramState

Overrides:

clone in class Object

Returns:

A deep copy of this program state.

toString

public String toString()

Creates a human readable string representation for debugging purposes.

Overrides:

toString in class Object

Returns:

A string representation of this program state.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

A hash code corresponding to this state.

size

public int size()

Specified by:

size in interface ProgramState

Specified by:

size in interface State

Returns:

The size of this program state, i.e. the number of nodes of the underlying heap configuration.

getProgramCounter

public int getProgramCounter()

Specified by:

getProgramCounter in interface ProgramState

Returns:

The program location of this state.

setProgramCounter

public void setProgramCounter(int pc)

Specified by:

setProgramCounter in interface ProgramState

Parameters:

pc - The program location assigned to this state.

getHeap

public HeapConfiguration getHeap()

Specified by:

getHeap in interface ProgramState

Returns:

The heap configuration determining the heap and the evaluation of variables for this program state.

prepareHeap

public ProgramState prepareHeap()

Description copied from interface: ProgramState

Adds all required constants if not yet present, converts variables from the semantics format to the format used inside the heap, etc.

Specified by:

prepareHeap in interface ProgramState

Returns:

The program state with the required constants.

getVariableTarget

public GeneralConcreteValue getVariableTarget(String variableName)

Description copied from interface: ProgramState

Gets the target of the variable in the current scopes.

Specified by:

getVariableTarget in interface ProgramState

Parameters:

variableName - The name of the requested variable

Returns:

The referenced element on the heap.

removeVariable

public void removeVariable(String variableName)

Description copied from interface: ProgramState

Removes the variable (in the current scopes) from the executable.

Specified by:

removeVariable in interface ProgramState

Parameters:

variableName - The name of the variable to remove.

setVariable

public void setVariable(String variableName,
                        ConcreteValue value)

Description copied from interface: ProgramState

Sets the variable of the given name to the given value. Resets the variable if it has been there previously.

Specified by:

setVariable in interface ProgramState

Parameters:

variableName - the name of the variable

value - the value (i.e. node) to which the variable should be set

getConstant

public GeneralConcreteValue getConstant(String constantName)

Description copied from interface: ProgramState

Gets the requested constant

Specified by:

getConstant in interface ProgramState

Parameters:

constantName - The name of the requested constant.

Returns:

The element in the heap that is referenced by the constant.

removeIntermediate

public GeneralConcreteValue removeIntermediate(String name)

Intermediates are internally equal to variables.
Name clashes do not happen since they start with an '@' while variables have to start with a letter.

Specified by:

removeIntermediate in interface ProgramState

Parameters:

name - The name of the intermediate

Returns:

The ConcreteValue that is referenced by the intermediate.

setIntermediate

public void setIntermediate(String name,
                            ConcreteValue value)

Intermediates are internally equal to variables.
Name clashes do not happen since they start with an '@' while variables have to start with a letter.

Specified by:

setIntermediate in interface ProgramState

Parameters:

name - The name of the intermediate .

value - The ConcreteValue that will should be referenced by the intermediate.

insertNewElement

public GeneralConcreteValue insertNewElement(Type type)

Description copied from interface: ProgramState

Adds a new element on the heap to the executable and returns it.

Specified by:

insertNewElement in interface ProgramState

Parameters:

type - The type of the new element.

Returns:

The added element.

getSelectorTarget

public GeneralConcreteValue getSelectorTarget(ConcreteValue from,
                                              SelectorLabel selectorLabel)

Description copied from interface: ProgramState

Gets the target of the given selector starting at a given object on the heap.

Specified by:

getSelectorTarget in interface ProgramState

Parameters:

from - The element on the heap whose selectors should be considered.

selectorLabel - The label of the selector.

Returns:

The element on the heap that is the target of the selector.

getSelectorTargetOf

protected abstract int getSelectorTargetOf(int sourceNode,
                                           SelectorLabel selectorLabel)

setSelector

public void setSelector(ConcreteValue from,
                        SelectorLabel selectorLabel,
                        ConcreteValue to)

Description copied from interface: ProgramState

(Re)sets the given selector starting at the given object on the heap to a (new) target.

Specified by:

setSelector in interface ProgramState

Parameters:

from - The element on the heap whose selectors should be considered.

selectorLabel - The label of the selector.

to - The element on the heap that should be the target of the selector.

removeSelector

protected abstract void removeSelector(int sourceNode,
                                       SelectorLabel selectorLabel)

getNewSelector

protected abstract SelectorLabel getNewSelector(SelectorLabel oldSelectorLabel)

getUndefined

public GeneralConcreteValue getUndefined()

Description copied from interface: ProgramState

Gets an undefined value.

Specified by:

getUndefined in interface ProgramState

Returns:

The concrete value that stands for undefined.

shallowCopyWithUpdateHeap

public ProgramState shallowCopyWithUpdateHeap(HeapConfiguration newHeap)

Description copied from interface: ProgramState

Creates a shallow copy in which the underlying heap is set to newHeap without creating a copy first.

Specified by:

shallowCopyWithUpdateHeap in interface ProgramState

Parameters:

newHeap - The heap underlying the copy.

Returns:

A shallow copy with a reference to newHeap as underlying heap.

satisfiesAP

public boolean satisfiesAP(String ap)

Description copied from interface: LabelledProgramState

Checks whether this object satisfies an atomic proposition.

Specified by:

satisfiesAP in interface LabelledProgramState

Returns:

true, if the proposition holds, i.e. is contained in the label of the state false, otherwise

addAP

public void addAP(String ap)

Description copied from interface: LabelledProgramState

Adds an atomic proposition.

Specified by:

addAP in interface LabelledProgramState

Parameters:

ap - The atomic proposition to add.

getAPs

public Set<String> getAPs()

Specified by:

getAPs in interface LabelledProgramState

Returns:

The set of all atomic propositions attached to this object.

getStateSpaceId

public int getStateSpaceId()

Specified by:

getStateSpaceId in interface State

setStateSpaceId

public void setStateSpaceId(int id)

Specified by:

setStateSpaceId in interface State

isFromTopLevelStateSpace

public boolean isFromTopLevelStateSpace()

Description copied from interface: ProgramState

determines whether this state is part of the top level statespace (and not of the state space of a method call)

Specified by:

isFromTopLevelStateSpace in interface ProgramState

Returns:

true if and only if the state is from the top level

getContainingStateSpace

public StateSpace getContainingStateSpace()

Specified by:

getContainingStateSpace in interface ProgramState

setContainingStateSpace

public void setContainingStateSpace(StateSpace containingStateSpace)

Specified by:

setContainingStateSpace in interface ProgramState

isContinueState

public boolean isContinueState()

Description copied from interface: ProgramState

determines whether this state is just about to be continued (partial state space) This is a necessary information to merge duplicate applications of previously known contracts

Specified by:

isContinueState in interface ProgramState

Returns:

true when the state is flagged set accordingly

flagAsContinueState

public void flagAsContinueState()

Specified by:

flagAsContinueState in interface ProgramState

unflagContinueState

public void unflagContinueState()

Specified by:

unflagContinueState in interface ProgramState