深入了解PHP：用gdb调试源码

作者：bobyzhang，腾讯 IEG 运营开发工程师

php编译时有一个debug模式，这个模式会关闭内存优化，提示内存泄露，屏蔽调用栈优化可以让我们看到完整的php c层面的调用栈。

通常我会编译两个php版（一个正常，一个打开debug）在不同的目录，通过export决定使用哪个。

通过php-config命令可以看到configure-options，修改其中的prefix 和 with-config-file-path 到新的目录，然后添加--enable-debug 命令

yongkbmaster ➜ ~ php-config
Usage: /data/env/runtime/php-7.1.33-debug/bin/php-config [OPTION]
Options:
--prefix [/data/env/runtime/php-7.1.33-debug]
--includes [-I/data/env/runtime/php-7.1.33-debug/include/php -I/data/env/runtime/php-7.1.33-debug/include/php/main -I/data/env/runtime/php-7.1.33-debug/include/php/TSRM -I/data/env/runtime/php-7.1.33-debug/include/php/Zend -I/data/env/runtime/php-7.1.33-debug/include/php/ext -I/data/env/runtime/php-7.1.33-debug/include/php/ext/date/lib]
--ldflags []
--libs [-lcrypt -lz -lexslt -lresolv -lcrypt -lrt -lldap -llber -lpng -lz -ljpeg -lcurl -lbz2 -lz -lrt -lm -ldl -lnsl -lxml2 -lz -lm -ldl -lgssapi_krb5 -lkrb5 -lk5crypto -lcom_err -lssl -lcrypto -lcurl -lxml2 -lz -lm -ldl -lfreetype -lxml2 -lz -lm -ldl -lxml2 -lz -lm -ldl -lcrypt -lxml2 -lz -lm -ldl -lxml2 -lz -lm -ldl -lxml2 -lz -lm -ldl -lxml2 -lz -lm -ldl -lxslt -lxml2 -lz -ldl -lm -lssl -lcrypto -lcrypt ]
--extension-dir [/data/env/runtime/php-7.1.33-debug/lib/php/extensions/debug-non-zts-20160303]
--include-dir [/data/env/runtime/php-7.1.33-debug/include/php]
--man-dir [/data/env/runtime/php-7.1.33-debug/php/man]
--php-binary [/data/env/runtime/php-7.1.33-debug/bin/php]
--php-sapis [ cli fpm phpdbg cgi]
--configure-options [--prefix=/data/env/runtime/php-7.1.33-debug --enable-debug --enable-phpdbg-debug --with-config-file-path=/data/env/runtime/php-7.1.33-debug/etc --with-curl --with-freetype-dir --with-gd --with-gettext --with-iconv-dir --with-kerberos --with-libdir=lib64 --with-libxml-dir --with-mysqli --with-openssl --with-pcre-regex --with-pdo-mysql --with-pdo-sqlite --with-pear --with-png-dir --with-jpeg-dir --with-xmlrpc --with-xsl --with-zlib --with-bz2 --with-mhash --enable-fpm --enable-bcmath --enable-libxml --enable-inline-optimization --enable-gd-native-ttf --enable-mbregex --enable-mbstring --enable-opcache --enable-pcntl --enable-shmop --enable-soap --enable-sockets --enable-sysvsem --enable-sysvshm --enable-xml --enable-zip --with-ldap]
--version [7.1.33]
--vernum [70133]


修改之后大概是这样子，然后编译安装 就可以得到debug版本了

--prefix=/data/env/runtime/php-7.1.33-debug --enable-debug --enable-phpdbg-debug --with-config-file-path=/data/env/runtime/php-7.1.33-debug/etc --with-curl --with-freetype-dir --with-gd --with-gettext --with-iconv-dir --with-kerberos --with-libdir=lib64 --with-libxml-dir --with-mysqli --with-openssl --with-pcre-regex --with-pdo-mysql --with-pdo-sqlite --with-pear --with-png-dir --with-jpeg-dir --with-xmlrpc --with-xsl --with-zlib --with-bz2 --with-mhash --enable-fpm --enable-bcmath --enable-libxml --enable-inline-optimization --enable-gd-native-ttf --enable-mbregex --enable-mbstring --enable-opcache --enable-pcntl --enable-shmop --enable-soap --enable-sockets --enable-sysvsem --enable-sysvshm --enable-xml --enable-zip --with-ldap


php --version中看到DEBUG 就可以了

yongkbmaster ➜ ~ /data/env/runtime/php-7.1.33-debug/bin/php --version
PHP 7.1.33 (cli) (built: Dec 29 2020 19:16:50) ( NTS DEBUG )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.1.0, Copyright (c) 1998-2018 Zend Technologie


注意：Debug版本的扩展需要再次编译安装，不能拷贝正常版本的so，安装方式和普通扩展一致，一般不需要开额外的debug参数。如果你需要调试扩展比如swoole你需要设置扩展的debug参数，可以参考扩展的./configure文件说明。

gdb使用

这里简单介绍一下gdb的基本使用，更详细的使用方法可以自行google。

启动gdb

• 捕获进程

• run 方法启动

• 通过core 文件

• break n :在第n行处设置断点（可以带上代码路径和代码名称）

• b fn1 if a＞b：条件断点设置

• break func（break缩写为b）：在函数func()的入口处设置断点

• delete 断点号n：删除第n个断点

• disable 断点号n：暂停第n个断点

• enable 断点号n：开启第n个断点

• clear 行号n：清除第n行的断点

• info b （info breakpoints） ：显示当前程序的断点设置情况

• delete breakpoints：清除所有断点

• list （简写 l） ，其作用就是列出程序的源代码，默认每次显示10行。

• list 行号：将显示当前文件以“行号”为中心的前后10行代码，

• print a：将显示 a 的值

• continue （简写c ）：继续执行，到下一个断点处（或运行结束）。设置断点后需要按这个。

• next （简写n）：当前函数，下一行

• step （简写s）：跳入函数内部

• where/bt ：当前运行的堆栈列表；

php gdb 小工具

这里就是本文的重点了php为gdb提供了一组小工具，在源代码目录下的.gdbinit文件中，它可以帮助我们更好的gdb php源代码。

准备

为了更好的演示，我这里准备一个php文件。


const A = 'test const';
const B = 'test const B';
class B {
public $a = 'test';
public function funB() {
var_dump('test funB');


class C extends B {
public function funC() {
var_dump('test funC');
}
}

$a = 'test';
$b = ['a1' => 1, 'a2' => 2];
$c = new B();
$d = [A, B];
$e = new C();
$f = $b;

var_dump($a, $b, $c, $d, $e, $f);
get_object_vars($e);


启动gdb，设置2个断点。

gdb php //注意这里要用debug版本的
(gdb) break var.c:211
Breakpoint 1 at 0x76e717: file /data/env/runtime/php-7.1.33-src/ext/standard/var.c, line 211.
(gdb) break zend_object_handlers.c:492
Breakpoint 2 at 0x86ce9d: file /data/env/runtime/php-7.1.33-src/Zend/zend_object_handlers.c, line 492.
(gdb) r test4.php


然后载入小工具

source /data/env/runtime/php-7.1.33-src/.gdbinit
使用

• zbacktrace 显示当前的php调用栈

• dump_bt 查看当前调用栈 和 zbacktrace 类似

• printzv 输出zend value 的情况

• print_global_vars 输出全局变量

• print_const_table 输出定义的常量

• print_zstr 输出zend string

• print_cvs 打印已编译的变量及其值 它需要传入一个zend_execute_data类型的值。可以先bt看一下调用栈。

[0] 'a'
[0x7ffff1614080] (refcount=0) string: test
[1] 'b'
[0x7ffff1614090] (refcount=5) array: Hash(2)[0x7ffff170e300]: {
[0] a1 => [0x7ffff1793e20] long: 1
[1] a2 => [0x7ffff1793e40] long: 2
}

[2] 'c'
[0x7ffff16140a0] (refcount=2) object(B) #2
Properties Hash(1)[0x7ffff170e480]: {
[0] a => [0x7ffff1793f60] indirect: [0x7ffff170e388] (refcount=4) string: test

[3] 'd'
[0x7ffff16140b0] (refcount=2) array: Packed(2)[0x7ffff170e3c0]: {
[0] 0 => [0x7ffff1793688] (refcount=1) string: test const
[1] 1 => [0x7ffff17936a8] (refcount=1) string: test const B
}

[4] 'e'
[0x7ffff16140c0] (refcount=2) object(C) #3
Properties Hash(1)[0x7ffff170e4e0]: {
[0] a => [0x7ffff17940a0] indirect: [0x7ffff170e448] (refcount=4) string: test

[5] 'f'
[0x7ffff16140d0] (refcount=5) array: Hash(2)[0x7ffff170e300]: {
[0] a1 => [0x7ffff1793e20] long: 1
[1] a2 => [0x7ffff1793e40] long: 2
}


• print_ht 输出HashTable, HashTable是php底层一个重要的数据结构是php array的实现方式，你可以理解为是C层面的php array，在php源码中也大量使用HashTable存储各类k v结构或数组结构。

• print_htptr 和 print_ht 类似，它输出的是zval的地址不是zval的值

• print_htstr 和 print_ht 类似，只是HashTable中存的不是zval 而是c char，但是这种情况在源码中好像很少见了，大部分存字符串的情况会直接用zend string，我找了一圈在php_cli_server_mime_type_ctor有一处使用

• print_ft 和 print_ht 类似，只是HashTable中存的是zend_function的地址

• print_inh 输出class相关信息

• print_pi 输出对象中属性相关信息，它需要传入一个zend_property_info类型的地址，在zend_object_handlers.c:492中有使用，php中可以用get_object_vars($e) 触发。

Breakpoint 2, zend_check_property_access (zobj=0x7ffff170e420, prop_info_name=0x7ffff173c2c0) at /data/env/runtime/php-7.1.33-src/Zend/zend_object_handlers.c:492
492 zend_string_release(member);
(gdb) print_pi property_info
[0x7ffff17833c8] {
offset = 0x28
ce = [0x7ffff17831d0] B
flags = 0x100 (ZEND_ACC_PUBLIC)
name = string(1) "a"
default value: [0x7ffff17690c0] (refcount=4) string: test
}


视频号最新视频