proguard.analysis.cpa.jvm.state.heap.tree

Class JvmTreeHeapAbstractState<StateT extends LatticeAbstractState<StateT>>

java.lang.Object

proguard.analysis.cpa.jvm.state.heap.tree.JvmTreeHeapAbstractState<StateT>

All Implemented Interfaces:

LatticeAbstractState<JvmHeapAbstractState<StateT>>, AbstractState, JvmHeapAbstractState<StateT>

Direct Known Subclasses:

JvmTreeHeapFollowerAbstractState, JvmTreeHeapPrincipalAbstractState

public abstract class JvmTreeHeapAbstractState<StateT extends LatticeAbstractState<StateT>>
extends java.lang.Object
implements JvmHeapAbstractState<StateT>

The tree heap model represents the memory as a map from references to objects or arrays (HeapNodes) which may refer other heap nodes in their fields.

Field Summary

Fields

Modifier and Type	Field and Description
protected StateT	defaultValue
protected MapAbstractStateFactory<Reference,HeapNode<StateT>>	heapMapAbstractStateFactory
protected MapAbstractStateFactory<java.lang.String,StateT>	heapNodeMapAbstractStateFactory
protected MapAbstractState<Reference,HeapNode<StateT>>	referenceToObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JvmTreeHeapAbstractState(MapAbstractState<Reference,HeapNode<StateT>> referenceToObject, MapAbstractStateFactory<Reference,HeapNode<StateT>> heapMapAbstractStateFactory, MapAbstractStateFactory<java.lang.String,StateT> heapNodeMapAbstractStateFactory, StateT defaultValue) Create a tree heap abstract state from a given memory layout.

Method Summary

Modifier and Type	Method and Description
protected void	assignField(SetAbstractState<Reference> object, java.lang.String descriptor, StateT value) Assigns the field value to the given one if the reference is unambiguous, joins otherwise.
boolean	equals(java.lang.Object obj)
void	expand(JvmHeapAbstractState<StateT> otherState) Expands the state with all the entries from another heap state with reference not already known by the state.
protected StateT	getArrayElementOrDefault(SetAbstractState<Reference> array, StateT index, StateT defaultValue) Returns a join over all arrays aliased by the input SetAbstractState.
protected StateT	getField(SetAbstractState<Reference> object, java.lang.String descriptor, StateT defaultValue) Returns a join over all fields aliased by the input SetAbstractState.
HeapNode<StateT>	getHeapNode(Reference reference) Returns the heap node for the given reference.
int	hashCode()
boolean	isLessOrEqual(JvmHeapAbstractState<StateT> abstractState) Compares itself to the abstractState.
protected void	mergeField(SetAbstractState<Reference> object, java.lang.String descriptor, StateT value) Merges the field value to the given one.
protected void	setArrayElement(SetAbstractState<Reference> array, StateT index, StateT value) Joins the array elements with the given one for all aliases.
protected void	setField(SetAbstractState<Reference> object, java.lang.String descriptor, StateT value) Replaces the field value with the given one.

Methods inherited from class java.lang.Object

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

Methods inherited from interface proguard.analysis.cpa.jvm.state.heap.JvmHeapAbstractState

copy, getArrayElementOrDefault, getFieldOrDefault, newArray, newObject, newObject, reduce, setArrayElement, setField

Methods inherited from interface proguard.analysis.cpa.defaults.LatticeAbstractState

isLess, join

Methods inherited from interface proguard.analysis.cpa.interfaces.AbstractState

getPrecision, getStateByName

Field Detail

referenceToObject

protected final MapAbstractState<Reference,HeapNode<StateT extends LatticeAbstractState<StateT>>> referenceToObject

heapNodeMapAbstractStateFactory

protected final MapAbstractStateFactory<java.lang.String,StateT extends LatticeAbstractState<StateT>> heapNodeMapAbstractStateFactory

heapMapAbstractStateFactory

protected final MapAbstractStateFactory<Reference,HeapNode<StateT extends LatticeAbstractState<StateT>>> heapMapAbstractStateFactory

defaultValue

protected final StateT extends LatticeAbstractState<StateT> defaultValue

Constructor Detail

JvmTreeHeapAbstractState

protected JvmTreeHeapAbstractState(MapAbstractState<Reference,HeapNode<StateT>> referenceToObject,
                                   MapAbstractStateFactory<Reference,HeapNode<StateT>> heapMapAbstractStateFactory,
                                   MapAbstractStateFactory<java.lang.String,StateT> heapNodeMapAbstractStateFactory,
                                   StateT defaultValue)

Create a tree heap abstract state from a given memory layout.

Parameters:

referenceToObject - a mapping from references to their objects/arrays

heapMapAbstractStateFactory - a map abstract state factory used for constructing the mapping from references to objects

heapNodeMapAbstractStateFactory - a map abstract state factory used for constructing the mapping from fields to values

defaultValue - a default value for undefined fields

Method Detail

getField

protected StateT getField(SetAbstractState<Reference> object,
                          java.lang.String descriptor,
                          StateT defaultValue)

Returns a join over all fields aliased by the input SetAbstractState. The defaultValue is used when there is no information available.

assignField

protected void assignField(SetAbstractState<Reference> object,
                           java.lang.String descriptor,
                           StateT value)

Assigns the field value to the given one if the reference is unambiguous, joins otherwise.

mergeField

protected void mergeField(SetAbstractState<Reference> object,
                          java.lang.String descriptor,
                          StateT value)

Merges the field value to the given one.

setField

protected void setField(SetAbstractState<Reference> object,
                        java.lang.String descriptor,
                        StateT value)

Replaces the field value with the given one.

getArrayElementOrDefault

protected StateT getArrayElementOrDefault(SetAbstractState<Reference> array,
                                          StateT index,
                                          StateT defaultValue)

Returns a join over all arrays aliased by the input SetAbstractState. The defaultValue is used when there is no information available.

setArrayElement

protected void setArrayElement(SetAbstractState<Reference> array,
                               StateT index,
                               StateT value)

Joins the array elements with the given one for all aliases.

getHeapNode

public HeapNode<StateT> getHeapNode(Reference reference)

Returns the heap node for the given reference.

expand

public void expand(JvmHeapAbstractState<StateT> otherState)

Expands the state with all the entries from another heap state with reference not already known by the state.

Specified by:

expand in interface JvmHeapAbstractState<StateT extends LatticeAbstractState<StateT>>

Parameters:

otherState - a heap state from which expanding the heap (e.g. the state calling a method to recover information discarded from it)

isLessOrEqual

public boolean isLessOrEqual(JvmHeapAbstractState<StateT> abstractState)

Description copied from interface: LatticeAbstractState

Compares itself to the abstractState.

Specified by:

isLessOrEqual in interface LatticeAbstractState<JvmHeapAbstractState<StateT extends LatticeAbstractState<StateT>>>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface AbstractState

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface AbstractState

Overrides:

hashCode in class java.lang.Object