SgAsmPEImportLookupTable Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmPEImportLookupTable:

Inheritance graph
[legend]
Collaboration diagram for SgAsmPEImportLookupTable:

Collaboration graph
[legend]
List of all members.

Public Types

typedef SgAsmExecutableFileFormat base_node_type
 ILT_LOOKUP_TABLE
 ILT_ADDRESS_TABLE
 static_variant = V_SgAsmPEImportLookupTable
enum  TableKind {
  ILT_LOOKUP_TABLE,
  ILT_ADDRESS_TABLE
}
 This class represents import lookup tables or import address tables. More...
enum  { static_variant = V_SgAsmPEImportLookupTable }
 static variant value More...

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
 SgAsmPEImportLookupTable (SgAsmPEImportDirectory *idir, TableKind tkind)
SgAsmPEImportLookupTableparse (rose_rva_t table_rva, size_t idir_idx)
 Parses a PE Import Lookup Table from the file.
size_t add_entry (SgAsmPEImportILTEntry *, size_t idx=(size_t)(-1))
 Adds an Import Lookup Table Entry (or Import Address Table Entry) to the Import Lookup Table (or Import Address Table).
size_t add_name (const std::string &name, size_t hint=0, size_t idx=(size_t)(-1))
 Constructs an Import Lookup Table Entry (or Import Address Table Entry) that points to a name/hint, and adds it to the Import Lookup Table.
size_t add_address (rose_rva_t rva, size_t idx=(size_t)(-1))
 Constructs an Import Lookup Table Entry (or Import Address Table Entry) which contains the address of the symbol.
size_t reallocate (rose_rva_t start_rva)
 Allocates space for this import lookup table.
virtual void unparse (std::ostream &, const SgAsmPEFileHeader *, rose_rva_t) 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 SgNodeget_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.
 SgAsmPEImportLookupTable (const SgAsmPEImportLookupTableStorageClass &source)
SgAsmPEImportLookupTableaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression.
SgAsmPEImportLookupTable::TableKind get_table_kind () const
void set_table_kind (SgAsmPEImportLookupTable::TableKind table_kind)
SgAsmPEImportILTEntryListget_entries () const
void set_entries (SgAsmPEImportILTEntryList *entries)
virtual ~SgAsmPEImportLookupTable ()
 SgAsmPEImportLookupTable ()

Static Public Member Functions

static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type.
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern.
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.

Protected Attributes

SgAsmPEImportLookupTable::TableKind p_table_kind
SgAsmPEImportILTEntryListp_entries

Private Member Functions

void ctor (SgAsmPEImportDirectory *)
 Constructs a new import lookup table or import address table and adds it as a child of the import directory.

Friends

class AST_FILE_IO
class SgAsmPEImportLookupTableStorageClass
class AstSpecificDataManagingClass
class AstSpecificDataManagingClassStorageClass
SgAsmPEImportLookupTableisSgAsmPEImportLookupTable (SgNode *s)
 Casts pointer from base class to derived class.
const SgAsmPEImportLookupTableisSgAsmPEImportLookupTable (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers).
SgAsmPEImportLookupTableSgAsmPEImportLookupTable_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 SgAsmPEImportLookupTable_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool.
void SgAsmPEImportLookupTable_clearMemoryPool ()
void SgAsmPEImportLookupTable_extendMemoryPoolForFileIO (unsigned long)
void SgAsmPEImportLookupTable_getNextValidPointer (std::pair< SgAsmPEImportLookupTable *, std::vector< unsigned char * >::const_iterator > &)
void SgAsmPEImportLookupTable_resetValidFreepointers ()

Member Typedef Documentation

typedef SgAsmExecutableFileFormat SgAsmPEImportLookupTable::base_node_type

Reimplemented from SgAsmExecutableFileFormat.


Member Enumeration Documentation

enum SgAsmPEImportLookupTable::TableKind

This class represents import lookup tables or import address tables.

Enumerator:
ILT_LOOKUP_TABLE 
ILT_ADDRESS_TABLE 

anonymous enum

static variant value

Enumerator:
static_variant 


Constructor & Destructor Documentation

SgAsmPEImportLookupTable::SgAsmPEImportLookupTable ( SgAsmPEImportDirectory idir,
TableKind  tkind 
) [inline, explicit]

SgAsmPEImportLookupTable::SgAsmPEImportLookupTable ( const SgAsmPEImportLookupTableStorageClass &  source  ) 

virtual SgAsmPEImportLookupTable::~SgAsmPEImportLookupTable (  )  [virtual]

SgAsmPEImportLookupTable::SgAsmPEImportLookupTable (  ) 


Member Function Documentation

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

Reimplemented from SgAsmExecutableFileFormat.

SgAsmPEImportLookupTable * SgAsmPEImportLookupTable::parse ( rose_rva_t  rva,
size_t  idir_idx 
)

Parses a PE Import Lookup Table from the file.

The rva is the address of the table and should be bound to a section (which may not necessarily be isec). The idir_idx argument is only for error messages and should indicate the index of this table's SgAsmPEImportDirectory object within the SgAsmPEImportSection.

size_t SgAsmPEImportLookupTable::add_entry ( SgAsmPEImportILTEntry ilt_entry,
size_t  idx = (size_t)(-1) 
)

Adds an Import Lookup Table Entry (or Import Address Table Entry) to the Import Lookup Table (or Import Address Table).

If an index is specified then the table is extended if necessary and all entries intervening between the old end-of-table and the newly added entry are initialized to null pointers. If an index was specified and the element already exists then it will be moved. If the destination already points to an entry then that entry will be unlinked from the AST.

If an index is not specified and the entry already exists in the table then its position becomes this method's return value and no other action is performed. Otherwise, an unspecified index is the same as choosing an index which is one past the end of the table, thus extending the table by exactly one element.

An entry can be removed from the table by specifying a null ilt_entry along with an index.

The return value is the index where the entry was inserted (or already exists if idx is unspecified). previous location.

size_t SgAsmPEImportLookupTable::add_name ( const std::string &  name,
size_t  hint = 0,
size_t  idx = (size_t)(-1) 
)

Constructs an Import Lookup Table Entry (or Import Address Table Entry) that points to a name/hint, and adds it to the Import Lookup Table.

Returns the table index where the entry was added.

size_t SgAsmPEImportLookupTable::add_address ( rose_rva_t  rva,
size_t  idx = (size_t)(-1) 
)

Constructs an Import Lookup Table Entry (or Import Address Table Entry) which contains the address of the symbol.

size_t SgAsmPEImportLookupTable::reallocate ( rose_rva_t  start_rva  ) 

Allocates space for this import lookup table.

Space is allocated beginning at the specified start_rva. Space is (re)allocated for Hint/Name table entries if the entry is not allocated or if its rose_rva_t points to the same section as start_rva points to. Returns the number of bytes allocated.

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

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

void SgAsmPEImportLookupTable::ctor ( SgAsmPEImportDirectory  )  [private]

Constructs a new import lookup table or import address table and adds it as a child of the import directory.

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

returns new style SageIII enum values

Reimplemented from SgAsmExecutableFileFormat.

void* SgAsmPEImportLookupTable::operator new ( size_t  size  ) 

returns pointer to newly allocated IR node

Reimplemented from SgAsmExecutableFileFormat.

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

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

Reimplemented from SgAsmExecutableFileFormat.

void SgAsmPEImportLookupTable::operator delete ( void *  pointer  ) 

Reimplemented from SgAsmExecutableFileFormat.

static size_t SgAsmPEImportLookupTable::numberOfNodes (  )  [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmExecutableFileFormat.

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

Reimplemented from SgAsmExecutableFileFormat.

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

Reimplemented from SgAsmExecutableFileFormat.

virtual size_t SgAsmPEImportLookupTable::get_childIndex ( SgNode child  )  [virtual]

Reimplemented from SgAsmExecutableFileFormat.

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

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

Reimplemented from SgAsmExecutableFileFormat.

void SgAsmPEImportLookupTable::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor  ) 

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

virtual void SgAsmPEImportLookupTable::accept ( ROSE_VisitorPattern visitor  )  [virtual]

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

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmPEImportLookupTable::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit  )  [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmPEImportLookupTable::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor  )  [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmExecutableFileFormat.

static void SgAsmPEImportLookupTable::visitRepresentativeNode ( ROSE_VisitTraversal visit  )  [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmExecutableFileFormat.

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

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

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgAsmExecutableFileFormat.

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

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

SgAsmPEImportLookupTable::TableKind SgAsmPEImportLookupTable::get_table_kind (  )  const

void SgAsmPEImportLookupTable::set_table_kind ( SgAsmPEImportLookupTable::TableKind  table_kind  ) 

SgAsmPEImportILTEntryList* SgAsmPEImportLookupTable::get_entries (  )  const

void SgAsmPEImportLookupTable::set_entries ( SgAsmPEImportILTEntryList entries  ) 


Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmExecutableFileFormat.

friend class SgAsmPEImportLookupTableStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmExecutableFileFormat.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmExecutableFileFormat.

SgAsmPEImportLookupTable* isSgAsmPEImportLookupTable ( SgNode s  )  [friend]

Casts pointer from base class to derived class.

const SgAsmPEImportLookupTable* isSgAsmPEImportLookupTable ( const SgNode s  )  [friend]

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

SgAsmPEImportLookupTable* SgAsmPEImportLookupTable_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 SgAsmPEImportLookupTable_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 SgAsmPEImportLookupTable_clearMemoryPool (  )  [friend]

void SgAsmPEImportLookupTable_extendMemoryPoolForFileIO ( unsigned  long  )  [friend]

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

void SgAsmPEImportLookupTable_resetValidFreepointers (  )  [friend]


Member Data Documentation

SgAsmPEImportLookupTable::TableKind SgAsmPEImportLookupTable::p_table_kind [protected]

SgAsmPEImportILTEntryList* SgAsmPEImportLookupTable::p_entries [protected]


The documentation for this class was generated from the following files:
Generated on Tue Jan 31 05:37:46 2012 for ROSE by  doxygen 1.4.7