使用valgrind檢查記憶體問題

作者：[email protected]

部落格：blog.focus-linux.net   linuxfocus.blog.chinaunix.net 

本文的copyleft歸[email protected]所有，使用GPL釋出，可以自由拷貝，轉載。但轉載請保持文檔的完整性，注明原作者及原連結，嚴禁用于任何商業用途。

======================================================================================================

工欲善其事，必先利其器。Valgrind作為一個免費且優秀的工具包，平時大部分人可能都是使用valgrind檢測記憶體問題，如記憶體洩露，越界等。其實Valgrind的用途遠不止于此，其實際上為一個工具包，除了檢查記憶體問題以外，還有其它多項用途。我準備将其大緻介紹一下。本不想再介紹Valgrind檢測記憶體問題的用法的，但是又一想，畢竟這是Valgrind的一個最有名的用途，如果少了它，不免有些遺憾，是以還是把檢查記憶體問題作為第一篇吧。

請看一下代碼：

#include stdlib.h>

#include stdio.h>

#include string.h>

static void mem_leak1(void)

{

    char *p = malloc(1);

}

static void mem_leak2(void)

    FILE *fp = fopen("test.txt", "w");

static void mem_overrun1(void)

    *(short*)p = 2;

    free(p);

static void mem_overrun2(void)

    char array[5];

    strcpy(array, "hello");

static void mem_double_free(void)

static void mem_use_wild_pointer(void)

    char *p = (void*)0x80184800;

    *p = 1;

static void mem_free_wild_pointer(void)

    char *p;

int main()

    mem_leak1();

    mem_leak2();

    mem_overrun1();

    mem_overrun2();

    mem_double_free();

    //mem_use_wild_pointer();

    mem_free_wild_pointer();

    return 0;

這裡一共列出了七種常見的記憶體問題：1. 動态記憶體洩露；2. 資源洩露，這裡以檔案描述符為例；3. 動态記憶體越界；4.數組記憶體越界；5.動态記憶體double free；6.使用野指針，即未初始化的指針；7.釋放野指針，即未初始化的指針；其中由于本示例代碼過于簡單，第6中情況，使用野指針會直接導緻crash，是以在main中，并沒有真正的調用那個示例代碼。由于valgrind隻能檢測執行到的代碼，是以在後面的報告中，不會報告第6種錯誤情況。但是，在大型的項目中，有可能使用野指針并不會導緻程式crash。另外上面的7中情況，有些情況嚴格的說，實際上可以歸為一類。

下面看怎樣執行valgrind來檢測記憶體錯誤：

valgrind --track-fds=yes --leak-check=full --undef-value-errors=yes ./a.out

上面那些option的具體含義，可以參加valgrind --help，其中有些option預設就是打開的，不過我習慣于明确的使用option，以示清晰。

看執行後的報告：

==2326== Memcheck, a memory error detector

==2326== Copyright (C) 2002-2009, and GNU GPL'd, by Julian Seward et al.

==2326== Using Valgrind-3.5.0 and LibVEX; rerun with -h for copyright info

==2326== Command: ./a.out

==2326==

/* 這裡檢測到了動态記憶體的越界，提示Invalid write。*/

==2326== Invalid write of size 2

==2326== at 0x80484B4: mem_overrun1 (in /home/fgao/works/test/a.out)

==2326== by 0x8048553: main (in /home/fgao/works/test/a.out)

==2326== Address 0x40211f0 is 0 bytes inside a block of size 1 alloc'd

==2326== at 0x4005BDC: malloc (vg_replace_malloc.c:195)

==2326== by 0x80484AD: mem_overrun1 (in /home/fgao/works/test/a.out)

 /* 這裡檢測到了double free問題，提示Invalid Free */

==2326== Invalid free() / delete / delete[]

==2326== at 0x40057F6: free (vg_replace_malloc.c:325)

==2326== by 0x8048514: mem_double_free (in /home/fgao/works/test/a.out)

==2326== by 0x804855D: main (in /home/fgao/works/test/a.out)

==2326== Address 0x4021228 is 0 bytes inside a block of size 1 free'd

==2326== by 0x8048509: mem_double_free (in /home/fgao/works/test/a.out)

/* 這裡檢測到了未初始化變量 */

==2326== Conditional jump or move depends on uninitialised value(s)

==2326== at 0x40057B6: free (vg_replace_malloc.c:325)

==2326== by 0x804853C: mem_free_wild_pointer (in /home/fgao/works/test/a.out)

==2326== by 0x8048562: main (in /home/fgao/works/test/a.out)

 /* 這裡檢測到了非法是否野指針 */

/* 

這裡檢測到了檔案指針資源的洩露，下面提示說有4個檔案描述符在退出時仍是打開的。

描述符0,1,2無需關心，通過報告，可以發現程式中自己明确打開的檔案描述符沒有關閉。

*/

==2326== FILE DESCRIPTORS: 4 open at exit.

==2326== Open file descriptor 3: test.txt

==2326== at 0x68D613: __open_nocancel (in /lib/libc-2.12.so)

==2326== by 0x61F8EC: __fopen_internal (in /lib/libc-2.12.so)

==2326== by 0x61F94B: fopen@@GLIBC_2.1 (in /lib/libc-2.12.so)

==2326== by 0x8048496: mem_leak2 (in /home/fgao/works/test/a.out)

==2326== by 0x804854E: main (in /home/fgao/works/test/a.out)

==2326== Open file descriptor 2: /dev/pts/4

==2326== Open file descriptor 1: /dev/pts/4

==2326== Open file descriptor 0: /dev/pts/4

/* 堆資訊的總結：一共調用4次alloc，4次free。之是以正好相等，因為上面有一函數少了free，有一個函數多了一個free */

==2326== HEAP SUMMARY:

==2326== in use at exit: 353 bytes in 2 blocks

==2326== total heap usage: 4 allocs, 4 frees, 355 bytes allocated

/* 檢測到一個位元組的記憶體洩露 */

==2326== 1 bytes in 1 blocks are definitely lost in loss record 1 of 2

==2326== by 0x8048475: mem_leak1 (in /home/fgao/works/test/a.out)

==2326== by 0x8048549: main (in /home/fgao/works/test/a.out)

/* 記憶體洩露的總結 */

==2326== LEAK SUMMARY:

==2326== definitely lost: 1 bytes in 1 blocks

==2326== indirectly lost: 0 bytes in 0 blocks

==2326== possibly lost: 0 bytes in 0 blocks

==2326== still reachable: 352 bytes in 1 blocks

==2326== suppressed: 0 bytes in 0 blocks

==2326== Reachable blocks (those to which a pointer was found) are not shown.

==2326== To see them, rerun with: --leak-check=full --show-reachable=yes

==2326== For counts of detected and suppressed errors, rerun with: -v

==2326== Use --track-origins=yes to see where uninitialised values come from

==2326== ERROR SUMMARY: 5 errors from 5 contexts (suppressed: 12 from 8)

這個隻是一個簡單的示例程式，即使沒有Valgrind，我們也可以很輕易的發現問題。但是在真實的項目中，當代碼量達到萬行，十萬行，甚至百萬行時。由于申請的記憶體可能不是在一個地方使用，不可避免的被傳來傳去。這時，如果光是看review代碼來檢查問題，可能很難找到根本原因。這時，使用Valgrind則可以很容易的發現問題所在。

當然，Valgrind也不是萬能的。我也遇到過Valgrind無法找到問題，反而我通過不斷的review代碼找到了症結。發現問題，解決問題，畢竟是末流。最好的方法，就是不引入記憶體問題。這可以通過良好的代碼風格和設計來實作的。

寫代碼不是那麼容易的。要用心，把代碼當作自己的作品，真心的去寫好它。這樣，自然而然的就會把代碼寫好。