Description
Represents one Intel x86 machine instruction.
Definition at line 122 of file binaryInstruction.C.
Inheritance diagram for SgAsmX86Instruction:
Collaboration diagram for SgAsmX86Instruction:
Public Member Functions | |
| virtual unsigned | get_anyKind () const override |
| Returns instruction kind for any architecture. | |
| virtual | ~SgAsmX86Instruction () |
| Destructor. | |
| SgAsmX86Instruction () | |
| Default constructor. | |
| SgAsmX86Instruction (rose_addr_t const &address, uint8_t const &architectureId, Rose::BinaryAnalysis::X86InstructionKind const &kind, Rose::BinaryAnalysis::X86InstructionSize const &baseSize, Rose::BinaryAnalysis::X86InstructionSize const &operandSize, Rose::BinaryAnalysis::X86InstructionSize const &addressSize) | |
| Constructor. | |
| Rose::BinaryAnalysis::X86InstructionKind const & | get_kind () const |
| Property: Instruction kind. | |
| void | set_kind (Rose::BinaryAnalysis::X86InstructionKind const &) |
| Property: Instruction kind. | |
| Rose::BinaryAnalysis::X86InstructionSize const & | get_baseSize () const |
| Property: An enum constant describing the base size of an x86 instruction. | |
| void | set_baseSize (Rose::BinaryAnalysis::X86InstructionSize const &) |
| Property: An enum constant describing the base size of an x86 instruction. | |
| Rose::BinaryAnalysis::X86InstructionSize const & | get_operandSize () const |
| Property: An enum describing the x86 instruction operand size. | |
| void | set_operandSize (Rose::BinaryAnalysis::X86InstructionSize const &) |
| Property: An enum describing the x86 instruction operand size. | |
| Rose::BinaryAnalysis::X86InstructionSize const & | get_addressSize () const |
| Property: An enum describing the x86 address size. | |
| void | set_addressSize (Rose::BinaryAnalysis::X86InstructionSize const &) |
| Property: An enum describing the x86 address size. | |
| bool const & | get_lockPrefix () const |
| Property: Whether the x86 lock prefix was present. | |
| void | set_lockPrefix (bool const &) |
| Property: Whether the x86 lock prefix was present. | |
| Rose::BinaryAnalysis::X86RepeatPrefix const & | get_repeatPrefix () const |
| Property: An enum constant describing whether the instruction is repeated. | |
| void | set_repeatPrefix (Rose::BinaryAnalysis::X86RepeatPrefix const &) |
| Property: An enum constant describing whether the instruction is repeated. | |
| Rose::BinaryAnalysis::X86BranchPrediction const & | get_branchPrediction () const |
| Property: An enum constant describing branch prediction. | |
| void | set_branchPrediction (Rose::BinaryAnalysis::X86BranchPrediction const &) |
| Property: An enum constant describing branch prediction. | |
| Rose::BinaryAnalysis::X86SegmentRegister const & | get_segmentOverride () const |
| Property: The segment override register. | |
| void | set_segmentOverride (Rose::BinaryAnalysis::X86SegmentRegister const &) |
| Property: The segment override register. | |
 Public Member Functions inherited from SgAsmInstruction | |
| std::string | architectureIdSerialize (uint8_t id) const |
| uint8_t | architectureIdDeserialize (const std::string &name) const |
| Rose::BinaryAnalysis::Architecture::BaseConstPtr | architecture () const |
| Architecture for instruction. | |
| std::string | get_mnemonic () const |
| Property: Instruction mnemonic string. | |
| virtual std::string | description () const final |
| size_t | nOperands () const |
| Number of operands. | |
| SgAsmExpression * | operand (size_t) const |
| Nth operand. | |
| virtual bool | terminatesBasicBlock () final |
| virtual bool | isFunctionCallFast (const std::vector< SgAsmInstruction * > &, rose_addr_t *target, rose_addr_t *ret) final |
| virtual bool | isFunctionCallSlow (const std::vector< SgAsmInstruction * > &, rose_addr_t *target, rose_addr_t *ret) final |
| virtual bool | isFunctionReturnFast (const std::vector< SgAsmInstruction * > &) final |
| virtual bool | isFunctionReturnSlow (const std::vector< SgAsmInstruction * > &) final |
| virtual Sawyer::Optional< rose_addr_t > | branchTarget () final |
| bool | isFirstInBlock () |
| Returns true if this instruction is the first instruction in a basic block. | |
| bool | isLastInBlock () |
| Returns true if this instruction is the last instruction in a basic block. | |
| virtual bool | hasEffect () |
| Determines whether a single instruction has an effect. | |
| virtual bool | hasEffect (const std::vector< SgAsmInstruction * > &, bool allow_branch=false, bool relax_stack_semantics=false) |
| Determine if an instruction sequence has an effect. | |
| virtual std::vector< std::pair< size_t, size_t > > | findNoopSubsequences (const std::vector< SgAsmInstruction * > &insns, bool allow_branch=false, bool relax_stack_semantics=false) |
| Determines what subsequences of an instruction sequence have no cumulative effect. | |
| virtual Rose::BinaryAnalysis::AddressSet | getSuccessors (bool &complete) |
| virtual Rose::BinaryAnalysis::AddressSet | getSuccessors (const std::vector< SgAsmInstruction * > &basicBlock, bool &complete, const Rose::BinaryAnalysis::MemoryMap::Ptr &initial_memory=Rose::BinaryAnalysis::MemoryMap::Ptr()) |
| virtual size_t | get_size () const |
| Returns the size of an instruction in bytes. | |
| virtual bool | isUnknown () const final |
| virtual std::string | toString () const |
| Converts the instruction to a string. | |
| virtual std::string | toStringNoAddr () const |
| Converts the instruction to a string. | |
| virtual std::set< rose_addr_t > | explicitConstants () const |
| Explicit constants. | |
| bool | normalizeOperands () |
| Rewrite certain addressing modes for operands. | |
| const SgUnsignedCharList & | get_raw_bytes () const |
| void | set_raw_bytes (const SgUnsignedCharList &) |
| virtual | ~SgAsmInstruction () |
| Destructor. | |
| SgAsmInstruction () | |
| Default constructor. | |
| SgAsmInstruction (rose_addr_t const &address, uint8_t const &architectureId) | |
| Constructor. | |
| uint8_t const & | get_architectureId () const |
| Property: Architecture registration ID. | |
| SgUnsignedCharList const & | get_rawBytes () const |
| Property: Raw bytes of an instruction. | |
| void | set_rawBytes (SgUnsignedCharList const &) |
| Property: Raw bytes of an instruction. | |
| SgAsmOperandList *const & | get_operandList () const |
| Property: AST node that holds all operands. | |
| void | set_operandList (SgAsmOperandList *const &) |
| Property: AST node that holds all operands. | |
| SgAsmInstruction *const & | get_delaySlot () const |
| Property: Delay slot instructions. | |
| void | set_delaySlot (SgAsmInstruction *const &) |
| Property: Delay slot instructions. | |
| SgAsmExprListExp *const & | get_semantics () const |
| Property: Ordered list of instruction semantics. | |
| void | set_semantics (SgAsmExprListExp *const &) |
| Property: Ordered list of instruction semantics. | |
| size_t | semanticFailure () const |
| Property: Whether instruction semantics failed at this location. | |
| void | semanticFailure (size_t) |
| Property: Whether instruction semantics failed at this location. | |
| void | incrementSemanticFailure () |
| Property: Whether instruction semantics failed at this location. | |
| Public Member Functions inherited from SgAsmStatement | |
| virtual | ~SgAsmStatement () |
| Destructor. | |
| rose_addr_t const & | get_address () const |
| Property: Starting virtual address. | |
| void | set_address (rose_addr_t const &) |
| Property: Starting virtual address. | |
| std::string const & | get_comment () const |
| Property: Commentary. | |
| void | set_comment (std::string const &) |
| Property: Commentary. | |
| Public Member Functions inherited from SgAsmNode | |
| virtual | ~SgAsmNode () |
| Destructor. | |
| Sawyer::Attribute::Storage const & | attributes () const |
| Attribute storage. | |
| Sawyer::Attribute::Storage & | attributes () |
| Attribute storage. | |
| Public Member Functions inherited from SgNode | |
| virtual SgNode * | copy (SgCopyHelp &help) const |
| virtual std::string | class_name () const |
| returns a string representing the class name | |
| virtual VariantT | variantT () const |
| returns new style SageIII enum values | |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| virtual size_t | get_numberOfTraversalSuccessors () |
| return number of children in the traversal successor list | |
| virtual SgNode * | get_traversalSuccessorByIndex (size_t idx) |
| index-based access to traversal successors by index number | |
| virtual size_t | get_childIndex (SgNode *child) |
| index-based access to traversal successors by child node | |
| virtual const char * | sage_class_name () const |
| generates string representing the class name: (e.g. for SgNode returns "SgNode"). | |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| virtual void | accept (ROSE_VisitorPattern &visitor) |
| support for the classic visitor pattern done in GoF | |
| virtual bool | isInMemoryPool () |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. | |
| virtual void | checkDataMemberPointersIfInMemoryPool () |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. | |
| virtual std::vector< std::pair< SgNode *, std::string > > | returnDataMemberPointers () const |
| FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools | |
| virtual void | processDataMemberReferenceToPointers (ReferenceToPointerHandler *) |
| FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools | |
| virtual long | getChildIndex (SgNode *childNode) const |
| FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. | |
| SgNode (const SgNodeStorageClass &source) | |
| IR node constructor to support AST File I/O. | |
| SgNode * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. | |
| void | set_isModified (bool isModified) |
| All nodes in the AST contain a isModified flag used to track changes to the AST. | |
| void | set_containsTransformation (bool containsTransformation) |
| Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. | |
| bool | get_isModified () const |
| Acess function for isModified flag. | |
| bool | get_containsTransformation () const |
| Acess function for containsTransformation flag. | |
| SgNode * | get_raw_parent () const |
| Access function for direct access to uncomputed value of parent node. | |
| bool | isChild (SgNode *node) const |
| Query function for if the input IR nodes is a child of the current IR node. | |
| virtual std::string | unparseToString (SgUnparse_Info *info) const |
| This function unparses the AST node (excluding comments and unnecessary white space) | |
| std::string | unparseToString () const |
| int | variant () const |
| Older version function returns enum value "NODE". | |
| virtual void | addNewAttribute (std::string s, AstAttribute *a) |
| Add a new attribute represented by the named string. | |
| virtual AstAttribute * | getAttribute (std::string s) const |
| Returns attribute of name 's'. | |
| virtual void | updateAttribute (std::string s, AstAttribute *a) |
| Replace existing attribute of name 's' with new AstAttribute. | |
| virtual void | setAttribute (std::string s, AstAttribute *a) |
| This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. | |
| virtual void | removeAttribute (std::string s) |
| Remove attribute of name 's' if present. | |
| virtual bool | attributeExists (std::string s) const |
| Tests if attribute of name 's' is present. | |
| virtual int | numberOfAttributes () const |
| Returns the number of attributes on this IR node. | |
| virtual AstAttributeMechanism * | get_attributeMechanism () const |
| FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. | |
| virtual void | set_attributeMechanism (AstAttributeMechanism *a) |
| FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. | |
| virtual void | fixupCopy_scopes (SgNode *copy, SgCopyHelp &help) const |
| virtual void | fixupCopy_symbols (SgNode *copy, SgCopyHelp &help) const |
| virtual void | fixupCopy_references (SgNode *copy, SgCopyHelp &help) const |
| virtual Sg_File_Info * | get_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_Info * | get_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_Info * | get_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::CFGEdge > | cfgOutEdges (unsigned int index=false) |
| Find the out edges of a CFG node – internal version. | |
| virtual std::vector< VirtualCFG::CFGEdge > | cfgInEdges (unsigned int index=false) |
| Find the in edges of a CFG node – internal version. | |
| int | numberOfNodesInSubtree () |
| Computes the number of nodes in the defined subtree of the AST. | |
| int | depthOfSubtree () |
| Computes the depth of the current defined subtree of the AST. | |
| template<class T > | |
| T * | initParentPointer (T *child, SgNode *parent) |
| Generated for tree edge data member initializations. | |
| SgNode * | get_freepointer () const |
| void | set_freepointer (SgNode *freepointer) |
| virtual | ~SgNode () |
| This is the destructor. | |
| SgNode () | |
| This is the constructor. | |
| virtual SgNode * | copy (SgCopyHelp &help) const |
| virtual std::string | class_name () const |
| returns a string representing the class name | |
| virtual VariantT | variantT () const |
| returns new style SageIII enum values | |
| void * | operator new (size_t size) |
| returns pointer to newly allocated IR node | |
| void | operator delete (void *pointer, size_t size) |
| deallocated memory for IR node (returns memory to memory pool for reuse) | |
| void | operator delete (void *pointer) |
| virtual std::vector< SgNode * > | get_traversalSuccessorContainer () |
| container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation | |
| virtual std::vector< std::string > | get_traversalSuccessorNamesContainer () |
| container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation | |
| virtual size_t | get_numberOfTraversalSuccessors () |
| return number of children in the traversal successor list | |
| virtual SgNode * | get_traversalSuccessorByIndex (size_t idx) |
| index-based access to traversal successors by index number | |
| virtual size_t | get_childIndex (SgNode *child) |
| index-based access to traversal successors by child node | |
| virtual RTIReturnType | roseRTI () |
| return C++ Runtime-Time-Information | |
| virtual const char * | sage_class_name () const |
| void | executeVisitorMemberFunction (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| virtual void | accept (ROSE_VisitorPattern &visitor) |
| support for the classic visitor pattern done in GoF | |
| virtual bool | isInMemoryPool () |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. | |
| virtual void | checkDataMemberPointersIfInMemoryPool () |
| FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. | |
| virtual std::vector< std::pair< SgNode *, std::string > > | returnDataMemberPointers () const |
| FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools | |
| virtual void | processDataMemberReferenceToPointers (ReferenceToPointerHandler *) |
| FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools | |
| virtual long | getChildIndex (SgNode *childNode) const |
| FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. | |
| SgNode (const SgNodeStorageClass &source) | |
| IR node constructor to support AST File I/O. | |
| SgNode * | addRegExpAttribute (std::string s, AstRegExAttribute *a) |
| Support for AST matching using regular expression. | |
| void | set_isModified (bool isModified) |
| All nodes in the AST contain a isModified flag used to track changes to the AST. | |
| void | set_containsTransformation (bool containsTransformation) |
| Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. | |
| bool | get_isModified () const |
| Acess function for isModified flag. | |
| bool | get_containsTransformation () const |
| Acess function for containsTransformation flag. | |
| void | set_parent (SgNode *parent) |
| All nodes in the AST contain a reference to a parent node. | |
| SgNode * | get_parent () const |
| Access function for parent node. | |
| SgNode * | get_raw_parent () const |
| Access function for direct access to uncomputed value of parent node. | |
| bool | isChild (SgNode *node) const |
| Query function for if the input IR nodes is a child of the current IR node. | |
| virtual std::string | unparseToString (SgUnparse_Info *info) const |
| This function unparses the AST node (excluding comments and unnecessary white space) | |
| std::string | unparseToString () const |
| std::string | unparseToCompleteString () |
| This function unparses the AST node (including comments and white space) | |
| int | variant () const |
| bool | get_isVisited () const |
| DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. | |
| void | set_isVisited (bool isVisited) |
| Access function for p_isVisited flag used previously by the AST traversals. | |
| virtual void | addNewAttribute (std::string s, AstAttribute *a) |
| Add a new attribute represented by the named string. | |
| virtual AstAttribute * | getAttribute (std::string s) const |
| Returns attribute of name 's'. | |
| virtual void | updateAttribute (std::string s, AstAttribute *a) |
| Replace existing attribute of name 's' with new AstAttribute. | |
| virtual void | setAttribute (std::string s, AstAttribute *a) |
| This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. | |
| virtual void | removeAttribute (std::string s) |
| Remove attribute of name 's' if present. | |
| virtual bool | attributeExists (std::string s) const |
| Tests if attribute of name 's' is present. | |
| virtual int | numberOfAttributes () const |
| Returns the number of attributes on this IR node. | |
| virtual AstAttributeMechanism * | get_attributeMechanism () const |
| FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. | |
| virtual void | set_attributeMechanism (AstAttributeMechanism *a) |
| FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. | |
| virtual void | fixupCopy_scopes (SgNode *copy, SgCopyHelp &help) const |
| virtual void | fixupCopy_symbols (SgNode *copy, SgCopyHelp &help) const |
| virtual void | fixupCopy_references (SgNode *copy, SgCopyHelp &help) const |
| virtual Sg_File_Info * | get_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_Info * | get_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_Info * | get_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::CFGEdge > | cfgOutEdges (unsigned int index=false) |
| Find the out edges of a CFG node – internal version. | |
| virtual std::vector< VirtualCFG::CFGEdge > | cfgInEdges (unsigned int index=false) |
| Find the in edges of a CFG node – internal version. | |
| int | numberOfNodesInSubtree () |
| Computes the number of nodes in the defined subtree of the AST. | |
| int | depthOfSubtree () |
| Computes the depth of the current defined subtree of the AST. | |
| template<class T > | |
| T * | initParentPointer (T *child, SgNode *parent) |
| Generated for tree edge data member initializations. | |
| SgNode * | get_freepointer () const |
| void | set_freepointer (SgNode *freepointer) |
| virtual std::vector< SgNode * > | get_traversalSuccessorContainer () |
| container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation | |
| virtual std::vector< std::string > | get_traversalSuccessorNamesContainer () |
| container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation | |
| virtual RTIReturnType | roseRTI () |
| return C++ Runtime-Time-Information | |
| void | set_parent (SgNode *parent) |
| All nodes in the AST contain a reference to a parent node. | |
| SgNode * | get_parent () const |
| Access function for parent node. | |
| std::string | unparseToCompleteString () |
| This function unparses the AST node (including comments and white space) | |
| bool | get_isVisited () const |
| DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. | |
| void | set_isVisited (bool isVisited) |
| Access function for p_isVisited flag used previously by the AST traversals. | |
| template<class T > | |
| std::enable_if< std::is_pointer< T >::value, void >::type | changeChildPointer (T &edge, T const &child) |
| Set a child edge in a tree to point to a specific child. | |
| template<class T > | |
| std::enable_if<!std::is_pointer< T >::value, void >::type | changeChildPointer (T &edge, T const &child) |
| Set a child edge in a tree to point to a specific child. | |
| template<class T > | |
| std::enable_if< std::is_pointer< T >::value, void >::type | changeChildPointer (T &edge, T const &child) |
| Set a child edge in a tree to point to a specific child. | |
| template<class T > | |
| std::enable_if<!std::is_pointer< T >::value, void >::type | changeChildPointer (T &edge, T const &child) |
| Set a child edge in a tree to point to a specific child. | |
Static Public Member Functions | |
| static Rose::BinaryAnalysis::X86InstructionSize | instructionSizeForWidth (size_t) |
| Converts a size to an instruction size enum. | |
| static size_t | widthForInstructionSize (Rose::BinaryAnalysis::X86InstructionSize) |
| Converts a size enum constant to a size. | |
| static Rose::BinaryAnalysis::RegisterDictionaryPtr | registersForInstructionSize (Rose::BinaryAnalysis::X86InstructionSize) |
| Return the register dictionary for an x86 architecture. | |
| static Rose::BinaryAnalysis::RegisterDictionaryPtr | registersForWidth (size_t) |
| Return the register dictionary for an x86 architecture. | |
| 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 SgNode * | getNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx) |
| Find a node by its variant type, pool index, and item index. | |
| static SgNode * | getNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx) |
| FOR INTERNAL USE Find an SgNode from its memory pool and location therin. | |
| static std::string | getNodeIdString (SgNode *sgnode) |
| compute the NodeId for a particular SgNode*. | |
| static std::string | getNodeIdStringInternal (SgNode *sgnode) |
| static std::vector< std::string > | buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName) |
| Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. | |
| static std::vector< VariantT > | getClassHierarchySubTreeFunction (VariantT v) |
| static void | getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &) |
| static std::map< SgNode *, std::string > & | get_globalMangledNameMap () |
| Access function for performance optimizing global mangled name map. | |
| static void | clearGlobalMangledNameMap () |
| Support to clear the performance optimizing global mangled name map. | |
| static std::map< std::string, uint64_t > & | get_shortMangledNameCache () |
| Access function for lower level optimizing of global mangled name map. | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForNames () |
| Access function for name qualification support (for names). | |
| static void | set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for names). | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForTypes () |
| Access function for name qualification support (for type). | |
| static void | set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for type). | |
| static std::map< SgNode *, std::map< SgNode *, std::string > > & | get_globalQualifiedNameMapForMapsOfTypes () |
| Access function for name qualification support (for maps of types). | |
| static void | set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X) |
| Access function for name qualification support (for maps of types). | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForTemplateHeaders () |
| Access function for name qualification support (for template headers in template declarations). | |
| static void | set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for template headers in template declarations). | |
| static std::map< SgNode *, std::string > & | get_globalTypeNameMap () |
| Access function for name qualification support (for names of types). | |
| static void | set_globalTypeNameMap (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for names of types). | |
| static SgFunctionTypeTable * | get_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 SgTypeTable * | get_globalTypeTable () |
| Access function for symbol table specific to non-function types. | |
| static void | set_globalTypeTable (SgTypeTable *globalTypeTable) |
| Access function for symbol table specific to non-function types. | |
| static VariantT | variantFromPool (SgNode const *n) |
| template<class T > | |
| static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type | createAndParent (SgNode *parent) |
| Allocate and return a new node after setting its parent. | |
| static void | deleteMemoryPool () |
| static size_t | numberOfNodes () |
| Returns the total number of IR nodes of this type. | |
| static size_t | memoryUsage () |
| Returns the size in bytes of the total memory allocated for all IR nodes of this type. | |
| static void | traverseMemoryPoolNodes (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. | |
| static void | traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor) |
| FOR INTERNAL USE Support for visitor pattern. | |
| static void | visitRepresentativeNode (ROSE_VisitTraversal &visit) |
| FOR INTERNAL USE Support for type-based traversal. | |
| static SgNode * | getNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx) |
| Find a node by its variant type, pool index, and item index. | |
| static SgNode * | getNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx) |
| FOR INTERNAL USE Find an SgNode from its memory pool and location therin. | |
| static std::string | getNodeIdString (SgNode *sgnode) |
| compute the NodeId for a particular SgNode*. | |
| static std::string | getNodeIdStringInternal (SgNode *sgnode) |
| static std::vector< std::string > | buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName) |
| Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. | |
| static std::vector< VariantT > | getClassHierarchySubTreeFunction (VariantT v) |
| static void | getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &) |
| static std::map< SgNode *, std::string > & | get_globalMangledNameMap () |
| Access function for performance optimizing global mangled name map. | |
| static void | clearGlobalMangledNameMap () |
| Support to clear the performance optimizing global mangled name map. | |
| static std::map< std::string, uint64_t > & | get_shortMangledNameCache () |
| Access function for lower level optimizing of global mangled name map. | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForNames () |
| Access function for name qualification support (for names). | |
| static void | set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for names). | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForTypes () |
| Access function for name qualification support (for type). | |
| static void | set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for type). | |
| static std::map< SgNode *, std::map< SgNode *, std::string > > & | get_globalQualifiedNameMapForMapsOfTypes () |
| Access function for name qualification support (for maps of types). | |
| static void | set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X) |
| Access function for name qualification support (for maps of types). | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForTemplateHeaders () |
| Access function for name qualification support (for template headers in template declarations). | |
| static void | set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for template headers in template declarations). | |
| static std::map< SgNode *, std::string > & | get_globalTypeNameMap () |
| Access function for name qualification support (for names of types). | |
| static void | set_globalTypeNameMap (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for names of types). | |
| static SgFunctionTypeTable * | get_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 SgTypeTable * | get_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. | |
Protected Member Functions | |
| void | initializeProperties () |
| Initialize all properties that have explicit initial values. | |
| Protected Member Functions inherited from SgAsmInstruction | |
| void | initializeProperties () |
| Initialize all properties that have explicit initial values. | |
| Protected Member Functions inherited from SgAsmStatement | |
| SgAsmStatement () | |
| Default constructor. | |
| SgAsmStatement (rose_addr_t const &address) | |
| Constructor. | |
| void | initializeProperties () |
| Initialize all properties that have explicit initial values. | |
| Protected Member Functions inherited from SgAsmNode | |
| SgAsmNode () | |
| Default constructor. | |
| void | initializeProperties () |
| Initialize all properties that have explicit initial values. | |
| Protected Member Functions inherited from SgNode | |
| virtual void | post_construction_initialization () |
| Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. | |
| virtual void | destructorHelper () |
| This gets called by all Rosebud-generated destructors. | |
| 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 | destructorHelper () |
| This gets called by all Rosebud-generated destructors. | |
| virtual void | debugSerializationBegin (const char *className) |
| Called by generated serializers. | |
| virtual void | debugSerializationEnd (const char *className) |
| Called by generated serializers. | |
| virtual void | debugSerializationBegin (const char *className) |
| Called by generated serializers. | |
| virtual void | debugSerializationEnd (const char *className) |
| Called by generated serializers. | |
Additional Inherited Members | |
| Public Types inherited from SgNode | |
| enum | { static_variant = V_SgNode } |
| static variant value More... | |
| enum | { static_variant = V_SgNode } |
| static variant value More... | |
| Static Public Attributes inherited from SgAsmInstruction | |
| static const int64_t | INVALID_STACK_DELTA |
| Represents an invalid stack delta. | |
| Protected Attributes inherited from SgNode | |
| SgNode * | p_parent |
| This is the pointer to the parent IR node in the AST. | |
| bool | p_isModified |
| Records if IR node has been modified (data members reset). | |
| bool | p_containsTransformation |
| SgNode * | p_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 SgFunctionTypeTable * | p_globalFunctionTypeTable |
| Pointer to symbol table specific to function types. | |
| static SgTypeTable * | p_globalTypeTable |
| static std::map< SgNode *, std::string > | p_globalMangledNameMap |
| Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. | |
| static std::map< std::string, uint64_t > | p_shortMangledNameCache |
| STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. | |
| static std::map< SgNode *, std::string > | p_globalQualifiedNameMapForNames |
| static std::map< SgNode *, std::string > | p_globalQualifiedNameMapForTypes |
| static std::map< SgNode *, std::string > | p_globalQualifiedNameMapForTemplateHeaders |
| static std::map< SgNode *, std::string > | p_globalTypeNameMap |
| static std::map< SgNode *, std::map< SgNode *, std::string > > | p_globalQualifiedNameMapForMapsOfTypes |
Member Function Documentation
◆ get_kind()
| Rose::BinaryAnalysis::X86InstructionKind const & SgAsmX86Instruction::get_kind | ( | ) | const |
Property: Instruction kind.
Returns an enum constant describing the x86 instruction. These enum constants correspond roughly 1:1 with instruction mnemonics. Each architecture has its own set of enum constants. See also, getAnyKind.
◆ set_kind()
| void SgAsmX86Instruction::set_kind | ( | Rose::BinaryAnalysis::X86InstructionKind const & | ) |
Property: Instruction kind.
Returns an enum constant describing the x86 instruction. These enum constants correspond roughly 1:1 with instruction mnemonics. Each architecture has its own set of enum constants. See also, getAnyKind.
◆ get_lockPrefix()
| bool const & SgAsmX86Instruction::get_lockPrefix | ( | ) | const |
Property: Whether the x86 lock prefix was present.
Returns true if this instruction had the x86 lock prefix byte; false otherwise.
◆ set_lockPrefix()
| void SgAsmX86Instruction::set_lockPrefix | ( | bool const & | ) |
Property: Whether the x86 lock prefix was present.
Returns true if this instruction had the x86 lock prefix byte; false otherwise.
◆ get_segmentOverride()
| Rose::BinaryAnalysis::X86SegmentRegister const & SgAsmX86Instruction::get_segmentOverride | ( | ) | const |
Property: The segment override register.
Returns an enum describing the segment register override. Note that this is not a register descriptor, but an enum constant.
◆ set_segmentOverride()
| void SgAsmX86Instruction::set_segmentOverride | ( | Rose::BinaryAnalysis::X86SegmentRegister const & | ) |
Property: The segment override register.
Returns an enum describing the segment register override. Note that this is not a register descriptor, but an enum constant.
◆ instructionSizeForWidth()
|
static |
Converts a size to an instruction size enum.
Given a size in bits, which must be 16, 32, or 64, return the corresponding enum constant.
◆ widthForInstructionSize()
|
static |
Converts a size enum constant to a size.
Given a size enum constant, return the number of bits that enum represents.
◆ registersForInstructionSize()
|
static |
Return the register dictionary for an x86 architecture.
Given an instruction size enum constant return the register dictionary that describes the x86 architecture with the specified word size. See also, registersForWidth.
◆ registersForWidth()
|
static |
Return the register dictionary for an x86 architecture.
Given an instruction size of 16, 32, or 64 return the register dictionary that describes the x86 architecture with the specified word size. See also, registersForInstructionSize.
◆ get_anyKind()
|
overridevirtual |
Returns instruction kind for any architecture.
Instruction kinds are specific to the architecture so it doesn't make sense to compare an instruction kind from x86 with an instruction kind from m68k. However, this virtual function exists so that we don't need to implement switch statements every time we want to compare two instructions from the same architecture. For instance, instead of code like this:
return false;
if (SgAsmM68kInstruction *aa = isSgAsmM68kInstruction(a)) {
SgAsmM68kInstruction *bb = isSgAsmM68kInstruction(b);
return aa->get_kind() == bb->get_kind();
}
if (SgAsmMipsInstruction *aa = isSgAsmMipsInstruction(a)) {
SgAsmMipsInstruction *bb = isSgAsmMipsInstruction(b);
return aa->get_kind() == bb->get_kind();
}
...
... // and many others
...
ASSERT_not_reachable("architecture is not implemented yet");
}
Definition binaryInstruction.C:7459
Rose::BinaryAnalysis::M68kInstructionKind const & get_kind() const
Property: Instruction kind.
Rose::BinaryAnalysis::MipsInstructionKind const & get_kind() const
Property: Instruction kind.
we can write future-proof code:
}
virtual unsigned get_anyKind() const
Returns instruction kind for any architecture.
Reimplemented from SgAsmInstruction.
◆ 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:
