SgAsmPEImportSection Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmPEImportSection:

[legend]Collaboration diagram for SgAsmPEImportSection:

[legend]List of all members.

Public Types
typedef SgAsmPESection	base_node_type
	static_variant = V_SgAsmPEImportSection
enum	{ static_variant = V_SgAsmPEImportSection }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgAsmPEImportSection (SgAsmPEFileHeader *fhdr)
virtual SgAsmPEImportSection *	parse ()
virtual bool	reallocate ()
	Reallocate space for the import section if necessary.
virtual void	unparse (std::ostream &) const
	Write a section back to the file.
virtual void	dump (FILE *, const char *prefix, ssize_t idx) const
void	add_import_directory (SgAsmPEImportDirectory *)
	Add an import directory to the end of the import directory list.
void	remove_import_directory (SgAsmPEImportDirectory *)
	Remove an import directory from the import directory list.
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.
	SgAsmPEImportSection (const SgAsmPEImportSectionStorageClass &source)
SgAsmPEImportSection *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
SgAsmPEImportDirectoryList *	get_import_directories () const
void	set_import_directories (SgAsmPEImportDirectoryList *import_directories)
virtual	~SgAsmPEImportSection ()
	SgAsmPEImportSection ()
Static Public Member Functions
static bool	import_mesg (const char *fmt,...)
	Optionally prints an error/warning/info message regarding import tables.
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
SgAsmPEImportDirectoryList *	p_import_directories
Private Member Functions
void	ctor ()
	Constructor for PE import data.
Friends
class	AST_FILE_IO
class	SgAsmPEImportSectionStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAsmPEImportSection *	isSgAsmPEImportSection (SgNode *s)
	Casts pointer from base class to derived class.
const SgAsmPEImportSection *	isSgAsmPEImportSection (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAsmPEImportSection *	SgAsmPEImportSection_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	SgAsmPEImportSection_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAsmPEImportSection_clearMemoryPool ()
void	SgAsmPEImportSection_extendMemoryPoolForFileIO (unsigned long)
void	SgAsmPEImportSection_getNextValidPointer (std::pair< SgAsmPEImportSection *, std::vector< unsigned char * >::const_iterator > &)
void	SgAsmPEImportSection_resetValidFreepointers ()

---

Member Typedef Documentation

typedef SgAsmPESection SgAsmPEImportSection::base_node_type

Reimplemented from SgAsmPESection.

---

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

---

Constructor & Destructor Documentation

SgAsmPEImportSection::SgAsmPEImportSection

(

SgAsmPEFileHeader *

fhdr

)

[inline, explicit]

SgAsmPEImportSection::SgAsmPEImportSection

(

const SgAsmPEImportSectionStorageClass &

source

)

virtual SgAsmPEImportSection::~SgAsmPEImportSection

(

)

[virtual]

SgAsmPEImportSection::SgAsmPEImportSection

(

)

---

Member Function Documentation

virtual SgNode* SgAsmPEImportSection::copy

(

SgCopyHelp &

help

)

const [virtual]

Reimplemented from SgAsmPESection.

SgAsmPEImportSection * SgAsmPEImportSection::parse

(

)

[virtual]

Reimplemented from SgAsmGenericSection.

bool SgAsmPEImportSection::reallocate

(

)

[virtual]

Reallocate space for the import section if necessary.

This will likely not work correctly because it moves the import address tables. Unlike ELF, which tends to have dynamic linking trampolines and tables (PLT and GOT) in well defined locations, PE executables seem to have them haphazardly scattered throughout virtual memory. That means there's no easy way to fix things if we have to move the import address table. This whole subject of Import reallocation needs much improvement.

Reimplemented from SgAsmPESection.

void SgAsmPEImportSection::unparse

(

std::ostream &

f

)

const [virtual]

Write a section back to the file.

This is the generic version that simply writes the content. Subclasses should override this.

Reimplemented from SgAsmGenericSection.

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

Reimplemented from SgAsmPESection.

void SgAsmPEImportSection::add_import_directory

(

SgAsmPEImportDirectory *

)

Add an import directory to the end of the import directory list.

void SgAsmPEImportSection::remove_import_directory

(

SgAsmPEImportDirectory *

d

)

Remove an import directory from the import directory list.

Does not delete it.

bool SgAsmPEImportSection::import_mesg	(	const char *	fmt,
			...
	)			[static]

Optionally prints an error/warning/info message regarding import tables.

The messages are silenced after a certain amount are printed. Returns true if printed; false if silenced.

void SgAsmPEImportSection::ctor

(

)

[private]

Constructor for PE import data.

Constructs an SgAsmPEImportSection that represents either a PE ".idata" section as defined by the PE Section Table, or a PE Import Table as described by the RVA/Size pairs at the end of the NT Optional Header. The ".idata" section and PE Import Table both have the same format, which is generally:

 +-------------------------------+  Starts at address zero of the .idata
 | Import Directory Table:       |  section or PE Import Table. Each Directory
 |   Import Directory Entry #0   |  represents one library and all  its
 |   Import Directory Entry #1   |  associated symbols.
 |   ...                         |
 |   Zero-filled Directory Entry |
 +-------------------------------+

 +-------------------------------+  One table per dynamic library, starting
 | Import Lookup Table (ILT)     |  at arbitrary RVA specified in the
 |   ILT Entry #0                |  Directory Table.
 |   ILT Entry #1                |
 |   Zero-filled ILTEntry        |
 +-------------------------------+

 +-------------------------------+  There is no starting RVA for this table.
 | Hint-Name Table               |  Rather, ILT Entries each contain an RVA
 |                               |  to an entry in the Hint-Name Table.
 +-------------------------------+

virtual std::string SgAsmPEImportSection::class_name

(

)

const [virtual]

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

Reimplemented from SgAsmPESection.

virtual VariantT SgAsmPEImportSection::variantT

(

)

const [virtual]

returns new style SageIII enum values

Reimplemented from SgAsmPESection.

void* SgAsmPEImportSection::operator new

(

size_t

size

)

returns pointer to newly allocated IR node

Reimplemented from SgAsmPESection.

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

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

Reimplemented from SgAsmPESection.

void SgAsmPEImportSection::operator delete

(

void *

pointer

)

Reimplemented from SgAsmPESection.

static size_t SgAsmPEImportSection::numberOfNodes

(

)

[static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmPESection.

static size_t SgAsmPEImportSection::memoryUsage

(

)

[static]

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

Reimplemented from SgAsmPESection.

virtual std::vector<SgNode*> SgAsmPEImportSection::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 SgAsmPESection.

virtual std::vector<std::string> SgAsmPEImportSection::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 SgAsmPESection.

virtual size_t SgAsmPEImportSection::get_numberOfTraversalSuccessors

(

)

[virtual]

Reimplemented from SgAsmPESection.

virtual SgNode* SgAsmPEImportSection::get_traversalSuccessorByIndex

(

size_t

idx

)

[virtual]

Reimplemented from SgAsmPESection.

virtual size_t SgAsmPEImportSection::get_childIndex

(

SgNode *

child

)

[virtual]

Reimplemented from SgAsmPESection.

virtual RTIReturnType SgAsmPEImportSection::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 SgAsmPESection.

virtual const char* SgAsmPEImportSection::sage_class_name

(

)

const [virtual]

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

Reimplemented from SgAsmPESection.

void SgAsmPEImportSection::executeVisitorMemberFunction

(

ROSE_VisitorPattern &

visitor

)

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmPESection.

virtual void SgAsmPEImportSection::accept

(

ROSE_VisitorPattern &

visitor

)

[virtual]

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

Reimplemented from SgAsmPESection.

static void SgAsmPEImportSection::traverseMemoryPoolNodes

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmPESection.

static void SgAsmPEImportSection::traverseMemoryPoolVisitorPattern

(

ROSE_VisitorPattern &

visitor

)

[static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmPESection.

static void SgAsmPEImportSection::visitRepresentativeNode

(

ROSE_VisitTraversal &

visit

)

[static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmPESection.

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

virtual void SgAsmPEImportSection::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 SgAsmPESection.

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

virtual void SgAsmPEImportSection::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 SgAsmPESection.

virtual long SgAsmPEImportSection::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 SgAsmPESection.

SgAsmPEImportSection* SgAsmPEImportSection::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 SgAsmPESection.

SgAsmPEImportDirectoryList* SgAsmPEImportSection::get_import_directories

(

)

const

void SgAsmPEImportSection::set_import_directories

(

SgAsmPEImportDirectoryList *

import_directories

)

---

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmPESection.

friend class SgAsmPEImportSectionStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmPESection.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmPESection.

SgAsmPEImportSection* isSgAsmPEImportSection

(

SgNode *

s

)

[friend]

Casts pointer from base class to derived class.

const SgAsmPEImportSection* isSgAsmPEImportSection

(

const SgNode *

s

)

[friend]

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

SgAsmPEImportSection* SgAsmPEImportSection_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 SgAsmPEImportSection_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 SgAsmPEImportSection_clearMemoryPool

(

)

[friend]

void SgAsmPEImportSection_extendMemoryPoolForFileIO

(

unsigned

long

)

[friend]

void SgAsmPEImportSection_getNextValidPointer

(

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

)

[friend]

void SgAsmPEImportSection_resetValidFreepointers

(

)

[friend]

---

Member Data Documentation

SgAsmPEImportDirectoryList* SgAsmPEImportSection::p_import_directories [protected]

---

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

• Cxx_Grammar.h
• PeImportSection.C

---