ROSE  0.9.6a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SgAsmGenericSection Class Reference

The SgAsmGenericSection represents any contiguous region of a file that serves a particular purpose. More...

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmGenericSection:
Collaboration diagram for SgAsmGenericSection:

Public Types

enum  SectionPurpose {
  SP_UNSPECIFIED,
  SP_PROGRAM,
  SP_HEADER,
  SP_SYMTAB,
  SP_OTHER
}
 
enum  { static_variant = V_SgAsmGenericSection }
 static variant value More...
 
typedef SgAsmExecutableFileFormat base_node_type
 
- Public Types inherited from SgAsmExecutableFileFormat
enum  ExecFamily {
  FAMILY_UNSPECIFIED,
  FAMILY_DOS,
  FAMILY_ELF,
  FAMILY_LE,
  FAMILY_LX,
  FAMILY_NE,
  FAMILY_PE
}
 
enum  ExecABI {
  ABI_UNSPECIFIED,
  ABI_OTHER,
  ABI_86OPEN,
  ABI_AIX,
  ABI_ARM,
  ABI_FREEBSD,
  ABI_HPUX,
  ABI_IRIX,
  ABI_HURD,
  ABI_LINUX,
  ABI_MODESTO,
  ABI_MONTEREY,
  ABI_MSDOS,
  ABI_NT,
  ABI_NETBSD,
  ABI_OS2,
  ABI_SOLARIS,
  ABI_SYSV,
  ABI_TRU64,
  ABI_WIN386
}
 
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_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
}
 
enum  ExecPurpose {
  PURPOSE_UNSPECIFIED,
  PURPOSE_OTHER,
  PURPOSE_EXECUTABLE,
  PURPOSE_LIBRARY,
  PURPOSE_CORE_DUMP,
  PURPOSE_OS_SPECIFIC,
  PURPOSE_PROC_SPECIFIC
}
 
enum  { static_variant = V_SgAsmExecutableFileFormat }
 static variant value More...
 
typedef struct stat fileDetails
 
typedef SgAsmNode base_node_type
 
- Public Types inherited from SgAsmNode
enum  { static_variant = V_SgAsmNode }
 static variant value More...
 
typedef SgNode base_node_type
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value More...
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
unsigned long get_starting_memory_address ()
 
unsigned long get_starting_file_offset ()
 
unsigned long get_flags ()
 
unsigned long get_type ()
 
 SgAsmGenericSection (SgAsmGenericFile *f, SgAsmGenericHeader *fhdr)
 
virtual ~SgAsmGenericSection ()
 
void grab_content ()
 Saves a reference to the original file data for a section based on the sections current offset and size. More...
 
virtual SgAsmGenericSectionparse ()
 
virtual void dump (FILE *, const char *prefix, ssize_t idx) const
 
virtual bool reallocate ()
 
virtual void unparse (std::ostream &) const
 Write a section back to the file. More...
 
void unparse (std::ostream &, const ExtentMap &) const
 Write just the specified regions back to the file. More...
 
void unparse_holes (std::ostream &) const
 Write holes (unreferenced areas) back to the file. More...
 
SgAsmGenericHeaderis_file_header ()
 true if section represents a top level file header More...
 
rose_addr_t get_size () const
 Returns the current file size of the section in bytes. More...
 
virtual void set_size (rose_addr_t)
 Adjust the current size of a section. More...
 
rose_addr_t get_offset () const
 Returns current file offset of section in bytes. More...
 
virtual void set_offset (rose_addr_t)
 Move a section w/o regard to other sections or mapping. More...
 
rose_addr_t get_end_offset () const
 file offset for end of section More...
 
void extend (rose_addr_t nbytes)
 make section larger by extending the end More...
 
rose_addr_t write (std::ostream &, rose_addr_t offset, size_t bufsize, const void *buf) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &, rose_addr_t offset, const std::string &str) const
 
rose_addr_t write (std::ostream &, rose_addr_t offset, char c) const
 
rose_addr_t write (std::ostream &, rose_addr_t offset, const SgFileContentList &buf) const
 
rose_addr_t write (std::ostream &, rose_addr_t offset, const SgUnsignedCharList &buf) const
 
rose_addr_t write_uleb128 (unsigned char *, rose_addr_t offset, uint64_t) const
 Encode an unsigned value as LEB128 and return the next offset. More...
 
rose_addr_t write_sleb128 (unsigned char *, rose_addr_t offset, int64_t) const
 Encode a signed value as LEB128 and return the next offset. More...
 
size_t read_content (rose_addr_t abs_offset, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
size_t read_content (const MemoryMap *, rose_addr_t va, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
size_t read_content (const MemoryMap *map, const rose_rva_t &rva, void *dst_buf, rose_addr_t size, bool strict=true)
 
size_t read_content_local (rose_addr_t rel_offset, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
std::string read_content_str (const MemoryMap *, rose_addr_t va, bool strict=true)
 Reads a string from the file. More...
 
std::string read_content_str (const MemoryMap *map, rose_rva_t rva, bool strict=true)
 
std::string read_content_str (rose_addr_t abs_offset, bool strict=true)
 Reads a string from the file. More...
 
std::string read_content_local_str (rose_addr_t rel_offset, bool strict=true)
 Reads a string from the file. More...
 
SgUnsignedCharList read_content_local_ucl (rose_addr_t rel_offset, rose_addr_t size)
 Reads content of a section and returns it as a container. More...
 
int64_t read_content_local_sleb128 (rose_addr_t *rel_offset, bool strict=true)
 Extract a signed LEB128 value and adjust rel_offset according to how many bytes it occupied. More...
 
uint64_t read_content_local_uleb128 (rose_addr_t *rel_offset, bool strict=true)
 Extract an unsigned LEB128 value and adjust rel_offset according to how many bytes it occupied. More...
 
unsigned char * writable_content (size_t nbytes)
 Sections typically point into the memory mapped, read-only file stored in the SgAsmGenericFile parent initialized by calling grab_content() (or indirectly by calling parse()). More...
 
ExtentMap get_referenced_extents () const
 Returns a list of parts of a single section that have been referenced. More...
 
ExtentMap get_unreferenced_extents () const
 
bool is_mapped () const
 True iff non-zero mapped address and size. More...
 
void clear_mapped ()
 Set mapped address and size to zero (unmapped) More...
 
rose_addr_t get_mapped_size () const
 Returns mapped size of section. More...
 
virtual void set_mapped_size (rose_addr_t)
 Resizes a mapped section without consideration of other sections that might be mapped. More...
 
rose_addr_t get_mapped_preferred_rva () const
 Returns relative virtual address w.r.t., base address of header. More...
 
virtual void set_mapped_preferred_rva (rose_addr_t)
 Moves a mapped section without consideration of other sections that might be mapped. More...
 
rose_addr_t get_base_va () const
 Returns base virtual address for a section, or zero if the section is not associated with a header. More...
 
rose_addr_t get_mapped_preferred_va () const
 Returns (non-relative) virtual address if mapped, zero otherwise. More...
 
rose_addr_t get_va_offset (rose_addr_t va) const
 Returns the file offset associated with the virtual address of a mapped section. More...
 
rose_addr_t get_rva_offset (rose_addr_t rva) const
 Returns the file offset associated with the relative virtual address of a mapped section. More...
 
SgAsmGenericStringget_name () const
 Return the section name. More...
 
void set_name (SgAsmGenericString *s)
 Set the section name node. More...
 
std::string get_short_name () const
 Returns an abbreviated name. More...
 
void set_short_name (const std::string &)
 Sets the abbreviated name of a section. More...
 
Extent get_file_extent () const
 Returns the file extent for the section. More...
 
Extent get_mapped_preferred_extent () const
 Returns the memory extent for a mapped section. More...
 
bool align ()
 Increase file offset and mapping address to satisfy alignment constraints. More...
 
virtual std::string class_name () const
 Copies AST (whole subtree, depending on the SgCopyHelp class. More...
 
virtual VariantT variantT () const
 returns new style SageIII enum values More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual size_t get_numberOfTraversalSuccessors ()
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx)
 
virtual size_t get_childIndex (SgNode *child)
 
virtual RTIReturnType roseRTI ()
 FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes. More...
 
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
virtual void accept (ROSE_VisitorPattern &visitor)
 DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...
 
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual std::vector< std::pair
< SgNode *, std::string > > 
returnDataMemberPointers () const
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
virtual long getChildIndex (SgNode *childNode) const
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...
 
 SgAsmGenericSection (const SgAsmGenericSectionStorageClass &source)
 
SgAsmGenericSectionaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
SgAsmGenericFileget_file () const
 
void set_file (SgAsmGenericFile *file)
 
SgAsmGenericHeaderget_header () const
 
void set_header (SgAsmGenericHeader *header)
 
rose_addr_t get_file_alignment () const
 
void set_file_alignment (rose_addr_t file_alignment)
 
SgFileContentList get_data () const
 
void set_data (SgFileContentList data)
 
SgAsmGenericSection::SectionPurpose get_purpose () const
 
void set_purpose (SgAsmGenericSection::SectionPurpose purpose)
 
bool get_synthesized () const
 
void set_synthesized (bool synthesized)
 
int get_id () const
 
void set_id (int id)
 
rose_addr_t get_mapped_alignment () const
 
void set_mapped_alignment (rose_addr_t mapped_alignment)
 
bool get_mapped_rperm () const
 
void set_mapped_rperm (bool mapped_rperm)
 
bool get_mapped_wperm () const
 
void set_mapped_wperm (bool mapped_wperm)
 
bool get_mapped_xperm () const
 
void set_mapped_xperm (bool mapped_xperm)
 
bool get_contains_code () const
 
void set_contains_code (bool contains_code)
 
rose_addr_t get_mapped_actual_va () const
 
void set_mapped_actual_va (rose_addr_t mapped_actual_va)
 
 SgAsmGenericSection ()
 
- Public Member Functions inherited from SgAsmExecutableFileFormat
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgAsmExecutableFileFormat (const SgAsmExecutableFileFormatStorageClass &source)
 
SgAsmExecutableFileFormataddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
virtual ~SgAsmExecutableFileFormat ()
 
 SgAsmExecutableFileFormat ()
 
- Public Member Functions inherited from SgAsmNode
 SgAsmNode (const SgAsmNode &X)
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string. More...
 
virtual AstAttributegetAttribute (std::string s) const
 Returns attribute of name 's'. More...
 
virtual void updateAttribute (std::string s, AstAttribute *a)
 Replace existing attribute of name 's' with new AstAttribute. More...
 
virtual void setAttribute (std::string s, AstAttribute *a)
 This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. More...
 
virtual void removeAttribute (std::string s)
 Remove attribute of name 's' if present. More...
 
virtual bool attributeExists (std::string s) const
 Tests if attribute of name 's' is present. More...
 
virtual int numberOfAttributes () const
 Returns the number of attributes on this IR node. More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgAsmNode (const SgAsmNodeStorageClass &source)
 
SgAsmNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
AttachedPreprocessingInfoTypeget_attachedPreprocessingInfoPtr () const
 
void set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)
 
AstAttributeMechanismget_asmAttributeMechanism () const
 
void set_asmAttributeMechanism (AstAttributeMechanism *asmAttributeMechanism)
 
AstAttributeMechanismget_attributeMechanism () const
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
 
void set_attributeMechanism (AstAttributeMechanism *attributeMechanism)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...
 
virtual ~SgAsmNode ()
 
 SgAsmNode ()
 
- Public Member Functions inherited from SgNode
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgNode (const SgNodeStorageClass &source)
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST. More...
 
bool get_isModified () const
 Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node. More...
 
SgNodeget_parent () const
 Access function for parent node. More...
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node. More...
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space) More...
 
std::string unparseToString () const
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space) More...
 
int variant () const ROSE_DEPRECATED_FUNCTION
 Older version function returns enum value "NODE". More...
 
virtual void fixupCopy (SgNode *copy, SgCopyHelp &help) const
 
virtual Sg_File_Infoget_file_info (void) const
 File information containing filename, line number, column number, and if the SgNode is a part of a new transformation, etc. More...
 
virtual Sg_File_Infoget_startOfConstruct (void) const
 New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword). More...
 
virtual Sg_File_Infoget_endOfConstruct (void) const
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). More...
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node. More...
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node. More...
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct. More...
 
virtual bool cfgIsIndexInteresting (unsigned int index) const
 Determine whether a particular CFG node index is "interesting" for this kind of node. More...
 
virtual unsigned int cfgFindChildIndex (SgNode *n)
 Find the index of n in this node's CFG children. More...
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n)
 Find the index just after n in this node's CFG children. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgInEdges (unsigned int index=false)
 Find the in edges of a CFG node – internal version. More...
 
int numberOfNodesInSubtree ()
 Computes the number of nodes in the defined subtree of the AST. More...
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST. More...
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor. More...
 
 SgNode ()
 This is the constructor. More...
 
bool get_isVisited () const ROSE_DEPRECATED_FUNCTION
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...
 
void set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
 Access function for p_isVisited flag used previously by the AST traversals. More...
 

Static Public Member Functions

static void dump_containing_sections (FILE *f, const std::string &prefix, rose_rva_t rva, const SgAsmGenericSectionPtrList &)
 Class method that prints info about offsets into known sections. More...
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgAsmExecutableFileFormat
static SgAsmGenericFileparseBinaryFormat (const char *name)
 
static void unparseBinaryFormat (const std::string &name, SgAsmGenericFile *)
 Writes a new file from the IR node for a parsed executable file. More...
 
static void unparseBinaryFormat (std::ostream &, SgAsmGenericFile *)
 Unparses an executable file into the supplied output stream. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Displays binary data in a fashion similar to the "hexdump -C" command in Unix: an address, numeric byte values, character byte values. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 
static std::string hexdump (rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 
static void hexdump (FILE *, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 
static std::string isa_family_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string isa_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 alias for isa_to_string(InsSetArchitecture) More...
 
static std::string to_string (SgAsmExecutableFileFormat::ExecFamily)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecABI)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecPurpose)
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgAsmNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
static std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...
 
static std::vector< VariantTgetClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode
*, std::string > & 
get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map. More...
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map. More...
 
static std::map< std::string,
int > & 
get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map. More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names). More...
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names). More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type). More...
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type). More...
 
static std::map< SgNode
*, std::string > & 
get_globalTypeNameMap ()
 Access function for name qualification support (for names of types). More...
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types). More...
 
static SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types. More...
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types. More...
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types. More...
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types. More...
 

Protected Member Functions

void ctor (SgAsmGenericFile *, SgAsmGenericHeader *)
 Section constructors set the optional section header relationship–a bidirectional link between this new section and its optional, single header. More...
 

Protected Attributes

SgAsmGenericFilep_file
 
SgAsmGenericHeaderp_header
 
rose_addr_t p_size
 
rose_addr_t p_offset
 
rose_addr_t p_file_alignment
 
SgFileContentList p_data
 
SgAsmGenericSection::SectionPurpose p_purpose
 
bool p_synthesized
 
int p_id
 
SgAsmGenericStringp_name
 
std::string p_short_name
 
rose_addr_t p_mapped_preferred_rva
 This is the relative virtual address where the section prefers to be mapped. More...
 
rose_addr_t p_mapped_size
 
rose_addr_t p_mapped_alignment
 
bool p_mapped_rperm
 
bool p_mapped_wperm
 
bool p_mapped_xperm
 
bool p_contains_code
 If a section is known to contain code then this data member is set. More...
 
rose_addr_t p_mapped_actual_va
 This is the virtual address where ROSE simulates a loader mapping the section. More...
 

Private Attributes

unsigned char * local_data_pool
 This is an optional local, writable pool for the p_data member. More...
 

Friends

class AST_FILE_IO
 
class SgAsmGenericSectionStorageClass
 
class AstSpecificDataManagingClass
 
class AstSpecificDataManagingClassStorageClass
 
ROSE_DLL_API friend
SgAsmGenericSection
isSgAsmGenericSection (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const
SgAsmGenericSection
isSgAsmGenericSection (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgAsmGenericSectionSgAsmGenericSection_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O Mechanism. More...
 
unsigned long SgAsmGenericSection_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgAsmGenericSection_clearMemoryPool ()
 
void SgAsmGenericSection_extendMemoryPoolForFileIO (unsigned long)
 
void SgAsmGenericSection_getNextValidPointer (std::pair< SgAsmGenericSection *, std::vector< unsigned char * >::const_iterator > &)
 
void SgAsmGenericSection_resetValidFreepointers ()
 

Additional Inherited Members

- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types. More...
 
static SgTypeTablep_globalTypeTable
 
static std::map< SgNode
*, std::string > 
p_globalMangledNameMap
 Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...
 
static std::map< std::string, int > p_shortMangledNameCache
 STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForNames
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForTypes
 
static std::map< SgNode
*, std::string > 
p_globalTypeNameMap
 

Detailed Description

The SgAsmGenericSection 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/section tables, etc.

Definition at line 279694 of file Cxx_Grammar.h.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
SP_UNSPECIFIED 
SP_PROGRAM 
SP_HEADER 
SP_SYMTAB 
SP_OTHER 

Definition at line 279720 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant 

Definition at line 279847 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgAsmGenericSection::SgAsmGenericSection ( SgAsmGenericFile f,
SgAsmGenericHeader fhdr 
)
SgAsmGenericSection::~SgAsmGenericSection ( )
virtual
SgAsmGenericSection::SgAsmGenericSection ( const SgAsmGenericSectionStorageClass source)

Member Function Documentation

virtual SgNode* SgAsmGenericSection::copy ( SgCopyHelp help) const
virtual

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

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

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

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

Exceptions
noneNo exceptions are thrown by this function.

Reimplemented from SgAsmExecutableFileFormat.

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

unsigned long SgAsmGenericSection::get_starting_memory_address ( )
inline

Definition at line 279708 of file Cxx_Grammar.h.

unsigned long SgAsmGenericSection::get_starting_file_offset ( )
inline

Definition at line 279712 of file Cxx_Grammar.h.

unsigned long SgAsmGenericSection::get_flags ( )
inline

Definition at line 279713 of file Cxx_Grammar.h.

unsigned long SgAsmGenericSection::get_type ( )
inline

Definition at line 279714 of file Cxx_Grammar.h.

void SgAsmGenericSection::dump_containing_sections ( FILE *  f,
const std::string &  prefix,
rose_rva_t  rva,
const SgAsmGenericSectionPtrList slist 
)
static

Class method that prints info about offsets into known sections.

Definition at line 754 of file GenericSection.C.

References DUMP_FIELD_WIDTH, get_id(), get_mapped_preferred_rva(), get_mapped_size(), get_name(), SgAsmGenericString::get_string(), is_mapped(), and offset.

void SgAsmGenericSection::grab_content ( )

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

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

Definition at line 98 of file GenericSection.C.

References SgAsmGenericFile::content(), and SgAsmGenericFile::get_orig_size().

Referenced by SgAsmLEFileHeader::ctor(), SgAsmNESectionTable::ctor(), SgAsmLESectionTable::ctor(), SgAsmLENameTable::ctor(), SgAsmLEPageTable::ctor(), SgAsmLEEntryTable::ctor(), SgAsmLERelocTable::ctor(), SgAsmElfSection::init_from_section_table(), and SgAsmElfSection::init_from_segment_table().

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

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

Definition at line 769 of file GenericSection.C.

References DUMP_FIELD_WIDTH, max, p_offset, rose::stringifySgAsmGenericSectionSectionPurpose(), and V_SgAsmGenericSection.

Referenced by SgAsmGenericHeader::dump(), SgAsmElfSection::dump(), SgAsmElfSymbolSection::dump(), SgAsmElfSectionTable::dump(), SgAsmElfSegmentTable::dump(), SgAsmPESection::dump(), SgAsmPESectionTable::dump(), SgAsmDOSExtendedHeader::dump(), SgAsmCoffSymbolTable::dump(), SgAsmNESection::dump(), SgAsmNESectionTable::dump(), SgAsmNENameTable::dump(), SgAsmNEModuleTable::dump(), SgAsmNEStringTable::dump(), SgAsmNEEntryTable::dump(), SgAsmNERelocTable::dump(), SgAsmLESection::dump(), SgAsmLESectionTable::dump(), SgAsmLENameTable::dump(), SgAsmLEPageTable::dump(), SgAsmLEEntryTable::dump(), and SgAsmLERelocTable::dump().

void SgAsmGenericSection::unparse ( std::ostream &  f,
const ExtentMap map 
) const

Write just the specified regions back to the file.

Definition at line 696 of file GenericSection.C.

References RangeMap< R, T >::begin(), RangeMap< R, T >::end(), Range< T >::first(), and Range< T >::size().

SgAsmGenericHeader * SgAsmGenericSection::is_file_header ( )

true if section represents a top level file header

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

Definition at line 670 of file GenericSection.C.

rose_addr_t SgAsmGenericSection::get_size ( ) const

Returns the current file size of the section in bytes.

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: p_data.size()

Definition at line 172 of file GenericSection.C.

Referenced by SgAsmPEFileHeader::add_rvasize_pairs(), SgAsmElfSection::calculate_sizes(), SgAsmPEFileHeader::ctor(), SgAsmDOSFileHeader::ctor(), SgAsmElfFileHeader::ctor(), SgAsmElfStringSection::ctor(), SgAsmDOSExtendedHeader::ctor(), SgAsmNERelocTable::ctor(), SgAsmLEPageTable::ctor(), SgAsmLEEntryTable::ctor(), SgAsmLERelocTable::ctor(), SgAsmNERelocEntry::ctor(), Disassembler::disassembleSection(), SgAsmGenericFile::dump(), SgAsmGenericStrtab::free_all_strings(), SgAsmGenericHeader::get_sections_by_offset(), SgAsmPEFileHeader::parse(), SgAsmLEFileHeader::parse(), SgAsmNEFileHeader::parse(), SgAsmDOSFileHeader::parse(), SgAsmElfFileHeader::parse(), SgAsmElfNoteSection::parse(), SgAsmElfEHFrameSection::parse(), SgAsmElfSymverDefinedSection::parse(), SgAsmElfSymverNeededSection::parse(), SgAsmPEFileHeader::reallocate(), SgAsmDOSFileHeader::reallocate(), SgAsmElfFileHeader::reallocate(), SgAsmElfSection::reallocate(), SgAsmElfNoteSection::reallocate(), SgAsmPEImportSection::reallocate(), SgAsmPESectionTable::reallocate(), SgAsmGenericStrtab::reallocate(), SgAsmElfStringSection::set_size(), SgAsmPEStringSection::set_size(), SgAsmGenericFile::shift_extend(), SgAsmDOSFileHeader::unparse(), SgAsmPEImportSection::unparse(), SgAsmDOSFileHeader::update_from_rm_section(), SgAsmElfSectionTableEntry::update_from_section(), SgAsmElfSegmentTableEntry::update_from_section(), and SgAsmPESectionTableEntry::update_from_section().

rose_addr_t SgAsmGenericSection::get_end_offset ( ) const

file offset for end of section

Returns starting byte offset in the file.

Definition at line 206 of file GenericSection.C.

Referenced by SgAsmNESectionTable::ctor().

void SgAsmGenericSection::extend ( rose_addr_t  size)

make section larger by extending the end

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::resize(). Sections are allowed to extend beyond the end of the file and the original data (p_data) is extended only up to the end of the file.

Definition at line 649 of file GenericSection.C.

Referenced by SgAsmPEFileHeader::add_rvasize_pairs(), SgAsmLENameTable::ctor(), SgAsmLEEntryTable::ctor(), SgAsmNERelocEntry::ctor(), SgAsmPEFileHeader::parse(), SgAsmDOSFileHeader::parse(), SgAsmElfFileHeader::parse(), and SgAsmCoffSymbolTable::parse().

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.

Parameters
fOutput steam to which to write
offsetByte offset relative to start of this section
bufsizeSize of buf in bytes
bufBuffer of bytes to be written
Returns
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_orig_size())

Definition at line 480 of file GenericSection.C.

References SageInterface::get_name(), offset, and HexdumpFormat::prefix.

Referenced by SgAsmPEFileHeader::unparse(), SgAsmLEFileHeader::unparse(), SgAsmDOSFileHeader::unparse(), SgAsmElfFileHeader::unparse(), SgAsmElfEHFrameSection::unparse(), SgAsmElfSymverSection::unparse(), SgAsmElfSymverDefinedSection::unparse(), SgAsmElfSymverNeededSection::unparse(), SgAsmPEImportSection::unparse(), SgAsmPESectionTable::unparse(), SgAsmDOSExtendedHeader::unparse(), SgAsmCoffSymbolTable::unparse(), SgAsmLESectionTable::unparse(), SgAsmLENameTable::unparse(), SgAsmLEPageTable::unparse(), SgAsmLEEntryTable::unparse(), SgAsmElfStrtab::unparse(), SgAsmCoffStrtab::unparse(), SgAsmElfNoteEntry::unparse(), SgAsmPEImportDirectory::unparse(), SgAsmNERelocEntry::unparse(), SgAsmLEEntryPoint::unparse(), and SgAsmPEImportDirectory::unparse_ilt_iat().

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

Definition at line 556 of file GenericSection.C.

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

Definition at line 563 of file GenericSection.C.

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

Definition at line 538 of file GenericSection.C.

References SgSharedVector< _Tp >::size().

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

Definition at line 547 of file GenericSection.C.

rose_addr_t SgAsmGenericSection::write_uleb128 ( unsigned char *  buf,
rose_addr_t  offset,
uint64_t  val 
) const

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

Definition at line 570 of file GenericSection.C.

References offset.

Referenced by SgAsmElfEHFrameEntryFD::unparse(), and SgAsmElfEHFrameEntryCI::unparse().

rose_addr_t SgAsmGenericSection::write_sleb128 ( unsigned char *  buf,
rose_addr_t  offset,
int64_t  val 
) const

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

Definition at line 588 of file GenericSection.C.

References offset.

Referenced by SgAsmElfEHFrameEntryCI::unparse().

size_t SgAsmGenericSection::read_content ( rose_addr_t  start_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.

Definition at line 312 of file GenericSection.C.

References SgAsmGenericFile::read_content().

Referenced by SgAsmPEExportDirectory::ctor(), SgAsmPEExportSection::parse(), SgAsmCoffSymbolTable::parse(), and SgAsmPEImportDirectory::parse_ilt_iat().

size_t SgAsmGenericSection::read_content ( const MemoryMap map,
rose_addr_t  start_va,
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_va (absolute 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 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.

Definition at line 327 of file GenericSection.C.

References SgAsmGenericFile::read_content().

size_t SgAsmGenericSection::read_content ( const MemoryMap map,
const rose_rva_t rva,
void *  dst_buf,
rose_addr_t  size,
bool  strict = true 
)
inline

Definition at line 279766 of file Cxx_Grammar.h.

References rose_rva_t::get_va().

size_t SgAsmGenericSection::read_content_local ( rose_addr_t  start_offset,
void *  dst_buf,
rose_addr_t  size,
bool  strict = true 
)

Reads data from a file.

This behaves the same as read_content() except the start_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.

Definition at line 339 of file GenericSection.C.

References SgAsmGenericFile::read_content().

Referenced by SgAsmPEFileHeader::add_rvasize_pairs(), SgAsmCoffStrtab::create_storage(), SgAsmLEFileHeader::ctor(), SgAsmLESectionTable::ctor(), SgAsmLENameTable::ctor(), SgAsmLEPageTable::ctor(), SgAsmLEEntryTable::ctor(), SgAsmCoffSymbol::ctor(), SgAsmNERelocEntry::ctor(), SgAsmPEFileHeader::parse(), SgAsmDOSFileHeader::parse(), SgAsmElfFileHeader::parse(), SgAsmElfEHFrameSection::parse(), SgAsmElfSymverSection::parse(), SgAsmElfSymverDefinedSection::parse(), SgAsmElfSymverNeededSection::parse(), SgAsmPESectionTable::parse(), SgAsmDOSExtendedHeader::parse(), SgAsmElfStrtab::parse(), and SgAsmElfNoteEntry::parse().

std::string SgAsmGenericSection::read_content_str ( const MemoryMap map,
rose_addr_t  start_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 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.

Definition at line 380 of file GenericSection.C.

References SgAsmGenericFile::read_content_str().

Referenced by SgAsmPEExportDirectory::ctor(), SgAsmPEExportSection::parse(), SgAsmPEImportDirectory::parse(), and SgAsmPEImportDirectory::parse_ilt_iat().

std::string SgAsmGenericSection::read_content_str ( const MemoryMap map,
rose_rva_t  rva,
bool  strict = true 
)
inline

Definition at line 279772 of file Cxx_Grammar.h.

References rose_rva_t::get_va().

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

Reads a string from the file.

The string begins at the specified absolute 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.

Definition at line 391 of file GenericSection.C.

References SgAsmGenericFile::read_content_str().

std::string SgAsmGenericSection::read_content_local_str ( 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.

Definition at line 402 of file GenericSection.C.

References max.

Referenced by SgAsmElfStrtab::create_storage(), SgAsmCoffSymbol::ctor(), SgAsmElfEHFrameSection::parse(), SgAsmElfSectionTable::parse(), SgAsmElfNoteEntry::parse(), and SgAsmElfStrtab::rebind().

SgUnsignedCharList SgAsmGenericSection::read_content_local_ucl ( 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.

Definition at line 364 of file GenericSection.C.

Referenced by SgAsmCoffSymbol::ctor(), SgAsmElfEHFrameSection::parse(), and SgAsmElfNoteEntry::parse().

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

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.

Definition at line 448 of file GenericSection.C.

Referenced by SgAsmElfEHFrameSection::parse().

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

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.

Definition at line 427 of file GenericSection.C.

Referenced by SgAsmElfEHFrameSection::parse().

unsigned char * SgAsmGenericSection::writable_content ( size_t  nbytes)

Sections typically point into the memory mapped, read-only file stored in the SgAsmGenericFile parent initialized by calling grab_content() (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 p_data values. But in order to modify p_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.

Definition at line 118 of file GenericSection.C.

ExtentMap SgAsmGenericSection::get_referenced_extents ( ) const

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

The offsets are relative to the start of the section.

Definition at line 609 of file GenericSection.C.

References RangeMap< R, T >::begin(), Range< T >::begins_before(), Range< T >::contained_in(), Range< T >::contains(), RangeMap< R, T >::end(), Range< T >::ends_after(), Range< T >::first(), RangeMap< R, T >::insert(), Range< T >::left_of(), Range< T >::right_of(), and Range< T >::size().

Referenced by SgAsmGenericStrtab::free_all_strings().

ExtentMap SgAsmGenericSection::get_unreferenced_extents ( ) const

Definition at line 638 of file GenericSection.C.

References ExtentMap::subtract_from().

void SgAsmGenericSection::clear_mapped ( )

Set mapped address and size to zero (unmapped)

Causes section to not be mapped to memory.

Definition at line 228 of file GenericSection.C.

rose_addr_t SgAsmGenericSection::get_base_va ( ) const

Returns base virtual address for a section, or zero if the section is not associated with a header.

Definition at line 287 of file GenericSection.C.

References SgAsmGenericHeader::get_base_va(), and isSgAsmGenericHeader().

Referenced by SgAsmGenericFile::dump(), and rose_rva_t::get_va().

rose_addr_t SgAsmGenericSection::get_mapped_preferred_va ( ) const

Returns (non-relative) virtual address if mapped, zero otherwise.

Definition at line 277 of file GenericSection.C.

Referenced by Partitioner::mark_func_symbols(), and SgAsmElfSegmentTableEntry::update_from_section().

rose_addr_t SgAsmGenericSection::get_va_offset ( rose_addr_t  va) const

Returns the file offset associated with the virtual address of a mapped section.

NOTE: The MemoryMap class is a better interface to this same information. [RPM 2009-09-09]

Definition at line 743 of file GenericSection.C.

References rva.

Referenced by SgAsmGenericFile::get_best_possible_section_by_va().

rose_addr_t SgAsmGenericSection::get_rva_offset ( rose_addr_t  rva) const

Returns the file offset associated with the relative virtual address of a mapped section.

NOTE: The MemoryMap class is a better interface to this same information. [RPM 2009-09-09]

Definition at line 734 of file GenericSection.C.

std::string SgAsmGenericSection::get_short_name ( ) const

Returns an 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. This method returns the short name if it exists, otherwise the full name.

Definition at line 155 of file GenericSection.C.

References SageInterface::get_name().

Referenced by SgAsmIntegerValueExpression::get_label().

void SgAsmGenericSection::set_short_name ( const std::string &  name)

Sets the abbreviated name of a section.

The abbreviated name is used in places like instruction disassembly.

Definition at line 164 of file GenericSection.C.

References name.

Referenced by SgAsmPEFileHeader::create_table_sections(), and SgAsmPEFileHeader::set_rvasize_pair().

Extent SgAsmGenericSection::get_file_extent ( ) const

Returns the file extent for the section.

Definition at line 213 of file GenericSection.C.

Referenced by SgAsmGenericFile::shift_extend().

Extent SgAsmGenericSection::get_mapped_preferred_extent ( ) const

Returns the memory extent for a mapped section.

If the section is not mapped then offset and size will be zero

Definition at line 300 of file GenericSection.C.

Referenced by SgAsmGenericFile::shift_extend().

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 set_file_alignment() and set_mapped_alignment()) 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::shift_extend() method.

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

Definition at line 73 of file GenericSection.C.

References ALIGN_UP.

void SgAsmGenericSection::ctor ( SgAsmGenericFile ef,
SgAsmGenericHeader hdr 
)
protected

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.

Definition at line 15 of file GenericSection.C.

References SgAsmGenericHeader::add_section().

void* SgAsmGenericSection::operator new ( size_t  size)

returns pointer to newly allocated IR node

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

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

void SgAsmGenericSection::operator delete ( void *  pointer)
static size_t SgAsmGenericSection::numberOfNodes ( )
static

Returns the total number of IR nodes of this type.

static size_t SgAsmGenericSection::memoryUsage ( )
static

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

virtual std::vector<SgNode*> SgAsmGenericSection::get_traversalSuccessorContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

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

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgAsmExecutableFileFormat.

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

virtual std::vector<std::string> SgAsmGenericSection::get_traversalSuccessorNamesContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

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

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

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

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

Reimplemented from SgAsmExecutableFileFormat.

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

void SgAsmGenericSection::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor)

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmGenericSection::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmGenericSection::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmGenericSection::visitRepresentativeNode ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgAsmGenericSection::isInMemoryPool ( )
virtual

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

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

Reimplemented from SgAsmExecutableFileFormat.

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

virtual void SgAsmGenericSection::checkDataMemberPointersIfInMemoryPool ( )
virtual

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

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

Reimplemented from SgAsmExecutableFileFormat.

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

virtual std::vector<std::pair<SgNode*,std::string> > SgAsmGenericSection::returnDataMemberPointers ( ) const
virtual

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

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

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
STL vector of pairs of SgNode* and strings

Reimplemented from SgAsmExecutableFileFormat.

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

virtual void SgAsmGenericSection::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *  )
virtual

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

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

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

Reimplemented from SgAsmExecutableFileFormat.

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

virtual long SgAsmGenericSection::getChildIndex ( SgNode childNode) const
virtual

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

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

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

Reimplemented from SgAsmExecutableFileFormat.

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

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

Support for AST matching using regular expression.

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

void SgAsmGenericSection::set_file ( SgAsmGenericFile file)
void SgAsmGenericSection::set_header ( SgAsmGenericHeader header)
SgFileContentList SgAsmGenericSection::get_data ( ) const
void SgAsmGenericSection::set_data ( SgFileContentList  data)
SgAsmGenericSection::SectionPurpose SgAsmGenericSection::get_purpose ( ) const
bool SgAsmGenericSection::get_synthesized ( ) const
bool SgAsmGenericSection::get_contains_code ( ) const
void SgAsmGenericSection::set_contains_code ( bool  contains_code)

Friends And Related Function Documentation

friend class AST_FILE_IO
friend

Definition at line 280118 of file Cxx_Grammar.h.

friend class SgAsmGenericSectionStorageClass
friend

Definition at line 280119 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass
friend

Definition at line 280120 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass
friend

Definition at line 280121 of file Cxx_Grammar.h.

ROSE_DLL_API friend SgAsmGenericSection* isSgAsmGenericSection ( SgNode s)
friend

Casts pointer from base class to derived class.

ROSE_DLL_API friend const SgAsmGenericSection* isSgAsmGenericSection ( const SgNode s)
friend

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

SgAsmGenericSection* SgAsmGenericSection_getPointerFromGlobalIndex ( unsigned long  globalIndex)
friend

Constructor for use by AST File I/O Mechanism.

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

Typedef used for low level memory access.

Typedef used to hold memory addresses as values.

Methods to find the pointer to a global and local index

unsigned long SgAsmGenericSection_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned  long)
friend

Get the size of the memory pool.

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

void SgAsmGenericSection_clearMemoryPool ( )
friend
void SgAsmGenericSection_extendMemoryPoolForFileIO ( unsigned  long)
friend
void SgAsmGenericSection_getNextValidPointer ( std::pair< SgAsmGenericSection *, std::vector< unsigned char * >::const_iterator > &  )
friend
void SgAsmGenericSection_resetValidFreepointers ( )
friend

Member Data Documentation

unsigned char* SgAsmGenericSection::local_data_pool
private

This is an optional local, writable pool for the p_data member.

Normally a section will point into the pool for its SgAsmGenericFile which is memory-mapped (read-only) from the actual file being parsed. The default unparsing action is to write the original data back to the file. By allowing a section to allocate its own pool for p_data we create a very easy way to get data into the unparsed file (the alternative is to derive a new class and override the unparse() method).

Definition at line 279820 of file Cxx_Grammar.h.

SgAsmGenericFile* SgAsmGenericSection::p_file
protected

Definition at line 280228 of file Cxx_Grammar.h.

SgAsmGenericHeader* SgAsmGenericSection::p_header
protected

Definition at line 280232 of file Cxx_Grammar.h.

rose_addr_t SgAsmGenericSection::p_size
protected

Definition at line 280236 of file Cxx_Grammar.h.

rose_addr_t SgAsmGenericSection::p_offset
protected

Definition at line 280240 of file Cxx_Grammar.h.

Referenced by SgAsmLEFileHeader::dump().

rose_addr_t SgAsmGenericSection::p_file_alignment
protected

Definition at line 280244 of file Cxx_Grammar.h.

SgAsmGenericSection::SectionPurpose SgAsmGenericSection::p_purpose
protected

Definition at line 280252 of file Cxx_Grammar.h.

bool SgAsmGenericSection::p_synthesized
protected

Definition at line 280256 of file Cxx_Grammar.h.

int SgAsmGenericSection::p_id
protected

Definition at line 280260 of file Cxx_Grammar.h.

SgAsmGenericString* SgAsmGenericSection::p_name
protected

Definition at line 280264 of file Cxx_Grammar.h.

std::string SgAsmGenericSection::p_short_name
protected

Definition at line 280268 of file Cxx_Grammar.h.

rose_addr_t SgAsmGenericSection::p_mapped_preferred_rva
protected

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.

Definition at line 280272 of file Cxx_Grammar.h.

rose_addr_t SgAsmGenericSection::p_mapped_size
protected

Definition at line 280276 of file Cxx_Grammar.h.

rose_addr_t SgAsmGenericSection::p_mapped_alignment
protected

Definition at line 280280 of file Cxx_Grammar.h.

bool SgAsmGenericSection::p_mapped_rperm
protected

Definition at line 280284 of file Cxx_Grammar.h.

bool SgAsmGenericSection::p_mapped_wperm
protected

Definition at line 280288 of file Cxx_Grammar.h.

bool SgAsmGenericSection::p_mapped_xperm
protected

Definition at line 280292 of file Cxx_Grammar.h.

bool SgAsmGenericSection::p_contains_code
protected

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.

Definition at line 280296 of file Cxx_Grammar.h.

rose_addr_t SgAsmGenericSection::p_mapped_actual_va
protected

This is the virtual address where ROSE simulates a loader mapping the 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 BinaryLoader class and subclasses thereof.

The address corresponds to the latest call into the Loader classes. Depending on the loader employed, it's possible for a section to be mapped, the p_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 p_mapped_actual_va of the first section is not reset to zero. The return value is not conditional upon is_mapped() since that predicate applies only to preferred mapping attributes.

Definition at line 280300 of file Cxx_Grammar.h.


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