SgAsmLEFileHeader Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmLEFileHeader:

[legend]Collaboration diagram for SgAsmLEFileHeader:


Public Types
typedef SgAsmGenericHeader	base_node_type
	HF_RESERVED = 0xbffc5ccb
	HF_PROC_LIB_INIT = 0x00000004
	HF_IFIXUPS_APPLIED = 0x00000010
	HF_EFIXUPS_APPLIED = 0x00000020
	HF_PM_WINDOW_NO = 0x00000100
	HF_PM_WINDOW_OK = 0x00000200
	HF_PM_WINDOW_USE = 0x00000300
	HF_NOT_LOADABLE = 0x00002000
	HF_PROC_LIB_TERM = 0x40000000
	HF_MODTYPE_MASK = 0x00038000
	HF_MODTYPE_PROG = 0x00000000
	HF_MODTYPE_LIB = 0x00008000
	HF_MODTYPE_PLIB = 0x00018000
	HF_MODTYPE_PDEV = 0x00020000
	HF_MODTYPE_VDEV = 0x00028000
	static_variant = V_SgAsmLEFileHeader
enum	LEFileHeaderFlags { HF_RESERVED = 0xbffc5ccb, HF_PROC_LIB_INIT = 0x00000004, HF_IFIXUPS_APPLIED = 0x00000010, HF_EFIXUPS_APPLIED = 0x00000020, HF_PM_WINDOW_NO = 0x00000100, HF_PM_WINDOW_OK = 0x00000200, HF_PM_WINDOW_USE = 0x00000300, HF_NOT_LOADABLE = 0x00002000, HF_PROC_LIB_TERM = 0x40000000, HF_MODTYPE_MASK = 0x00038000, HF_MODTYPE_PROG = 0x00000000, HF_MODTYPE_LIB = 0x00008000, HF_MODTYPE_PLIB = 0x00018000, HF_MODTYPE_PDEV = 0x00020000, HF_MODTYPE_VDEV = 0x00028000 }
enum	{ static_variant = V_SgAsmLEFileHeader }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
const char *	format_name () const
	SgAsmLEFileHeader (SgAsmGenericFile *f, rose_addr_t offset)
virtual void	unparse (std::ostream &) const
	Unparse headers and all they point to.
virtual void	dump (FILE , 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.
	SgAsmLEFileHeader (const SgAsmLEFileHeaderStorageClass &source)
SgAsmLEFileHeader *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
unsigned	get_e_byte_order () const
void	set_e_byte_order (unsigned e_byte_order)
unsigned	get_e_word_order () const
void	set_e_word_order (unsigned e_word_order)
unsigned	get_e_format_level () const
void	set_e_format_level (unsigned e_format_level)
unsigned	get_e_cpu_type () const
void	set_e_cpu_type (unsigned e_cpu_type)
unsigned	get_e_os_type () const
void	set_e_os_type (unsigned e_os_type)
unsigned	get_e_module_version () const
void	set_e_module_version (unsigned e_module_version)
unsigned	get_e_flags () const
void	set_e_flags (unsigned e_flags)
unsigned	get_e_eip_section () const
void	set_e_eip_section (unsigned e_eip_section)
unsigned	get_e_esp_section () const
void	set_e_esp_section (unsigned e_esp_section)
unsigned	get_e_last_page_size () const
void	set_e_last_page_size (unsigned e_last_page_size)
unsigned	get_e_page_offset_shift () const
void	set_e_page_offset_shift (unsigned e_page_offset_shift)
unsigned	get_e_fixup_sect_cksum () const
void	set_e_fixup_sect_cksum (unsigned e_fixup_sect_cksum)
unsigned	get_e_loader_sect_cksum () const
void	set_e_loader_sect_cksum (unsigned e_loader_sect_cksum)
unsigned	get_e_secttab_nentries () const
void	set_e_secttab_nentries (unsigned e_secttab_nentries)
unsigned	get_e_rsrctab_nentries () const
void	set_e_rsrctab_nentries (unsigned e_rsrctab_nentries)
unsigned	get_e_fmtdirtab_nentries () const
void	set_e_fmtdirtab_nentries (unsigned e_fmtdirtab_nentries)
unsigned	get_e_import_modtab_nentries () const
void	set_e_import_modtab_nentries (unsigned e_import_modtab_nentries)
unsigned	get_e_preload_npages () const
void	set_e_preload_npages (unsigned e_preload_npages)
unsigned	get_e_nonresnametab_size () const
void	set_e_nonresnametab_size (unsigned e_nonresnametab_size)
unsigned	get_e_nonresnametab_cksum () const
void	set_e_nonresnametab_cksum (unsigned e_nonresnametab_cksum)
unsigned	get_e_auto_ds_section () const
void	set_e_auto_ds_section (unsigned e_auto_ds_section)
unsigned	get_e_debug_info_size () const
void	set_e_debug_info_size (unsigned e_debug_info_size)
unsigned	get_e_num_instance_preload () const
void	set_e_num_instance_preload (unsigned e_num_instance_preload)
unsigned	get_e_num_instance_demand () const
void	set_e_num_instance_demand (unsigned e_num_instance_demand)
unsigned	get_e_heap_size () const
void	set_e_heap_size (unsigned e_heap_size)
rose_addr_t	get_e_npages () const
void	set_e_npages (rose_addr_t e_npages)
rose_addr_t	get_e_eip () const
void	set_e_eip (rose_addr_t e_eip)
rose_addr_t	get_e_esp () const
void	set_e_esp (rose_addr_t e_esp)
rose_addr_t	get_e_page_size () const
void	set_e_page_size (rose_addr_t e_page_size)
rose_addr_t	get_e_fixup_sect_size () const
void	set_e_fixup_sect_size (rose_addr_t e_fixup_sect_size)
rose_addr_t	get_e_loader_sect_size () const
void	set_e_loader_sect_size (rose_addr_t e_loader_sect_size)
rose_addr_t	get_e_secttab_rfo () const
void	set_e_secttab_rfo (rose_addr_t e_secttab_rfo)
rose_addr_t	get_e_pagetab_rfo () const
void	set_e_pagetab_rfo (rose_addr_t e_pagetab_rfo)
rose_addr_t	get_e_iterpages_offset () const
void	set_e_iterpages_offset (rose_addr_t e_iterpages_offset)
rose_addr_t	get_e_rsrctab_rfo () const
void	set_e_rsrctab_rfo (rose_addr_t e_rsrctab_rfo)
rose_addr_t	get_e_resnametab_rfo () const
void	set_e_resnametab_rfo (rose_addr_t e_resnametab_rfo)
rose_addr_t	get_e_entrytab_rfo () const
void	set_e_entrytab_rfo (rose_addr_t e_entrytab_rfo)
rose_addr_t	get_e_fmtdirtab_rfo () const
void	set_e_fmtdirtab_rfo (rose_addr_t e_fmtdirtab_rfo)
rose_addr_t	get_e_fixup_pagetab_rfo () const
void	set_e_fixup_pagetab_rfo (rose_addr_t e_fixup_pagetab_rfo)
rose_addr_t	get_e_fixup_rectab_rfo () const
void	set_e_fixup_rectab_rfo (rose_addr_t e_fixup_rectab_rfo)
rose_addr_t	get_e_import_modtab_rfo () const
void	set_e_import_modtab_rfo (rose_addr_t e_import_modtab_rfo)
rose_addr_t	get_e_import_proctab_rfo () const
void	set_e_import_proctab_rfo (rose_addr_t e_import_proctab_rfo)
rose_addr_t	get_e_ppcksumtab_rfo () const
void	set_e_ppcksumtab_rfo (rose_addr_t e_ppcksumtab_rfo)
rose_addr_t	get_e_data_pages_offset () const
void	set_e_data_pages_offset (rose_addr_t e_data_pages_offset)
rose_addr_t	get_e_nonresnametab_offset () const
void	set_e_nonresnametab_offset (rose_addr_t e_nonresnametab_offset)
rose_addr_t	get_e_debug_info_rfo () const
void	set_e_debug_info_rfo (rose_addr_t e_debug_info_rfo)
SgAsmDOSExtendedHeader *	get_dos2_header () const
void	set_dos2_header (SgAsmDOSExtendedHeader *dos2_header)
SgAsmLESectionTable *	get_section_table () const
void	set_section_table (SgAsmLESectionTable *section_table)
SgAsmLEPageTable *	get_page_table () const
void	set_page_table (SgAsmLEPageTable *page_table)
SgAsmLENameTable *	get_resname_table () const
void	set_resname_table (SgAsmLENameTable *resname_table)
SgAsmLENameTable *	get_nonresname_table () const
void	set_nonresname_table (SgAsmLENameTable *nonresname_table)
SgAsmLEEntryTable *	get_entry_table () const
void	set_entry_table (SgAsmLEEntryTable *entry_table)
SgAsmLERelocTable *	get_reloc_table () const
void	set_reloc_table (SgAsmLERelocTable *reloc_table)
virtual	~SgAsmLEFileHeader ()
	SgAsmLEFileHeader ()
Static Public Member Functions
static bool	is_LE (SgAsmGenericFile *)
	Return true if the file looks like it might be an LE or LX file according to the magic number.
static SgAsmLEFileHeader *	parse (SgAsmDOSFileHeader *)
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
SgAsmLEFileHeader::LEFileHeader_disk	packed
Protected Attributes
unsigned	p_e_byte_order
unsigned	p_e_word_order
unsigned	p_e_format_level
unsigned	p_e_cpu_type
unsigned	p_e_os_type
unsigned	p_e_module_version
unsigned	p_e_flags
unsigned	p_e_eip_section
unsigned	p_e_esp_section
unsigned	p_e_last_page_size
unsigned	p_e_page_offset_shift
unsigned	p_e_fixup_sect_cksum
unsigned	p_e_loader_sect_cksum
unsigned	p_e_secttab_nentries
unsigned	p_e_rsrctab_nentries
unsigned	p_e_fmtdirtab_nentries
unsigned	p_e_import_modtab_nentries
unsigned	p_e_preload_npages
unsigned	p_e_nonresnametab_size
unsigned	p_e_nonresnametab_cksum
unsigned	p_e_auto_ds_section
unsigned	p_e_debug_info_size
unsigned	p_e_num_instance_preload
unsigned	p_e_num_instance_demand
unsigned	p_e_heap_size
rose_addr_t	p_e_npages
rose_addr_t	p_e_eip
rose_addr_t	p_e_esp
rose_addr_t	p_e_page_size
rose_addr_t	p_e_fixup_sect_size
rose_addr_t	p_e_loader_sect_size
rose_addr_t	p_e_secttab_rfo
rose_addr_t	p_e_pagetab_rfo
rose_addr_t	p_e_iterpages_offset
rose_addr_t	p_e_rsrctab_rfo
rose_addr_t	p_e_resnametab_rfo
rose_addr_t	p_e_entrytab_rfo
rose_addr_t	p_e_fmtdirtab_rfo
rose_addr_t	p_e_fixup_pagetab_rfo
rose_addr_t	p_e_fixup_rectab_rfo
rose_addr_t	p_e_import_modtab_rfo
rose_addr_t	p_e_import_proctab_rfo
rose_addr_t	p_e_ppcksumtab_rfo
rose_addr_t	p_e_data_pages_offset
rose_addr_t	p_e_nonresnametab_offset
rose_addr_t	p_e_debug_info_rfo
SgAsmDOSExtendedHeader *	p_dos2_header
SgAsmLESectionTable *	p_section_table
SgAsmLEPageTable *	p_page_table
SgAsmLENameTable *	p_resname_table
SgAsmLENameTable *	p_nonresname_table
SgAsmLEEntryTable *	p_entry_table
SgAsmLERelocTable *	p_reloc_table
Private Member Functions
void	ctor (SgAsmGenericFile *f, rose_addr_t offset)
void *	encode (SgAsmExecutableFileFormat::ByteOrder sex, SgAsmLEFileHeader::LEFileHeader_disk *) const
Friends
class	AST_FILE_IO
class	SgAsmLEFileHeaderStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAsmLEFileHeader *	isSgAsmLEFileHeader (SgNode *s)
	Casts pointer from base class to derived class.
const SgAsmLEFileHeader *	isSgAsmLEFileHeader (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAsmLEFileHeader *	SgAsmLEFileHeader_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	SgAsmLEFileHeader_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAsmLEFileHeader_clearMemoryPool ()
void	SgAsmLEFileHeader_extendMemoryPoolForFileIO (unsigned long)
void	SgAsmLEFileHeader_getNextValidPointer (std::pair< SgAsmLEFileHeader , std::vector< unsigned char >::const_iterator > &)
void	SgAsmLEFileHeader_resetValidFreepointers ()
Classes
struct	LEFileHeader_disk

Member Typedef Documentation

typedef SgAsmGenericHeader SgAsmLEFileHeader::base_node_type

Reimplemented from SgAsmGenericHeader.

Member Enumeration Documentation

enum SgAsmLEFileHeader::LEFileHeaderFlags

Enumerator:

HF_RESERVED
HF_PROC_LIB_INIT
HF_IFIXUPS_APPLIED
HF_EFIXUPS_APPLIED
HF_PM_WINDOW_NO
HF_PM_WINDOW_OK
HF_PM_WINDOW_USE
HF_NOT_LOADABLE
HF_PROC_LIB_TERM
HF_MODTYPE_MASK
HF_MODTYPE_PROG
HF_MODTYPE_LIB
HF_MODTYPE_PLIB
HF_MODTYPE_PDEV
HF_MODTYPE_VDEV

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgAsmLEFileHeader::SgAsmLEFileHeader	(	SgAsmGenericFile *	f,
		rose_addr_t	offset
	)			`[inline]`

SgAsmLEFileHeader::SgAsmLEFileHeader ( const SgAsmLEFileHeaderStorageClass & source )

virtual SgAsmLEFileHeader::~SgAsmLEFileHeader ( ) [virtual]

SgAsmLEFileHeader::SgAsmLEFileHeader ( )

Member Function Documentation

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

Reimplemented from SgAsmGenericHeader.

const char * SgAsmLEFileHeader::format_name ( ) const [virtual]

Reimplemented from SgAsmGenericHeader.

bool SgAsmLEFileHeader::is_LE ( SgAsmGenericFile * file ) [static]

Return true if the file looks like it might be an LE or LX file according to the magic number.

The file must contain what appears to be a DOS File Header at address zero, and what appears to be an LE or LX File Header at a file offset specified in part of the DOS File Header (actually, in the bytes that follow the DOS File Header).

SgAsmLEFileHeader * SgAsmLEFileHeader::parse ( SgAsmDOSFileHeader * ) [static]

void SgAsmLEFileHeader::unparse ( std::ostream & ) const [virtual]

Unparse headers and all they point to.

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

void SgAsmLEFileHeader::ctor	(	SgAsmGenericFile *	f,
		rose_addr_t	offset
	)			`[private]`

void* SgAsmLEFileHeader::encode	(	SgAsmExecutableFileFormat::ByteOrder	sex,
		SgAsmLEFileHeader::LEFileHeader_disk *
	)			const `[private]`

virtual std::string SgAsmLEFileHeader::class_name ( ) const [virtual]

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

Reimplemented from SgAsmGenericHeader.

virtual VariantT SgAsmLEFileHeader::variantT ( ) const [virtual]

returns new style SageIII enum values

Reimplemented from SgAsmGenericHeader.

void* SgAsmLEFileHeader::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

void SgAsmLEFileHeader::operator delete ( void * pointer )

Reimplemented from SgAsmGenericHeader.

static size_t SgAsmLEFileHeader::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmGenericHeader.

static size_t SgAsmLEFileHeader::memoryUsage ( ) [static]

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

Reimplemented from SgAsmGenericHeader.

virtual std::vector<SgNode*> SgAsmLEFileHeader::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 SgAsmGenericHeader.

virtual std::vector<std::string> SgAsmLEFileHeader::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 SgAsmGenericHeader.

virtual size_t SgAsmLEFileHeader::get_numberOfTraversalSuccessors ( ) [virtual]

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

virtual RTIReturnType SgAsmLEFileHeader::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 SgAsmGenericHeader.

virtual const char* SgAsmLEFileHeader::sage_class_name ( ) const [virtual]

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

Reimplemented from SgAsmGenericHeader.

void SgAsmLEFileHeader::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmGenericHeader.

virtual bool SgAsmLEFileHeader::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 SgAsmGenericHeader.

virtual void SgAsmLEFileHeader::checkDataMemberPointersIfInMemoryPool ( ) [virtual]

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

Reimplemented from SgAsmGenericHeader.

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

virtual void SgAsmLEFileHeader::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 SgAsmGenericHeader.

virtual long SgAsmLEFileHeader::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 SgAsmGenericHeader.

SgAsmLEFileHeader* SgAsmLEFileHeader::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 SgAsmGenericHeader.

unsigned SgAsmLEFileHeader::get_e_byte_order ( ) const

void SgAsmLEFileHeader::set_e_byte_order ( unsigned e_byte_order )

unsigned SgAsmLEFileHeader::get_e_word_order ( ) const

void SgAsmLEFileHeader::set_e_word_order ( unsigned e_word_order )

unsigned SgAsmLEFileHeader::get_e_format_level ( ) const

void SgAsmLEFileHeader::set_e_format_level ( unsigned e_format_level )

unsigned SgAsmLEFileHeader::get_e_cpu_type ( ) const

void SgAsmLEFileHeader::set_e_cpu_type ( unsigned e_cpu_type )

unsigned SgAsmLEFileHeader::get_e_os_type ( ) const

void SgAsmLEFileHeader::set_e_os_type ( unsigned e_os_type )

unsigned SgAsmLEFileHeader::get_e_module_version ( ) const

void SgAsmLEFileHeader::set_e_module_version ( unsigned e_module_version )

unsigned SgAsmLEFileHeader::get_e_flags ( ) const

void SgAsmLEFileHeader::set_e_flags ( unsigned e_flags )

unsigned SgAsmLEFileHeader::get_e_eip_section ( ) const

void SgAsmLEFileHeader::set_e_eip_section ( unsigned e_eip_section )

unsigned SgAsmLEFileHeader::get_e_esp_section ( ) const

void SgAsmLEFileHeader::set_e_esp_section ( unsigned e_esp_section )

unsigned SgAsmLEFileHeader::get_e_last_page_size ( ) const

void SgAsmLEFileHeader::set_e_last_page_size ( unsigned e_last_page_size )

unsigned SgAsmLEFileHeader::get_e_page_offset_shift ( ) const

void SgAsmLEFileHeader::set_e_page_offset_shift ( unsigned e_page_offset_shift )

unsigned SgAsmLEFileHeader::get_e_fixup_sect_cksum ( ) const

void SgAsmLEFileHeader::set_e_fixup_sect_cksum ( unsigned e_fixup_sect_cksum )

unsigned SgAsmLEFileHeader::get_e_loader_sect_cksum ( ) const

void SgAsmLEFileHeader::set_e_loader_sect_cksum ( unsigned e_loader_sect_cksum )

unsigned SgAsmLEFileHeader::get_e_secttab_nentries ( ) const

void SgAsmLEFileHeader::set_e_secttab_nentries ( unsigned e_secttab_nentries )

unsigned SgAsmLEFileHeader::get_e_rsrctab_nentries ( ) const

void SgAsmLEFileHeader::set_e_rsrctab_nentries ( unsigned e_rsrctab_nentries )

unsigned SgAsmLEFileHeader::get_e_fmtdirtab_nentries ( ) const

void SgAsmLEFileHeader::set_e_fmtdirtab_nentries ( unsigned e_fmtdirtab_nentries )

unsigned SgAsmLEFileHeader::get_e_import_modtab_nentries ( ) const

void SgAsmLEFileHeader::set_e_import_modtab_nentries ( unsigned e_import_modtab_nentries )

unsigned SgAsmLEFileHeader::get_e_preload_npages ( ) const

void SgAsmLEFileHeader::set_e_preload_npages ( unsigned e_preload_npages )

unsigned SgAsmLEFileHeader::get_e_nonresnametab_size ( ) const

void SgAsmLEFileHeader::set_e_nonresnametab_size ( unsigned e_nonresnametab_size )

unsigned SgAsmLEFileHeader::get_e_nonresnametab_cksum ( ) const

void SgAsmLEFileHeader::set_e_nonresnametab_cksum ( unsigned e_nonresnametab_cksum )

unsigned SgAsmLEFileHeader::get_e_auto_ds_section ( ) const

void SgAsmLEFileHeader::set_e_auto_ds_section ( unsigned e_auto_ds_section )

unsigned SgAsmLEFileHeader::get_e_debug_info_size ( ) const

void SgAsmLEFileHeader::set_e_debug_info_size ( unsigned e_debug_info_size )

unsigned SgAsmLEFileHeader::get_e_num_instance_preload ( ) const

void SgAsmLEFileHeader::set_e_num_instance_preload ( unsigned e_num_instance_preload )

unsigned SgAsmLEFileHeader::get_e_num_instance_demand ( ) const

void SgAsmLEFileHeader::set_e_num_instance_demand ( unsigned e_num_instance_demand )

unsigned SgAsmLEFileHeader::get_e_heap_size ( ) const

void SgAsmLEFileHeader::set_e_heap_size ( unsigned e_heap_size )

rose_addr_t SgAsmLEFileHeader::get_e_npages ( ) const

void SgAsmLEFileHeader::set_e_npages ( rose_addr_t e_npages )

rose_addr_t SgAsmLEFileHeader::get_e_eip ( ) const

void SgAsmLEFileHeader::set_e_eip ( rose_addr_t e_eip )

rose_addr_t SgAsmLEFileHeader::get_e_esp ( ) const

void SgAsmLEFileHeader::set_e_esp ( rose_addr_t e_esp )

rose_addr_t SgAsmLEFileHeader::get_e_page_size ( ) const

void SgAsmLEFileHeader::set_e_page_size ( rose_addr_t e_page_size )

rose_addr_t SgAsmLEFileHeader::get_e_fixup_sect_size ( ) const

void SgAsmLEFileHeader::set_e_fixup_sect_size ( rose_addr_t e_fixup_sect_size )

rose_addr_t SgAsmLEFileHeader::get_e_loader_sect_size ( ) const

void SgAsmLEFileHeader::set_e_loader_sect_size ( rose_addr_t e_loader_sect_size )

rose_addr_t SgAsmLEFileHeader::get_e_secttab_rfo ( ) const

void SgAsmLEFileHeader::set_e_secttab_rfo ( rose_addr_t e_secttab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_pagetab_rfo ( ) const

void SgAsmLEFileHeader::set_e_pagetab_rfo ( rose_addr_t e_pagetab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_iterpages_offset ( ) const

void SgAsmLEFileHeader::set_e_iterpages_offset ( rose_addr_t e_iterpages_offset )

rose_addr_t SgAsmLEFileHeader::get_e_rsrctab_rfo ( ) const

void SgAsmLEFileHeader::set_e_rsrctab_rfo ( rose_addr_t e_rsrctab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_resnametab_rfo ( ) const

void SgAsmLEFileHeader::set_e_resnametab_rfo ( rose_addr_t e_resnametab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_entrytab_rfo ( ) const

void SgAsmLEFileHeader::set_e_entrytab_rfo ( rose_addr_t e_entrytab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_fmtdirtab_rfo ( ) const

void SgAsmLEFileHeader::set_e_fmtdirtab_rfo ( rose_addr_t e_fmtdirtab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_fixup_pagetab_rfo ( ) const

void SgAsmLEFileHeader::set_e_fixup_pagetab_rfo ( rose_addr_t e_fixup_pagetab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_fixup_rectab_rfo ( ) const

void SgAsmLEFileHeader::set_e_fixup_rectab_rfo ( rose_addr_t e_fixup_rectab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_import_modtab_rfo ( ) const

void SgAsmLEFileHeader::set_e_import_modtab_rfo ( rose_addr_t e_import_modtab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_import_proctab_rfo ( ) const

void SgAsmLEFileHeader::set_e_import_proctab_rfo ( rose_addr_t e_import_proctab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_ppcksumtab_rfo ( ) const

void SgAsmLEFileHeader::set_e_ppcksumtab_rfo ( rose_addr_t e_ppcksumtab_rfo )

rose_addr_t SgAsmLEFileHeader::get_e_data_pages_offset ( ) const

void SgAsmLEFileHeader::set_e_data_pages_offset ( rose_addr_t e_data_pages_offset )

rose_addr_t SgAsmLEFileHeader::get_e_nonresnametab_offset ( ) const

void SgAsmLEFileHeader::set_e_nonresnametab_offset ( rose_addr_t e_nonresnametab_offset )

rose_addr_t SgAsmLEFileHeader::get_e_debug_info_rfo ( ) const

void SgAsmLEFileHeader::set_e_debug_info_rfo ( rose_addr_t e_debug_info_rfo )

SgAsmDOSExtendedHeader* SgAsmLEFileHeader::get_dos2_header ( ) const

void SgAsmLEFileHeader::set_dos2_header ( SgAsmDOSExtendedHeader * dos2_header )

SgAsmLESectionTable* SgAsmLEFileHeader::get_section_table ( ) const

void SgAsmLEFileHeader::set_section_table ( SgAsmLESectionTable * section_table )

SgAsmLEPageTable* SgAsmLEFileHeader::get_page_table ( ) const

void SgAsmLEFileHeader::set_page_table ( SgAsmLEPageTable * page_table )

SgAsmLENameTable* SgAsmLEFileHeader::get_resname_table ( ) const

void SgAsmLEFileHeader::set_resname_table ( SgAsmLENameTable * resname_table )

SgAsmLENameTable* SgAsmLEFileHeader::get_nonresname_table ( ) const

void SgAsmLEFileHeader::set_nonresname_table ( SgAsmLENameTable * nonresname_table )

SgAsmLEEntryTable* SgAsmLEFileHeader::get_entry_table ( ) const

void SgAsmLEFileHeader::set_entry_table ( SgAsmLEEntryTable * entry_table )

SgAsmLERelocTable* SgAsmLEFileHeader::get_reloc_table ( ) const

void SgAsmLEFileHeader::set_reloc_table ( SgAsmLERelocTable * reloc_table )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmGenericHeader.

friend class SgAsmLEFileHeaderStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmGenericHeader.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmGenericHeader.

SgAsmLEFileHeader* isSgAsmLEFileHeader ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

const SgAsmLEFileHeader* isSgAsmLEFileHeader ( const SgNode * s ) [friend]

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

SgAsmLEFileHeader* SgAsmLEFileHeader_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 SgAsmLEFileHeader_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 SgAsmLEFileHeader_clearMemoryPool ( ) [friend]