ROSE  0.9.6a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SgAsmInstruction Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmInstruction:
Collaboration diagram for SgAsmInstruction:

Public Types

enum  { static_variant = V_SgAsmInstruction }
 static variant value More...
 
typedef SgAsmStatement base_node_type
 
- Public Types inherited from SgAsmStatement
enum  { static_variant = V_SgAsmStatement }
 static variant value More...
 
typedef SgAsmNode base_node_type
 
- Public Types inherited from SgAsmNode
enum  { static_variant = V_SgAsmNode }
 static variant value More...
 
typedef SgNode base_node_type
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value More...
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
SgAsmInstructioncfgBinFlowOutEdge (const VirtualBinCFG::AuxiliaryInformation *info)
 
std::vector
< VirtualBinCFG::CFGEdge
cfgBinOutEdges (const VirtualBinCFG::AuxiliaryInformation *info)
 
std::vector
< VirtualBinCFG::CFGEdge
cfgBinInEdges (const VirtualBinCFG::AuxiliaryInformation *info)
 
void append_sources (SgAsmInstruction *instruction)
 
virtual bool terminates_basic_block ()
 Determines if an instruction can terminate a basic block. More...
 
virtual bool is_function_call (const std::vector< SgAsmInstruction * > &, rose_addr_t *target, rose_addr_t *ret)
 Returns true if the specified basic block looks like a function call. More...
 
virtual bool is_function_return (const std::vector< SgAsmInstruction * > &)
 Returns true if the specified basic block looks like a function return. More...
 
bool is_first_in_block ()
 Returns true if this instruction is the first instruction in a basic block. More...
 
bool is_last_in_block ()
 Returns true if this instruction is the last instruction in a basic block. More...
 
virtual bool get_branch_target (rose_addr_t *target)
 Obtains the virtual address for a branching instruction. More...
 
virtual bool has_effect ()
 Virtual method to determine if a single instruction has an effect. More...
 
virtual bool has_effect (const std::vector< SgAsmInstruction * > &, bool allow_branch=false, bool relax_stack_semantics=false)
 Virtual method to determine if an instruction sequence has an effect. More...
 
virtual std::vector< std::pair
< size_t, size_t > > 
find_noop_subsequences (const std::vector< SgAsmInstruction * > &insns, bool allow_branch=false, bool relax_stack_semantics=false)
 Virtual method to find subsequences of an instruction sequence that are effectively no-ops. More...
 
virtual std::set< rose_addr_tget_successors (bool *complete)
 Control flow successors for a single instruction. More...
 
virtual std::set< rose_addr_tget_successors (const std::vector< SgAsmInstruction * > &, bool *complete, MemoryMap *initial_memory=NULL)
 Control flow successors for a basic block. More...
 
virtual size_t get_size () const
 Returns the size of an instruction in bytes. More...
 
virtual bool is_unknown () const
 Returns true if this instruction is the special "unknown" instruction. More...
 
virtual std::string class_name () const
 Copies AST (whole subtree, depending on the SgCopyHelp class. More...
 
virtual VariantT variantT () const
 returns new style SageIII enum values More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual size_t get_numberOfTraversalSuccessors ()
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx)
 
virtual size_t get_childIndex (SgNode *child)
 
virtual RTIReturnType roseRTI ()
 FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes. More...
 
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
virtual void accept (ROSE_VisitorPattern &visitor)
 DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...
 
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual std::vector< std::pair
< SgNode *, std::string > > 
returnDataMemberPointers () const
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
virtual long getChildIndex (SgNode *childNode) const
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...
 
 SgAsmInstruction (const SgAsmInstructionStorageClass &source)
 
SgAsmInstructionaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
std::string get_mnemonic () const
 
void set_mnemonic (std::string mnemonic)
 
SgUnsignedCharList get_raw_bytes () const
 
void set_raw_bytes (SgUnsignedCharList raw_bytes)
 
SgAsmOperandListget_operandList () const
 
void set_operandList (SgAsmOperandList *operandList)
 
SgAsmStatementPtrList get_sources () const
 
void set_sources (SgAsmStatementPtrList sources)
 
virtual ~SgAsmInstruction ()
 
 SgAsmInstruction (rose_addr_t address=0, std::string mnemonic="")
 
- Public Member Functions inherited from SgAsmStatement
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgAsmStatement (const SgAsmStatementStorageClass &source)
 
SgAsmStatementaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
rose_addr_t get_address () const
 
void set_address (rose_addr_t address)
 
std::string get_comment () const
 
void set_comment (std::string comment)
 
virtual ~SgAsmStatement ()
 
 SgAsmStatement (rose_addr_t address=0)
 
- Public Member Functions inherited from SgAsmNode
 SgAsmNode (const SgAsmNode &X)
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string. More...
 
virtual AstAttributegetAttribute (std::string s) const
 Returns attribute of name 's'. More...
 
virtual void updateAttribute (std::string s, AstAttribute *a)
 Replace existing attribute of name 's' with new AstAttribute. More...
 
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. More...
 
virtual void removeAttribute (std::string s)
 Remove attribute of name 's' if present. More...
 
virtual bool attributeExists (std::string s) const
 Tests if attribute of name 's' is present. More...
 
virtual int numberOfAttributes () const
 Returns the number of attributes on this IR node. More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgAsmNode (const SgAsmNodeStorageClass &source)
 
SgAsmNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
AttachedPreprocessingInfoTypeget_attachedPreprocessingInfoPtr () const
 
void set_attachedPreprocessingInfoPtr (AttachedPreprocessingInfoType *attachedPreprocessingInfoPtr)
 
AstAttributeMechanismget_asmAttributeMechanism () const
 
void set_asmAttributeMechanism (AstAttributeMechanism *asmAttributeMechanism)
 
AstAttributeMechanismget_attributeMechanism () const
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
 
void set_attributeMechanism (AstAttributeMechanism *attributeMechanism)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...
 
virtual ~SgAsmNode ()
 
 SgAsmNode ()
 
- Public Member Functions inherited from SgNode
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgNode (const SgNodeStorageClass &source)
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST. More...
 
bool get_isModified () const
 Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node. More...
 
SgNodeget_parent () const
 Access function for parent node. More...
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node. More...
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space) More...
 
std::string unparseToString () const
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space) More...
 
int variant () const ROSE_DEPRECATED_FUNCTION
 Older version function returns enum value "NODE". More...
 
virtual void fixupCopy (SgNode *copy, SgCopyHelp &help) const
 
virtual Sg_File_Infoget_file_info (void) const
 File information containing filename, line number, column number, and if the SgNode is a part of a new transformation, etc. More...
 
virtual Sg_File_Infoget_startOfConstruct (void) const
 New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword). More...
 
virtual Sg_File_Infoget_endOfConstruct (void) const
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). More...
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node. More...
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node. More...
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct. More...
 
virtual bool cfgIsIndexInteresting (unsigned int index) const
 Determine whether a particular CFG node index is "interesting" for this kind of node. More...
 
virtual unsigned int cfgFindChildIndex (SgNode *n)
 Find the index of n in this node's CFG children. More...
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n)
 Find the index just after n in this node's CFG children. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgInEdges (unsigned int index=false)
 Find the in edges of a CFG node – internal version. More...
 
int numberOfNodesInSubtree ()
 Computes the number of nodes in the defined subtree of the AST. More...
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST. More...
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor. More...
 
 SgNode ()
 This is the constructor. More...
 
bool get_isVisited () const ROSE_DEPRECATED_FUNCTION
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...
 
void set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
 Access function for p_isVisited flag used previously by the AST traversals. More...
 

Static Public Member Functions

static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgAsmStatement
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgAsmNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
static std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...
 
static std::vector< VariantTgetClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode
*, std::string > & 
get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map. More...
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map. More...
 
static std::map< std::string,
int > & 
get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map. More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names). More...
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names). More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type). More...
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type). More...
 
static std::map< SgNode
*, std::string > & 
get_globalTypeNameMap ()
 Access function for name qualification support (for names of types). More...
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types). More...
 
static SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types. More...
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types. More...
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types. More...
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types. More...
 

Protected Attributes

std::string p_mnemonic
 
SgUnsignedCharList p_raw_bytes
 
SgAsmOperandListp_operandList
 
SgAsmStatementPtrList p_sources
 
- Protected Attributes inherited from SgAsmStatement
rose_addr_t p_address
 
std::string p_comment
 
- Protected Attributes inherited from SgAsmNode
AttachedPreprocessingInfoTypep_attachedPreprocessingInfoPtr
 
AstAttributeMechanismp_asmAttributeMechanism
 
AstAttributeMechanismp_attributeMechanism
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST. More...
 
bool p_isModified
 Records if IR node has been modified (data members reset). More...
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects. More...
 

Friends

class AST_FILE_IO
 
class SgAsmInstructionStorageClass
 
class AstSpecificDataManagingClass
 
class AstSpecificDataManagingClassStorageClass
 
ROSE_DLL_API friend
SgAsmInstruction
isSgAsmInstruction (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const
SgAsmInstruction
isSgAsmInstruction (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgAsmInstructionSgAsmInstruction_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O Mechanism. More...
 
unsigned long SgAsmInstruction_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgAsmInstruction_clearMemoryPool ()
 
void SgAsmInstruction_extendMemoryPoolForFileIO (unsigned long)
 
void SgAsmInstruction_getNextValidPointer (std::pair< SgAsmInstruction *, std::vector< unsigned char * >::const_iterator > &)
 
void SgAsmInstruction_resetValidFreepointers ()
 

Additional Inherited Members

- 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. More...
 
- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types. More...
 
static SgTypeTablep_globalTypeTable
 
static std::map< SgNode
*, std::string > 
p_globalMangledNameMap
 Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...
 
static std::map< std::string, int > p_shortMangledNameCache
 STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForNames
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForTypes
 
static std::map< SgNode
*, std::string > 
p_globalTypeNameMap
 

Detailed Description

Definition at line 255114 of file Cxx_Grammar.h.

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator
static_variant 

Definition at line 255176 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgAsmInstruction::SgAsmInstruction ( const SgAsmInstructionStorageClass source)
virtual SgAsmInstruction::~SgAsmInstruction ( )
virtual
SgAsmInstruction::SgAsmInstruction ( rose_addr_t  address = 0,
std::string  mnemonic = "" 
)

Member Function Documentation

virtual SgNode* SgAsmInstruction::copy ( SgCopyHelp help) const
virtual

This function clones the current IR node object recursively or not, depending on the argument.

This function performs a copy based on the specification of the input parameter. The input parameter is used to determin which data members are copied by reference and which are copied by value.

Parameters
help- If this argument is of type SgTreeCopy, then the IR node is cloned recursively. If its of type SgShallowCopy only the first level of the IR node is copied, everything else is left pointing to the the original IR node's object's data members.
Returns
a pointer to the new clone.

It appears the the copy functions don't set the parents of anything that they do a deep copy of! This can cause AST tests to fail. In particular some functions that require the parent pointers to be valid will return NULL pointers (e.g. SgInitializedName::get_declaration()). It might be that we should allow this to be done as part of the SgCopyHelp::clone function or perhaps another member function of SgCopyHelp would be useful for this support. It is not serious if the AST post processing is done since that will set any NULL pointers that are found within its traversal.

Exceptions
noneNo exceptions are thrown by this function.

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

SgAsmInstruction* SgAsmInstruction::cfgBinFlowOutEdge ( const VirtualBinCFG::AuxiliaryInformation info)
std::vector<VirtualBinCFG::CFGEdge> SgAsmInstruction::cfgBinOutEdges ( const VirtualBinCFG::AuxiliaryInformation info)
std::vector<VirtualBinCFG::CFGEdge> SgAsmInstruction::cfgBinInEdges ( const VirtualBinCFG::AuxiliaryInformation info)
void SgAsmInstruction::append_sources ( SgAsmInstruction instruction)
bool SgAsmInstruction::terminates_basic_block ( )
virtual

Determines if an instruction can terminate a basic block.

The analysis only looks at the individual instruction and therefore is not very sophisticated. For instance, a conditional branch will always terminate a basic block by this method even if its condition is constant. The base class implementation always aborts; architecture-specific subclasses should override this to do something useful (pure virtual is not possible due to ROSETTA).

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

Definition at line 41 of file SgAsmInstruction.C.

Referenced by Partitioner::detectBasicBlocks(), Disassembler::disassembleBlock(), and Partitioner::Instruction::terminates_basic_block().

bool SgAsmInstruction::is_function_call ( const std::vector< SgAsmInstruction * > &  ,
rose_addr_t target,
rose_addr_t return_va 
)
virtual

Returns true if the specified basic block looks like a function call.

This instruction object is only used to select the appropriate virtual is_function_call(); the basic block to be analyzed is the first argument to the function. If the basic block looks like a function call then is_function_call() returns true. If (and only if) the target address is known (i.e., the address of the called function) then target is set to this address (otherwise target is unmodified). If the return address is known or can be guessed, then return_va is initialized to the return address, which is normally the fall-through address of the last instruction; otherwise the return_va is unmodified.

Reimplemented in SgAsmMipsInstruction, and SgAsmx86Instruction.

Definition at line 55 of file SgAsmInstruction.C.

Referenced by Disassembler::get_block_successors().

bool SgAsmInstruction::is_function_return ( const std::vector< SgAsmInstruction * > &  )
virtual

Returns true if the specified basic block looks like a function return.

This instruction object is only used to select the appropriate virtual is_function_return(); the basic block to be analyzed is the first argument to the function.

Reimplemented in SgAsmMipsInstruction, and SgAsmx86Instruction.

Definition at line 63 of file SgAsmInstruction.C.

bool SgAsmInstruction::is_first_in_block ( )

Returns true if this instruction is the first instruction in a basic block.

Definition at line 70 of file SgAsmInstruction.C.

References SgAsmBlock::get_statementList(), and isSgAsmInstruction.

bool SgAsmInstruction::is_last_in_block ( )

Returns true if this instruction is the last instruction in a basic block.

Definition at line 85 of file SgAsmInstruction.C.

References SgAsmBlock::get_statementList(), and isSgAsmInstruction.

bool SgAsmInstruction::get_branch_target ( rose_addr_t target)
virtual

Obtains the virtual address for a branching instruction.

Returns true if this instruction is a branching instruction and the target address is known; otherwise, returns false and target is not modified.

Reimplemented in SgAsmMipsInstruction, and SgAsmx86Instruction.

Definition at line 101 of file SgAsmInstruction.C.

Referenced by Partitioner::detectBasicBlocks().

bool SgAsmInstruction::has_effect ( )
virtual

Virtual method to determine if a single instruction has an effect.

Unless subclass redefines, assume all instructions have an effect other than adjusting the instruction pointer. See SgAsmx86Instruction implementation for complete documentation.

Reimplemented in SgAsmx86Instruction.

Definition at line 109 of file SgAsmInstruction.C.

bool SgAsmInstruction::has_effect ( const std::vector< SgAsmInstruction * > &  ,
bool  allow_branch = false,
bool  relax_stack_semantics = false 
)
virtual

Virtual method to determine if an instruction sequence has an effect.

Unless subclass redefines, assume all instruction sequences have an effect. See SgAsmx86Instruction implementation for complete documentation.

Reimplemented in SgAsmx86Instruction.

Definition at line 117 of file SgAsmInstruction.C.

std::vector< std::pair< size_t, size_t > > SgAsmInstruction::find_noop_subsequences ( const std::vector< SgAsmInstruction * > &  insns,
bool  allow_branch = false,
bool  relax_stack_semantics = false 
)
virtual

Virtual method to find subsequences of an instruction sequence that are effectively no-ops.

Unless subclass redefines, assume that the sequence has no no-op subsequences. See SgAsmx86Instruction implementation for complete documentation.

FIXME: Instead of leaving this unimplemented, we could implement it in terms of has_effect() and let the subclasses reimplement it only if they can do so more efficiently (which they probably can). [RPM 2010-04-30]

Reimplemented in SgAsmx86Instruction.

Definition at line 129 of file SgAsmInstruction.C.

std::set< rose_addr_t > SgAsmInstruction::get_successors ( bool *  complete)
virtual

Control flow successors for a single instruction.

The return value does not consider neighboring instructions, and therefore is quite naive. It returns only the information it can glean from this single instruction. If the returned set of virtual instructions is fully known then the complete argument will be set to true, otherwise false. The base class implementation always aborts()–it must be defined in an architecture-specific subclass (pure virtual is not possible due to ROSETTA).

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

Definition at line 12 of file SgAsmInstruction.C.

Referenced by Partitioner::detectBasicBlocks(), Partitioner::Instruction::get_successors(), and SgAsmx86Instruction::get_successors().

std::set< rose_addr_t > SgAsmInstruction::get_successors ( const std::vector< SgAsmInstruction * > &  basic_block,
bool *  complete,
MemoryMap initial_memory = NULL 
)
virtual

Control flow successors for a basic block.

The basic_block argument is a vector of instructions that is assumed to be a basic block that is entered only at the first instruction and exits only at the last instruction. A memory map can supply initial values for the analysis' memory state. The return value is a set of control flow successor virtual addresses, and the complete argument return value indicates whether the returned set is known to be complete (aside from interrupts, faults, etc). The base class implementation just calls the single-instruction version, so architecture-specific subclasses might want to override this to do something more sophisticated.

Reimplemented in SgAsmx86Instruction.

Definition at line 26 of file SgAsmInstruction.C.

size_t SgAsmInstruction::get_size ( ) const
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.

Definition at line 140 of file SgAsmInstruction.C.

References p_raw_bytes.

Referenced by Partitioner::detectBasicBlocks(), Disassembler::disassembleBlock(), SgAsmFunction::get_extent(), SgAsmBlock::get_fallthrough_va(), Partitioner::get_indirection_addr(), Partitioner::Instruction::get_size(), SgAsmx86Instruction::get_successors(), SgAsmPowerpcInstruction::get_successors(), SgAsmMipsInstruction::get_successors(), SgAsmx86Instruction::is_function_call(), SgAsmMipsInstruction::is_function_call(), Disassembler::mark_referenced_instructions(), Partitioner::pattern1(), Disassembler::search_following(), and Disassembler::search_next_address().

bool SgAsmInstruction::is_unknown ( ) const
virtual

Returns true if this instruction is the special "unknown" instruction.

Each instruction architecture in ROSE defines an "unknown" instruction to be used when the disassembler is unable to create a real instruction. This can happen, for instance, if the bit pattern does not represent a valid instruction for the architecture.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

Definition at line 149 of file SgAsmInstruction.C.

virtual std::string SgAsmInstruction::class_name ( ) const
virtual

Copies AST (whole subtree, depending on the SgCopyHelp class.

returns a string representing the class name

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual VariantT SgAsmInstruction::variantT ( ) const
virtual

returns new style SageIII enum values

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

void* SgAsmInstruction::operator new ( size_t  size)

returns pointer to newly allocated IR node

void SgAsmInstruction::operator delete ( void *  pointer,
size_t  size 
)

deallocated memory for IR node (returns memory to memory pool for reuse)

void SgAsmInstruction::operator delete ( void *  pointer)
static size_t SgAsmInstruction::numberOfNodes ( )
static

Returns the total number of IR nodes of this type.

static size_t SgAsmInstruction::memoryUsage ( )
static

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

virtual std::vector<SgNode*> SgAsmInstruction::get_traversalSuccessorContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual std::vector<std::string> SgAsmInstruction::get_traversalSuccessorNamesContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns
Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual size_t SgAsmInstruction::get_numberOfTraversalSuccessors ( )
virtual
virtual SgNode* SgAsmInstruction::get_traversalSuccessorByIndex ( size_t  idx)
virtual
virtual size_t SgAsmInstruction::get_childIndex ( SgNode child)
virtual
virtual RTIReturnType SgAsmInstruction::roseRTI ( )
virtual

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

 This function provides runtime type information for accessing the

structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns
Returns a RTIReturnType object (runtime type information).

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual const char* SgAsmInstruction::sage_class_name ( ) const
virtual

returns a C style string (char*) representing the class name

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

void SgAsmInstruction::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgAsmInstruction::accept ( ROSE_VisitorPattern visitor)
virtual

DXN (08/09/2010): support for the classic visitor pattern done in GoF.

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

static void SgAsmInstruction::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmInstruction::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgAsmInstruction::visitRepresentativeNode ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgAsmInstruction::isInMemoryPool ( )
virtual

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual void SgAsmInstruction::checkDataMemberPointersIfInMemoryPool ( )
virtual

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual std::vector<std::pair<SgNode*,std::string> > SgAsmInstruction::returnDataMemberPointers ( ) const
virtual

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
STL vector of pairs of SgNode* and strings

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual void SgAsmInstruction::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *  )
virtual

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

virtual long SgAsmInstruction::getChildIndex ( SgNode childNode) const
virtual

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).

Warning
The mapping on children to integer values could change from release to release of ROSE.
Returns
long

Reimplemented from SgAsmStatement.

Reimplemented in SgAsmMipsInstruction, SgAsmPowerpcInstruction, SgAsmArmInstruction, and SgAsmx86Instruction.

SgAsmInstruction* SgAsmInstruction::addRegExpAttribute ( std::string  s,
AstRegExAttribute a 
)

Support for AST matching using regular expression.

This support is incomplete and the subject of current research to define RegEx trees to support inexact matching.

std::string SgAsmInstruction::get_mnemonic ( ) const
void SgAsmInstruction::set_mnemonic ( std::string  mnemonic)
SgAsmStatementPtrList SgAsmInstruction::get_sources ( ) const
void SgAsmInstruction::set_sources ( SgAsmStatementPtrList  sources)

Friends And Related Function Documentation

friend class AST_FILE_IO
friend

Definition at line 255447 of file Cxx_Grammar.h.

friend class SgAsmInstructionStorageClass
friend

Definition at line 255448 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass
friend

Definition at line 255449 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass
friend

Definition at line 255450 of file Cxx_Grammar.h.

ROSE_DLL_API friend SgAsmInstruction* isSgAsmInstruction ( SgNode s)
friend

Casts pointer from base class to derived class.

Referenced by is_first_in_block(), and is_last_in_block().

ROSE_DLL_API friend const SgAsmInstruction* isSgAsmInstruction ( const SgNode s)
friend

Casts pointer from base class to derived class (for const pointers)

SgAsmInstruction* SgAsmInstruction_getPointerFromGlobalIndex ( unsigned long  globalIndex)
friend

Constructor for use by AST File I/O Mechanism.

This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory which obtained via fast binary file I/O from disk.

Typedef used for low level memory access.

Typedef used to hold memory addresses as values.

Methods to find the pointer to a global and local index

unsigned long SgAsmInstruction_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned  long)
friend

Get the size of the memory pool.

It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.

void SgAsmInstruction_clearMemoryPool ( )
friend
void SgAsmInstruction_extendMemoryPoolForFileIO ( unsigned  long)
friend
void SgAsmInstruction_getNextValidPointer ( std::pair< SgAsmInstruction *, std::vector< unsigned char * >::const_iterator > &  )
friend
void SgAsmInstruction_resetValidFreepointers ( )
friend

Member Data Documentation

std::string SgAsmInstruction::p_mnemonic
protected

Definition at line 255519 of file Cxx_Grammar.h.

SgUnsignedCharList SgAsmInstruction::p_raw_bytes
protected

Definition at line 255523 of file Cxx_Grammar.h.

Referenced by get_size().

SgAsmOperandList* SgAsmInstruction::p_operandList
protected

Definition at line 255527 of file Cxx_Grammar.h.

SgAsmStatementPtrList SgAsmInstruction::p_sources
protected

Definition at line 255531 of file Cxx_Grammar.h.


The documentation for this class was generated from the following files: