/* $Id: kHll.h,v 1.10 2000-08-31 03:02:27 bird Exp $ * * kHll - Declarations of the class kHll. * That class is used to create HLL debuginfo. * * Copyright (c) 2000 knut st. osmundsen (knut.stange.osmundsen@pmsc.no) * * Project Odin Software License can be found in LICENSE.TXT * */ #ifndef _kHll_h_ #define _kHll_h_ //wrong placement! #include #undef assert #define assert(a) (!(a) ? \ fprintf(stderr, "assert - %s(%d): %s\n", __FUNCTION__, __LINE__, #a), \ __interrupt(3) \ : \ (void)0, (void)0) /******************************************************************************* * Structures and Typedefs * *******************************************************************************/ /** * HLL General entry. * Provided as a base class for kList entries. * @author knut st. osmundsen (knut.stange.osmundsen@pmsc.no) */ class kHllBaseEntry : public kSortedListEntry { public: /** * Write this HLL entry to file. * @returns Count of bytes written (on success). * -3 Invalid offsets. * -2 Seek error. * -1 Write error. * 0 No data written. Concidered as an error! * @param phFile Filehandle. */ virtual int write(FILE *phFile) = 0; static int writeList(FILE *phFile, kHllBaseEntry *pEntry); /** * Dumps the HLL entry to ph in a human readable fashion. * @param ph Output file handle the dump is to be written to. * @param cchIndent Number of char to indents the output dump. */ virtual void dump(FILE *ph, int cchIndent) = 0; static void dumpList(FILE *ph, int cchIndent, kHllBaseEntry *pEntry); /** * Create IDC (IDA Pro) calls which adds info contained in the entry * to the ida pro database. * !!!NOTE!!! THIS IS ONLY TO BE USED FOR YOUR OWN PROGRAMS!!! * @param pFile Output file. */ virtual void ida(kFile *pFile) throw(int) = 0; static void idaList(kFile *pFile, kHllBaseEntry *pEntry) throw(int); /* temp fix */ BOOL operator==(const kSortedListEntry &entry) const { return TRUE; } BOOL operator!=(const kSortedListEntry &entry) const { return FALSE; } BOOL operator< (const kSortedListEntry &entry) const { return TRUE; } BOOL operator<=(const kSortedListEntry &entry) const { return TRUE; } BOOL operator> (const kSortedListEntry &entry) const { return FALSE; } BOOL operator>=(const kSortedListEntry &entry) const { return FALSE; } }; /** * HLL Public symbol entry. * @author knut st. osmundsen (knut.stange.osmundsen@pmsc.no) */ class kHllPubSymEntry : public kHllBaseEntry { private: PHLLPUBLICSYM pPubSym; public: kHllPubSymEntry( const char * pachName, int cchName, unsigned long off, unsigned short iObject, unsigned short iType ); ~kHllPubSymEntry(); int write(FILE *phFile); void dump(FILE *ph, int cchIndent); void ida(kFile *pFile) throw(int); /** @cat * Get methods. */ /** Gets the offset of the symbol location relative to object start. */ unsigned long getOffset() { return pPubSym->off; } /** Gets the object (segment/section/what ever) index of the symbol location. */ int getObjectIndex(){ return pPubSym->iObject; } /** Gets the Type index of the symbol type. */ int getTypeIndex() { return pPubSym->iType; } /** Gets the length of the public symbol. */ char getNameLength() { return pPubSym->cchName; } /** Gets ASCIIZ public symbol name. */ const char * getName() { return (const char *)&pPubSym->achName[0]; } BOOL operator==(const kHllPubSymEntry &entry) const; BOOL operator!=(const kHllPubSymEntry &entry) const; BOOL operator< (const kHllPubSymEntry &entry) const; BOOL operator<=(const kHllPubSymEntry &entry) const; BOOL operator> (const kHllPubSymEntry &entry) const; BOOL operator>=(const kHllPubSymEntry &entry) const; }; /** * Linenumber chunk. * @author knut st. osmundsen (knut.stange.osmundsen@pmsc.no) */ class kHllLineNumberChunk : public kHllBaseEntry { private: PHLLLINENUMBERENTRY paLines; HLLFIRSTENTRY FirstEntry; public: kHllLineNumberChunk( unsigned short int iSeg, unsigned long int offBase = 0 ); ~kHllLineNumberChunk(); BOOL addLineInfo( unsigned short int iusFile, unsigned short int usLine, unsigned long int off ); int write(FILE *phFile); void dump(FILE *ph, int cchIndent); void ida(kFile *pFile) throw(int); int getSeg() { return FirstEntry.hll04.iSeg; } }; /** * HLL Source entry. * @author knut st. osmundsen (knut.stange.osmundsen@pmsc.no) */ class kHllSrcEntry { private: unsigned long int cFilenames; char * pachFilenames; unsigned long int cbFilenames; unsigned long int cbFilenamesAllocated; kList Lines; public: kHllSrcEntry(); ~kHllSrcEntry(); kHllLineNumberChunk * addLineNumberChunk( unsigned short int iSeg, unsigned long int offBase = 0 ); unsigned short addFile( const char * pszFilename ); unsigned short addFile( const char * pachFilename, int cchFilename ); int write(FILE *phFile); void dump(FILE *ph, int cchIndent); void ida(kFile *pFile) throw(int); }; /** * HLL Module entry. * @author knut st. osmundsen (knut.stange.osmundsen@pmsc.no) */ class kHllModuleEntry : public kListEntry { private: /** @cat * Internal data. * HLL Module data. * Lists of HLL elements * Offsets and sizes - set by write(..). */ PHLLMODULE pModule; kSortedList PublicSymbols; /* kList Types; kList Symbols; */ kHllSrcEntry Source; BOOL fValidOffsetsAndSizes; unsigned long offModule; unsigned long cbModule; unsigned long offPublicSymbols; unsigned long cbPublicSymbols; unsigned long offTypes; unsigned long cbTypes; unsigned long offSymbols; unsigned long cbSymbols; unsigned long offSource; unsigned long cbSource; unsigned long iObjectMax; /** @cat * Internal methods. */ int writeList(FILE *phFile, kList &List); public: /** @cat * Constructor and destructor. */ kHllModuleEntry( const char * pszName, unsigned short iLib, unsigned char cSegInfo = 0, PHLLSEGINFO paSegInfo = NULL ); ~kHllModuleEntry(); /** @cat * Add menthods */ BOOL addSegInfo( unsigned short int iObject, unsigned long off, unsigned long cb ); const void * addPublicSymbol( const char * pszName, unsigned long int off, unsigned short int iObject, const void * pvType ); const void * addPublicSymbol( const char * pachName, int cchName, unsigned long int off, unsigned short int iObject, const void * pvType ); kHllSrcEntry * getSourceEntry() { return &Source; } /** @cat * Output. */ int write(FILE *phFile, unsigned long off); int writeDirEntries(FILE *phFile, unsigned short iMod); void writeSymSeg(kFile *pFile, int iSeg, PSEGDEF pSegDef, unsigned short * &paoffSyms, int &coffSymsAllocated, unsigned long offSegDef) throw (int); /** @cat * Get and queries. */ int queryMaxObjectIndex(); /** @cat * Debug dump function. */ void dump(FILE *ph); void ida(kFile *pFile) throw(int); }; /** * HLL Debug Info generator. * @author knut st. osmundsen (knut.stange.osmundsen@pmsc.no) */ class kHll { private: /** @cat * Internal data. */ kList Modules; /* kList Libraries; */ char * pszModName; /** @cat * Internal methods. */ int write(FILE *phFile); public: /** @cat * Constructors and Destructors. */ kHll(); kHll(kFile *pFile) throw (int); ~kHll(); /** @cat * Add menthods */ kHllModuleEntry * addModule( const char * pszName, const void * pvLib, unsigned cSegInfo = 0, PHLLSEGINFO paSegInfo = NULL ); kHllModuleEntry * addModule( const char * pachName, unsigned cchName, const void * pvLib, unsigned cSegInfo = 0, PHLLSEGINFO paSegInfo = NULL ); BOOL setModName( const char * pszModName ); BOOL setModName( const char * pachModName, int cchModName ); const char * getModName(); /** @cat * Output. */ BOOL write( const char *pszFilename ); APIRET writeToLX( const char *pszFilename ); void writeSym( kFile * pFile ) throw(int); /** @cat * Static read function(s). */ static kHll * readLX( const char *pszFilename ); static kHll * readLXExports( kFileLX *FileLX ) throw(int); static kHll * readSym( kFile *pFile, kFileLX *pFileLX = NULL ) throw(int); /** @cat * Get and queries. */ int queryMaxObjectIndex(); /** @cat * Debug dump function. */ void dump(FILE *ph); void ida(kFile *pFile) throw(int); }; #endif