SgAsmLESectionTableEntry Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmLESectionTableEntry:

[legend]Collaboration diagram for SgAsmLESectionTableEntry:


Public Types
typedef SgAsmExecutableFileFormat	base_node_type
	SF_RESERVED = 0xffff0800
	SF_READABLE = 0x00000001
	Read permission granted when mapped.
	SF_WRITABLE = 0x00000002
	Write permission granted when mapped.
	SF_EXECUTABLE = 0x00000004
	Execute permission granted when mapped.
	SF_RESOURCE = 0x00000008
	Section contains resource objects.
	SF_DISCARDABLE = 0x00000010
	Discardable section.
	SF_SHARED = 0x00000020
	Section is shared.
	SF_PRELOAD_PAGES = 0x00000040
	Section has preload pages.
	SF_INVALID_PAGES = 0x00000080
	Section has invalid pages.
	SF_TYPE_MASK = 0x00000300
	SF_TYPE_NORMAL = 0x00000000
	SF_TYPE_ZERO = 0x00000100
	Section has zero-filled pages.
	SF_TYPE_RESIDENT = 0x00000200
	Section is resident (valid for VDDs and PDDs only).
	SF_TYPE_RESCONT = 0x00000300
	Section is resident and contiguous.
	SF_RES_LONG_LOCK = 0x00000400
	Section is resident and "long-lockable" (VDDs and PDDs only).
	SF_1616_ALIAS = 0x00001000
	16:16 alias required (80x86 specific)
	SF_BIG_BIT = 0x00002000
	Big/default bit setting (80x86 specific); see note above.
	SF_CODE_CONFORM = 0x00004000
	Section is conforming for code (80x86 specific).
	SF_IO_PRIV = 0x00008000
	Section I/O privilege level (80x86 specific; used only for 16:16 alias objects).
	static_variant = V_SgAsmLESectionTableEntry
enum	LESectionFlags { SF_RESERVED = 0xffff0800, SF_READABLE = 0x00000001, SF_WRITABLE = 0x00000002, SF_EXECUTABLE = 0x00000004, SF_RESOURCE = 0x00000008, SF_DISCARDABLE = 0x00000010, SF_SHARED = 0x00000020, SF_PRELOAD_PAGES = 0x00000040, SF_INVALID_PAGES = 0x00000080, SF_TYPE_MASK = 0x00000300, SF_TYPE_NORMAL = 0x00000000, SF_TYPE_ZERO = 0x00000100, SF_TYPE_RESIDENT = 0x00000200, SF_TYPE_RESCONT = 0x00000300, SF_RES_LONG_LOCK = 0x00000400, SF_1616_ALIAS = 0x00001000, SF_BIG_BIT = 0x00002000, SF_CODE_CONFORM = 0x00004000, SF_IO_PRIV = 0x00008000 }
enum	{ static_variant = V_SgAsmLESectionTableEntry }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgAsmLESectionTableEntry (SgAsmExecutableFileFormat::ByteOrder sex, const SgAsmLESectionTableEntry::LESectionTableEntry_disk *disk)
void *	encode (SgAsmExecutableFileFormat::ByteOrder, SgAsmLESectionTableEntry::LESectionTableEntry_disk *) const
virtual void	dump (FILE f, const char prefix, ssize_t idx) const
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.
	SgAsmLESectionTableEntry (const SgAsmLESectionTableEntryStorageClass &source)
SgAsmLESectionTableEntry *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
unsigned	get_flags () const
void	set_flags (unsigned flags)
unsigned	get_pagemap_index () const
void	set_pagemap_index (unsigned pagemap_index)
unsigned	get_pagemap_nentries () const
void	set_pagemap_nentries (unsigned pagemap_nentries)
unsigned	get_res1 () const
void	set_res1 (unsigned res1)
rose_addr_t	get_mapped_size () const
void	set_mapped_size (rose_addr_t mapped_size)
rose_addr_t	get_base_addr () const
void	set_base_addr (rose_addr_t base_addr)
virtual	~SgAsmLESectionTableEntry ()
	SgAsmLESectionTableEntry ()
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.
Public Attributes
SgAsmLESectionTableEntry::LESectionTableEntry_disk	packed
Protected Attributes
unsigned	p_flags
unsigned	p_pagemap_index
unsigned	p_pagemap_nentries
unsigned	p_res1
rose_addr_t	p_mapped_size
rose_addr_t	p_base_addr
Private Member Functions
void	ctor (SgAsmExecutableFileFormat::ByteOrder, const SgAsmLESectionTableEntry::LESectionTableEntry_disk *)
Friends
class	AST_FILE_IO
class	SgAsmLESectionTableEntryStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAsmLESectionTableEntry *	isSgAsmLESectionTableEntry (SgNode *s)
	Casts pointer from base class to derived class.
const SgAsmLESectionTableEntry *	isSgAsmLESectionTableEntry (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAsmLESectionTableEntry *	SgAsmLESectionTableEntry_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	SgAsmLESectionTableEntry_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAsmLESectionTableEntry_clearMemoryPool ()
void	SgAsmLESectionTableEntry_extendMemoryPoolForFileIO (unsigned long)
void	SgAsmLESectionTableEntry_getNextValidPointer (std::pair< SgAsmLESectionTableEntry , std::vector< unsigned char >::const_iterator > &)
void	SgAsmLESectionTableEntry_resetValidFreepointers ()
Classes
struct	LESectionTableEntry_disk

Member Typedef Documentation

typedef SgAsmExecutableFileFormat SgAsmLESectionTableEntry::base_node_type

Reimplemented from SgAsmExecutableFileFormat.

Member Enumeration Documentation

enum SgAsmLESectionTableEntry::LESectionFlags

Enumerator:

SF_RESERVED
SF_READABLE	Read permission granted when mapped.
SF_WRITABLE	Write permission granted when mapped.
SF_EXECUTABLE	Execute permission granted when mapped.
SF_RESOURCE	Section contains resource objects.
SF_DISCARDABLE	Discardable section.
SF_SHARED	Section is shared.
SF_PRELOAD_PAGES	Section has preload pages.
SF_INVALID_PAGES	Section has invalid pages.
SF_TYPE_MASK
SF_TYPE_NORMAL
SF_TYPE_ZERO	Section has zero-filled pages.
SF_TYPE_RESIDENT	Section is resident (valid for VDDs and PDDs only).
SF_TYPE_RESCONT	Section is resident and contiguous.
SF_RES_LONG_LOCK	Section is resident and "long-lockable" (VDDs and PDDs only).
SF_1616_ALIAS	16:16 alias required (80x86 specific)
SF_BIG_BIT	Big/default bit setting (80x86 specific); see note above.
SF_CODE_CONFORM	Section is conforming for code (80x86 specific).
SF_IO_PRIV	Section I/O privilege level (80x86 specific; used only for 16:16 alias objects).

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgAsmLESectionTableEntry::SgAsmLESectionTableEntry	(	SgAsmExecutableFileFormat::ByteOrder	sex,
		const SgAsmLESectionTableEntry::LESectionTableEntry_disk *	disk
	)

SgAsmLESectionTableEntry::SgAsmLESectionTableEntry ( const SgAsmLESectionTableEntryStorageClass & source )

virtual SgAsmLESectionTableEntry::~SgAsmLESectionTableEntry ( ) [virtual]

SgAsmLESectionTableEntry::SgAsmLESectionTableEntry ( )

Member Function Documentation

virtual SgNode* SgAsmLESectionTableEntry::copy ( SgCopyHelp & help ) const [virtual]

Reimplemented from SgAsmExecutableFileFormat.

void* SgAsmLESectionTableEntry::encode	(	SgAsmExecutableFileFormat::ByteOrder	,
		SgAsmLESectionTableEntry::LESectionTableEntry_disk *
	)			const

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

void SgAsmLESectionTableEntry::ctor	(	SgAsmExecutableFileFormat::ByteOrder	,
		const SgAsmLESectionTableEntry::LESectionTableEntry_disk *
	)			`[private]`

virtual std::string SgAsmLESectionTableEntry::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 SgAsmLESectionTableEntry::variantT ( ) const [virtual]

returns new style SageIII enum values

Reimplemented from SgAsmExecutableFileFormat.

void* SgAsmLESectionTableEntry::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgAsmExecutableFileFormat.

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

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

Reimplemented from SgAsmExecutableFileFormat.

void SgAsmLESectionTableEntry::operator delete ( void * pointer )

Reimplemented from SgAsmExecutableFileFormat.

static size_t SgAsmLESectionTableEntry::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmExecutableFileFormat.

static size_t SgAsmLESectionTableEntry::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*> SgAsmLESectionTableEntry::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> SgAsmLESectionTableEntry::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 SgAsmLESectionTableEntry::get_numberOfTraversalSuccessors ( ) [virtual]

Reimplemented from SgAsmExecutableFileFormat.

virtual SgNode* SgAsmLESectionTableEntry::get_traversalSuccessorByIndex ( size_t idx ) [virtual]

Reimplemented from SgAsmExecutableFileFormat.

virtual size_t SgAsmLESectionTableEntry::get_childIndex ( SgNode * child ) [virtual]

Reimplemented from SgAsmExecutableFileFormat.

virtual RTIReturnType SgAsmLESectionTableEntry::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* SgAsmLESectionTableEntry::sage_class_name ( ) const [virtual]

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

Reimplemented from SgAsmExecutableFileFormat.

void SgAsmLESectionTableEntry::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

virtual void SgAsmLESectionTableEntry::accept ( ROSE_VisitorPattern & visitor ) [virtual]

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

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmLESectionTableEntry::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmLESectionTableEntry::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmLESectionTableEntry::visitRepresentativeNode ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmExecutableFileFormat.

virtual bool SgAsmLESectionTableEntry::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 SgAsmLESectionTableEntry::checkDataMemberPointersIfInMemoryPool ( ) [virtual]

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

Reimplemented from SgAsmExecutableFileFormat.

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

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

unsigned SgAsmLESectionTableEntry::get_flags ( ) const

void SgAsmLESectionTableEntry::set_flags ( unsigned flags )

unsigned SgAsmLESectionTableEntry::get_pagemap_index ( ) const

void SgAsmLESectionTableEntry::set_pagemap_index ( unsigned pagemap_index )

unsigned SgAsmLESectionTableEntry::get_pagemap_nentries ( ) const

void SgAsmLESectionTableEntry::set_pagemap_nentries ( unsigned pagemap_nentries )

unsigned SgAsmLESectionTableEntry::get_res1 ( ) const

void SgAsmLESectionTableEntry::set_res1 ( unsigned res1 )

rose_addr_t SgAsmLESectionTableEntry::get_mapped_size ( ) const

void SgAsmLESectionTableEntry::set_mapped_size ( rose_addr_t mapped_size )

rose_addr_t SgAsmLESectionTableEntry::get_base_addr ( ) const

void SgAsmLESectionTableEntry::set_base_addr ( rose_addr_t base_addr )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmExecutableFileFormat.

friend class SgAsmLESectionTableEntryStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmExecutableFileFormat.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmExecutableFileFormat.

SgAsmLESectionTableEntry* isSgAsmLESectionTableEntry ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

const SgAsmLESectionTableEntry* isSgAsmLESectionTableEntry ( const SgNode * s ) [friend]

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

SgAsmLESectionTableEntry* SgAsmLESectionTableEntry_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 SgAsmLESectionTableEntry_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 SgAsmLESectionTableEntry_clearMemoryPool ( ) [friend]

void SgAsmLESectionTableEntry_extendMemoryPoolForFileIO ( unsigned long ) [friend]

void SgAsmLESectionTableEntry_getNextValidPointer ( std::pair< SgAsmLESectionTableEntry *, std::vector< unsigned char * >::const_iterator > & ) [friend]