Description
Base class for machine instructions.
- Each instruction is represented by one or more instances of SgAsmInstruction.
- An instruction obtained from a full AST will have a parent pointer. The instruction's first ancestor of type SgAsmBlock is the basic block in which the instruction appears, and its first ancestor of type SgAsmFunction is the function in which the instruction appears. There may be intervening AST nodes having other types.
- An instruction obtained from a Partitioner will not have a parent pointer. You can find ownership information using the Partitioner API.
- An instruction's bytes will always be contiguous in the virtual address space from which the instruction was decoded, but might not be contiguous in the file (if any) where the instruction was stored. In fact, there's no guarantee that the instruction even exists entirely within one file.
- Two distinct instructions (with different encodings) can start at the same virtual address if the specimen is self-modifying. Most ROSE analysis assumes that specimens are not self-modifying and uses the instruction's starting virtual address to uniquely identify the instruction.
- Two distinct instructions (with different encodings) can occupy overlapping bytes in the virtual address space, and are guaranteed to have different starting addresses unless the specimen is self-modifying.
Definition at line 43518 of file binaryInstruction.C.
Public Member Functions | |
| 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 unsigned | get_anyKind () const |
| Returns instruction kind for any architecture. | |
| 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. | |
| int64_t const & | get_stackDeltaIn () const |
| Property: Stack pointer at start of instruction relative to start of instruction's function. | |
| void | set_stackDeltaIn (int64_t const &) |
| Property: Stack pointer at start of instruction relative to start of instruction's function. | |
| 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 Attributes | |
| static const int64_t | INVALID_STACK_DELTA |
| Represents an invalid stack delta. | |
Protected Member Functions | |
| 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 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 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_architectureId()
| uint8_t const & SgAsmInstruction::get_architectureId | ( | ) | const |
Property: Architecture registration ID.
Every instruction must belong to a registered architecture. This ID specifies the architecture of which this instruction is a member.
When an instruction is serialized to a file, the architecture name is saved in place of its registration ID, and when the instruction is deserialized, that name is looked up in the registry and the registration ID is saved in the reconstituted instruction. This mechanism enables the instruction to point to the correct architecture even if the writer and reader tools have slightly different sets of architectures registered.
◆ get_rawBytes()
| SgUnsignedCharList const & SgAsmInstruction::get_rawBytes | ( | ) | const |
Property: Raw bytes of an instruction.
These are the bytes that were actually decoded to obtain the instruction AST.
◆ set_rawBytes()
| void SgAsmInstruction::set_rawBytes | ( | SgUnsignedCharList const & | ) |
Property: Raw bytes of an instruction.
These are the bytes that were actually decoded to obtain the instruction AST.
◆ get_operandList()
| SgAsmOperandList *const & SgAsmInstruction::get_operandList | ( | ) | const |
Property: AST node that holds all operands.
This is the SgAsmOperandList AST node that holds all the operands of this instruction. A separate node is necessary (rather than storing the operand list directly in the instruction node) due to limitations of ROSETTA.
◆ set_operandList()
| void SgAsmInstruction::set_operandList | ( | SgAsmOperandList *const & | ) |
Property: AST node that holds all operands.
This is the SgAsmOperandList AST node that holds all the operands of this instruction. A separate node is necessary (rather than storing the operand list directly in the instruction node) due to limitations of ROSETTA.
◆ get_delaySlot()
| SgAsmInstruction *const & SgAsmInstruction::get_delaySlot | ( | ) | const |
Property: Delay slot instructions.
The instruction occupying the delay slot for this instruction. A delay slot is an instruction that is executed without the effects of a preceding instruction. The most common form is a single arbitrary instruction located immediately after a branch instruction on a RISC architecture, in which case the delay instruction will execute even if the preceding branch is taken. This makes the instruction execute out-of-order compared to its location in memory or in the original assembler language code.
The address of the instruction pointed to by the delay slot must immediately follow this instruction. There is no AST edge from this instruction to its delay slot instruction.
◆ set_delaySlot()
| void SgAsmInstruction::set_delaySlot | ( | SgAsmInstruction *const & | ) |
Property: Delay slot instructions.
The instruction occupying the delay slot for this instruction. A delay slot is an instruction that is executed without the effects of a preceding instruction. The most common form is a single arbitrary instruction located immediately after a branch instruction on a RISC architecture, in which case the delay instruction will execute even if the preceding branch is taken. This makes the instruction execute out-of-order compared to its location in memory or in the original assembler language code.
The address of the instruction pointed to by the delay slot must immediately follow this instruction. There is no AST edge from this instruction to its delay slot instruction.
◆ get_stackDeltaIn()
| int64_t const & SgAsmInstruction::get_stackDeltaIn | ( | ) | const |
Property: Stack pointer at start of instruction relative to start of instruction's function.
If the stack delta was not computed, or could not be computed, or is a non-numeric value then the special value INVALID_STACK_DELTA is used.
◆ set_stackDeltaIn()
| void SgAsmInstruction::set_stackDeltaIn | ( | int64_t const & | ) |
Property: Stack pointer at start of instruction relative to start of instruction's function.
If the stack delta was not computed, or could not be computed, or is a non-numeric value then the special value INVALID_STACK_DELTA is used.
◆ get_semantics()
| SgAsmExprListExp *const & SgAsmInstruction::get_semantics | ( | ) | const |
Property: Ordered list of instruction semantics.
If instruction semantics are available and attached to the instruction, then this subtree will contain a list of semantic side effects of the instruction. The semantics are attached by using the Rose::BinaryAnalysis::InstructionSemantics::StaticSemantics semantic domain.
◆ set_semantics()
| void SgAsmInstruction::set_semantics | ( | SgAsmExprListExp *const & | ) |
Property: Ordered list of instruction semantics.
If instruction semantics are available and attached to the instruction, then this subtree will contain a list of semantic side effects of the instruction. The semantics are attached by using the Rose::BinaryAnalysis::InstructionSemantics::StaticSemantics semantic domain.
◆ architecture()
| Rose::BinaryAnalysis::Architecture::BaseConstPtr SgAsmInstruction::architecture | ( | ) | const |
Architecture for instruction.
The architecture is looked up in the architecture registery in constant time by using the architectureId property. It is generally unwise to change the architecture registery after instructions have been created since this may cause instructions to refer to an incorrect architecture.
Thread safety: This function is thread safe.
◆ get_mnemonic()
| std::string SgAsmInstruction::get_mnemonic | ( | ) | const |
Property: Instruction mnemonic string.
The short string that describes the instruction. When comparing instructions, it's faster to use the kind property defined in the subclasses, or the SgAsmInstruction::get_anyKind function instead of comparing mnemonic strings. But be aware that some architectures have mnemonics that include information about the instruction operands and this information is typically not represented by the instruction kind enum constants.
◆ operand()
| SgAsmExpression * SgAsmInstruction::operand | ( | size_t | ) | const |
Nth operand.
If the operand index is out of range, then null is returned.
◆ isFirstInBlock()
| bool SgAsmInstruction::isFirstInBlock | ( | ) |
Returns true if this instruction is the first instruction in a basic block.
This method looks only at the AST to make this determination.
◆ isLastInBlock()
| bool SgAsmInstruction::isLastInBlock | ( | ) |
Returns true if this instruction is the last instruction in a basic block.
This method looks only at the AST to make this determination.
◆ hasEffect() [1/2]
|
virtual |
Determines whether a single instruction has an effect.
An instruction has an effect if it does anything other than setting the instruction pointer to a concrete value. Instructions that have no effect are called "no-ops". The x86 NOP instruction is an example of a no-op, but there are others also.
The following information about x86 no-ops is largely from Cory Cohen at CMU/SEI. In the discussion that follows, we are careful to distinguish between NOP (the mneumonic for instructions 90, and 0f1f) and "no-op" (any instruction whose only effect is to advance the instruction pointer).
◆ hasEffect() [2/2]
|
virtual |
Determine if an instruction sequence has an effect.
A sequence of instructions has an effect if it does something other than setting the instruction pointer to a concrete value.
This is mostly a wrapper around the NoOperation analysis. The allow_branch and relax_stack_semantics are no longer supported but perhaps will be added eventually to the NoOperation analysis.
◆ findNoopSubsequences()
|
virtual |
Determines what subsequences of an instruction sequence have no cumulative effect.
The return value is a vector of pairs where each pair is the starting index and length of subsequence. The algorithm we use is to compute the machine state after each instruction and then look for pairs of states that are identical except for the instruction pointer.
This is mostly a wrapper around the NoOperation analysis. The allow_branch and relax_stack_semantics are no longer supported but perhaps will be added eventually to the NoOperation analysis.
◆ get_size()
|
virtual |
Returns the size of an instruction in bytes.
This is only a convenience function that returns the size of the instruction's raw byte vector. If an instruction or its arguments are modified, then the size returned by this function might not reflect the true size of the modified instruction if it were to be reassembled.
◆ get_anyKind()
|
virtual |
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:
we can write future-proof code:
Reimplemented in SgAsmX86Instruction, SgAsmUserInstruction, SgAsmPowerpcInstruction, SgAsmNullInstruction, SgAsmMipsInstruction, SgAsmM68kInstruction, SgAsmJvmInstruction, and SgAsmCilInstruction.
◆ toString()
|
virtual |
Converts the instruction to a string.
The return value is an address, colon, mnemonic, and arguments. Only one space is used between the parts.
◆ toStringNoAddr()
|
virtual |
Converts the instruction to a string.
The return value is a mnemonic, and arguments. Only one space is used between the parts.
◆ explicitConstants()
|
virtual |
Explicit constants.
Return the set of integer constants that appear explicitly in the instruction's operands. These are called "immediates" for some architectures such as X86.
◆ semanticFailure() [1/2]
| size_t SgAsmInstruction::semanticFailure | ( | ) | const |
Property: Whether instruction semantics failed at this location.
This property is incremented by various analyses that evaluate instructions semantically when semantics fails in a way that is not recoverable. Some analyses can work around failed semantics by operating in a degraded mode, and it is up to the analysis whether to increment this property.
Thread safety: This method is thread safe.
◆ semanticFailure() [2/2]
| void SgAsmInstruction::semanticFailure | ( | size_t | ) |
Property: Whether instruction semantics failed at this location.
This property is incremented by various analyses that evaluate instructions semantically when semantics fails in a way that is not recoverable. Some analyses can work around failed semantics by operating in a degraded mode, and it is up to the analysis whether to increment this property.
Thread safety: This method is thread safe.
◆ incrementSemanticFailure()
| void SgAsmInstruction::incrementSemanticFailure | ( | ) |
Property: Whether instruction semantics failed at this location.
This property is incremented by various analyses that evaluate instructions semantically when semantics fails in a way that is not recoverable. Some analyses can work around failed semantics by operating in a degraded mode, and it is up to the analysis whether to increment this property.
Thread safety: This method is thread safe.
◆ normalizeOperands()
| bool SgAsmInstruction::normalizeOperands | ( | ) |
Rewrite certain addressing modes for operands.
The addressing mode: REG1 + REG2 * SIZE + OFFSET is changed from (+ (+ REG1 (* REG2 SIZE)) OFFSET) to (+ (+ REG1 OFFSET) (* REG2 SIZE)), which during instruction semantic executions causes the base register and offset to be added first to obtain the starting address of an array, and then an additional offset added to obtain the address of the desired element of that array.
Returns true if anything changed, false otherwise.
◆ 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.
Member Data Documentation
◆ INVALID_STACK_DELTA
|
static |
Represents an invalid stack delta.
This value is used for the result of a stack delta analysis stored in the instruction AST if the stack delta analysis was not run or did not produce a numeric result.
Definition at line 43691 of file binaryInstruction.C.
The documentation for this class was generated from the following file:
