Package it.unive.lisa.interprocedural

Class CFGResults<A extends AbstractState<A>>

java.lang.Object

it.unive.lisa.analysis.lattices.FunctionalLattice<CFGResults<A>,ScopeId,AnalyzedCFG<A>>

it.unive.lisa.interprocedural.CFGResults<A>

Type Parameters:

A - the type of AbstractState contained into the analysis state

All Implemented Interfaces:

BaseLattice<CFGResults<A>>, Lattice<CFGResults<A>>, StructuredObject, java.lang.Iterable<java.util.Map.Entry<ScopeId,AnalyzedCFG<A>>>

public class CFGResults<A extends AbstractState<A>>
extends FunctionalLattice<CFGResults<A>,ScopeId,AnalyzedCFG<A>>

A FunctionalLattice from ScopeIds to AnalyzedCFGs. This class is meant to store fixpoint results on each token generated during the interprocedural analysis.

Nested Class Summary

Nested classes/interfaces inherited from class it.unive.lisa.analysis.lattices.FunctionalLattice

FunctionalLattice.FunctionalLift<V extends Lattice<V>>, FunctionalLattice.KeyFunctionalLift<K>

Field Summary

Fields inherited from class it.unive.lisa.analysis.lattices.FunctionalLattice

function, lattice

Fields inherited from interface it.unive.lisa.analysis.Lattice

BOTTOM_STRING, TOP_STRING

Constructor Summary

Constructors

Constructor	Description
CFGResults(AnalyzedCFG<A> lattice)	Builds a new result.

Method Summary

Modifier and Type	Method	Description
CFGResults<A>	bottom()	Yields the bottom element of this lattice.
boolean	contains(ScopeId token)	Yields true if a result exists for the given token.
AnalyzedCFG<A>	get(ScopeId token)	Yields the recorded result for the given token.
java.util.Collection<AnalyzedCFG<A>>	getAll()	Yields all the results stored in this object, for any possible ScopeId used.
CFGResults<A>	mk(AnalyzedCFG<A> lattice, java.util.Map<ScopeId,AnalyzedCFG<A>> function)	Builds a instance of this class from the given lattice instance and the given mapping.
org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,AnalyzedCFG<A>>	putResult(ScopeId token, AnalyzedCFG<A> result)	Stores the result of a fixpoint computation on a cfg, if needed.
AnalyzedCFG<A>	stateOfUnknown(ScopeId key)	Yields the value that should be returned by FunctionalLattice.getState(Object) whenever the given key is not present in this map.
CFGResults<A>	top()	Yields the top element of this lattice.

Methods inherited from class it.unive.lisa.analysis.lattices.FunctionalLattice

equals, functionalLift, getKeys, getMap, getOtDefault, getState, getValues, glbAux, glbKeys, hashCode, isBottom, isTop, iterator, lessOrEqualAux, lubAux, lubKeys, mkNewFunction, narrowingAux, putState, representation, toString, wideningAux

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unive.lisa.analysis.BaseLattice

glb, lessOrEqual, lub, narrowing, widening

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CFGResults

public CFGResults(AnalyzedCFG<A> lattice)

Builds a new result.

Parameters:

lattice - a singleton instance used for retrieving top and bottom values

Method Detail

putResult

public org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,AnalyzedCFG<A>> putResult(ScopeId token,
                                                                                             AnalyzedCFG<A> result)
                                                                                      throws SemanticException

Stores the result of a fixpoint computation on a cfg, if needed. This method returns a pair of a boolean and a AnalyzedCFG, where (prev is the AnalyzedCFG already present for the given token):

• if no prev was stored for token, than that token is mapped to result and this method returns <false, result>
• if prev <= result, then token is mapped to result and this method returns <true, result>
• if result <= prev, then the mapping is left untouched and this method returns <false, prev>
• otherwise, token is mapped to lub = prev.lub(result) and this method returns <true, lub>

The value returned by this method is intended to be a hint that a new fixpoint computation is needed to ensure that the results are stable.

Parameters:

token - the ScopeId that identifying the result

result - the AnalyzedCFG to store

Returns:

true if the previous result has been updated, if any

Throws:

SemanticException - if something goes wrong during the update

contains

public boolean contains(ScopeId token)

Yields true if a result exists for the given token.

Parameters:

token - the ScopeId that identifying the result

Returns:

true if that condition holds

get

public AnalyzedCFG<A> get(ScopeId token)

Yields the recorded result for the given token. This differs from FunctionalLattice.getState(Object) as it returns null instead of Lattice.bottom() if there is no recorded result for the given token.

Parameters:

token - the ScopeId that identifying the result

Returns:

the result, or null

getAll

public java.util.Collection<AnalyzedCFG<A>> getAll()

Yields all the results stored in this object, for any possible ScopeId used.

Returns:

the results

top

public CFGResults<A> top()

Description copied from interface: Lattice

Yields the top element of this lattice. The returned element should be unique across different calls to this method, since Lattice.isTop() uses reference equality by default. If the value returned by this method is not a singleton, override Lattice.isTop() accordingly to provide a coherent test.

Returns:

the top element

bottom

public CFGResults<A> bottom()

Description copied from interface: Lattice

Yields the bottom element of this lattice. The returned element should be unique across different calls to this method, since Lattice.isBottom() uses reference equality by default. If the value returned by this method is not a singleton, override Lattice.isBottom() accordingly to provide a coherent test.

Returns:

the bottom element

mk

public CFGResults<A> mk(AnalyzedCFG<A> lattice,
                        java.util.Map<ScopeId,AnalyzedCFG<A>> function)

Description copied from class: FunctionalLattice

Builds a instance of this class from the given lattice instance and the given mapping.

Specified by:

mk in class FunctionalLattice<CFGResults<A extends AbstractState<A>>,ScopeId,AnalyzedCFG<A extends AbstractState<A>>>

Parameters:

lattice - an instance of lattice to be used during semantic operations to retrieve top and bottom values

function - the function representing the mapping contained in the new environment; can be null

Returns:

a new instance of this class

stateOfUnknown

public AnalyzedCFG<A> stateOfUnknown(ScopeId key)

Description copied from class: FunctionalLattice

Yields the value that should be returned by FunctionalLattice.getState(Object) whenever the given key is not present in this map.

Specified by:

stateOfUnknown in class FunctionalLattice<CFGResults<A extends AbstractState<A>>,ScopeId,AnalyzedCFG<A extends AbstractState<A>>>

Parameters:

key - the key that is missing

Returns:

the lattice element for keys not in the mapping