用valgrind檢測php擴展內存洩露

原文：https://bugs.php.net/bugs-getting-valgrind-log.php

前提

1，編譯php的時候，必須要帶上--enable-debug選項。

2，禁用php的內存管理。

禁用Zend MM

Zend虛擬機使用了自己的程序來優化內存管理，因此，valgrind無法探測到大部分的內存問題。在使用valgrind執行php之前，你必須禁用Zend自帶的內存管理器。禁用方式為將環境變量USE_ZEND_ALLOC設置成0。

export USE_ZEND_ALLOC=0

或者

setenv USE_ZEND_ALLOC 0

上述方式適用於php5.2及以上的版本。5.2之前的php需要在編譯的時候帶上--disable-zend-memory-manager選項。

使用共享擴展

為了能在valgrind中正確顯示extension的內存堆棧，需要設置：

export ZEND_DONT_UNLOAD_MODULES=1

或者

setenv ZEND_DONT_UNLOAD_MODULES 1

該設置作用於PHP 5.3.11及之後的版本。

編者注：舉例來說，如果不設置ZEND_DONT_UNLOAD_MODULES，valgrind可能會報告

$ valgrind --leak-check=full --show-reachable=yes php test.php
...
==25829== 8 bytes in 1 blocks are indirectly lost in loss record 2 of 21
==25829==    at 0x4C25E84: ???
==25829==    by 0xCE440DC: ???
==25829==    by 0xCE44316: ???
==25829==    by 0xCE44368: ???
==25829==    by 0xCBEE55F: ???
==25829==    by 0xCBD3F87: ???
==25829==    by 0x949A85: zend_activate_modules (zend_API.c:2285)
==25829==    by 0x8B5EBC: php_request_startup (main.c:1491)
==25829==    by 0xA84F7B: main (php_cli.c:1356)
...

如果設置ZEND_DONT_UNLOAD_MODULES，則會顯示如下

$ valgrind --leak-check=full --show-reachable=yes php test.php
...
==25824== 8 bytes in 1 blocks are still reachable in loss record 2 of 30
==25824==    at 0x4C25E84: calloc (in /usr/lib/valgrind/vgpreload_memcheck.so)
==25824==    by 0xCE440DC: event_base_priority_init (in /usr/lib/libevent-1.4.so.2.1.3)
==25824==    by 0xCE44316: event_base_new (in /usr/lib/libevent-1.4.so.2.1.3)
==25824==    by 0xCE44368: event_init (in /usr/lib/libevent-1.4.so.2.1.3)
==25824==    by 0xCBEE55F: zm_activate_http_request_pool (http_request_pool_api.c:58)
==25824==    by 0xCBD3F87: zm_activate_http (http.c:373)
==25824==    by 0x949A85: zend_activate_modules (zend_API.c:2285)
==25824==    by 0x8B5EBC: php_request_startup (main.c:1491)
==25824==    by 0xA84F7B: main (php_cli.c:1356)
...

使用CLI，web server內建或者CGI方式來執行php

為了使php CLI/CGI生成valgrind日志，你需要用以下命令來執行：

valgrind --tool=memcheck --num-callers=30 --log-file=php.log /path/to/php-cli script.php

這樣會將log輸出到當前目錄下的php.log文件中。

如果要檢測web server內建的php，需要對CLI可執行文件使用適當的-S和-t參數。然後通過浏覽器請求來執行，再看php.log中的valgrind錯誤。

通過valgrind執行PHP Apache module

如果你是靜態編譯php和apache，那麼需要確保apache的bin沒有在make install之後被分離，否則會丟失所需的調試信息。檢測如下，執行/path/to/httpd，這樣會輸出一些東西（例如not stripped）

$ file /usr/local/apache2/bin/httpd

/usr/local/apache2/bin/httpd: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), for GNU/Linux 2.6.4, dynamically linked (uses shared libs), not stripped

如果要針對apache的php mod來生成valgrind的檢測報告，你需要在valgrind下運行apache：

valgrind --tool=memcheck --num-callers=30 --log-file=apache.log /usr/local/apache/bin/httpd -X

通過浏覽器請求來訪問，所有的內存錯誤都會輸出到apache.log中。