de.rwth.i2.attestor.stateSpaceGeneration

Interface ProgramState

All Superinterfaces:

Cloneable, LabelledProgramState, State

All Known Implementing Classes:

DefaultProgramState, GeneralProgramState, IndexedState

public interface ProgramState
extends Cloneable, LabelledProgramState, State

An abstraction of a single state in a StateSpace. This comprises information about the current program location, that is the value of the program counter, of the state and the program's heap.

Author:

Christoph, Hannah

Field Summary

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

INVALID_STATE_SPACE_ID

Method Summary

Modifier and Type	Method and Description
ProgramState	clone()
void	flagAsContinueState()
ConcreteValue	getConstant(String constantName) Gets the requested constant
StateSpace	getContainingStateSpace()
HeapConfiguration	getHeap()
int	getProgramCounter()
ConcreteValue	getSelectorTarget(ConcreteValue from, SelectorLabel selectorLabel) Gets the target of the given selector starting at a given object on the heap.
ConcreteValue	getUndefined() Gets an undefined value.
ConcreteValue	getVariableTarget(String variableName) Gets the target of the variable in the current scopes.
ConcreteValue	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.
ConcreteValue	removeIntermediate(String name) Removes an intermediate (in the current scopes) from the executable.
void	removeVariable(String variableName) Removes the variable (in the current scopes) from the executable.
void	setContainingStateSpace(StateSpace containingStateSpace)
void	setIntermediate(String name, ConcreteValue value) Sets an intermediate to the given value.
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	setVariable(String variableName, ConcreteValue value) Sets the variable of the given name to the given value.
ProgramState	shallowCopy() Creates a shallow copy of this program state in which the underlying heap configuration is the same as in the copied object.
ProgramState	shallowCopyUpdatePC(int newPC) Creates a shallow copy of this program state in which the underlying heap configuration is the same as in the copied object.
ProgramState	shallowCopyWithUpdateHeap(HeapConfiguration newHeap) Creates a shallow copy in which the underlying heap is set to newHeap without creating a copy first.
int	size()
void	unflagContinueState()

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

addAP, getAPs, satisfiesAP

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

getStateSpaceId, setStateSpaceId

Method Detail

getProgramCounter

int getProgramCounter()

Returns:

The program location of this state.

setProgramCounter

void setProgramCounter(int pc)

Parameters:

pc - The program location assigned to this state.

prepareHeap

ProgramState prepareHeap()

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

Returns:

The program state with the required constants.

getHeap

HeapConfiguration getHeap()

Returns:

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

size

int size()

Specified by:

size in interface State

Returns:

The size of the heap configuration corresponding to this program state.

getVariableTarget

ConcreteValue getVariableTarget(String variableName)

Gets the target of the variable in the current scopes.

Parameters:

variableName - The name of the requested variable

Returns:

The referenced element on the heap.

removeVariable

void removeVariable(String variableName)

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

Parameters:

variableName - The name of the variable to remove.

setVariable

void setVariable(String variableName,
                 ConcreteValue value)

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

Parameters:

variableName - the name of the variable

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

getConstant

ConcreteValue getConstant(String constantName)

Gets the requested constant

Parameters:

constantName - The name of the requested constant.

Returns:

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

removeIntermediate

ConcreteValue removeIntermediate(String name)

Removes an intermediate (in the current scopes) from the executable. Intermediates are internal variables for communication between methodExecution, such that this, return, param_n, etc.

Parameters:

name - The name of the intermediate

Returns:

The ConcreteValue that is referenced by the intermediate.

setIntermediate

void setIntermediate(String name,
                     ConcreteValue value)

Sets an intermediate to the given value. Intermediates are internal variables for communication between methodExecution, such that this, return, param_n, etc.

Parameters:

name - The name of the intermediate .

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

getSelectorTarget

ConcreteValue getSelectorTarget(ConcreteValue from,
                                SelectorLabel selectorLabel)

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

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.

setSelector

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.

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.

insertNewElement

ConcreteValue insertNewElement(Type type)

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

Parameters:

type - The type of the new element.

Returns:

The added element.

getUndefined

ConcreteValue getUndefined()

Gets an undefined value.

Returns:

The concrete value that stands for undefined.

shallowCopy

ProgramState shallowCopy()

Creates a shallow copy of this program state in which the underlying heap configuration is the same as in the copied object.

Returns:

A shallow copy of this program state.

shallowCopyWithUpdateHeap

ProgramState shallowCopyWithUpdateHeap(HeapConfiguration newHeap)

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

Parameters:

newHeap - The heap underlying the copy.

Returns:

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

shallowCopyUpdatePC

ProgramState shallowCopyUpdatePC(int newPC)

Creates a shallow copy of this program state in which the underlying heap configuration is the same as in the copied object. The program counter of the copy is set to the provided new program counter value.

Parameters:

newPC - The value of the program counter of the copy.

Returns:

A shallow copy of this program state with the given program counter.

clone

ProgramState clone()

isFromTopLevelStateSpace

boolean isFromTopLevelStateSpace()

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

Returns:

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

getContainingStateSpace

StateSpace getContainingStateSpace()

setContainingStateSpace

void setContainingStateSpace(StateSpace containingStateSpace)

isContinueState

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

Returns:

true when the state is flagged set accordingly

flagAsContinueState

void flagAsContinueState()

unflagContinueState

void unflagContinueState()