ROSE  0.11.145.0
Public Member Functions | Protected Member Functions | List of all members
SgAsmGenericHeader Class Reference

Description

Base class for container file headers.

Definition at line 25710 of file binaryInstruction.C.

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

Public Member Functions

 SgAsmGenericHeader (SgAsmGenericFile *)
 Constructor. More...
 
virtual bool reallocate () override
 Allow all sections to reallocate themselves.
 
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. More...
 
virtual const char * format_name () const
 Returns the name of the file format. More...
 
void add_dll (SgAsmGenericDLL *dll)
 Add a new DLL to the header DLL list.
 
std::vector< SgAsmGenericDLL * > & get_dlls ()
 Vector of dynamically loaded libraries. More...
 
rose_addr_t get_entry_rva () const
 Returns the RVA of the first entry point. More...
 
void add_entry_rva (const rose_rva_t &rva)
 Append an RVA to the list of entry points. More...
 
Rose::BinaryAnalysis::ByteOrder::Endianness get_sex () const
 
size_t get_word_size () const
 
void add_section (SgAsmGenericSection *)
 Adds a new section to the header. More...
 
void remove_section (SgAsmGenericSection *)
 Removes a secton from the header's section list. More...
 
SgAsmGenericSectionPtrList get_mapped_sections () const
 Returns the list of sections that are memory mapped.
 
SgAsmGenericSectionPtrList get_sections_by_id (int id) const
 Returns sections in this header that have the specified ID. More...
 
SgAsmGenericSectionPtrList get_sections_by_name (std::string, char sep=0) const
 Returns sections in this header that have the specified name. More...
 
SgAsmGenericSectionPtrList get_sections_by_offset (rose_addr_t offset, rose_addr_t size) const
 Returns sectons in this header that contain all of the specified portion of the file. More...
 
SgAsmGenericSectionPtrList get_sections_by_rva (rose_addr_t rva) const
 Returns sections that have a preferred mapping that includes the specified relative virtual address. More...
 
SgAsmGenericSectionPtrList get_sections_by_va (rose_addr_t va, bool use_preferred) const
 Returns sections having a preferred or actual mapping that includes the specified virtual address. More...
 
SgAsmGenericSectionget_section_by_id (int id, size_t *nfound=0) const
 Returns single section in this header that has the specified ID. More...
 
SgAsmGenericSectionget_section_by_name (const std::string &, char sep=0, size_t *nfound=0) const
 Returns single section in this header that has the specified name. More...
 
SgAsmGenericSectionget_section_by_offset (rose_addr_t offset, rose_addr_t size, size_t *nfound=0) const
 Returns single section in this header that contains all of the specified portion of the file. More...
 
SgAsmGenericSectionget_section_by_rva (rose_addr_t rva, size_t *nfound=0) const
 Returns the single section having a preferred mapping that includes the specified relative virtual address. More...
 
SgAsmGenericSectionget_section_by_va (rose_addr_t va, bool use_preferred, size_t *nfound=0) const
 Returns the section having a preferred or actual mapping that includes the specified virtual address. More...
 
SgAsmGenericSectionget_best_section_by_va (rose_addr_t va, bool use_preferred, size_t *nfound=0) const
 Like SgAsmGenericFile::get_best_section_by_va() except considers only sections defined in this header. More...
 
virtual ~SgAsmGenericHeader ()
 Destructor. More...
 
 SgAsmGenericHeader ()
 Default constructor. More...
 
SgAsmGenericFormat *const & get_exec_format () const
 Property: General info about the executable format.
 
void set_exec_format (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. More...
 
void set_isa (SgAsmGenericFormat::InsSetArchitecture const &)
 Property: Machine for which this header and its sections, etc. More...
 
rose_addr_t const & get_base_va () const
 Property: Base virtual address used by all relative virtual addresses.
 
void set_base_va (rose_addr_t const &)
 Property: Base virtual address used by all relative virtual addresses.
 
SgRVAList const & get_entry_rvas () const
 Property: Code entry point wrt base virtual address.
 
SgRVAList & get_entry_rvas ()
 Property: Code entry point wrt base virtual address.
 
void set_entry_rvas (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. More...
 
void grab_content ()
 Saves a reference to the original file data for a section based on the section's current offset and size. More...
 
virtual SgAsmGenericSectionparse ()
 
void unparse (std::ostream &, const ExtentMap &) const
 Write just the specified regions back to the file.
 
void unparse_holes (std::ostream &) const
 Write holes (unreferenced areas) back to the file.
 
SgAsmGenericHeaderis_file_header ()
 Predicate determining whether this section is also a top-level file header. More...
 
rose_addr_t get_end_offset () const
 File offset for end of section. More...
 
void extend (rose_addr_t nbytes)
 Extend a section by some number of bytes during the construction and/or parsing phase. More...
 
rose_addr_t write_uleb128 (unsigned char *, rose_addr_t offset, uint64_t) const
 Write an unsigned little-endian 128-bit value. More...
 
rose_addr_t write_sleb128 (unsigned char *, rose_addr_t offset, int64_t) const
 Write a signed little-endian 128-bit value. More...
 
size_t read_content (rose_addr_t abs_offset, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
size_t read_content_local (rose_addr_t rel_offset, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
std::string read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t va, bool strict=true)
 Reads a string from the file. More...
 
std::string read_content_local_str (rose_addr_t rel_offset, bool strict=true)
 Reads a string from the file. More...
 
SgUnsignedCharList read_content_local_ucl (rose_addr_t rel_offset, rose_addr_t size)
 Reads content of a section and returns it as a container. More...
 
int64_t read_content_local_sleb128 (rose_addr_t *rel_offset, bool strict=true)
 Read a signed little-endian 128-bit value. More...
 
uint64_t read_content_local_uleb128 (rose_addr_t *rel_offset, bool strict=true)
 Read an unsigned little-endian 128-bit value. More...
 
unsigned char * writable_content (size_t nbytes)
 Obtain a local, writable pool to hold content. More...
 
AddressIntervalSet get_referenced_extents () const
 Returns a list of parts of a single section that have been referenced. More...
 
AddressIntervalSet get_unreferenced_extents () const
 Returns a list of parts of a single section that have not been referenced. More...
 
bool is_mapped () const
 Whether section desires to be mapped to memory. More...
 
void clear_mapped ()
 Causes section to not be mapped to memory. More...
 
rose_addr_t get_base_va () const
 Base virtual address for a section. More...
 
rose_addr_t get_mapped_preferred_va () const
 Virtual address where section prefers to be mapped. More...
 
rose_addr_t get_va_offset (rose_addr_t va) const
 File offset for specified virtual address. More...
 
rose_addr_t get_rva_offset (rose_addr_t rva) const
 File offset for specified relative virtual address. More...
 
Extent get_file_extent () const
 Returns the file extent for the section. More...
 
Extent get_mapped_preferred_extent () const
 Returns the memory extent for a mapped section. More...
 
bool align ()
 Increase file offset and mapping address to satisfy alignment constraints. More...
 
virtual ~SgAsmGenericSection ()
 Destructor. More...
 
 SgAsmGenericSection ()
 Default constructor. More...
 
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. More...
 
virtual void set_size (rose_addr_t)
 Property: Size of section in file in bytes. More...
 
rose_addr_t get_offset () const
 Property: Offset to start of section in file. More...
 
virtual void set_offset (rose_addr_t)
 Property: Offset to start of section in file. More...
 
rose_addr_t const & get_file_alignment () const
 Property: Required file alignment. More...
 
void set_file_alignment (rose_addr_t const &)
 Property: Required file alignment. More...
 
SgFileContentList const & get_data () const
 Property: Original content of just this section. More...
 
void set_data (SgFileContentList const &)
 Property: Original content of just this section. More...
 
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. More...
 
void set_synthesized (bool const &)
 Property: Whether section really exists. More...
 
int const & get_id () const
 Property: Non-unique section ID or negative. More...
 
void set_id (int const &)
 Property: Non-unique section ID or negative. More...
 
SgAsmGenericStringget_name () const
 Property: Non-unique name of section. More...
 
void set_name (SgAsmGenericString *s)
 Property: Non-unique name of section. More...
 
std::string get_short_name () const
 Property: Abbreviated name. More...
 
void set_short_name (const std::string &)
 Property: Abbreviated name. More...
 
rose_addr_t get_mapped_preferred_rva () const
 Property: Relative virtual address where section prefers to be mapped. More...
 
virtual void set_mapped_preferred_rva (rose_addr_t)
 Property: Relative virtual address where section prefers to be mapped. More...
 
rose_addr_t get_mapped_size () const
 Property: Mapped size. More...
 
virtual void set_mapped_size (rose_addr_t)
 Property: Mapped size. More...
 
rose_addr_t const & get_mapped_alignment () const
 Property: Alignment in virtual memory.
 
void set_mapped_alignment (rose_addr_t const &)
 Property: Alignment in virtual memory.
 
bool const & get_mapped_rperm () const
 Property: Whether mapped with read permission.
 
void set_mapped_rperm (bool const &)
 Property: Whether mapped with read permission.
 
bool const & get_mapped_wperm () const
 Property: Whether mapped with write permission.
 
void set_mapped_wperm (bool const &)
 Property: Whether mapped with write permission.
 
bool const & get_mapped_xperm () const
 Property: Whether mapped with execute permission.
 
void set_mapped_xperm (bool const &)
 Property: Whether mapped with execute permission.
 
bool const & get_contains_code () const
 Property: Whether a section is known to contain code. More...
 
void set_contains_code (bool const &)
 Property: Whether a section is known to contain code. More...
 
rose_addr_t const & get_mapped_actual_va () const
 Property: Virtual address where ROSE maps this section. More...
 
void set_mapped_actual_va (rose_addr_t const &)
 Property: Virtual address where ROSE maps this section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, size_t bufsize, const void *buf) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const std::string &str) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, char c) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const SgFileContentList &buf) const
 Write data to a file section. More...
 
rose_addr_t write (std::ostream &f, rose_addr_t offset, const SgUnsignedCharList &buf) const
 Write data to a file section. More...
 
size_t read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, rose_addr_t start, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
size_t read_content (const Rose::BinaryAnalysis::MemoryMap::Ptr &, const rose_rva_t &start, void *dst_buf, rose_addr_t size, bool strict=true)
 Reads data from a file. More...
 
std::string read_content_str (rose_addr_t abs_offset, bool strict=true)
 Reads a string from the file. More...
 
std::string read_content_str (const Rose::BinaryAnalysis::MemoryMap::Ptr &map, rose_rva_t rva, bool strict=true)
 Reads a string from the file. More...
 
- Public Member Functions inherited from SgAsmExecutableFileFormat
virtual ~SgAsmExecutableFileFormat ()
 Destructor. More...
 
- Public Member Functions inherited from SgAsmNode
virtual ~SgAsmNode ()
 Destructor. More...
 
Sawyer::Attribute::Storage const & attributes () const
 Attribute storage. More...
 
Sawyer::Attribute::Storageattributes ()
 Attribute storage. 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)
 
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...
 
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) 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 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. 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...
 
template<class T >
T * initParentPointer (T *child, SgNode *parent)
 Generated for tree edge data member initializations. 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...
 
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. More...
 
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. More...
 

Protected Member Functions

virtual void destructorHelper () override
 This gets called by all Rosebud-generated destructors. More...
 
void initializeProperties ()
 Initialize all properties that have explicit initial values. More...
 
- Protected Member Functions inherited from SgAsmGenericSection
void initializeProperties ()
 Initialize all properties that have explicit initial values. More...
 
- Protected Member Functions inherited from SgAsmExecutableFileFormat
 SgAsmExecutableFileFormat ()
 Default constructor. More...
 
void initializeProperties ()
 Initialize all properties that have explicit initial values. More...
 
- Protected Member Functions inherited from SgAsmNode
 SgAsmNode ()
 Default constructor. More...
 
void initializeProperties ()
 Initialize all properties that have explicit initial values. 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.
 
virtual void debugSerializationBegin (const char *className)
 Called by generated serializers. More...
 
virtual void debugSerializationEnd (const char *className)
 Called by generated serializers. More...
 

Additional Inherited Members

- 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. More...
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value
 
- Static Public Member Functions inherited from SgAsmGenericSection
static void dump_containing_sections (FILE *, const std::string &prefix, rose_rva_t, const SgAsmGenericSectionPtrList &)
 Prints info about offsets into known sections. More...
 
- Static Public Member Functions inherited from SgAsmExecutableFileFormat
static SgAsmGenericFileparseBinaryFormat (const char *name)
 Factory method that parses a binary file. More...
 
static void unparseBinaryFormat (const std::string &name, SgAsmGenericFile *)
 Dump debugging information into a named text file. More...
 
static void unparseBinaryFormat (std::ostream &, SgAsmGenericFile *)
 Dump debugging information to specified stream. More...
 
static void initDiagnostics ()
 Initialize diagnostic streams. More...
 
static std::string isa_family_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string isa_to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string to_string (SgAsmExecutableFileFormat::InsSetArchitecture)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecFamily)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecABI)
 
static std::string to_string (SgAsmExecutableFileFormat::ExecPurpose)
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (std::ostream &, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static std::string hexdump (rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const unsigned char *data, size_t data_sz, const HexdumpFormat &)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgUnsignedCharList &data, bool multiline=true)
 Display binary data. More...
 
static void hexdump (FILE *, rose_addr_t base_addr, const std::string &prefix, const SgFileContentList &data, bool multiline=true)
 Display binary data. More...
 
- Static Public Member Functions inherited from SgNode
static 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. 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::map< SgNode *, std::string > > & get_globalQualifiedNameMapForMapsOfTypes ()
 Access function for name qualification support (for maps of types). More...
 
static void set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
 Access function for name qualification support (for maps of types). 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 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. More...
 
- Static Public Attributes inherited from SgAsmExecutableFileFormat
static Sawyer::Message::Facility mlog
 Diagnostic stream. More...
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST. More...
 
bool p_isModified
 Records if IR node has been modified (data members reset). More...
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 
- Static Protected Attributes inherited from SgNode
static 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, 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
 
static std::map< SgNode *, std::map< SgNode *, std::string > > p_globalQualifiedNameMapForMapsOfTypes
 

Constructor & Destructor Documentation

SgAsmGenericHeader::SgAsmGenericHeader ( SgAsmGenericFile )
explicit

Constructor.

Headers (SgAsmGenericHeader and derived classes) set the file/header relationship–a bidirectional link between this new header and the single file that contains this new header. This new header points to its file and the file contains a list that points to this new header. The header-to-file half of the link is deleted by the default destructor by virtue of being a simple pointer, but we also need to delete the other half of the link in the destructors.

virtual SgAsmGenericHeader::~SgAsmGenericHeader ( )
virtual

Destructor.

SgAsmGenericHeader::SgAsmGenericHeader ( )

Default constructor.

Member Function Documentation

SgAsmGenericFormat::InsSetArchitecture const& SgAsmGenericHeader::get_isa ( ) const

Property: Machine for which this header and its sections, etc.

was compiled.

void SgAsmGenericHeader::set_isa ( SgAsmGenericFormat::InsSetArchitecture const &  )

Property: Machine for which this header and its sections, etc.

was compiled.

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

Print some debugging info.

Reimplemented from SgAsmGenericSection.

Reimplemented in SgAsmDOSFileHeader, SgAsmElfFileHeader, SgAsmLEFileHeader, SgAsmNEFileHeader, and SgAsmPEFileHeader.

virtual const char* SgAsmGenericHeader::format_name ( ) const
virtual

Returns the name of the file format.

Reimplemented in SgAsmDOSFileHeader, SgAsmElfFileHeader, SgAsmLEFileHeader, SgAsmNEFileHeader, and SgAsmPEFileHeader.

std::vector<SgAsmGenericDLL*>& SgAsmGenericHeader::get_dlls ( )
inline

Vector of dynamically loaded libraries.

Definition at line 25861 of file binaryInstruction.C.

rose_addr_t SgAsmGenericHeader::get_entry_rva ( ) const

Returns the RVA of the first entry point.

The return value is relative to the header's base virtual address. If there are no entry points defined then returns a zero RVA.

void SgAsmGenericHeader::add_entry_rva ( const rose_rva_t rva)
inline

Append an RVA to the list of entry points.

Definition at line 25873 of file binaryInstruction.C.

void SgAsmGenericHeader::add_section ( SgAsmGenericSection )

Adds a new section to the header.

This is called implicitly by the section constructor.

void SgAsmGenericHeader::remove_section ( SgAsmGenericSection )

Removes a secton from the header's section list.

SgAsmGenericSectionPtrList SgAsmGenericHeader::get_sections_by_id ( int  id) const

Returns sections in this header that have the specified ID.

SgAsmGenericSectionPtrList SgAsmGenericHeader::get_sections_by_name ( std::string  ,
char  sep = 0 
) const

Returns sections in this header that have the specified name.

If sep is a non-null string then ignore any part of name at and after sep.

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

Returns sectons in this header that contain all of the specified portion of the file.

SgAsmGenericSectionPtrList SgAsmGenericHeader::get_sections_by_rva ( rose_addr_t  rva) const

Returns sections that have a preferred mapping that includes the specified relative virtual address.

SgAsmGenericSectionPtrList SgAsmGenericHeader::get_sections_by_va ( rose_addr_t  va,
bool  use_preferred 
) const

Returns sections having a preferred or actual mapping that includes the specified virtual address.

If use_preferred is set, then the condition is evaluated by looking at the section's preferred mapping, otherwise the actual mapping is used. If an actual mapping is used, the specified virtual address must be part of the actual mapped section, not merely in the memory region that was also mapped to satisfy alignment constraints.

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

Returns single section in this header that has the specified ID.

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

Returns single section in this header that has the specified name.

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

Returns single section in this header that contains all of the specified portion of the file.

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

Returns the single section having a preferred mapping that includes the specified relative virtual address.

If there are no sections or multiple sections satisfying this condition then a null pointer is returned.

SgAsmGenericSection* SgAsmGenericHeader::get_section_by_va ( rose_addr_t  va,
bool  use_preferred,
size_t *  nfound = 0 
) const

Returns the section having a preferred or actual mapping that includes the specified virtual address.

If use_preferred is set, then the condition is evaluated by looking at the section's preferred mapping, otherwise the actual mapping is used. If an actual mapping is used, the specified virtual address must be part of the actual mapped section, not merely in the memory region that was also mapped to satisfy alignment constraints. If there are no sections or multiple sections satisfying this condition then a null pointer is returned.

SgAsmGenericSection* SgAsmGenericHeader::get_best_section_by_va ( rose_addr_t  va,
bool  use_preferred,
size_t *  nfound = 0 
) const

Like SgAsmGenericFile::get_best_section_by_va() except considers only sections defined in this header.

Referenced by rose_rva_t::bind().

virtual void SgAsmGenericHeader::destructorHelper ( )
overrideprotectedvirtual

This gets called by all Rosebud-generated destructors.

Rosebud generates a call to destructorHelper from every destructor implementation. This gives the user a chance to do something special. There are some things to be aware of when reimplementing this function, and you should be well versed in the C++ rules about calling virtual functions from destructors.

  • The implementation must not attempt to access any data members of derived classes. These data members have already been destroyed by time this function is called.
  • Any calls you make to virtual functions declared in this class will dispatch only to implementations in this class or its base classes, not any derived classes.
  • Your implementation must expect to be called multiple times for the same object. This occurs when this class implements this function but its derived class does not. During destruction of a derived object, the derived class's Rosebud-generated destructor will call destructorHelper, which will dispatch to the implementation in this class. Then, when the part of the object corresponding to this class is being destroyed, the destructor will call destructorHelper again, which will dispatch to this implementation again. This may happen recursively mutliple times.
  • Your implementation should not destroy anything that a subclass might need during its destruction. This follows from the rule above, but is generally not a problem in practice. The reason it's not a problem is that the derived classes are usually Rosebud-generated and thus their destructors only call destructorHelper. Therefore, in order for any derived class to any work, it must be done in its destructorHelper, which would be called before the implementation of destructorHelper in this class is called.

All attempts should be made to avoid having to implement a destructorHelper in any class but the most base class (and that one does nothing). Instead, use data members whose own destructors do their cleanup. For instance, if this class needs a pointer to data allocated on the stack, then instead of using a raw pointer which needs to be deleted in this class's destructor, use a smart pointer whose own destructor deletes the data. If you follow this advice, then you don't need to be well-versed in the details of C++ object destruction.

Reimplemented from SgAsmGenericSection.

Reimplemented in SgAsmJvmFileHeader.

void SgAsmGenericHeader::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: