SgAsmGenericSection Class Reference

Description

Contiguous region of a file.

This class represents any contiguous region of a file that serves a particular purpose. Not only are ELF and PE Sections represented by SgAsmGenericSection, but also such things as file headers, segment and section tables, etc.

Definition at line 30951 of file binaryInstruction.C.

Inheritance diagram for SgAsmGenericSection:

Collaboration diagram for SgAsmGenericSection:

Public Types
enum	SectionPurpose {   SP_UNSPECIFIED ,   SP_PROGRAM ,   SP_HEADER ,   SP_SYMTAB ,   SP_OTHER }
	Reason for section's existence. More...
Public Types inherited from SgAsmExecutableFileFormat
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
	SgAsmGenericSection (SgAsmGenericFile *, SgAsmGenericHeader *)
	Constructor linking object into ASt.
void	grabContent ()
	Saves a reference to the original file data for a section based on the section's current offset and size.
virtual SgAsmGenericSection *	parse ()
	Parse contents of the section.
virtual void	dump (FILE *, const char *prefix, ssize_t idx) const
	Print some debugging info.
virtual bool	reallocate ()
	Called prior to unparse to make things consistent.
virtual void	unparse (std::ostream &) const
	Write a section back to the file.
void	unparse (std::ostream &, const ExtentMap &) const
	Write just the specified regions back to the file.
void	unparseHoles (std::ostream &) const
	Write holes (unreferenced areas) back to the file.
SgAsmGenericHeader *	isFileHeader ()
	Predicate determining whether this section is also a top-level file header.
rose_addr_t	get_endOffset () const
	File offset for end of section.
void	extend (rose_addr_t nbytes)
	Extend a section by some number of bytes during the construction and/or parsing phase.
rose_addr_t	writeUleb128 (unsigned char *, rose_addr_t offset, uint64_t) const
	Write an unsigned little-endian 128-bit value.
rose_addr_t	writeSleb128 (unsigned char *, rose_addr_t offset, int64_t) const
	Write a signed little-endian 128-bit value.
size_t	readContent (rose_addr_t abs_offset, void *dst_buf, rose_addr_t size, bool strict=true)
	Reads data from a file.
size_t	readContentLocal (rose_addr_t rel_offset, void *dst_buf, rose_addr_t size, bool strict=true)
	Reads data from a file.
std::string	readContentString (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t va, bool strict=true)
	Reads a string from the file.
std::string	readContentLocalString (rose_addr_t rel_offset, bool strict=true)
	Reads a string from the file.
SgUnsignedCharList	readContentLocalUcl (rose_addr_t rel_offset, rose_addr_t size)
	Reads content of a section and returns it as a container.
int64_t	readContentLocalSleb128 (rose_addr_t *rel_offset, bool strict=true)
	Read a signed little-endian 128-bit value.
uint64_t	readContentLocalUleb128 (rose_addr_t *rel_offset, bool strict=true)
	Read an unsigned little-endian 128-bit value.
unsigned char *	writableContent (size_t nbytes)
	Obtain a local, writable pool to hold content.
Rose::BinaryAnalysis::AddressIntervalSet	get_referencedExtents () const
	Returns a list of parts of a single section that have been referenced.
Rose::BinaryAnalysis::AddressIntervalSet	get_unreferencedExtents () const
	Returns a list of parts of a single section that have not been referenced.
bool	isMapped () const
	Whether section desires to be mapped to memory.
void	clearMapped ()
	Causes section to not be mapped to memory.
rose_addr_t	get_baseVa () const
	Base virtual address for a section.
rose_addr_t	get_mappedPreferredVa () const
	Virtual address where section prefers to be mapped.
rose_addr_t	get_vaOffset (rose_addr_t va) const
	File offset for specified virtual address.
rose_addr_t	get_rvaOffset (rose_addr_t rva) const
	File offset for specified relative virtual address.
Extent	get_fileExtent () const
	Returns the file extent for the section.
Extent	get_mappedPreferredExtent () const
	Returns the memory extent for a mapped section.
bool	align ()
	Increase file offset and mapping address to satisfy alignment constraints.
rose_addr_t	get_file_alignment () const
void	set_file_alignment (rose_addr_t)
std::string	get_short_name () const
void	set_short_name (const std::string &)
rose_addr_t	get_mapped_preferred_rva () const
void	set_mapped_preferred_rva (rose_addr_t)
rose_addr_t	get_mapped_size () const
void	set_mapped_size (rose_addr_t)
rose_addr_t	get_mapped_alignment () const
void	set_mapped_alignment (rose_addr_t)
bool	get_mapped_rperm () const
void	set_mapped_rperm (bool)
bool	get_mapped_wperm () const
void	set_mapped_wperm (bool)
bool	get_mapped_xperm () const
void	set_mapped_xperm (bool)
bool	get_contains_code () const
void	set_contains_code (bool)
rose_addr_t	get_mapped_actual_va () const
void	set_mapped_actual_va (rose_addr_t)
void	grab_content ()
void	unparse_holes (std::ostream &) const
SgAsmGenericHeader *	is_file_header ()
rose_addr_t	get_end_offset () const
rose_addr_t	write_uleb128 (unsigned char *, rose_addr_t, uint64_t) const
rose_addr_t	write_sleb128 (unsigned char *, rose_addr_t, int64_t) const
size_t	read_content (rose_addr_t, void *, rose_addr_t, bool=true)
size_t	read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t, void *, rose_addr_t, bool=true)
size_t	read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, const Rose::BinaryAnalysis::RelativeVirtualAddress &, void *, rose_addr_t, bool=true)
size_t	read_content_local (rose_addr_t, void *, rose_addr_t, bool=true)
std::string	read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t, bool=true)
std::string	read_content_str (rose_addr_t, bool=true)
std::string	read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &, Rose::BinaryAnalysis::RelativeVirtualAddress, bool=true)
std::string	read_content_local_str (rose_addr_t, bool=true)
SgUnsignedCharList	read_content_local_ucl (rose_addr_t, rose_addr_t)
int64_t	read_content_local_sleb128 (rose_addr_t *, bool=true)
uint64_t	read_content_local_uleb128 (rose_addr_t *, bool=true)
unsigned char *	writable_content (size_t)
Rose::BinaryAnalysis::AddressIntervalSet	get_referenced_extents () const
Rose::BinaryAnalysis::AddressIntervalSet	get_unreferenced_extents () const
bool	is_mapped () const
void	clear_mapped ()
rose_addr_t	get_base_va () const
rose_addr_t	get_mapped_preferred_va () const
rose_addr_t	get_va_offset (rose_addr_t) const
rose_addr_t	get_rva_offset (rose_addr_t) const
Extent	get_file_extent () const
Extent	get_mapped_preferred_extent () const
virtual	~SgAsmGenericSection ()
	Destructor.
	SgAsmGenericSection ()
	Default constructor.
SgAsmGenericFile *const &	get_file () const
	Property: File to which this section belongs.
void	set_file (SgAsmGenericFile *const &)
	Property: File to which this section belongs.
SgAsmGenericHeader *const &	get_header () const
	Property: File header that owns this section.
void	set_header (SgAsmGenericHeader *const &)
	Property: File header that owns this section.
rose_addr_t	get_size () const
	Property: Size of section in file in bytes.
virtual void	set_size (rose_addr_t)
	Property: Size of section in file in bytes.
rose_addr_t	get_offset () const
	Property: Offset to start of section in file.
virtual void	set_offset (rose_addr_t)
	Property: Offset to start of section in file.
rose_addr_t const &	get_fileAlignment () const
	Property: Required file alignment.
void	set_fileAlignment (rose_addr_t const &)
	Property: Required file alignment.
SgFileContentList const &	get_data () const
	Property: Original content of just this section.
void	set_data (SgFileContentList const &)
	Property: Original content of just this section.
SgAsmGenericSection::SectionPurpose const &	get_purpose () const
	Property: General contents of the section.
void	set_purpose (SgAsmGenericSection::SectionPurpose const &)
	Property: General contents of the section.
bool const &	get_synthesized () const
	Property: Whether section really exists.
void	set_synthesized (bool const &)
	Property: Whether section really exists.
int const &	get_id () const
	Property: Non-unique section ID or negative.
void	set_id (int const &)
	Property: Non-unique section ID or negative.
SgAsmGenericString *const &	get_name () const
	Property: Non-unique name of section.
void	set_name (SgAsmGenericString *s)
	Property: Non-unique name of section.
void	set_shortName (std::string const &)
	Property: Abbreviated name.
std::string	get_shortName () const
	Property: Abbreviated name.
rose_addr_t const &	get_mappedPreferredRva () const
	Property: Relative virtual address where section prefers to be mapped.
virtual void	set_mappedPreferredRva (rose_addr_t)
	Property: Relative virtual address where section prefers to be mapped.
rose_addr_t const &	get_mappedSize () const
	Property: Mapped size.
virtual void	set_mappedSize (rose_addr_t)
	Property: Mapped size.
rose_addr_t const &	get_mappedAlignment () const
	Property: Alignment in virtual memory.
void	set_mappedAlignment (rose_addr_t const &)
	Property: Alignment in virtual memory.
bool const &	get_mappedReadPermission () const
	Property: Whether mapped with read permission.
void	set_mappedReadPermission (bool const &)
	Property: Whether mapped with read permission.
bool const &	get_mappedWritePermission () const
	Property: Whether mapped with write permission.
void	set_mappedWritePermission (bool const &)
	Property: Whether mapped with write permission.
bool const &	get_mappedExecutePermission () const
	Property: Whether mapped with execute permission.
void	set_mappedExecutePermission (bool const &)
	Property: Whether mapped with execute permission.
bool const &	get_containsCode () const
	Property: Whether a section is known to contain code.
void	set_containsCode (bool const &)
	Property: Whether a section is known to contain code.
rose_addr_t const &	get_mappedActualVa () const
	Property: Virtual address where ROSE maps this section.
void	set_mappedActualVa (rose_addr_t const &)
	Property: Virtual address where ROSE maps this section.
rose_addr_t	write (std::ostream &f, rose_addr_t offset, size_t bufsize, const void *buf) const
	Write data to a file section.
rose_addr_t	write (std::ostream &f, rose_addr_t offset, const std::string &str) const
	Write data to a file section.
rose_addr_t	write (std::ostream &f, rose_addr_t offset, char c) const
	Write data to a file section.
rose_addr_t	write (std::ostream &f, rose_addr_t offset, const SgFileContentList &buf) const
	Write data to a file section.
rose_addr_t	write (std::ostream &f, rose_addr_t offset, const SgUnsignedCharList &buf) const
	Write data to a file section.
size_t	readContent (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t start, void *dst_buf, rose_addr_t size, bool strict=true)
	Reads data from a file.
size_t	readContent (const Rose::BinaryAnalysis::MemoryMap::Ptr &, const Rose::BinaryAnalysis::RelativeVirtualAddress &start, void *dst_buf, rose_addr_t size, bool strict=true)
	Reads data from a file.
std::string	readContentString (rose_addr_t abs_offset, bool strict=true)
	Reads a string from the file.
std::string	readContentString (const Rose::BinaryAnalysis::MemoryMap::Ptr &map, Rose::BinaryAnalysis::RelativeVirtualAddress rva, bool strict=true)
	Reads a string from the file.
Public Member Functions inherited from SgAsmExecutableFileFormat
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 void	dumpContainingSections (FILE *, const std::string &prefix, Rose::BinaryAnalysis::RelativeVirtualAddress, const SgAsmGenericSectionPtrList &)
	Prints info about offsets into known sections.
static void	dump_containing_sections (FILE *, const std::string &, Rose::BinaryAnalysis::RelativeVirtualAddress, const SgAsmGenericSectionPtrList &)
Static Public Member Functions inherited from SgAsmExecutableFileFormat
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.

Protected Member Functions
virtual void	destructorHelper () override
	This gets called by all Rosebud-generated destructors.
void	initializeProperties ()
	Initialize all properties that have explicit initial values.
Protected Member Functions inherited from SgAsmExecutableFileFormat
	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	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	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.

Protected Attributes
unsigned char *	local_data_pool
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.

Additional Inherited Members
Static Public Attributes inherited from SgAsmExecutableFileFormat
static Sawyer::Message::Facility	mlog
	Diagnostic stream.
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 Enumeration Documentation

SectionPurpose

enum SgAsmGenericSection::SectionPurpose

Reason for section's existence.

This is a union of all the section purposes from the various supported file formats. However, at this time we're only interested in a few kinds of sections and therefore most will fall into the SP_OTHER category.

Enumerator
SP_UNSPECIFIED	File format did not specify a reason and none could be determined.
SP_PROGRAM	Program-supplied data, code, etc.
SP_HEADER	Section contains a header for the executable file format.
SP_SYMTAB	Symbol table.
SP_OTHER	File-specified purpose other than any given in this enum.

Definition at line 31110 of file binaryInstruction.C.

Constructor & Destructor Documentation

SgAsmGenericSection()

SgAsmGenericSection::SgAsmGenericSection	(	SgAsmGenericFile *	,
		SgAsmGenericHeader *
	)

Constructor linking object into ASt.

Section constructors set the optional section header relationship–a bidirectional link between this new section and its optional, single header. This new section points to its header and the header contains a list that points to this new section. The section-to-header part of the link is deleted by the default destructor by virtue of being a simple pointer, but we also need to delete the other half of the link in the destructors.

Member Function Documentation

get_size()

rose_addr_t SgAsmGenericSection::get_size

(

)

const

Property: Size of section in file in bytes.

This is the current file size of the section in bytes as it exists in the file.. The original size of the section (available when parse is called for the function, but possibly updated while parsing) is available through the size of the original data property.

When ths size is set, some types of sections may do additional work. That additional work must not adjust the size of other sections or the mapping of any section (use SgAsmGenericFile::shiftExtend to do that).

set_size()

virtual void SgAsmGenericSection::set_size ( rose_addr_t  )

virtual

Property: Size of section in file in bytes.

This is the current file size of the section in bytes as it exists in the file.. The original size of the section (available when parse is called for the function, but possibly updated while parsing) is available through the size of the original data property.

When ths size is set, some types of sections may do additional work. That additional work must not adjust the size of other sections or the mapping of any section (use SgAsmGenericFile::shiftExtend to do that).

Reimplemented in SgAsmPEStringSection, and SgAsmElfStringSection.

get_offset()

rose_addr_t SgAsmGenericSection::get_offset

(

)

const

Property: Offset to start of section in file.

This property holds the current file offset in bytes of this section. When setting the property, some types of sections may need to do perform additional work. That additional work must not adjust the offset of other sections, or the mapping of any section.

set_offset()

virtual void SgAsmGenericSection::set_offset ( rose_addr_t  )

virtual

Property: Offset to start of section in file.

This property holds the current file offset in bytes of this section. When setting the property, some types of sections may need to do perform additional work. That additional work must not adjust the offset of other sections, or the mapping of any section.

get_fileAlignment()

rose_addr_t const & SgAsmGenericSection::get_fileAlignment

(

)

const

Property: Required file alignment.

Zero and one both imply byte alignment.

set_fileAlignment()

void SgAsmGenericSection::set_fileAlignment

(

rose_addr_t const &

)

Property: Required file alignment.

Zero and one both imply byte alignment.

get_data()

SgFileContentList const & SgAsmGenericSection::get_data

(

)

const

Property: Original content of just this section.

Points into file's content.

set_data()

void SgAsmGenericSection::set_data

(

SgFileContentList const &

)

Property: Original content of just this section.

Points into file's content.

get_synthesized()

bool const & SgAsmGenericSection::get_synthesized

(

)

const

Property: Whether section really exists.

If true, then this section was created by the format reader and not actually present in the file.

set_synthesized()

void SgAsmGenericSection::set_synthesized

(

bool const &

)

Property: Whether section really exists.

If true, then this section was created by the format reader and not actually present in the file.

get_id()

int const & SgAsmGenericSection::get_id

(

)

const

Property: Non-unique section ID or negative.

ELF files have unique id numbers.

set_id()

void SgAsmGenericSection::set_id

(

int const &

)

Property: Non-unique section ID or negative.

ELF files have unique id numbers.

get_name()

SgAsmGenericString *const & SgAsmGenericSection::get_name

(

)

const

Property: Non-unique name of section.

The name may be the empty string. If you just want to change the name of a section use the existing name node and change its string value. Assigning a new SgAsmGenericString to the section also changes the parent of the specified string node.

set_name()

void SgAsmGenericSection::set_name

(

SgAsmGenericString *

s

)

Property: Non-unique name of section.

The name may be the empty string. If you just want to change the name of a section use the existing name node and change its string value. Assigning a new SgAsmGenericString to the section also changes the parent of the specified string node.

set_shortName()

void SgAsmGenericSection::set_shortName

(

std::string const &

)

Property: Abbreviated name.

Some sections have long names like "Import Address Table" that are cumbersome when they appear in assembly listings. Therefore, each section may also have a short name. Reading this property returns the short name if it's non-empty, otherwise the full name.

get_shortName()

std::string SgAsmGenericSection::get_shortName

(

)

const

Property: Abbreviated name.

Some sections have long names like "Import Address Table" that are cumbersome when they appear in assembly listings. Therefore, each section may also have a short name. Reading this property returns the short name if it's non-empty, otherwise the full name.

get_mappedPreferredRva()

rose_addr_t const & SgAsmGenericSection::get_mappedPreferredRva

(

)

const

Property: Relative virtual address where section prefers to be mapped.

This is the relative virtual address where the section prefers to be mapped. The RVA where the section will ultimately be mapped by the loader might be different due to file and/or memory alignment constraints and conflicts with other sections.

The virtual address is relative to the base address stored in the file header.

set_mappedPreferredRva()

virtual void SgAsmGenericSection::set_mappedPreferredRva ( rose_addr_t  )

virtual

Property: Relative virtual address where section prefers to be mapped.

This is the relative virtual address where the section prefers to be mapped. The RVA where the section will ultimately be mapped by the loader might be different due to file and/or memory alignment constraints and conflicts with other sections.

The virtual address is relative to the base address stored in the file header.

get_mappedSize()

rose_addr_t const & SgAsmGenericSection::get_mappedSize

(

)

const

Property: Mapped size.

Size of section in bytes when it's mapped into virtual memory.

set_mappedSize()

virtual void SgAsmGenericSection::set_mappedSize ( rose_addr_t  )

virtual

Property: Mapped size.

Size of section in bytes when it's mapped into virtual memory.

get_containsCode()

bool const & SgAsmGenericSection::get_containsCode

(

)

const

Property: Whether a section is known to contain code.

If a section is known to contain code then this data member is set. Part of the process of parsing a binary file is to look at the symbol tables and if any function symbol points into a section then the entire section is marked as containing code. This is necessary because ELF Object Files (*.o files) contain one ELF Section per function, none of which have a memory mapping specification. By marking those sections as containing code, the LoaderELFObj class, knows that the section should be mapped to virtual memory for disassembly.

set_containsCode()

void SgAsmGenericSection::set_containsCode

(

bool const &

)

Property: Whether a section is known to contain code.

If a section is known to contain code then this data member is set. Part of the process of parsing a binary file is to look at the symbol tables and if any function symbol points into a section then the entire section is marked as containing code. This is necessary because ELF Object Files (*.o files) contain one ELF Section per function, none of which have a memory mapping specification. By marking those sections as containing code, the LoaderELFObj class, knows that the section should be mapped to virtual memory for disassembly.

get_mappedActualVa()

rose_addr_t const & SgAsmGenericSection::get_mappedActualVa

(

)

const

Property: Virtual address where ROSE maps this section.

The actual mapping is sometimes different than the preferred mapping indicated in the section table due to file and/or memory alignment constraints or conflicts with other sections. The only place values are assigned to this data member is in the Rose::BinaryAnalysis::BinaryLoader class and subclasses thereof.

The address corresponds to the latest call into the Rose::BinaryAnalysis::BinaryLoader classes. Depending on the loader employed, it's possible for a section to be mapped, this mapped_actual_va value to be set, and then some other section to be mapped over the top of all or part of the first section. In that case, the mapped_actual_va of the first section is not reset to zero. The return value is not conditional upon isMapped since that predicate applies only to preferred mapping attributes.

set_mappedActualVa()

void SgAsmGenericSection::set_mappedActualVa

(

rose_addr_t const &

)

Property: Virtual address where ROSE maps this section.

The actual mapping is sometimes different than the preferred mapping indicated in the section table due to file and/or memory alignment constraints or conflicts with other sections. The only place values are assigned to this data member is in the Rose::BinaryAnalysis::BinaryLoader class and subclasses thereof.

The address corresponds to the latest call into the Rose::BinaryAnalysis::BinaryLoader classes. Depending on the loader employed, it's possible for a section to be mapped, this mapped_actual_va value to be set, and then some other section to be mapped over the top of all or part of the first section. In that case, the mapped_actual_va of the first section is not reset to zero. The return value is not conditional upon isMapped since that predicate applies only to preferred mapping attributes.

grabContent()

void SgAsmGenericSection::grabContent

(

)

Saves a reference to the original file data for a section based on the section's current offset and size.

Once this happens, changing the offset or size of the file will not affect the original data. The original data can be extended, however, by calling extend, which is typically done during parsing.

parse()

virtual SgAsmGenericSection * SgAsmGenericSection::parse ( )

virtual

Parse contents of the section.

This is normally reimplemented in subclasses.

Reimplemented in SgAsmJvmAttributeTable, SgAsmPEStringSection, SgAsmPESectionTable, SgAsmPEImportSection, SgAsmPEFileHeader, SgAsmPEExportSection, SgAsmJvmMethodTable, SgAsmJvmFileHeader, SgAsmJvmFieldTable, SgAsmJvmConstantPool, SgAsmElfSymverSection, SgAsmElfSymverNeededSection, SgAsmElfSymverDefinedSection, SgAsmElfSymbolSection, SgAsmElfStringSection, SgAsmElfSegmentTable, SgAsmElfSectionTable, SgAsmElfRelocSection, SgAsmElfNoteSection, SgAsmElfFileHeader, SgAsmElfEHFrameSection, SgAsmElfDynamicSection, SgAsmDOSFileHeader, SgAsmDOSExtendedHeader, SgAsmCoffSymbolTable, and SgAsmCliHeader.

dump()

virtual void SgAsmGenericSection::dump ( FILE *  , const char *  prefix, ssize_t  idx  ) const

virtual

Print some debugging info.

Reimplemented in SgAsmPEStringSection, SgAsmPESectionTable, SgAsmPEImportSection, SgAsmPEFileHeader, SgAsmPEExportSection, SgAsmPESection, SgAsmNEStringTable, SgAsmNESectionTable, SgAsmNESection, SgAsmNERelocTable, SgAsmNENameTable, SgAsmNEModuleTable, SgAsmNEFileHeader, SgAsmNEEntryTable, SgAsmLESectionTable, SgAsmLESection, SgAsmLERelocTable, SgAsmLEPageTable, SgAsmLENameTable, SgAsmLEFileHeader, SgAsmLEEntryTable, SgAsmJvmMethodTable, SgAsmJvmFieldTable, SgAsmJvmConstantPool, SgAsmJvmAttributeTable, SgAsmElfSymverSection, SgAsmElfSymverNeededSection, SgAsmElfSymverDefinedSection, SgAsmElfSymbolSection, SgAsmElfStringSection, SgAsmElfSegmentTable, SgAsmElfSectionTable, SgAsmElfRelocSection, SgAsmElfNoteSection, SgAsmElfFileHeader, SgAsmElfEHFrameSection, SgAsmElfDynamicSection, SgAsmElfSection, SgAsmDOSFileHeader, SgAsmGenericHeader, SgAsmDOSExtendedHeader, SgAsmCoffSymbolTable, and SgAsmCliHeader.

reallocate()

virtual bool SgAsmGenericSection::reallocate ( )

inlinevirtual

Called prior to unparse to make things consistent.

Reimplemented in SgAsmPEStringSection, SgAsmPESectionTable, SgAsmPEImportSection, SgAsmPEFileHeader, SgAsmPESection, SgAsmElfSymbolSection, SgAsmElfStringSection, SgAsmElfSegmentTable, SgAsmElfSectionTable, SgAsmElfRelocSection, SgAsmElfNoteSection, SgAsmElfFileHeader, SgAsmElfDynamicSection, SgAsmElfSection, SgAsmDOSFileHeader, and SgAsmGenericHeader.

Definition at line 31364 of file binaryInstruction.C.

unparse()

virtual void SgAsmGenericSection::unparse ( std::ostream &  ) const

virtual

Write a section back to the file.

This is the generic version that simply writes the content. Subclasses should override this.

Reimplemented in SgAsmPEStringSection, SgAsmPESectionTable, SgAsmPEImportSection, SgAsmPEFileHeader, SgAsmNESectionTable, SgAsmNESection, SgAsmNERelocTable, SgAsmNENameTable, SgAsmNEModuleTable, SgAsmNEFileHeader, SgAsmNEEntryTable, SgAsmLESectionTable, SgAsmLEPageTable, SgAsmLENameTable, SgAsmLEFileHeader, SgAsmLEEntryTable, SgAsmJvmMethodTable, SgAsmJvmFileHeader, SgAsmJvmFieldTable, SgAsmJvmConstantPool, SgAsmJvmAttributeTable, SgAsmElfSymverSection, SgAsmElfSymverNeededSection, SgAsmElfSymverDefinedSection, SgAsmElfSymbolSection, SgAsmElfStringSection, SgAsmElfSegmentTable, SgAsmElfSectionTable, SgAsmElfRelocSection, SgAsmElfNoteSection, SgAsmElfFileHeader, SgAsmElfEHFrameSection, SgAsmElfDynamicSection, SgAsmDOSFileHeader, SgAsmGenericHeader, SgAsmDOSExtendedHeader, and SgAsmCoffSymbolTable.

isFileHeader()

SgAsmGenericHeader * SgAsmGenericSection::isFileHeader

(

)

Predicate determining whether this section is also a top-level file header.

Returns true (the associated SgAsmGenericHeader pointer) if this section is a top-level file header, false (NULL) otherwise.

extend()

void SgAsmGenericSection::extend

(

rose_addr_t

nbytes

)

Extend a section by some number of bytes during the construction and/or parsing phase.

This is function is considered to be part of the parsing and construction of a section–it changes the part of the file that's considered the "original size" of the section. To adjust the size of a section after the executable file is parsed, see SgAsmGenericFile::shiftExtend. Sections are allowed to extend beyond the end of the file and the original data (the data property) is extended only up to the end of the file.

write() [1/5]

rose_addr_t SgAsmGenericSection::write	(	std::ostream &	f,
		rose_addr_t	offset,
		size_t	bufsize,
		const void *	buf
	)		const

Write data to a file section.

Writes data to the specified file at the specified offset (first two arguments). The remaining arguments specify the data to be written.

Returns the section-relative byte offset for the first byte beyond what would have been written if all bytes of the buffer were written.

The buffer is allowed to extend past the end of the section as long as the part that extends beyond is all zeros. The zeros will not be written to the output file. Furthermore, any trailing zeros that extend beyond the end of the file will not be written (end-of-file is determined by SgAsmGenericFile::get_originalSize).

write() [2/5]

rose_addr_t SgAsmGenericSection::write	(	std::ostream &	f,
		rose_addr_t	offset,
		const std::string &	str
	)		const

Write data to a file section.

Writes data to the specified file at the specified offset (first two arguments). The remaining arguments specify the data to be written.

Returns the section-relative byte offset for the first byte beyond what would have been written if all bytes of the buffer were written.

The buffer is allowed to extend past the end of the section as long as the part that extends beyond is all zeros. The zeros will not be written to the output file. Furthermore, any trailing zeros that extend beyond the end of the file will not be written (end-of-file is determined by SgAsmGenericFile::get_originalSize).

write() [3/5]

rose_addr_t SgAsmGenericSection::write	(	std::ostream &	f,
		rose_addr_t	offset,
		char	c
	)		const

Write data to a file section.

Writes data to the specified file at the specified offset (first two arguments). The remaining arguments specify the data to be written.

Returns the section-relative byte offset for the first byte beyond what would have been written if all bytes of the buffer were written.

The buffer is allowed to extend past the end of the section as long as the part that extends beyond is all zeros. The zeros will not be written to the output file. Furthermore, any trailing zeros that extend beyond the end of the file will not be written (end-of-file is determined by SgAsmGenericFile::get_originalSize).

write() [4/5]

rose_addr_t SgAsmGenericSection::write	(	std::ostream &	f,
		rose_addr_t	offset,
		const SgFileContentList &	buf
	)		const

Write data to a file section.

Writes data to the specified file at the specified offset (first two arguments). The remaining arguments specify the data to be written.

Returns the section-relative byte offset for the first byte beyond what would have been written if all bytes of the buffer were written.

The buffer is allowed to extend past the end of the section as long as the part that extends beyond is all zeros. The zeros will not be written to the output file. Furthermore, any trailing zeros that extend beyond the end of the file will not be written (end-of-file is determined by SgAsmGenericFile::get_originalSize).

write() [5/5]

rose_addr_t SgAsmGenericSection::write	(	std::ostream &	f,
		rose_addr_t	offset,
		const SgUnsignedCharList &	buf
	)		const

Write data to a file section.

Writes data to the specified file at the specified offset (first two arguments). The remaining arguments specify the data to be written.

Returns the section-relative byte offset for the first byte beyond what would have been written if all bytes of the buffer were written.

The buffer is allowed to extend past the end of the section as long as the part that extends beyond is all zeros. The zeros will not be written to the output file. Furthermore, any trailing zeros that extend beyond the end of the file will not be written (end-of-file is determined by SgAsmGenericFile::get_originalSize).

writeUleb128()

rose_addr_t SgAsmGenericSection::writeUleb128	(	unsigned char *	,
		rose_addr_t	offset,
		uint64_t
	)		const

Write an unsigned little-endian 128-bit value.

Encode an unsigned value as LEB128 and return the next offset.

writeSleb128()

rose_addr_t SgAsmGenericSection::writeSleb128	(	unsigned char *	,
		rose_addr_t	offset,
		int64_t
	)		const

Write a signed little-endian 128-bit value.

Encode an signed value as LEB128 and return the next offset.

readContent() [1/3]

size_t SgAsmGenericSection::readContent	(	rose_addr_t	abs_offset,
		void *	dst_buf,
		rose_addr_t	size,
		bool	strict = true
	)

Reads data from a file.

Reads up to size bytes of data beginning at byte start_offset from the beginning of the file, placing the results in dst_buf and returning the number of bytes read. The return value could be smaller than size if the end-of-file is reached. If the return value is smaller than size then one of two things happen: if strict is set (the default) then an SgAsmExecutableFileFormat::ShortRead exception is thrown; otherwise the dst_buf will be padded with zero bytes so that exactly size bytes of dst_buf are always initialized.

readContent() [2/3]

size_t SgAsmGenericSection::readContent	(	const Rose::BinaryAnalysis::MemoryMap::Ptr &	,
		rose_addr_t	start,
		void *	dst_buf,
		rose_addr_t	size,
		bool	strict = true
	)

Reads data from a file.

Reads up to size bytes of data beginning at byte start (absolute or relative virtual address) in the mapped address space and placing the results in dst_buf and returning the number of bytes read. The return value could be smaller than size if the reading encounters virtual addresses that are not mapped. When an unmapped virtual address is encountered the reading stops (even if subsequent virtual addresses are defined) and one of two things happen: if strict is set (the default) then an Rose::BinaryAnalysis::MemoryMap::NotMapped exception is thrown, otherwise the dst_buf is padded with zeros so that all size bytes are initialized. The map is used to map virtual addresses to file offsets; if map is NULL then the map defined in the underlying file is used.

readContent() [3/3]

size_t SgAsmGenericSection::readContent	(	const Rose::BinaryAnalysis::MemoryMap::Ptr &	,
		const Rose::BinaryAnalysis::RelativeVirtualAddress &	start,
		void *	dst_buf,
		rose_addr_t	size,
		bool	strict = true
	)

Reads data from a file.

Reads up to size bytes of data beginning at byte start (absolute or relative virtual address) in the mapped address space and placing the results in dst_buf and returning the number of bytes read. The return value could be smaller than size if the reading encounters virtual addresses that are not mapped. When an unmapped virtual address is encountered the reading stops (even if subsequent virtual addresses are defined) and one of two things happen: if strict is set (the default) then an Rose::BinaryAnalysis::MemoryMap::NotMapped exception is thrown, otherwise the dst_buf is padded with zeros so that all size bytes are initialized. The map is used to map virtual addresses to file offsets; if map is NULL then the map defined in the underlying file is used.

readContentLocal()

size_t SgAsmGenericSection::readContentLocal	(	rose_addr_t	rel_offset,
		void *	dst_buf,
		rose_addr_t	size,
		bool	strict = true
	)

Reads data from a file.

This behaves the same as readContent except the starting offset is relative to the beginning of this section. Reading past the end of the section is not allowed and treated as a short read, and one of two things happen: if strict is set (the default) then an SgAsmExecutableFileFormat::ShortRead exception is thrown, otherwise the result is zero padded so as to contain exactly size bytes.

readContentString() [1/3]

std::string SgAsmGenericSection::readContentString	(	const Rose::BinaryAnalysis::MemoryMap::Ptr &	,
		rose_addr_t	va,
		bool	strict = true
	)

Reads a string from the file.

The string begins at the specified virtual address and continues until the first NUL byte or until we reach an address that is not mapped. However, if strict is set (the default) and we reach an unmapped address then an Rose::BinaryAnalysis::MemoryMap::NotMapped exception is thrown. The map defines the mapping from virtual addresses to file offsets; if map is NULL then the map defined in the underlying file is used.

readContentString() [2/3]

std::string SgAsmGenericSection::readContentString	(	rose_addr_t	abs_offset,
		bool	strict = true
	)

Reads a string from the file.

The string begins at the specified absolute or header-relative file offset and continues until the first NUL byte or end of file is reached. However, if strict is set (the default) and we reach the end-of-file then an SgAsmExecutableFileFormat::ShortRead exception is thrown.

readContentString() [3/3]

std::string SgAsmGenericSection::readContentString	(	const Rose::BinaryAnalysis::MemoryMap::Ptr &	map,
		Rose::BinaryAnalysis::RelativeVirtualAddress	rva,
		bool	strict = true
	)

Reads a string from the file.

The string begins at the specified absolute or header-relative file offset and continues until the first NUL byte or end of file is reached. However, if strict is set (the default) and we reach the end-of-file then an SgAsmExecutableFileFormat::ShortRead exception is thrown.

readContentLocalString()

std::string SgAsmGenericSection::readContentLocalString	(	rose_addr_t	rel_offset,
		bool	strict = true
	)

Reads a string from the file.

The string begins at the specified file offset relative to the start of this section and continues until the first NUL byte or the end of section is reached. However, if strict is set (the default) and we reach the end-of-section then an SgAsmExecutableFileFormat::ShortRead exception is thrown.

readContentLocalUcl()

SgUnsignedCharList SgAsmGenericSection::readContentLocalUcl	(	rose_addr_t	rel_offset,
		rose_addr_t	size
	)

Reads content of a section and returns it as a container.

The returned container will always have exactly size byte. If size bytes are not available in this section at the specified offset then the container will be zero padded. This method always behaves as a non-strict read.

readContentLocalSleb128()

int64_t SgAsmGenericSection::readContentLocalSleb128	(	rose_addr_t *	rel_offset,
		bool	strict = true
	)

Read a signed little-endian 128-bit value.

Extract a signed LEB128 value and adjust rel_offset according to how many bytes it occupied. If strict is set (the default) and the end of the section is reached then throw an SgAsmExecutableFileFormat::ShortRead exception. Upon return, the rel_offset will be adjusted to point to the first byte after the LEB128 value.

readContentLocalUleb128()

uint64_t SgAsmGenericSection::readContentLocalUleb128	(	rose_addr_t *	rel_offset,
		bool	strict = true
	)

Read an unsigned little-endian 128-bit value.

Extract an unsigned LEB128 value and adjust rel_offset according to how many bytes it occupied. If strict is set (the default) and the end of the section is reached then throw an SgAsmExecutableFileFormat::ShortRead exception. Upon return, the rel_offset will be adjusted to point to the first byte after the LEB128 value.

writableContent()

unsigned char * SgAsmGenericSection::writableContent

(

size_t

nbytes

)

Obtain a local, writable pool to hold content.

Sections typically point into the memory mapped, read-only file stored in the SgAsmGenericFile parent initialized by calling grabContent (or indirectly by calling parse). This is also the same data which is, by default, written back out to the new file during unparse. Programs modify section content by either overriding the unparse method or by modifying the data property. But in order to modify data we have to make sure that it's pointing to a read/write memory pool. This function replaces the read-only memory pool with a new one containing nbytes bytes of zeros.

get_referencedExtents()

Rose::BinaryAnalysis::AddressIntervalSet SgAsmGenericSection::get_referencedExtents

(

)

const

Returns a list of parts of a single section that have been referenced.

The offsets are relative to the start of the section. The tracking actually happens at the entire file level (see the SgAsmGenericFile::referencedExtents property) and this function returns that same information but limits the results to this section, and returns section offsets rather than file offsets.

get_unreferencedExtents()

Rose::BinaryAnalysis::AddressIntervalSet SgAsmGenericSection::get_unreferencedExtents

(

)

const

Returns a list of parts of a single section that have not been referenced.

The offsets are relative to the start of the section. The tracking actually happens at the entire file level (see SgAsmGenericFile::get_unreferencedExtents) and this function returns that same information but limits the results to this section, and returns section offsets rather than file offsets.

isMapped()

bool SgAsmGenericSection::isMapped

(

)

const

Whether section desires to be mapped to memory.

This predicate is true iff this section has a non-zero mapped address and size.

clearMapped()

void SgAsmGenericSection::clearMapped

(

)

Causes section to not be mapped to memory.

This method sets the mapped address and size to zero.

get_baseVa()

rose_addr_t SgAsmGenericSection::get_baseVa

(

)

const

Base virtual address for a section.

Returns zero if the section is not associated with a header. This is just a convenience method to get the base virtual address of the file header that owns this section.

get_mappedPreferredVa()

rose_addr_t SgAsmGenericSection::get_mappedPreferredVa

(

)

const

Virtual address where section prefers to be mapped.

Returns (non-relative) virtual address if mapped, zero otherwise. See also, the mappedPreferredRva property.

get_vaOffset()

rose_addr_t SgAsmGenericSection::get_vaOffset

(

rose_addr_t

va

)

const

File offset for specified virtual address.

Returns the file offset associated with the virtual address of a mapped section. The Rose::BinaryAnalysis::MemoryMap class is a better interface to this same information.

get_rvaOffset()

rose_addr_t SgAsmGenericSection::get_rvaOffset

(

rose_addr_t

rva

)

const

File offset for specified relative virtual address.

Returns the file offset associated with the relative virtual address of a mapped section. The Rose::BinaryAnalysis::MemoryMap class is a better interface to this same information.

get_fileExtent()

Extent SgAsmGenericSection::get_fileExtent

(

)

const

Returns the file extent for the section.

The extent end points are determined by calling get_offset and get_size.

get_mappedPreferredExtent()

Extent SgAsmGenericSection::get_mappedPreferredExtent

(

)

const

Returns the memory extent for a mapped section.

If the section is not mapped then offset and size will be zero. The return value is computed from the mappedPreferredRva and mappedSize properties.

align()

bool SgAsmGenericSection::align

(

)

Increase file offset and mapping address to satisfy alignment constraints.

This is typically done when initializing a new section. The constructor places the new section at the end of the file before it knows what the alignment constraints will be. The user should then set the alignment constraints (see fileAlignment and mappedAlignment properties) and call this method. This method must be called before any additional sections are appended to the file.

The file offset and memory mapping address are adjusted independently.

On the other hand, if additional sections are in the way, they must first be moved out of the way with the SgAsmGenericFile::shiftExtend method.

Returns true if the file offset and/or mapping address changed as a result of this call.

destructorHelper()

virtual void SgAsmGenericSection::destructorHelper ( )

overrideprotectedvirtual

This gets called by all Rosebud-generated destructors.

Rosebud generates a call to destructorHelper from every destructor implementation. This gives the user a chance to do something special. There are some things to be aware of when reimplementing this function, and you should be well versed in the C++ rules about calling virtual functions from destructors.

• The implementation must not attempt to access any data members of derived classes. These data members have already been destroyed by time this function is called.

• Any calls you make to virtual functions declared in this class will dispatch only to implementations in this class or its base classes, not any derived classes.

• Your implementation must expect to be called multiple times for the same object. This occurs when this class implements this function but its derived class does not. During destruction of a derived object, the derived class's Rosebud-generated destructor will call destructorHelper, which will dispatch to the implementation in this class. Then, when the part of the object corresponding to this class is being destroyed, the destructor will call destructorHelper again, which will dispatch to this implementation again. This may happen recursively mutliple times.

• Your implementation should not destroy anything that a subclass might need during its destruction. This follows from the rule above, but is generally not a problem in practice. The reason it's not a problem is that the derived classes are usually Rosebud-generated and thus their destructors only call destructorHelper. Therefore, in order for any derived class to any work, it must be done in its destructorHelper, which would be called before the implementation of destructorHelper in this class is called.

All attempts should be made to avoid having to implement a destructorHelper in any class but the most base class (and that one does nothing). Instead, use data members whose own destructors do their cleanup. For instance, if this class needs a pointer to data allocated on the stack, then instead of using a raw pointer which needs to be deleted in this class's destructor, use a smart pointer whose own destructor deletes the data. If you follow this advice, then you don't need to be well-versed in the details of C++ object destruction.

Reimplemented from SgNode.

Reimplemented in SgAsmJvmFileHeader, and SgAsmJvmConstantPool.

initializeProperties()

void SgAsmGenericSection::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

local_data_pool

unsigned char* SgAsmGenericSection::local_data_pool

protected

Definition at line 31331 of file binaryInstruction.C.

---

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

• binaryInstruction.C