SgAsmPEFileHeader Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmPEFileHeader:

[legend]Collaboration diagram for SgAsmPEFileHeader:


Public Types
typedef SgAsmGenericHeader	base_node_type
	HF_PROGRAM = 0x0000
	HF_EXECUTABLE = 0x0002
	HF_FIXED = 0x0200
	HF_LIBRARY = 0x2000
	HF_RESERVED_MASK = 0xddfd
	HF_SPEC_UNKNOWN = 0x0000
	HF_NATIVE = 0x0001
	HF_WINGUI = 0x0002
	HF_WINCHAR = 0x0003
	HF_OS2CHAR = 0x0005
	HF_POSIX = 0x0007
	DLL_PROC_INIT = 0x0001
	DLL_PROC_TERM = 0x0002
	DLL_THRD_INIT = 0x0004
	DLL_THRD_TERM = 0x0008
	DLL_RESERVED_MASK = 0xfff0
	PAIR_EXPORTS = 0
	PAIR_IMPORTS = 1
	PAIR_RESOURCES = 2
	PAIR_EXCEPTIONS = 3
	PAIR_CERTIFICATES = 4
	PAIR_BASERELOCS = 5
	PAIR_DEBUG = 6
	PAIR_ARCHITECTURE = 7
	PAIR_GLOBALPTR = 8
	PAIR_TLS = 9
	PAIR_LOADCONFIG = 10
	PAIR_BOUNDIMPORT = 11
	PAIR_IAT = 12
	PAIR_DELAYIMPORT = 13
	PAIR_CLRRUNTIME = 14
	PAIR_RESERVED15 = 15
	static_variant = V_SgAsmPEFileHeader
enum	HeaderFlags { HF_PROGRAM = 0x0000, HF_EXECUTABLE = 0x0002, HF_FIXED = 0x0200, HF_LIBRARY = 0x2000, HF_RESERVED_MASK = 0xddfd }
enum	Subsystem { HF_SPEC_UNKNOWN = 0x0000, HF_NATIVE = 0x0001, HF_WINGUI = 0x0002, HF_WINCHAR = 0x0003, HF_OS2CHAR = 0x0005, HF_POSIX = 0x0007 }
enum	DLLFlags { DLL_PROC_INIT = 0x0001, DLL_PROC_TERM = 0x0002, DLL_THRD_INIT = 0x0004, DLL_THRD_TERM = 0x0008, DLL_RESERVED_MASK = 0xfff0 }
enum	PairPurpose { PAIR_EXPORTS = 0, PAIR_IMPORTS = 1, PAIR_RESOURCES = 2, PAIR_EXCEPTIONS = 3, PAIR_CERTIFICATES = 4, PAIR_BASERELOCS = 5, PAIR_DEBUG = 6, PAIR_ARCHITECTURE = 7, PAIR_GLOBALPTR = 8, PAIR_TLS = 9, PAIR_LOADCONFIG = 10, PAIR_BOUNDIMPORT = 11, PAIR_IAT = 12, PAIR_DELAYIMPORT = 13, PAIR_CLRRUNTIME = 14, PAIR_RESERVED15 = 15 }
	Reason for each rva/size pair in the PE header. More...
enum	{ static_variant = V_SgAsmPEFileHeader }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgAsmPEFileHeader (SgAsmGenericFile *f)
virtual	~SgAsmPEFileHeader ()
virtual const char *	format_name () const
std::string	rvasize_pair_name (PairPurpose)
	Convert an RVA/Size Pair index number into a section name.
void	set_rvasize_pair (PairPurpose, SgAsmPESection *)
	Define an RVA/Size pair in the PE file header.
void	update_rvasize_pairs ()
	Update all the RVA/Size pair info from the section to which it points.
void	add_rvasize_pairs ()
virtual SgAsmPEFileHeader *	parse ()
	Initialize the header with information parsed from the file and construct and parse everything that's reachable from the header.
virtual bool	reallocate ()
	Allow all sections to reallocate themselves.
virtual void	unparse (std::ostream &) const
	Unparse headers and all they point to.
virtual void	dump (FILE , const char prefix, ssize_t idx) const
void	create_table_sections ()
MemoryMap *	get_loader_map () const
void	set_loader_map (MemoryMap *map)
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.
	SgAsmPEFileHeader (const SgAsmPEFileHeaderStorageClass &source)
SgAsmPEFileHeader *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
unsigned	get_e_cpu_type () const
void	set_e_cpu_type (unsigned e_cpu_type)
unsigned	get_e_nsections () const
void	set_e_nsections (unsigned e_nsections)
unsigned	get_e_time () const
void	set_e_time (unsigned e_time)
rose_addr_t	get_e_coff_symtab () const
void	set_e_coff_symtab (rose_addr_t e_coff_symtab)
rose_addr_t	get_e_nt_hdr_size () const
void	set_e_nt_hdr_size (rose_addr_t e_nt_hdr_size)
unsigned	get_e_coff_nsyms () const
void	set_e_coff_nsyms (unsigned e_coff_nsyms)
unsigned	get_e_flags () const
void	set_e_flags (unsigned e_flags)
unsigned	get_e_opt_magic () const
void	set_e_opt_magic (unsigned e_opt_magic)
unsigned	get_e_lmajor () const
void	set_e_lmajor (unsigned e_lmajor)
unsigned	get_e_lminor () const
void	set_e_lminor (unsigned e_lminor)
unsigned	get_e_code_size () const
void	set_e_code_size (unsigned e_code_size)
unsigned	get_e_data_size () const
void	set_e_data_size (unsigned e_data_size)
unsigned	get_e_bss_size () const
void	set_e_bss_size (unsigned e_bss_size)
rose_rva_t	get_e_code_rva () const
void	set_e_code_rva (rose_rva_t e_code_rva)
rose_rva_t	get_e_data_rva () const
void	set_e_data_rva (rose_rva_t e_data_rva)
unsigned	get_e_section_align () const
void	set_e_section_align (unsigned e_section_align)
unsigned	get_e_file_align () const
void	set_e_file_align (unsigned e_file_align)
unsigned	get_e_os_major () const
void	set_e_os_major (unsigned e_os_major)
unsigned	get_e_os_minor () const
void	set_e_os_minor (unsigned e_os_minor)
unsigned	get_e_user_major () const
void	set_e_user_major (unsigned e_user_major)
unsigned	get_e_user_minor () const
void	set_e_user_minor (unsigned e_user_minor)
unsigned	get_e_subsys_major () const
void	set_e_subsys_major (unsigned e_subsys_major)
unsigned	get_e_subsys_minor () const
void	set_e_subsys_minor (unsigned e_subsys_minor)
unsigned	get_e_reserved9 () const
void	set_e_reserved9 (unsigned e_reserved9)
unsigned	get_e_image_size () const
void	set_e_image_size (unsigned e_image_size)
unsigned	get_e_header_size () const
void	set_e_header_size (unsigned e_header_size)
unsigned	get_e_file_checksum () const
void	set_e_file_checksum (unsigned e_file_checksum)
unsigned	get_e_subsystem () const
void	set_e_subsystem (unsigned e_subsystem)
unsigned	get_e_dll_flags () const
void	set_e_dll_flags (unsigned e_dll_flags)
unsigned	get_e_stack_reserve_size () const
void	set_e_stack_reserve_size (unsigned e_stack_reserve_size)
unsigned	get_e_stack_commit_size () const
void	set_e_stack_commit_size (unsigned e_stack_commit_size)
unsigned	get_e_heap_reserve_size () const
void	set_e_heap_reserve_size (unsigned e_heap_reserve_size)
unsigned	get_e_heap_commit_size () const
void	set_e_heap_commit_size (unsigned e_heap_commit_size)
unsigned	get_e_loader_flags () const
void	set_e_loader_flags (unsigned e_loader_flags)
unsigned	get_e_num_rvasize_pairs () const
void	set_e_num_rvasize_pairs (unsigned e_num_rvasize_pairs)
SgAsmPERVASizePairList *	get_rvasize_pairs () const
void	set_rvasize_pairs (SgAsmPERVASizePairList *rvasize_pairs)
SgAsmPESectionTable *	get_section_table () const
void	set_section_table (SgAsmPESectionTable *section_table)
SgAsmCoffSymbolTable *	get_coff_symtab () const
void	set_coff_symtab (SgAsmCoffSymbolTable *coff_symtab)
	SgAsmPEFileHeader ()
Static Public Member Functions
static bool	is_PE (SgAsmGenericFile *)
	Return true if the file looks like it might be a PE file according to the magic number.
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
SgAsmPEFileHeader::PEFileHeader_disk	packed
SgAsmPEFileHeader::PE32OptHeader_disk	packed
SgAsmPEFileHeader::PE64OptHeader_disk	packed
Protected Attributes
unsigned	p_e_cpu_type
unsigned	p_e_nsections
unsigned	p_e_time
rose_addr_t	p_e_coff_symtab
rose_addr_t	p_e_nt_hdr_size
unsigned	p_e_coff_nsyms
unsigned	p_e_flags
unsigned	p_e_opt_magic
unsigned	p_e_lmajor
unsigned	p_e_lminor
unsigned	p_e_code_size
unsigned	p_e_data_size
unsigned	p_e_bss_size
rose_rva_t	p_e_code_rva
rose_rva_t	p_e_data_rva
unsigned	p_e_section_align
unsigned	p_e_file_align
unsigned	p_e_os_major
unsigned	p_e_os_minor
unsigned	p_e_user_major
unsigned	p_e_user_minor
unsigned	p_e_subsys_major
unsigned	p_e_subsys_minor
unsigned	p_e_reserved9
unsigned	p_e_image_size
unsigned	p_e_header_size
unsigned	p_e_file_checksum
unsigned	p_e_subsystem
unsigned	p_e_dll_flags
unsigned	p_e_stack_reserve_size
unsigned	p_e_stack_commit_size
unsigned	p_e_heap_reserve_size
unsigned	p_e_heap_commit_size
unsigned	p_e_loader_flags
unsigned	p_e_num_rvasize_pairs
SgAsmPERVASizePairList *	p_rvasize_pairs
SgAsmPESectionTable *	p_section_table
SgAsmCoffSymbolTable *	p_coff_symtab
Private Member Functions
void	ctor ()
	Constructor.
void *	encode (SgAsmPEFileHeader::PEFileHeader_disk *) const
void *	encode (SgAsmPEFileHeader::PE32OptHeader_disk *) const
void *	encode (SgAsmPEFileHeader::PE64OptHeader_disk *) const
Private Attributes
MemoryMap *	p_loader_map
Friends
class	AST_FILE_IO
class	SgAsmPEFileHeaderStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAsmPEFileHeader *	isSgAsmPEFileHeader (SgNode *s)
	Casts pointer from base class to derived class.
const SgAsmPEFileHeader *	isSgAsmPEFileHeader (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAsmPEFileHeader *	SgAsmPEFileHeader_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	SgAsmPEFileHeader_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAsmPEFileHeader_clearMemoryPool ()
void	SgAsmPEFileHeader_extendMemoryPoolForFileIO (unsigned long)
void	SgAsmPEFileHeader_getNextValidPointer (std::pair< SgAsmPEFileHeader , std::vector< unsigned char >::const_iterator > &)
void	SgAsmPEFileHeader_resetValidFreepointers ()
Classes
struct	PE32OptHeader_disk
struct	PE64OptHeader_disk
struct	PEFileHeader_disk

Member Typedef Documentation

typedef SgAsmGenericHeader SgAsmPEFileHeader::base_node_type

Reimplemented from SgAsmGenericHeader.

Member Enumeration Documentation

enum SgAsmPEFileHeader::HeaderFlags

Enumerator:

HF_PROGRAM
HF_EXECUTABLE
HF_FIXED
HF_LIBRARY
HF_RESERVED_MASK

enum SgAsmPEFileHeader::Subsystem

Enumerator:

HF_SPEC_UNKNOWN
HF_NATIVE
HF_WINGUI
HF_WINCHAR
HF_OS2CHAR
HF_POSIX

enum SgAsmPEFileHeader::DLLFlags

Enumerator:

DLL_PROC_INIT
DLL_PROC_TERM
DLL_THRD_INIT
DLL_THRD_TERM
DLL_RESERVED_MASK

enum SgAsmPEFileHeader::PairPurpose

Reason for each rva/size pair in the PE header.

Enumerator:

PAIR_EXPORTS
PAIR_IMPORTS
PAIR_RESOURCES
PAIR_EXCEPTIONS
PAIR_CERTIFICATES
PAIR_BASERELOCS
PAIR_DEBUG
PAIR_ARCHITECTURE
PAIR_GLOBALPTR
PAIR_TLS
PAIR_LOADCONFIG
PAIR_BOUNDIMPORT
PAIR_IAT
PAIR_DELAYIMPORT
PAIR_CLRRUNTIME
PAIR_RESERVED15

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

SgAsmPEFileHeader::SgAsmPEFileHeader ( SgAsmGenericFile * f ) [inline, explicit]

SgAsmPEFileHeader::~SgAsmPEFileHeader ( ) [virtual]

SgAsmPEFileHeader::SgAsmPEFileHeader ( const SgAsmPEFileHeaderStorageClass & source )

SgAsmPEFileHeader::SgAsmPEFileHeader ( )

Member Function Documentation

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

Reimplemented from SgAsmGenericHeader.

virtual const char* SgAsmPEFileHeader::format_name ( ) const [inline, virtual]

Reimplemented from SgAsmGenericHeader.

bool SgAsmPEFileHeader::is_PE ( SgAsmGenericFile * file ) [static]

Return true if the file looks like it might be a PE 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 a PE File Header at a file offset specified in part of the DOS File Header (actually, in the bytes that follow the DOS File Header).

std::string SgAsmPEFileHeader::rvasize_pair_name ( PairPurpose idx )

Convert an RVA/Size Pair index number into a section name.

This is different than stringifySgAsmPEFileHeaderPairPurpose() because it returns a section name rather than an enum name.

void SgAsmPEFileHeader::set_rvasize_pair	(	PairPurpose	,
		SgAsmPESection *
	)

Define an RVA/Size pair in the PE file header.

void SgAsmPEFileHeader::update_rvasize_pairs ( )

Update all the RVA/Size pair info from the section to which it points.

void SgAsmPEFileHeader::add_rvasize_pairs ( )

SgAsmPEFileHeader * SgAsmPEFileHeader::parse ( ) [virtual]

Initialize the header with information parsed from the file and construct and parse everything that's reachable from the header.

The PE File Header should have been constructed such that SgAsmPEFileHeader::ctor() was called.

Reimplemented from SgAsmGenericSection.

bool SgAsmPEFileHeader::reallocate ( ) [virtual]

Allow all sections to reallocate themselves.

Reimplemented from SgAsmGenericHeader.

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

Unparse headers and all they point to.

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

void SgAsmPEFileHeader::create_table_sections ( )

MemoryMap* SgAsmPEFileHeader::get_loader_map ( ) const [inline]

void SgAsmPEFileHeader::set_loader_map ( MemoryMap * map ) [inline]

void SgAsmPEFileHeader::ctor ( ) [private]

Constructor.

Headers (SgAsmGenericHeader and derived classes) set the file/header relationship--a bidirectional link between this new header and the single file that contains this new header. This new header points to its file and the file contains a list that points to this new header. The header-to-file half of the link is deleted by the default destructor by virtue of being a simple pointer, but we also need to delete the other half of the link in the destructors.

Reimplemented from SgAsmGenericHeader.

void * SgAsmPEFileHeader::encode ( SgAsmPEFileHeader::PEFileHeader_disk * ) const [private]

void * SgAsmPEFileHeader::encode ( SgAsmPEFileHeader::PE32OptHeader_disk * ) const [private]

void * SgAsmPEFileHeader::encode ( SgAsmPEFileHeader::PE64OptHeader_disk * ) const [private]

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

returns new style SageIII enum values

Reimplemented from SgAsmGenericHeader.

void* SgAsmPEFileHeader::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

void SgAsmPEFileHeader::operator delete ( void * pointer )

Reimplemented from SgAsmGenericHeader.

static size_t SgAsmPEFileHeader::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

void SgAsmPEFileHeader::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmGenericHeader.

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

SgAsmPEFileHeader* SgAsmPEFileHeader::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 SgAsmPEFileHeader::get_e_cpu_type ( ) const

void SgAsmPEFileHeader::set_e_cpu_type ( unsigned e_cpu_type )

unsigned SgAsmPEFileHeader::get_e_nsections ( ) const

void SgAsmPEFileHeader::set_e_nsections ( unsigned e_nsections )

unsigned SgAsmPEFileHeader::get_e_time ( ) const

void SgAsmPEFileHeader::set_e_time ( unsigned e_time )

rose_addr_t SgAsmPEFileHeader::get_e_coff_symtab ( ) const

void SgAsmPEFileHeader::set_e_coff_symtab ( rose_addr_t e_coff_symtab )

rose_addr_t SgAsmPEFileHeader::get_e_nt_hdr_size ( ) const

void SgAsmPEFileHeader::set_e_nt_hdr_size ( rose_addr_t e_nt_hdr_size )

unsigned SgAsmPEFileHeader::get_e_coff_nsyms ( ) const

void SgAsmPEFileHeader::set_e_coff_nsyms ( unsigned e_coff_nsyms )

unsigned SgAsmPEFileHeader::get_e_flags ( ) const

void SgAsmPEFileHeader::set_e_flags ( unsigned e_flags )

unsigned SgAsmPEFileHeader::get_e_opt_magic ( ) const

void SgAsmPEFileHeader::set_e_opt_magic ( unsigned e_opt_magic )

unsigned SgAsmPEFileHeader::get_e_lmajor ( ) const

void SgAsmPEFileHeader::set_e_lmajor ( unsigned e_lmajor )

unsigned SgAsmPEFileHeader::get_e_lminor ( ) const

void SgAsmPEFileHeader::set_e_lminor ( unsigned e_lminor )

unsigned SgAsmPEFileHeader::get_e_code_size ( ) const

void SgAsmPEFileHeader::set_e_code_size ( unsigned e_code_size )

unsigned SgAsmPEFileHeader::get_e_data_size ( ) const

void SgAsmPEFileHeader::set_e_data_size ( unsigned e_data_size )

unsigned SgAsmPEFileHeader::get_e_bss_size ( ) const

void SgAsmPEFileHeader::set_e_bss_size ( unsigned e_bss_size )

rose_rva_t SgAsmPEFileHeader::get_e_code_rva ( ) const

void SgAsmPEFileHeader::set_e_code_rva ( rose_rva_t e_code_rva )

rose_rva_t SgAsmPEFileHeader::get_e_data_rva ( ) const

void SgAsmPEFileHeader::set_e_data_rva ( rose_rva_t e_data_rva )

unsigned SgAsmPEFileHeader::get_e_section_align ( ) const

void SgAsmPEFileHeader::set_e_section_align ( unsigned e_section_align )

unsigned SgAsmPEFileHeader::get_e_file_align ( ) const

void SgAsmPEFileHeader::set_e_file_align ( unsigned e_file_align )

unsigned SgAsmPEFileHeader::get_e_os_major ( ) const

void SgAsmPEFileHeader::set_e_os_major ( unsigned e_os_major )

unsigned SgAsmPEFileHeader::get_e_os_minor ( ) const

void SgAsmPEFileHeader::set_e_os_minor ( unsigned e_os_minor )

unsigned SgAsmPEFileHeader::get_e_user_major ( ) const

void SgAsmPEFileHeader::set_e_user_major ( unsigned e_user_major )

unsigned SgAsmPEFileHeader::get_e_user_minor ( ) const

void SgAsmPEFileHeader::set_e_user_minor ( unsigned e_user_minor )

unsigned SgAsmPEFileHeader::get_e_subsys_major ( ) const

void SgAsmPEFileHeader::set_e_subsys_major ( unsigned e_subsys_major )

unsigned SgAsmPEFileHeader::get_e_subsys_minor ( ) const

void SgAsmPEFileHeader::set_e_subsys_minor ( unsigned e_subsys_minor )

unsigned SgAsmPEFileHeader::get_e_reserved9 ( ) const

void SgAsmPEFileHeader::set_e_reserved9 ( unsigned e_reserved9 )

unsigned SgAsmPEFileHeader::get_e_image_size ( ) const

void SgAsmPEFileHeader::set_e_image_size ( unsigned e_image_size )

unsigned SgAsmPEFileHeader::get_e_header_size ( ) const

void SgAsmPEFileHeader::set_e_header_size ( unsigned e_header_size )

unsigned SgAsmPEFileHeader::get_e_file_checksum ( ) const

void SgAsmPEFileHeader::set_e_file_checksum ( unsigned e_file_checksum )

unsigned SgAsmPEFileHeader::get_e_subsystem ( ) const

void SgAsmPEFileHeader::set_e_subsystem ( unsigned e_subsystem )

unsigned SgAsmPEFileHeader::get_e_dll_flags ( ) const

void SgAsmPEFileHeader::set_e_dll_flags ( unsigned e_dll_flags )

unsigned SgAsmPEFileHeader::get_e_stack_reserve_size ( ) const

void SgAsmPEFileHeader::set_e_stack_reserve_size ( unsigned e_stack_reserve_size )

unsigned SgAsmPEFileHeader::get_e_stack_commit_size ( ) const

void SgAsmPEFileHeader::set_e_stack_commit_size ( unsigned e_stack_commit_size )

unsigned SgAsmPEFileHeader::get_e_heap_reserve_size ( ) const

void SgAsmPEFileHeader::set_e_heap_reserve_size ( unsigned e_heap_reserve_size )

unsigned SgAsmPEFileHeader::get_e_heap_commit_size ( ) const

void SgAsmPEFileHeader::set_e_heap_commit_size ( unsigned e_heap_commit_size )

unsigned SgAsmPEFileHeader::get_e_loader_flags ( ) const

void SgAsmPEFileHeader::set_e_loader_flags ( unsigned e_loader_flags )

unsigned SgAsmPEFileHeader::get_e_num_rvasize_pairs ( ) const

void SgAsmPEFileHeader::set_e_num_rvasize_pairs ( unsigned e_num_rvasize_pairs )

SgAsmPERVASizePairList* SgAsmPEFileHeader::get_rvasize_pairs ( ) const

void SgAsmPEFileHeader::set_rvasize_pairs ( SgAsmPERVASizePairList * rvasize_pairs )

SgAsmPESectionTable* SgAsmPEFileHeader::get_section_table ( ) const

void SgAsmPEFileHeader::set_section_table ( SgAsmPESectionTable * section_table )

SgAsmCoffSymbolTable* SgAsmPEFileHeader::get_coff_symtab ( ) const

void SgAsmPEFileHeader::set_coff_symtab ( SgAsmCoffSymbolTable * coff_symtab )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmGenericHeader.

friend class SgAsmPEFileHeaderStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmGenericHeader.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmGenericHeader.

SgAsmPEFileHeader* isSgAsmPEFileHeader ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

const SgAsmPEFileHeader* isSgAsmPEFileHeader ( const SgNode * s ) [friend]

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

SgAsmPEFileHeader* SgAsmPEFileHeader_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 SgAsmPEFileHeader_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 SgAsmPEFileHeader_clearMemoryPool ( ) [friend]