TypeInfo模塊是Doom3中用于動(dòng)態(tài)類型識(shí)別(RTTI)和輔助查錯(cuò)的模塊,可以檢測(cè)類中未初始化變量、打印某種類型的對(duì)象中所有成員變量的值,或打印整個(gè)程序中所有實(shí)體對(duì)象(idEntity)的值。在寫程序過程中,可能經(jīng)常會(huì)出現(xiàn)一些由于未對(duì)成員變量初始化而導(dǎo)致的問題。而這類問題一般在Debug模式下沒有問題,在Release版本中偶爾出現(xiàn),這導(dǎo)致很難定位與問題相關(guān)的代碼。
除了檢測(cè)未初始化的內(nèi)存,其他方面的應(yīng)用,可以從TypeInfo.h中的幾個(gè)函數(shù)可以略窺一二。
/*
===================================================================================
Game Type Info
===================================================================================
*/
// 根據(jù)偏移取得變量名
const char * GetTypeVariableName( const char *typeName, int offset );
// 打印某個(gè)對(duì)象的信息
void PrintType( const void *typePtr, const char *typeName );
// 將某對(duì)象值寫入文件
void WriteTypeToFile( idFile *fp, const void *typePtr, const char *typeName );
// 給某對(duì)象的所有變量設(shè)定一個(gè)初始值
void InitTypeVariables( const void *typePtr, const char *typeName, int value );
// 列舉所有類型信息
void ListTypeInfo_f( const idCmdArgs &args );
// 將所有游戲狀態(tài)(所有idEntity信息)寫入文件
void WriteGameState_f( const idCmdArgs &args );
// 比較游戲狀態(tài)
void CompareGameState_f( const idCmdArgs &args );
// 測(cè)試保存游戲
void TestSaveGame_f( const idCmdArgs &args );
經(jīng)過幾天的努力,我將TypfInfo相關(guān)的代碼提取出,單獨(dú)創(chuàng)建了工程文件,并做了簡(jiǎn)單的代碼演示。有愛好的同學(xué)可以深入研究。點(diǎn)擊這里下載。在工程(
vs2010) 中,Example是一個(gè)簡(jiǎn)單的演示程序,idLib是對(duì)Doom3源碼中idLib的刪減版本。TypeInfo是生成GameTypeInfo.h類型信息的控制臺(tái)工具。
TypeInfo的用法為 typeinfo.exe [source_code_path] [out_file_name]
實(shí)現(xiàn):
TypeInfo檢測(cè)未初始化內(nèi)存實(shí)現(xiàn)原理為,對(duì)代碼中所有的頭文件掃描分析,并將類型中,變量名,變量類型等信息記錄生成一個(gè)GameTypeInfo.h文件。然后在new一個(gè)對(duì)象時(shí),會(huì)先將這個(gè)對(duì)象的內(nèi)存初始化為0xcdcdcdcd。當(dāng)對(duì)象構(gòu)造完成時(shí),檢測(cè)對(duì)象內(nèi)存中是否有某值為0xcdcdcdcd,如果有,就通過GameTypeInfo.h中記錄的類型,變量名,偏移等信息將未初始化的變量信息打印出來。
將上述過程分為三段內(nèi)容:1. 解析 2. 生成類型信息 3. 利用類型信息
1. 解析:
基本的詞法解析在idLib中實(shí)現(xiàn),相關(guān)類為idToken, idLexer, idParser。
2. 生成類型信息
idTypeInfoGen利用idParser來解析代碼頭文件,記錄相關(guān)類型信息,類型信息包括:常量,枚舉量和類(包括結(jié)構(gòu)體)
// 常量信息
typedef struct {
const char * name;
const char * type;
const char * value;
} constantInfo_t;
// 枚舉形變量信息
typedef struct {
const char * name;
int value;
} enumValueInfo_t;
// 枚舉類型信息
typedef struct {
const char * typeName;
const enumValueInfo_t * values;
} enumTypeInfo_t;
// 類成員變量信息
typedef struct {
const char * type;
const char * name;
int offset;
int size;
} classVariableInfo_t;
// 類的類型信息(包括結(jié)構(gòu)體)
typedef struct {
const char * typeName;
const char * superType;
int size;
const classVariableInfo_t * variables;
} classTypeInfo_t;
所有信息記錄在GameTypeInfo.h中,詳細(xì)內(nèi)容可以查閱源代碼。
3. 對(duì)類型信息的利用
3.1 通過類型名創(chuàng)建實(shí)例。在Doom3程序的GamePlay層,主要的類都是從idClass繼承下來的,并且在類聲明和定義時(shí),通過idTypeInfo記錄類型信息,包括記錄類之間的父子關(guān)系。在類中加入宏CLASS_PROTOTYPE, CLASS_DECLARATION來實(shí)現(xiàn)。
創(chuàng)建類實(shí)例時(shí)是這樣的:
idTypeInfo *cls;
idClass *obj;
cls = idClass::GetClass( "idPlayer" );
obj = cls->CreateInstance();
3.2 輸出未初始化變量的名稱。
idClass中重載了new操作符,以便記錄內(nèi)存的使用量和創(chuàng)建的對(duì)象個(gè)數(shù),如果需要檢測(cè)未初始化的內(nèi)存,還會(huì)將內(nèi)存初始化為0xcdcdcdcd。
void * idClass::operator new( size_t s ) {
int *p;
s += sizeof( int );
p = (int *)Mem_Alloc( s );
*p = s;
memused += s;
numobjects++;
#ifdef ID_DEBUG_UNINITIALIZED_MEMORY
unsigned long *ptr = (unsigned long *)p;
int size = s;
assert( ( size & 3 ) == 0 );
size >>= 2;
for ( int i = 1; i < size; i++ ) {
ptr[i] = 0xcdcdcdcd;
}
#endif
return p + 1;
}
對(duì)象創(chuàng)建后,調(diào)用FindUninitializedMemory來檢測(cè)未初始化的內(nèi)存
/*
================
idClass::FindUninitializedMemory
================
*/
void idClass::FindUninitializedMemory( void ) {
#ifdef ID_DEBUG_UNINITIALIZED_MEMORY
unsigned long *ptr = ( ( unsigned long * )this ) - 1;
int size = *ptr;
assert( ( size & 3 ) == 0 );
size >>= 2;
ptr = ( unsigned long * )this;
for ( int i = 0; i < size; i++ ) {
if ( ptr[i] == 0xcdcdcdcd ) {
const char *varName = GetTypeVariableName( GetClassname(), i << 2 );
idLib::Warning( "type '%s' has uninitialized variable %s (offset %d)", GetClassname(), varName, i << 2 );
}
}
#endif
}
這里通過 GetTypeVariableName 在類型信息表中查找變量名稱。
3.3打印輸出某個(gè)實(shí)例的所有成員變量值。
代碼實(shí)現(xiàn)在TypeInfo.cpp文件中,沒有仔細(xì)研究這段代碼實(shí)現(xiàn),就不在這里單列了。