簡介
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 2 3 4 5 6 7 |
#cd /home/php/sapi #git clone https://github.com/krakjoe/phpdbg #cd ../ #./buildconf --force #./config.nice #make -j8 #make install-phpdbg |
注意:
1、如果你的php版本是php5.6或者更高的版本,phpdbg已經整合在php的程式碼包中,無需單獨下載了。
2、編譯引數中記得要加 –enable-phpdbg。
3、編譯時引數,–with-readline 可以選擇性新增。如果不新增,phpdbg的history等功能無法使用。
基本使用
引數介紹
phpdbg是php的一個sapi,它可以以命令列的方式除錯php。常用引數如下:
The following switches are implemented (just like cli SAPI):
-n ignore php ini
-c search for php ini in path
-z load zend extension
-d define php ini entry
The following switches change the default behaviour of phpdbg:
-v disables quietness
-s enabled stepping
-e sets execution context
-b boring – disables use of colour on the console
-I ignore .phpdbginit (default init file)
-i override .phpgdbinit location (implies -I)
-O set oplog output file
-q do not print banner on startup
-r jump straight to run
-E enable step through eval()
Note: passing -rr will cause phpdbg to quit after execution, rather than returning to the console
常用功能
之前我們介紹過gdb工具。其實phpdbg和gdb功能有些地方非常相似。如,可以設定斷點,可以單步執行,等。只是他們除錯的語言不一樣,gdb側重於除錯c或者c++語言,而phpdbg側重於除錯php語言。下面我們將對phpdbg的一些常用除錯功能做下介紹。要除錯的程式碼如下:
檔案test_phpdbg_inc.php原始碼如下:
1 2 3 4 5 6 |
<?php function phpdbg_inc_func() { echo "phpdbg_inc_func \n"; } ?> |
檔案test_phpdgb.php的原始碼如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
<?php include(dirname(__FILE__)."/test_phpdbg_inc.php"); class demo{ public function __construct(){ echo __METHOD__.":".__LINE__."\n"; } public function func($param){ $param++; echo "method func $param\n"; } public function __destruct(){ echo __METHOD__.":".__LINE__."\n"; } } function func(){ $param = "ali"; $param = $param + "baba"; echo "function func $param\n"; } $demo = new demo(); $demo->func(1); func(); phpdbg_inc_func(); ?> |
啟動phpdbg
phpdbg安裝成功後,會在安裝目錄的bin目錄下。進入bin目錄,直接輸入phpdbg即可。如下:
1 2 3 4 5 |
#phpdeg [Welcome to phpdbg, the interactive PHP debugger, v0.4.0] To get help using phpdbg type "help" and press enter [Please report bugs to <http://github.com/krakjoe/phpdbg/issues>] prompt> |
要想載入要除錯的php指令碼,只需要執行exec命令即可。如下:
1 2 3 |
#phpdbg ...... prompt> exec ./test_phpdbg.php |
當然我們也可以在啟動phpdbg的時候,指定e引數。如下:
1 |
#phpdbg -e ./test_phpdbg.php |
檢視幫助資訊
如果你之前使用過其他的除錯工具,你會發現phpdbg和他們比較相似。但是,你使用初期,還是會經常需要獲取幫助資訊。通過help命令我們可以獲取幫助資訊。
1 2 3 4 5 6 7 8 9 |
...... prompt> help phpdbg is a lightweight, powerful and easy to use debugging platform for PHP5.4+ It supports the following commands: Information list list PHP source ...... |
設定斷點
設定斷點的命令和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 3 4 5 6 7 8 9 10 11 12 13 |
...... prompt> b func#2 prompt> r demo::__construct:5 method func 2 [Breakpoint #0 resolved at func#2 (opline 0x7f5b230a2e38)] [Breakpoint #0 resolved at func#2 (opline 0x7f5b230a2e38)] [Breakpoint #0 resolved at func#2 (opline 0x7f5b230a2e38)] [Breakpoint #0 in func()#2 at ./test_phpdbg.php:18, hits: 1] >00018: $param = $param + "baba"; 00019: echo "function func $param\n";; 00020: } ...... |
檢視斷點
和gdb一樣,phpdbg也是使用info break命令檢視斷點。示例如下:
1 2 3 4 5 6 7 8 9 10 11 12 |
.... prompt> info break ------------------------------------------------ File Breakpoints: #1 /home/hailong.xhl/test_phpdbg.php:10 ------------------------------------------------ Opline Breakpoints: #0 7ff3219e1df0 (function breakpoint) ------------------------------------------------ Function opline Breakpoints: #0 func opline 2 .... |
通過上面的顯示,我們可以知道。info break的顯示結果中會把斷點的型別也給顯示出來。#後面的數字是斷點號。我們可以根據斷點號刪除斷點。
刪除斷點
和gdb命令不一樣。phpdbg的刪除斷點不是delete命令,而是break del 命令。示例如下:
1 2 3 4 5 |
...... prompt> break del 1 [Deleted breakpoint #1] prompt> ...... |
break del 後面的數字1就是斷點號。
檢視程式碼
phpdbg檢視程式碼的命令也是list。但是和gdb相比,使用的方式更多樣一些。
顯示指定函式的程式碼:
1 2 3 4 5 6 7 8 9 |
...... prompt> l f func 00017: $param = "ali"; 00018: $param = $param + "baba"; 00019: echo "function func $param\n";; 00020: } 00021: prompt> ...... |
單步執行
phpdbg的單步執行只有一個命令 step。和gdb的step命令差不多。都是一行一行的執行程式碼。注意,phpdbg是沒有next命令的。
1 2 3 4 5 6 7 8 |
.... prompt> s [Breakpoint #0 resolved at func#2 (opline 0x152ba40)] [L19 0x152ba70 ZEND_ADD_STRING C2 @0 ./test_phpdbg.php] >00019: echo "function func $param\n";; 00020: } 00021: .... |
繼續執行
和gdb一樣,phpdbg的繼續執行命令也是continue,簡寫形式為c。
執行php程式碼
這個是phpdbg的一個特色。可以在除錯的過程中使用ev命令執行任意的php程式碼。如:
1 2 3 4 5 6 |
...... prompt> ev $var = "val"; val prompt> ev var_dump($var); string(3) "val" ...... |
可以通過這種方式,在除錯過程中動態的修改變數值,檢視執行效果。