ROSE  0.9.9.168
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
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 13910 of file binaryInstruction.C.

Inheritance diagram for SgAsmGenericSection:
Inheritance graph
[legend]
Collaboration diagram for SgAsmGenericSection:
Collaboration graph
[legend]

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_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_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_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. More...
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value
 

Public Member Functions

 SgAsmGenericSection (SgAsmGenericFile *f, SgAsmGenericHeader *fhdr)
 Constructor linking object into ASt. More...
 
void grab_content ()
 Saves a reference to the original file data for a section based on the section's current offset and size. More...
 
virtual SgAsmGenericSectionparse ()
 
virtual void dump (FILE *, const char *prefix, ssize_t idx) const
 Print some debugging info. More...
 
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.
 
void unparse_holes (std::ostream &) const
 Write holes (unreferenced areas) back to the file.
 
SgAsmGenericHeaderis_file_header ()
 Predicate determining whether this section is also a top-level file header. More...
 
rose_addr_t get_end_offset () const
 File offset for end of section. More...
 
void extend (rose_addr_t nbytes)
 Extend a section by some number of bytes during the construction and/or parsing phase. More...
 
rose_addr_t write_uleb128 (unsigned char *, rose_addr_t offset, uint64_t) const
 Write an unsigned little-endian 128-bit value. More...
 
rose_addr_t write_sleb128 (unsigned char *, rose_addr_t offset, int64_t) const
 Write a signed little-endian 128-bit value. 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_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 Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t va, 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)
 Read a signed little-endian 128-bit value. More...
 
uint64_t read_content_local_uleb128 (rose_addr_t *rel_offset, bool strict=true)
 Read an unsigned little-endian 128-bit value. More...
 
unsigned char * writable_content (size_t nbytes)
 Obtain a local, writable pool to hold content. More...
 
AddressIntervalSet get_referenced_extents () const
 Returns a list of parts of a single section that have been referenced. More...
 
AddressIntervalSet get_unreferenced_extents () const
 Returns a list of parts of a single section that have not been referenced. More...
 
bool is_mapped () const
 Whether section desires to be mapped to memory. More...
 
void clear_mapped ()
 Causes section to not be mapped to memory. More...
 
rose_addr_t get_base_va () const
 Base virtual address for a section. More...
 
rose_addr_t get_mapped_preferred_va () const
 Virtual address where section prefers to be mapped. More...
 
rose_addr_t get_va_offset (rose_addr_t va) const
 File offset for specified virtual address. More...
 
rose_addr_t get_rva_offset (rose_addr_t rva) const
 File offset for specified relative virtual address. 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...
 
SgAsmGenericFileget_file () const
 Property: File to which this section belongs.
 
void set_file (SgAsmGenericFile *)
 Property: File to which this section belongs.
 
SgAsmGenericHeaderget_header () const
 Property: File header that owns this section.
 
void set_header (SgAsmGenericHeader *)
 Property: File header that owns this section.
 
rose_addr_t get_file_alignment () const
 Property: Required file alignment. More...
 
void set_file_alignment (rose_addr_t)
 Property: Required file alignment. More...
 
const SgFileContentListget_data () const
 Property: Original content of just this section. More...
 
void set_data (const SgFileContentList &)
 Property: Original content of just this section. More...
 
SectionPurpose get_purpose () const
 Property: General contents of the section.
 
void set_purpose (SectionPurpose)
 Property: General contents of the section.
 
bool get_synthesized () const
 Property: Whether section really exists. More...
 
void set_synthesized (bool)
 Property: Whether section really exists. More...
 
int get_id () const
 Property: Non-unique section ID or negative. More...
 
void set_id (int)
 Property: Non-unique section ID or negative. More...
 
rose_addr_t get_mapped_alignment () const
 Property: Alignment in virtual memory.
 
void set_mapped_alignment (rose_addr_t)
 Property: Alignment in virtual memory.
 
bool get_mapped_rperm () const
 Property: Whether mapped with read permission.
 
void set_mapped_rperm (bool)
 Property: Whether mapped with read permission.
 
bool get_mapped_wperm () const
 Property: Whether mapped with write permission.
 
void set_mapped_wperm (bool)
 Property: Whether mapped with write permission.
 
bool get_mapped_xperm () const
 Property: Whether mapped with execute permission.
 
void set_mapped_xperm (bool)
 Property: Whether mapped with execute permission.
 
bool get_contains_code () const
 Property: Whether a section is known to contain code. More...
 
void set_contains_code (bool)
 Property: Whether a section is known to contain code. More...
 
rose_addr_t get_mapped_actual_va () const
 Property: Virtual address where ROSE maps this section. More...
 
void set_mapped_actual_va (rose_addr_t)
 Property: Virtual address where ROSE maps this section. More...
 
rose_addr_t get_size () const
 Property: Size of section in file in bytes. More...
 
virtual void set_size (rose_addr_t)
 Property: Size of section in file in bytes. More...
 
rose_addr_t get_offset () const
 Property: Offset to start of section in file. More...
 
virtual void set_offset (rose_addr_t)
 Property: Offset to start of section in file. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, size_t bufsize, const void *buf) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const std::string &str) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, char c) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const SgFileContentList &buf) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const SgUnsignedCharList &buf) const
 Write data to a file section. More...
 
size_t read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t start, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
size_t read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, const rose_rva_t &start, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
std::string read_content_str (rose_addr_t abs_offset, bool strict=true)
 Reads a string from the file. More...
 
std::string read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &map, rose_rva_t rva, bool strict=true)
 Reads a string from the file. More...
 
rose_addr_t get_mapped_size () const
 Property: Mapped size. More...
 
virtual void set_mapped_size (rose_addr_t)
 Property: Mapped size. More...
 
rose_addr_t get_mapped_preferred_rva () const
 Property: Relative virtual address where section prefers to be mapped. More...
 
virtual void set_mapped_preferred_rva (rose_addr_t)
 Property: Relative virtual address where section prefers to be mapped. More...
 
SgAsmGenericStringget_name () const
 Property: Non-unique name of section. More...
 
void set_name (SgAsmGenericString *s)
 Property: Non-unique name of section. More...
 
std::string get_short_name () const
 Property: Abbreviated name. More...
 
void set_short_name (const std::string &)
 Property: Abbreviated name. More...
 
- Public Member Functions inherited from SgNode
virtual SgNodecopy (SgCopyHelp &help) const
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
virtual std::string class_name () const
 returns a string representing the class name 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
 
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)
 ROSETTA generated delete operator: deletes all non-traversed members.
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation More...
 
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 More...
 
virtual size_t get_numberOfTraversalSuccessors ()
 return number of children in the traversal successor list
 
virtual SgNodeget_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 More...
 
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
 generates string representing the class name: (e.g. for SgNode returns "SgNode"). More...
 
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. 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...
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
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...
 
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. More...
 
bool get_isModified () const
 Acess function for isModified flag. More...
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag. 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.
 
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) More...
 
int variant () const ROSE_DEPRECATED_FUNCTION
 Older version function returns enum value "NODE". More...
 
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. More...
 
virtual void set_attributeMechanism (AstAttributeMechanism *a)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. 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.
 
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).
 
virtual Sg_File_Infoget_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::CFGEdgecfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version.
 
virtual std::vector< VirtualCFG::CFGEdgecfgInEdges (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. 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 *, const std::string &prefix, rose_rva_t, const SgAsmGenericSectionPtrList &)
 Prints info about offsets into known sections. More...
 
- Static Public Member Functions inherited from SgAsmExecutableFileFormat
static SgAsmGenericFileparseBinaryFormat (const char *name)
 Factory method that parses a binary file. More...
 
static void unparseBinaryFormat (const std::string &name, SgAsmGenericFile *)
 Dump debugging information into a named text file. More...
 
static void unparseBinaryFormat (std::ostream &, SgAsmGenericFile *)
 Dump debugging information to specified stream. More...
 
static void initDiagnostics ()
 Initialize diagnostic streams. More...
 
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 void hexdump (std::ostream &, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
- Static Public Member Functions inherited from SgNode
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 std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...
 
static std::vector< VariantT > getClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode *, std::string > & get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map. More...
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map.
 
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_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations). More...
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations). 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.
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types.
 
static SgTypeTableget_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 SgNodebuild_node_from_nonlist_children ()
 

Protected Member Functions

void ctor (SgAsmGenericFile *, SgAsmGenericHeader *)
 
- 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.
 

Additional Inherited Members

- Static Public Attributes inherited from SgAsmExecutableFileFormat
static Sawyer::Message::Facility mlog
 Diagnostic stream. More...
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST. More...
 
bool p_isModified
 Records if IR node has been modified (data members reset). More...
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 
- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types.
 
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.
 
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.
 
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
 

Member Enumeration Documentation

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 14186 of file binaryInstruction.C.

Constructor & Destructor Documentation

SgAsmGenericSection::SgAsmGenericSection ( SgAsmGenericFile f,
SgAsmGenericHeader fhdr 
)
inline

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.

Definition at line 14201 of file binaryInstruction.C.

Member Function Documentation

rose_addr_t SgAsmGenericSection::get_file_alignment ( ) const

Property: Required file alignment.

Zero and one both imply byte alignment.

void SgAsmGenericSection::set_file_alignment ( rose_addr_t  )

Property: Required file alignment.

Zero and one both imply byte alignment.

const SgFileContentList& SgAsmGenericSection::get_data ( ) const

Property: Original content of just this section.

Points into file's content.

void SgAsmGenericSection::set_data ( const SgFileContentList )

Property: Original content of just this section.

Points into file's content.

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

void SgAsmGenericSection::set_synthesized ( bool  )

Property: Whether section really exists.

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

int SgAsmGenericSection::get_id ( ) const

Property: Non-unique section ID or negative.

ELF files have unique id numbers.

Referenced by SgAsmLEFileHeader::dump(), SgAsmNESectionTable::unparse(), and SgAsmLESectionTable::unparse().

void SgAsmGenericSection::set_id ( int  )

Property: Non-unique section ID or negative.

ELF files have unique id numbers.

bool SgAsmGenericSection::get_contains_code ( ) 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.

void SgAsmGenericSection::set_contains_code ( bool  )

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.

rose_addr_t SgAsmGenericSection::get_mapped_actual_va ( ) 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 BinaryLoader class and subclasses thereof.

The address corresponds to the latest call into the 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 is_mapped since that predicate applies only to preferred mapping attributes.

void SgAsmGenericSection::set_mapped_actual_va ( rose_addr_t  )

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 BinaryLoader class and subclasses thereof.

The address corresponds to the latest call into the 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 is_mapped since that predicate applies only to preferred mapping attributes.

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

Prints info about offsets into known sections.

void SgAsmGenericSection::grab_content ( )

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.

virtual void SgAsmGenericSection::dump ( FILE *  ,
const char *  prefix,
ssize_t  idx 
) const
virtual
virtual void SgAsmGenericSection::unparse ( std::ostream &  ) const
virtual
SgAsmGenericHeader* SgAsmGenericSection::is_file_header ( )

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.

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::resize to do that).

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::resize to do that).

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.

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.

rose_addr_t SgAsmGenericSection::get_end_offset ( ) const

File offset for end of section.

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

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

Referenced by SgAsmLEFileHeader::unparse(), SgAsmLESectionTable::unparse(), SgAsmLENameTable::unparse(), SgAsmLEPageTable::unparse(), and SgAsmLEEntryTable::unparse().

rose_addr_t SgAsmGenericSection::write ( std::ostream &  f,
rose_addr_t  offset,
const std::string &  str 
) 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).

rose_addr_t SgAsmGenericSection::write ( std::ostream &  f,
rose_addr_t  offset,
char  c 
) 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).

rose_addr_t SgAsmGenericSection::write ( std::ostream &  f,
rose_addr_t  offset,
const SgFileContentList 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).

rose_addr_t SgAsmGenericSection::write ( std::ostream &  f,
rose_addr_t  offset,
const SgUnsignedCharList &  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).

rose_addr_t SgAsmGenericSection::write_uleb128 ( 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.

rose_addr_t SgAsmGenericSection::write_sleb128 ( 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.

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

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

size_t SgAsmGenericSection::read_content ( const Rose::BinaryAnalysis::MemoryMap::Ptr ,
const rose_rva_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 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.

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

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

Referenced by read_content_str().

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

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

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.

Definition at line 14365 of file binaryInstruction.C.

References rose_rva_t::get_va(), and 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.

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. This method always behaves as a non-strict read.

int64_t SgAsmGenericSection::read_content_local_sleb128 ( 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.

uint64_t SgAsmGenericSection::read_content_local_uleb128 ( 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.

unsigned char* SgAsmGenericSection::writable_content ( 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 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 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.

AddressIntervalSet 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. The tracking actually happens at the entire file level (see SgAsmGenericFile::get_referenced_extents) and this function returns that same information but limits the results to this section, and returns section offsets rather than file offsets.

AddressIntervalSet SgAsmGenericSection::get_unreferenced_extents ( ) 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_unreferenced_extents) and this function returns that same information but limits the results to this section, and returns section offsets rather than file offsets.

bool SgAsmGenericSection::is_mapped ( ) const

Whether section desires to be mapped to memory.

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

Referenced by rose_rva_t::get_rel(), rose_rva_t::get_rva(), rose_rva_t::get_va(), rose_rva_t::section_relative(), rose_rva_t::set_rva(), and rose_rva_t::set_section().

void SgAsmGenericSection::clear_mapped ( )

Causes section to not be mapped to memory.

This method sets the mapped address and size to zero.

rose_addr_t SgAsmGenericSection::get_mapped_size ( ) const

Property: Mapped size.

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

virtual void SgAsmGenericSection::set_mapped_size ( rose_addr_t  )
virtual

Property: Mapped size.

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

rose_addr_t SgAsmGenericSection::get_mapped_preferred_rva ( ) 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.

Referenced by rose_rva_t::get_rel(), rose_rva_t::get_rva(), rose_rva_t::get_va(), rose_rva_t::section_relative(), rose_rva_t::set_rva(), and rose_rva_t::set_section().

virtual void SgAsmGenericSection::set_mapped_preferred_rva ( 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.

rose_addr_t SgAsmGenericSection::get_base_va ( ) 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.

Referenced by rose_rva_t::get_va().

rose_addr_t SgAsmGenericSection::get_mapped_preferred_va ( ) const

Virtual address where section prefers to be mapped.

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

rose_addr_t SgAsmGenericSection::get_va_offset ( 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 MemoryMap class is a better interface to this same information.

rose_addr_t SgAsmGenericSection::get_rva_offset ( 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 MemoryMap class is a better interface to this same information.

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

Referenced by SgAsmLEFileHeader::dump(), and rose_rva_t::to_string().

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.

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

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

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.

Extent SgAsmGenericSection::get_file_extent ( ) const

Returns the file extent for the section.

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

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. The return value is computed from the mapped_preferred_rva and mapped_size properties.

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 file_alignment and mapped_alignment 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::shift_extend method.

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


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