PHP内存泄漏排查：使用Valgrind/Memcheck定位扩展中的内存未释放错误 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

PHP 内存泄漏排查：使用 Valgrind/Memcheck 定位扩展中的内存未释放错误

大家好，今天我们来深入探讨一个在 PHP 扩展开发中经常遇到的问题：内存泄漏。我们将重点介绍如何使用 Valgrind 工具集中的 Memcheck 组件来定位和解决 PHP 扩展中的内存未释放错误。

1. 为什么内存泄漏很重要？

内存泄漏是指程序在分配内存后，由于某种原因未能及时释放，导致这部分内存无法被再次利用。在长时间运行的 PHP 进程（如 FPM）中，即使是很小的内存泄漏，累积起来也会导致严重的性能问题，甚至导致进程崩溃。

性能下降： 可用内存减少，导致频繁的页面交换，影响系统整体性能。
程序崩溃： 可用内存耗尽，导致程序无法继续分配内存，最终崩溃。
安全风险： 某些类型的内存泄漏可能被利用来进行攻击。

因此，在开发 PHP 扩展时，必须高度重视内存管理，避免出现内存泄漏。

2. PHP 扩展中的内存管理

PHP 扩展中使用 Zend 引擎提供的内存管理机制。核心函数包括：

emalloc() / efree(): 分配和释放持久性内存，生命周期与请求周期相同。
pemalloc() / pefree(): 分配和释放请求内存，生命周期与单个请求周期相同。
estrdup(): 复制字符串到持久性内存中。
pestrdup(): 复制字符串到请求内存中。
zval_ptr_dtor(): 释放 zval 指针指向的内存。

正确使用这些函数是避免内存泄漏的关键。例如，如果使用 emalloc() 分配了内存，必须确保在请求结束前使用 efree() 释放。如果使用 pemalloc() 分配了内存，PHP 会在请求结束时自动释放，但仍然需要在逻辑上保证数据的正确性和生命周期。

3. Valgrind/Memcheck 简介

Valgrind 是一套开源的内存调试和分析工具集，其中 Memcheck 是最常用的组件，专门用于检测内存管理问题，包括：

内存泄漏： 检查未释放的内存块。
使用未初始化的内存： 检查在使用之前未被初始化的内存。
非法内存访问： 检查读取或写入已释放的内存，或超出分配内存边界的访问。
内存覆盖： 检查是否覆盖了已分配的内存块。

Valgrind/Memcheck 的工作原理是使用动态二进制插桩技术，在程序运行时插入额外的代码，监控内存的分配、释放和访问，并报告潜在的错误。

4. 使用 Valgrind/Memcheck 检测 PHP 扩展中的内存泄漏

下面我们通过一个简单的例子来演示如何使用 Valgrind/Memcheck 检测 PHP 扩展中的内存泄漏。

示例代码（my_extension.c）:

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "php.h"
#include "php_ini.h"
#include "ext/standard/info.h"
#include "php_my_extension.h"

ZEND_DECLARE_MODULE_GLOBALS(my_extension)

PHP_INI_BEGIN()
    STD_PHP_INI_ENTRY("my_extension.global_value",      "42", PHP_INI_ALL, OnUpdateLong, global_value, zend_my_extension_globals, my_extension_globals)
    STD_PHP_INI_ENTRY("my_extension.global_string", "foobar", PHP_INI_ALL, OnUpdateString, global_string, zend_my_extension_globals, my_extension_globals)
PHP_INI_END()

PHP_FUNCTION(my_hello_world)
{
    char *name = NULL;
    size_t name_len = 0;

    ZEND_PARSE_PARAMETERS_START(0, 1)
        Z_PARAM_OPTIONAL_STR(name, name_len)
    ZEND_PARSE_PARAMETERS_END();

    if (name) {
        php_printf("Hello, %s!n", name);
    } else {
        php_printf("Hello, World!n");
    }

    // 故意泄漏内存
    char *leak = emalloc(1024);
    strcpy(leak, "This is a memory leak!");
    // 忘记释放 leak 了
}

PHP_FUNCTION(my_allocate_and_free)
{
    char *data = emalloc(1024);
    strcpy(data, "Allocated and freed memory");
    efree(data);

    RETURN_TRUE;
}

PHP_MINIT_FUNCTION(my_extension)
{
    REGISTER_INI_ENTRIES();
    return SUCCESS;
}

PHP_MSHUTDOWN_FUNCTION(my_extension)
{
    UNREGISTER_INI_ENTRIES();
    return SUCCESS;
}

PHP_RINIT_FUNCTION(my_extension)
{
#if defined(COMPILE_DL_MY_EXTENSION) && defined(ZTS)
    ZEND_TSRMLS_CACHE_UPDATE();
#endif
    return SUCCESS;
}

PHP_RSHUTDOWN_FUNCTION(my_extension)
{
    return SUCCESS;
}

PHP_MINFO_FUNCTION(my_extension)
{
    php_info_print_table_start();
    php_info_print_table_header(2, "my_extension support", "enabled");
    php_info_print_table_row(2, "Version", PHP_MY_EXTENSION_VERSION);
    php_info_print_table_row(2, "global_value", ZSTR_VAL(MY_EXTENSION_G(global_string)));
    php_info_print_table_end();

    DISPLAY_INI_ENTRIES();
}

const zend_function_entry my_extension_functions[] = {
    PHP_FE(my_hello_world,  NULL)
    PHP_FE(my_allocate_and_free, NULL)
    PHP_FE_END
};

zend_module_entry my_extension_module_entry = {
    STANDARD_MODULE_HEADER,
    "my_extension",
    my_extension_functions,
    PHP_MINIT(my_extension),
    PHP_MSHUTDOWN(my_extension),
    PHP_RINIT(my_extension),
    PHP_RSHUTDOWN(my_extension),
    PHP_MINFO(my_extension),
    PHP_MY_EXTENSION_VERSION,
    STANDARD_MODULE_PROPERTIES
};

#ifdef COMPILE_DL_MY_EXTENSION
#ifdef ZTS
ZEND_TSRMLS_CACHE_DEFINE()
#endif
ZEND_GET_MODULE(my_extension)
#endif

在这个例子中，my_hello_world 函数故意泄漏了 1024 字节的内存。 my_allocate_and_free函数则分配并释放内存。

5. 编译和安装扩展

按照正常的 PHP 扩展开发流程编译和安装这个扩展。

phpize
./configure
make
sudo make install

然后在 php.ini 中启用这个扩展:

extension=my_extension.so

6. 使用 Valgrind/Memcheck 运行 PHP

现在，我们可以使用 Valgrind/Memcheck 运行 PHP 脚本来检测内存泄漏。首先创建一个 PHP 脚本（test.php）:

<?php
echo my_hello_world("John");
echo my_allocate_and_free();
?>

接下来，使用以下命令运行 PHP 脚本：

valgrind --leak-check=full --show-leak-kinds=all php test.php

--leak-check=full: 启用完整的内存泄漏检查。
--show-leak-kinds=all: 显示所有类型的内存泄漏（definite, indirect, possible, reachable）。

7. 分析 Valgrind/Memcheck 的输出

Valgrind/Memcheck 会输出大量的调试信息，我们需要关注的是关于内存泄漏的报告。一个典型的内存泄漏报告如下所示：

==12345== Memcheck, a memory error detector
==12345== Copyright (C) 2002-2017, and GNU GPL'd, by Julian Seward et al.
==12345== Using Valgrind-3.15.0 and LibVEX; rerun with -h for copyright info
==12345== Command: php test.php
==12345==
Hello, John!
1
==12345==
==12345== LEAK SUMMARY:
==12345==    definitely lost: 1,024 bytes in 1 blocks
==12345==      possibly lost: 0 bytes in 0 blocks
==12345==    still reachable: 0 bytes in 0 blocks
==12345==         suppressed: 0 bytes in 0 blocks
==12345==
==12345== For counts of detected and suppressed errors, rerun with: -v
==12345== ERROR SUMMARY: 1 errors from 1 contexts (suppressed: 0 from 0)

definitely lost 表示确定发生了内存泄漏，这部分内存已经无法被程序访问。 still reachable 表示内存虽然没有被释放，但仍然可以通过指针访问到，这种情况可能不是真正的内存泄漏，但仍然需要检查。

更详细的报告会提供泄漏发生的具体位置：

==12345== 1,024 bytes in 1 blocks are definitely lost in loss record 1 of 1
==12345==    at 0x4C2DB8F: malloc (in /usr/lib/valgrind/vgpreload_memcheck-amd64-linux.so)
==12345==    by 0x7F0123456789: emalloc (zend_alloc.c:2895)  <--- emalloc 调用
==12345==    by 0x7F0123457890: zif_my_hello_world (my_extension.c:30)  <--- 函数调用
==12345==    by 0x7F0123458901: execute_ex (zend_vm_execute.h:468)
==12345==    by 0x7F0123459012: zend_call_function (zend_execute_API.c:984)
==12345==    by 0x7F012345A123: zval_ptr_dtor (zend_variables.c:527)
==12345==    by 0x7F012345B234: zend_shutdown (zend.c:1546)
==12345==    by 0x7F012345C345: php_module_shutdown_wrapper (main.c:2316)
==12345==    by 0x7F012345D456: php_request_shutdown (main.c:2196)
==12345==    by 0x7F012345E567: main (main.c:1417)
==12345==

这个报告显示，内存泄漏发生在 my_extension.c 文件的第 30 行，也就是 emalloc() 函数的调用位置。我们可以据此定位到泄漏的代码，并进行修复。

8. 解决内存泄漏

根据 Valgrind/Memcheck 的报告，我们可以修改 my_extension.c 文件，在 my_hello_world 函数中释放内存：

PHP_FUNCTION(my_hello_world)
{
    char *name = NULL;
    size_t name_len = 0;

    ZEND_PARSE_PARAMETERS_START(0, 1)
        Z_PARAM_OPTIONAL_STR(name, name_len)
    ZEND_PARSE_PARAMETERS_END();

    if (name) {
        php_printf("Hello, %s!n", name);
    } else {
        php_printf("Hello, World!n");
    }

    // 故意泄漏内存
    char *leak = emalloc(1024);
    strcpy(leak, "This is a memory leak!");

    // 释放内存
    efree(leak);
}

重新编译和安装扩展，然后再次运行 Valgrind/Memcheck，确认内存泄漏已经解决。

9. 高级技巧和注意事项

抑制错误报告： 对于一些无法避免的内存泄漏（例如，某些第三方库的泄漏），可以使用 Valgrind 的抑制文件来忽略这些错误报告。
自定义内存管理器： 可以使用自定义的内存管理器来更好地控制内存的分配和释放，方便调试和分析。
结合 gdb 调试： 可以结合 gdb 调试器来更深入地分析内存泄漏的原因。
自动化测试： 编写自动化测试用例，定期使用 Valgrind/Memcheck 进行检测，可以及早发现内存泄漏问题。
理解不同的泄漏类型： definite lost是最严重的，必须立即修复。reachable 则需要仔细分析是否真的有必要释放。
关注still reachable的内存： 尽管still reachable的内存不一定是泄漏，但它们可能表明存在未释放的资源或者潜在的性能问题。检查这些内存，确保它们在程序的生命周期中被正确地管理。

10. 表格：常用 Valgrind/Memcheck 选项

选项	描述
`--leak-check=full`	启用完整的内存泄漏检查。
`--show-leak-kinds=all`	显示所有类型的内存泄漏 (definite, indirect, possible, reachable)。
`--track-origins=yes`	跟踪未初始化内存的来源，可以帮助定位使用未初始化内存的问题。
`--log-file=valgrind.log`	将 Valgrind 的输出保存到文件中。
`--suppressions=suppressions.txt`	指定抑制文件，用于忽略某些已知的错误报告。

11. 一些常见的内存管理错误以及如何避免

错误类型	描述	如何避免
未释放已分配的内存	使用`emalloc`或`pemalloc`分配的内存，在不再使用时没有使用`efree`或`pefree`释放。	确保每次分配内存后，都有对应的释放操作。使用智能指针或者资源管理类来自动释放内存。
重复释放内存	同一块内存被`efree`或`pefree`释放了多次。	在释放内存后，将指针设置为`NULL`。避免在多个地方释放同一块内存。
使用已释放的内存	在内存被释放后，仍然尝试访问或修改该内存。	避免使用悬挂指针。在释放内存后，将指针设置为`NULL`。
内存越界访问	尝试读取或写入超出已分配内存块边界的内存。	确保访问内存的索引或指针在有效范围内。使用数组边界检查或指针算术运算时要小心。
使用未初始化的内存	尝试使用未初始化的变量或内存。	在使用变量或内存之前，始终对其进行初始化。
缓冲区溢出	将数据写入缓冲区时，写入的数据超过了缓冲区的大小。	确保缓冲区的大小足够容纳要写入的数据。使用安全的字符串操作函数，如`strncpy`和`snprintf`。
忘记释放`zval`中的资源	在使用`zval`时，如果`zval`包含指针类型的数据（如字符串或数组），在不再使用`zval`时，需要使用`zval_ptr_dtor`释放其包含的资源。	确保在不再使用`zval`时，调用`zval_ptr_dtor`释放其包含的资源。

总结：细心排查，防微杜渐

内存泄漏是一个隐蔽但危害极大的问题，需要我们在开发过程中始终保持警惕。通过 Valgrind/Memcheck 等工具，我们可以有效地检测和解决内存泄漏问题，提高 PHP 扩展的稳定性和性能。记住，预防胜于治疗，养成良好的编码习惯，是避免内存泄漏的关键。

PHP 内存泄漏排查：使用 Valgrind/Memcheck 定位扩展中的内存未释放错误

发表回复 取消回复

发表回复取消回复