linux c 程式碼測試之記憶體越界及記憶體洩露
記憶體越界是我們軟體開發中經常遇到的一個問題。不經意間的複製常常導致很嚴重的後果。經常使用memset、memmove、strcpy、strncpy、strcat、sprintf的朋友肯定對此印象深刻,下面就是我個人在開發中實際遇到的一個開發問題,頗具典型。
- #define MAX_SET_STR_LENGTH 50
- #define MAX_GET_STR_LENGTH 100
- int* process(char* pMem, int size)
- {
- char localMemory[MAX_SET_STR_LENGTH] = {0};
-
int* pData = NULL;
- /* code process */
- memset(localMemory, 1, MAX_GET_STR_LENGTH);
- memmove(pMem, localMemory, MAX_GET_STR_LENGTH);
- return pData;
- }
這段程式碼看上去沒有什麼問題。我們本意是對localMemory進行賦值,然後拷貝到pMem指向的記憶體中去。其實問題就出在這一句memset的大小。根據localMemory初始化定義語句,我們可以看出localMemory其實最初的申明大小隻有MAX_SET_STR_LENGTH,但是我們賦值的時候,卻設定成了MAX_GET_STR_LENGTH。之所以會犯這樣的錯誤,主要是因為MAX_GET_STR_LENGTH和MAX_SET_STR_LENGTH極其相似。這段程式碼編譯後,產生的後果是非常嚴重的,不斷沖垮了堆疊資訊,還把返回的int*設定成了非法值。
那麼有沒有什麼好的辦法來處理這樣一個問題?我們可以換一個方向來看。首先我們檢視,在軟體中存在的資料型別主要有哪些?無非就是全域性資料、堆資料、棧臨時資料。搞清楚了需要控制的資料之後,我們應該怎麼對這些資料進行監控呢,一個簡單有效的辦法就是把memset這些函式替換成我們自己的函式,在這些函式中我們嚴格對指標的複製、拷貝進行判斷和監督。
(1)事實上,一般來說malloc的資料是不需要我們監督的,因為記憶體分配的時候,通常庫函式會比我們要求的size多分配幾個位元組,這樣在free的時候就可以判斷記憶體的開頭和結尾處有沒有指標溢位。朋友們可以試一下下面這段程式碼。
-
void
- {
- char* pMem = (char*)malloc(100);
- pMem[-1] = 100;
- pMem[100] = 100;
- free(pMem);
- }
(2)堆全域性資料和棧臨時資料進行處理時,我們利用memset初始化記錄全域性指標或者是堆疊臨時指標
a) 首先對memset處理,新增下面一句巨集語句
#define memset(param, value, size) MEMORY_SET_PROCESS(__FUNCTION__, __LINE__, param, value, size)
b) 定義記憶體節點結構
- typedefstruct _MEMORY_NODE
- {
- char functionName[64];
- int line;
- void* pAddress;
- int size;
- struct _MEMORY_NODE* next;
- }MEMORY_NODE;
其中functionName記錄了函式名稱,line記錄檔案行數, pAddress記錄了指標地址, size指向了pAddress指向的記憶體大小,next指向下一個結構節點。
c)記錄記憶體節點屬性
在MEMORY_SET_PROCESS處理過程中,不僅需要呼叫memset函式,還需要對當前記憶體節點進行記錄和儲存。可以通過使用單鏈表節點的方法進行記錄。但是如果發現pAddress指向的記憶體是malloc時候分配過的,此時就不需要記錄了,因為堆記憶體指標溢位的問題lib庫已經幫我們解決了。
d)改造原有記憶體指標操作函式
比如對memmove等函式進行改造,不失去一般性,我們就以memmove作為範例。
新增巨集語句 #define memmove(dst, src, size) MEMMOVE_PROCESS(dst, src, size)
- void MEMMOVE_PROCESS(void* dst, constvoid* src, int size)
- {
- MEMORY_NODE* pMemNode = check_node_exist(dst);
- if(NULL == pMemNode) return;
- assert(dst >= (pMemNode->pAddress));
- assert(((char*)dst + size) <= ((char*)pMemNode->pAddress + pMemNode->size));
- memmove(dst, src, size);
- return;
- }
e)下面就是記憶體節點的刪除工作。
我們知道函式是需要反覆使用堆疊的。不同時間相同的堆疊地址對應的是完全不同的指標內容,這就要求我們在函式返回的時候對記憶體地址進行清理,把記憶體節點從對應的連結串列刪除。
我們知道在函式執行後,ebp和esp之間的記憶體就是通常意義上臨時變數的生存空間,所以下面的一段巨集就可以記錄函式的記憶體空間。
- #ifdef MEMORY_LEAK_TEST
- #define FUNCTION_LOCAL_SPACE_RECORD()\
- {\
- int* functionBpRecord = 0;\
- int* functionSpRecord = 0;\
- }
- #else
- #define FUNCTION_LOCAL_SPACE_RECORD()
- #endif
- #ifdef MEMORY_LEAK_TEST
- #define FUNCTION_LEAVE_PROCESS()\
- {\
- __asm { mov functionBpRecord, bp\
- mov functionSpRecord, sp}\
- FREE_MEMORY_NODE(functionBpRecord, functionSpRecord)\
- }
- #else
- #define FUNCTION_LEAVE_PROCESS()
- #endif
這兩段巨集程式碼,需要插在函式的起始位置和結束的位置,這樣在函式結束的時候就可以根據ebp和esp刪除堆疊空間中的所有記憶體,方便了堆疊的重複使用。如果是全域性記憶體,因為函式的變化不會導致地址的變化,所以沒有必要進行全域性記憶體節點的處理。
記憶體溢位檢查流程總結:
(1)對memset進行重新設計,記錄除了malloc指標外的一切記憶體;
(2)對memmove, strcpy, strncpy,strcat,sprintf等全部函式進行重新設計,因為我們需要對他們的指標執行範圍進行判斷;
(3)在函式的開頭和結尾位置新增巨集處理。函式執行返回前進行節點清除。
在我們個人程式設計的過程當中,記憶體洩露雖然不會像記憶體溢位那樣造成各種莫名奇妙的問題,但是它的危害也是不可忽視的。一方面,記憶體的洩露導致我們的軟體在執行過程中佔用了越來越多的記憶體,佔有資源而又得不到及時清理,這會導致我們程式的效率越來越低;另一方面,它會影響我們使用者的體驗,失去市場的競爭能力。
常見的記憶體洩露是這樣的:
- void process(int size)
- {
- char* pData = (char*)malloc(size);
- /* other code */
- return; /* forget to free pData */
- }
記憶體洩露的危害是不言而喻的,但是查詢記憶體洩露卻是一件苦難而且複雜的工作。我們都知道,解決bug是一件非常簡單的事情,但是尋找bug的出處卻是一件非常吃力的事情。因此,我們有必要在自己編寫程式碼的時候,就把查詢記憶體洩露的工作放在很重要的位置上面。那麼有沒有什麼辦法來解決這一問題呢?
我想要做到解決記憶體洩露,必須做到下面兩個方面:
(1)必須記錄記憶體在哪個函式申請的,具體檔案的行數是多少
(2)記憶體應該什麼時候被釋放
要完成第1個條件其實並不困難。我們可以用節點的方法記錄我們申請的記憶體:
a)設定節點的資料結構
- typedefstruct _MEMORY_NODE
- {
- char functionName[64];
- int line;
- void* pAddress;
- struct _MEMORY_NODE* next;
- }MEMORY_NODE;
b)修改記憶體的分配函式
對業務側的malloc進行函式修改,新增下面一句巨集語句
#define malloc(param) MemoryMalloc(__FUNCTION__, __LINE__, param)
在樁函式側書寫下面的程式碼
- void* MemoryMalloc(constchar* name, int line, int size)
- {
- void* pData = (void*)malloc(size);
- MEMORY_NODE* pMemNode = NULL;
- if(NULL == pData) return NULL;
- memset((char*)pData, 0, size);
- pMemNode = (MEMORY_NODE*)malloc(sizeof(MEMORY_NODE));
- if(NULL == pMemNode){
- free(pData);
- return NULL;
- }
- memset((char*)pMemNode, 0, sizeof(MEMORY_NODE));
- memmove(pMemNode->functionName, name, strlen(name));
- pMemNode->line = line;
- pMemNode->pAddress = pData;
- pMemNode->next = NULL;
- add_memory_node(pMemNode);
- return pData;
- }
記憶體的分配過程中還涉及到了節點的新增,所以我們還需要新增下面的程式碼
- static MEMORY_NODE* gMemNode = NULL;
- void add_memory_node(MEMORY_NODE* pMemNode)
- {
- MEMORY_NODE* pNode = gMemNode;
- if(NULL == pMemNode) return;
- if(NULL == gMemNode){
- gMemNode = pMemNode;
- return;
- }
- while(NULL != pNode->next){
- pNode = pNode->next;
- }
- pNode->next = pMemNode;
- return;
- }
完成了第一個條件之後,我們就要對第二個條件進行完成。
a)記憶體什麼時候釋放,這取決於我們在函式中是怎麼實現的,但是我們在編寫測試用例的時候卻是應該知道記憶體釋放沒有,比如說如果測試用例全部結束了,我們有理由相信assert(gMemNode == NULL)這應該是恆等於真的。
b)記憶體釋放的時候,我們應該做些什麼?和節點的新增一樣,我們在記憶體釋放的時候需要free指定的記憶體,free節點,free節點的記憶體,下面就是在釋放的時候我們需要進行的操作
對業務側的free函式進行修改,新增下面一句巨集程式碼,
#define free(param) MemoryFree(param)
在樁函式側輸入下面的程式碼:
- void MemoryFree(void* pAddress)
- {
- if(NULL == pAddress) return;
- delete_memory_node(pAddress);
- free(pAddress);
- }
在刪除記憶體的時候,需要刪除節點,刪除節點的記憶體
- void delete_memory_node(void* pAddress)
- {
- MEMORY_NODE* pHead = gMemNode;
- MEMORY_NODE* pMemNode = gMemNode;
- while(NULL != pMemNode){
- if(pAddress == pMemNode->pAddress)
- break;
- pMemNode = pMemNode->next;
- }
- if(NULL == pMemNode) {
- assert(1 == 0);
- return;
- }
- while(pMemNode != pHead->next){
- pHead = pHead->next;
- }