SgAsmInstruction.h

 
#ifndef ROSE_SgAsmInstruction_H
#define ROSE_SgAsmInstruction_H
#include <RoseFirst.h>
#include <Cxx_GrammarDeclarations.h>
#include <SgAsmStatement.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 SgAsmInstruction
 
/* #line 25 "../../../src/frontend/SageIII//SgAsmInstruction.h" */
/* #line 43831 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
 
#include <Rose/BinaryAnalysis/Address.h>
#include <Rose/BinaryAnalysis/Architecture/BasicTypes.h>
#include <Rose/BinaryAnalysis/MemoryMap.h>
#include <sageContainer.h>
#include <Sawyer/Cached.h>
 
#ifdef ROSE_SgAsmInstruction_IMPL
#include <SgAsmExprListExp.h>
#include <SgAsmOperandList.h>
#endif
 
 
/* #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 SgAsmInstruction
class ROSE_DLL_API SgAsmInstruction  : public SgAsmStatement
   {
     public:
 
 
/* #line 51 "../../../src/frontend/SageIII//SgAsmInstruction.h" */
 
          virtual SgNode* copy ( SgCopyHelp& help) const override;
// Start of memberFunctionString
/* #line 43900 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
 
 
    //----------------------- Boost serialization for SgAsmInstruction -----------------------
#ifdef ROSE_ENABLE_BOOST_SERIALIZATION
private:
    friend class boost::serialization::access;
 
    template<class S>
    void serialize(S &s, const unsigned /*version*/) {
        debugSerializationBegin("SgAsmInstruction");
        s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmStatement);
        {
            auto temp = architectureIdSerialize(p_architectureId);
            s & boost::serialization::make_nvp("p_architectureId", temp);
            p_architectureId = architectureIdDeserialize(temp);
        }
        s & BOOST_SERIALIZATION_NVP(p_rawBytes);
        s & BOOST_SERIALIZATION_NVP(p_operandList);
        s & BOOST_SERIALIZATION_NVP(p_delaySlot);
        userSerializeBoost(s);
        debugSerializationEnd("SgAsmInstruction");
    }
#endif // ROSE_ENABLE_BOOST_SERIALIZATION
    // Local types
private:
    struct SemanticFailure {
        size_t n;
        SemanticFailure(): n(0) {}
 
#ifdef ROSE_ENABLE_BOOST_SERIALIZATION
    private:
        friend class boost::serialization::access;
        template<class S>
        void serialize(S &s, const unsigned /*version*/) {
            s & BOOST_SERIALIZATION_NVP(n);
        }
#endif
    };
 
    // Properties
public:
public:
    uint8_t const& get_architectureId() const;
    // Architecture registration IDs change from run to run, so serialize the architecture name instead. The architecture names
    // will probably not change as frequently as their registration IDs.
    std::string architectureIdSerialize(uint8_t id) const;
    uint8_t architectureIdDeserialize(const std::string &name) const;
public:
    SgUnsignedCharList const& get_rawBytes() const;
    void set_rawBytes(SgUnsignedCharList const&);
public:
    SgAsmOperandList* const& get_operandList() const;
    void set_operandList(SgAsmOperandList* const&);
public:
    SgAsmInstruction* const& get_delaySlot() const;
    void set_delaySlot(SgAsmInstruction* const&);
    // FIXME[Robb Matzke 2023-03-18]: is the lack of serialization a bug?
public:
    SgAsmExprListExp* const& get_semantics() const;
    void set_semantics(SgAsmExprListExp* const&);
    // Non-property data members
private:
    SemanticFailure semanticFailure_;
 
public:
    static const int64_t INVALID_STACK_DELTA;           // [Robb Matzke 2024-10-01]: deprecated; use an optional type instead
 
    // Functions
public:
    Rose::BinaryAnalysis::Architecture::BaseConstPtr architecture() const /*final*/;
 
    std::string get_mnemonic() const;
 
    // [Robb Matzke 2023-12-04]: deprecated
    virtual std::string description() const final ROSE_DEPRECATED("use Architecture::Base::instructionDescription");
 
    size_t nOperands() const;
 
    SgAsmExpression* operand(size_t) const;
 
    // [Robb Matzke 2023-12-04]: deprecated
    virtual bool terminatesBasicBlock() final ROSE_DEPRECATED("use Architecture::Base::terminatesBasicBlock");
    virtual bool isFunctionCallFast(const std::vector<SgAsmInstruction*>&, Rose::BinaryAnalysis::Address *target,
                                    Rose::BinaryAnalysis::Address *ret) final
        ROSE_DEPRECATED("use Architecture::Base::isFunctionCallFast");
    virtual bool isFunctionCallSlow(const std::vector<SgAsmInstruction*>&, Rose::BinaryAnalysis::Address *target,
                                    Rose::BinaryAnalysis::Address *ret) final
        ROSE_DEPRECATED("use Architecture::Base::isFunctionCallSlow");
    virtual bool isFunctionReturnFast(const std::vector<SgAsmInstruction*>&) final
        ROSE_DEPRECATED("use Architecture::Base::isFunctionReturnFast");
    virtual bool isFunctionReturnSlow(const std::vector<SgAsmInstruction*>&) final
        ROSE_DEPRECATED("use Architecture::Base::isFunctionReturnSlow");
    virtual Sawyer::Optional<Rose::BinaryAnalysis::Address> branchTarget() final
        ROSE_DEPRECATED("use Architecture::Base::branchTarget");
 
    bool isFirstInBlock();
 
    bool isLastInBlock();
 
    virtual bool hasEffect();
 
    virtual bool hasEffect(const std::vector<SgAsmInstruction*>&, bool allow_branch=false,
                           bool relax_stack_semantics=false);
 
    virtual std::vector<std::pair<size_t,size_t> >
    findNoopSubsequences(const std::vector<SgAsmInstruction*>& insns, bool allow_branch=false,
                         bool relax_stack_semantics=false);
 
    // [Robb Matzke 2023-12-04]: deprecated
    virtual Rose::BinaryAnalysis::AddressSet getSuccessors(bool &complete)
        ROSE_DEPRECATED("use Architecture::Base::getSuccessors");
    virtual Rose::BinaryAnalysis::AddressSet getSuccessors(const std::vector<SgAsmInstruction*> &basicBlock,
                                                           bool &complete,
                                                           const Rose::BinaryAnalysis::MemoryMap::Ptr &initial_memory =
                                                           Rose::BinaryAnalysis::MemoryMap::Ptr())
        ROSE_DEPRECATED("use Architecture::Base::getSuccessors");
 
    virtual size_t get_size() const;
 
    // [Robb Matzke 2023-12-05]: deprecated
    virtual bool isUnknown() const final ROSE_DEPRECATED("use Architecture::Base::isUnknown");
 
    virtual unsigned get_anyKind() const;
 
    virtual std::string toString() const;
 
    virtual std::string toStringNoAddr() const;
 
    virtual std::set<Rose::BinaryAnalysis::Address> explicitConstants() const;
 
    size_t semanticFailure() const;
    void semanticFailure(size_t);
    void incrementSemanticFailure();
    bool normalizeOperands();
 
    // Serialization
#ifdef ROSE_ENABLE_BOOST_SERIALIZATION
private:
    template<class S>
    void userSerializeBoost(S &s) {
        s & BOOST_SERIALIZATION_NVP(semanticFailure_);
    }
#endif
 
    // Deprecated
public:
    // [Robb Matzke 2023-11-07]: deprecated
    const SgUnsignedCharList& get_raw_bytes() const ROSE_DEPRECATED("use get_rawBytes");
    void set_raw_bytes(const SgUnsignedCharList&) ROSE_DEPRECATED("use set_rawBytes");
public:
    virtual ~SgAsmInstruction();
 
public:
    SgAsmInstruction();
 
public:
    SgAsmInstruction(Rose::BinaryAnalysis::Address const& address,
                     uint8_t const& architectureId);
 
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_SgAsmInstruction;
          enum { static_variant = V_SgAsmInstruction };
 
       /* the generated cast function */
          ROSE_DLL_API friend       SgAsmInstruction* isSgAsmInstruction(       SgNode * s );
 
          ROSE_DLL_API friend const SgAsmInstruction* isSgAsmInstruction( const SgNode * s );
 
     // ******************************************
     // * Memory Pool / New / Delete
     // ******************************************
 
     public:
          static const unsigned pool_size; // 
          static std::vector<unsigned char *> pools; // 
          static SgAsmInstruction * next_node; // 
 
          static unsigned long initializeStorageClassArray(SgAsmInstructionStorageClass *); // 
 
          static void clearMemoryPool(); // 
          static void deleteMemoryPool(); // 
 
          static void extendMemoryPoolForFileIO(); // 
 
          static SgAsmInstruction * getPointerFromGlobalIndex(unsigned long); // 
          static SgAsmInstruction * 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...
               SgAsmInstruction::operator delete (pointer,sizeof(SgAsmInstruction));
             }
 
          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 SgAsmInstruction* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
        static std::string getNodeIdString(SgAsmInstruction* sgnode);
        static std::string getNodeIdStringInternal(SgAsmInstruction* 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.
       */
       // SgAsmInstruction( SgAsmInstructionStorageClass& 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 SgAsmInstructionStorageClass;
 
          friend class AstSpecificDataManagingClass;
 
          friend class AstSpecificDataManagingClassStorageClass;
    public:
          SgAsmInstruction( const SgAsmInstructionStorageClass& 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();
          SgAsmInstruction* 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 SgAsmInstruction* isSgAsmInstruction ( SgNode* s );
 
          typedef SgAsmStatement base_node_type;
 
 
// End of memberFunctionString
 
 
 
 
 
 
    protected:
// Start of memberFunctionString
uint8_t p_architectureId;
          
// End of memberFunctionString
// Start of memberFunctionString
SgUnsignedCharList p_rawBytes;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmOperandList* p_operandList;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmInstruction* p_delaySlot;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmExprListExp* p_semantics;
          
// End of memberFunctionString
 
    friend struct Rose::Traits::generated::describe_node_t<SgAsmInstruction>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmInstruction, uint8_t,&SgAsmInstruction::p_architectureId>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmInstruction, SgUnsignedCharList,&SgAsmInstruction::p_rawBytes>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmInstruction, SgAsmOperandList*,&SgAsmInstruction::p_operandList>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmInstruction, SgAsmInstruction*,&SgAsmInstruction::p_delaySlot>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmInstruction, SgAsmExprListExp*,&SgAsmInstruction::p_semantics>;
 
/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
 
   };
#endif
 
// postdeclarations for SgAsmInstruction
 
/* #line 983 "../../../src/frontend/SageIII//SgAsmInstruction.h" */
 
/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
 
/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
 
/* #line 990 "../../../src/frontend/SageIII//SgAsmInstruction.h" */
 
#endif // ROSE_SgAsmInstruction_H