Description
Represents an interpretation of a binary container.
An interpretation is a collection of the parts of a binary specimen that represent a coherent program, library, core dump, etc. For instance, a Windows PE executable has a DOS interpretation and a Windows interpretation–really two executables in the one container. All the DOS-related stuff will be under one SgAsmInterpretation AST and all the Windows-related stuff will be under another SgAsmInterpretation AST.
Definition at line 12448 of file binaryInstruction.C.
Inheritance diagram for SgAsmInterpretation:
Collaboration diagram for SgAsmInterpretation:
Public Member Functions | |
| SgAsmGenericFilePtrList | get_files () const |
| Returns a list of all files referenced by an interpretation. More... | |
| void | insert_instructions (InstructionMap &) |
| Populate a map of instructions indexed by their virtual addresses. More... | |
| void | erase_instructions (InstructionMap &) |
| Erase instructions from a map. More... | |
| virtual | ~SgAsmInterpretation () |
| Destructor. More... | |
| SgAsmInterpretation () | |
| Default constructor. More... | |
| SgAsmGenericHeaderList *const & | get_headers () const |
| Property: File headers. More... | |
| void | set_headers (SgAsmGenericHeaderList *const &) |
| Property: File headers. More... | |
| SgAsmBlock *const & | get_global_block () const |
| Property: Global block. More... | |
| void | set_global_block (SgAsmBlock *const &) |
| Property: Global block. More... | |
| Rose::BinaryAnalysis::MemoryMap::Ptr const & | get_map () const |
| Property: Memory map. More... | |
| void | set_map (Rose::BinaryAnalysis::MemoryMap::Ptr const &) |
| Property: Memory map. More... | |
| InstructionMap & | get_instruction_map (bool recompute=false) |
| Property: Cached map of instructions by address. More... | |
| void | set_instruction_map (const InstructionMap &) |
| Property: Cached map of instructions by address. More... | |
| bool const & | get_coverageComputed () const |
| Property: code coverage percent. More... | |
| void | set_coverageComputed (bool const &) |
| Property: code coverage percent. More... | |
| double const & | get_percentageCoverage () const |
| Property: code coverage percent. More... | |
| void | set_percentageCoverage (double const &) |
| Property: code coverage percent. More... | |
 Public Member Functions inherited from SgAsmNode | |
| virtual | ~SgAsmNode () |
| Destructor. More... | |
| Sawyer::Attribute::Storage const & | attributes () const |
| Attribute storage. More... | |
| Sawyer::Attribute::Storage & | attributes () |
| Attribute storage. More... | |
| Public Member Functions inherited from SgNode | |
| virtual SgNode * | copy (SgCopyHelp &help) const |
| This function clones the current IR node object recursively or not, depending on the argument. More... | |
| virtual std::string | class_name () const |
| returns a string representing the class name 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 | |
| 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 More... | |
| 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 More... | |
| 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 More... | |
| virtual const char * | sage_class_name () const ROSE_DEPRECATED_FUNCTION |
| generates string representing the class name: (e.g. for SgNode returns "SgNode"). More... | |
| 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. 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... | |
| 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. More... | |
| void | set_isModified (bool isModified) |
| All nodes in the AST contain a isModified flag used to track changes to the AST. More... | |
| 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. More... | |
| bool | get_isModified () const |
| Acess function for isModified flag. More... | |
| bool | get_containsTransformation () const |
| Acess function for containsTransformation flag. More... | |
| void | set_parent (SgNode *parent) |
| All nodes in the AST contain a reference to a parent node. More... | |
| SgNode * | get_parent () const |
| Access function for parent node. More... | |
| 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) More... | |
| int | variant () const ROSE_DEPRECATED_FUNCTION |
| Older version function returns enum value "NODE". More... | |
| 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. More... | |
| virtual void | set_attributeMechanism (AstAttributeMechanism *a) |
| FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More... | |
| virtual void | fixupCopy (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. More... | |
| int | depthOfSubtree () |
| Computes the depth of the current defined subtree of the AST. More... | |
| template<class T > | |
| T * | initParentPointer (T *child, SgNode *parent) |
| Generated for tree edge data member initializations. More... | |
| SgNode * | get_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... | |
| 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. More... | |
| 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. More... | |
Protected Member Functions | |
| void | initializeProperties () |
| Initialize all properties that have explicit initial values. More... | |
| Protected Member Functions inherited from SgAsmNode | |
| SgAsmNode () | |
| Default constructor. More... | |
| void | initializeProperties () |
| Initialize all properties that have explicit initial values. More... | |
| 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. More... | |
| virtual void | debugSerializationBegin (const char *className) |
| Called by generated serializers. More... | |
| virtual void | debugSerializationEnd (const char *className) |
| Called by generated serializers. More... | |
Additional Inherited Members | |
| Public Types inherited from SgNode | |
| enum | { static_variant = V_SgNode } |
| static variant value | |
| 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. More... | |
| 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. More... | |
| static void | clearGlobalMangledNameMap () |
| Support to clear the performance optimizing global mangled name map. | |
| 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::map< SgNode *, std::string > > & | get_globalQualifiedNameMapForMapsOfTypes () |
| Access function for name qualification support (for maps of types). More... | |
| static void | set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X) |
| Access function for name qualification support (for maps of types). More... | |
| static std::map< SgNode *, std::string > & | get_globalQualifiedNameMapForTemplateHeaders () |
| Access function for name qualification support (for template headers in template declarations). More... | |
| static void | set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X) |
| Access function for name qualification support (for template headers in template declarations). 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 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. More... | |
| Protected Attributes inherited from SgNode | |
| SgNode * | p_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... | |
| 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, 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. | |
| 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 |
Constructor & Destructor Documentation
|
virtual |
Destructor.
| SgAsmInterpretation::SgAsmInterpretation | ( | ) |
Default constructor.
Member Function Documentation
| SgAsmGenericHeaderList* const& SgAsmInterpretation::get_headers | ( | ) | const |
Property: File headers.
List of pointers to the file headers that compose this interpretation.
These headers are not considered to be children of this interpretation in the AST–they are reached from other traversal paths.
| void SgAsmInterpretation::set_headers | ( | SgAsmGenericHeaderList *const & | ) |
Property: File headers.
List of pointers to the file headers that compose this interpretation.
These headers are not considered to be children of this interpretation in the AST–they are reached from other traversal paths.
| SgAsmBlock* const& SgAsmInterpretation::get_global_block | ( | ) | const |
Property: Global block.
The global block is the top of the AST for this interpretation's functions, basic blocks, and instructions.
| void SgAsmInterpretation::set_global_block | ( | SgAsmBlock *const & | ) |
Property: Global block.
The global block is the top of the AST for this interpretation's functions, basic blocks, and instructions.
| Rose::BinaryAnalysis::MemoryMap::Ptr const& SgAsmInterpretation::get_map | ( | ) | const |
Property: Memory map.
This is the memory map representing the entire interpretation.
| void SgAsmInterpretation::set_map | ( | Rose::BinaryAnalysis::MemoryMap::Ptr const & | ) |
Property: Memory map.
This is the memory map representing the entire interpretation.
| InstructionMap& SgAsmInterpretation::get_instruction_map | ( | bool | recompute = false | ) |
Property: Cached map of instructions by address.
Returns the InstructionMap associated with an interpretation. The instruction map is recomputed if the currently cached map is empty or if the recompute argument is true. Otherwise this just returns the existing map. No attempt is made to make sure that the map is up-to-date with respect to the current state of the AST.
| void SgAsmInterpretation::set_instruction_map | ( | const InstructionMap & | ) |
Property: Cached map of instructions by address.
Returns the InstructionMap associated with an interpretation. The instruction map is recomputed if the currently cached map is empty or if the recompute argument is true. Otherwise this just returns the existing map. No attempt is made to make sure that the map is up-to-date with respect to the current state of the AST.
| bool const& SgAsmInterpretation::get_coverageComputed | ( | ) | const |
Property: code coverage percent.
True iff percentageCoverage has been computed.
Results of a code coverage analysis.
| void SgAsmInterpretation::set_coverageComputed | ( | bool const & | ) |
Property: code coverage percent.
True iff percentageCoverage has been computed.
Results of a code coverage analysis.
| double const& SgAsmInterpretation::get_percentageCoverage | ( | ) | const |
Property: code coverage percent.
The percentage of an interpretation where each section is marked as executable and identified for disassembly into instructions.
| void SgAsmInterpretation::set_percentageCoverage | ( | double const & | ) |
Property: code coverage percent.
The percentage of an interpretation where each section is marked as executable and identified for disassembly into instructions.
| SgAsmGenericFilePtrList SgAsmInterpretation::get_files | ( | ) | const |
Returns a list of all files referenced by an interpretation.
It does this by looking at the file headers referenced by the interpretation, following their parent pointers up to an SgAsmGenericFile node, and returning a vector of those nodes with duplicate files removed.
| void SgAsmInterpretation::insert_instructions | ( | InstructionMap & | ) |
Populate a map of instructions indexed by their virtual addresses.
This function traverses the AST rooted at the global_block and inserts each encountered instruction into the provided InstructionMap based on its starting virtual address.
| void SgAsmInterpretation::erase_instructions | ( | InstructionMap & | ) |
Erase instructions from a map.
This function traverses the AST rooted at the global_block and erases each encountered instruction from the provided InstructionMap based on its starting virtual address.
|
protected |
Initialize all properties that have explicit initial values.
This function is mostly for use in user-defined constructors where the user desires to initialize all the properties but does not know the names of the data members that store the property values. This function initializes the properties that have explicit initializations within this class, but does not recursively initialize base classes.
The documentation for this class was generated from the following file:
