#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmFunction:

Collaboration diagram for SgAsmFunction:

Classes
class	NodeSelector
	Selection functor for SgAsmFunction::get_extent(). More...

Public Types
enum	MayReturn { RET_UNKNOWN, RET_NEVER, RET_SOMETIMES, RET_ALWAYS }
	Whether a function returns. More...

enum	FunctionReason { FUNC_NONE = 0x00000000, FUNC_ENTRY_POINT = 0x00010000, FUNC_CALL_TARGET = 0x00020000, FUNC_CALL_INSN = 0x00040000, FUNC_EH_FRAME = 0x00080000, FUNC_SYMBOL = 0x00100000, FUNC_PATTERN = 0x00200000, FUNC_GRAPH = 0x00400000, FUNC_USERDEF = 0x00800000, FUNC_PADDING = 0x01000000, FUNC_DISCONT = 0x02000000, FUNC_INSNHEAD = 0x04000000, FUNC_IMPORT = 0x08000000, FUNC_LEFTOVERS = 0x10000000, FUNC_INTRABLOCK = 0x20000000, FUNC_THUNK = 0x40000000, FUNC_EXPORT = 0x80000000, FUNC_DEFAULT = 0xefff00ff, FUNC_MISCMASK = 0x000000ff, FUNC_INTERPADFUNC = 0x00000001 }
	Reasons why an instruction might be considered the beginning of a function. More...

enum	function_kind_enum { e_unknown = 0, e_standard = 1, e_library = 2, e_imported = 3, e_thunk = 4, e_last }
	enum declaration as specified in proposed Sabre database schema More...

enum	function_calling_convention_enum { e_unknown_call = 0, e_std_call = 1, e_fast_call = 2, e_cdecl_call = 3, e_this_call = 4, e_last_call }
	enum declaration to specify type of calling convention used. More...

enum	{ static_variant = V_SgAsmFunction }
	static variant value More...

typedef SgAsmSynthesizedDeclaration	base_node_type

Public Types inherited from SgAsmSynthesizedDeclaration
enum	{ static_variant = V_SgAsmSynthesizedDeclaration }
	static variant value More...

typedef SgAsmStatement	base_node_type

Public Types inherited from SgAsmStatement
enum	{ static_variant = V_SgAsmStatement }
	static variant value More...

typedef SgAsmNode	base_node_type

Public Types inherited from SgAsmNode
enum	{ static_variant = V_SgAsmNode }
	static variant value More...

typedef SgNode	base_node_type

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

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

int	nrOfValidInstructions (std::vector< SgNode * > &succs)

void	append_statement (SgAsmStatement *statement)

void	remove_statement (SgAsmStatement *statement)

void	append_dest (SgAsmStatement *instruction)

void	remove_children ()

SgAsmBlock *	get_entry_block () const
	Function entry basic block. More...

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

size_t	get_extent (ExtentMap emap=NULL, rose_addr_t lo_addr=NULL, rose_addr_t hi_addr=NULL, NodeSelector selector=NULL)
	Returns info about what addresses a function occupies. More...

bool	get_sha1 (uint8_t digest[20], NodeSelector *selector=NULL)
	Computes the SHA1 message digest for the bytes of a function. More...

function_calling_convention_enum	get_functionCallingConvention () const
	Computes the calling convention used in this function (used to score properly formed functions). More...

int	get_stackNutralityMetric () const
	Computes the offset of the stack at the end of the call relative the the start of the call (in a perfect function this would be zero, this is used to score properly formed functions). More...

int	get_numberOfPathsNotReturningMetric () const
	Computes the number of paths determined to no return (all paths returning metric) More...

virtual std::string	class_name () const
	Compute the percentage of coverage based on the length of blocks in this disassembled function (in bytes) compared to the size of the address range of the top of the first block in memory to the end of the last block in memory. 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 More...

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

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

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

virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION

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

virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...

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

	SgAsmFunction (const SgAsmFunctionStorageClass &source)

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

std::string	get_name () const

void	set_name (std::string name)

unsigned	get_reason () const

void	set_reason (unsigned reason)

SgAsmFunction::function_kind_enum	get_function_kind () const

void	set_function_kind (SgAsmFunction::function_kind_enum function_kind)

SgAsmFunction::MayReturn	get_may_return () const

void	set_may_return (SgAsmFunction::MayReturn may_return)

std::string	get_name_md5 () const

void	set_name_md5 (std::string name_md5)

const SgAsmStatementPtrList &	get_statementList () const

SgAsmStatementPtrList &	get_statementList ()

SgAsmStatementPtrList	get_dest () const

void	set_dest (SgAsmStatementPtrList dest)

rose_addr_t	get_entry_va () const

void	set_entry_va (rose_addr_t entry_va)

SgSymbolTable *	get_symbol_table () const

void	set_symbol_table (SgSymbolTable *symbol_table)

size_t	get_cached_vertex () const

void	set_cached_vertex (size_t cached_vertex)

virtual	~SgAsmFunction ()

	SgAsmFunction (rose_addr_t address=0, std::string name="", unsigned reason=SgAsmFunction::FUNC_NONE, SgAsmFunction::function_kind_enum function_kind=SgAsmFunction::e_unknown)

Public Member Functions inherited from SgAsmSynthesizedDeclaration
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

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

void	operator delete (void *pointer)

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

	SgAsmSynthesizedDeclaration (const SgAsmSynthesizedDeclarationStorageClass &source)

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

virtual	~SgAsmSynthesizedDeclaration ()

	SgAsmSynthesizedDeclaration (rose_addr_t address=0)

Public Member Functions inherited from SgAsmStatement
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

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

void	operator delete (void *pointer)

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

	SgAsmStatement (const SgAsmStatementStorageClass &source)

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

rose_addr_t	get_address () const

void	set_address (rose_addr_t address)

std::string	get_comment () const

void	set_comment (std::string comment)

virtual	~SgAsmStatement ()

	SgAsmStatement (rose_addr_t address=0)

Public Member Functions inherited from SgAsmNode
	SgAsmNode (const SgAsmNode &X)

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

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

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

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

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

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

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

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

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

void	operator delete (void *pointer)

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

	SgAsmNode (const SgAsmNodeStorageClass &source)

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

AttachedPreprocessingInfoType *	get_attachedPreprocessingInfoPtr () const

void	set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)

AstAttributeMechanism *	get_asmAttributeMechanism () const

void	set_asmAttributeMechanism (AstAttributeMechanism *asmAttributeMechanism)

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

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

virtual	~SgAsmNode ()

	SgAsmNode ()

Public Member Functions inherited from SgNode
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

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

void	operator delete (void *pointer)

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

	SgNode (const SgNodeStorageClass &source)

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

bool	get_isModified () const
	Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. 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...

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

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

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

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). More...

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). More...

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static std::string	reason_key (const std::string &prefix="")
	Returns a very short string describing the reason mask. More...

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

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

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

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

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

Static Public Member Functions inherited from SgAsmSynthesizedDeclaration
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

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

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

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

Static Public Member Functions inherited from SgAsmStatement
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

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

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

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

Static Public Member Functions inherited from SgAsmNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

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

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

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

Static Public Member Functions inherited from SgNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

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

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

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

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

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

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::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. More...

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

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

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

Protected Attributes
std::string	p_name

unsigned	p_reason

SgAsmFunction::function_kind_enum	p_function_kind

SgAsmFunction::MayReturn	p_may_return

std::string	p_name_md5

SgAsmStatementPtrList	p_statementList

SgAsmStatementPtrList	p_dest

rose_addr_t	p_entry_va

SgSymbolTable *	p_symbol_table

size_t	p_cached_vertex

Friends
class	AST_FILE_IO

class	SgAsmFunctionStorageClass

class	AstSpecificDataManagingClass

class	AstSpecificDataManagingClassStorageClass

ROSE_DLL_API friend SgAsmFunction *	isSgAsmFunction (SgNode *s)
	Casts pointer from base class to derived class. More...

ROSE_DLL_API friend const SgAsmFunction *	isSgAsmFunction (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers) More...

SgAsmFunction *	SgAsmFunction_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O Mechanism. More...

unsigned long	SgAsmFunction_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool. More...

void	SgAsmFunction_clearMemoryPool ()

void	SgAsmFunction_extendMemoryPoolForFileIO (unsigned long)

void	SgAsmFunction_getNextValidPointer (std::pair< SgAsmFunction , std::vector< unsigned char >::const_iterator > &)

void	SgAsmFunction_resetValidFreepointers ()

Additional Inherited Members
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. More...

Static Protected Attributes inherited from SgNode
static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types. More...

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

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

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

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

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

Detailed Description

Definition at line 253526 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgAsmSynthesizedDeclaration SgAsmFunction::base_node_type

Definition at line 254034 of file Cxx_Grammar.h.

Member Enumeration Documentation

enum SgAsmFunction::MayReturn

Whether a function returns.

Enumerator
RET_UNKNOWN	It is unknown whether this function ever returns or not.
RET_NEVER	This function is known to never return.
RET_SOMETIMES	This function may return or not, depending on how it is called.
RET_ALWAYS	This function returns each time it is called.

Definition at line 253546 of file Cxx_Grammar.h.

enum SgAsmFunction::FunctionReason

Reasons why an instruction might be considered the beginning of a function.

These bit flags are also used by the instruction partitioner (Partitioner class) to determine what heuristics are used when partitioning instructions into functions.

Enumerator
FUNC_NONE	Used for initialization; not a bit flag.
FUNC_ENTRY_POINT	An entry point specified in the file header.
FUNC_CALL_TARGET	Target of a function call instruction sequence in the CFG. When used as a partitioning heuristic, the partitioner will create new functions when it discovers a call-like sequence while traversing the CFG.
FUNC_CALL_INSN	Target of call, possibly not in the CFG (see Partitioner::mark_call_insns). When used as a partitioning heuristic, the partitioner will search all available instructions for instances of call-like instructions and define a function for each target. The function entry points added in this way become initial nodes of the CFG which is used by some of the other function discovery methods, including FUNC_CALL_TARGET.
FUNC_EH_FRAME	Address mentioned in the ELF .eh_frame section.
FUNC_SYMBOL	Address of a function symbol in a symbol table.
FUNC_PATTERN	Appears to be a function based on pattern of instructions. When used as a partitioning heuristic, the partitioner will search through all available instructions and create function entry points. The function entry points are added to the CFG which is used by some of the other function discovery methods.
FUNC_GRAPH	Implied by inter-basicblock branching. When used as a partitioning heuristic, the partitioner creates a new function when it discovers, by CFG traversal, that two different functions branch to a common basic block. The block in common becomes a new function under this rule.
FUNC_USERDEF	User-defined algorithm. See Partitioner::addFunctionDetector().
FUNC_PADDING	Created to represent NOP padding between other functions. When used as a partitioning heuristic, the partitioner searches for padding after all CFG-based analysis has completed. Padding can consist of either NOP instructions or zero bytes. The former requires that instructions at the interfunction addresses have been disassembled.
FUNC_DISCONT	Blocks of function are not contiguous in memory. This is not a partitioner heuristic, but rather only an indication of whether the function's basic blocks occupy contiguous memory locations.
FUNC_INSNHEAD	Initial instructions not in any other function. (UNUSED?)
FUNC_IMPORT	Functions dynamically linked. For ELF containers, these are the entries in the procedure lookup table (PLT). When used as a partitioning heuristic, the partitioner will scan the PLT and define a function for each entry.
FUNC_LEFTOVERS	Generated function to hold blocks that are otherwise not part of any function. If this bit is turned off then the instruction Partitioner will delete instructions that it couldn't assign to a function.
FUNC_INTRABLOCK	Function contains basic blocks that were inserted by searching the address space between the blocks discovered by analyzing the control flow. Blocks added by this algorithm do not take control flow into account, and therefore, the global control flow graph (CFG) may have edges into the middle of such blocks, or such blocks may have edges into the middle of other blocks, including inter-function edges. Also, blocks added by this method might not represent true instructions, but rather data that was disassembled as instructions.
FUNC_THUNK	Function is a thunk. Thunks are small pieces of code whose only purpose is to branch to another function. Depending on how the disassembler and partitioner are run, a thunk can exist either as its own function or the thunk's instructions will be subsumed by the called function. The partitioner only sets this flag for functions that are created due to the thunk recognition pass; other functions that don't have this bit set might also be thunks, and functions that have this bit set might not be a thunk. The Partitioner::is_thunk() method will return true for functions whose content looks like a thunk.
FUNC_EXPORT	Exported function. These are the functions that appear in a PE export table.
FUNC_DEFAULT	Default value for Partitioner class.
FUNC_MISCMASK	Miscellaneous. These are all the other special purpose function detectors that are implemented in the Partitioner. Each one is identified by an eight-bit integer stored in the low order bits. Only one such reason can be stored at a time. These are not used to control which partitioning heuristics to use, but rather to indicate which one (of possibly many) that detected the function.
FUNC_INTERPADFUNC	Detected by Partitioner::FindInterPadFunctions, which looks for unassigned space between two inter-function padding blocks and makes the first such address the beginning of one of these functions.

Definition at line 253556 of file Cxx_Grammar.h.

enum SgAsmFunction::function_kind_enum

enum declaration as specified in proposed Sabre database schema

Enumerator
e_unknown
e_standard
e_library
e_imported
e_thunk
e_last

Definition at line 253659 of file Cxx_Grammar.h.

enum SgAsmFunction::function_calling_convention_enum

enum declaration to specify type of calling convention used.

Enumerator
e_unknown_call
e_std_call
e_fast_call
e_cdecl_call
e_this_call
e_last_call

Definition at line 253669 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 253722 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgAsmFunction::SgAsmFunction ( const SgAsmFunctionStorageClass & source)

virtual SgAsmFunction::~SgAsmFunction ( )

virtual

SgAsmFunction::SgAsmFunction	(	rose_addr_t	address = `0`,
		std::string	name = `""`,
		unsigned	reason = `SgAsmFunction::FUNC_NONE`,
		SgAsmFunction::function_kind_enum	function_kind = `SgAsmFunction::e_unknown`
	)

Member Function Documentation

virtual SgNode* SgAsmFunction::copy ( SgCopyHelp & help) const

virtual

This function clones the current IR node object recursively or not, depending on the argument.

This function performs a copy based on the specification of the input parameter. The input parameter is used to determin which data members are copied by reference and which are copied by value.

Parameters

help	- If this argument is of type SgTreeCopy, then the IR node is cloned recursively. If its of type SgShallowCopy only the first level of the IR node is copied, everything else is left pointing to the the original IR node's object's data members.

Returns: a pointer to the new clone.

It appears the the copy functions don't set the parents of anything that they do a deep copy of! This can cause AST tests to fail. In particular some functions that require the parent pointers to be valid will return NULL pointers (e.g. SgInitializedName::get_declaration()). It might be that we should allow this to be done as part of the SgCopyHelp::clone function or perhaps another member function of SgCopyHelp would be useful for this support. It is not serious if the AST post processing is done since that will set any NULL pointers that are found within its traversal.

Exceptions

none	No exceptions are thrown by this function.

Reimplemented from SgAsmSynthesizedDeclaration.

int SgAsmFunction::nrOfValidInstructions ( std::vector< SgNode * > & succs)

void SgAsmFunction::append_statement ( SgAsmStatement * statement)

void SgAsmFunction::remove_statement ( SgAsmStatement * statement)

void SgAsmFunction::append_dest ( SgAsmStatement * instruction)

void SgAsmFunction::remove_children ( )

SgAsmBlock * SgAsmFunction::get_entry_block ( ) const

Function entry basic block.

Returns the basic block that represents the function entry point. Returns null for a function that contains no instructions (e.g., has only static data blocks).

Definition at line 244 of file SgAsmFunction.C.

References SgAsmStatement::get_address(), and isSgAsmBlock().

std::string SgAsmFunction::reason_key ( const std::string & prefix = "")

static

Returns a very short string describing the reason mask.

Returns a multi-line string describing the letters used for function reasons.

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

Definition at line 17 of file SgAsmFunction.C.

Referenced by Partitioner::pre_cfg().

std::string SgAsmFunction::reason_str ( bool do_pad) const

Returns reason string for this function.

Definition at line 33 of file SgAsmFunction.C.

Referenced by Partitioner::analyze_cfg(), Partitioner::discover_first_block(), and Partitioner::merge_function_fragments().

std::string SgAsmFunction::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 SgAsmFunction::FunctionReason bits.

Definition at line 41 of file SgAsmFunction.C.

References StringUtility::add_to_reason_string(), and rose::stringifySgAsmFunctionFunctionReason().

size_t SgAsmFunction::get_extent	(	ExtentMap *	extents = `NULL`,
		rose_addr_t *	lo_addr = `NULL`,
		rose_addr_t *	hi_addr = `NULL`,
		NodeSelector *	selector = `NULL`
	)

Returns info about what addresses a function occupies.

Returns information about the function addresses.

Every non-empty function has a minimum (inclusive) and maximum (exclusive) address which are returned by reference, but not all functions own all the bytes within that range of addresses. Therefore, the exact bytes are returned by adding them to the optional ExtentMap argument. This function returns the number of nodes (instructions and static data items) in the function. If the function contains no nodes then the extent map is not modified and the low and high addresses are both set to zero.

If an selector functor is provided, then only nodes for which it returns true are considered part of the function. This can be used for such things as filtering out data blocks that are marked as padding. For example:

class NotPadding: public SgAsmFunction::NodeSelector {
public:
    virtual bool operator()(SgNode *node) {
        SgAsmStaticData *data = isSgAsmStaticData(node);
        SgAsmBlock *block = SageInterface::getEnclosingNode<SgAsmBlock>(data);
        return !data || !block || block->get_reason()!=SgAsmBlock::BLK_PADDING;
    }
} notPadding;
ExtentMap extents;
function->get_extent(&extents, NULL, NULL, &notPadding);

Here's another example that calculates the extent of only the padding data, based on the negation of the filter in the previous example:

class OnlyPadding: public NotPadding {
public:
    virtual bool operator()(SgNode *node) {
        return !NotPadding::operator()(node);
    }
} onlyPadding;
ExtentMap extents;
function->get_extent(&extents, NULL, NULL, &onlyPadding);

Definition at line 148 of file SgAsmFunction.C.

References SgAsmStatement::get_address(), SgAsmInstruction::get_size(), SgAsmStaticData::get_size(), RangeMap< R, T >::insert(), isSgAsmInstruction(), isSgAsmStaticData(), max, and preorder.

bool SgAsmFunction::get_sha1	(	uint8_t	digest[20],
		NodeSelector *	selector = `NULL`
	)

Computes the SHA1 message digest for the bytes of a function.

Returns true if the SHA1 is available, false if the message digest cannot be computed because the prerequisite gcrypt functions are not available. The optional selector argument can be used to limit the digest to only certain nodes of the function; by default, all instructions and static data are accumulated.

Definition at line 198 of file SgAsmFunction.C.

References SgAsmInstruction::get_raw_bytes(), SgAsmStaticData::get_raw_bytes(), isSgAsmInstruction(), isSgAsmStaticData(), and preorder.

function_calling_convention_enum SgAsmFunction::get_functionCallingConvention ( ) const

Computes the calling convention used in this function (used to score properly formed functions).

int SgAsmFunction::get_stackNutralityMetric ( ) const

Computes the offset of the stack at the end of the call relative the the start of the call (in a perfect function this would be zero, this is used to score properly formed functions).

int SgAsmFunction::get_numberOfPathsNotReturningMetric ( ) const

Computes the number of paths determined to no return (all paths returning metric)

virtual std::string SgAsmFunction::class_name ( ) const

virtual

Compute the percentage of coverage based on the length of blocks in this disassembled function (in bytes) compared to the size of the address range of the top of the first block in memory to the end of the last block in memory.

Copies AST (whole subtree, depending on the SgCopyHelp class

returns a string representing the class name

Reimplemented from SgAsmSynthesizedDeclaration.

virtual VariantT SgAsmFunction::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgAsmSynthesizedDeclaration.

void* SgAsmFunction::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgAsmFunction::operator delete ( void * pointer)

static size_t SgAsmFunction::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgAsmFunction::memoryUsage ( )

static

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

virtual std::vector<SgNode*> SgAsmFunction::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 SgAsmSynthesizedDeclaration.

virtual std::vector<std::string> SgAsmFunction::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 SgAsmSynthesizedDeclaration.

virtual size_t SgAsmFunction::get_numberOfTraversalSuccessors ( )

virtual

Reimplemented from SgAsmSynthesizedDeclaration.

virtual SgNode* SgAsmFunction::get_traversalSuccessorByIndex ( size_t idx)

virtual

Reimplemented from SgAsmSynthesizedDeclaration.

virtual size_t SgAsmFunction::get_childIndex ( SgNode * child)

virtual

Reimplemented from SgAsmSynthesizedDeclaration.

virtual RTIReturnType SgAsmFunction::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 SgAsmSynthesizedDeclaration.

virtual const char* SgAsmFunction::sage_class_name ( ) const

virtual

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

Reimplemented from SgAsmSynthesizedDeclaration.

void SgAsmFunction::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgAsmFunction::accept ( ROSE_VisitorPattern & visitor)

virtual

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

Reimplemented from SgAsmSynthesizedDeclaration.

static void SgAsmFunction::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmFunction::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmFunction::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgAsmFunction::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 SgAsmSynthesizedDeclaration.

virtual void SgAsmFunction::checkDataMemberPointersIfInMemoryPool ( )

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

virtual std::vector<std::pair<SgNode*,std::string> > SgAsmFunction::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 SgAsmSynthesizedDeclaration.

virtual void SgAsmFunction::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 SgAsmSynthesizedDeclaration.

virtual long SgAsmFunction::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 SgAsmSynthesizedDeclaration.

SgAsmFunction* SgAsmFunction::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.

std::string SgAsmFunction::get_name ( ) const

Referenced by SgAsmIntegerValueExpression::get_label().

void SgAsmFunction::set_name ( std::string name)

Referenced by Partitioner::build_ast().

unsigned SgAsmFunction::get_reason ( ) const

void SgAsmFunction::set_reason ( unsigned reason)

Referenced by Partitioner::build_ast().

SgAsmFunction::function_kind_enum SgAsmFunction::get_function_kind ( ) const

void SgAsmFunction::set_function_kind ( SgAsmFunction::function_kind_enum function_kind)

SgAsmFunction::MayReturn SgAsmFunction::get_may_return ( ) const

void SgAsmFunction::set_may_return ( SgAsmFunction::MayReturn may_return)

Referenced by Partitioner::build_ast().

std::string SgAsmFunction::get_name_md5 ( ) const

void SgAsmFunction::set_name_md5 ( std::string name_md5)

const SgAsmStatementPtrList& SgAsmFunction::get_statementList ( ) const

Referenced by Partitioner::build_ast().

SgAsmStatementPtrList& SgAsmFunction::get_statementList ( )

SgAsmStatementPtrList SgAsmFunction::get_dest ( ) const

void SgAsmFunction::set_dest ( SgAsmStatementPtrList dest)

rose_addr_t SgAsmFunction::get_entry_va ( ) const

Referenced by Partitioner::fixup_pointers(), SgAsmBlock::is_function_call(), SgAsmx86Instruction::is_function_call(), and SgAsmIntegerValueExpression::virtual_address().

void SgAsmFunction::set_entry_va ( rose_addr_t entry_va)

Referenced by Partitioner::build_ast().

SgSymbolTable* SgAsmFunction::get_symbol_table ( ) const

void SgAsmFunction::set_symbol_table ( SgSymbolTable * symbol_table)

size_t SgAsmFunction::get_cached_vertex ( ) const

void SgAsmFunction::set_cached_vertex ( size_t cached_vertex)

Friends And Related Function Documentation

friend class AST_FILE_IO

friend

Definition at line 253993 of file Cxx_Grammar.h.

friend class SgAsmFunctionStorageClass

friend

Definition at line 253994 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 253995 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 253996 of file Cxx_Grammar.h.

ROSE_DLL_API friend SgAsmFunction* isSgAsmFunction ( SgNode * s)

friend

Casts pointer from base class to derived class.

ROSE_DLL_API friend const SgAsmFunction* isSgAsmFunction ( const SgNode * s)

friend

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

SgAsmFunction* SgAsmFunction_getPointerFromGlobalIndex ( unsigned long globalIndex)

friend

Constructor for use by AST File I/O Mechanism.

This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory which obtained via fast binary file I/O from disk.

Typedef 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 SgAsmFunction_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 SgAsmFunction_clearMemoryPool ( )

friend

void SgAsmFunction_extendMemoryPoolForFileIO ( unsigned long)

friend

void SgAsmFunction_getNextValidPointer ( std::pair< SgAsmFunction *, std::vector< unsigned char * >::const_iterator > & )

friend

void SgAsmFunction_resetValidFreepointers ( )

friend

Member Data Documentation

std::string SgAsmFunction::p_name

protected

Definition at line 254089 of file Cxx_Grammar.h.

unsigned SgAsmFunction::p_reason

protected

Definition at line 254093 of file Cxx_Grammar.h.

SgAsmFunction::function_kind_enum SgAsmFunction::p_function_kind

protected

Definition at line 254097 of file Cxx_Grammar.h.

SgAsmFunction::MayReturn SgAsmFunction::p_may_return

protected

Definition at line 254101 of file Cxx_Grammar.h.

std::string SgAsmFunction::p_name_md5

protected

Definition at line 254105 of file Cxx_Grammar.h.

SgAsmStatementPtrList SgAsmFunction::p_statementList

protected

Definition at line 254109 of file Cxx_Grammar.h.

SgAsmStatementPtrList SgAsmFunction::p_dest

protected

Definition at line 254113 of file Cxx_Grammar.h.

rose_addr_t SgAsmFunction::p_entry_va

protected

Definition at line 254117 of file Cxx_Grammar.h.

SgSymbolTable* SgAsmFunction::p_symbol_table

protected

Definition at line 254121 of file Cxx_Grammar.h.

size_t SgAsmFunction::p_cached_vertex

protected

Definition at line 254125 of file Cxx_Grammar.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation