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

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmDOSFileHeader:
Collaboration diagram for SgAsmDOSFileHeader:

Classes

struct  DOSFileHeader_disk
 
struct  DOSRelocEntry_disk
 

Public Types

enum  { static_variant = V_SgAsmDOSFileHeader }
 static variant value More...
 
typedef SgAsmGenericHeader base_node_type
 
- Public Types inherited from SgAsmGenericHeader
enum  { static_variant = V_SgAsmGenericHeader }
 static variant value More...
 
typedef SgAsmGenericSection base_node_type
 
- Public Types inherited from SgAsmGenericSection
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...
 
struct
SgAsmDOSFileHeader::DOSFileHeader_disk 
__attribute__ ((packed))
 
struct
SgAsmDOSFileHeader::DOSRelocEntry_disk 
__attribute__ ((packed))
 
 SgAsmDOSFileHeader (SgAsmGenericFile *f)
 
virtual SgAsmDOSFileHeaderparse ()
 
SgAsmDOSFileHeaderparse (bool define_rm_section)
 Initialize this header with information parsed from the file and construct and parse everything that's reachable from the header. More...
 
virtual bool reallocate ()
 Allocate file space for header. More...
 
virtual void unparse (std::ostream &) const
 Unparse headers and all they point to. More...
 
virtual void dump (FILE *, const char *prefix, ssize_t idx) const
 
virtual const char * format_name () const
 
SgAsmGenericSectionparse_rm_section (rose_addr_t max_offset=0)
 Parses the DOS real-mode text+data section and adds it to the AST. More...
 
void update_from_rm_section ()
 Update DOS header with data from real-mode section. 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...
 
 SgAsmDOSFileHeader (const SgAsmDOSFileHeaderStorageClass &source)
 
SgAsmDOSFileHeaderaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
uint16_t get_e_last_page_size () const
 
void set_e_last_page_size (uint16_t e_last_page_size)
 
uint16_t get_e_total_pages () const
 
void set_e_total_pages (uint16_t e_total_pages)
 
uint16_t get_e_nrelocs () const
 
void set_e_nrelocs (uint16_t e_nrelocs)
 
uint16_t get_e_header_paragraphs () const
 
void set_e_header_paragraphs (uint16_t e_header_paragraphs)
 
uint16_t get_e_minalloc () const
 
void set_e_minalloc (uint16_t e_minalloc)
 
uint16_t get_e_maxalloc () const
 
void set_e_maxalloc (uint16_t e_maxalloc)
 
uint16_t get_e_ss () const
 
void set_e_ss (uint16_t e_ss)
 
uint16_t get_e_sp () const
 
void set_e_sp (uint16_t e_sp)
 
uint16_t get_e_cksum () const
 
void set_e_cksum (uint16_t e_cksum)
 
uint16_t get_e_ip () const
 
void set_e_ip (uint16_t e_ip)
 
uint16_t get_e_cs () const
 
void set_e_cs (uint16_t e_cs)
 
uint16_t get_e_overlay () const
 
void set_e_overlay (uint16_t e_overlay)
 
rose_addr_t get_e_relocs_offset () const
 
void set_e_relocs_offset (rose_addr_t e_relocs_offset)
 
unsigned get_e_res1 () const
 
void set_e_res1 (unsigned e_res1)
 
SgAsmGenericSectionget_relocs () const
 
void set_relocs (SgAsmGenericSection *relocs)
 
SgAsmGenericSectionget_rm_section () const
 
void set_rm_section (SgAsmGenericSection *rm_section)
 
virtual ~SgAsmDOSFileHeader ()
 
 SgAsmDOSFileHeader ()
 
- Public Member Functions inherited from SgAsmGenericHeader
 SgAsmGenericHeader (SgAsmGenericFile *ef)
 
virtual ~SgAsmGenericHeader ()
 
void add_dll (SgAsmGenericDLL *dll)
 Add a new DLL to the header DLL list. More...
 
std::vector< SgAsmGenericDLL * > & get_dlls ()
 
std::vector< unsigned char > & get_magic ()
 
rose_addr_t get_entry_rva () const
 Returns the RVA (relative to the header's base virtual address) of the first entry point. More...
 
void add_entry_rva (const rose_rva_t &rva)
 
ByteOrder::Endianness get_sex () const
 
size_t get_word_size () const
 
void add_section (SgAsmGenericSection *)
 Adds a new section to the header. More...
 
void remove_section (SgAsmGenericSection *)
 Removes a secton from the header's section list. More...
 
SgAsmGenericSectionPtrList get_mapped_sections () const
 Returns the list of sections that are memory mapped. More...
 
SgAsmGenericSectionPtrList get_sections_by_id (int id) const
 Returns sections in this header that have the specified ID. More...
 
SgAsmGenericSectionPtrList get_sections_by_name (std::string, char sep=0) const
 Returns sections in this header that have the specified name. More...
 
SgAsmGenericSectionPtrList get_sections_by_offset (rose_addr_t offset, rose_addr_t size) const
 Returns sectons in this header that contain all of the specified portion of the file. More...
 
SgAsmGenericSectionPtrList get_sections_by_rva (rose_addr_t rva) const
 Returns sections that have a preferred mapping that includes the specified relative virtual address. More...
 
SgAsmGenericSectionPtrList get_sections_by_va (rose_addr_t va, bool use_preferred) const
 Returns sections having a preferred or actual mapping that includes the specified virtual address. More...
 
SgAsmGenericSectionget_section_by_id (int id, size_t *nfound=0) const
 Returns single section in this header that has the specified ID. More...
 
SgAsmGenericSectionget_section_by_name (const std::string &, char sep=0, size_t *nfound=0) const
 Returns single section in this header that has the specified name. More...
 
SgAsmGenericSectionget_section_by_offset (rose_addr_t offset, rose_addr_t size, size_t *nfound=0) const
 Returns single section in this header that contains all of the specified portion of the file. More...
 
SgAsmGenericSectionget_section_by_rva (rose_addr_t rva, size_t *nfound=0) const
 Returns the single section having a preferred mapping that includes the specified relative virtual address. More...
 
SgAsmGenericSectionget_section_by_va (rose_addr_t va, bool use_preferred, size_t *nfound=0) const
 Returns the section having a preferred or actual mapping that includes the specified virtual address. More...
 
SgAsmGenericSectionget_best_section_by_va (rose_addr_t va, bool use_preferred, size_t *nfound=0) const
 Like SgAsmGenericFile::get_best_section_by_va() except considers only sections defined in this header. 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...
 
 SgAsmGenericHeader (const SgAsmGenericHeaderStorageClass &source)
 
SgAsmGenericHeaderaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
SgAsmGenericFormatget_exec_format () const
 
void set_exec_format (SgAsmGenericFormat *exec_format)
 
SgCharList get_magic () const
 
void set_magic (SgCharList magic)
 
SgAsmGenericFormat::InsSetArchitecture get_isa () const
 
void set_isa (SgAsmGenericFormat::InsSetArchitecture isa)
 
rose_addr_t get_base_va () const
 
void set_base_va (rose_addr_t base_va)
 
const SgRVAListget_entry_rvas () const
 
SgRVAListget_entry_rvas ()
 
SgAsmGenericDLLListget_dlls () const
 
void set_dlls (SgAsmGenericDLLList *dlls)
 
SgAsmGenericSectionListget_sections () const
 
void set_sections (SgAsmGenericSectionList *sections)
 
 SgAsmGenericHeader ()
 
- Public Member Functions inherited from SgAsmGenericSection
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...
 
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...
 
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...
 
 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 bool is_DOS (SgAsmGenericFile *)
 Returns true if a cursory look at the file indicates that it could be a DOS executable file. 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 SgAsmGenericHeader
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 SgAsmGenericSection
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...
 

Public Attributes

enum SgAsmDOSFileHeader:: { ... }  __attribute__
 static variant value More...
 

Protected Attributes

uint16_t p_e_last_page_size
 
uint16_t p_e_total_pages
 
uint16_t p_e_nrelocs
 
uint16_t p_e_header_paragraphs
 
uint16_t p_e_minalloc
 
uint16_t p_e_maxalloc
 
uint16_t p_e_ss
 
uint16_t p_e_sp
 
uint16_t p_e_cksum
 
uint16_t p_e_ip
 
uint16_t p_e_cs
 
uint16_t p_e_overlay
 
rose_addr_t p_e_relocs_offset
 
unsigned p_e_res1
 
SgAsmGenericSectionp_relocs
 
SgAsmGenericSectionp_rm_section
 
- Protected Attributes inherited from SgAsmGenericHeader
SgAsmGenericFormatp_exec_format
 
SgCharList p_magic
 
SgAsmGenericFormat::InsSetArchitecture p_isa
 
rose_addr_t p_base_va
 
SgRVAList p_entry_rvas
 
SgAsmGenericDLLListp_dlls
 
SgAsmGenericSectionListp_sections
 
- Protected Attributes inherited from SgAsmGenericSection
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 Member Functions

void ctor ()
 Construct a new DOS File Header with default values. More...
 
void * encode (SgAsmDOSFileHeader::DOSFileHeader_disk *) const
 

Friends

class AST_FILE_IO
 
class SgAsmDOSFileHeaderStorageClass
 
class AstSpecificDataManagingClass
 
class AstSpecificDataManagingClassStorageClass
 
ROSE_DLL_API friend
SgAsmDOSFileHeader
isSgAsmDOSFileHeader (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const
SgAsmDOSFileHeader
isSgAsmDOSFileHeader (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgAsmDOSFileHeaderSgAsmDOSFileHeader_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O Mechanism. More...
 
unsigned long SgAsmDOSFileHeader_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgAsmDOSFileHeader_clearMemoryPool ()
 
void SgAsmDOSFileHeader_extendMemoryPoolForFileIO (unsigned long)
 
void SgAsmDOSFileHeader_getNextValidPointer (std::pair< SgAsmDOSFileHeader *, std::vector< unsigned char * >::const_iterator > &)
 
void SgAsmDOSFileHeader_resetValidFreepointers ()
 

Additional Inherited Members

- Protected Member Functions inherited from SgAsmGenericSection
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...
 
- 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

Definition at line 283448 of file Cxx_Grammar.h.

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant 

Definition at line 283546 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgAsmDOSFileHeader::SgAsmDOSFileHeader ( SgAsmGenericFile f)
inlineexplicit

Definition at line 283505 of file Cxx_Grammar.h.

SgAsmDOSFileHeader::SgAsmDOSFileHeader ( const SgAsmDOSFileHeaderStorageClass source)
virtual SgAsmDOSFileHeader::~SgAsmDOSFileHeader ( )
virtual
SgAsmDOSFileHeader::SgAsmDOSFileHeader ( )

Member Function Documentation

virtual SgNode* SgAsmDOSFileHeader::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 SgAsmGenericHeader.

struct SgAsmDOSFileHeader::DOSFileHeader_disk SgAsmDOSFileHeader::__attribute__ ( (packed)  )
struct SgAsmDOSFileHeader::DOSRelocEntry_disk SgAsmDOSFileHeader::__attribute__ ( (packed)  )
virtual SgAsmDOSFileHeader* SgAsmDOSFileHeader::parse ( )
inlinevirtual

Reimplemented from SgAsmGenericSection.

Definition at line 283508 of file Cxx_Grammar.h.

References parse().

Referenced by parse(), and SgAsmExecutableFileFormat::parseBinaryFormat().

SgAsmDOSFileHeader * SgAsmDOSFileHeader::parse ( bool  define_rm_section)

Initialize this header with information parsed from the file and construct and parse everything that's reachable from the header.

The DOS File Header should have been constructed such that SgAsmDOSFileHeader::ctor() was called.

Definition at line 65 of file ExecDOS.C.

References SgAsmGenericHeader::add_entry_rva(), SgAsmDOSFileHeader::DOSFileHeader_disk::e_cksum, SgAsmDOSFileHeader::DOSFileHeader_disk::e_cs, SgAsmDOSFileHeader::DOSFileHeader_disk::e_header_paragraphs, SgAsmDOSFileHeader::DOSFileHeader_disk::e_ip, SgAsmDOSFileHeader::DOSFileHeader_disk::e_last_page_size, SgAsmDOSFileHeader::DOSFileHeader_disk::e_magic, SgAsmDOSFileHeader::DOSFileHeader_disk::e_maxalloc, SgAsmDOSFileHeader::DOSFileHeader_disk::e_minalloc, SgAsmDOSFileHeader::DOSFileHeader_disk::e_nrelocs, SgAsmDOSFileHeader::DOSFileHeader_disk::e_overlay, SgAsmDOSFileHeader::DOSFileHeader_disk::e_relocs_offset, SgAsmDOSFileHeader::DOSFileHeader_disk::e_res1, SgAsmDOSFileHeader::DOSFileHeader_disk::e_sp, SgAsmDOSFileHeader::DOSFileHeader_disk::e_ss, SgAsmDOSFileHeader::DOSFileHeader_disk::e_total_pages, SgAsmGenericSection::extend(), SgAsmGenericSection::get_file(), SgAsmGenericFormat::get_sex(), SgAsmGenericSection::get_size(), ByteOrder::le_to_host(), ByteOrder::ORDER_LSB, SgAsmGenericHeader::p_base_va, p_e_cksum, p_e_cs, p_e_header_paragraphs, p_e_ip, p_e_last_page_size, p_e_maxalloc, p_e_minalloc, p_e_nrelocs, p_e_overlay, p_e_relocs_offset, p_e_res1, p_e_sp, p_e_ss, p_e_total_pages, SgAsmGenericHeader::p_exec_format, SgAsmGenericHeader::p_magic, SgAsmGenericSection::parse(), parse_rm_section(), SgAsmGenericSection::read_content_local(), SgAsmGenericSection::set_name(), SgAsmGenericSection::set_offset(), SgAsmGenericSection::set_purpose(), set_relocs(), SgAsmGenericSection::set_size(), SgAsmGenericSection::set_synthesized(), SgAsmGenericSection::SgAsmGenericSection(), and SgAsmGenericSection::SP_HEADER.

bool SgAsmDOSFileHeader::reallocate ( )
virtual
void SgAsmDOSFileHeader::unparse ( std::ostream &  f) const
virtual
virtual const char* SgAsmDOSFileHeader::format_name ( ) const
inlinevirtual

Reimplemented from SgAsmGenericHeader.

Definition at line 283513 of file Cxx_Grammar.h.

SgAsmGenericSection * SgAsmDOSFileHeader::parse_rm_section ( rose_addr_t  max_offset = 0)
void SgAsmDOSFileHeader::update_from_rm_section ( )

Update DOS header with data from real-mode section.

The DOS real-mode data+text section is assumed to appear immediately after the DOS Extended Header, which appears immediately after the DOS File Header, which appears at the beginning of the file. These assumptions are not checked until SgAsmDOSFileHeader::unparse() is called. See also, parse_rm_section().

Definition at line 129 of file ExecDOS.C.

References SgAsmGenericHeader::get_sections(), SgAsmGenericSectionList::get_sections(), SgAsmGenericSection::get_size(), isSgAsmDOSExtendedHeader(), p_e_header_paragraphs, p_e_last_page_size, p_e_total_pages, and p_rm_section.

Referenced by reallocate().

bool SgAsmDOSFileHeader::is_DOS ( SgAsmGenericFile file)
static

Returns true if a cursory look at the file indicates that it could be a DOS executable file.

Definition at line 42 of file ExecDOS.C.

References SgAsmGenericFile::get_tracking_references(), SgAsmGenericFile::read_content(), and SgAsmGenericFile::set_tracking_references().

Referenced by SgAsmExecutableFileFormat::parseBinaryFormat().

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

Copies AST (whole subtree, depending on the SgCopyHelp class.

returns a string representing the class name

Reimplemented from SgAsmGenericHeader.

virtual VariantT SgAsmDOSFileHeader::variantT ( ) const
virtual

returns new style SageIII enum values

Reimplemented from SgAsmGenericHeader.

void* SgAsmDOSFileHeader::operator new ( size_t  size)

returns pointer to newly allocated IR node

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

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

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

Returns the total number of IR nodes of this type.

static size_t SgAsmDOSFileHeader::memoryUsage ( )
static

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

virtual std::vector<SgNode*> SgAsmDOSFileHeader::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 SgAsmGenericHeader.

virtual std::vector<std::string> SgAsmDOSFileHeader::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 SgAsmGenericHeader.

virtual size_t SgAsmDOSFileHeader::get_numberOfTraversalSuccessors ( )
virtual

Reimplemented from SgAsmGenericHeader.

virtual SgNode* SgAsmDOSFileHeader::get_traversalSuccessorByIndex ( size_t  idx)
virtual

Reimplemented from SgAsmGenericHeader.

virtual size_t SgAsmDOSFileHeader::get_childIndex ( SgNode child)
virtual

Reimplemented from SgAsmGenericHeader.

virtual RTIReturnType SgAsmDOSFileHeader::roseRTI ( )
virtual

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

 This function provides runtime type information for accessing the

structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns
Returns a RTIReturnType object (runtime type information).

Reimplemented from SgAsmGenericHeader.

virtual const char* SgAsmDOSFileHeader::sage_class_name ( ) const
virtual

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

Reimplemented from SgAsmGenericHeader.

void SgAsmDOSFileHeader::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgAsmDOSFileHeader::accept ( ROSE_VisitorPattern visitor)
virtual

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

Reimplemented from SgAsmGenericHeader.

static void SgAsmDOSFileHeader::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmDOSFileHeader::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmDOSFileHeader::visitRepresentativeNode ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgAsmDOSFileHeader::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 SgAsmGenericHeader.

virtual void SgAsmDOSFileHeader::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 SgAsmGenericHeader.

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

virtual void SgAsmDOSFileHeader::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 SgAsmGenericHeader.

virtual long SgAsmDOSFileHeader::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 SgAsmGenericHeader.

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

uint16_t SgAsmDOSFileHeader::get_e_last_page_size ( ) const
void SgAsmDOSFileHeader::set_e_last_page_size ( uint16_t  e_last_page_size)
uint16_t SgAsmDOSFileHeader::get_e_total_pages ( ) const
void SgAsmDOSFileHeader::set_e_total_pages ( uint16_t  e_total_pages)
uint16_t SgAsmDOSFileHeader::get_e_nrelocs ( ) const
void SgAsmDOSFileHeader::set_e_nrelocs ( uint16_t  e_nrelocs)
uint16_t SgAsmDOSFileHeader::get_e_header_paragraphs ( ) const
void SgAsmDOSFileHeader::set_e_header_paragraphs ( uint16_t  e_header_paragraphs)
uint16_t SgAsmDOSFileHeader::get_e_minalloc ( ) const
void SgAsmDOSFileHeader::set_e_minalloc ( uint16_t  e_minalloc)
uint16_t SgAsmDOSFileHeader::get_e_maxalloc ( ) const
void SgAsmDOSFileHeader::set_e_maxalloc ( uint16_t  e_maxalloc)
uint16_t SgAsmDOSFileHeader::get_e_ss ( ) const
void SgAsmDOSFileHeader::set_e_ss ( uint16_t  e_ss)
uint16_t SgAsmDOSFileHeader::get_e_sp ( ) const
void SgAsmDOSFileHeader::set_e_sp ( uint16_t  e_sp)
uint16_t SgAsmDOSFileHeader::get_e_cksum ( ) const
void SgAsmDOSFileHeader::set_e_cksum ( uint16_t  e_cksum)
uint16_t SgAsmDOSFileHeader::get_e_ip ( ) const
void SgAsmDOSFileHeader::set_e_ip ( uint16_t  e_ip)
uint16_t SgAsmDOSFileHeader::get_e_cs ( ) const
void SgAsmDOSFileHeader::set_e_cs ( uint16_t  e_cs)
uint16_t SgAsmDOSFileHeader::get_e_overlay ( ) const
void SgAsmDOSFileHeader::set_e_overlay ( uint16_t  e_overlay)
rose_addr_t SgAsmDOSFileHeader::get_e_relocs_offset ( ) const
void SgAsmDOSFileHeader::set_e_relocs_offset ( rose_addr_t  e_relocs_offset)
unsigned SgAsmDOSFileHeader::get_e_res1 ( ) const
void SgAsmDOSFileHeader::set_e_res1 ( unsigned  e_res1)
SgAsmGenericSection* SgAsmDOSFileHeader::get_relocs ( ) const
void SgAsmDOSFileHeader::set_relocs ( SgAsmGenericSection relocs)

Referenced by parse().

SgAsmGenericSection* SgAsmDOSFileHeader::get_rm_section ( ) const
void SgAsmDOSFileHeader::set_rm_section ( SgAsmGenericSection rm_section)

Friends And Related Function Documentation

friend class AST_FILE_IO
friend

Definition at line 283817 of file Cxx_Grammar.h.

friend class SgAsmDOSFileHeaderStorageClass
friend

Definition at line 283818 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass
friend

Definition at line 283819 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass
friend

Definition at line 283820 of file Cxx_Grammar.h.

ROSE_DLL_API friend SgAsmDOSFileHeader* isSgAsmDOSFileHeader ( SgNode s)
friend

Casts pointer from base class to derived class.

ROSE_DLL_API friend const SgAsmDOSFileHeader* isSgAsmDOSFileHeader ( const SgNode s)
friend

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

SgAsmDOSFileHeader* SgAsmDOSFileHeader_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 SgAsmDOSFileHeader_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 SgAsmDOSFileHeader_clearMemoryPool ( )
friend
void SgAsmDOSFileHeader_extendMemoryPoolForFileIO ( unsigned  long)
friend
void SgAsmDOSFileHeader_getNextValidPointer ( std::pair< SgAsmDOSFileHeader *, std::vector< unsigned char * >::const_iterator > &  )
friend
void SgAsmDOSFileHeader_resetValidFreepointers ( )
friend

Member Data Documentation

enum { ... } SgAsmDOSFileHeader::__attribute__

static variant value

uint16_t SgAsmDOSFileHeader::p_e_last_page_size
protected

Definition at line 283937 of file Cxx_Grammar.h.

Referenced by dump(), encode(), parse(), parse_rm_section(), and update_from_rm_section().

uint16_t SgAsmDOSFileHeader::p_e_total_pages
protected

Definition at line 283941 of file Cxx_Grammar.h.

Referenced by dump(), encode(), parse(), parse_rm_section(), and update_from_rm_section().

uint16_t SgAsmDOSFileHeader::p_e_nrelocs
protected

Definition at line 283945 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_header_paragraphs
protected

Definition at line 283949 of file Cxx_Grammar.h.

Referenced by dump(), encode(), parse(), parse_rm_section(), and update_from_rm_section().

uint16_t SgAsmDOSFileHeader::p_e_minalloc
protected

Definition at line 283953 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_maxalloc
protected

Definition at line 283957 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_ss
protected

Definition at line 283961 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_sp
protected

Definition at line 283965 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_cksum
protected

Definition at line 283969 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_ip
protected

Definition at line 283973 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_cs
protected

Definition at line 283977 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

uint16_t SgAsmDOSFileHeader::p_e_overlay
protected

Definition at line 283981 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

rose_addr_t SgAsmDOSFileHeader::p_e_relocs_offset
protected

Definition at line 283985 of file Cxx_Grammar.h.

Referenced by dump(), encode(), parse(), and reallocate().

unsigned SgAsmDOSFileHeader::p_e_res1
protected

Definition at line 283989 of file Cxx_Grammar.h.

Referenced by dump(), encode(), and parse().

SgAsmGenericSection* SgAsmDOSFileHeader::p_relocs
protected

Definition at line 283993 of file Cxx_Grammar.h.

Referenced by dump(), and reallocate().

SgAsmGenericSection* SgAsmDOSFileHeader::p_rm_section
protected

Definition at line 283997 of file Cxx_Grammar.h.

Referenced by dump(), parse_rm_section(), and update_from_rm_section().


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