SgAsmBlock Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmBlock:

[legend]Collaboration diagram for SgAsmBlock:


Public Types
typedef SgAsmStatement	base_node_type
	BLK_NONE = 0x00000000
	No particular reason.
	BLK_ENTRY_POINT = 0x00010000
	Block is an entry point for the function.
	BLK_PADDING = 0x00020000
	Block is used for padding.
	BLK_FRAGMENT = 0x00080000
	This block created because it seems to belong to the function although CFG traversal did not find it.
	BLK_CFGHEAD = 0x00100000
	Block serves as an explicit starting point for CFG analysis.
	BLK_USERDEF = 0x00200000
	User says block belongs to the function.
	BLK_LEFTOVERS = 0x00400000
	Block is being assigned to a FUNC_LEFTOVERS function because it could not be assigned to any other function.
	BLK_JUMPTABLE = 0x00800000
	Table of code addresses used by indirect branches.
	BLK_GRAPH1 = 0x01000000
	Block was added by the main CFG analysis.
	BLK_GRAPH2 = 0x02000000
	Block was added by a second pass of CFG analysis.
	BLK_GRAPH3 = 0x04000000
	Block was added by a third pass of CFG analysis.
	BLK_DEFAULT = BLK_NONE
	BLK_MISCMASK = 0x000000ff
	Miscellaneous reasons go here.
	BLK_FINDDATA = 0x00000001
	Added by Partitioner::FindData, which attaches unassigned parts of the disassembly address space to the preceding function.
	BLK_POSTFUNC = 0x00000002
	Added by Partitioner::FindPostFunctionInsns, which adds unassigned instructions to the immediately preceding function.
	static_variant = V_SgAsmBlock
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...
enum	{ static_variant = V_SgAsmBlock }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
void	append_statement (SgAsmStatement *statement)
void	remove_statement (SgAsmStatement *statement)
void	remove_children ()
rose_addr_t	get_fallthrough_va ()
SgAsmFunction *	get_enclosing_function () const
std::string	reason_str (bool pad) const
	Returns reason string for this block.
virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.
virtual VariantT	variantT () const
	returns new style SageIII enum values
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 ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
virtual size_t	get_numberOfTraversalSuccessors ()
virtual SgNode *	get_traversalSuccessorByIndex (size_t idx)
virtual size_t	get_childIndex (SgNode *child)
virtual RTIReturnType	roseRTI ()
	FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.
virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): 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.
virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
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
virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
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.
	SgAsmBlock (const SgAsmBlockStorageClass &source)
SgAsmBlock *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
rose_addr_t	get_next_block_true_address () const
void	set_next_block_true_address (rose_addr_t next_block_true_address)
rose_addr_t	get_next_block_false_address () const
void	set_next_block_false_address (rose_addr_t next_block_false_address)
rose_addr_t	get_id () const
void	set_id (rose_addr_t id)
unsigned	get_reason () const
void	set_reason (unsigned reason)
const SgAsmStatementPtrList &	get_statementList () const
SgAsmStatementPtrList &	get_statementList ()
const SgAsmTargetPtrList &	get_successors () const
SgAsmTargetPtrList &	get_successors ()
bool	get_successors_complete () const
void	set_successors_complete (bool successors_complete)
SgAsmBlock *	get_immediate_dominator () const
void	set_immediate_dominator (SgAsmBlock *immediate_dominator)
size_t	get_cached_vertex () const
void	set_cached_vertex (size_t cached_vertex)
double	get_code_likelihood () const
void	set_code_likelihood (double code_likelihood)
virtual	~SgAsmBlock ()
	SgAsmBlock (rose_addr_t address=0)
Static Public Member Functions
static std::string	reason_key (const std::string &prefix="")
	Returns a very short string describing the reason mask.
static std::string	reason_str (bool pad, unsigned reason)
	Class method that converts a reason bit vector to a human-friendly string.
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.
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.
Protected Attributes
rose_addr_t	p_next_block_true_address
rose_addr_t	p_next_block_false_address
rose_addr_t	p_id
unsigned	p_reason
SgAsmStatementPtrList	p_statementList
SgAsmTargetPtrList	p_successors
bool	p_successors_complete
SgAsmBlock *	p_immediate_dominator
size_t	p_cached_vertex
double	p_code_likelihood
Friends
class	AST_FILE_IO
class	SgAsmBlockStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAsmBlock *	isSgAsmBlock (SgNode *s)
	Casts pointer from base class to derived class.
const SgAsmBlock *	isSgAsmBlock (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAsmBlock *	SgAsmBlock_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.
unsigned long	SgAsmBlock_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAsmBlock_clearMemoryPool ()
void	SgAsmBlock_extendMemoryPoolForFileIO (unsigned long)
void	SgAsmBlock_getNextValidPointer (std::pair< SgAsmBlock , std::vector< unsigned char >::const_iterator > &)
void	SgAsmBlock_resetValidFreepointers ()

Member Typedef Documentation

typedef SgAsmStatement SgAsmBlock::base_node_type

Reimplemented from SgAsmStatement.

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_DEFAULT
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.

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgAsmBlock::SgAsmBlock ( const SgAsmBlockStorageClass & source )

virtual SgAsmBlock::~SgAsmBlock ( ) [virtual]

SgAsmBlock::SgAsmBlock ( rose_addr_t address = 0 )

Member Function Documentation

virtual SgNode* SgAsmBlock::copy ( SgCopyHelp & help ) const [virtual]

Reimplemented from SgAsmStatement.

void SgAsmBlock::append_statement ( SgAsmStatement * statement )

void SgAsmBlock::remove_statement ( SgAsmStatement * statement )

void SgAsmBlock::remove_children ( )

rose_addr_t SgAsmBlock::get_fallthrough_va ( )

SgAsmFunction* SgAsmBlock::get_enclosing_function ( ) const

std::string SgAsmBlock::reason_key ( const std::string & prefix = "" ) [static]

Returns a very short string describing the reason mask.

The letters are returned by the padding version of reason_str().

std::string SgAsmBlock::reason_str ( bool pad ) const

Returns reason string for this block.

std::string SgAsmBlock::reason_str	(	bool	do_pad,
		unsigned	r
	)			`[static]`

Class method that converts a reason bit vector to a human-friendly string.

The second argument is the bit vector of SgAsmBlock::Reason bits. Some of the positions in the padded return value are used for more than one bit. For instance, the first character can be "L" for leftovers, "N" for padding, "E" for entry point, or "-" for none of the above.

virtual std::string SgAsmBlock::class_name ( ) const [virtual]

Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.

Reimplemented from SgAsmStatement.

virtual VariantT SgAsmBlock::variantT ( ) const [virtual]

returns new style SageIII enum values

Reimplemented from SgAsmStatement.

void* SgAsmBlock::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgAsmStatement.

void SgAsmBlock::operator delete	(	void *	pointer,
		size_t	size
	)

deallocated memory for IR node (returns memory to memory pool for reuse)

Reimplemented from SgAsmStatement.

void SgAsmBlock::operator delete ( void * pointer )

Reimplemented from SgAsmStatement.

static size_t SgAsmBlock::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmStatement.

static size_t SgAsmBlock::memoryUsage ( ) [static]

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

Reimplemented from SgAsmStatement.

virtual std::vector<SgNode*> SgAsmBlock::get_traversalSuccessorContainer ( ) [virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Returns:: Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgAsmStatement.

virtual std::vector<std::string> SgAsmBlock::get_traversalSuccessorNamesContainer ( ) [virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns:: Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgAsmStatement.

virtual size_t SgAsmBlock::get_numberOfTraversalSuccessors ( ) [virtual]

Reimplemented from SgAsmStatement.

virtual SgNode* SgAsmBlock::get_traversalSuccessorByIndex ( size_t idx ) [virtual]

Reimplemented from SgAsmStatement.

virtual size_t SgAsmBlock::get_childIndex ( SgNode * child ) [virtual]

Reimplemented from SgAsmStatement.

virtual RTIReturnType SgAsmBlock::roseRTI ( ) [virtual]

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

This function provides runtime type information for accessing the structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns:: Returns a RTIReturnType object (runtime type information).

Reimplemented from SgAsmStatement.

virtual const char* SgAsmBlock::sage_class_name ( ) const [virtual]

returns a C style string (char*) representing the class name

Reimplemented from SgAsmStatement.

void SgAsmBlock::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmStatement.

virtual void SgAsmBlock::accept ( ROSE_VisitorPattern & visitor ) [virtual]

DXN (08/09/2010): support for the classic visitor pattern done in GoF.

Reimplemented from SgAsmStatement.

static void SgAsmBlock::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmStatement.

static void SgAsmBlock::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmStatement.

static void SgAsmBlock::visitRepresentativeNode ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmStatement.

virtual bool SgAsmBlock::isInMemoryPool ( ) [virtual]

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgAsmStatement.

virtual void SgAsmBlock::checkDataMemberPointersIfInMemoryPool ( ) [virtual]

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

Reimplemented from SgAsmStatement.

virtual std::vector<std::pair<SgNode*,std::string> > SgAsmBlock::returnDataMemberPointers ( ) const [virtual]

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Returns:: STL vector of pairs of SgNode* and strings

Reimplemented from SgAsmStatement.

virtual void SgAsmBlock::processDataMemberReferenceToPointers ( ReferenceToPointerHandler * ) [virtual]

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Reimplemented from SgAsmStatement.

virtual long SgAsmBlock::getChildIndex ( SgNode * childNode ) const [virtual]

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).

Warning:: The mapping on children to integer values could change from release to release of ROSE.

Returns:: long

Reimplemented from SgAsmStatement.

SgAsmBlock* SgAsmBlock::addRegExpAttribute	(	std::string	s,
		AstRegExAttribute *	a
	)

Support for AST matching using regular expression.

This support is incomplete and the subject of current research to define RegEx trees to support inexact matching.

Reimplemented from SgAsmStatement.

rose_addr_t SgAsmBlock::get_next_block_true_address ( ) const

void SgAsmBlock::set_next_block_true_address ( rose_addr_t next_block_true_address )

rose_addr_t SgAsmBlock::get_next_block_false_address ( ) const

void SgAsmBlock::set_next_block_false_address ( rose_addr_t next_block_false_address )

rose_addr_t SgAsmBlock::get_id ( ) const

void SgAsmBlock::set_id ( rose_addr_t id )

unsigned SgAsmBlock::get_reason ( ) const

void SgAsmBlock::set_reason ( unsigned reason )

const SgAsmStatementPtrList& SgAsmBlock::get_statementList ( ) const

SgAsmStatementPtrList& SgAsmBlock::get_statementList ( )

const SgAsmTargetPtrList& SgAsmBlock::get_successors ( ) const

SgAsmTargetPtrList& SgAsmBlock::get_successors ( )

bool SgAsmBlock::get_successors_complete ( ) const

void SgAsmBlock::set_successors_complete ( bool successors_complete )

SgAsmBlock* SgAsmBlock::get_immediate_dominator ( ) const

void SgAsmBlock::set_immediate_dominator ( SgAsmBlock * immediate_dominator )

size_t SgAsmBlock::get_cached_vertex ( ) const

void SgAsmBlock::set_cached_vertex ( size_t cached_vertex )

double SgAsmBlock::get_code_likelihood ( ) const

void SgAsmBlock::set_code_likelihood ( double code_likelihood )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmStatement.

friend class SgAsmBlockStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmStatement.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmStatement.

SgAsmBlock* isSgAsmBlock ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

const SgAsmBlock* isSgAsmBlock ( const SgNode * s ) [friend]

Casts pointer from base class to derived class (for const pointers).

SgAsmBlock* SgAsmBlock_getPointerFromGlobalIndex ( unsigned long globalIndex ) [friend]

Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.

unsigned long SgAsmBlock_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned long ) [friend]

Get the size of the memory pool.

It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.

void SgAsmBlock_clearMemoryPool ( ) [friend]