ROSE 0.11.145.192
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
SgAsmPEFileHeader Class Reference

Description

Windows PE file header.

Most of the properties come directly from the PE specification and their documentation is not repeated here.

Definition at line 3712 of file binaryInstruction.C.

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

Classes

struct  PE32OptHeader_disk
 
struct  PE64OptHeader_disk
 
struct  PEFileHeader_disk
 

Public Types

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

Public Member Functions

struct SgAsmPEFileHeader::PEFileHeader_disk __attribute__ ((packed))
 
struct SgAsmPEFileHeader::PE32OptHeader_disk __attribute__ ((packed))
 
struct SgAsmPEFileHeader::PE64OptHeader_disk __attribute__ ((packed))
 
 SgAsmPEFileHeader (SgAsmGenericFile *)
 
virtual const char * formatName () const override
 Returns the name of the file format.
 
std::string rvaSizePairName (PairPurpose, const char **short_name)
 Convert an RVA/Size Pair index number into a section name.
 
void set_rvaSizePair (PairPurpose, SgAsmPESection *)
 Define an RVA/Size pair in the PE file header.
 
void updateRvaSizePairs ()
 Update all the RVA/Size pair info from the section to which it points.
 
void addRvaSizePairs ()
 
virtual SgAsmPEFileHeaderparse () override
 Parse contents of the section.
 
virtual bool reallocate () override
 Called prior to unparse to make things consistent.
 
virtual void unparse (std::ostream &) const override
 Unparse headers and all they point to.
 
virtual void dump (FILE *, const char *prefix, ssize_t idx) const override
 Print some debugging info.
 
void createTableSections ()
 
Rose::BinaryAnalysis::MemoryMap::Ptr get_loaderMap () const
 
void set_loaderMap (const Rose::BinaryAnalysis::MemoryMap::Ptr &)
 
SgAsmPERVASizePairListget_rvasize_pairs () const
 
void set_rvasize_pairs (SgAsmPERVASizePairList *)
 
SgAsmPESectionTableget_section_table () const
 
void set_section_table (SgAsmPESectionTable *)
 
SgAsmCoffSymbolTableget_coff_symtab () const
 
void set_coff_symtab (SgAsmCoffSymbolTable *)
 
virtual const char * format_name () const override
 
std::string rvasize_pair_name (PairPurpose, const char **)
 
void set_rvasize_pair (PairPurpose, SgAsmPESection *)
 
void update_rvasize_pairs ()
 
void add_rvasize_pairs ()
 
void create_table_sections ()
 
Rose::BinaryAnalysis::MemoryMap::Ptr get_loader_map () const
 
void set_loader_map (const Rose::BinaryAnalysis::MemoryMap::Ptr &)
 
virtual ~SgAsmPEFileHeader ()
 Destructor.
 
 SgAsmPEFileHeader ()
 Default constructor.
 
unsigned const & get_e_cpu_type () const
 Property: CPU type.
 
void set_e_cpu_type (unsigned const &)
 Property: CPU type.
 
unsigned const & get_e_nsections () const
 Property: Number of sections.
 
void set_e_nsections (unsigned const &)
 Property: Number of sections.
 
unsigned const & get_e_time () const
 Property: Time.
 
void set_e_time (unsigned const &)
 Property: Time.
 
rose_addr_t const & get_e_coff_symtab () const
 Property: COFF symbol table.
 
void set_e_coff_symtab (rose_addr_t const &)
 Property: COFF symbol table.
 
rose_addr_t const & get_e_nt_hdr_size () const
 Property: Size of NT header.
 
void set_e_nt_hdr_size (rose_addr_t const &)
 Property: Size of NT header.
 
unsigned const & get_e_coff_nsyms () const
 Property: Number of COFF symbols.
 
void set_e_coff_nsyms (unsigned const &)
 Property: Number of COFF symbols.
 
unsigned const & get_e_flags () const
 Property: Flags.
 
void set_e_flags (unsigned const &)
 Property: Flags.
 
unsigned const & get_e_opt_magic () const
 Property: Magic.
 
void set_e_opt_magic (unsigned const &)
 Property: Magic.
 
unsigned const & get_e_lmajor () const
 Property: lmajor.
 
void set_e_lmajor (unsigned const &)
 Property: lmajor.
 
unsigned const & get_e_lminor () const
 Property: lminor.
 
void set_e_lminor (unsigned const &)
 Property: lminor.
 
unsigned const & get_e_code_size () const
 Property: Code size.
 
void set_e_code_size (unsigned const &)
 Property: Code size.
 
unsigned const & get_e_data_size () const
 Property: Data size.
 
void set_e_data_size (unsigned const &)
 Property: Data size.
 
unsigned const & get_e_bss_size () const
 Property: BSS size.
 
void set_e_bss_size (unsigned const &)
 Property: BSS size.
 
Rose::BinaryAnalysis::RelativeVirtualAddress const & get_e_code_rva () const
 Property: Code RVA.
 
Rose::BinaryAnalysis::RelativeVirtualAddressget_e_code_rva ()
 Property: Code RVA.
 
void set_e_code_rva (Rose::BinaryAnalysis::RelativeVirtualAddress const &)
 Property: Code RVA.
 
Rose::BinaryAnalysis::RelativeVirtualAddress const & get_e_data_rva () const
 Property: Data RVA.
 
Rose::BinaryAnalysis::RelativeVirtualAddressget_e_data_rva ()
 Property: Data RVA.
 
void set_e_data_rva (Rose::BinaryAnalysis::RelativeVirtualAddress const &)
 Property: Data RVA.
 
unsigned const & get_e_section_align () const
 Property: Section alignment.
 
void set_e_section_align (unsigned const &)
 Property: Section alignment.
 
unsigned const & get_e_file_align () const
 Property: File alignment.
 
void set_e_file_align (unsigned const &)
 Property: File alignment.
 
unsigned const & get_e_os_major () const
 Property: OS major number.
 
void set_e_os_major (unsigned const &)
 Property: OS major number.
 
unsigned const & get_e_os_minor () const
 Property: OS minor number.
 
void set_e_os_minor (unsigned const &)
 Property: OS minor number.
 
unsigned const & get_e_user_major () const
 Property: User major number.
 
void set_e_user_major (unsigned const &)
 Property: User major number.
 
unsigned const & get_e_user_minor () const
 Property: User minor number.
 
void set_e_user_minor (unsigned const &)
 Property: User minor number.
 
unsigned const & get_e_subsys_major () const
 Property: Subsystem major number.
 
void set_e_subsys_major (unsigned const &)
 Property: Subsystem major number.
 
unsigned const & get_e_subsys_minor () const
 Property: Subsystem minor number.
 
void set_e_subsys_minor (unsigned const &)
 Property: Subsystem minor number.
 
unsigned const & get_e_reserved9 () const
 Property: Reserved area #9.
 
void set_e_reserved9 (unsigned const &)
 Property: Reserved area #9.
 
unsigned const & get_e_image_size () const
 Property: Image size.
 
void set_e_image_size (unsigned const &)
 Property: Image size.
 
unsigned const & get_e_header_size () const
 Property: Header size.
 
void set_e_header_size (unsigned const &)
 Property: Header size.
 
unsigned const & get_e_file_checksum () const
 Property: File checksum.
 
void set_e_file_checksum (unsigned const &)
 Property: File checksum.
 
unsigned const & get_e_subsystem () const
 Property: Subsystem.
 
void set_e_subsystem (unsigned const &)
 Property: Subsystem.
 
unsigned const & get_e_dll_flags () const
 Property: DLL flags.
 
void set_e_dll_flags (unsigned const &)
 Property: DLL flags.
 
unsigned const & get_e_stack_reserve_size () const
 Property: Stack reserve size.
 
void set_e_stack_reserve_size (unsigned const &)
 Property: Stack reserve size.
 
unsigned const & get_e_stack_commit_size () const
 Property: Stack commit size.
 
void set_e_stack_commit_size (unsigned const &)
 Property: Stack commit size.
 
unsigned const & get_e_heap_reserve_size () const
 Property: Heap reserve size.
 
void set_e_heap_reserve_size (unsigned const &)
 Property: Heap reserve size.
 
unsigned const & get_e_heap_commit_size () const
 Property: Heap commit size.
 
void set_e_heap_commit_size (unsigned const &)
 Property: Heap commit size.
 
unsigned const & get_e_loader_flags () const
 Property: Loader flags.
 
void set_e_loader_flags (unsigned const &)
 Property: Loader flags.
 
unsigned const & get_e_num_rvasize_pairs () const
 Property: Number of RVA/size pairs.
 
void set_e_num_rvasize_pairs (unsigned const &)
 Property: Number of RVA/size pairs.
 
SgAsmPERVASizePairList *const & get_rvaSizePairs () const
 Property: RVA/size pairs.
 
void set_rvaSizePairs (SgAsmPERVASizePairList *const &)
 Property: RVA/size pairs.
 
SgAsmPESectionTable *const & get_sectionTable () const
 Property: Section table.
 
void set_sectionTable (SgAsmPESectionTable *const &)
 Property: Section table.
 
SgAsmCoffSymbolTable *const & get_coffSymbolTable () const
 Property: COFF symbol table.
 
void set_coffSymbolTable (SgAsmCoffSymbolTable *const &)
 Property: COFF symbol table.
 
- Public Member Functions inherited from SgAsmGenericHeader
 SgAsmGenericHeader (SgAsmGenericFile *)
 Constructor.
 
void addDll (SgAsmGenericDLL *dll)
 Add a new DLL to the header DLL list.
 
std::vector< SgAsmGenericDLL * > & get_dlls ()
 Vector of dynamically loaded libraries.
 
rose_addr_t get_entryRva () const
 Returns the RVA of the first entry point.
 
void addEntryRva (const Rose::BinaryAnalysis::RelativeVirtualAddress &)
 Append an RVA to the list of entry points.
 
Rose::BinaryAnalysis::ByteOrder::Endianness get_sex () const
 
size_t get_wordSize () const
 
void addSection (SgAsmGenericSection *)
 Adds a new section to the header.
 
void removeSection (SgAsmGenericSection *)
 Removes a secton from the header's section list.
 
SgAsmGenericSectionPtrList get_mappedSections () const
 Returns the list of sections that are memory mapped.
 
SgAsmGenericSectionPtrList get_sectionsById (int id) const
 Returns sections in this header that have the specified ID.
 
SgAsmGenericSectionPtrList get_sectionsByName (std::string, char sep=0) const
 Returns sections in this header that have the specified name.
 
SgAsmGenericSectionPtrList get_sectionsByOffset (rose_addr_t offset, rose_addr_t size) const
 Returns sectons in this header that contain all of the specified portion of the file.
 
SgAsmGenericSectionPtrList get_sectionsByRva (rose_addr_t rva) const
 Returns sections that have a preferred mapping that includes the specified relative virtual address.
 
SgAsmGenericSectionPtrList get_sectionsByVa (rose_addr_t va, bool use_preferred) const
 Returns sections having a preferred or actual mapping that includes the specified virtual address.
 
SgAsmGenericSectionget_sectionById (int id, size_t *nfound=0) const
 Returns single section in this header that has the specified ID.
 
SgAsmGenericSectionget_sectionByName (const std::string &, char sep=0, size_t *nfound=0) const
 Returns single section in this header that has the specified name.
 
SgAsmGenericSectionget_sectionByOffset (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.
 
SgAsmGenericSectionget_sectionByRva (rose_addr_t rva, size_t *nfound=0) const
 Returns the single section having a preferred mapping that includes the specified relative virtual address.
 
SgAsmGenericSectionget_sectionByVa (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.
 
SgAsmGenericSectionget_bestSectionByVa (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.
 
SgAsmGenericFormatget_exec_format () const
 
void set_exec_format (SgAsmGenericFormat *)
 
rose_addr_t get_base_va () const
 
void set_base_va (rose_addr_t)
 
SgRVAList & get_entry_rvas ()
 
const SgRVAList & get_entry_rvas () const
 
void set_entry_rvas (const SgRVAList &)
 
void add_dll (SgAsmGenericDLL *)
 
rose_addr_t get_entry_rva () const
 
void add_entry_rva (const Rose::BinaryAnalysis::RelativeVirtualAddress &)
 
size_t get_word_size () const
 
void add_section (SgAsmGenericSection *)
 
void remove_section (SgAsmGenericSection *)
 
SgAsmGenericSectionPtrList get_mapped_sections () const
 
SgAsmGenericSectionPtrList get_sections_by_id (int) const
 
SgAsmGenericSectionPtrList get_sections_by_name (std::string, char=0) const
 
SgAsmGenericSectionPtrList get_sections_by_offset (rose_addr_t, rose_addr_t) const
 
SgAsmGenericSectionPtrList get_sections_by_rva (rose_addr_t) const
 
SgAsmGenericSectionPtrList get_sections_by_va (rose_addr_t, bool) const
 
SgAsmGenericSectionget_section_by_id (int, size_t *=nullptr) const
 
SgAsmGenericSectionget_section_by_name (const std::string &, char=0, size_t *=nullptr) const
 
SgAsmGenericSectionget_section_by_offset (rose_addr_t, rose_addr_t, size_t *=nullptr) const
 
SgAsmGenericSectionget_section_by_rva (rose_addr_t, size_t *=nullptr) const
 
SgAsmGenericSectionget_section_by_va (rose_addr_t, bool, size_t *=nullptr) const
 
SgAsmGenericSectionget_best_section_by_va (rose_addr_t, bool, size_t *=nullptr) const
 
virtual ~SgAsmGenericHeader ()
 Destructor.
 
 SgAsmGenericHeader ()
 Default constructor.
 
SgAsmGenericFormat *const & get_executableFormat () const
 Property: General info about the executable format.
 
void set_executableFormat (SgAsmGenericFormat *const &)
 Property: General info about the executable format.
 
SgCharList const & get_magic () const
 Property: Optional magic number in file byte order.
 
SgCharList & get_magic ()
 Property: Optional magic number in file byte order.
 
void set_magic (SgCharList const &)
 Property: Optional magic number in file byte order.
 
SgAsmGenericFormat::InsSetArchitecture const & get_isa () const
 Property: Machine for which this header and its sections, etc.
 
void set_isa (SgAsmGenericFormat::InsSetArchitecture const &)
 Property: Machine for which this header and its sections, etc.
 
rose_addr_t const & get_baseVa () const
 Property: Base virtual address used by all relative virtual addresses.
 
void set_baseVa (rose_addr_t const &)
 Property: Base virtual address used by all relative virtual addresses.
 
SgRVAList const & get_entryRvas () const
 Property: Code entry point wrt base virtual address.
 
SgRVAList & get_entryRvas ()
 Property: Code entry point wrt base virtual address.
 
void set_entryRvas (SgRVAList const &)
 Property: Code entry point wrt base virtual address.
 
SgAsmGenericDLLList *const & get_dlls () const
 Property: List of dynamically linked libraries.
 
void set_dlls (SgAsmGenericDLLList *const &)
 Property: List of dynamically linked libraries.
 
SgAsmGenericSectionList *const & get_sections () const
 Property: List of file sections.
 
void set_sections (SgAsmGenericSectionList *const &)
 Property: List of file sections.
 
- Public Member Functions inherited from SgAsmGenericSection
 SgAsmGenericSection (SgAsmGenericFile *, SgAsmGenericHeader *)
 Constructor linking object into ASt.
 
void grabContent ()
 Saves a reference to the original file data for a section based on the section's current offset and size.
 
void unparse (std::ostream &, const ExtentMap &) const
 Write just the specified regions back to the file.
 
void unparseHoles (std::ostream &) const
 Write holes (unreferenced areas) back to the file.
 
SgAsmGenericHeaderisFileHeader ()
 Predicate determining whether this section is also a top-level file header.
 
rose_addr_t get_endOffset () const
 File offset for end of section.
 
void extend (rose_addr_t nbytes)
 Extend a section by some number of bytes during the construction and/or parsing phase.
 
rose_addr_t writeUleb128 (unsigned char *, rose_addr_t offset, uint64_t) const
 Write an unsigned little-endian 128-bit value.
 
rose_addr_t writeSleb128 (unsigned char *, rose_addr_t offset, int64_t) const
 Write a signed little-endian 128-bit value.
 
size_t readContent (rose_addr_t abs_offset, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file.
 
size_t readContentLocal (rose_addr_t rel_offset, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file.
 
std::string readContentString (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t va, bool strict=true)
 Reads a string from the file.
 
std::string readContentLocalString (rose_addr_t rel_offset, bool strict=true)
 Reads a string from the file.
 
SgUnsignedCharList readContentLocalUcl (rose_addr_t rel_offset, rose_addr_t size)
 Reads content of a section and returns it as a container.
 
int64_t readContentLocalSleb128 (rose_addr_t *rel_offset, bool strict=true)
 Read a signed little-endian 128-bit value.
 
uint64_t readContentLocalUleb128 (rose_addr_t *rel_offset, bool strict=true)
 Read an unsigned little-endian 128-bit value.
 
unsigned char * writableContent (size_t nbytes)
 Obtain a local, writable pool to hold content.
 
Rose::BinaryAnalysis::AddressIntervalSet get_referencedExtents () const
 Returns a list of parts of a single section that have been referenced.
 
Rose::BinaryAnalysis::AddressIntervalSet get_unreferencedExtents () const
 Returns a list of parts of a single section that have not been referenced.
 
bool isMapped () const
 Whether section desires to be mapped to memory.
 
void clearMapped ()
 Causes section to not be mapped to memory.
 
rose_addr_t get_baseVa () const
 Base virtual address for a section.
 
rose_addr_t get_mappedPreferredVa () const
 Virtual address where section prefers to be mapped.
 
rose_addr_t get_vaOffset (rose_addr_t va) const
 File offset for specified virtual address.
 
rose_addr_t get_rvaOffset (rose_addr_t rva) const
 File offset for specified relative virtual address.
 
Extent get_fileExtent () const
 Returns the file extent for the section.
 
Extent get_mappedPreferredExtent () const
 Returns the memory extent for a mapped section.
 
bool align ()
 Increase file offset and mapping address to satisfy alignment constraints.
 
rose_addr_t get_file_alignment () const
 
void set_file_alignment (rose_addr_t)
 
std::string get_short_name () const
 
void set_short_name (const std::string &)
 
rose_addr_t get_mapped_preferred_rva () const
 
void set_mapped_preferred_rva (rose_addr_t)
 
rose_addr_t get_mapped_size () const
 
void set_mapped_size (rose_addr_t)
 
rose_addr_t get_mapped_alignment () const
 
void set_mapped_alignment (rose_addr_t)
 
bool get_mapped_rperm () const
 
void set_mapped_rperm (bool)
 
bool get_mapped_wperm () const
 
void set_mapped_wperm (bool)
 
bool get_mapped_xperm () const
 
void set_mapped_xperm (bool)
 
bool get_contains_code () const
 
void set_contains_code (bool)
 
rose_addr_t get_mapped_actual_va () const
 
void set_mapped_actual_va (rose_addr_t)
 
void grab_content ()
 
void unparse_holes (std::ostream &) const
 
SgAsmGenericHeaderis_file_header ()
 
rose_addr_t get_end_offset () const
 
rose_addr_t write_uleb128 (unsigned char *, rose_addr_t, uint64_t) const
 
rose_addr_t write_sleb128 (unsigned char *, rose_addr_t, int64_t) const
 
size_t read_content (rose_addr_t, void *, rose_addr_t, bool=true)
 
size_t read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t, void *, rose_addr_t, bool=true)
 
size_t read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, const Rose::BinaryAnalysis::RelativeVirtualAddress &, void *, rose_addr_t, bool=true)
 
size_t read_content_local (rose_addr_t, void *, rose_addr_t, bool=true)
 
std::string read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t, bool=true)
 
std::string read_content_str (rose_addr_t, bool=true)
 
std::string read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &, Rose::BinaryAnalysis::RelativeVirtualAddress, bool=true)
 
std::string read_content_local_str (rose_addr_t, bool=true)
 
SgUnsignedCharList read_content_local_ucl (rose_addr_t, rose_addr_t)
 
int64_t read_content_local_sleb128 (rose_addr_t *, bool=true)
 
uint64_t read_content_local_uleb128 (rose_addr_t *, bool=true)
 
unsigned char * writable_content (size_t)
 
Rose::BinaryAnalysis::AddressIntervalSet get_referenced_extents () const
 
Rose::BinaryAnalysis::AddressIntervalSet get_unreferenced_extents () const
 
bool is_mapped () const
 
void clear_mapped ()
 
rose_addr_t get_base_va () const
 
rose_addr_t get_mapped_preferred_va () const
 
rose_addr_t get_va_offset (rose_addr_t) const
 
rose_addr_t get_rva_offset (rose_addr_t) const
 
Extent get_file_extent () const
 
Extent get_mapped_preferred_extent () const
 
virtual ~SgAsmGenericSection ()
 Destructor.
 
 SgAsmGenericSection ()
 Default constructor.
 
SgAsmGenericFile *const & get_file () const
 Property: File to which this section belongs.
 
void set_file (SgAsmGenericFile *const &)
 Property: File to which this section belongs.
 
SgAsmGenericHeader *const & get_header () const
 Property: File header that owns this section.
 
void set_header (SgAsmGenericHeader *const &)
 Property: File header that owns this section.
 
rose_addr_t get_size () const
 Property: Size of section in file in bytes.
 
virtual void set_size (rose_addr_t)
 Property: Size of section in file in bytes.
 
rose_addr_t get_offset () const
 Property: Offset to start of section in file.
 
virtual void set_offset (rose_addr_t)
 Property: Offset to start of section in file.
 
rose_addr_t const & get_fileAlignment () const
 Property: Required file alignment.
 
void set_fileAlignment (rose_addr_t const &)
 Property: Required file alignment.
 
SgFileContentList const & get_data () const
 Property: Original content of just this section.
 
void set_data (SgFileContentList const &)
 Property: Original content of just this section.
 
SgAsmGenericSection::SectionPurpose const & get_purpose () const
 Property: General contents of the section.
 
void set_purpose (SgAsmGenericSection::SectionPurpose const &)
 Property: General contents of the section.
 
bool const & get_synthesized () const
 Property: Whether section really exists.
 
void set_synthesized (bool const &)
 Property: Whether section really exists.
 
int const & get_id () const
 Property: Non-unique section ID or negative.
 
void set_id (int const &)
 Property: Non-unique section ID or negative.
 
SgAsmGenericString *const & get_name () const
 Property: Non-unique name of section.
 
void set_name (SgAsmGenericString *s)
 Property: Non-unique name of section.
 
void set_shortName (std::string const &)
 Property: Abbreviated name.
 
std::string get_shortName () const
 Property: Abbreviated name.
 
rose_addr_t const & get_mappedPreferredRva () const
 Property: Relative virtual address where section prefers to be mapped.
 
virtual void set_mappedPreferredRva (rose_addr_t)
 Property: Relative virtual address where section prefers to be mapped.
 
rose_addr_t const & get_mappedSize () const
 Property: Mapped size.
 
virtual void set_mappedSize (rose_addr_t)
 Property: Mapped size.
 
rose_addr_t const & get_mappedAlignment () const
 Property: Alignment in virtual memory.
 
void set_mappedAlignment (rose_addr_t const &)
 Property: Alignment in virtual memory.
 
bool const & get_mappedReadPermission () const
 Property: Whether mapped with read permission.
 
void set_mappedReadPermission (bool const &)
 Property: Whether mapped with read permission.
 
bool const & get_mappedWritePermission () const
 Property: Whether mapped with write permission.
 
void set_mappedWritePermission (bool const &)
 Property: Whether mapped with write permission.
 
bool const & get_mappedExecutePermission () const
 Property: Whether mapped with execute permission.
 
void set_mappedExecutePermission (bool const &)
 Property: Whether mapped with execute permission.
 
bool const & get_containsCode () const
 Property: Whether a section is known to contain code.
 
void set_containsCode (bool const &)
 Property: Whether a section is known to contain code.
 
rose_addr_t const & get_mappedActualVa () const
 Property: Virtual address where ROSE maps this section.
 
void set_mappedActualVa (rose_addr_t const &)
 Property: Virtual address where ROSE maps this section.
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, size_t bufsize, const void *buf) const
 Write data to a file section.
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const std::string &str) const
 Write data to a file section.
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, char c) const
 Write data to a file section.
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const SgFileContentList &buf) const
 Write data to a file section.
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const SgUnsignedCharList &buf) const
 Write data to a file section.
 
size_t readContent (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t start, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file.
 
size_t readContent (const Rose::BinaryAnalysis::MemoryMap::Ptr &, const Rose::BinaryAnalysis::RelativeVirtualAddress &start, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file.
 
std::string readContentString (rose_addr_t abs_offset, bool strict=true)
 Reads a string from the file.
 
std::string readContentString (const Rose::BinaryAnalysis::MemoryMap::Ptr &map, Rose::BinaryAnalysis::RelativeVirtualAddress rva, bool strict=true)
 Reads a string from the file.
 
- Public Member Functions inherited from SgAsmExecutableFileFormat
virtual ~SgAsmExecutableFileFormat ()
 Destructor.
 
- Public Member Functions inherited from SgAsmNode
virtual ~SgAsmNode ()
 Destructor.
 
Sawyer::Attribute::Storage const & attributes () const
 Attribute storage.
 
Sawyer::Attribute::Storageattributes ()
 Attribute storage.
 
- Public Member Functions inherited from SgNode
virtual SgNodecopy (SgCopyHelp &help) const
 
virtual std::string class_name () const
 returns a string representing the class name
 
virtual VariantT variantT () const
 returns new style SageIII enum values
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
virtual size_t get_numberOfTraversalSuccessors ()
 return number of children in the traversal successor list
 
virtual 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 const char * sage_class_name () const
 generates string representing the class name: (e.g. for SgNode returns "SgNode").
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
virtual void accept (ROSE_VisitorPattern &visitor)
 support for the classic visitor pattern done in GoF
 
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
 
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
 
virtual std::vector< std::pair< SgNode *, std::string > > returnDataMemberPointers () const
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
 
virtual long getChildIndex (SgNode *childNode) const
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST.
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified.
 
bool get_isModified () const
 Acess function for isModified flag.
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag.
 
SgNodeget_raw_parent () const
 Access function for direct access to uncomputed value of parent node.
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
std::string unparseToString () const
 
int variant () const
 Older version function returns enum value "NODE".
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string.
 
virtual AstAttributegetAttribute (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 AstAttributeMechanismget_attributeMechanism () const
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.
 
virtual void set_attributeMechanism (AstAttributeMechanism *a)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.
 
virtual void fixupCopy_scopes (SgNode *copy, SgCopyHelp &help) const
 
virtual void fixupCopy_symbols (SgNode *copy, SgCopyHelp &help) const
 
virtual void fixupCopy_references (SgNode *copy, SgCopyHelp &help) const
 
virtual Sg_File_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.
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST.
 
template<class T >
T * initParentPointer (T *child, SgNode *parent)
 Generated for tree edge data member initializations.
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor.
 
 SgNode ()
 This is the constructor.
 
virtual SgNodecopy (SgCopyHelp &help) const
 
virtual std::string class_name () const
 returns a string representing the class name
 
virtual VariantT variantT () const
 returns new style SageIII enum values
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation
 
virtual size_t get_numberOfTraversalSuccessors ()
 return number of children in the traversal successor list
 
virtual 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
 
virtual const char * sage_class_name () const
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
virtual void accept (ROSE_VisitorPattern &visitor)
 support for the classic visitor pattern done in GoF
 
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
 
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
 
virtual std::vector< std::pair< SgNode *, std::string > > returnDataMemberPointers () const
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
 
virtual long getChildIndex (SgNode *childNode) const
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST.
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified.
 
bool get_isModified () const
 Acess function for isModified flag.
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag.
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node.
 
SgNodeget_parent () const
 Access function for parent node.
 
SgNodeget_raw_parent () const
 Access function for direct access to uncomputed value of parent node.
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
std::string unparseToString () const
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space)
 
int variant () const
 
bool get_isVisited () const
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals.
 
void set_isVisited (bool isVisited)
 Access function for p_isVisited flag used previously by the AST traversals.
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string.
 
virtual AstAttributegetAttribute (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 AstAttributeMechanismget_attributeMechanism () const
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.
 
virtual void set_attributeMechanism (AstAttributeMechanism *a)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.
 
virtual void fixupCopy_scopes (SgNode *copy, SgCopyHelp &help) const
 
virtual void fixupCopy_symbols (SgNode *copy, SgCopyHelp &help) const
 
virtual void fixupCopy_references (SgNode *copy, SgCopyHelp &help) const
 
virtual Sg_File_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.
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST.
 
template<class T >
T * initParentPointer (T *child, SgNode *parent)
 Generated for tree edge data member initializations.
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation
 
virtual RTIReturnType roseRTI ()
 return C++ Runtime-Time-Information
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node.
 
SgNodeget_parent () const
 Access function for parent node.
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space)
 
bool get_isVisited () const
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals.
 
void set_isVisited (bool isVisited)
 Access function for p_isVisited flag used previously by the AST traversals.
 
template<class T >
std::enable_if< std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 
template<class T >
std::enable_if<!std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 
template<class T >
std::enable_if< std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 
template<class T >
std::enable_if<!std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child.
 

Static Public Member Functions

static bool isPe (SgAsmGenericFile *)
 Return true if the file looks like it might be a PE file according to the magic number.
 
static bool is_PE (SgAsmGenericFile *)
 
- Static Public Member Functions inherited from SgAsmGenericSection
static void dumpContainingSections (FILE *, const std::string &prefix, Rose::BinaryAnalysis::RelativeVirtualAddress, const SgAsmGenericSectionPtrList &)
 Prints info about offsets into known sections.
 
static void dump_containing_sections (FILE *, const std::string &, Rose::BinaryAnalysis::RelativeVirtualAddress, const SgAsmGenericSectionPtrList &)
 
- Static Public Member Functions inherited from SgAsmExecutableFileFormat
static SgAsmGenericFileparseBinaryFormat (const char *name)
 Factory method that parses a binary file.
 
static void unparseBinaryFormat (const std::string &name, SgAsmGenericFile *)
 Dump debugging information into a named text file.
 
static void unparseBinaryFormat (std::ostream &, SgAsmGenericFile *)
 Dump debugging information to specified stream.
 
static void initDiagnostics ()
 Initialize diagnostic streams.
 
static std::string isaFamilyToString (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string isaToString (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string toString (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string toString (SgAsmExecutableFileFormat::ExecFamily)
 
static std::string toString (SgAsmExecutableFileFormat::ExecABI)
 
static std::string toString (SgAsmExecutableFileFormat::ExecPurpose)
 
static std::string isa_family_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string isa_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecFamily)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecABI)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecPurpose)
 
- Static Public Member Functions inherited from SgNode
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgNodegetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgNode *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgNode *sgnode)
 
static std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism.
 
static std::vector< VariantT > getClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode *, std::string > & get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map.
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map.
 
static std::map< std::string, uint64_t > & get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map.
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names).
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type).
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type).
 
static std::map< SgNode *, std::map< SgNode *, std::string > > & get_globalQualifiedNameMapForMapsOfTypes ()
 Access function for name qualification support (for maps of types).
 
static void set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
 Access function for name qualification support (for maps of types).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations).
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations).
 
static std::map< SgNode *, std::string > & get_globalTypeNameMap ()
 Access function for name qualification support (for names of types).
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types).
 
static 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 VariantT variantFromPool (SgNode const *n)
 
template<class T >
static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type createAndParent (SgNode *parent)
 Allocate and return a new node after setting its parent.
 
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgNodegetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgNode *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgNode *sgnode)
 
static std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism.
 
static std::vector< VariantT > getClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode *, std::string > & get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map.
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map.
 
static std::map< std::string, uint64_t > & get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map.
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names).
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type).
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type).
 
static std::map< SgNode *, std::map< SgNode *, std::string > > & get_globalQualifiedNameMapForMapsOfTypes ()
 Access function for name qualification support (for maps of types).
 
static void set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
 Access function for name qualification support (for maps of types).
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations).
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations).
 
static std::map< SgNode *, std::string > & get_globalTypeNameMap ()
 Access function for name qualification support (for names of types).
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types).
 
static 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 VariantT variantFromPool (SgNode const *n)
 
template<class T >
static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type createAndParent (SgNode *parent)
 Allocate and return a new node after setting its parent.
 

Public Attributes

enum SgAsmPEFileHeader::HeaderFlags __attribute__
 

Protected Member Functions

void initializeProperties ()
 Initialize all properties that have explicit initial values.
 
- Protected Member Functions inherited from SgAsmGenericHeader
void initializeProperties ()
 Initialize all properties that have explicit initial values.
 
- Protected Member Functions inherited from SgAsmGenericSection
virtual void destructorHelper () override
 This gets called by all Rosebud-generated destructors.
 
void initializeProperties ()
 Initialize all properties that have explicit initial values.
 
- Protected Member Functions inherited from SgAsmExecutableFileFormat
 SgAsmExecutableFileFormat ()
 Default constructor.
 
void initializeProperties ()
 Initialize all properties that have explicit initial values.
 
- Protected Member Functions inherited from SgAsmNode
 SgAsmNode ()
 Default constructor.
 
void initializeProperties ()
 Initialize all properties that have explicit initial values.
 
- Protected Member Functions inherited from SgNode
virtual void post_construction_initialization ()
 Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.
 
virtual void post_construction_initialization ()
 Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.
 
virtual void debugSerializationBegin (const char *className)
 Called by generated serializers.
 
virtual void debugSerializationEnd (const char *className)
 Called by generated serializers.
 
virtual void debugSerializationBegin (const char *className)
 Called by generated serializers.
 
virtual void debugSerializationEnd (const char *className)
 Called by generated serializers.
 

Additional Inherited Members

- Static Public Attributes inherited from SgAsmExecutableFileFormat
static Sawyer::Message::Facility mlog
 Diagnostic stream.
 
- Protected Attributes inherited from SgAsmGenericSection
unsigned char * local_data_pool
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST.
 
bool p_isModified
 Records if IR node has been modified (data members reset).
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 
- Static Protected Attributes inherited from SgNode
static std::vector< std::tuple< unsigned char *, unsigned, VariantT > > all_pools
 
static 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, uint64_t > p_shortMangledNameCache
 STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates.
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForNames
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTypes
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTemplateHeaders
 
static std::map< SgNode *, std::string > p_globalTypeNameMap
 
static std::map< SgNode *, std::map< SgNode *, std::string > > p_globalQualifiedNameMapForMapsOfTypes
 

Member Enumeration Documentation

◆ HeaderFlags

enum SgAsmPEFileHeader::HeaderFlags

Definition at line 4097 of file binaryInstruction.C.

◆ Subsystem

enum SgAsmPEFileHeader::Subsystem

Definition at line 4106 of file binaryInstruction.C.

◆ DLLFlags

enum SgAsmPEFileHeader::DLLFlags

Definition at line 4116 of file binaryInstruction.C.

◆ PairPurpose

Reason for each rva/size pair in the PE header.

Definition at line 4125 of file binaryInstruction.C.

Member Function Documentation

◆ get_e_cpu_type()

unsigned const & SgAsmPEFileHeader::get_e_cpu_type ( ) const

Property: CPU type.

See PE specification.

◆ set_e_cpu_type()

void SgAsmPEFileHeader::set_e_cpu_type ( unsigned const &  )

Property: CPU type.

See PE specification.

◆ get_e_nsections()

unsigned const & SgAsmPEFileHeader::get_e_nsections ( ) const

Property: Number of sections.

See PE specification.

◆ set_e_nsections()

void SgAsmPEFileHeader::set_e_nsections ( unsigned const &  )

Property: Number of sections.

See PE specification.

◆ get_e_time()

unsigned const & SgAsmPEFileHeader::get_e_time ( ) const

Property: Time.

See PE specification.

◆ set_e_time()

void SgAsmPEFileHeader::set_e_time ( unsigned const &  )

Property: Time.

See PE specification.

◆ get_e_coff_symtab()

rose_addr_t const & SgAsmPEFileHeader::get_e_coff_symtab ( ) const

Property: COFF symbol table.

See PE specification.

◆ set_e_coff_symtab()

void SgAsmPEFileHeader::set_e_coff_symtab ( rose_addr_t const &  )

Property: COFF symbol table.

See PE specification.

◆ get_e_nt_hdr_size()

rose_addr_t const & SgAsmPEFileHeader::get_e_nt_hdr_size ( ) const

Property: Size of NT header.

See PE specification.

◆ set_e_nt_hdr_size()

void SgAsmPEFileHeader::set_e_nt_hdr_size ( rose_addr_t const &  )

Property: Size of NT header.

See PE specification.

◆ get_e_coff_nsyms()

unsigned const & SgAsmPEFileHeader::get_e_coff_nsyms ( ) const

Property: Number of COFF symbols.

See PE specification.

◆ set_e_coff_nsyms()

void SgAsmPEFileHeader::set_e_coff_nsyms ( unsigned const &  )

Property: Number of COFF symbols.

See PE specification.

◆ get_e_flags()

unsigned const & SgAsmPEFileHeader::get_e_flags ( ) const

Property: Flags.

See PE specification.

◆ set_e_flags()

void SgAsmPEFileHeader::set_e_flags ( unsigned const &  )

Property: Flags.

See PE specification.

◆ get_e_opt_magic()

unsigned const & SgAsmPEFileHeader::get_e_opt_magic ( ) const

Property: Magic.

See PE specification.

◆ set_e_opt_magic()

void SgAsmPEFileHeader::set_e_opt_magic ( unsigned const &  )

Property: Magic.

See PE specification.

◆ get_e_lmajor()

unsigned const & SgAsmPEFileHeader::get_e_lmajor ( ) const

Property: lmajor.

See PE specification.

◆ set_e_lmajor()

void SgAsmPEFileHeader::set_e_lmajor ( unsigned const &  )

Property: lmajor.

See PE specification.

◆ get_e_lminor()

unsigned const & SgAsmPEFileHeader::get_e_lminor ( ) const

Property: lminor.

See PE specification.

◆ set_e_lminor()

void SgAsmPEFileHeader::set_e_lminor ( unsigned const &  )

Property: lminor.

See PE specification.

◆ get_e_code_size()

unsigned const & SgAsmPEFileHeader::get_e_code_size ( ) const

Property: Code size.

See PE specification.

◆ set_e_code_size()

void SgAsmPEFileHeader::set_e_code_size ( unsigned const &  )

Property: Code size.

See PE specification.

◆ get_e_data_size()

unsigned const & SgAsmPEFileHeader::get_e_data_size ( ) const

Property: Data size.

See PE specification.

◆ set_e_data_size()

void SgAsmPEFileHeader::set_e_data_size ( unsigned const &  )

Property: Data size.

See PE specification.

◆ get_e_bss_size()

unsigned const & SgAsmPEFileHeader::get_e_bss_size ( ) const

Property: BSS size.

See PE specification.

◆ set_e_bss_size()

void SgAsmPEFileHeader::set_e_bss_size ( unsigned const &  )

Property: BSS size.

See PE specification.

◆ get_e_code_rva() [1/2]

Rose::BinaryAnalysis::RelativeVirtualAddress const & SgAsmPEFileHeader::get_e_code_rva ( ) const

Property: Code RVA.

See PE specification.

◆ get_e_code_rva() [2/2]

Rose::BinaryAnalysis::RelativeVirtualAddress & SgAsmPEFileHeader::get_e_code_rva ( )

Property: Code RVA.

See PE specification.

◆ set_e_code_rva()

void SgAsmPEFileHeader::set_e_code_rva ( Rose::BinaryAnalysis::RelativeVirtualAddress const &  )

Property: Code RVA.

See PE specification.

◆ get_e_data_rva() [1/2]

Rose::BinaryAnalysis::RelativeVirtualAddress const & SgAsmPEFileHeader::get_e_data_rva ( ) const

Property: Data RVA.

See PE specification.

◆ get_e_data_rva() [2/2]

Rose::BinaryAnalysis::RelativeVirtualAddress & SgAsmPEFileHeader::get_e_data_rva ( )

Property: Data RVA.

See PE specification.

◆ set_e_data_rva()

void SgAsmPEFileHeader::set_e_data_rva ( Rose::BinaryAnalysis::RelativeVirtualAddress const &  )

Property: Data RVA.

See PE specification.

◆ get_e_section_align()

unsigned const & SgAsmPEFileHeader::get_e_section_align ( ) const

Property: Section alignment.

See PE specification.

◆ set_e_section_align()

void SgAsmPEFileHeader::set_e_section_align ( unsigned const &  )

Property: Section alignment.

See PE specification.

◆ get_e_file_align()

unsigned const & SgAsmPEFileHeader::get_e_file_align ( ) const

Property: File alignment.

See PE specification.

◆ set_e_file_align()

void SgAsmPEFileHeader::set_e_file_align ( unsigned const &  )

Property: File alignment.

See PE specification.

◆ get_e_os_major()

unsigned const & SgAsmPEFileHeader::get_e_os_major ( ) const

Property: OS major number.

See PE specification.

◆ set_e_os_major()

void SgAsmPEFileHeader::set_e_os_major ( unsigned const &  )

Property: OS major number.

See PE specification.

◆ get_e_os_minor()

unsigned const & SgAsmPEFileHeader::get_e_os_minor ( ) const

Property: OS minor number.

See PE specification.

◆ set_e_os_minor()

void SgAsmPEFileHeader::set_e_os_minor ( unsigned const &  )

Property: OS minor number.

See PE specification.

◆ get_e_user_major()

unsigned const & SgAsmPEFileHeader::get_e_user_major ( ) const

Property: User major number.

See PE specification.

◆ set_e_user_major()

void SgAsmPEFileHeader::set_e_user_major ( unsigned const &  )

Property: User major number.

See PE specification.

◆ get_e_user_minor()

unsigned const & SgAsmPEFileHeader::get_e_user_minor ( ) const

Property: User minor number.

See PE specification.

◆ set_e_user_minor()

void SgAsmPEFileHeader::set_e_user_minor ( unsigned const &  )

Property: User minor number.

See PE specification.

◆ get_e_subsys_major()

unsigned const & SgAsmPEFileHeader::get_e_subsys_major ( ) const

Property: Subsystem major number.

See PE specification.

◆ set_e_subsys_major()

void SgAsmPEFileHeader::set_e_subsys_major ( unsigned const &  )

Property: Subsystem major number.

See PE specification.

◆ get_e_subsys_minor()

unsigned const & SgAsmPEFileHeader::get_e_subsys_minor ( ) const

Property: Subsystem minor number.

See PE specification.

◆ set_e_subsys_minor()

void SgAsmPEFileHeader::set_e_subsys_minor ( unsigned const &  )

Property: Subsystem minor number.

See PE specification.

◆ get_e_reserved9()

unsigned const & SgAsmPEFileHeader::get_e_reserved9 ( ) const

Property: Reserved area #9.

See PE specification.

◆ set_e_reserved9()

void SgAsmPEFileHeader::set_e_reserved9 ( unsigned const &  )

Property: Reserved area #9.

See PE specification.

◆ get_e_image_size()

unsigned const & SgAsmPEFileHeader::get_e_image_size ( ) const

Property: Image size.

See PE specification.

◆ set_e_image_size()

void SgAsmPEFileHeader::set_e_image_size ( unsigned const &  )

Property: Image size.

See PE specification.

◆ get_e_header_size()

unsigned const & SgAsmPEFileHeader::get_e_header_size ( ) const

Property: Header size.

See PE specification.

◆ set_e_header_size()

void SgAsmPEFileHeader::set_e_header_size ( unsigned const &  )

Property: Header size.

See PE specification.

◆ get_e_file_checksum()

unsigned const & SgAsmPEFileHeader::get_e_file_checksum ( ) const

Property: File checksum.

See PE specification.

◆ set_e_file_checksum()

void SgAsmPEFileHeader::set_e_file_checksum ( unsigned const &  )

Property: File checksum.

See PE specification.

◆ get_e_subsystem()

unsigned const & SgAsmPEFileHeader::get_e_subsystem ( ) const

Property: Subsystem.

See PE specification.

◆ set_e_subsystem()

void SgAsmPEFileHeader::set_e_subsystem ( unsigned const &  )

Property: Subsystem.

See PE specification.

◆ get_e_dll_flags()

unsigned const & SgAsmPEFileHeader::get_e_dll_flags ( ) const

Property: DLL flags.

See PE specification.

◆ set_e_dll_flags()

void SgAsmPEFileHeader::set_e_dll_flags ( unsigned const &  )

Property: DLL flags.

See PE specification.

◆ get_e_stack_reserve_size()

unsigned const & SgAsmPEFileHeader::get_e_stack_reserve_size ( ) const

Property: Stack reserve size.

See PE specification.

◆ set_e_stack_reserve_size()

void SgAsmPEFileHeader::set_e_stack_reserve_size ( unsigned const &  )

Property: Stack reserve size.

See PE specification.

◆ get_e_stack_commit_size()

unsigned const & SgAsmPEFileHeader::get_e_stack_commit_size ( ) const

Property: Stack commit size.

See PE specification.

◆ set_e_stack_commit_size()

void SgAsmPEFileHeader::set_e_stack_commit_size ( unsigned const &  )

Property: Stack commit size.

See PE specification.

◆ get_e_heap_reserve_size()

unsigned const & SgAsmPEFileHeader::get_e_heap_reserve_size ( ) const

Property: Heap reserve size.

See PE specification.

◆ set_e_heap_reserve_size()

void SgAsmPEFileHeader::set_e_heap_reserve_size ( unsigned const &  )

Property: Heap reserve size.

See PE specification.

◆ get_e_heap_commit_size()

unsigned const & SgAsmPEFileHeader::get_e_heap_commit_size ( ) const

Property: Heap commit size.

See PE specification.

◆ set_e_heap_commit_size()

void SgAsmPEFileHeader::set_e_heap_commit_size ( unsigned const &  )

Property: Heap commit size.

See PE specification.

◆ get_e_loader_flags()

unsigned const & SgAsmPEFileHeader::get_e_loader_flags ( ) const

Property: Loader flags.

See PE specification.

◆ set_e_loader_flags()

void SgAsmPEFileHeader::set_e_loader_flags ( unsigned const &  )

Property: Loader flags.

See PE specification.

◆ get_e_num_rvasize_pairs()

unsigned const & SgAsmPEFileHeader::get_e_num_rvasize_pairs ( ) const

Property: Number of RVA/size pairs.

See PE specification.

◆ set_e_num_rvasize_pairs()

void SgAsmPEFileHeader::set_e_num_rvasize_pairs ( unsigned const &  )

Property: Number of RVA/size pairs.

See PE specification.

◆ get_rvaSizePairs()

SgAsmPERVASizePairList *const & SgAsmPEFileHeader::get_rvaSizePairs ( ) const

Property: RVA/size pairs.

See PE specification.

◆ set_rvaSizePairs()

void SgAsmPEFileHeader::set_rvaSizePairs ( SgAsmPERVASizePairList *const &  )

Property: RVA/size pairs.

See PE specification.

◆ get_sectionTable()

SgAsmPESectionTable *const & SgAsmPEFileHeader::get_sectionTable ( ) const

Property: Section table.

See PE specification.

◆ set_sectionTable()

void SgAsmPEFileHeader::set_sectionTable ( SgAsmPESectionTable *const &  )

Property: Section table.

See PE specification.

◆ get_coffSymbolTable()

SgAsmCoffSymbolTable *const & SgAsmPEFileHeader::get_coffSymbolTable ( ) const

Property: COFF symbol table.

See PE specification.

◆ set_coffSymbolTable()

void SgAsmPEFileHeader::set_coffSymbolTable ( SgAsmCoffSymbolTable *const &  )

Property: COFF symbol table.

See PE specification.

◆ formatName()

virtual const char * SgAsmPEFileHeader::formatName ( ) const
overridevirtual

Returns the name of the file format.

Reimplemented from SgAsmGenericHeader.

◆ isPe()

static bool SgAsmPEFileHeader::isPe ( SgAsmGenericFile )
static

Return true if the file looks like it might be a PE file according to the magic number.

The file must contain what appears to be a DOS File Header at address zero, and what appears to be a PE File Header at a file offset specified in part of the DOS File Header (actually, in the bytes that follow the DOS File Header).

◆ rvaSizePairName()

std::string SgAsmPEFileHeader::rvaSizePairName ( PairPurpose  ,
const char **  short_name 
)

Convert an RVA/Size Pair index number into a section name.

The enum value passed as the first argument is looked up in an internal table and its full, static name from the PE documentation is returned. Additionally, if short_name is non-null then it points to a static abbreviated name. For example, if the first argument is PAIR_EXPORTS from the SgAsmPEFileHeader::PairPurpose enum, then this function returns "Export Table" as the full name, and "Exports" as the abbreviated name.

◆ parse()

virtual SgAsmPEFileHeader * SgAsmPEFileHeader::parse ( )
overridevirtual

Parse contents of the section.

This is normally reimplemented in subclasses.

Reimplemented from SgAsmGenericSection.

◆ reallocate()

virtual bool SgAsmPEFileHeader::reallocate ( )
overridevirtual

Called prior to unparse to make things consistent.

Reimplemented from SgAsmGenericHeader.

◆ unparse()

virtual void SgAsmPEFileHeader::unparse ( std::ostream &  ) const
overridevirtual

Unparse headers and all they point to.

Reimplemented from SgAsmGenericHeader.

◆ dump()

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

Print some debugging info.

Reimplemented from SgAsmGenericHeader.

◆ format_name()

virtual const char * SgAsmPEFileHeader::format_name ( ) const
overridevirtual

Reimplemented from SgAsmGenericHeader.

◆ initializeProperties()

void SgAsmPEFileHeader::initializeProperties ( )
protected

Initialize all properties that have explicit initial values.

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


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