proguard.analysis.cpa.jvm.state.heap

Interface JvmHeapAbstractState<StateT extends LatticeAbstractState<StateT>>

All Superinterfaces:

AbstractState, LatticeAbstractState<JvmHeapAbstractState<StateT>>

All Known Implementing Classes:

JvmForgetfulHeapAbstractState, JvmTreeHeapAbstractState, JvmTreeHeapFollowerAbstractState, JvmTreeHeapPrincipalAbstractState

public interface JvmHeapAbstractState<StateT extends LatticeAbstractState<StateT>>
extends LatticeAbstractState<JvmHeapAbstractState<StateT>>

The JvmHeapAbstractState provides the interfaces for heap operations over objects and arrays.

Method Summary

Modifier and Type	Method and Description
JvmHeapAbstractState<StateT>	copy() Creates a copy of itself.
default void	expand(JvmHeapAbstractState<StateT> otherState) Expands the heap with references present in another state.
StateT	getArrayElementOrDefault(StateT array, StateT index, StateT defaultValue) Returns an array element at the specified index or the defaultValue, if the element is unset.
StateT	getField(StateT object, java.lang.String descriptor, StateT defaultValue) Returns a field descriptor from a reference object.
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.
default void	reduce(java.util.Optional<java.util.Set<Reference>> references) Discards unused parts of the heap.
void	setArrayElement(StateT array, StateT index, StateT value) Sets the array element value at the specified index.
void	setField(StateT object, java.lang.String descriptor, StateT value) Sets a value to a field descriptor of a referenced object and returns the value.

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

isLess, isLessOrEqual, join

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

equals, getPrecision, getStateByName, hashCode

Method Detail

copy

JvmHeapAbstractState<StateT> copy()

Description copied from interface: AbstractState

Creates a copy of itself.

Specified by:

copy in interface AbstractState

newArray

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.

newObject

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.

getField

StateT getField(StateT object,
                java.lang.String descriptor,
                StateT defaultValue)

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

setField

void setField(StateT object,
              java.lang.String descriptor,
              StateT value)

Sets a value to a field descriptor of a referenced object and returns the value.

getArrayElementOrDefault

StateT getArrayElementOrDefault(StateT array,
                                StateT index,
                                StateT defaultValue)

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

setArrayElement

void setArrayElement(StateT array,
                     StateT index,
                     StateT value)

Sets the array element value at the specified index.

reduce

default void reduce(java.util.Optional<java.util.Set<Reference>> references)

Discards unused parts of the heap. Does nothing in the default implementation. This can be overridden to model discarding heap portions at call sites.

Parameters:

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

expand

default void expand(JvmHeapAbstractState<StateT> otherState)

Expands the heap with references present in another state. Does nothing in the default implementation. This can be overridden to model recovering information discarded at call sites when analyzing a return site.

Parameters:

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