SgAsmExecutableFileFormat Class Reference

Description

Base class for many binary analysis nodes.

Definition at line 42316 of file binaryInstruction.C.

Inheritance diagram for SgAsmExecutableFileFormat:

Collaboration diagram for SgAsmExecutableFileFormat:

Classes
class	FormatError
	Exception for container syntax errors. More...
class	ShortRead
	Exception for reading past the end of something. More...
class	ShortWrite
	Exception for writing past the end of something. More...

Public Types
enum	ExecFamily {   FAMILY_UNSPECIFIED ,   FAMILY_DOS ,   FAMILY_ELF ,   FAMILY_JVM ,   FAMILY_LE ,   FAMILY_LX ,   FAMILY_NE ,   FAMILY_PE }
	Architecture family. More...
enum	ExecABI {   ABI_UNSPECIFIED ,   ABI_OTHER ,   ABI_86OPEN ,   ABI_AIX ,   ABI_ARM ,   ABI_FREEBSD ,   ABI_HPUX ,   ABI_IRIX ,   ABI_HURD ,   ABI_JVM ,   ABI_LINUX ,   ABI_MODESTO ,   ABI_MONTEREY ,   ABI_MSDOS ,   ABI_NT ,   ABI_NETBSD ,   ABI_OS2 ,   ABI_SOLARIS ,   ABI_SYSV ,   ABI_TRU64 ,   ABI_WIN386 }
	Application binary interface. More...
enum	InsSetArchitecture {   ISA_UNSPECIFIED = 0x0000 ,   ISA_OTHER = 0xffff ,   ISA_FAMILY_MASK = 0xff00 ,   ISA_IA32_Family = 0x0100 ,   ISA_IA32_286 = 0x0101 ,   ISA_IA32_386 = 0x0102 ,   ISA_IA32_486 = 0x0103 ,   ISA_IA32_Pentium = 0x0104 ,   ISA_IA32_Cyrix6x86 = 0x0105 ,   ISA_IA32_AMDK5 = 0x0106 ,   ISA_IA32_PentiumPro = 0x0107 ,   ISA_IA32_PentiumII = 0x0108 ,   ISA_IA32_Athlon = 0x0109 ,   ISA_IA32_Pentium4 = 0x010a ,   ISA_IA32_PentiumM = 0x010b ,   ISA_X8664_Family = 0x0200 ,   ISA_X8664_Athlon64 = 0x0201 ,   ISA_X8664_Prescott = 0x0202 ,   ISA_X8664_IntelCore = 0x0203 ,   ISA_X8664_AMDPhenom = 0x0204 ,   ISA_SPARC_Family = 0x0300 ,   ISA_SPARC_V7 = 0x0301 ,   ISA_SPARC_V8 = 0x0302 ,   ISA_SPARC_V8E = 0x0303 ,   ISA_SPARC_V9 = 0x0304 ,   ISA_SPARC_V9JPS1 = 0x0305 ,   ISA_SPARC_V9UA = 0x0306 ,   ISA_SPARC_V9JPS2 = 0x0307 ,   ISA_M68K_Family = 0x0400 ,   ISA_M68K_68000 = 0x0401 ,   ISA_M68K_68EC000 = 0x0402 ,   ISA_M68K_68HC000 = 0x0403 ,   ISA_M68K_68008 = 0x0404 ,   ISA_M68K_68010 = 0x0405 ,   ISA_M68K_68012 = 0x0406 ,   ISA_M68K_68020 = 0x0407 ,   ISA_M68K_68EC020 = 0x0408 ,   ISA_M68K_68030 = 0x0409 ,   ISA_M68K_68EC030 = 0x040a ,   ISA_M68K_68040 = 0x040b ,   ISA_M68K_68EC040 = 0x040c ,   ISA_M68K_68LC040 = 0x040d ,   ISA_M68K_68060 = 0x040e ,   ISA_M68K_ColdFire = 0x040f ,   ISA_M68K_DragonBall = 0x0410 ,   ISA_M88K_Family = 0x0500 ,   ISA_M88K_88100 = 0x0501 ,   ISA_M88K_88110 = 0x0502 ,   ISA_M88K_88110MP = 0x0503 ,   ISA_M88K_88120 = 0x0504 ,   ISA_MIPS_Family = 0x0600 ,   ISA_MIPS_MarkI = 0x0601 ,   ISA_MIPS_MarkII = 0x0602 ,   ISA_MIPS_MarkIII = 0x0603 ,   ISA_MIPS_R2000 = 0x0604 ,   ISA_MIPS_R3000 = 0x0605 ,   ISA_MIPS_R4000 = 0x0606 ,   ISA_MIPS_R4200 = 0x0607 ,   ISA_MIPS_R4300 = 0x0608 ,   ISA_MIPS_R4600 = 0x0609 ,   ISA_MIPS_R4650 = 0x060a ,   ISA_MIPS_R4700 = 0x060b ,   ISA_MIPS_R5000 = 0x060c ,   ISA_MIPS_RM7000 = 0x060d ,   ISA_MIPS_R8000 = 0x060e ,   ISA_MIPS_R10000 = 0x060f ,   ISA_MIPS_R12000 = 0x0610 ,   ISA_MIPS_R14000 = 0x0611 ,   ISA_MIPS_R16000 = 0x0612 ,   ISA_MIPS_R16000A = 0x0613 ,   ISA_MIPS_16 = 0x0614 ,   ISA_MIPS_FPU = 0x0615 ,   ISA_MIPS_16FPU = 0x0616 ,   ISA_I860_Family = 0x0700 ,   ISA_I860_860XR = 0x0701 ,   ISA_I860_860XP = 0x0702 ,   ISA_IA64_Family = 0x0800 ,   ISA_IA64_Itanium = 0x0801 ,   ISA_IA64_Itanium2 = 0x0802 ,   ISA_ARM_Family = 0x0900 ,   ISA_ARM_ARM1 = 0x0901 ,   ISA_ARM_ARM2 = 0x0902 ,   ISA_ARM_ARM3 = 0x0903 ,   ISA_ARM_ARM6 = 0x0904 ,   ISA_ARM_ARM7 = 0x0905 ,   ISA_ARM_ARM7TDMI = 0x0906 ,   ISA_ARM_StrongARM = 0x0907 ,   ISA_ARM_ARM8 = 0x0908 ,   ISA_ARM_ARM9TDMI = 0x0909 ,   ISA_ARM_ARM9E = 0x090a ,   ISA_ARM_ARM10E = 0x090b ,   ISA_ARM_XScale = 0x090c ,   ISA_ARM_ARM11 = 0x090d ,   ISA_ARM_Cortex = 0x090e ,   ISA_ARM_A64 = 0x090f ,   ISA_JVM = 0x0a00 ,   ISA_OTHER_Family = 0xf000 ,   ISA_ATT_WE_32100 = 0xf001 ,   ISA_IBM_System_370 = 0xf002 ,   ISA_HPPA = 0xf003 ,   ISA_Fujitsu_VPP500 = 0xf004 ,   ISA_Sun_v8plus = 0xf005 ,   ISA_PowerPC = 0xf006 ,   ISA_PowerPC_64bit = 0xf007 ,   ISA_IBM_S390 = 0xf008 ,   ISA_NEC_V800_series = 0xf009 ,   ISA_Fujitsu_FR20 = 0xf00a ,   ISA_TRW_RH_32 = 0xf00b ,   ISA_Motorola_RCE = 0xf00c ,   ISA_Digital_Alpha_fake = 0xf00e ,   ISA_Hitachi_SH = 0xf00f ,   ISA_Siemens_Tricore = 0xf010 ,   ISA_Argonaut_RISC_Core = 0xf011 ,   ISA_Hitachi_H8_300 = 0xf012 ,   ISA_Hitachi_H8_300H = 0xf013 ,   ISA_Hitachi_H8S = 0xf014 ,   ISA_Hitachi_H8_500 = 0xf015 ,   ISA_Stanford_MIPS_X = 0xf016 ,   ISA_Motorola_M68HC12 = 0xf017 ,   ISA_Fujitsu_MMA_Multimedia_Accelerator =0xf018 ,   ISA_Siemens_PCP = 0xf019 ,   ISA_Sony_nCPU_embeeded_RISC = 0xf01a ,   ISA_Denso_NDR1_microprocessor =0xf01b ,   ISA_Motorola_Start_Core_processor =0xf01c ,   ISA_Toyota_ME16_processor = 0xf01d ,   ISA_STMicroelectronic_ST100_processor =0xf01e ,   ISA_Advanced_Logic_Corp_Tinyj_emb_family =0xf01f ,   ISA_AMD_x86_64_architecture = 0xf020 ,   ISA_Sony_DSP_Processor = 0xf021 ,   ISA_Siemens_FX66_microcontroller =0xf022 ,   ISA_STMicroelectronics_ST9_plus_8_16_microcontroller =0xf023 ,   ISA_STMicroelectronics_ST7_8bit_microcontroller =0xf024 ,   ISA_Motorola_MC68HC16_microcontroller =0xf025 ,   ISA_Motorola_MC68HC11_microcontroller =0xf026 ,   ISA_Motorola_MC68HC08_microcontroller =0xf027 ,   ISA_Motorola_MC68HC05_microcontroller =0xf028 ,   ISA_Silicon_Graphics_SVx = 0xf029 ,   ISA_STMicroelectronics_ST19_8bit_microcontroller =0xf02a ,   ISA_Digital_VAX = 0xf02b ,   ISA_Axis_Communications_32bit_embedded_processor =0xf02c ,   ISA_Infineon_Technologies_32bit_embedded_processor =0xf02d ,   ISA_Element_14_64bit_DSP_Processor =0xf02e ,   ISA_LSI_Logic_16bit_DSP_Processor =0xf02f ,   ISA_Donald_Knuths_educational_64bit_processor =0xf030 ,   ISA_Harvard_University_machine_independent_object_files =0xf031 ,   ISA_SiTera_Prism = 0xf032 ,   ISA_Atmel_AVR_8bit_microcontroller =0xf033 ,   ISA_Fujitsu_FR30 = 0xf034 ,   ISA_Mitsubishi_D10V = 0xf035 ,   ISA_Mitsubishi_D30V = 0xf036 ,   ISA_NEC_v850 = 0xf037 ,   ISA_Mitsubishi_M32R = 0xf038 ,   ISA_Matsushita_MN10300 = 0xf039 ,   ISA_Matsushita_MN10200 = 0xf03a ,   ISA_picoJava = 0xf03b ,   ISA_OpenRISC_32bit_embedded_processor =0xf03c ,   ISA_ARC_Cores_Tangent_A5 = 0xf03d ,   ISA_Tensilica_Xtensa_Architecture =0xf03e ,   ISA_Digital_Alpha = 0xf03f ,   ISA_Matsushita_AM33 = 0xf040 ,   ISA_EFI_ByteCode = 0xf041 }
	Instruction sets organized by families. More...
enum	ExecPurpose {   PURPOSE_UNSPECIFIED ,   PURPOSE_OTHER ,   PURPOSE_EXECUTABLE ,   PURPOSE_LIBRARY ,   PURPOSE_CORE_DUMP ,   PURPOSE_OS_SPECIFIC ,   PURPOSE_PROC_SPECIFIC }
	General purpose of a binary executable file. More...
typedef struct stat	fileDetails
	Information about the file in the filesystem.
Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value More...
enum	{ static_variant = V_SgNode }
	static variant value More...

Public Member Functions
virtual	~SgAsmExecutableFileFormat ()
	Destructor.
Public Member Functions inherited from SgAsmNode
virtual	~SgAsmNode ()
	Destructor.
Sawyer::Attribute::Storage const &	attributes () const
	Attribute storage.
Sawyer::Attribute::Storage &	attributes ()
	Attribute storage.
Public Member Functions inherited from SgNode
virtual SgNode *	copy (SgCopyHelp &help) const
virtual std::string	class_name () const
	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 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 const char *	sage_class_name () const
	generates string representing the class name: (e.g. for SgNode returns "SgNode").
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.
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.
	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.
void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST.
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.
bool	get_isModified () const
	Acess function for isModified flag.
bool	get_containsTransformation () const
	Acess function for containsTransformation flag.
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
int	variant () const
	Older version function returns enum value "NODE".
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.
virtual void	set_attributeMechanism (AstAttributeMechanism *a)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.
virtual void	fixupCopy_scopes (SgNode *copy, SgCopyHelp &help) const
virtual void	fixupCopy_symbols (SgNode *copy, SgCopyHelp &help) const
virtual void	fixupCopy_references (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.
int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST.
template<class T >
T *	initParentPointer (T *child, SgNode *parent)
	Generated for tree edge data member initializations.
SgNode *	get_freepointer () const
void	set_freepointer (SgNode *freepointer)
virtual	~SgNode ()
	This is the destructor.
	SgNode ()
	This is the constructor.
virtual SgNode *	copy (SgCopyHelp &help) const
virtual std::string	class_name () const
	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 ()
	container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
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
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
virtual const char *	sage_class_name () const
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.
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.
	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.
void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST.
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.
bool	get_isModified () const
	Acess function for isModified flag.
bool	get_containsTransformation () const
	Acess function for containsTransformation flag.
void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node.
SgNode *	get_parent () const
	Access function for parent node.
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)
int	variant () const
bool	get_isVisited () const
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals.
void	set_isVisited (bool isVisited)
	Access function for p_isVisited flag used previously by the AST traversals.
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.
virtual void	set_attributeMechanism (AstAttributeMechanism *a)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.
virtual void	fixupCopy_scopes (SgNode *copy, SgCopyHelp &help) const
virtual void	fixupCopy_symbols (SgNode *copy, SgCopyHelp &help) const
virtual void	fixupCopy_references (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.
int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST.
template<class T >
T *	initParentPointer (T *child, SgNode *parent)
	Generated for tree edge data member initializations.
SgNode *	get_freepointer () const
void	set_freepointer (SgNode *freepointer)
virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
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
virtual RTIReturnType	roseRTI ()
	return C++ Runtime-Time-Information
void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node.
SgNode *	get_parent () const
	Access function for parent node.
std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space)
bool	get_isVisited () const
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals.
void	set_isVisited (bool isVisited)
	Access function for p_isVisited flag used previously by the AST traversals.
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.
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.
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.
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.

Static Public Member Functions
static SgAsmGenericFile *	parseBinaryFormat (const char *name)
	Factory method that parses a binary file.
static void	unparseBinaryFormat (const std::string &name, SgAsmGenericFile *)
	Dump debugging information into a named text file.
static void	unparseBinaryFormat (std::ostream &, SgAsmGenericFile *)
	Dump debugging information to specified stream.
static void	initDiagnostics ()
	Initialize diagnostic streams.
static std::string	isaFamilyToString (SgAsmExecutableFileFormat::InsSetArchitecture)
static std::string	isaToString (SgAsmExecutableFileFormat::InsSetArchitecture)
static std::string	toString (SgAsmExecutableFileFormat::InsSetArchitecture)
static std::string	toString (SgAsmExecutableFileFormat::ExecFamily)
static std::string	toString (SgAsmExecutableFileFormat::ExecABI)
static std::string	toString (SgAsmExecutableFileFormat::ExecPurpose)
static std::string	isa_family_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
static std::string	isa_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
static std::string	to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
static std::string	to_string (SgAsmExecutableFileFormat::ExecFamily)
static std::string	to_string (SgAsmExecutableFileFormat::ExecABI)
static std::string	to_string (SgAsmExecutableFileFormat::ExecPurpose)
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.
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.
static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map.
static std::map< std::string, uint64_t > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map.
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names).
static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names).
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type).
static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type).
static std::map< SgNode *, std::map< SgNode *, std::string > > &	get_globalQualifiedNameMapForMapsOfTypes ()
	Access function for name qualification support (for maps of types).
static void	set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
	Access function for name qualification support (for maps of types).
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTemplateHeaders ()
	Access function for name qualification support (for template headers in template declarations).
static void	set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for template headers in template declarations).
static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types).
static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types).
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.
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.
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.
static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map.
static std::map< std::string, uint64_t > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map.
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names).
static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names).
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type).
static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type).
static std::map< SgNode *, std::map< SgNode *, std::string > > &	get_globalQualifiedNameMapForMapsOfTypes ()
	Access function for name qualification support (for maps of types).
static void	set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
	Access function for name qualification support (for maps of types).
static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTemplateHeaders ()
	Access function for name qualification support (for template headers in template declarations).
static void	set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for template headers in template declarations).
static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types).
static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types).
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.

Static Public Attributes
static Sawyer::Message::Facility	mlog
	Diagnostic stream.

Protected Member Functions
	SgAsmExecutableFileFormat ()
	Default constructor.
void	initializeProperties ()
	Initialize all properties that have explicit initial values.
Protected Member Functions inherited from SgAsmNode
	SgAsmNode ()
	Default constructor.
void	initializeProperties ()
	Initialize all properties that have explicit initial values.
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.
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.
virtual void	debugSerializationBegin (const char *className)
	Called by generated serializers.
virtual void	debugSerializationEnd (const char *className)
	Called by generated serializers.
virtual void	debugSerializationBegin (const char *className)
	Called by generated serializers.
virtual void	debugSerializationEnd (const char *className)
	Called by generated serializers.

Additional Inherited Members
Protected Attributes inherited from SgNode
SgNode *	p_parent
	This is the pointer to the parent IR node in the AST.
bool	p_isModified
	Records if IR node has been modified (data members reset).
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, uint64_t >	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 Typedef Documentation

fileDetails

typedef struct stat SgAsmExecutableFileFormat::fileDetails

Information about the file in the filesystem.

Definition at line 42386 of file binaryInstruction.C.

Member Enumeration Documentation

ExecFamily

enum SgAsmExecutableFileFormat::ExecFamily

Architecture family.

Enumerator
FAMILY_UNSPECIFIED	Unspecified family.
FAMILY_DOS	Microsoft DOS format.
FAMILY_ELF	Unix Executable and Linking Format.
FAMILY_JVM	Java Virtual Machine (JVM) format.
FAMILY_LE	Microsft Linear Executable format.
FAMILY_LX	OS/2 LX (Windows 9x VxD device drivers, extension of LE).
FAMILY_NE	Microsoft New Executable Format.
FAMILY_PE	Microsoft Portable Executable Format.

Definition at line 42389 of file binaryInstruction.C.

ExecABI

enum SgAsmExecutableFileFormat::ExecABI

Application binary interface.

Enumerator
ABI_UNSPECIFIED	Not specified in file and could not be inferred.
ABI_OTHER	Anything other than values below.
ABI_86OPEN	86Open Common IA32
ABI_AIX	AIX.
ABI_ARM	ARM architecture.
ABI_FREEBSD	FreeBSD.
ABI_HPUX	HP/UX.
ABI_IRIX	IRIX.
ABI_HURD	GNU/Hurd.
ABI_JVM	Java Virtual Machine (JVM).
ABI_LINUX	GNU/Linux.
ABI_MODESTO	Novell Modesto.
ABI_MONTEREY	Monterey project.
ABI_MSDOS	Microsoft DOS.
ABI_NT	Windows NT.
ABI_NETBSD	NetBSD.
ABI_OS2	OS/2.
ABI_SOLARIS	Sun Solaris.
ABI_SYSV	SysV R4.
ABI_TRU64	Compaq TRU64 UNIX.
ABI_WIN386	Microsoft Windows.

Definition at line 42401 of file binaryInstruction.C.

InsSetArchitecture

enum SgAsmExecutableFileFormat::InsSetArchitecture

Instruction sets organized by families.

Enumerator
ISA_UNSPECIFIED	File does not specify an architecture.
ISA_OTHER	Architecture is something other than below.
ISA_FAMILY_MASK	Mask to get family part of ISA.
ISA_IA32_Family	x86 IA-32 family of architectures; Intel, AMD, VIA, ...
ISA_IA32_286	80286
ISA_IA32_386	MMU with paging.
ISA_IA32_486	risc-like pipelining, integrated FPU, on-chip cache
ISA_IA32_Pentium	superscalar, 64-bit databus, MMX
ISA_IA32_Cyrix6x86	register renaming, speculative execution
ISA_IA32_AMDK5	micro-op translation
ISA_IA32_PentiumPro	PAE, integrated L2 cache.
ISA_IA32_PentiumII	L3-cache, 3D Now, SSE.
ISA_IA32_Athlon	superscalar FPU, wide design
ISA_IA32_Pentium4	deeply pipelined, high frequency, SSE2, hyper-threading
ISA_IA32_PentiumM	low power
ISA_X8664_Family	x86-64 family of architectures: Intel, AMD, VIA, ...
ISA_X8664_Athlon64	on-die memory controller, 40-bit phys address space
ISA_X8664_Prescott	deeply pipelined, high frequency, SSE3
ISA_X8664_IntelCore	low power, multi-core, lower clock frequency
ISA_X8664_AMDPhenom	quad core, 128-bit FPUs, SSE4a, native mem ctrl, on-die L3 cache
ISA_SPARC_Family	SPARC family of architectures; Sun Microsystems.
ISA_M68K_Family	Motorala m68k family.
ISA_M68K_68000	generation one: 16/32 internal; 8-, 16-, 32-bit interface
ISA_M68K_68020	generation two: fully 32-bit
ISA_M68K_68040	generation three: pipelined
ISA_M68K_68060	generation four: superscalar
ISA_M68K_ColdFire	other
ISA_M68K_DragonBall	other
ISA_M88K_Family	Motorola m88k family (not very popular)
ISA_M88K_88100	32-bit, integrated FPU mated with 88200 MMU and cache controller
ISA_M88K_88110	single package of 88100+88200
ISA_M88K_88110MP	on-chip comm for use in multi-processor systems
ISA_M88K_88120	superscalar (never actually released)
ISA_MIPS_Family	32/64-bit RISC; MIPS Technologies, Inc.
ISA_MIPS_MarkI	R2000, R3000.
ISA_MIPS_MarkII	R6000.
ISA_MIPS_MarkIII	R4000.
ISA_MIPS_R2000	32-bit, Big or little endian
ISA_MIPS_R3000	virtual identical: Pacempi's R3400, IDT's R3500, Toshiba R3900
ISA_MIPS_R4000	64-bit; others in the series had larger caches and bug fixes
ISA_MIPS_R4200	low-cost version of R4000
ISA_MIPS_R4300	low-cost version of R4000 with 32-bit external bus
ISA_MIPS_R4600	"Orion" by Qauntum Effect Devices (QED); larger caches
ISA_MIPS_R4650	by QED
ISA_MIPS_R4700	"Orion" by QED
ISA_MIPS_R5000	by QED
ISA_MIPS_RM7000	by PMC-Sierra; 256kB L2 and optional L3
ISA_MIPS_R8000	superscalar, fairly rare
ISA_MIPS_R10000	R8000 on a single chip; 32kB caches; out-of-order.
ISA_MIPS_R12000	R10000 + higher clock rates.
ISA_MIPS_R14000	R12000 + support for DDR SRAM; 200MHz front side bus.
ISA_MIPS_R16000	R14000 + increased freq, more L1, smaller die.
ISA_MIPS_16	Unknown. Windows PE architecture 0x266 "MIPS16"
ISA_MIPS_FPU	Unknown. Windows PE architecture 0x366 "MIPS with FPU"
ISA_MIPS_16FPU	Unknown. Windows PE architecture 0x466 "MIPS16 with FPU"
ISA_I860_Family	Intel i860 family; 1989-mid 90's; RISC VLIW.
ISA_I860_860XR	(code named N10) 25-40MHz
ISA_I860_860XP	(code named N11) larger caches; 40-50MHz; same IS as XR
ISA_IA64_Family	Intel 64-bit architecture.
ISA_IA64_Itanium	First generation.
ISA_IA64_Itanium2	Second generation starting Nov 2007.
ISA_ARM_Family	Acorn RISC Machine, Advanced RISC Machines, ARM Limited.
ISA_ARM_ARM1	ARM evaluation system.
ISA_ARM_ARM2	ARM2, ARM250 cores.
ISA_ARM_ARM3	ARM2a core.
ISA_ARM_ARM6	ARM60, ARM600, ARM610 cores.
ISA_ARM_ARM7	ARM{700,710,710a,7100,7500,7500FE} cores.
ISA_ARM_ARM7TDMI	ARM{7TDMI,7TDMI-S,710T,720T,740T,7EJ-S} cores.
ISA_ARM_StrongARM	SA-110, SA-1110 cores.
ISA_ARM_ARM8	ARM810 core.
ISA_ARM_ARM9TDMI	ARM{9TDMI,920T,922T,940T} cores.
ISA_ARM_ARM9E	ARM{946E-S,966E-S,968E-S,926EJ-S,966HS} cores.
ISA_ARM_ARM10E	ARM{1020E,1022E,1026EJ-S} cores.
ISA_ARM_XScale	80200, IOP310, IOP315, 80219, IOP321, IOP33x, IOP34x, PXA210, PXA250, PXA255, PXA26x, PXA27x, PXA800(E)F, Monahans, PXA900, IXC1100, IXP2400, IXP2800, IXP2850, IXP2325, IXP2350, IXP42x, IXP460, IXP465 cores
ISA_ARM_ARM11	ARMv{6,6T2,6KZ,6K} cores.
ISA_ARM_Cortex	Cortex-{A8,A9,A9 MPCore,R4(F),M3,M1} cores.
ISA_ARM_A64	ARM AArch64 A64 instruction set.
ISA_JVM	Java Virtual Machine (JVM) instruction set.
ISA_ATT_WE_32100	Sometimes simply "M32".

Definition at line 42426 of file binaryInstruction.C.

ExecPurpose

enum SgAsmExecutableFileFormat::ExecPurpose

General purpose of a binary executable file.

Enumerator
PURPOSE_UNSPECIFIED	Purpose is not specified and could not be inferred.
PURPOSE_OTHER	A purpose other than any defined below.
PURPOSE_EXECUTABLE	Executable program.
PURPOSE_LIBRARY	Library (shared or relocatable)
PURPOSE_CORE_DUMP	Post mortem image.
PURPOSE_OS_SPECIFIC	Some operating system specific purpose.
PURPOSE_PROC_SPECIFIC	Some processor specific purpose.

Definition at line 42608 of file binaryInstruction.C.

Member Function Documentation

unparseBinaryFormat() [1/2]

static void SgAsmExecutableFileFormat::unparseBinaryFormat ( const std::string &  name, SgAsmGenericFile *    )

static

Dump debugging information into a named text file.

Writes a new file from the IR node for a parsed executable file. Warning: This function might modify the AST by calling SgAsmGenericSection::reallocate, which makes sure all parts of the AST are consistent with respect to each other.

unparseBinaryFormat() [2/2]

static void SgAsmExecutableFileFormat::unparseBinaryFormat ( std::ostream &  , SgAsmGenericFile *    )

static

Dump debugging information to specified stream.

Unparses an executable file into the supplied output stream. Warning: This function might modify the AST by calling SgAsmGenericSection::reallocate, which makes sure all parts of the AST are consistent with respect to each other.

initDiagnostics()

static void SgAsmExecutableFileFormat::initDiagnostics ( )

static

Initialize diagnostic streams.

This is called automatically by Rose::initialize.

initializeProperties()

void SgAsmExecutableFileFormat::initializeProperties ( )

protected

Initialize all properties that have explicit initial values.

This function is mostly for use in user-defined constructors where the user desires to initialize all the properties but does not know the names of the data members that store the property values. This function initializes the properties that have explicit initializations within this class, but does not recursively initialize base classes.

Member Data Documentation

mlog

Sawyer::Message::Facility SgAsmExecutableFileFormat::mlog

static

Diagnostic stream.

Definition at line 42638 of file binaryInstruction.C.

---

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

• binaryInstruction.C