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

Class JvmShallowHeapAbstractState<ReferenceT,StateT extends AbstractState<StateT>>

java.lang.Object

proguard.analysis.cpa.jvm.state.heap.tree.JvmShallowHeapAbstractState<ReferenceT,StateT>

All Implemented Interfaces:

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

public class JvmShallowHeapAbstractState<ReferenceT,StateT extends AbstractState<StateT>>
extends java.lang.Object
implements JvmHeapAbstractState<StateT>

A shallow heap models objects as atomic abstract states thus having only one level of depth. Object fields are not modeled. References of wrong types are ignored.

Field Summary

Fields

Modifier and Type	Field	Description
protected StateT	defaultValue
protected java.lang.Class<ReferenceT>	referenceClass
MapAbstractState<ReferenceT,StateT>	referenceToObject

Constructor Summary

Constructors

Constructor	Description
JvmShallowHeapAbstractState(MapAbstractState<ReferenceT,StateT> referenceToObject, java.lang.Class<ReferenceT> referenceClass, StateT defaultValue)	Create a shallow heap abstract state returning the specified value for all queries from an existing reference to abstract state map.

Method Summary

Modifier and Type	Method	Description
JvmShallowHeapAbstractState<ReferenceT,StateT>	copy()	Creates a copy of itself.
boolean	equals(java.lang.Object o)
void	expand(JvmHeapAbstractState<StateT> otherState)	Expands the state with all the entries from another heap state with reference not already known by the state.
<T> StateT	getArrayElementOrDefault(T array, StateT index, StateT defaultValue)	Returns an array element at the specified index or the defaultValue, if the element is unset.
<T> StateT	getFieldOrDefault(T object, java.lang.String fqn, StateT defaultValue)	Returns a field fqn from a reference object.
int	hashCode()
boolean	isLessOrEqual(JvmHeapAbstractState<StateT> abstractState)	Compares itself to the abstractState (i.e., compare the states on the partial order provided by the domain of the analysis).
JvmShallowHeapAbstractState<ReferenceT,StateT>	join(JvmHeapAbstractState<StateT> abstractState)	Computes a join over itself and another abstract state abstractState (i.e., finds the least upper bound on the semilattice).
StateT	newArray(java.lang.String type, java.util.List<StateT> dimensions, JvmCfaNode creationCite)	Creates a new array of a given class with the given dimension sizes at a specific program point and returns a reference to it.
StateT	newObject(java.lang.String className, JvmCfaNode creationCite)	Creates a new object of a given class at a specific program point and returns a reference to it.
void	reduce(java.util.Set<java.lang.Object> referencesToKeep)	Discards all the references not in {@param referencesToKeep}.
<T> void	setArrayElement(T array, StateT index, StateT value)	Sets the array element value at the specified index.
<T> void	setField(T object, java.lang.String fqn, StateT value)	Sets a value to a field fqn of a referenced object.

Methods inherited from class java.lang.Object

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

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

getPrecision, isLess

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

newObject

Field Detail

referenceToObject

public final MapAbstractState<ReferenceT,StateT extends AbstractState<StateT>> referenceToObject

referenceClass

protected final java.lang.Class<ReferenceT> referenceClass

defaultValue

protected final StateT extends AbstractState<StateT> defaultValue

Constructor Detail

JvmShallowHeapAbstractState

public JvmShallowHeapAbstractState(MapAbstractState<ReferenceT,StateT> referenceToObject,
                                   java.lang.Class<ReferenceT> referenceClass,
                                   StateT defaultValue)

Create a shallow heap abstract state returning the specified value for all queries from an existing reference to abstract state map.

Parameters:

defaultValue - the value to be returned by memory accesses

referenceClass - the class of the reference used for addressing

referenceToObject - the value to be returned by memory accesses

Method Detail

reduce

public void reduce(java.util.Set<java.lang.Object> referencesToKeep)

Discards all the references not in {@param referencesToKeep}.

Specified by:

reduce in interface JvmHeapAbstractState<ReferenceT>

Parameters:

referencesToKeep - information on the references to keep or discard, based on the implementation. Unused in the default implementation

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<ReferenceT>

Parameters:

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

getFieldOrDefault

public <T> StateT getFieldOrDefault(T object,
                                    java.lang.String fqn,
                                    StateT defaultValue)

Description copied from interface: JvmHeapAbstractState

Returns a field fqn from a reference object. If there is no abstract state representing the field, returns the defaultValue

Specified by:

getFieldOrDefault in interface JvmHeapAbstractState<ReferenceT>

setField

public <T> void setField(T object,
                         java.lang.String fqn,
                         StateT value)

Description copied from interface: JvmHeapAbstractState

Sets a value to a field fqn of a referenced object.

Specified by:

setField in interface JvmHeapAbstractState<ReferenceT>

getArrayElementOrDefault

public <T> StateT getArrayElementOrDefault(T array,
                                           StateT index,
                                           StateT defaultValue)

Description copied from interface: JvmHeapAbstractState

Returns an array element at the specified index or the defaultValue, if the element is unset.

Specified by:

getArrayElementOrDefault in interface JvmHeapAbstractState<ReferenceT>

setArrayElement

public <T> void setArrayElement(T array,
                                StateT index,
                                StateT value)

Description copied from interface: JvmHeapAbstractState

Sets the array element value at the specified index.

Specified by:

setArrayElement in interface JvmHeapAbstractState<ReferenceT>

newObject

public StateT newObject(java.lang.String className,
                        JvmCfaNode creationCite)

Description copied from interface: JvmHeapAbstractState

Creates a new object of a given class at a specific program point and returns a reference to it.

Specified by:

newObject in interface JvmHeapAbstractState<ReferenceT>

newArray

public StateT newArray(java.lang.String type,
                       java.util.List<StateT> dimensions,
                       JvmCfaNode creationCite)

Description copied from interface: JvmHeapAbstractState

Creates a new array of a given class with the given dimension sizes at a specific program point and returns a reference to it.

Specified by:

newArray in interface JvmHeapAbstractState<ReferenceT>

join

public JvmShallowHeapAbstractState<ReferenceT,StateT> join(JvmHeapAbstractState<StateT> abstractState)

Description copied from interface: AbstractState

Computes a join over itself and another abstract state abstractState (i.e., finds the least upper bound on the semilattice).

Specified by:

join in interface AbstractState<ReferenceT>

isLessOrEqual

public boolean isLessOrEqual(JvmHeapAbstractState<StateT> abstractState)

Description copied from interface: AbstractState

Compares itself to the abstractState (i.e., compare the states on the partial order provided by the domain of the analysis).

Specified by:

isLessOrEqual in interface AbstractState<ReferenceT>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface AbstractState<ReferenceT>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface AbstractState<ReferenceT>

Overrides:

hashCode in class java.lang.Object

copy

public JvmShallowHeapAbstractState<ReferenceT,StateT> copy()

Description copied from interface: AbstractState

Creates a copy of itself.

Specified by:

copy in interface AbstractState<ReferenceT>

Specified by:

copy in interface JvmHeapAbstractState<ReferenceT>