org.checkerframework.dataflow.analysis

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

java.lang.Object

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

Type Parameters:

A - type of the abstract value that is tracked

public class AnalysisResult<A extends AbstractValue<A>,S extends Store<S>>
extends java.lang.Object

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 java.util.Map<TransferInput<A,S>,java.util.IdentityHashMap<Node,TransferResult<A,S>>>	analysisCaches Caches of the analysis results for each input for the block of the node and each node.
protected java.util.HashMap<javax.lang.model.element.Element,A>	finalLocalValues Map from (effectively final) local variable elements to their abstract value.
protected java.util.IdentityHashMap<Node,A>	nodeValues Abstract values of nodes.
protected java.util.IdentityHashMap<Block,TransferInput<A,S>>	stores The stores before every method call.
protected java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.Set<Node>>	treeLookup Map from AST Trees to sets of Nodes.
protected java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode>	unaryAssignNodeLookup Map from AST UnaryTrees to corresponding AssignmentNodes.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AnalysisResult(java.util.Map<Node,A> nodeValues, java.util.IdentityHashMap<Block,TransferInput<A,S>> stores, java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.Set<Node>> treeLookup, java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookup, java.util.HashMap<javax.lang.model.element.Element,A> finalLocalValues) Initialize with given mappings and empty cache.
protected	AnalysisResult(java.util.Map<Node,A> nodeValues, java.util.IdentityHashMap<Block,TransferInput<A,S>> stores, java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.Set<Node>> treeLookup, java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookup, java.util.HashMap<javax.lang.model.element.Element,A> finalLocalValues, java.util.Map<TransferInput<A,S>,java.util.IdentityHashMap<Node,TransferResult<A,S>>> analysisCaches) Initialize with given mappings.
	AnalysisResult(java.util.Map<TransferInput<A,S>,java.util.IdentityHashMap<Node,TransferResult<A,S>>> analysisCaches) Initialize empty result with specified cache.

Method Summary

Modifier and Type	Method and Description
void	combine(AnalysisResult<A,S> other) Combine with another analysis result.
AssignmentNode	getAssignForUnaryTree(com.sun.source.tree.UnaryTree tree)
java.util.HashMap<javax.lang.model.element.Element,A>	getFinalLocalValues()
@Nullable java.util.Set<Node>	getNodesForTree(com.sun.source.tree.Tree tree) Returns the Nodes corresponding to a particular Tree.
S	getStoreAfter(Node node)
S	getStoreAfter(com.sun.source.tree.Tree tree)
S	getStoreBefore(Node node)
S	getStoreBefore(com.sun.source.tree.Tree tree)
A	getValue(Node n)
A	getValue(com.sun.source.tree.Tree t)
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 <A extends AbstractValue<A>,S extends Store<S>> S	runAnalysisFor(Node node, boolean before, TransferInput<A,S> transferInput, java.util.IdentityHashMap<Node,A> nodeValues, java.util.Map<TransferInput<A,S>,java.util.IdentityHashMap<Node,TransferResult<A,S>>> analysisCaches) Runs the analysis again within the block of node and returns the store at the location of node.

Methods inherited from class java.lang.Object

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

Field Detail

nodeValues

protected final java.util.IdentityHashMap<Node,A extends AbstractValue<A>> nodeValues

Abstract values of nodes.

treeLookup

protected final java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.Set<Node>> treeLookup

Map from AST Trees to sets of Nodes.

unaryAssignNodeLookup

protected final java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookup

Map from AST UnaryTrees to corresponding AssignmentNodes.

finalLocalValues

protected final java.util.HashMap<javax.lang.model.element.Element,A extends AbstractValue<A>> finalLocalValues

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

stores

protected final java.util.IdentityHashMap<Block,TransferInput<A extends AbstractValue<A>,S extends Store<S>>> stores

The stores before every method call.

analysisCaches

protected final java.util.Map<TransferInput<A extends AbstractValue<A>,S extends Store<S>>,java.util.IdentityHashMap<Node,TransferResult<A extends AbstractValue<A>,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(java.util.Map<Node,A> nodeValues,
                         java.util.IdentityHashMap<Block,TransferInput<A,S>> stores,
                         java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.Set<Node>> treeLookup,
                         java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookup,
                         java.util.HashMap<javax.lang.model.element.Element,A> finalLocalValues,
                         java.util.Map<TransferInput<A,S>,java.util.IdentityHashMap<Node,TransferResult<A,S>>> analysisCaches)

Initialize with given mappings.

AnalysisResult

public AnalysisResult(java.util.Map<Node,A> nodeValues,
                      java.util.IdentityHashMap<Block,TransferInput<A,S>> stores,
                      java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.Set<Node>> treeLookup,
                      java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookup,
                      java.util.HashMap<javax.lang.model.element.Element,A> finalLocalValues)

Initialize with given mappings and empty cache.

AnalysisResult

public AnalysisResult(java.util.Map<TransferInput<A,S>,java.util.IdentityHashMap<Node,TransferResult<A,S>>> analysisCaches)

Initialize empty result with specified cache.

Method Detail

combine

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

Combine with another analysis result.

getFinalLocalValues

public java.util.HashMap<javax.lang.model.element.Element,A> getFinalLocalValues()

Returns:

the value of effectively final local variables

getValue

public A getValue(Node n)

Returns:

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

getValue

public A getValue(com.sun.source.tree.Tree t)

Returns:

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

getNodesForTree

public @Nullable java.util.Set<Node> getNodesForTree(com.sun.source.tree.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.

Returns:

the set of Nodes for a given Tree

getAssignForUnaryTree

public AssignmentNode getAssignForUnaryTree(com.sun.source.tree.UnaryTree tree)

Returns:

the corresponding AssignmentNode for a given UnaryTree.

getStoreBefore

public S getStoreBefore(com.sun.source.tree.Tree tree)

Returns:

the store immediately before a given Tree.

getStoreBefore

public S getStoreBefore(Node node)

Returns:

the store immediately before a given Node.

getStoreAfter

public S getStoreAfter(com.sun.source.tree.Tree tree)

Returns:

the store immediately after a given Tree.

getStoreAfter

public S getStoreAfter(Node 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.

runAnalysisFor

public static <A extends AbstractValue<A>,S extends Store<S>> S runAnalysisFor(Node node,
                                                                               boolean before,
                                                                               TransferInput<A,S> transferInput,
                                                                               java.util.IdentityHashMap<Node,A> nodeValues,
                                                                               java.util.Map<TransferInput<A,S>,java.util.IdentityHashMap<Node,TransferResult<A,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 after node is returned. If analysisCaches is not null, this method uses a cache. analysisCaches is a map to a cache for analysis result from an input of the block of the node. If the cache for transferInput is not in analysisCaches, this method create new cache and store it in analysisCaches. The cache is a map from a node to the analysis result of the node.