ROSE  0.11.145.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
SgAsmFloatType Class Reference

Description

Floating point types.

Definition at line 14892 of file binaryInstruction.C.

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

Public Types

enum  Flag {
  GRADUAL_UNDERFLOW = 0x00000001,
  IMPLICIT_BIT_CONVENTION = 0x00000002
}
 Individual bit flags for this floating-point type. More...
 
typedef Rose::BitFlags< FlagFlags
 Collective bit flags for this floating-point type. More...
 
typedef Sawyer::Container::BitVector::BitRange BitRange
 Range of bits used for various purposes within the values of this type. More...
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value
 

Public Member Functions

 SgAsmFloatType (Rose::BinaryAnalysis::ByteOrder::Endianness, size_t nBits, const BitRange &significandBits, const BitRange exponentBits, size_t signBit, uint64_t exponentBias, Flags flags)
 Construct a new floating-point type. More...
 
BitRange significandBits () const
 Property: Offset to significand least significant bit. More...
 
BitRange exponentBits () const
 Property: Number of bits in the exponent. More...
 
size_t signBit () const
 Property: Offset to significand sign bit. More...
 
uint64_t exponentBias () const
 Property: Zero-point of exponent. More...
 
Flags flags () const
 Property: Bit vector of all boolean properties. More...
 
bool gradualUnderflow () const
 Property: Whether type has gradual underflow. More...
 
bool implicitBitConvention () const
 Property: Whether the type follows the IEEE 754 significand implicit bit convention. More...
 
virtual void check () const override
 Validate properties collectively. More...
 
virtual std::string toString () const override
 Convert a type to a string. More...
 
virtual ~SgAsmFloatType ()
 Destructor. More...
 
 SgAsmFloatType ()
 Default constructor. More...
 
- Public Member Functions inherited from SgAsmScalarType
virtual size_t get_nBits () const override
 Property: Number of bits. More...
 
Rose::BinaryAnalysis::ByteOrder::Endianness get_minorOrder () const
 Property: Minor byte order. More...
 
Rose::BinaryAnalysis::ByteOrder::Endianness get_majorOrder () const
 Property: Major byte order for mixed-order types. More...
 
size_t get_majorNBytes () const
 Property: Stride of major byte order for mixed order types. More...
 
virtual ~SgAsmScalarType ()
 Destructor. More...
 
- Public Member Functions inherited from SgAsmType
virtual size_t get_nBytes () const
 Width of type in bytes. More...
 
virtual ~SgAsmType ()
 Destructor. More...
 
- Public Member Functions inherited from SgAsmNode
virtual ~SgAsmNode ()
 Destructor. More...
 
Sawyer::Attribute::Storage const & attributes () const
 Attribute storage. More...
 
Sawyer::Attribute::Storageattributes ()
 Attribute storage. 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)
 
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 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...
 
SgNodeget_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 AstAttributegetAttribute (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 AstAttributeMechanismget_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...
 
template<class T >
T * initParentPointer (T *child, SgNode *parent)
 Generated for tree edge data member initializations. 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...
 
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...
 

Static Public Member Functions

static Flags ieeeFlags ()
 Default IEEE 754 flags. More...
 
- Static Public Member Functions inherited from SgAsmType
template<class Type >
static Type * registerOrDelete (Type *toInsert)
 Registers a type with the type system. 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 SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgNodegetNodeByNodeIdInternal (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 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 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 Member Functions

void initializeProperties ()
 Initialize all properties that have explicit initial values. More...
 
- Protected Member Functions inherited from SgAsmScalarType
 SgAsmScalarType (Rose::BinaryAnalysis::ByteOrder::Endianness, size_t nBits)
 Property: Major byte order for mixed-order types. More...
 
 SgAsmScalarType ()
 Default constructor. More...
 
void initializeProperties ()
 Initialize all properties that have explicit initial values. More...
 
- Protected Member Functions inherited from SgAsmType
 SgAsmType ()
 Default constructor. More...
 
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

- 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 std::vector< std::tuple< unsigned char *, unsigned, VariantT > > all_pools
 
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
 
static std::map< SgNode *, std::map< SgNode *, std::string > > p_globalQualifiedNameMapForMapsOfTypes
 

Member Typedef Documentation

Collective bit flags for this floating-point type.

Definition at line 14967 of file binaryInstruction.C.

Range of bits used for various purposes within the values of this type.

Definition at line 14970 of file binaryInstruction.C.

Member Enumeration Documentation

Individual bit flags for this floating-point type.

Enumerator
GRADUAL_UNDERFLOW 

De-normalized signifand when exponent field is clear.

IMPLICIT_BIT_CONVENTION 

Use IEEE 754 implicit bit convention for signicand.

Definition at line 14961 of file binaryInstruction.C.

Constructor & Destructor Documentation

SgAsmFloatType::SgAsmFloatType ( Rose::BinaryAnalysis::ByteOrder::Endianness  ,
size_t  nBits,
const BitRange significandBits,
const BitRange  exponentBits,
size_t  signBit,
uint64_t  exponentBias,
Flags  flags 
)

Construct a new floating-point type.

virtual SgAsmFloatType::~SgAsmFloatType ( )
virtual

Destructor.

SgAsmFloatType::SgAsmFloatType ( )

Default constructor.

Member Function Documentation

BitRange SgAsmFloatType::significandBits ( ) const

Property: Offset to significand least significant bit.

BitRange SgAsmFloatType::exponentBits ( ) const

Property: Number of bits in the exponent.

size_t SgAsmFloatType::signBit ( ) const

Property: Offset to significand sign bit.

uint64_t SgAsmFloatType::exponentBias ( ) const

Property: Zero-point of exponent.

Flags SgAsmFloatType::flags ( ) const

Property: Bit vector of all boolean properties.

static Flags SgAsmFloatType::ieeeFlags ( )
static

Default IEEE 754 flags.

These flags are the most common types and include the implicit bit convention for the significand and the gradual underflow capability.

bool SgAsmFloatType::gradualUnderflow ( ) const

Property: Whether type has gradual underflow.

If the type supports gradual underflow, then when the exponent field's bits are all clear then the integer part (a single bit implied or explicit depending on implicitBitConvention) of the significand is zero instead of one.

bool SgAsmFloatType::implicitBitConvention ( ) const

Property: Whether the type follows the IEEE 754 significand implicit bit convention.

If true, then the leading set bit of the significand is not stored but rather an implied. If the exponent field contains any non-zero bits then the integer part of the significand is one, otherwise when the exponent field is all clear the integer part is zero.

virtual void SgAsmFloatType::check ( ) const
overridevirtual

Validate properties collectively.

This method collectively validates the properties of a type since validation is not always possible or convenient when the user modifies an individual property. For instance, when changing the bit fields in a floating-point type, it would be very inconvenient to the user if those properties individually validated there settings because it would require the user to shuffle fields around in such a way that they never overlap. This way, the overlap validation can occur after the user is all done moving the fields.

Reimplemented from SgAsmScalarType.

virtual std::string SgAsmFloatType::toString ( ) const
overridevirtual

Convert a type to a string.

The output is intended mostly for debugging since it contains more details than what would be typically useful. For instance, instead of the word "double", this will probably print all the details about where the various floating-point fields are located, how the exponent field works, etc.

Reimplemented from SgAsmScalarType.

void SgAsmFloatType::initializeProperties ( )
protected

Initialize all properties that have explicit initial values.

This function is mostly for use in user-defined constructors where the user desires to initialize all the properties but does not know the names of the data members that store the property values. This function initializes the properties that have explicit initializations within this class, but does not recursively initialize base classes.


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