SgAsmElfEHFrameEntryCI Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmElfEHFrameEntryCI:

[legend]Collaboration diagram for SgAsmElfEHFrameEntryCI:

[legend]List of all members.

Public Types
typedef SgAsmExecutableFileFormat	base_node_type
	static_variant = V_SgAsmElfEHFrameEntryCI
enum	{ static_variant = V_SgAsmElfEHFrameEntryCI }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgAsmElfEHFrameEntryCI (SgAsmElfEHFrameSection *ehframe)
virtual void	dump (FILE *, const char *prefix, ssize_t idx) const
	Print some debugging info.
std::string	unparse (const SgAsmElfEHFrameSection *) const
	Unparse one Common Information Entry (CIE) without unparsing the Frame Description Entries (FDE) to which it points.
virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.
virtual VariantT	variantT () const
	returns new style SageIII enum values
void *	operator new (size_t size)
	returns pointer to newly allocated IR node
void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse)
void	operator delete (void *pointer)
virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only.
virtual size_t	get_numberOfTraversalSuccessors ()
virtual SgNode *	get_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.
virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION
void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern.
virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF.
virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.
virtual std::vector< std::pair< SgNode *, std::string > >	returnDataMemberPointers () const
	FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
virtual long	getChildIndex (SgNode *childNode) const
	FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.
	SgAsmElfEHFrameEntryCI (const SgAsmElfEHFrameEntryCIStorageClass &source)
SgAsmElfEHFrameEntryCI *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
int	get_version () const
void	set_version (int version)
std::string	get_augmentation_string () const
void	set_augmentation_string (std::string augmentation_string)
uint64_t	get_code_alignment_factor () const
void	set_code_alignment_factor (uint64_t code_alignment_factor)
int64_t	get_data_alignment_factor () const
void	set_data_alignment_factor (int64_t data_alignment_factor)
uint64_t	get_augmentation_data_length () const
void	set_augmentation_data_length (uint64_t augmentation_data_length)
int	get_lsda_encoding () const
void	set_lsda_encoding (int lsda_encoding)
int	get_prh_encoding () const
void	set_prh_encoding (int prh_encoding)
unsigned	get_prh_arg () const
void	set_prh_arg (unsigned prh_arg)
rose_addr_t	get_prh_addr () const
void	set_prh_addr (rose_addr_t prh_addr)
int	get_addr_encoding () const
void	set_addr_encoding (int addr_encoding)
bool	get_sig_frame () const
void	set_sig_frame (bool sig_frame)
const SgUnsignedCharList &	get_instructions () const
SgUnsignedCharList &	get_instructions ()
SgAsmElfEHFrameEntryFDList *	get_fd_entries () const
void	set_fd_entries (SgAsmElfEHFrameEntryFDList *fd_entries)
virtual	~SgAsmElfEHFrameEntryCI ()
	SgAsmElfEHFrameEntryCI ()
Static Public Member Functions
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.
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.
Protected Attributes
int	p_version
std::string	p_augmentation_string
uint64_t	p_code_alignment_factor
int64_t	p_data_alignment_factor
uint64_t	p_augmentation_data_length
int	p_lsda_encoding
int	p_prh_encoding
unsigned	p_prh_arg
rose_addr_t	p_prh_addr
int	p_addr_encoding
bool	p_sig_frame
SgUnsignedCharList	p_instructions
SgAsmElfEHFrameEntryFDList *	p_fd_entries
Private Member Functions
void	ctor (SgAsmElfEHFrameSection *)
	Non-parsing constructor.
Friends
class	AST_FILE_IO
class	SgAsmElfEHFrameEntryCIStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAsmElfEHFrameEntryCI *	isSgAsmElfEHFrameEntryCI (SgNode *s)
	Casts pointer from base class to derived class.
const SgAsmElfEHFrameEntryCI *	isSgAsmElfEHFrameEntryCI (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAsmElfEHFrameEntryCI *	SgAsmElfEHFrameEntryCI_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O MechanismTypedef 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	SgAsmElfEHFrameEntryCI_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAsmElfEHFrameEntryCI_clearMemoryPool ()
void	SgAsmElfEHFrameEntryCI_extendMemoryPoolForFileIO (unsigned long)
void	SgAsmElfEHFrameEntryCI_getNextValidPointer (std::pair< SgAsmElfEHFrameEntryCI *, std::vector< unsigned char * >::const_iterator > &)
void	SgAsmElfEHFrameEntryCI_resetValidFreepointers ()

---

Member Typedef Documentation

typedef SgAsmExecutableFileFormat SgAsmElfEHFrameEntryCI::base_node_type

Reimplemented from SgAsmExecutableFileFormat.

---

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

---

Constructor & Destructor Documentation

SgAsmElfEHFrameEntryCI::SgAsmElfEHFrameEntryCI

(

SgAsmElfEHFrameSection *

ehframe

)

[inline, explicit]

SgAsmElfEHFrameEntryCI::SgAsmElfEHFrameEntryCI

(

const SgAsmElfEHFrameEntryCIStorageClass &

source

)

virtual SgAsmElfEHFrameEntryCI::~SgAsmElfEHFrameEntryCI

(

)

[virtual]

SgAsmElfEHFrameEntryCI::SgAsmElfEHFrameEntryCI

(

)

---

Member Function Documentation

virtual SgNode* SgAsmElfEHFrameEntryCI::copy

(

SgCopyHelp &

help

)

const [virtual]

Reimplemented from SgAsmExecutableFileFormat.

void SgAsmElfEHFrameEntryCI::dump	(	FILE *	,
		const char *	prefix,
		ssize_t	idx
	)			const [virtual]

Print some debugging info.

std::string SgAsmElfEHFrameEntryCI::unparse

(

const SgAsmElfEHFrameSection *

ehframe

)

const

Unparse one Common Information Entry (CIE) without unparsing the Frame Description Entries (FDE) to which it points.

The initial length fields are not included in the result string.

void SgAsmElfEHFrameEntryCI::ctor

(

SgAsmElfEHFrameSection *

)

[private]

Non-parsing constructor.

virtual std::string SgAsmElfEHFrameEntryCI::class_name

(

)

const [virtual]

Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.

Reimplemented from SgAsmExecutableFileFormat.

virtual VariantT SgAsmElfEHFrameEntryCI::variantT

(

)

const [virtual]

returns new style SageIII enum values

Reimplemented from SgAsmExecutableFileFormat.

void* SgAsmElfEHFrameEntryCI::operator new

(

size_t

size

)

returns pointer to newly allocated IR node

Reimplemented from SgAsmExecutableFileFormat.

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

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

Reimplemented from SgAsmExecutableFileFormat.

void SgAsmElfEHFrameEntryCI::operator delete

(

void *

pointer

)

Reimplemented from SgAsmExecutableFileFormat.

static size_t SgAsmElfEHFrameEntryCI::numberOfNodes

(

)

[static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmExecutableFileFormat.

static size_t SgAsmElfEHFrameEntryCI::memoryUsage

(

)

[static]

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

Reimplemented from SgAsmExecutableFileFormat.

virtual std::vector<SgNode*> SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

virtual std::vector<std::string> SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

virtual size_t SgAsmElfEHFrameEntryCI::get_numberOfTraversalSuccessors

(

)

[virtual]

Reimplemented from SgAsmExecutableFileFormat.

virtual SgNode* SgAsmElfEHFrameEntryCI::get_traversalSuccessorByIndex

(

size_t

idx

)

[virtual]

Reimplemented from SgAsmExecutableFileFormat.

virtual size_t SgAsmElfEHFrameEntryCI::get_childIndex

(

SgNode *

child

)

[virtual]

Reimplemented from SgAsmExecutableFileFormat.

virtual RTIReturnType SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

virtual const char* SgAsmElfEHFrameEntryCI::sage_class_name

(

)

const [virtual]

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

Reimplemented from SgAsmExecutableFileFormat.

void SgAsmElfEHFrameEntryCI::executeVisitorMemberFunction

(

ROSE_VisitorPattern &

visitor

)

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

virtual void SgAsmElfEHFrameEntryCI::accept

(

ROSE_VisitorPattern &

visitor

)

[virtual]

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

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmElfEHFrameEntryCI::traverseMemoryPoolNodes

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmElfEHFrameEntryCI::traverseMemoryPoolVisitorPattern

(

ROSE_VisitorPattern &

visitor

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmElfEHFrameEntryCI::visitRepresentativeNode

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmExecutableFileFormat.

virtual bool SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

virtual void SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

virtual std::vector<std::pair<SgNode*,std::string> > SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

virtual void SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

virtual long SgAsmElfEHFrameEntryCI::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 SgAsmExecutableFileFormat.

SgAsmElfEHFrameEntryCI* SgAsmElfEHFrameEntryCI::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.

Reimplemented from SgAsmExecutableFileFormat.

int SgAsmElfEHFrameEntryCI::get_version

(

)

const

void SgAsmElfEHFrameEntryCI::set_version

(

int

version

)

std::string SgAsmElfEHFrameEntryCI::get_augmentation_string

(

)

const

void SgAsmElfEHFrameEntryCI::set_augmentation_string

(

std::string

augmentation_string

)

uint64_t SgAsmElfEHFrameEntryCI::get_code_alignment_factor

(

)

const

void SgAsmElfEHFrameEntryCI::set_code_alignment_factor

(

uint64_t

code_alignment_factor

)

int64_t SgAsmElfEHFrameEntryCI::get_data_alignment_factor

(

)

const

void SgAsmElfEHFrameEntryCI::set_data_alignment_factor

(

int64_t

data_alignment_factor

)

uint64_t SgAsmElfEHFrameEntryCI::get_augmentation_data_length

(

)

const

void SgAsmElfEHFrameEntryCI::set_augmentation_data_length

(

uint64_t

augmentation_data_length

)

int SgAsmElfEHFrameEntryCI::get_lsda_encoding

(

)

const

void SgAsmElfEHFrameEntryCI::set_lsda_encoding

(

int

lsda_encoding

)

int SgAsmElfEHFrameEntryCI::get_prh_encoding

(

)

const

void SgAsmElfEHFrameEntryCI::set_prh_encoding

(

int

prh_encoding

)

unsigned SgAsmElfEHFrameEntryCI::get_prh_arg

(

)

const

void SgAsmElfEHFrameEntryCI::set_prh_arg

(

unsigned

prh_arg

)

rose_addr_t SgAsmElfEHFrameEntryCI::get_prh_addr

(

)

const

void SgAsmElfEHFrameEntryCI::set_prh_addr

(

rose_addr_t

prh_addr

)

int SgAsmElfEHFrameEntryCI::get_addr_encoding

(

)

const

void SgAsmElfEHFrameEntryCI::set_addr_encoding

(

int

addr_encoding

)

bool SgAsmElfEHFrameEntryCI::get_sig_frame

(

)

const

void SgAsmElfEHFrameEntryCI::set_sig_frame

(

bool

sig_frame

)

const SgUnsignedCharList& SgAsmElfEHFrameEntryCI::get_instructions

(

)

const

SgUnsignedCharList& SgAsmElfEHFrameEntryCI::get_instructions

(

)

SgAsmElfEHFrameEntryFDList* SgAsmElfEHFrameEntryCI::get_fd_entries

(

)

const

void SgAsmElfEHFrameEntryCI::set_fd_entries

(

SgAsmElfEHFrameEntryFDList *

fd_entries

)

---

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmExecutableFileFormat.

friend class SgAsmElfEHFrameEntryCIStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmExecutableFileFormat.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmExecutableFileFormat.

SgAsmElfEHFrameEntryCI* isSgAsmElfEHFrameEntryCI

(

SgNode *

s

)

[friend]

Casts pointer from base class to derived class.

const SgAsmElfEHFrameEntryCI* isSgAsmElfEHFrameEntryCI

(

const SgNode *

s

)

[friend]

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

SgAsmElfEHFrameEntryCI* SgAsmElfEHFrameEntryCI_getPointerFromGlobalIndex

(

unsigned long

globalIndex

)

[friend]

Constructor for use by AST File I/O MechanismTypedef 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 SgAsmElfEHFrameEntryCI_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 SgAsmElfEHFrameEntryCI_clearMemoryPool

(

)

[friend]

void SgAsmElfEHFrameEntryCI_extendMemoryPoolForFileIO

(

unsigned

long

)

[friend]

void SgAsmElfEHFrameEntryCI_getNextValidPointer

(

std::pair< SgAsmElfEHFrameEntryCI *, std::vector< unsigned char * >::const_iterator > &

)

[friend]

void SgAsmElfEHFrameEntryCI_resetValidFreepointers

(

)

[friend]

---

Member Data Documentation

int SgAsmElfEHFrameEntryCI::p_version [protected]

std::string SgAsmElfEHFrameEntryCI::p_augmentation_string [protected]

uint64_t SgAsmElfEHFrameEntryCI::p_code_alignment_factor [protected]

int64_t SgAsmElfEHFrameEntryCI::p_data_alignment_factor [protected]

uint64_t SgAsmElfEHFrameEntryCI::p_augmentation_data_length [protected]

int SgAsmElfEHFrameEntryCI::p_lsda_encoding [protected]

int SgAsmElfEHFrameEntryCI::p_prh_encoding [protected]

unsigned SgAsmElfEHFrameEntryCI::p_prh_arg [protected]

rose_addr_t SgAsmElfEHFrameEntryCI::p_prh_addr [protected]

int SgAsmElfEHFrameEntryCI::p_addr_encoding [protected]

bool SgAsmElfEHFrameEntryCI::p_sig_frame [protected]

SgUnsignedCharList SgAsmElfEHFrameEntryCI::p_instructions [protected]

SgAsmElfEHFrameEntryFDList* SgAsmElfEHFrameEntryCI::p_fd_entries [protected]

---

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

• Cxx_Grammar.h
• ElfErrorFrame.C

---