PHP调试的强悍利器之PHPDBG

这篇文章主要为大家详细介绍了PHP调试的强悍利器之PHPDBG的相关资料,感兴趣的小伙伴们可以参考一下。

PHPDBG是一个PHP的SAPI模块,可以在不用修改代码和不影响性能的情况下控制PHP的运行环境。

PHPDBG的目标是成为一个轻量级、强大、易用的PHP调试平台,可以在PHP5.4和之上版本中使用。在php5.6和之上版本将内部集成。

主要功能:

– 单步调试

– 灵活的下断点方式(类方法、函数、文件:行、内存地址、opcode)

– 可直接调用php的eval

– 可以查看当前执行的代码

– 用户空间API(userland/user space)

– 方便集成

– 支持指定php配置文件

– JIT全局变量

– readline支持(可选),终端操作更方便

– 远程debug,使用java GUI

– 操作简便(具体看help)

安装

为了使用phpdgb,你首先需要下载一个php的源码包。然后下载phpdgb的源码包,并放在php源码包的sapi目录下,最后,你就可以执行命令安装了,编译安装示例如下:

假设我们已经下载php的源码包,并放在了/home/php目录下。

  1. #cd /home/php/sapi
  2. #git clone https://github.com/krakjoe/phpdbg
  3. #cd ../
  4. #./buildconf --force
  5. #./config.nice
  6. #make -j8
  7. #make install-phpdbg

注意:

1、如果你的php版本是php5.6或者更高的版本,phpdbg已经集成在php的代码包中,无需单独下载了。

2、编译参数中记得要加 –enable-phpdbg。

3、编译时参数,–with-readline 可以选择性添加。如果不添加,phpdbg的history等功能无法使用。

基本使用

1、参数介绍

phpdbg是php的一个sapi,它可以以命令行的方式调试php,常用参数如下:

  1. The following switches are implemented (just like cli SAPI):
  2. -n ignore php ini
  3. -c search for php ini in path
  4. -z load zend extension
  5. -d define php ini entry
  6. The following switches change the default behaviour of phpdbg:
  7. -v disables quietness
  8. -s enabled stepping
  9. -e sets execution context
  10. -b boring – disables use of colour on the console
  11. -I ignore .phpdbginit (default init file)
  12. -i override .phpgdbinit location (implies -I)
  13. -O set oplog output file
  14. -q do not print banner on startup
  15. -r jump straight to run
  16. -E enable step through eval()
  17. Note: passing -rr will cause phpdbg to quit after execution, rather than returning to the console

2、常用功能

之前我们介绍过gdb工具。其实phpdbg和gdb功能有些地方非常相似。如,可以设置断点,可以单步执行,等。只是他们调试的语言不一样,gdb侧重于调试c或者c++语言,而phpdbg侧重于调试php语言。下面我们将对phpdbg的一些常用调试功能做下介绍。要调试的代码如下:

文件test_phpdbg_inc.php源代码如下:

  1. <?php
  2. function phpdbg_inc_func()
  3. {
  4. echo "phpdbg_inc_func \n";
  5. }
  6. ?>

文件test_phpdgb.php的源代码如下:

  1. <?php
  2. include(dirname(__FILE__)."/test_phpdbg_inc.php");
  3. class demo{
  4. public function __construct(){
  5. echo __METHOD__.":".__LINE__."\n";
  6. }
  7. public function func($param){
  8. $param++;
  9. echo "method func $param\n";
  10. }
  11. public function __destruct(){
  12. echo __METHOD__.":".__LINE__."\n";
  13. }
  14. }
  15. function func(){
  16. $param = "ali";
  17. $param = $param + "baba";
  18. echo "function func $param\n";
  19. }
  20. $demo = new demo();
  21. $demo->func(1);
  22. func();
  23. phpdbg_inc_func();
  24. ?>

3、启动phpdbg

phpdbg安装成功后,会在安装目录的bin目录下,进入bin目录,直接输入phpdbg即可,如下:

  1. #phpdeg
  2. [Welcome to phpdbg, the interactive PHP debugger, v0.4.0]
  3. To get help using phpdbg type "help" and press enter
  4. [Please report bugs to <http://github.com/krakjoe/phpdbg/issues>]
  5. prompt>

要想加载要调试的php脚本,只需要执行exec命令即可,如下:

  1. #phpdbg
  2. ......
  3. prompt> exec ./test_phpdbg.php

当然我们也可以在启动phpdbg的时候,指定e参数,如下:

#phpdbg -e ./test_phpdbg.php

4、查看帮助信息

如果你之前使用过其他的调试工具,你会发现phpdbg和他们比较相似,但是,你使用初期,还是会经常需要获取帮助信息,通过help命令我们可以获取帮助信息。

  1. ......
  2. prompt> help
  3. phpdbg is a lightweight, powerful and easy to use debugging platform for PHP5.4+
  4. It supports the following commands:
  5. Information
  6. list list PHP source
  7. ......

5、设置断点

设置断点的命令和gdb一样。都是break,简写形式为b。不过具体的命令参数还是有所差异的。和gdb的断点命令相同之处,它们都可以“按文件名:行号” 或者 行号的方式设置断点。除此之外,phpdbg还提供了一些针对php特有的设置断点的方式。如,根据opline设置断点,根据opcode设置断点等。

众所周知,php代码最终是解析成opcode,然后由php内核一条条执行。一条php语句,可能会解析成多条opcode。如果可以按opcode设置断点,我们就可以更精确的跟踪程序执行过程。下面我们来看看phapdbg设置断点的具体示例。

按opline设置断点:

这里所说的opline,就是以方法入口作为起点,当前代码的行号。如test_phpdgb.php文件中,第18行的代码“$param = $param + “baba”;”的opline就是 2。

  1. ......
  2. prompt> b func#2
  3. prompt> r
  4. demo::__construct:5
  5. method func 2
  6. [Breakpoint #0 resolved at func#2 (opline 0x7f5b230a2e38)]
  7. [Breakpoint #0 resolved at func#2 (opline 0x7f5b230a2e38)]
  8. [Breakpoint #0 resolved at func#2 (opline 0x7f5b230a2e38)]
  9. [Breakpoint #0 in func()#2 at ./test_phpdbg.php:18, hits: 1]
  10. >00018: $param = $param + "baba";
  11. 00019: echo "function func $param\n";;
  12. 00020: }
  13. ......

6、查看断点

和gdb一样,phpdbg也是使用info break命令查看断点,示例如下:

  1. ....
  2. prompt> info break
  3. ------------------------------------------------
  4. File Breakpoints:
  5. #1 /home/hailong.xhl/test_phpdbg.php:10
  6. ------------------------------------------------
  7. Opline Breakpoints:
  8. #0 7ff3219e1df0 (function breakpoint)
  9. ------------------------------------------------
  10. Function opline Breakpoints:
  11. #0 func opline 2
  12. ....

通过上面的显示,我们可以知道,info break的显示结果中会把断点的类型也给显示出来,#后面的数字是断点号,我们可以根据断点号删除断点。

7、删除断点

和gdb命令不一样。phpdbg的删除断点不是delete命令,而是break del 命令,示例如下:

  1. ......
  2. prompt> break del 1
  3. [Deleted breakpoint #1]
  4. prompt>
  5. ......

break del 后面的数字1就是断点号。

8、查看代码

phpdbg查看代码的命令也是list,但是和gdb相比,使用的方式更多样一些。

显示指定函数的代码:

  1. ......
  2. prompt> l f func
  3. 00017: $param = "ali";
  4. 00018: $param = $param + "baba";
  5. 00019: echo "function func $param\n";;
  6. 00020: }
  7. 00021:
  8. prompt>
  9. ......

单步执行

phpdbg的单步执行只有一个命令 step,和gdb的step命令差不多,都是一行一行的执行代码,注意,phpdbg是没有next命令的。

  1. ....
  2. prompt> s
  3. [Breakpoint #0 resolved at func#2 (opline 0x152ba40)]
  4. [L19 0x152ba70 ZEND_ADD_STRING C2 @0 ./test_phpdbg.php]
  5. >00019: echo "function func $param\n";;
  6. 00020: }
  7. 00021:
  8. ....

继续执行

和gdb一样,phpdbg的继续执行命令也是continue,简写形式为c。

执行php代码

这个是phpdbg的一个特色,可以在调试的过程中使用ev命令执行任意的php代码。如:

  1. ......
  2. prompt> ev $var = "val";
  3. val
  4. prompt> ev var_dump($var);
  5. string(3) "val"
  6. ......

可以通过这种方式,在调试过程中动态的修改变量值,查看执行效果。