org.checkerframework.dataflow.cfg

Class DOTCFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

java.lang.Object

org.checkerframework.dataflow.cfg.DOTCFGVisualizer<A,S,T>

All Implemented Interfaces:

CFGVisualizer<A,S,T>

public class DOTCFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>
extends java.lang.Object
implements CFGVisualizer<A,S,T>

Generate a graph description in the DOT language of a control graph.

Author:

Stefan Heule

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	checkerName
protected java.util.Map<java.lang.String,java.lang.String>	generated Mapping from class/method representation to generated dot file.
protected java.lang.String	outdir
protected java.lang.StringBuilder	sbBlock
protected java.lang.StringBuilder	sbDigraph
protected java.lang.StringBuilder	sbStore
protected boolean	verbose

Constructor Summary

Constructors

Constructor and Description
DOTCFGVisualizer()

Method Summary

Modifier and Type	Method and Description
protected void	addDotEdge(long sId, long eId, java.lang.String labelContent)
protected java.lang.String	dotOutputFileName(UnderlyingAST ast)
protected java.lang.String	escapeDoubleQuotes(java.lang.String str)
protected java.lang.String	generateDotGraph(ControlFlowGraph cfg, Block entry, @Nullable Analysis<A,S,T> analysis) Generate the dot representation as String.
protected void	generateDotNodes(java.util.Set<Block> visited, ControlFlowGraph cfg, @Nullable Analysis<A,S,T> analysis)
protected java.util.IdentityHashMap<Block,java.util.List<java.lang.Integer>>	getProcessOrder(ControlFlowGraph cfg)
void	init(java.util.Map<java.lang.String,java.lang.Object> args) Initialization method guaranteed to be called once before the first invocation of visualize.
protected java.lang.String	prepareNodeType(Node t)
protected java.lang.String	prepareString(java.lang.String s)
void	shutdown() Write a file methods.txt that contains a mapping from source code location to generated dot file.
protected java.lang.String	toStringEscapeDoubleQuotes(java.lang.Object obj)
@Nullable java.util.Map<java.lang.String,java.lang.Object>	visualize(ControlFlowGraph cfg, Block entry, @Nullable Analysis<A,S,T> analysis) Output a visualization representing the control flow graph starting at entry.
void	visualizeBlock(Block bb, @Nullable Analysis<A,S,T> analysis) Produce a representation of the contests of a basic block.
void	visualizeBlockNode(Node t, @Nullable Analysis<A,S,T> analysis) Visualize a Node based on the analysis.
void	visualizeBlockTransferInput(Block bb, Analysis<A,S,T> analysis) Visualize the transferInput of a Block based on the analysis.
void	visualizeSpecialBlock(SpecialBlock sbb) Visualize a SpecialBlock.
void	visualizeStore(S store) Delegate the visualization responsibility to the passed Store instance, which will call back to this visualizer instance for sub-components.
void	visualizeStoreArrayVal(FlowExpressions.ArrayAccess arrayValue, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of arrays collected by this Store.
void	visualizeStoreClassVals(FlowExpressions.ClassName className, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of class names collected by this Store.
void	visualizeStoreFieldVals(FlowExpressions.FieldAccess fieldAccess, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of fields collected by this Store.
void	visualizeStoreFooter() Called by CFAbstractStore to visualize any information after the invocation of CFAbstractStore#internalVisualize().
void	visualizeStoreHeader(java.lang.String classCanonicalName) Called by a CFAbstractStore to visualize the class name before calling the CFAbstractStore#internalVisualize() method.
void	visualizeStoreKeyVal(java.lang.String keyName, java.lang.Object value) Called by CFAbstractStore#internalVisualize() to visualize the specific information collected according to the specific kind of Store.
void	visualizeStoreLocalVar(FlowExpressions.LocalVariable localVar, A value) Called by CFAbstractStore#internalVisualize() to visualize a local variable.
void	visualizeStoreMethodVals(FlowExpressions.MethodCall methodCall, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of pure method calls collected by this Store.
void	visualizeStoreThisVal(A value) Called by CFAbstractStore#internalVisualize() to visualize the value of the current object this in this Store.

Methods inherited from class java.lang.Object

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

Field Detail

outdir

protected java.lang.String outdir

verbose

protected boolean verbose

checkerName

protected java.lang.String checkerName

sbDigraph

protected java.lang.StringBuilder sbDigraph

sbStore

protected java.lang.StringBuilder sbStore

sbBlock

protected java.lang.StringBuilder sbBlock

generated

protected java.util.Map<java.lang.String,java.lang.String> generated

Mapping from class/method representation to generated dot file.

Constructor Detail

DOTCFGVisualizer

public DOTCFGVisualizer()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.Object> args)

Description copied from interface: CFGVisualizer

Initialization method guaranteed to be called once before the first invocation of visualize.

Specified by:

init in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

args - implementation-dependent options

visualize

public @Nullable java.util.Map<java.lang.String,java.lang.Object> visualize(ControlFlowGraph cfg,
                                                                            Block entry,
                                                                            @Nullable Analysis<A,S,T> analysis)

Output a visualization representing the control flow graph starting at entry. The concrete actions are implementation dependent.

An invocation visualize(cfg, entry, null); does not output stores at the beginning of basic blocks.

Specified by:

visualize in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

cfg - the CFG to visualize

entry - the entry node of the control flow graph to be represented

analysis - an analysis containing information about the program represented by the CFG. The information includes Stores that are valid at the beginning of basic blocks reachable from entry and per-node information for value producing Nodes. Can also be null to indicate that this information should not be output.

Returns:

possible analysis results, e.g. generated file names.

generateDotGraph

protected java.lang.String generateDotGraph(ControlFlowGraph cfg,
                                            Block entry,
                                            @Nullable Analysis<A,S,T> analysis)

Generate the dot representation as String.

generateDotNodes

protected void generateDotNodes(java.util.Set<Block> visited,
                                ControlFlowGraph cfg,
                                @Nullable Analysis<A,S,T> analysis)

dotOutputFileName

protected java.lang.String dotOutputFileName(UnderlyingAST ast)

Returns:

the file name used for DOT output.

getProcessOrder

protected java.util.IdentityHashMap<Block,java.util.List<java.lang.Integer>> getProcessOrder(ControlFlowGraph cfg)

visualizeBlock

public void visualizeBlock(Block bb,
                           @Nullable Analysis<A,S,T> analysis)

Produce a representation of the contests of a basic block.

Specified by:

visualizeBlock in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

bb - basic block to visualize

analysis - the current analysis

visualizeSpecialBlock

public void visualizeSpecialBlock(SpecialBlock sbb)

Description copied from interface: CFGVisualizer

Visualize a SpecialBlock.

Specified by:

visualizeSpecialBlock in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

sbb - the special block

visualizeBlockTransferInput

public void visualizeBlockTransferInput(Block bb,
                                        Analysis<A,S,T> analysis)

Description copied from interface: CFGVisualizer

Visualize the transferInput of a Block based on the analysis.

Specified by:

visualizeBlockTransferInput in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

bb - the block

analysis - the current analysis

visualizeBlockNode

public void visualizeBlockNode(Node t,
                               @Nullable Analysis<A,S,T> analysis)

Description copied from interface: CFGVisualizer

Visualize a Node based on the analysis.

Specified by:

visualizeBlockNode in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

t - the node

analysis - the current analysis

prepareNodeType

protected java.lang.String prepareNodeType(Node t)

prepareString

protected java.lang.String prepareString(java.lang.String s)

addDotEdge

protected void addDotEdge(long sId,
                          long eId,
                          java.lang.String labelContent)

visualizeStore

public void visualizeStore(S store)

Description copied from interface: CFGVisualizer

Delegate the visualization responsibility to the passed Store instance, which will call back to this visualizer instance for sub-components.

Specified by:

visualizeStore in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

store - the store to visualize

visualizeStoreThisVal

public void visualizeStoreThisVal(A value)

Description copied from interface: CFGVisualizer

Called by CFAbstractStore#internalVisualize() to visualize the value of the current object this in this Store.

Specified by:

visualizeStoreThisVal in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

value - the value of the current object this

visualizeStoreLocalVar

public void visualizeStoreLocalVar(FlowExpressions.LocalVariable localVar,
                                   A value)

Description copied from interface: CFGVisualizer

Called by CFAbstractStore#internalVisualize() to visualize a local variable.

Specified by:

visualizeStoreLocalVar in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

localVar - the local variable

value - the value of the local variable

visualizeStoreFieldVals

public void visualizeStoreFieldVals(FlowExpressions.FieldAccess fieldAccess,
                                    A value)

Description copied from interface: CFGVisualizer

Called by CFAbstractStore#internalVisualize() to visualize the value of fields collected by this Store.

Specified by:

visualizeStoreFieldVals in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

fieldAccess - the field

value - the value of the field

visualizeStoreArrayVal

public void visualizeStoreArrayVal(FlowExpressions.ArrayAccess arrayValue,
                                   A value)

Description copied from interface: CFGVisualizer

Called by CFAbstractStore#internalVisualize() to visualize the value of arrays collected by this Store.

Specified by:

visualizeStoreArrayVal in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

arrayValue - the array

value - the value of the array

visualizeStoreMethodVals

public void visualizeStoreMethodVals(FlowExpressions.MethodCall methodCall,
                                     A value)

Description copied from interface: CFGVisualizer

Called by CFAbstractStore#internalVisualize() to visualize the value of pure method calls collected by this Store.

Specified by:

visualizeStoreMethodVals in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

methodCall - the pure method call

value - the value of the pure method call

visualizeStoreClassVals

public void visualizeStoreClassVals(FlowExpressions.ClassName className,
                                    A value)

Description copied from interface: CFGVisualizer

Called by CFAbstractStore#internalVisualize() to visualize the value of class names collected by this Store.

Specified by:

visualizeStoreClassVals in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

className - the class name

value - the value of the class name

visualizeStoreKeyVal

public void visualizeStoreKeyVal(java.lang.String keyName,
                                 java.lang.Object value)

Description copied from interface: CFGVisualizer

Called by CFAbstractStore#internalVisualize() to visualize the specific information collected according to the specific kind of Store. Currently, these Stores call this method: LockStore, NullnessStore, and InitializationStore to visualize additional information.

Specified by:

visualizeStoreKeyVal in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

keyName - the name of the specific information to be visualized

value - the value of the specific information to be visualized

escapeDoubleQuotes

protected java.lang.String escapeDoubleQuotes(java.lang.String str)

toStringEscapeDoubleQuotes

protected java.lang.String toStringEscapeDoubleQuotes(java.lang.Object obj)

visualizeStoreHeader

public void visualizeStoreHeader(java.lang.String classCanonicalName)

Description copied from interface: CFGVisualizer

Called by a CFAbstractStore to visualize the class name before calling the CFAbstractStore#internalVisualize() method.

Specified by:

visualizeStoreHeader in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Parameters:

classCanonicalName - the canonical name of the class

visualizeStoreFooter

public void visualizeStoreFooter()

Description copied from interface: CFGVisualizer

Called by CFAbstractStore to visualize any information after the invocation of CFAbstractStore#internalVisualize().

Specified by:

visualizeStoreFooter in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

shutdown

public void shutdown()

Write a file methods.txt that contains a mapping from source code location to generated dot file.

Specified by:

shutdown in interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>