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