Description

Static single assignment analysis. This analysis attaches uses an definitions to unfiltered CFG nodes rather than to AST nodes; as such its interfaces are more intuitive and easier to use. It also resolves some ambiguity issues when attaching definitions to AST nodes.

Known bugs:

Bodies of catch statements are not analyzed. This is a shortcoming of the ROSE virtual CFG, because these bodies do not appear in the virtual CFG.
Variables used to define the dimensions inside an array declaration are not detected as uses. This is because the SgVarRef nodes for these variables are not visited by AST traversals.
Operands of the sizeof operator are considered uses, and they should not be (relatively easy fix).

Definition at line 81 of file ssaUnfilteredCfg.h.

#include <midend/programAnalysis/ssaUnfilteredCfg/ssaUnfilteredCfg.h>

Collaboration diagram for ssa_unfiltered_cfg::SSA_UnfilteredCfg:

[legend]

Public Types
typedef std::vector< SgInitializedName * >	VarName
	A compound variable name as used by the variable renaming.

typedef boost::shared_ptr< ReachingDef >	ReachingDefPtr

typedef std::map< VarName, ReachingDefPtr >	NodeReachingDefTable
	A map from each variable to its reaching definitions at the current node.

typedef std::map< CFGNode, std::set< VarName > >	CFGNodeToVarNamesMap

typedef std::map< SgNode , std::set< SgVarRefExp > >	ASTNodeToVarRefsMap

typedef std::map< CFGNode, NodeReachingDefTable >	CFGNodeToDefTableMap

Public Member Functions
	SSA_UnfilteredCfg (SgProject *proj)

void	run ()
	Run the analysis.

void	toDOT (const std::string fileName)
	Print the CFG with any UniqueNames and Def/Use information visible.

void	toFilteredDOT (const std::string fileName)
	Print the CFG with any UniqueNames and Def/Use information visible.

const NodeReachingDefTable &	getReachingDefsBefore (const CFGNode &node) const
	Returns the reaching definitions before the given node was executed.

const NodeReachingDefTable &	getReachingDefsAfter (const CFGNode &node) const
	Returns the reaching definitions after the given node was executed.

const NodeReachingDefTable &	getDefsAtNode (const CFGNode &node) const
	Returns the definitions that occur at the given node.

const NodeReachingDefTable &	getReachingDefsBefore (SgNode *astNode) const
	Get the reaching definitions before the given AST node is executed.

const NodeReachingDefTable &	getReachingDefsAfter (SgNode *astNode) const
	Get the reaching definitions after the given AST node is executed.

const NodeReachingDefTable &	getLastVersions (SgFunctionDefinition *astNode) const
	Get the final versions of all the variables at the end of the given function.

const std::set< SgVarRefExp * > &	getUsesAtNode (SgNode *astNode) const
	Returns all the SgVarRef objects that are used in the execution of the given AST node.

const ReachingDefPtr	getDefinitionForUse (SgVarRefExp *astNode) const
	Given a use obtained through getUsesAtNode, resolve its corresponding def.

const ASTNodeToVarRefsMap &	getUseTable () const
	Returns the entire use table, mapping each non-statement AST node to the variables used in its execution.

Static Public Member Functions
static bool	getDebug ()

static bool	getDebugExtra ()

static bool	isPrefixOfName (VarName name, VarName prefix)
	Find if the given prefix is a prefix of the given name.

static ssa_private::VarUniqueName *	getUniqueName (SgNode *node)
	Get the uniqueName attribute for the given node.

static const VarName &	getVarName (SgNode *node)
	Get the variable name of the given node.

static const VarName &	getVarForExpression (SgNode *node)
	If an expression evaluates to a reference of a variable, returns that variable.

static SgExpression *	buildVariableReference (const VarName &var, SgScopeStatement *scope=NULL)
	Get an AST fragment containing the appropriate varRefs and Dot/Arrow ops to access the given variable.

static std::string	varnameToString (const VarName &vec)
	Get a string representation of a varName.

static void	printNodeDefTable (const NodeReachingDefTable &table)

static void	printFullDefTable (const CFGNodeToDefTableMap &defTable)

Static Public Attributes
static VarName	emptyName

Member Typedef Documentation

◆ VarName

typedef std::vector<SgInitializedName*> ssa_unfiltered_cfg::SSA_UnfilteredCfg::VarName

A compound variable name as used by the variable renaming.

Definition at line 90 of file ssaUnfilteredCfg.h.

◆ ReachingDefPtr

typedef boost::shared_ptr<ReachingDef> ssa_unfiltered_cfg::SSA_UnfilteredCfg::ReachingDefPtr

Definition at line 92 of file ssaUnfilteredCfg.h.

◆ NodeReachingDefTable

typedef std::map<VarName, ReachingDefPtr> ssa_unfiltered_cfg::SSA_UnfilteredCfg::NodeReachingDefTable

A map from each variable to its reaching definitions at the current node.

Definition at line 95 of file ssaUnfilteredCfg.h.

◆ CFGNodeToVarNamesMap

typedef std::map<CFGNode, std::set<VarName> > ssa_unfiltered_cfg::SSA_UnfilteredCfg::CFGNodeToVarNamesMap

Definition at line 97 of file ssaUnfilteredCfg.h.

◆ ASTNodeToVarRefsMap

typedef std::map<SgNode*, std::set<SgVarRefExp*> > ssa_unfiltered_cfg::SSA_UnfilteredCfg::ASTNodeToVarRefsMap

Definition at line 99 of file ssaUnfilteredCfg.h.

◆ CFGNodeToDefTableMap

typedef std::map<CFGNode, NodeReachingDefTable> ssa_unfiltered_cfg::SSA_UnfilteredCfg::CFGNodeToDefTableMap

Definition at line 101 of file ssaUnfilteredCfg.h.

Constructor & Destructor Documentation

◆ SSA_UnfilteredCfg()

ssa_unfiltered_cfg::SSA_UnfilteredCfg::SSA_UnfilteredCfg ( SgProject * proj )

inline

Definition at line 121 of file ssaUnfilteredCfg.h.

◆ ~SSA_UnfilteredCfg()

ssa_unfiltered_cfg::SSA_UnfilteredCfg::~SSA_UnfilteredCfg ( )

inline

Definition at line 123 of file ssaUnfilteredCfg.h.

Member Function Documentation

◆ getDebug()

static bool ssa_unfiltered_cfg::SSA_UnfilteredCfg::getDebug ( )

inlinestatic

Definition at line 128 of file ssaUnfilteredCfg.h.

◆ getDebugExtra()

static bool ssa_unfiltered_cfg::SSA_UnfilteredCfg::getDebugExtra ( )

inlinestatic

Definition at line 133 of file ssaUnfilteredCfg.h.

◆ toDOT()

void ssa_unfiltered_cfg::SSA_UnfilteredCfg::toDOT ( const std::string fileName )

Print the CFG with any UniqueNames and Def/Use information visible.

Parameters

fileName The filename to save graph as. Filenames will be prepended.

◆ toFilteredDOT()

void ssa_unfiltered_cfg::SSA_UnfilteredCfg::toFilteredDOT ( const std::string fileName )

Print the CFG with any UniqueNames and Def/Use information visible.

This will only print the nodes that are of interest to the filter function used by the def/use traversal.

Parameters

fileName The filename to save graph as. Filenames will be prepended.

◆ getReachingDefsAfter() [1/2]

const NodeReachingDefTable & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getReachingDefsAfter ( const CFGNode & node ) const

Returns the reaching definitions after the given node was executed.

If there are no local defs at the node (i.e. getDefsAtNode returns empty), then the reaching defs After a node are identical to the reaching defs before the node.

◆ getDefsAtNode()

const NodeReachingDefTable & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getDefsAtNode ( const CFGNode & node ) const

Returns the definitions that occur at the given node.

If no definitions occur at the node, the result is empty

◆ getReachingDefsBefore()

const NodeReachingDefTable & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getReachingDefsBefore ( SgNode * astNode ) const

Get the reaching definitions before the given AST node is executed.

This method is equivalent to looking up the reaching definitions before astNode->cfgForBeginning()

◆ getReachingDefsAfter() [2/2]

const NodeReachingDefTable & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getReachingDefsAfter ( SgNode * astNode ) const

Get the reaching definitions after the given AST node is executed.

This method is equivalent to looking up the reaching definitions after astNode->cfgForEnd()

◆ getUsesAtNode()

const std::set< SgVarRefExp * > & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getUsesAtNode ( SgNode * astNode ) const

Returns all the SgVarRef objects that are used in the execution of the given AST node.

Each of the SgVarRef objects returned corresponds to a variable name

◆ getDefinitionForUse()

const ReachingDefPtr ssa_unfiltered_cfg::SSA_UnfilteredCfg::getDefinitionForUse ( SgVarRefExp * astNode ) const

Given a use obtained through getUsesAtNode, resolve its corresponding def.

This function may return NULL for SgVarRef objects not returned by getUsesAtNode

◆ getUseTable()

const ASTNodeToVarRefsMap & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getUseTable ( ) const

Returns the entire use table, mapping each non-statement AST node to the variables used in its execution.

◆ isPrefixOfName()

static bool ssa_unfiltered_cfg::SSA_UnfilteredCfg::isPrefixOfName	(	VarName	name,
		VarName	prefix
	)

static

Find if the given prefix is a prefix of the given name.

This will return whether the given name has the given prefix inside it.

ex. a.b.c has prefix a.b, but not a.c

Parameters

name	The name to search.
prefix	The prefix to search for.

Returns: Whether or not the prefix is in this name.

◆ getUniqueName()

static ssa_private::VarUniqueName * ssa_unfiltered_cfg::SSA_UnfilteredCfg::getUniqueName ( SgNode * node )

static

Get the uniqueName attribute for the given node.

Parameters

node	Node to get the attribute from.

Returns: The attribute, or NULL.

◆ getVarName()

static const VarName & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getVarName ( SgNode * node )

static

Get the variable name of the given node.

Parameters

node	The node to get the name for.

Returns: The name, or empty name.

◆ getVarForExpression()

static const VarName & ssa_unfiltered_cfg::SSA_UnfilteredCfg::getVarForExpression ( SgNode * node )

static

If an expression evaluates to a reference of a variable, returns that variable.

Handles casts, comma ops, address of ops, etc. For example, Given the expression (...., &a), this method would return the VarName for a.

◆ buildVariableReference()

static SgExpression * ssa_unfiltered_cfg::SSA_UnfilteredCfg::buildVariableReference	(	const VarName &	var,
		SgScopeStatement *	scope = `NULL`
	)

static

Get an AST fragment containing the appropriate varRefs and Dot/Arrow ops to access the given variable.

Parameters

var	The variable to construct access for.
scope	The scope within which to construct the access.

Returns: An expression that access the given variable in the given scope.

◆ varnameToString()

static std::string ssa_unfiltered_cfg::SSA_UnfilteredCfg::varnameToString ( const VarName & vec )

static

Get a string representation of a varName.

Parameters

vec	varName to get string for.

Returns: String for given varName.

Member Data Documentation

◆ emptyName

VarName ssa_unfiltered_cfg::SSA_UnfilteredCfg::emptyName

static

Definition at line 203 of file ssaUnfilteredCfg.h.

The documentation for this class was generated from the following file:

ssaUnfilteredCfg.h

Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ VarName

◆ ReachingDefPtr

◆ NodeReachingDefTable

◆ CFGNodeToVarNamesMap

◆ ASTNodeToVarRefsMap

◆ CFGNodeToDefTableMap

Constructor & Destructor Documentation

◆ SSA_UnfilteredCfg()

◆ ~SSA_UnfilteredCfg()

Member Function Documentation

◆ getDebug()

◆ getDebugExtra()

◆ toDOT()

◆ toFilteredDOT()

◆ getReachingDefsAfter() [1/2]

◆ getDefsAtNode()

◆ getReachingDefsBefore()

◆ getReachingDefsAfter() [2/2]

◆ getUsesAtNode()

◆ getDefinitionForUse()

◆ getUseTable()

◆ isPrefixOfName()

◆ getUniqueName()

◆ getVarName()

◆ getVarForExpression()

◆ buildVariableReference()

◆ varnameToString()

Member Data Documentation

◆ emptyName