ROSE  0.9.10.103
Public Member Functions | Static Public Member Functions | List of all members
SgAsmIntegerValueExpression Class Reference

Description

Base class for integer values.

An integer value consists of an offset from an optional base node. The base node must be some kind of object with a virtual address, such as an instruction, symbol, segment, etc. If no base node is associated with the SgAsmIntegerValueExpression (the default situation), then a zero base address is used.

When a (new) base object is associated with an SgAsmIntegerValueExpression via the makeRelativeTo() method, the value of the expression does not change. However, the value does change when the address of the associated base node changes. For instance, one way to represent a function call to "main" is to have a CALL instruction whose operand is an SgAsmIntegerValueExpression that has a base which is either the entry instruction of "main" or the symbol for "main". That way, if the address of "main" changes then the target address in the CALL instruction also changes.

The base class stores the bits that are interpretted as the signed offset. The offset is accessed with get_relativeValue() and set_relativeValue() methods. The class also defines get_absoluteValue() and set_aabsoluteValue() methods that operate on the absolute value (which isn't actually stored anywhere).

Definition at line 2020 of file binaryInstruction.C.

Inheritance diagram for SgAsmIntegerValueExpression:
Inheritance graph
[legend]
Collaboration diagram for SgAsmIntegerValueExpression:
Collaboration graph
[legend]

Public Member Functions

 SgAsmIntegerValueExpression (uint64_t n, SgAsmType *type)
 Construct a new value of specified type. More...
 
 SgAsmIntegerValueExpression (const Sawyer::Container::BitVector &bv, SgAsmType *type)
 Construct a new value of specified type. More...
 
std::string get_label (bool quiet=false) const
 Returns a label for the value. More...
 
size_t get_significantBits () const
 Return the number of significant bits in the value. More...
 
void makeRelativeTo (SgNode *baseNode)
 Makes the value of this integer relative to some other addressable node. More...
 
uint64_t get_baseAddress () const
 Returns the base address. More...
 
uint64_t get_absoluteValue (size_t nbits=0) const
 Returns the current absolute value zero filled to 64 bits. More...
 
void set_absoluteValue (uint64_t)
 Set absolute value. More...
 
int64_t get_signedValue () const
 Returns the current absolute value (base+offset) as a signed value. More...
 
int64_t get_relativeValue () const
 Get relative value. More...
 
void set_relativeValue (int64_t v, size_t nbits=64)
 Set relative value without changing the base value. More...
 
uint64_t get_value () const
 
SgNodeget_baseNode () const
 Property: Base node associated with an integer. More...
 
void set_baseNode (SgNode *)
 Property: Base node associated with an integer. More...
 
- Public Member Functions inherited from SgAsmConstantExpression
const Sawyer::Container::BitVectorget_bitVector () const
 Property: Bits for constant. More...
 
Sawyer::Container::BitVectorget_bitVector ()
 Property: Bits for constant. More...
 
void set_bitVector (const Sawyer::Container::BitVector &bv)
 Property: Bits for constant. More...
 
- Public Member Functions inherited from SgAsmValueExpression
SgAsmValueExpressionget_unfolded_expression_tree () const
 Property: Alternate expression without constant folding. More...
 
void set_unfolded_expression_tree (SgAsmValueExpression *)
 Property: Alternate expression without constant folding. More...
 
unsigned short get_bit_offset () const
 Property: Where this expression is encoded within the instruction. More...
 
void set_bit_offset (unsigned short)
 Property: Where this expression is encoded within the instruction. More...
 
unsigned short get_bit_size () const
 Property: Where this expression is encoded within the instruction. More...
 
void set_bit_size (unsigned short)
 Property: Where this expression is encoded within the instruction. More...
 
SgSymbolget_symbol () const
 Property: Symbol corresponding to this expression. More...
 
void set_symbol (SgSymbol *)
 Property: Symbol corresponding to this expression. More...
 
- Public Member Functions inherited from SgAsmExpression
size_t get_nBits () const
 Property: Width of expression in bits. More...
 
Sawyer::Optional< uint64_t > asUnsigned () const
 Return a constant if possible. More...
 
Sawyer::Optional< int64_t > asSigned () const
 Return a signed constant if possible. More...
 
SgAsmTypeget_type () const
 Property: Type of expression. More...
 
void set_type (SgAsmType *)
 Property: Type of expression. More...
 
const std::string & get_comment () const
 Property: Comment. More...
 
void set_comment (const std::string &)
 Property: Comment. More...
 
- Public Member Functions inherited from SgNode
virtual SgNodecopy (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)
 
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 SgNodeget_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.
 
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...
 
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...
 
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.
 
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_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.
 
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).
 
virtual Sg_File_Infoget_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::CFGEdgecfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version.
 
virtual std::vector< VirtualCFG::CFGEdgecfgInEdges (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...
 
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 uint64_t virtualAddress (SgNode *)
 Returns the base address of an addressable IR node. More...
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 ROSETTA generated delete operator: deletes all non-traversed members. More...
 
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 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::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 SgFunctionTypeTableget_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 SgTypeTableget_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 SgNodebuild_node_from_nonlist_children ()
 

Additional Inherited Members

- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value
 
- 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.
 
- 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...
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 
- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types.
 
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.
 
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
 

Constructor & Destructor Documentation

SgAsmIntegerValueExpression::SgAsmIntegerValueExpression ( uint64_t  n,
SgAsmType type 
)

Construct a new value of specified type.

Creates a new AST node having value n of type type. See also, the constructor that takes a bit vector as the first argument, which is useful when the value is non-integral or is too large to fit in a uint64_t.

SgAsmIntegerValueExpression::SgAsmIntegerValueExpression ( const Sawyer::Container::BitVector bv,
SgAsmType type 
)

Construct a new value of specified type.

Creates a new AST node having value bv of type type. See also, the constructor that takes a uint64_t as the first argument which might be simpler to call in situations where the value is an integral type not more than 64 bits.

Member Function Documentation

SgNode* SgAsmIntegerValueExpression::get_baseNode ( ) const

Property: Base node associated with an integer.

When setting this property, the base node is changed without updating this object's relative value, thus this object's absolute value changes. The value returned by get_absoluteValue() will probably differ from what it would have returned before calling set_baseNode(). If this is not the behavior that's needed, see the makeRelativeTo() method.

The base node is not considered to be a child of this node in the AST.

void SgAsmIntegerValueExpression::set_baseNode ( SgNode )

Property: Base node associated with an integer.

When setting this property, the base node is changed without updating this object's relative value, thus this object's absolute value changes. The value returned by get_absoluteValue() will probably differ from what it would have returned before calling set_baseNode(). If this is not the behavior that's needed, see the makeRelativeTo() method.

The base node is not considered to be a child of this node in the AST.

static uint64_t SgAsmIntegerValueExpression::virtualAddress ( SgNode )
static

Returns the base address of an addressable IR node.

std::string SgAsmIntegerValueExpression::get_label ( bool  quiet = false) const

Returns a label for the value.

The label consists of the base object name (if available) or address, followed by a plus sign or minus sign, followed by the offset from that object. The empty string is returned if this integer value expression has no base object (i.e., it's absolute).

If the base object has no name and the integer value points directly at the object (offset=0) then one of two things happen: if quiet is true, the empty string is returned, otherwise the label is the name of the node type enclosed in an extra set of angle brackets. This is useful to indicate that a value is relative rather than absolute. For instance, the instruction listing "call 0x004126bb" is ambiguous as to whether 0x004126bb points to a known, unnamed function, a non-entry instruction within a function, or some memory location we didn't disassemble. But when labeled with quiet being false, the output will be:

  • call 0x004126bb<main>; points to a function with a name
  • call 0x004126bb<<Func>>; points to a function without a name
  • call 0x004126bb<<Insn>>; points to an instruction that's not a function entry point
  • call 0x004126bb; points to something that's not been disassembled
size_t SgAsmIntegerValueExpression::get_significantBits ( ) const

Return the number of significant bits in the value.

void SgAsmIntegerValueExpression::makeRelativeTo ( SgNode baseNode)

Makes the value of this integer relative to some other addressable node.

The absolute value of this expression is unchanged by this operation. The baseNode must be a type of IR node that has a virtual address, such as another instruction. If baseNode is the null pointer, then the "relativeness" of this constant is removed (i.e., it will be relative to zero).

Referenced by Rose::BinaryAnalysis::ControlFlow::apply_to_ast().

uint64_t SgAsmIntegerValueExpression::get_baseAddress ( ) const

Returns the base address.

The base address is the virtual address of the associated IR node, or zero if no IR node is associated with this integer value.

uint64_t SgAsmIntegerValueExpression::get_absoluteValue ( size_t  nbits = 0) const

Returns the current absolute value zero filled to 64 bits.

The absolute value is the 64-bit sum of the 64-bit address of the base node (or zero if no base node is associated with this object) and the 64-bit offset. However, this function returns only the specified number of low-order bits zero extended to the 64-bit return type. If nbits is zero, then get_significantBits() is called.

Referenced by Rose::BinaryAnalysis::ControlFlow::build_block_cfg_from_ast().

void SgAsmIntegerValueExpression::set_absoluteValue ( uint64_t  )

Set absolute value.

Changes the absolute value of this integer expression without changing the base node.

int64_t SgAsmIntegerValueExpression::get_signedValue ( ) const

Returns the current absolute value (base+offset) as a signed value.

int64_t SgAsmIntegerValueExpression::get_relativeValue ( ) const

Get relative value.

Interprets the bit vector as a signed value, sign extends it to 64-bits if necessary, and returns it.

void SgAsmIntegerValueExpression::set_relativeValue ( int64_t  v,
size_t  nbits = 64 
)

Set relative value without changing the base value.

The relative value is interpretted as a signed value of the specified width (defaulting to 64-bits).


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