PHP内存泄漏看这一篇就够了！
FPM 的黑魔法
首先，传统的跑在 FPM 下的 PHP 代码是没有“内存泄漏”一说的，所谓的内存泄漏就是忘记释放内存，致使进程占用的物理内存(附1)持续增加，得益于 PHP 的短生命周期，PHP 内核有一个关键函数叫作php_request_shutdown此函数会在请求结束后，把请求期间申请的全部内存都释放掉，这从根本上杜绝了内存泄漏，极大的提升了 PHPer 的开发效率，同时也会致使性能的降低，例如单例对象，不必每次请求都从新申请释放这个单例对象的内存。（这也是Swoole等cli方案的优点之一，由于 cli 请求结束不会清理内存）。php
Cli 下的内存泄漏
相信 PHPer 都碰见过这个报错Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 12288 bytes)，是因为向 PHP 申请的内存达到了上限致使的，在 FPM 下必定是由于此次 web 请求有大内存块申请，例如 Sql 查询返回一个超大结果集，但在 Cli 下报这个错大几率是由于你的 PHP 代码出现了内存泄漏。web
常见的泄漏姿式有：api
- 向类的静态属性中追加数据，例如：
//不停的调用foo() 内存就会一直涨
function foo(){
ClassA::$pro[] = "the big string";
}
- 向 $GLOBAL 全局变量中追加数据，例如：
//不停的调用foo() 内存就会一直涨
function foo(){
$GLOBAL['arr'][] = "the big string";
}
- 向函数的静态变量中追加数据，例如：
//不停的调用foo() 内存就会一直涨
function foo(){
static $arr = [];
$arr[] = "the big string";
}
咱们须要检测工具
有的同窗可能会说很简单嘛，把追加的变量在请求结束后unset()掉就能够了。但真实场景远没有你想的那么简单：缓存
- 例一：
function foo()
{
$obj = new ClassA(); //foo函数结束后将自动释放 $obj对象
$obj->pro[] = str_repeat("big string", 1024);
}
while (1) {
foo();
sleep(1);
}
上述代码 Cli 运行起来会泄漏吗？肉眼来看确定不会泄漏，由于foo()函数结束后$obj是栈上的对象自动释放掉了，但答案是可能泄漏也可能没泄漏，这取决于ClassA的定义：
class classA
{
public $pro;
public function __construct()
{
$this->pro = &$GLOBALS['arr']; //pro是其余变量的引用
}
}
若是
ClassA的定义是上面的样子，那么这个例子就是泄漏的！！
- 例二：
class Test
{
public $pro = null;
function run()
{
$var = "Im global var now";//此处 $var 是长生命周期。
$http = new \Swoole\Http\Server("0.0.0.0", 9501, SWOOLE_BASE);
$http->on("request", function($req, $resp) {
//此处没有给类的静态属性赋值，没有给全局变量赋值，
//也没有给函数的静态变量赋值，可是这里是泄漏的，由于 $this 变成长生命周期了。
$this->pro[] = str_repeat("big string", 1024);
$resp->end("hello world");
});
$http->start();
echo "run done\n"; //输出不了
//这个函数永远不会结束，局部变量也变成了"全局变量"
}
}
(new Test())->run();
new Test()的本意虽然是建立一个临时的对象，可是run()方法触发了server->start()方法，代码将不向下执行，run()函数结束不了，run()函数的局部变量$var和临时对象自己均可以视为全局变量了，给其追加数据都是泄漏的！！
- 例三：
因为php_request_shutdown的存在，不少 PHP 扩展实际上是有内存泄漏的(emalloc 后没有 efree)，可是在 FPM 下是能够正常运行的，而这些扩展放到 Cli 下就会有内存泄漏问题，若是没有工具，Cli 下遇到扩展的泄漏问题，那也只能 gg 了-.-！还有就是当咱们调用第三方的类库的函数，要传一个参数，这个参数是全局变量，我不知道这个第三方库会不会给这个参数追加数据，一旦追加数据就会产生泄漏，同理别人给个人函数传的参数我也不敢赋值，第三方函数的返回值有没有全局变量我也不知道。swoole
综上咱们须要一个检测工具，相对于其余语言 PHP 在这个领域是空白的，能够说没有这个工具整个 Cli 生态就没法真正的发展起来，由于复杂的项目都会遇到泄漏问题。并发
Swoole Tracker能够检测泄漏问题，但它是一款商业产品，如今咱们决定重构这个工具，把内存泄漏检测的功能（下文简称Leak工具）彻底免费给 PHP 社区使用，完善 PHP 生态，回馈社区，下面我将概述它的具体用法和工做原理。ide
Swoole Tracker 用法
Leak工具的实现原理是直接拦截系统底层的 emalloc，erealloc，以及 efree 调用，记录一个巨大的指针表，emalloc/erealloc 的时候添加，efree 的时候删除表中的记录，若是请求结束，指针表中仍然有值就证实产生了内存泄漏，不只能发现 PHP 代码的泄漏，扩展层甚至 PHP 语言层面的泄漏都能发现，从根本上杜绝泄漏问题。函数
使用方式很简单：工具
- 前往官网下载最新的 tracker(3.0+) 扩展。
- php.ini 加入如下配置：
extension=swoole_tracker.so ;总开关 apm.enable=1 ;Leak检测开关 apm.enable_malloc_hook=1
- 在 Cli 模式下主业务逻辑必定是能够抽象成循环体函数的，例如
Swoole的OnReceive函数，workerman 的OnMessage函数，以及上文例一中的foo()函数， 在循环体主函数(下文简称主函数)最开始加上trackerHookMalloc()调用便可：
function foo()
{
trackerHookMalloc(); //标记主函数，开始hook malloc
$obj = new ClassA();
$obj->pro[] = str_repeat("big string", 1024);
}
while (1) {
foo();
sleep(1);
}
每次调用主函数结束后（第一次调用不会被记录），都会生成一个泄漏的信息到/tmp/trackerleak日志里面。oop
查看泄漏结果
在 Cli 命令行调用trackerAnalyzeLeak()函数便可分析泄漏日志，生成泄漏报告，能够直接php -r "trackerAnalyzeLeak();"便可。
下面是泄漏报告的格式：
- 没有内存泄漏的状况：
[16916 (Loop 5)] ✅ Nice!! No Leak Were Detected In This Loop
其中16916表示进程 id，Loop 5表示第 5 次调用主函数生成的泄漏信息
- 有肯定的内存泄漏：
[24265 (Loop 8)] /Users/guoxinhua/tests/mem_leak/http_server.php:125 => <span style="color:red">[12928]</span>
[24265 (Loop 8)] /Users/guoxinhua/tests/mem_leak/http_server.php:129 => <span style="color:red">[12928]</span>
[24265 (Loop 8)] ❌ This Loop TotalLeak: <span style="color:red">[25216]</span>
表示第 8 次调用
http_server.php的 125 行和 129 行，分别泄漏了 12928 字节内存，总共泄漏了 25216 字节内存。
经过调用trackerCleanLeak()能够清除泄漏日志，从新开始。
技术特性（技术难点）
- 支持持续增加检测：
想象一个场景，第一次请求运行主函数的时候申请 10 字节内存，而后请求结束前释放掉，而后第二次请求申请了 100 字节，请求结束再释放掉，虽然每次都能正确的释放内存可是每次又都申请更多的内存，最终致使内存爆掉，Leak工具支持这种检测，若是某一行代码有N次(默认 5 次)这种行为就会报"可疑的内存泄漏"，格式以下：
<span style="color:#b0b05f">The Possible Leak As Malloc Size Keep Growth:</span>
/Users/guoxinhua/tests/mem_leak/hook_malloc_incri.php:39 => <span style="color:red"> Growth Times : [8]; Growth Size : [2304]</span>
表示 39 行有 8 次 malloc size 的增加，总共增加了 2304 字节。
- 支持跨 loop 分析：
//Swoole Http Server的OnRequest回调
$http->on("request", function($request, $response) {
trackerHookMalloc();
if(isset(classA::$leak['tmp'])){
unset(classA::$leak['tmp']);//每一次loop都释放上一次loop申请的内存
}
classA::$leak['tmp'] = str_repeat("big string", 1024);//申请内存 并在本次loop结束后不释放
$response->end("hello world");
});
按照正常的检测泄漏的理论，上述代码每次都会检测出泄漏，由于每次都给classA::$leak['tmp']赋值并在 Loop 结束也没有释放，但实际业务代码常常这样写，而且此代码也是不会产生泄漏的，由于本次 Loop 的泄漏会在下次释放掉，Leak工具会跨相邻 2 个Loop 进行分析，自动对冲上面这种状况的泄漏信息，若是是跨多个 Loop 的释放，会以以下格式输出：
[28316 (Loop 2)] /Users/guoxinhua/tests/mem_leak/hook_efree_pre_loop.php:37 => <span style="color:red">[-12288]</span>
<span style="color:#5f92b0">Free Pre (Loop 0) : /Users/guoxinhua/tests/mem_leak/hook_efree_pre_loop.php:42 => [12288]</span>
[28316 (Loop 2)] /Users/guoxinhua/tests/mem_leak/hook_efree_pre_loop.php:42 => <span style="color:red">[12288]</span>
[28316 (Loop 2)] ✅ Nice!! No Leak Were Detected In This Loop
上述信息表示 Loop 2 释放了 Loop 0 的 12288 字节内存，而后 Loop 2 又申请了 12288 字节内存，整体来讲本次 Loop 跑下来没有内存泄漏。
- 支持循环引用状况：
首先简单的介绍一下循环引用问题：
function foo()
{
$o = new classA();
$o->pro[] = $o;
//foo结束后 $o没法释放，由于本身引用了本身，即循环引用
}
while (1) {
foo();
sleep(1);
}
由于循环引用，上面的代码每次运行foo()内存都会增加，可是这个代码确实没有内存泄漏的，由于增加到必定程度 PHP 会开启同步垃圾回收，把这种循环引用的内存都释放掉。
可是这给Leak工具带来了麻烦，由于$o的变量是延迟释放的，foo()结束后会报泄漏，而这种写法又确实不是泄漏。
Swoole Tracker的Leak工具会自动识别上面的状况，会立刻释放循环引用的内存，不会形成误报。
若是你发现你的进程内存一直涨，开启了 Tracker 的泄漏检测，经过
memory_get_usage(false);打印发现内存不涨了，那么证实你的应用存在循环引用，而且原本就没有内存泄漏问题。
- 支持子协程统计：
function loop()
{
trackerHookMalloc();
classA::$leak[] = str_repeat("big string", 1024);//申请内存
go(function() {
echo co::getcid() . "child\n";
go(function() {
echo co::getcid()."child2\n";
classA::$leak = [];//释放内存
});
});
}
Co\run(function(){
while (1) {
loop();
sleep(1);
}
});
上述代码申请的内存会在第二个子协程里面释放，Leak工具会自动识别协程环境，会在全部子协程都结束后才统计汇总，因此上述代码不会有误报状况。
- 支持 defer，context：
$http->on("request", function($request, $response) {
trackerHookMalloc();
$context = Co::getContext();
$context['data'] = str_repeat("big string", 1024);//context会在协程结束自动释放
classA::$leak[] = str_repeat("big string1", 1024);
defer(function() {
classA::$leak = [];//注册defer释放内存
});
$response->end("hello world");
});
Leak工具会自动识别协程环境，若是存在 defer 和 context，会在 defer 执行结束和 context 释放以后再统计汇总，因此上述代码不会有误报状况，固然若是上面没有注册 defer 也会正确的报告泄漏信息。
- 支持旁路函数干扰排除：
例如一个进程由主函数响应请求（OnRequest 等），而后还有个定时器在运行（旁路函数），咱们但愿检测的是主循环函数的泄漏状况，而当主循环函数执行到一半的时候定时器函数执行了,并申请了内存，而后又切回到主循环函数，此时会误报，Leak工具会支持识别出旁路函数而后不收集旁路函数的 malloc 数据。
除了上述这些，Leak工具还支持internd string抓取等等，在此再也不展开。
注意
- 前几回 Loop 的泄漏信息不用管，由于大部分项目都有一些初始化的缓存是不释放的。
- 检测期间尽可能不要有并发。
- 因为开启泄漏检测后性能会很是差，不要在 php.ini 中开启
apm.enable_malloc_hook = 1压测。 - 和 Swoole Tracker2.x 的检查泄漏原理不同，不能一块儿用。
- 一个进程只能有一个地方调用
trackerHookMalloc()函数。 Swoole4.5.3因为底层 api 有问题，Leak工具没法正常工做，请升级到最新版Swoole或者降级Swoole版本。
附件：
- 免费公开课--如何正确查看进程内存占用
