SgAsmDOSFileHeader Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgAsmDOSFileHeader:

[legend]Collaboration diagram for SgAsmDOSFileHeader:


Public Types
typedef SgAsmGenericHeader	base_node_type
	static_variant = V_SgAsmDOSFileHeader
enum	{ static_variant = V_SgAsmDOSFileHeader }
	static variant value More...
Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	SgAsmDOSFileHeader (SgAsmGenericFile *f)
virtual SgAsmDOSFileHeader *	parse ()
SgAsmDOSFileHeader *	parse (bool define_rm_section)
	Initialize this header with information parsed from the file and construct and parse everything that's reachable from the header.
virtual bool	reallocate ()
	Allocate file space for header.
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 const char *	format_name () const
SgAsmGenericSection *	parse_rm_section (rose_addr_t max_offset=0)
	Parses the DOS real-mode text+data section and adds it to the AST.
void	update_from_rm_section ()
	Update DOS header with data from real-mode section.
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.
	SgAsmDOSFileHeader (const SgAsmDOSFileHeaderStorageClass &source)
SgAsmDOSFileHeader *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression.
uint16_t	get_e_last_page_size () const
void	set_e_last_page_size (uint16_t e_last_page_size)
uint16_t	get_e_total_pages () const
void	set_e_total_pages (uint16_t e_total_pages)
uint16_t	get_e_nrelocs () const
void	set_e_nrelocs (uint16_t e_nrelocs)
uint16_t	get_e_header_paragraphs () const
void	set_e_header_paragraphs (uint16_t e_header_paragraphs)
uint16_t	get_e_minalloc () const
void	set_e_minalloc (uint16_t e_minalloc)
uint16_t	get_e_maxalloc () const
void	set_e_maxalloc (uint16_t e_maxalloc)
uint16_t	get_e_ss () const
void	set_e_ss (uint16_t e_ss)
uint16_t	get_e_sp () const
void	set_e_sp (uint16_t e_sp)
uint16_t	get_e_cksum () const
void	set_e_cksum (uint16_t e_cksum)
uint16_t	get_e_ip () const
void	set_e_ip (uint16_t e_ip)
uint16_t	get_e_cs () const
void	set_e_cs (uint16_t e_cs)
uint16_t	get_e_overlay () const
void	set_e_overlay (uint16_t e_overlay)
rose_addr_t	get_e_relocs_offset () const
void	set_e_relocs_offset (rose_addr_t e_relocs_offset)
unsigned	get_e_res1 () const
void	set_e_res1 (unsigned e_res1)
SgAsmGenericSection *	get_relocs () const
void	set_relocs (SgAsmGenericSection *relocs)
SgAsmGenericSection *	get_rm_section () const
void	set_rm_section (SgAsmGenericSection *rm_section)
virtual	~SgAsmDOSFileHeader ()
	SgAsmDOSFileHeader ()
Static Public Member Functions
static bool	is_DOS (SgAsmGenericFile *)
	Returns true if a cursory look at the file indicates that it could be a DOS executable file.
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
SgAsmDOSFileHeader::DOSFileHeader_disk	packed
SgAsmDOSFileHeader::DOSRelocEntry_disk	packed
Protected Attributes
uint16_t	p_e_last_page_size
uint16_t	p_e_total_pages
uint16_t	p_e_nrelocs
uint16_t	p_e_header_paragraphs
uint16_t	p_e_minalloc
uint16_t	p_e_maxalloc
uint16_t	p_e_ss
uint16_t	p_e_sp
uint16_t	p_e_cksum
uint16_t	p_e_ip
uint16_t	p_e_cs
uint16_t	p_e_overlay
rose_addr_t	p_e_relocs_offset
unsigned	p_e_res1
SgAsmGenericSection *	p_relocs
SgAsmGenericSection *	p_rm_section
Private Member Functions
void	ctor ()
	Construct a new DOS File Header with default values.
void *	encode (SgAsmDOSFileHeader::DOSFileHeader_disk *) const
Friends
class	AST_FILE_IO
class	SgAsmDOSFileHeaderStorageClass
class	AstSpecificDataManagingClass
class	AstSpecificDataManagingClassStorageClass
SgAsmDOSFileHeader *	isSgAsmDOSFileHeader (SgNode *s)
	Casts pointer from base class to derived class.
const SgAsmDOSFileHeader *	isSgAsmDOSFileHeader (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers).
SgAsmDOSFileHeader *	SgAsmDOSFileHeader_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	SgAsmDOSFileHeader_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool.
void	SgAsmDOSFileHeader_clearMemoryPool ()
void	SgAsmDOSFileHeader_extendMemoryPoolForFileIO (unsigned long)
void	SgAsmDOSFileHeader_getNextValidPointer (std::pair< SgAsmDOSFileHeader , std::vector< unsigned char >::const_iterator > &)
void	SgAsmDOSFileHeader_resetValidFreepointers ()
Classes
struct	DOSFileHeader_disk
struct	DOSRelocEntry_disk

Member Typedef Documentation

typedef SgAsmGenericHeader SgAsmDOSFileHeader::base_node_type

Reimplemented from SgAsmGenericHeader.

Member Enumeration Documentation

anonymous enum

static variant value

Enumerator:

static_variant

Constructor & Destructor Documentation

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

SgAsmDOSFileHeader::SgAsmDOSFileHeader ( const SgAsmDOSFileHeaderStorageClass & source )

virtual SgAsmDOSFileHeader::~SgAsmDOSFileHeader ( ) [virtual]

SgAsmDOSFileHeader::SgAsmDOSFileHeader ( )

Member Function Documentation

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

Reimplemented from SgAsmGenericHeader.

virtual SgAsmDOSFileHeader* SgAsmDOSFileHeader::parse ( ) [inline, virtual]

Reimplemented from SgAsmGenericSection.

SgAsmDOSFileHeader * SgAsmDOSFileHeader::parse ( bool define_rm_section )

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

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

bool SgAsmDOSFileHeader::reallocate ( ) [virtual]

Allocate file space for header.

Also updates various entries in the header based on the location and size of the DOS Extended Header and the DOS Real-Mode Text+Data section (if any).

Reimplemented from SgAsmGenericHeader.

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

Unparse headers and all they point to.

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

SgAsmGenericSection * SgAsmDOSFileHeader::parse_rm_section ( rose_addr_t max_offset = 0 )

Parses the DOS real-mode text+data section and adds it to the AST.

If max_offset is non-zero then use that as the maximum offset of the real-mode section. If the DOS header indicates a zero sized section then return NULL. If the section exists or is zero size due to the max_offset then return the section. See also, update_from_rm_section().

void SgAsmDOSFileHeader::update_from_rm_section ( )

Update DOS header with data from real-mode section.

The DOS real-mode data+text section is assumed to appear immediately after the DOS Extended Header, which appears immediately after the DOS File Header, which appears at the beginning of the file. These assumptions are not checked until SgAsmDOSFileHeader::unparse() is called. See also, parse_rm_section().

bool SgAsmDOSFileHeader::is_DOS ( SgAsmGenericFile * ) [static]

Returns true if a cursory look at the file indicates that it could be a DOS executable file.

void SgAsmDOSFileHeader::ctor ( ) [private]

Construct a new DOS File Header with default values.

The new section is placed at file offset zero and the size is initially one byte (calling reallocate() or parse() will extend it as necessary).

Reimplemented from SgAsmGenericHeader.

void * SgAsmDOSFileHeader::encode ( SgAsmDOSFileHeader::DOSFileHeader_disk * ) const [private]

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

returns new style SageIII enum values

Reimplemented from SgAsmGenericHeader.

void* SgAsmDOSFileHeader::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

void SgAsmDOSFileHeader::operator delete ( void * pointer )

Reimplemented from SgAsmGenericHeader.

static size_t SgAsmDOSFileHeader::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

void SgAsmDOSFileHeader::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

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

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgAsmGenericHeader.

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

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgAsmGenericHeader.

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

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

uint16_t SgAsmDOSFileHeader::get_e_last_page_size ( ) const

void SgAsmDOSFileHeader::set_e_last_page_size ( uint16_t e_last_page_size )

uint16_t SgAsmDOSFileHeader::get_e_total_pages ( ) const

void SgAsmDOSFileHeader::set_e_total_pages ( uint16_t e_total_pages )

uint16_t SgAsmDOSFileHeader::get_e_nrelocs ( ) const

void SgAsmDOSFileHeader::set_e_nrelocs ( uint16_t e_nrelocs )

uint16_t SgAsmDOSFileHeader::get_e_header_paragraphs ( ) const

void SgAsmDOSFileHeader::set_e_header_paragraphs ( uint16_t e_header_paragraphs )

uint16_t SgAsmDOSFileHeader::get_e_minalloc ( ) const

void SgAsmDOSFileHeader::set_e_minalloc ( uint16_t e_minalloc )

uint16_t SgAsmDOSFileHeader::get_e_maxalloc ( ) const

void SgAsmDOSFileHeader::set_e_maxalloc ( uint16_t e_maxalloc )

uint16_t SgAsmDOSFileHeader::get_e_ss ( ) const

void SgAsmDOSFileHeader::set_e_ss ( uint16_t e_ss )

uint16_t SgAsmDOSFileHeader::get_e_sp ( ) const

void SgAsmDOSFileHeader::set_e_sp ( uint16_t e_sp )

uint16_t SgAsmDOSFileHeader::get_e_cksum ( ) const

void SgAsmDOSFileHeader::set_e_cksum ( uint16_t e_cksum )

uint16_t SgAsmDOSFileHeader::get_e_ip ( ) const

void SgAsmDOSFileHeader::set_e_ip ( uint16_t e_ip )

uint16_t SgAsmDOSFileHeader::get_e_cs ( ) const

void SgAsmDOSFileHeader::set_e_cs ( uint16_t e_cs )

uint16_t SgAsmDOSFileHeader::get_e_overlay ( ) const

void SgAsmDOSFileHeader::set_e_overlay ( uint16_t e_overlay )

rose_addr_t SgAsmDOSFileHeader::get_e_relocs_offset ( ) const

void SgAsmDOSFileHeader::set_e_relocs_offset ( rose_addr_t e_relocs_offset )

unsigned SgAsmDOSFileHeader::get_e_res1 ( ) const

void SgAsmDOSFileHeader::set_e_res1 ( unsigned e_res1 )

SgAsmGenericSection* SgAsmDOSFileHeader::get_relocs ( ) const

void SgAsmDOSFileHeader::set_relocs ( SgAsmGenericSection * relocs )

SgAsmGenericSection* SgAsmDOSFileHeader::get_rm_section ( ) const

void SgAsmDOSFileHeader::set_rm_section ( SgAsmGenericSection * rm_section )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgAsmGenericHeader.

friend class SgAsmDOSFileHeaderStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgAsmGenericHeader.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgAsmGenericHeader.

SgAsmDOSFileHeader* isSgAsmDOSFileHeader ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

const SgAsmDOSFileHeader* isSgAsmDOSFileHeader ( const SgNode * s ) [friend]

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

SgAsmDOSFileHeader* SgAsmDOSFileHeader_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 SgAsmDOSFileHeader_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 SgAsmDOSFileHeader_clearMemoryPool ( ) [friend]