Description

Instruction basic block.

A SgAsmBlock usually represents a sequence of instructions. It's also used for grouping other things such as functions. A SgAsmBlock represents a basic block if and only if it has at least one descendant of type SgAsmInstruction and it has no descendants of type SgAsmBlock.

In the absence of interrupt handling, the instructions of a basic block are executed entirely. In the absense of multi-threading, no other instructions intervene.

The instructions of a basic block need not be contiguous in virtual memory. They also do not need to be at increasing virtual addresses.

If the basic block has a parent pointer, then the closest SgAsmFunction ancestor is the one to which this basic block belongs. In the Partitioner API, a basic block can be owned by more than one function.

An AST may have multiple SgAsmBlock objects that represent the same basic block. This happens when a single block belongs to more than one function.

See also, Rose::BinaryAnalysis::Partitioner2::BasicBlock, which represents a basic block outside the AST.

Definition at line 36871 of file binaryInstruction.C.

Inheritance diagram for SgAsmBlock:

[legend]

Collaboration diagram for SgAsmBlock:

[legend]

Public Types
enum	Reason { BLK_NONE = 0x00000000, BLK_ENTRY_POINT = 0x00010000, BLK_PADDING = 0x00020000, BLK_FRAGMENT = 0x00080000, BLK_CFGHEAD = 0x00100000, BLK_USERDEF = 0x00200000, BLK_LEFTOVERS = 0x00400000, BLK_JUMPTABLE = 0x00800000, BLK_GRAPH1 = 0x01000000, BLK_GRAPH2 = 0x02000000, BLK_GRAPH3 = 0x04000000, BLK_DEFAULT = BLK_NONE, BLK_MISCMASK = 0x000000ff, BLK_FINDDATA = 0x00000001, BLK_POSTFUNC = 0x00000002 }
	Reasons why a basic block might have been assigned to a function. More...

Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value

Public Member Functions
void	append_statement (SgAsmStatement *)
	Add the specified statement to the end of the statement list. More...

void	remove_statement (SgAsmStatement *)
	Erase the specified statement. More...

void	remove_children ()
	Removes all statements from the block. More...

rose_addr_t	get_fallthrough_va ()
	Fall-through virtual address. More...

SgAsmFunction *	get_enclosing_function () const
	Returns the function that owns this block. More...

bool	has_instructions () const
	Determins if a block contains instructions. More...

bool	is_basic_block () const
	Determine if a block contains instructions. More...

bool	is_function_call (rose_addr_t &target_va, rose_addr_t &return_va)
	Returns true if basic block appears to be a function call. More...

std::string	reason_str (bool pad) const
	Returns reason string for this block. More...

virtual	~SgAsmBlock ()
	Destructor. More...

	SgAsmBlock ()
	Default constructor. More...

	SgAsmBlock (rose_addr_t const &address)
	Constructor. More...


rose_addr_t const &	get_id () const
	Property: Identification. More...

void	set_id (rose_addr_t const &)
	Property: Identification. More...


unsigned const &	get_reason () const
	Property: Reasons this block was created. More...

void	set_reason (unsigned const &)
	Property: Reasons this block was created. More...


SgAsmStatementPtrList const &	get_statementList () const
	Property: Statements of which this block is composed. More...

SgAsmStatementPtrList &	get_statementList ()
	Property: Statements of which this block is composed. More...

void	set_statementList (SgAsmStatementPtrList const &)
	Property: Statements of which this block is composed. More...


SgAsmIntegerValuePtrList const &	get_successors () const
	Property: Control flow successors. More...

SgAsmIntegerValuePtrList &	get_successors ()
	Property: Control flow successors. More...

void	set_successors (SgAsmIntegerValuePtrList const &)
	Property: Control flow successors. More...


bool const &	get_successors_complete () const
	Property: Whether the successors list is complete. More...

void	set_successors_complete (bool const &)
	Property: Whether the successors list is complete. More...


SgAsmBlock *const &	get_immediate_dominator () const
	Property: Holds the immediate dominator block in the control flow graph. More...

void	set_immediate_dominator (SgAsmBlock *const &)
	Property: Holds the immediate dominator block in the control flow graph. More...


size_t const &	get_cached_vertex () const
	Property: Cached vertex for control flow graphs. More...

void	set_cached_vertex (size_t const &)
	Property: Cached vertex for control flow graphs. More...


double const &	get_code_likelihood () const
	Property: Likelihood that this block represents real instructions. More...

void	set_code_likelihood (double const &)
	Property: Likelihood that this block represents real instructions. More...


int64_t const &	get_stackDeltaOut () const
	Property: Stack pointer at block exit w.r.t. More...

void	set_stackDeltaOut (int64_t const &)
	Property: Stack pointer at block exit w.r.t. More...

Public Member Functions inherited from SgAsmStatement
virtual	~SgAsmStatement ()
	Destructor. More...

rose_addr_t const &	get_address () const
	Property: Starting virtual address. More...

void	set_address (rose_addr_t const &)
	Property: Starting virtual address. More...

std::string const &	get_comment () const
	Property: Commentary.

void	set_comment (std::string const &)
	Property: Commentary.

Public Member Functions inherited from SgAsmNode
virtual	~SgAsmNode ()
	Destructor. More...

Sawyer::Attribute::Storage const &	attributes () const
	Attribute storage. More...

Sawyer::Attribute::Storage &	attributes ()
	Attribute storage. More...

Public Member Functions inherited from SgNode
virtual SgNode *	copy (SgCopyHelp &help) const
	This function clones the current IR node object recursively or not, depending on the argument. More...

virtual std::string	class_name () const
	returns a string representing the class name More...

virtual VariantT	variantT () const
	returns new style SageIII enum values More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse)

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation More...

virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation More...

virtual size_t	get_numberOfTraversalSuccessors ()
	return number of children in the traversal successor list

virtual SgNode *	get_traversalSuccessorByIndex (size_t idx)
	index-based access to traversal successors by index number

virtual size_t	get_childIndex (SgNode *child)
	index-based access to traversal successors by child node

virtual RTIReturnType	roseRTI ()
	return C++ Runtime-Time-Information More...

virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION
	generates string representing the class name: (e.g. for SgNode returns "SgNode"). More...

void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.

virtual void	accept (ROSE_VisitorPattern &visitor)
	support for the classic visitor pattern done in GoF

virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual std::vector< std::pair< SgNode *, std::string > >	returnDataMemberPointers () const
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...

virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...

virtual long	getChildIndex (SgNode *childNode) const
	FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...

	SgNode (const SgNodeStorageClass &source)
	IR node constructor to support AST File I/O.

SgNode *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...

void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST. More...

void	set_containsTransformation (bool containsTransformation)
	Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. More...

bool	get_isModified () const
	Acess function for isModified flag. More...

bool	get_containsTransformation () const
	Acess function for containsTransformation flag. More...

void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node. More...

SgNode *	get_parent () const
	Access function for parent node. More...

SgNode *	get_raw_parent () const
	Access function for direct access to uncomputed value of parent node.

bool	isChild (SgNode *node) const
	Query function for if the input IR nodes is a child of the current IR node.

virtual std::string	unparseToString (SgUnparse_Info *info) const
	This function unparses the AST node (excluding comments and unnecessary white space)

std::string	unparseToString () const

std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space) More...

int	variant () const ROSE_DEPRECATED_FUNCTION
	Older version function returns enum value "NODE". More...

virtual void	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string.

virtual AstAttribute *	getAttribute (std::string s) const
	Returns attribute of name 's'.

virtual void	updateAttribute (std::string s, AstAttribute *a)
	Replace existing attribute of name 's' with new AstAttribute.

virtual void	setAttribute (std::string s, AstAttribute *a)
	This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called.

virtual void	removeAttribute (std::string s)
	Remove attribute of name 's' if present.

virtual bool	attributeExists (std::string s) const
	Tests if attribute of name 's' is present.

virtual int	numberOfAttributes () const
	Returns the number of attributes on this IR node.

virtual AstAttributeMechanism *	get_attributeMechanism () const
	FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...

virtual void	set_attributeMechanism (AstAttributeMechanism *a)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...

virtual void	fixupCopy (SgNode *copy, SgCopyHelp &help) const

virtual Sg_File_Info *	get_file_info (void) const
	File information containing filename, line number, column number, and if the SgNode is a part of a new transformation, etc.

virtual Sg_File_Info *	get_startOfConstruct (void) const
	New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword).

virtual Sg_File_Info *	get_endOfConstruct (void) const
	New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).

VirtualCFG::CFGNode	cfgForBeginning ()
	Returns the CFG node for just before this AST node.

VirtualCFG::CFGNode	cfgForEnd ()
	Returns the CFG node for just after this AST node.

virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct.

virtual bool	cfgIsIndexInteresting (unsigned int index) const
	Determine whether a particular CFG node index is "interesting" for this kind of node.

virtual unsigned int	cfgFindChildIndex (SgNode *n)
	Find the index of n in this node's CFG children.

virtual unsigned int	cfgFindNextChildIndex (SgNode *n)
	Find the index just after n in this node's CFG children.

virtual std::vector< VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index=false)
	Find the out edges of a CFG node – internal version.

virtual std::vector< VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index=false)
	Find the in edges of a CFG node – internal version.

int	numberOfNodesInSubtree ()
	Computes the number of nodes in the defined subtree of the AST. More...

int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST. More...

template<class T >
T *	initParentPointer (T child, SgNode parent)
	Generated for tree edge data member initializations. More...

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

virtual	~SgNode ()
	This is the destructor. More...

	SgNode ()
	This is the constructor. More...

bool	get_isVisited () const ROSE_DEPRECATED_FUNCTION
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...

void	set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
	Access function for p_isVisited flag used previously by the AST traversals. More...

template<class T >
std::enable_if< std::is_pointer< T >::value, void >::type	changeChildPointer (T &edge, T const &child)
	Set a child edge in a tree to point to a specific child. More...

template<class T >
std::enable_if< !std::is_pointer< T >::value, void >::type	changeChildPointer (T &edge, T const &child)
	Set a child edge in a tree to point to a specific child. More...

Static Public Member Functions
static std::string	reason_key (const std::string &prefix="")
	Multi-line string describing the letters used for basic block reasons. More...

static std::string	reason_str (bool pad, unsigned reason)
	Converts a reason bit vector to a human-friendly string. More...

Static Public Member Functions inherited from SgNode
static void	deleteMemoryPool ()

static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type.

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type.

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal.

static SgNode *	getNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
	Find a node by its variant type, pool index, and item index.

static SgNode *	getNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
	FOR INTERNAL USE Find an SgNode from its memory pool and location therin.

static std::string	getNodeIdString (SgNode *sgnode)
	compute the NodeId for a particular SgNode*.

static std::string	getNodeIdStringInternal (SgNode *sgnode)

static std::vector< std::string >	buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
	Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...

static std::vector< VariantT >	getClassHierarchySubTreeFunction (VariantT v)

static void	getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)

static std::map< SgNode *, std::string > &	get_globalMangledNameMap ()
	Access function for performance optimizing global mangled name map. More...

static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map.

static std::map< std::string, int > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map. More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names). More...

static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names). More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type). More...

static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type). More...

static std::map< SgNode , std::map< SgNode , std::string > > &	get_globalQualifiedNameMapForMapsOfTypes ()
	Access function for name qualification support (for maps of types). More...

static void	set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode , std::map< SgNode , std::string > > &X)
	Access function for name qualification support (for maps of types). More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTemplateHeaders ()
	Access function for name qualification support (for template headers in template declarations). More...

static void	set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for template headers in template declarations). More...

static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types). More...

static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types). More...

static SgFunctionTypeTable *	get_globalFunctionTypeTable ()
	Access function for symbol table specific to function types.

static void	set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
	Access function for symbol table specific to function types.

static SgTypeTable *	get_globalTypeTable ()
	Access function for symbol table specific to non-function types.

static void	set_globalTypeTable (SgTypeTable *globalTypeTable)
	Access function for symbol table specific to non-function types.

static VariantT	variantFromPool (SgNode const *n)

template<class T >
static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type	createAndParent (SgNode *parent)
	Allocate and return a new node after setting its parent. More...

Protected Member Functions
void	initializeProperties ()
	Initialize all properties that have explicit initial values. More...

Protected Member Functions inherited from SgAsmStatement
	SgAsmStatement ()
	Default constructor. More...

	SgAsmStatement (rose_addr_t const &address)
	Constructor. More...

void	initializeProperties ()
	Initialize all properties that have explicit initial values. More...

Protected Member Functions inherited from SgAsmNode
	SgAsmNode ()
	Default constructor. More...

void	initializeProperties ()
	Initialize all properties that have explicit initial values. More...

Protected Member Functions inherited from SgNode
virtual void	post_construction_initialization ()
	Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.

virtual void	destructorHelper ()
	This gets called by all Rosebud-generated destructors. More...

virtual void	debugSerializationBegin (const char *className)
	Called by generated serializers. More...

virtual void	debugSerializationEnd (const char *className)
	Called by generated serializers. More...

Additional Inherited Members
Protected Attributes inherited from SgNode
SgNode *	p_parent
	This is the pointer to the parent IR node in the AST. More...

bool	p_isModified
	Records if IR node has been modified (data members reset). More...

bool	p_containsTransformation

SgNode *	p_freepointer
	This is the pointer to the chain of previously freed objects.

Static Protected Attributes inherited from SgNode
static std::vector< std::tuple< unsigned char *, unsigned, VariantT > >	all_pools

static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types.

static SgTypeTable *	p_globalTypeTable

static std::map< SgNode *, std::string >	p_globalMangledNameMap
	Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization.

static std::map< std::string, int >	p_shortMangledNameCache
	STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates.

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForNames

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTypes

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTemplateHeaders

static std::map< SgNode *, std::string >	p_globalTypeNameMap

static std::map< SgNode , std::map< SgNode , std::string > >	p_globalQualifiedNameMapForMapsOfTypes

Member Enumeration Documentation

enum SgAsmBlock::Reason

Reasons why a basic block might have been assigned to a function.

Enumerator
BLK_NONE	No particular reason. Mostly just for initialization.
BLK_ENTRY_POINT	Block is an entry point for the function.
BLK_PADDING	Block is used for padding.
BLK_FRAGMENT	This block created because it seems to belong to the function although CFG traversal did not find it.
BLK_CFGHEAD	Block serves as an explicit starting point for CFG analysis.
BLK_USERDEF	User says block belongs to the function.
BLK_LEFTOVERS	Block is being assigned to a FUNC_LEFTOVERS function because it could not be assigned to any other function.
BLK_JUMPTABLE	Table of code addresses used by indirect branches.
BLK_GRAPH1	Block was added by the main CFG analysis.
BLK_GRAPH2	Block was added by a second pass of CFG analysis.
BLK_GRAPH3	Block was added by a third pass of CFG analysis.
BLK_MISCMASK	Miscellaneous reasons go here. We can store only one such reason at a time.
BLK_FINDDATA	Added by Partitioner::FindData, which attaches unassigned parts of the disassembly address space to the preceding function.
BLK_POSTFUNC	Added by Partitioner::FindPostFunctionInsns, which adds unassigned instructions to the immediately preceding function.

Definition at line 36956 of file binaryInstruction.C.

Constructor & Destructor Documentation

virtual SgAsmBlock::~SgAsmBlock ( )

virtual

Destructor.

SgAsmBlock::SgAsmBlock ( )

Default constructor.

SgAsmBlock::SgAsmBlock ( rose_addr_t const & address )

explicit

Constructor.

Member Function Documentation

rose_addr_t const& SgAsmBlock::get_id ( ) const

Property: Identification.

Block unique identification number. Not used by ROSE.

void SgAsmBlock::set_id ( rose_addr_t const & )

Property: Identification.

Block unique identification number. Not used by ROSE.

unsigned const& SgAsmBlock::get_reason ( ) const

Property: Reasons this block was created.

This property holds a bit mask of SgAsmBlock::Reason bits that indicate why this block was created.

void SgAsmBlock::set_reason ( unsigned const & )

Property: Reasons this block was created.

This property holds a bit mask of SgAsmBlock::Reason bits that indicate why this block was created.

SgAsmStatementPtrList const& SgAsmBlock::get_statementList ( ) const

Property: Statements of which this block is composed.

This is the list of "statements" that belong to this block. Statements are usually instructions, but historical code may have used basic blocks with other children.

Referenced by Rose::BinaryAnalysis::ControlFlow::explode_blocks().

SgAsmStatementPtrList& SgAsmBlock::get_statementList ( )

Property: Statements of which this block is composed.

This is the list of "statements" that belong to this block. Statements are usually instructions, but historical code may have used basic blocks with other children.

void SgAsmBlock::set_statementList ( SgAsmStatementPtrList const & )

Property: Statements of which this block is composed.

This is the list of "statements" that belong to this block. Statements are usually instructions, but historical code may have used basic blocks with other children.

SgAsmIntegerValuePtrList const& SgAsmBlock::get_successors ( ) const

Property: Control flow successors.

This property holds the list of addresses which are control flow successors of this block. The Partitioner2 name space has a more useful definition of control flow graph that can reference indeterminate addresses and store data in the edges, and which is copiable.

Referenced by Rose::BinaryAnalysis::ControlFlow::apply_to_ast(), Rose::BinaryAnalysis::ControlFlow::build_block_cfg_from_ast(), and Rose::BinaryAnalysis::FunctionCall::build_cg_from_ast().

SgAsmIntegerValuePtrList& SgAsmBlock::get_successors ( )

Property: Control flow successors.

This property holds the list of addresses which are control flow successors of this block. The Partitioner2 name space has a more useful definition of control flow graph that can reference indeterminate addresses and store data in the edges, and which is copiable.

void SgAsmBlock::set_successors ( SgAsmIntegerValuePtrList const & )

Property: Control flow successors.

This property holds the list of addresses which are control flow successors of this block. The Partitioner2 name space has a more useful definition of control flow graph that can reference indeterminate addresses and store data in the edges, and which is copiable.

bool const& SgAsmBlock::get_successors_complete ( ) const

Property: Whether the successors list is complete.

This property is true if the "successors" property holds an incomplete list of successors. Since this representation of a control flow graph is unable to represent edges that point to indeterminate addresses (e.g., computed branches), the "successors_complete" property can be used.