ROSE  0.9.9.168
Public Types | Public Member Functions | Static Public Member Functions | List of all members
SgAsmGenericFile Class Reference

Description

Base class for binary files.

Definition at line 14852 of file binaryInstruction.C.

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

Public Types

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

Public Member Functions

 SgAsmGenericFile ()
 Non-parsing constructor. More...
 
virtual ~SgAsmGenericFile ()
 Destructor deletes children and unmaps/closes file. More...
 
SgAsmGenericFileparse (std::string file_name)
 Loads file contents into memory. More...
 
void reallocate ()
 Call this before unparsing to make sure everything is consistent. More...
 
void unparse (std::ostream &) const
 Mirror image of parsing an executable file. More...
 
void extend_to_eof (std::ostream &) const
 Extend the output file by writing the last byte if it hasn't been written yet. More...
 
void dump (FILE *) const
 Print basic info about the sections of a file. More...
 
void dump_all (bool in_cwd=true, const char *ext=NULL)
 Print text file containing all known information about a binary file. More...
 
void dump_all (const std::string &dumpname)
 Print text file containing all known information about a binary file. More...
 
const AddressIntervalSetget_unreferenced_extents () const
 Returns the parts of the file that have never been referenced. More...
 
void mark_referenced_extent (rose_addr_t start_rva, rose_addr_t size)
 Marks part of a file as having been referenced if tracking references. More...
 
rose_addr_t get_current_size () const
 Returns current size of file based on section with highest ending address. More...
 
rose_addr_t get_orig_size () const
 Returns original size of file, based on file system. More...
 
size_t read_content (rose_addr_t offset, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
size_t read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t va, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
std::string read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t va, bool strict=true)
 Reads a string from a file. More...
 
std::string read_content_str (rose_addr_t abs_offset, bool strict=true)
 Reads a string from a file. More...
 
const SgFileContentListcontent ()
 Property: Entire file contents. More...
 
SgFileContentList content (rose_addr_t offset, rose_addr_t size)
 Returns a vector that points to part of the file. More...
 
SgAsmGenericSectionPtrList get_mapped_sections () const
 Returns list of all sections in the file that are memory mapped, including headers and holes. More...
 
SgAsmGenericSectionPtrList get_sections (bool include_holes=true) const
 Returns list of all sections in the file (including headers, holes, etc). More...
 
SgAsmGenericSectionPtrList get_sections_by_id (int id) const
 Returns sections having specified ID across all headers, including headers and holes. More...
 
SgAsmGenericSectionPtrList get_sections_by_name (std::string, char sep='\0') const
 Returns all sections having specified name across all headers, including headers and holes. More...
 
SgAsmGenericSectionPtrList get_sections_by_offset (rose_addr_t offset, rose_addr_t size) const
 Find sections by their offset. More...
 
SgAsmGenericSectionPtrList get_sections_by_rva (rose_addr_t rva) const
 Find sections by address. More...
 
SgAsmGenericSectionPtrList get_sections_by_va (rose_addr_t va) const
 Find sections by address. More...
 
SgAsmGenericSectionget_section_by_id (int id, size_t *nfound=0) const
 Find section with specified ID. More...
 
SgAsmGenericSectionget_section_by_name (const std::string &, char sep=0, size_t *nfound=0) const
 Find section by name. More...
 
SgAsmGenericSectionget_section_by_offset (rose_addr_t offset, rose_addr_t size, size_t *nfound=0) const
 Find section by file offset. More...
 
SgAsmGenericSectionget_section_by_rva (rose_addr_t rva, size_t *nfound=0) const
 Find section by address. More...
 
SgAsmGenericSectionget_section_by_va (rose_addr_t va, size_t *nfound=0) const
 Find section by address. More...
 
SgAsmGenericSectionget_best_section_by_va (rose_addr_t va, size_t *nfound=0) const
 Find section by address. More...
 
rose_addr_t get_next_section_offset (rose_addr_t offset)
 File offset of next section. More...
 
void add_hole (SgAsmGenericSection *)
 Adds a new hole to the file. More...
 
void remove_hole (SgAsmGenericSection *)
 Removes a hole from the list of holes in a file. More...
 
void fill_holes ()
 Find holes in file and create sections to fill them. More...
 
void unfill_holes ()
 Deletes "hole" sections. More...
 
void add_header (SgAsmGenericHeader *)
 Adds a new header to the file. More...
 
void remove_header (SgAsmGenericHeader *)
 Removes a header from the header list in a file. More...
 
SgAsmGenericHeaderget_header (SgAsmGenericFormat::ExecFamily)
 Returns the header for the specified format. More...
 
const char * format_name () const
 Return a string describing the file format. More...
 
const SgAsmGenericFormat::fileDetailsget_sb ()
 
void set_sb (const SgAsmGenericFormat::fileDetails &sb)
 
SgAsmGenericSectionget_best_possible_section_by_va (rose_addr_t va) ROSE_DEPRECATED("use get_best_section_by_va")
 
SgAsmDwarfCompilationUnitListget_dwarf_info () const
 Property: DWARF debugging hiearchy.
 
void set_dwarf_info (SgAsmDwarfCompilationUnitList *)
 Property: DWARF debugging hiearchy.
 
const std::string & get_name () const
 Property: Name of file.
 
void set_name (const std::string &)
 Property: Name of file.
 
void set_data_converter (DataConverter *dc)
 Property: Data converter. More...
 
DataConverterget_data_converter () const
 Property: Data converter. More...
 
void shift_extend (SgAsmGenericSection *, rose_addr_t sa, rose_addr_t sn, AddressSpace, Elasticity)
 Moves and enlarges a section. More...
 
void shift_extend (SgAsmGenericSection *s, rose_addr_t sa, rose_addr_t sn)
 Moves and enlarges a section. More...
 
- Public Member Functions inherited from SgNode
virtual SgNodecopy (SgCopyHelp &help) const
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
virtual std::string class_name () const
 returns a string representing the class name More...
 
virtual VariantT variantT () const
 returns new style SageIII enum values More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 ROSETTA generated delete operator: deletes all non-traversed members.
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation More...
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation More...
 
virtual size_t get_numberOfTraversalSuccessors ()
 return number of children in the traversal successor list
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx)
 index-based access to traversal successors by index number
 
virtual size_t get_childIndex (SgNode *child)
 index-based access to traversal successors by child node
 
virtual RTIReturnType roseRTI ()
 return C++ Runtime-Time-Information More...
 
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
 generates string representing the class name: (e.g. for SgNode returns "SgNode"). More...
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
virtual void accept (ROSE_VisitorPattern &visitor)
 support for the classic visitor pattern done in GoF
 
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual std::vector< std::pair< SgNode *, std::string > > returnDataMemberPointers () const
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
virtual long getChildIndex (SgNode *childNode) const
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST. More...
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. More...
 
bool get_isModified () const
 Acess function for isModified flag. More...
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag. More...
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node. More...
 
SgNodeget_parent () const
 Access function for parent node. More...
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
std::string unparseToString () const
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space) More...
 
int variant () const ROSE_DEPRECATED_FUNCTION
 Older version function returns enum value "NODE". More...
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string.
 
virtual AstAttribute * getAttribute (std::string s) const
 Returns attribute of name 's'.
 
virtual void updateAttribute (std::string s, AstAttribute *a)
 Replace existing attribute of name 's' with new AstAttribute.
 
virtual void setAttribute (std::string s, AstAttribute *a)
 This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called.
 
virtual void removeAttribute (std::string s)
 Remove attribute of name 's' if present.
 
virtual bool attributeExists (std::string s) const
 Tests if attribute of name 's' is present.
 
virtual int numberOfAttributes () const
 Returns the number of attributes on this IR node.
 
virtual AstAttributeMechanism * get_attributeMechanism () const
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
 
virtual void set_attributeMechanism (AstAttributeMechanism *a)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...
 
virtual void fixupCopy (SgNode *copy, SgCopyHelp &help) const
 
virtual Sg_File_Infoget_file_info (void) const
 File information containing filename, line number, column number, and if the SgNode is a part of a new transformation, etc.
 
virtual Sg_File_Infoget_startOfConstruct (void) const
 New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword).
 
virtual Sg_File_Infoget_endOfConstruct (void) const
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node.
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node.
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct.
 
virtual bool cfgIsIndexInteresting (unsigned int index) const
 Determine whether a particular CFG node index is "interesting" for this kind of node.
 
virtual unsigned int cfgFindChildIndex (SgNode *n)
 Find the index of n in this node's CFG children.
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n)
 Find the index just after n in this node's CFG children.
 
virtual std::vector< VirtualCFG::CFGEdgecfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version.
 
virtual std::vector< VirtualCFG::CFGEdgecfgInEdges (unsigned int index=false)
 Find the in edges of a CFG node – internal version.
 
int numberOfNodesInSubtree ()
 Computes the number of nodes in the defined subtree of the AST. More...
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST. More...
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor. More...
 
 SgNode ()
 This is the constructor. More...
 
bool get_isVisited () const ROSE_DEPRECATED_FUNCTION
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...
 
void set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
 Access function for p_isVisited flag used previously by the AST traversals. More...
 

Static Public Member Functions

static SgAsmGenericSectionbest_section_by_va (const SgAsmGenericSectionPtrList &sections, rose_addr_t va)
 Definition for "best". More...
 
- Static Public Member Functions inherited from SgAsmExecutableFileFormat
static SgAsmGenericFileparseBinaryFormat (const char *name)
 Factory method that parses a binary file. More...
 
static void unparseBinaryFormat (const std::string &name, SgAsmGenericFile *)
 Dump debugging information into a named text file. More...
 
static void unparseBinaryFormat (std::ostream &, SgAsmGenericFile *)
 Dump debugging information to specified stream. More...
 
static void initDiagnostics ()
 Initialize diagnostic streams. More...
 
static std::string isa_family_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string isa_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecFamily)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecABI)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecPurpose)
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...
 
static std::vector< VariantT > getClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode *, std::string > & get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map. More...
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map.
 
static std::map< std::string, int > & get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map. More...
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names). More...
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names). More...
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type). More...
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type). More...
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations). More...
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations). More...
 
static std::map< SgNode *, std::string > & get_globalTypeNameMap ()
 Access function for name qualification support (for names of types). More...
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types). More...
 
static SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types.
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types.
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types.
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types.
 
static SgNodebuild_node_from_nonlist_children ()
 

Additional Inherited Members

- Static Public Attributes inherited from SgAsmExecutableFileFormat
static Sawyer::Message::Facility mlog
 Diagnostic stream. More...
 
- 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.
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST. More...
 
bool p_isModified
 Records if IR node has been modified (data members reset). More...
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 
- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types.
 
static SgTypeTablep_globalTypeTable
 
static std::map< SgNode *, std::string > p_globalMangledNameMap
 Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization.
 
static std::map< std::string, int > p_shortMangledNameCache
 STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates.
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForNames
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTypes
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTemplateHeaders
 
static std::map< SgNode *, std::string > p_globalTypeNameMap
 

Member Enumeration Documentation

Elasticity argument for shift_extend.

Enumerator
ELASTIC_NONE 

Nothing is elastic; other parts of space are shifted.

ELASTIC_UNREF 

Unreferenced address space is elastic.

ELASTIC_HOLE 

Unreferenced and "hole" sections are elastic.

Definition at line 15030 of file binaryInstruction.C.

Constructor & Destructor Documentation

SgAsmGenericFile::SgAsmGenericFile ( )
inline

Non-parsing constructor.

If you're creating an executable from scratch then call this function and you're done. But if you're parsing an existing file then call parse in order to map the file's contents into memory for parsing.

Definition at line 15040 of file binaryInstruction.C.

virtual SgAsmGenericFile::~SgAsmGenericFile ( )
virtual

Destructor deletes children and unmaps/closes file.

Member Function Documentation

SgAsmGenericFile* SgAsmGenericFile::parse ( std::string  file_name)

Loads file contents into memory.

void SgAsmGenericFile::reallocate ( )

Call this before unparsing to make sure everything is consistent.

void SgAsmGenericFile::unparse ( std::ostream &  ) const

Mirror image of parsing an executable file.

The result (unless the AST has been modified) should be identical to the original file. If the file's neuter property is true, then rather than creating a binary file, the output will contain a note indicating that the neuter property is set. This is intended to prevent ASTs that represent malicious binaries from accidently being used to create the binary.

void SgAsmGenericFile::extend_to_eof ( std::ostream &  ) const

Extend the output file by writing the last byte if it hasn't been written yet.

void SgAsmGenericFile::dump ( FILE *  ) const

Print basic info about the sections of a file.

void SgAsmGenericFile::dump_all ( bool  in_cwd = true,
const char *  ext = NULL 
)

Print text file containing all known information about a binary file.

If in_cwd is set, then the file is created in the current working directory rather than the directory containing the binary file (the default is to create the file in the current working directory). If ext is non-null then these characters are added to the end of the binary file name. The default null pointer causes the string ".dump" to be appended to the file name.

void SgAsmGenericFile::dump_all ( const std::string &  dumpname)

Print text file containing all known information about a binary file.

const AddressIntervalSet& SgAsmGenericFile::get_unreferenced_extents ( ) const

Returns the parts of the file that have never been referenced.

void SgAsmGenericFile::mark_referenced_extent ( rose_addr_t  start_rva,
rose_addr_t  size 
)

Marks part of a file as having been referenced if tracking references.

void SgAsmGenericFile::set_data_converter ( DataConverter dc)
inline

Property: Data converter.

Function to encode/decode data as it's transferred to/from disk. The default is to do no transformation.

Definition at line 15091 of file binaryInstruction.C.

DataConverter* SgAsmGenericFile::get_data_converter ( ) const
inline

Property: Data converter.

Function to encode/decode data as it's transferred to/from disk. The default is to do no transformation.

Definition at line 15092 of file binaryInstruction.C.

rose_addr_t SgAsmGenericFile::get_current_size ( ) const

Returns current size of file based on section with highest ending address.

rose_addr_t SgAsmGenericFile::get_orig_size ( ) const

Returns original size of file, based on file system.

size_t SgAsmGenericFile::read_content ( rose_addr_t  offset,
void *  dst_buf,
rose_addr_t  size,
bool  strict = true 
)

Reads data from a file.

Reads up to size bytes of data from the file beginning at the specified byte offset (measured from the beginning of the file), placing the result in dst_buf, and returning the number of bytes read. If the number of bytes read is less than size then one of two things happen: if strict is true then an SgAsmExecutableFileFormat::ShortRead exception is thrown; otherwise dst_buf is zero padded so that exactly size bytes are always initialized.

Referenced by SgAsmLEFileHeader::is_LE(), and SgAsmNEFileHeader::is_NE().

size_t SgAsmGenericFile::read_content ( const Rose::BinaryAnalysis::MemoryMap::Ptr ,
rose_addr_t  va,
void *  dst_buf,
rose_addr_t  size,
bool  strict = true 
)

Reads data from a file.

Reads up to size bytes of data starting at the specified (absolute) virtual address. The map specifies how virtual addresses are mapped to file offsets. As bytes are read, if we encounter a virtual address that is not mapped we stop reading and do one of two things: if strict is set then a MemoryMap::NotMapped exception is thrown; otherwise the rest of the dst_buf is zero filled and the number of bytes read (not filled) is returned.

std::string SgAsmGenericFile::read_content_str ( const Rose::BinaryAnalysis::MemoryMap::Ptr ,
rose_addr_t  va,
bool  strict = true 
)

Reads a string from a file.

Returns the string stored at the specified (absolute) virtual address. The returned string contains the bytes beginning at the starting virtual address and continuing until we reach a NUL byte or an address which is not mapped. If we reach an address which is not mapped then one of two things happen: if strict is set then a MemoryMap::NotMapped exception is thrown; otherwise the string is simply terminated. The returned string does not include the NUL byte.

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

Reads a string from a file.

Returns the NUL-terminated string stored at the specified relative virtual address. The returned string contains the bytes beginning at the specified starting file offset and continuing until we reach a NUL byte or an invalid file offset. If we reach an invalid file offset one of two things happen: if strict is set (the default) then an SgAsmExecutableFileFormat::ShortRead exception is thrown; otherwise the string is simply terminated. The returned string does not include the NUL byte.

const SgFileContentList& SgAsmGenericFile::content ( )
inline

Property: Entire file contents.

Definition at line 15139 of file binaryInstruction.C.

SgFileContentList SgAsmGenericFile::content ( rose_addr_t  offset,
rose_addr_t  size 
)

Returns a vector that points to part of the file.

Returns a vector that points to part of the file content without actually ever reading or otherwise referencing the file content until the vector elements are referenced. If the desired extent falls entirely or partially outside the range of data known to the file then throw an SgAsmExecutableFileFormat::ShortRead exception. This function never updates reference tracking lists for the file.

SgAsmGenericSectionPtrList SgAsmGenericFile::get_mapped_sections ( ) const

Returns list of all sections in the file that are memory mapped, including headers and holes.

SgAsmGenericSectionPtrList SgAsmGenericFile::get_sections ( bool  include_holes = true) const

Returns list of all sections in the file (including headers, holes, etc).

SgAsmGenericSectionPtrList SgAsmGenericFile::get_sections_by_id ( int  id) const

Returns sections having specified ID across all headers, including headers and holes.

SgAsmGenericSectionPtrList SgAsmGenericFile::get_sections_by_name ( std::string  ,
char  sep = '\0' 
) const

Returns all sections having specified name across all headers, including headers and holes.

SgAsmGenericSectionPtrList SgAsmGenericFile::get_sections_by_offset ( rose_addr_t  offset,
rose_addr_t  size 
) const

Find sections by their offset.

Returns all sections that contain all of the specified portion of the file across all headers, including headers and holes.

SgAsmGenericSectionPtrList SgAsmGenericFile::get_sections_by_rva ( rose_addr_t  rva) const

Find sections by address.

Returns all sections that are mapped to include the specified relative virtual address across all headers, including headers and holes. This uses the preferred mapping of the section rather than the actual mapping.

SgAsmGenericSectionPtrList SgAsmGenericFile::get_sections_by_va ( rose_addr_t  va) const

Find sections by address.

Returns all sections that are mapped to include the specified virtual address across all headers, including headers and holes. This uses the preferred mapping rather than the actual mapping.

SgAsmGenericSection* SgAsmGenericFile::get_section_by_id ( int  id,
size_t *  nfound = 0 
) const

Find section with specified ID.

Returns the pointer to section with the specified ID across all headers only if there's exactly one match. Headers and holes are included in the results.

SgAsmGenericSection* SgAsmGenericFile::get_section_by_name ( const std::string &  ,
char  sep = 0,
size_t *  nfound = 0 
) const

Find section by name.

Returns pointer to the section with the specified name, or NULL if there isn't exactly one match. Any characters in the name after the first occurrence of SEP are ignored (default is NUL). For instance, if sep=='$' then the following names are all equivalent: .idata, .idata$, and .idata$1

SgAsmGenericSection* SgAsmGenericFile::get_section_by_offset ( rose_addr_t  offset,
rose_addr_t  size,
size_t *  nfound = 0 
) const

Find section by file offset.

Returns single section that contains all of the specified portion of the file across all headers, including headers and holes.

SgAsmGenericSection* SgAsmGenericFile::get_section_by_rva ( rose_addr_t  rva,
size_t *  nfound = 0 
) const

Find section by address.

Returns single section that is mapped to include the specified relative virtual file address across all headers, including headers and holes.

SgAsmGenericSection* SgAsmGenericFile::get_section_by_va ( rose_addr_t  va,
size_t *  nfound = 0 
) const

Find section by address.

Returns single section that is mapped to include the specified virtual address across all headers. See also get_best_section_by_va.

SgAsmGenericSection* SgAsmGenericFile::get_best_section_by_va ( rose_addr_t  va,
size_t *  nfound = 0 
) const

Find section by address.

Similar to get_section_by_va except when more than one section contains the specified virtual address this choose the "best" one. All candidates must map the virtual address to the same file address or else we fail (return null and number of candidates). See best_section_by_va for definition of "best".

static SgAsmGenericSection* SgAsmGenericFile::best_section_by_va ( const SgAsmGenericSectionPtrList &  sections,
rose_addr_t  va 
)
static

Definition for "best".

This is the definition of "best" as used by get_best_section_by_va and SgAsmGenericHeader::get_best_section_by_va. The specified list of sections is scanned and the best one containing the specified virtual address is returned. The operation is equivalent to the successive elimination of bad sections: first eliminate all sections that do not contain the virtual address. If more than one remains, eliminate all but the smallest. If two or more are tied in size and at least one has a name, eliminate those that don't have names. If more than one section remains, return the section that is earliest in the specified list of sections. Return the null pointer if no section contains the specified virtual address, or if any two sections that contain the virtual address map it to different parts of the underlying binary file.

void SgAsmGenericFile::shift_extend ( SgAsmGenericSection ,
rose_addr_t  sa,
rose_addr_t  sn,
AddressSpace  ,
Elasticity   
)

Moves and enlarges a section.

Shifts (to a higher offset) and/or enlarges the specified section, S, taking all other sections into account. The positions of sections are based on their preferred virtual mappings rather than the actual mapping.

The neighborhood(S) is S itself and the set of all sections that overlap or are adjacent to the neighborhood of S, recursively.

The address space can be partitioned into three categories:

  • Section: part of an address space that is referenced by an SgAsmGenericSection other than a "hole" section.
  • Hole: part of an address space that is referenced only by a "hole" section.
  • Unref: part of an address space that is not used by any section, including any "hole" section.

The last two categories define parts of the address space that can be optionally elastic–they expand or contract to take up slack or provide space for neighboring sections. This is controlled by the "elasticity" argument.

Note that when elasticity is ELASTIC_HOLE we simply ignore the "hole" sections, effectively removing their addresses from the range of addresses under consideration. This avoids complications that arise when a "hole" overlaps with a real section (due to someone changing offsets in an incompatible manner), but causes the hole offset and size to remain fixed. (FIXME RPM 2008-10-20)

When section S is shifted by 'Sa' bytes and/or enlarged by 'Sn' bytes, other sections are affected as follows:

  • Cat L: Not affected
  • Cat R: Shifted by Sa+Sn if they are in neighborhood(S). Otherwise the amount of shifting depends on the size of the hole right of neighborhood(S).
  • Cat C: Shifted Sa and enlarged Sn.
  • Cat O: If starting address are the same: Shifted Sa. If starting address not equal: Englarged Sa+Sn
  • Cat I: Shifted Sa, not enlarged
  • Cat B: Not shifted, but enlarged Sn
  • Cat E: Shifted Sa and enlarged Sn

Generally speaking, the AddressSpace argument should be SgAsmGenericFile::ADDRSP_ALL in order to adjust both file and memory offsets and sizes in a consistent manner.

To change the address and/or size of S without regard to other sections in the same file, use set_offset() and set_size() (for file address space) or set_mapped_preferred_rva() and set_mapped_size() (for memory address space).

Referenced by shift_extend().

void SgAsmGenericFile::shift_extend ( SgAsmGenericSection s,
rose_addr_t  sa,
rose_addr_t  sn 
)
inline

Moves and enlarges a section.

Shifts (to a higher offset) and/or enlarges the specified section, S, taking all other sections into account. The positions of sections are based on their preferred virtual mappings rather than the actual mapping.

The neighborhood(S) is S itself and the set of all sections that overlap or are adjacent to the neighborhood of S, recursively.

The address space can be partitioned into three categories:

  • Section: part of an address space that is referenced by an SgAsmGenericSection other than a "hole" section.
  • Hole: part of an address space that is referenced only by a "hole" section.
  • Unref: part of an address space that is not used by any section, including any "hole" section.

The last two categories define parts of the address space that can be optionally elastic–they expand or contract to take up slack or provide space for neighboring sections. This is controlled by the "elasticity" argument.

Note that when elasticity is ELASTIC_HOLE we simply ignore the "hole" sections, effectively removing their addresses from the range of addresses under consideration. This avoids complications that arise when a "hole" overlaps with a real section (due to someone changing offsets in an incompatible manner), but causes the hole offset and size to remain fixed. (FIXME RPM 2008-10-20)

When section S is shifted by 'Sa' bytes and/or enlarged by 'Sn' bytes, other sections are affected as follows:

  • Cat L: Not affected
  • Cat R: Shifted by Sa+Sn if they are in neighborhood(S). Otherwise the amount of shifting depends on the size of the hole right of neighborhood(S).
  • Cat C: Shifted Sa and enlarged Sn.
  • Cat O: If starting address are the same: Shifted Sa. If starting address not equal: Englarged Sa+Sn
  • Cat I: Shifted Sa, not enlarged
  • Cat B: Not shifted, but enlarged Sn
  • Cat E: Shifted Sa and enlarged Sn

Generally speaking, the AddressSpace argument should be SgAsmGenericFile::ADDRSP_ALL in order to adjust both file and memory offsets and sizes in a consistent manner.

To change the address and/or size of S without regard to other sections in the same file, use set_offset() and set_size() (for file address space) or set_mapped_preferred_rva() and set_mapped_size() (for memory address space).

Definition at line 15269 of file binaryInstruction.C.

References ELASTIC_UNREF, and shift_extend().

rose_addr_t SgAsmGenericFile::get_next_section_offset ( rose_addr_t  offset)

File offset of next section.

Given a file address, return the file offset of the following section. If there is no following section then return an address of -1 (when signed)

void SgAsmGenericFile::add_hole ( SgAsmGenericSection )

Adds a new hole to the file.

This is called implicitly by the hole constructor.

void SgAsmGenericFile::remove_hole ( SgAsmGenericSection )

Removes a hole from the list of holes in a file.

void SgAsmGenericFile::fill_holes ( )

Find holes in file and create sections to fill them.

Synthesizes "hole" sections to describe the parts of the file that are not yet referenced by other sections. Note that holes are used to represent parts of the original file data, before sections were modified by walking the AST (at this time it is not possible to create a hole outside the original file content).

void SgAsmGenericFile::unfill_holes ( )

Deletes "hole" sections.

Undoes what fill_holes did.

void SgAsmGenericFile::add_header ( SgAsmGenericHeader )

Adds a new header to the file.

This is called implicitly by the header constructor

void SgAsmGenericFile::remove_header ( SgAsmGenericHeader )

Removes a header from the header list in a file.

SgAsmGenericHeader* SgAsmGenericFile::get_header ( SgAsmGenericFormat::ExecFamily  )

Returns the header for the specified format.

const char* SgAsmGenericFile::format_name ( ) const

Return a string describing the file format.

This uses the last header so that files like PE, NE, LE, LX, etc. which also have a DOS header report the format of the second (PE, etc.) header rather than the DOS header.


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