SgAsmGenericHeader.h

 
#ifndef ROSE_SgAsmGenericHeader_H
#define ROSE_SgAsmGenericHeader_H
#include <RoseFirst.h>
#include <Cxx_GrammarDeclarations.h>
#include <SgAsmGenericSection.h>
 
 
 
/* #line 1 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
// WARNING -- GENERATED CODE -- DO NOT MODIFY THIS CODE -- WARNING!
//      This code is automatically generated for each 
//      terminal and non-terminal within the defined 
//      grammar.  There is a simple way to change the 
//      code to fix bugs etc.  See the ROSE README file
//      for directions.
 
// tps: (02/22/2010): Adding DLL export requirements
#include "rosedll.h"
 
// predeclarations for SgAsmGenericHeader
 
/* #line 25 "../../../src/frontend/SageIII//SgAsmGenericHeader.h" */
/* #line 29067 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
 
#include <Rose/BinaryAnalysis/Address.h>
#include <Rose/BinaryAnalysis/ByteOrder.h>
#include <Rose/BinaryAnalysis/RelativeVirtualAddress.h>
#include <sageContainer.h>
#include <SgAsmGenericFormat.h>
 
#ifdef ROSE_SgAsmGenericHeader_IMPL
#include <SgAsmGenericDLLList.h>
#include <SgAsmGenericSectionList.h>
#endif
 
class SgAsmGenericDLL;
class SgAsmGenericDLLList;
 
 
/* #line 13 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $PREDECLARATIONS" */
 
/* #line 14 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
#if !defined(DOCUMENTATION)
// Class Definition for SgAsmGenericHeader
class ROSE_DLL_API SgAsmGenericHeader  : public SgAsmGenericSection
   {
     public:
 
 
/* #line 54 "../../../src/frontend/SageIII//SgAsmGenericHeader.h" */
 
          virtual SgNode* copy ( SgCopyHelp& help) const override;
// Start of memberFunctionString
/* #line 29131 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
 
 
    //----------------------- Boost serialization for SgAsmGenericHeader -----------------------
#ifdef ROSE_ENABLE_BOOST_SERIALIZATION
private:
    friend class boost::serialization::access;
 
    template<class S>
    void serialize(S &s, const unsigned /*version*/) {
        debugSerializationBegin("SgAsmGenericHeader");
        s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmGenericSection);
        s & BOOST_SERIALIZATION_NVP(p_executableFormat);
        s & BOOST_SERIALIZATION_NVP(p_magic);
        s & BOOST_SERIALIZATION_NVP(p_isa);
        s & BOOST_SERIALIZATION_NVP(p_baseVa);
        s & BOOST_SERIALIZATION_NVP(p_entryRvas);
        s & BOOST_SERIALIZATION_NVP(p_dlls);
        s & BOOST_SERIALIZATION_NVP(p_sections);
        debugSerializationEnd("SgAsmGenericHeader");
    }
#endif // ROSE_ENABLE_BOOST_SERIALIZATION
public:
public:
    SgAsmGenericFormat* const& get_executableFormat() const;
    void set_executableFormat(SgAsmGenericFormat* const&);
public:
    SgCharList const& get_magic() const;
    SgCharList& get_magic();
    void set_magic(SgCharList const&);
public:
    SgAsmGenericFormat::InsSetArchitecture const& get_isa() const;
    void set_isa(SgAsmGenericFormat::InsSetArchitecture const&);
public:
    Rose::BinaryAnalysis::Address const& get_baseVa() const;
    void set_baseVa(Rose::BinaryAnalysis::Address const&);
public:
    SgRVAList const& get_entryRvas() const;
    SgRVAList& get_entryRvas();
    void set_entryRvas(SgRVAList const&);
public:
    SgAsmGenericDLLList* const& get_dlls() const;
    void set_dlls(SgAsmGenericDLLList* const&);
public:
    SgAsmGenericSectionList* const& get_sections() const;
    void set_sections(SgAsmGenericSectionList* const&);
public:
    explicit SgAsmGenericHeader(SgAsmGenericFile*);
 
    virtual bool reallocate() override;
 
    virtual void unparse(std::ostream&) const override;
 
    virtual void dump(FILE*, const char *prefix, ssize_t idx) const override;
 
    virtual const char *formatName() const;
 
    void addDll(SgAsmGenericDLL *dll);
 
    std::vector<SgAsmGenericDLL*>& get_dlls();
 
    Rose::BinaryAnalysis::Address get_entryRva() const;
 
    void addEntryRva(const Rose::BinaryAnalysis::RelativeVirtualAddress&);
 
    /* Convenience functions */
    Rose::BinaryAnalysis::ByteOrder::Endianness get_sex() const;
    size_t get_wordSize() const;
 
    void addSection(SgAsmGenericSection*);
 
    void removeSection(SgAsmGenericSection*);
 
    SgAsmGenericSectionPtrList get_mappedSections() const;
 
    SgAsmGenericSectionPtrList get_sectionsById(int id) const;
 
    SgAsmGenericSectionPtrList get_sectionsByName(std::string, char sep=0) const;
 
    SgAsmGenericSectionPtrList get_sectionsByOffset(Rose::BinaryAnalysis::Address offset, Rose::BinaryAnalysis::Address size) const;
 
    SgAsmGenericSectionPtrList get_sectionsByRva(Rose::BinaryAnalysis::Address rva) const;
 
    SgAsmGenericSectionPtrList get_sectionsByVa(Rose::BinaryAnalysis::Address va, bool use_preferred) const;
 
    SgAsmGenericSection *get_sectionById(int id, size_t *nfound=0) const;
 
    SgAsmGenericSection *get_sectionByName(const std::string&, char sep=0, size_t *nfound=0) const;
 
    SgAsmGenericSection *get_sectionByOffset(Rose::BinaryAnalysis::Address offset, Rose::BinaryAnalysis::Address size,
                                             size_t *nfound=0) const;
 
    SgAsmGenericSection *get_sectionByRva(Rose::BinaryAnalysis::Address rva, size_t *nfound=0) const;
 
    SgAsmGenericSection *get_sectionByVa(Rose::BinaryAnalysis::Address va, bool use_preferred, size_t *nfound=0) const;
 
    SgAsmGenericSection *get_bestSectionByVa(Rose::BinaryAnalysis::Address va, bool use_preferred, size_t *nfound=0) const;
 
    // Deprecated 2023-11
public:
    SgAsmGenericFormat* get_exec_format() const ROSE_DEPRECATED("use get_executableFormat");
    void set_exec_format(SgAsmGenericFormat*) ROSE_DEPRECATED("use set_executableFormat");
    Rose::BinaryAnalysis::Address get_base_va() const ROSE_DEPRECATED("use get_baseVa");
    void set_base_va(Rose::BinaryAnalysis::Address) ROSE_DEPRECATED("use set_baseVa");
    SgRVAList& get_entry_rvas() ROSE_DEPRECATED("use get_entryRvas");
    const SgRVAList& get_entry_rvas() const ROSE_DEPRECATED("use get_entryRvas");
    void set_entry_rvas(const SgRVAList&) ROSE_DEPRECATED("use set_entryRvas");
    virtual const char *format_name() const ROSE_DEPRECATED("use formatName");
    void add_dll(SgAsmGenericDLL*) ROSE_DEPRECATED("use addDll");
    Rose::BinaryAnalysis::Address get_entry_rva() const ROSE_DEPRECATED("use get_entryRva");
    void add_entry_rva(const Rose::BinaryAnalysis::RelativeVirtualAddress&) ROSE_DEPRECATED("use addEntryRva");
    size_t get_word_size() const ROSE_DEPRECATED("use get_wordSize");
    void add_section(SgAsmGenericSection*) ROSE_DEPRECATED("use addSection");
    void remove_section(SgAsmGenericSection*) ROSE_DEPRECATED("use removeSection");
    SgAsmGenericSectionPtrList get_mapped_sections() const ROSE_DEPRECATED("use get_mappedSections");
    SgAsmGenericSectionPtrList get_sections_by_id(int) const ROSE_DEPRECATED("use get_sectionsById");
    SgAsmGenericSectionPtrList get_sections_by_name(std::string, char=0) const ROSE_DEPRECATED("use get_sectionsByName");
    SgAsmGenericSectionPtrList get_sections_by_offset(Rose::BinaryAnalysis::Address, Rose::BinaryAnalysis::Address) const
        ROSE_DEPRECATED("use get_sectionsByOffset");
    SgAsmGenericSectionPtrList get_sections_by_rva(Rose::BinaryAnalysis::Address) const ROSE_DEPRECATED("use get_sectionsByRva");
    SgAsmGenericSectionPtrList get_sections_by_va(Rose::BinaryAnalysis::Address, bool) const
        ROSE_DEPRECATED("use get_sectionsByVa");
    SgAsmGenericSection *get_section_by_id(int, size_t* = nullptr) const ROSE_DEPRECATED("use get_sectionById");
    SgAsmGenericSection *get_section_by_name(const std::string&, char=0, size_t* = nullptr) const
        ROSE_DEPRECATED("use get_sectionByName");
    SgAsmGenericSection *get_section_by_offset(Rose::BinaryAnalysis::Address, Rose::BinaryAnalysis::Address,
                                               size_t* = nullptr) const ROSE_DEPRECATED("use get_sectionByOffset");
    SgAsmGenericSection *get_section_by_rva(Rose::BinaryAnalysis::Address, size_t* = nullptr) const
        ROSE_DEPRECATED("use get_sectionByRva");
    SgAsmGenericSection *get_section_by_va(Rose::BinaryAnalysis::Address, bool, size_t* = nullptr) const
        ROSE_DEPRECATED("use get_sectionByVa");
    SgAsmGenericSection *get_best_section_by_va(Rose::BinaryAnalysis::Address, bool, size_t* = nullptr) const
        ROSE_DEPRECATED("use get_bestSectionByVa");
public:
    virtual ~SgAsmGenericHeader();
 
public:
    SgAsmGenericHeader();
 
protected:
    void initializeProperties();
 
 
// End of memberFunctionString
// Start of memberFunctionString
/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
 
// *** COMMON CODE SECTION BEGINS HERE ***
 
    public:
 
       // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required 
       // and not required which is required to match the other aspects of the copy mechanism code generation.
       // Specifically it is a problem to declare the copy function everywhere because it is not implemented 
       // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
       /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
       // virtual SgNode* copy ( const SgCopyHelp & help) const;
 
          virtual std::string class_name() const override;
 
          virtual VariantT variantT() const override; // MS: new variant used in tree traversal
 
       // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
       // static const VariantT static_variant = V_SgAsmGenericHeader;
          enum { static_variant = V_SgAsmGenericHeader };
 
       /* the generated cast function */
          ROSE_DLL_API friend       SgAsmGenericHeader* isSgAsmGenericHeader(       SgNode * s );
 
          ROSE_DLL_API friend const SgAsmGenericHeader* isSgAsmGenericHeader( const SgNode * s );
 
     // ******************************************
     // * Memory Pool / New / Delete
     // ******************************************
 
     public:
          static const unsigned pool_size; // 
          static std::vector<unsigned char *> pools; // 
          static SgAsmGenericHeader * next_node; // 
 
          static unsigned long initializeStorageClassArray(SgAsmGenericHeaderStorageClass *); // 
 
          static void clearMemoryPool(); // 
          static void deleteMemoryPool(); // 
 
          static void extendMemoryPoolForFileIO(); // 
 
          static SgAsmGenericHeader * getPointerFromGlobalIndex(unsigned long); // 
          static SgAsmGenericHeader * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); // 
 
          static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); // 
          static void resetValidFreepointers(); // 
          static unsigned long getNumberOfLastValidPointer(); // 
 
 
#if defined(INLINE_FUNCTIONS)
          inline void *operator new (size_t size);
#else
          void *operator new (size_t size);
#endif
          void operator delete (void* pointer, size_t size);
 
       // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
          void operator delete (void* pointer)
             {
            // This is the generated delete operator...
               SgAsmGenericHeader::operator delete (pointer,sizeof(SgAsmGenericHeader));
             }
 
          static size_t numberOfNodes();
 
          static size_t memoryUsage();
 
      // End of scope which started in IR nodes specific code 
      /* */
 
      /* name Internal Functions
          \brief Internal functions ... incomplete-documentation
 
          These functions have been made public as part of the design, but they are suggested for internal use 
          or by particularly knowledgeable users for specialized tools or applications.
 
          \internal We could not make these private because they are required by user for special purposes. And 
              it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
         
       */
 
       // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
       // overridden in every class by *generated* implementation
          virtual std::vector<SgNode*> get_traversalSuccessorContainer() const override;
       // MS: 06/28/02 container of names of variables or container indices 
       // used used in the traversal to access AST successor nodes
       // overridden in every class by *generated* implementation
          virtual std::vector<std::string> get_traversalSuccessorNamesContainer() const override;
 
       // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
       // than all the vector copies. The implementation for these functions is generated for each class.
          virtual size_t get_numberOfTraversalSuccessors() const override;
          virtual SgNode *get_traversalSuccessorByIndex(size_t idx) const override;
          virtual size_t get_childIndex(SgNode *child) const override;
 
#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
       // MS: 08/16/2002 method for generating RTI information
          virtual RTIReturnType roseRTI() override;
#endif
      /* */
 
 
 
      /* name Deprecated Functions
          \brief Deprecated functions ... incomplete-documentation
 
          These functions have been deprecated from use.
       */
      /* */
 
          virtual const char* sage_class_name() const  override ROSE_DEPRECATED_FUNCTION;
 
      // JJW (10/16/2008): Changed to a single function in Node.code, and put
      // getVariant() in #if 0 block to prevent confusing Doxygen
#if 0
          virtual int variant() const ROSE_DEPRECATED_FUNCTION;
       // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
#endif
      /* */
 
 
 
 
     public:
      /* name Traversal Support Functions
          \brief Traversal support functions ... incomplete-documentation
 
          These functions have been made public as part of the design, but they are suggested for internal use 
          or by particularly knowledgable users for specialized tools or applications.
       */
      /* */
 
       // DQ (11/26/2005): Support for visitor pattern mechanims
       // (inferior to ROSE traversal mechanism, experimental).
          void executeVisitorMemberFunction (ROSE_VisitorPattern & visitor);
 
      /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
          virtual void accept (ROSE_VisitorPattern & visitor) override;
 
       // DQ (12/26/2005): Support for traversal based on the memory pool
          static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
 
          static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern & visitor);
 
       // DQ (2/9/2006): Added to support traversal over single representative of each IR node
       // This traversal helps support internal tools that call static member functions.
       // note: this function operates on the memory pools.
          static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
      /* */
 
     public: 
        /* NodeId support functions */
        static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
        static SgAsmGenericHeader* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
        static std::string getNodeIdString(SgAsmGenericHeader* sgnode);
        static std::string getNodeIdStringInternal(SgAsmGenericHeader* sgnode);
 
     public:
      /* name Memory Allocation Functions
          \brief Memory allocations functions ... incomplete-documentation
 
          These functions have been made public as part of the design, but they are suggested for internal use 
          or by particularly knowledgable users for specialized tools or applications.
       */
      /* */
 
          virtual bool isInMemoryPool() override;
 
          virtual void checkDataMemberPointersIfInMemoryPool() override;
 
      // DQ (4/30/2006): Modified to be a const function.
          virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
 
          virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override;
 
          virtual long getChildIndex( SgNode* childNode ) const override;
 
      // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the 
      // comment here (changed to be a C style comment and not be a doxygen comment).
      /* \brief Constructor for use by AST File I/O Mechanism
 
          This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory 
          which obtained via fast binary file I/O from disk.
       */
       // SgAsmGenericHeader( SgAsmGenericHeaderStorageClass& source );
 
 
 
 
 
 // JH (10/24/2005): methods added to support the ast file IO
    private:
 
      /* name AST Memory Allocation Support Functions
          \brief Memory allocations support....
 
          These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated 
          in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
          and support the AST File I/O Mechanism.
       */
      /* */
 
       /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
          we compare them. Since I had several problems with this, I decided to make a typdef to ensure
          that I use the same type everywhere, if any changes are made. THe second one declares the type
          (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
          might got changed, but unfortunatly, the return types are still unsigned longs. There exists
          a correspinding one in the AST_FILE_IO class!
       */
      // DQ (9/2/2015): This typedef is no longer used, we can't define the 
      // comment here (changed to be a C style comment and not be a doxygen comment).
      /* \brief Typedef used for low level memory access.
       */
       // typedef unsigned char* TestType;
 
      // DQ (9/2/2015): This typedef is no longer used, we can't define the 
      // comment here (changed to be a C style comment and not be a doxygen comment).
      /* \brief Typedef used to hold memory addresses as values.
       */
       // typedef unsigned long  AddressType;
 
 
 
       // necessary, to have direct access to the p_freepointer and the private methods !
          friend class AST_FILE_IO;
 
          friend class SgAsmGenericHeaderStorageClass;
 
          friend class AstSpecificDataManagingClass;
 
          friend class AstSpecificDataManagingClassStorageClass;
    public:
          SgAsmGenericHeader( const SgAsmGenericHeaderStorageClass& source );
 
 // private: // JJW hack
       /*
          name AST Memory Allocation Support Variables
          Memory allocations support variables 
 
          These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated 
          in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
          and support the AST File I/O Mechanism.
       */
      /* */
 
    public:
 
      // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer 
      // to current node (so that it will work cleanly with build functions to specify patterns).
      // virtual SgNode* addRegExpAttribute();
          SgAsmGenericHeader* addRegExpAttribute(std::string s, AstRegExAttribute* a);
 
#ifndef _MSC_VER
// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
// and likely never fully implemented nor tested.  Files remain in the src tree but are no
// longer built.
#define BUILD_ATERM_SUPPORT 0
   #if BUILD_ATERM_SUPPORT
   #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
      // DQ (10/4/2014): Adding ATerm support to ROSE.
       // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
          virtual ATerm generate_ATerm() override;
 
          virtual void generate_ATerm_Annotation(ATerm & term) override;
   #endif
   #endif // BUILD_ATERM_SUPPORT
#endif
       // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
       // virtual generate_AST(ATerm & term);
       // virtual void read_ATerm_Annotation(ATerm & term);
 
// *** COMMON CODE SECTION ENDS HERE ***
 
 
// End of memberFunctionString
// Start of memberFunctionString
/* #line 710 "/workspace/src/ROSETTA/Grammar/Node.code" */
 
     // the generated cast function
     // friend ROSE_DLL_API SgAsmGenericHeader* isSgAsmGenericHeader ( SgNode* s );
 
          typedef SgAsmGenericSection base_node_type;
 
 
// End of memberFunctionString
 
 
 
 
 
 
 
 
    protected:
// Start of memberFunctionString
SgAsmGenericFormat* p_executableFormat;
          
// End of memberFunctionString
// Start of memberFunctionString
SgCharList p_magic;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmGenericFormat::InsSetArchitecture p_isa;
          
// End of memberFunctionString
// Start of memberFunctionString
Rose::BinaryAnalysis::Address p_baseVa;
          
// End of memberFunctionString
// Start of memberFunctionString
SgRVAList p_entryRvas;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmGenericDLLList* p_dlls;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmGenericSectionList* p_sections;
          
// End of memberFunctionString
 
    friend struct Rose::Traits::generated::describe_node_t<SgAsmGenericHeader>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmGenericHeader, SgAsmGenericFormat*,&SgAsmGenericHeader::p_executableFormat>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmGenericHeader, SgCharList,&SgAsmGenericHeader::p_magic>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmGenericHeader, SgAsmGenericFormat::InsSetArchitecture,&SgAsmGenericHeader::p_isa>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmGenericHeader, Rose::BinaryAnalysis::Address,&SgAsmGenericHeader::p_baseVa>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmGenericHeader, SgRVAList,&SgAsmGenericHeader::p_entryRvas>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmGenericHeader, SgAsmGenericDLLList*,&SgAsmGenericHeader::p_dlls>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmGenericHeader, SgAsmGenericSectionList*,&SgAsmGenericHeader::p_sections>;
 
/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
 
   };
#endif
 
// postdeclarations for SgAsmGenericHeader
 
/* #line 754 "../../../src/frontend/SageIII//SgAsmGenericHeader.h" */
 
/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
 
/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
 
/* #line 761 "../../../src/frontend/SageIII//SgAsmGenericHeader.h" */
 
#endif // ROSE_SgAsmGenericHeader_H