org.checkerframework.dataflow.analysis

Class AnalysisResult<V extends AbstractValue<V>,S extends Store<S>>

java.lang.Object

org.checkerframework.dataflow.analysis.AnalysisResult<V,S>

Type Parameters:

V - type of the abstract value that is tracked

S - the store type used in the analysis

All Implemented Interfaces:

org.plumelib.util.UniqueId

public class AnalysisResult<V extends AbstractValue<V>,S extends Store<S>>
extends Object
implements org.plumelib.util.UniqueId

An AnalysisResult represents the result of a org.checkerframework.dataflow analysis by providing the abstract values given a node or a tree. Note that it does not keep track of custom results computed by some analysis.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<TransferInput<V,S>,IdentityHashMap<Node,TransferResult<V,S>>>	analysisCaches Caches of the analysis results for each input for the block of the node and each node.
protected HashMap<Element,V>	finalLocalValues Map from (effectively final) local variable elements to their abstract value.
protected IdentityHashMap<Node,V>	nodeValues Abstract values of nodes.
protected IdentityHashMap<Block,TransferInput<V,S>>	stores The stores before every method call.
protected IdentityHashMap<Tree,Set<Node>>	treeLookup Map from AST Trees to sets of Nodes.
protected IdentityHashMap<UnaryTree,AssignmentNode>	unaryAssignNodeLookup Map from AST UnaryTrees to corresponding AssignmentNodes.

Fields inherited from interface org.plumelib.util.UniqueId

nextUid

Constructor Summary

Constructors

Modifier	Constructor and Description
	AnalysisResult(Map<Node,V> nodeValues, IdentityHashMap<Block,TransferInput<V,S>> stores, IdentityHashMap<Tree,Set<Node>> treeLookup, IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup, HashMap<Element,V> finalLocalValues) Initialize with given mappings and empty cache.
protected	AnalysisResult(Map<Node,V> nodeValues, IdentityHashMap<Block,TransferInput<V,S>> stores, IdentityHashMap<Tree,Set<Node>> treeLookup, IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup, HashMap<Element,V> finalLocalValues, Map<TransferInput<V,S>,IdentityHashMap<Node,TransferResult<V,S>>> analysisCaches) Initialize with given mappings.
	AnalysisResult(Map<TransferInput<V,S>,IdentityHashMap<Node,TransferResult<V,S>>> analysisCaches) Initialize empty result with specified cache.

Method Summary

Modifier and Type	Method and Description
void	combine(AnalysisResult<V,S> other) Combine with another analysis result.
AssignmentNode	getAssignForUnaryTree(UnaryTree tree) Returns the corresponding AssignmentNode for a given UnaryTree.
HashMap<Element,V>	getFinalLocalValues() Returns the value of effectively final local variables.
@Nullable Set<Node>	getNodesForTree(Tree tree) Returns the Nodes corresponding to a particular Tree.
S	getStoreAfter(Block block) Returns the regular store immediately after a given block.
S	getStoreAfter(Node node) Returns the store immediately after a given Node.
S	getStoreAfter(Tree tree) Returns the store immediately after a given Tree.
S	getStoreBefore(Block block) Returns the regular store immediately before a given Block.
S	getStoreBefore(Node node) Returns the store immediately before a given Node.
S	getStoreBefore(Tree tree) Returns the store immediately before a given Tree.
long	getUid()
V	getValue(Node n) Returns the abstract value for Node n, or null if no information is available.
V	getValue(Tree t) Returns the abstract value for Tree t, or null if no information is available.
static <V> String	nodeValuesToString(Map<Node,V> nodeValues) Returns a verbose string representation, useful for debugging.
protected S	runAnalysisFor(Node node, boolean before) Runs the analysis again within the block of node and returns the store at the location of node.
static <V extends AbstractValue<V>,S extends Store<S>> S	runAnalysisFor(Node node, boolean before, TransferInput<V,S> transferInput, IdentityHashMap<Node,V> nodeValues, Map<TransferInput<V,S>,IdentityHashMap<Node,TransferResult<V,S>>> analysisCaches) Runs the analysis again within the block of node and returns the store at the location of node.
String	toStringDebug() Returns a verbose string representation of this, useful for debugging.
static String	treeLookupToString(Map<Tree,Set<Node>> treeLookup) Returns a verbose string representation of a map, useful for debugging.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.plumelib.util.UniqueId

getClassAndUid

Field Detail

nodeValues

protected final IdentityHashMap<Node,V extends AbstractValue<V>> nodeValues

Abstract values of nodes.

treeLookup

protected final IdentityHashMap<Tree,Set<Node>> treeLookup

Map from AST Trees to sets of Nodes.

Some of those Nodes might not be keys in nodeValues. One reason is that the Node is unreachable in the control flow graph, so dataflow never gave it a value.

unaryAssignNodeLookup

protected final IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup

Map from AST UnaryTrees to corresponding AssignmentNodes.

finalLocalValues

protected final HashMap<Element,V extends AbstractValue<V>> finalLocalValues

Map from (effectively final) local variable elements to their abstract value.

stores

protected final IdentityHashMap<Block,TransferInput<V extends AbstractValue<V>,S extends Store<S>>> stores

The stores before every method call.

analysisCaches

protected final Map<TransferInput<V extends AbstractValue<V>,S extends Store<S>>,IdentityHashMap<Node,TransferResult<V extends AbstractValue<V>,S extends Store<S>>>> analysisCaches

Caches of the analysis results for each input for the block of the node and each node.

See Also:

runAnalysisFor(Node, boolean, TransferInput, IdentityHashMap, Map)

Constructor Detail

AnalysisResult

protected AnalysisResult(Map<Node,V> nodeValues,
                         IdentityHashMap<Block,TransferInput<V,S>> stores,
                         IdentityHashMap<Tree,Set<Node>> treeLookup,
                         IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup,
                         HashMap<Element,V> finalLocalValues,
                         Map<TransferInput<V,S>,IdentityHashMap<Node,TransferResult<V,S>>> analysisCaches)

Initialize with given mappings.

Parameters:

nodeValues - nodeValues

stores - stores

treeLookup - treeLookup

unaryAssignNodeLookup - unaryAssignNodeLookup

finalLocalValues - finalLocalValues

analysisCaches - analysisCaches

AnalysisResult

public AnalysisResult(Map<Node,V> nodeValues,
                      IdentityHashMap<Block,TransferInput<V,S>> stores,
                      IdentityHashMap<Tree,Set<Node>> treeLookup,
                      IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup,
                      HashMap<Element,V> finalLocalValues)

Initialize with given mappings and empty cache.

Parameters:

nodeValues - nodeValues

stores - stores

treeLookup - treeLookup

unaryAssignNodeLookup - unaryAssignNodeLookup

finalLocalValues - finalLocalValues

AnalysisResult

public AnalysisResult(Map<TransferInput<V,S>,IdentityHashMap<Node,TransferResult<V,S>>> analysisCaches)

Initialize empty result with specified cache.

Parameters:

analysisCaches - analysisCaches

Method Detail

getUid

public long getUid()

Specified by:

getUid in interface org.plumelib.util.UniqueId

combine

public void combine(AnalysisResult<V,S> other)

Combine with another analysis result.

Parameters:

other - an analysis result to combine with this

getFinalLocalValues

public HashMap<Element,V> getFinalLocalValues()

Returns the value of effectively final local variables.

Returns:

the value of effectively final local variables

getValue

public V getValue(Node n)

Returns the abstract value for Node n, or null if no information is available. Note that if the analysis has not finished yet, this value might not represent the final value for this node.

Parameters:

n - a node

Returns:

the abstract value for Node n, or null if no information is available

getValue

public V getValue(Tree t)

Returns the abstract value for Tree t, or null if no information is available. Note that if the analysis has not finished yet, this value might not represent the final value for this node.

Parameters:

t - a tree

Returns:

the abstract value for Tree t, or null if no information is available

getNodesForTree

public @Nullable Set<Node> getNodesForTree(Tree tree)

Returns the Nodes corresponding to a particular Tree. Multiple Nodes can correspond to a single Tree because of several reasons:

1. In a lambda expression such as () -> 5 the 5 is both an IntegerLiteralNode and a LambdaResultExpressionNode.
2. Narrowing and widening primitive conversions can result in NarrowingConversionNode and WideningConversionNode.
3. Automatic String conversion can result in a StringConversionNode.
4. Trees for finally blocks are cloned to achieve a precise CFG. Any Tree within a finally block can have multiple corresponding Nodes attached to them.

Callers of this method should always iterate through the returned set, possibly ignoring all Nodes they are not interested in.

Parameters:

tree - a tree

Returns:

the set of Nodes for a given Tree

getAssignForUnaryTree

public AssignmentNode getAssignForUnaryTree(UnaryTree tree)

Returns the corresponding AssignmentNode for a given UnaryTree.

Parameters:

tree - a unary tree

Returns:

the corresponding assignment node

getStoreBefore

public S getStoreBefore(Tree tree)

Returns the store immediately before a given Tree.

Parameters:

tree - a tree

Returns:

the store immediately before a given Tree

getStoreBefore

public S getStoreBefore(Node node)

Returns the store immediately before a given Node.

Parameters:

node - a node

Returns:

the store immediately before a given Node

getStoreBefore

public S getStoreBefore(Block block)

Returns the regular store immediately before a given Block.

Parameters:

block - a block

Returns:

the store right before the given block

getStoreAfter

public S getStoreAfter(Block block)

Returns the regular store immediately after a given block.

Parameters:

block - a block

Returns:

the store after the given block

getStoreAfter

public S getStoreAfter(Tree tree)

Returns the store immediately after a given Tree.

Parameters:

tree - a tree

Returns:

the store immediately after a given Tree

getStoreAfter

public S getStoreAfter(Node node)

Returns the store immediately after a given Node.

Parameters:

node - a node

Returns:

the store immediately after a given Node

runAnalysisFor

protected S runAnalysisFor(Node node,
                           boolean before)

Runs the analysis again within the block of node and returns the store at the location of node. If before is true, then the store immediately before the Node node is returned. Otherwise, the store after node is returned.

If the given Node cannot be reached (in the control flow graph), then null is returned.

Parameters:

node - the node to analyze

before - the boolean value to indicate which store to return (if it is true, return the store immediately before node; otherwise, the store after node is returned)

Returns:

the store before or after node (depends on the value of before) after running the analysis

runAnalysisFor

public static <V extends AbstractValue<V>,S extends Store<S>> S runAnalysisFor(Node node,
                                                                               boolean before,
                                                                               TransferInput<V,S> transferInput,
                                                                               IdentityHashMap<Node,V> nodeValues,
                                                                               Map<TransferInput<V,S>,IdentityHashMap<Node,TransferResult<V,S>>> analysisCaches)

Runs the analysis again within the block of node and returns the store at the location of node. If before is true, then the store immediately before the Node node is returned. Otherwise, the store immediately after node is returned. If analysisCaches is not null, this method uses a cache. analysisCaches is a map of a block of node to the cached analysis result. If the cache for transferInput is not in analysisCaches, this method creates new cache and stores it in analysisCaches. The cache is a map of nodes to the analysis results of the nodes.

Type Parameters:

V - the abstract value type to be tracked by the analysis

S - the store type used in the analysis

Parameters:

node - the node to analyze

before - the boolean value to indicate which store to return (if it is true, return the store immediately before node; otherwise, the store after node is returned)

transferInput - a transfer input

nodeValues - nodeValues

analysisCaches - analysisCaches

Returns:

the store before or after node (depends on the value of before) after running the analysis

toStringDebug

public String toStringDebug()

Returns a verbose string representation of this, useful for debugging.

Returns:

a string representation of this

nodeValuesToString

public static <V> String nodeValuesToString(Map<Node,V> nodeValues)

Returns a verbose string representation, useful for debugging. The map has the same type as the nodeValues field.

Type Parameters:

V - the type of values in the map

Parameters:

nodeValues - a map to format

Returns:

a printed representation of the given map

treeLookupToString

public static String treeLookupToString(Map<Tree,Set<Node>> treeLookup)

Returns a verbose string representation of a map, useful for debugging. The map has the same type as the treeLookup field.

Parameters:

treeLookup - a map to format

Returns:

a printed representation of the given map