技巧: 使用truss、strace或ltrace診斷軟體的"疑難雜症"

http://www-128.ibm.com/developerworks/cn/linux/l-tsl/

本文透過三個實際案例演示如何使用truss、strace和ltrace這三個常用的除錯工具來快速診斷軟體的"疑難雜症"。
簡介

程式無法啟動，軟體執行速度突然變慢，程式的"Segment Fault"等等都是讓每個Unix系統使用者頭痛的問題，本文透過三個實際案例演示如何使用truss、strace和ltrace這三個常用的除錯工具來快速診斷軟體的"疑難雜症"。

truss和strace用來 跟蹤一個程式的系統呼叫或訊號產生的情況，而 ltrace用來 跟蹤程式呼叫庫函式的情況。truss是早期為System V R4開發的除錯程式，包括Aix、FreeBSD在內的大部分Unix系統都自帶了這個工具；而strace最初是為SunOS系統編寫的，ltrace最早出現在GNU/Debian Linux中。這兩個工具現在也已被移植到了大部分Unix系統中，大多數Linux發行版都自帶了strace和ltrace，而FreeBSD也可透過Ports安裝它們。

你不僅可以從命令列除錯一個新開始的程式，也可以把truss、strace或ltrace繫結到一個已有的PID上來除錯一個正在執行的程式。三個除錯工具的基本使用方法大體相同，下面僅介紹三者共有，而且是最常用的三個命令列引數：

-f ：除了跟蹤當前程式外，還跟蹤其子程式。
-o file ：將輸出資訊寫到檔案file中，而不是顯示到標準錯誤輸出（stderr）。
-p pid ：繫結到一個由pid對應的正在執行的程式。此引數常用來除錯後臺程式。

使用上述三個引數基本上就可以完成大多數除錯任務了，下面舉幾個命令列例子：

truss -o ls.truss ls -al： 跟蹤ls -al的執行，將輸出資訊寫到檔案/tmp/ls.truss中。
strace -f -o vim.strace vim： 跟蹤vim及其子程式的執行，將輸出資訊寫到檔案vim.strace。
ltrace -p 234： 跟蹤一個pid為234的已經在執行的程式。

三個除錯工具的輸出結果格式也很相似，以strace為例：

brk(0) = 0x8062aa8
brk(0x8063000) = 0x8063000
mmap2(NULL, 4096, PROT_READ, MAP_PRIVATE, 3, 0x92f) = 0x40016000

每一行都是一條系統呼叫，等號左邊是系統呼叫的函式名及其引數，右邊是該呼叫的返回值。 truss、strace和ltrace的工作原理大同小異，都是使用ptrace系統呼叫跟蹤除錯執行中的程式，詳細原理不在本文討論範圍內，有興趣可以參考它們的原始碼。

下面舉兩個例項演示如何利用這三個除錯工具診斷軟體的"疑難雜症"：

案例一：執行clint出現Segment Fault錯誤

作業系統：FreeBSD-5.2.1-release

clint是一個C++靜態原始碼分析工具，透過Ports安裝好之後，執行：

# clint foo.cpp
Segmentation fault (core dumped)

在Unix系統中遇見"Segmentation Fault"就像在MS Windows中彈出"非法操作"對話方塊一樣令人討厭。OK，我們用truss給clint"把把脈"：

# truss -f -o clint.truss clint
Segmentation fault (core dumped)
# tail clint.truss
739: read(0x6,0x806f000,0x1000) = 4096 (0x1000)
739: fstat(6,0xbfbfe4d0) = 0 (0x0)
739: fcntl(0x6,0x3,0x0) = 4 (0x4)
739: fcntl(0x6,0x4,0x0) = 0 (0x0)
739: close(6) = 0 (0x0)
739: stat("/root/.clint/plugins",0xbfbfe680) ERR#2 'No such file or directory'
SIGNAL 11
SIGNAL 11
Process stopped because of: 16
process exit, rval = 139

我們用truss跟蹤clint的系統呼叫執行情況，並把結果輸出到檔案clint.truss，然後用tail檢視最後幾行。注意看clint執行的最後一條系統呼叫（倒數第五行）： stat("/root/.clint/plugins",0xbfbfe680) ERR#2 'No such file or directory'，問題就出在這裡：clint找不到目錄"/root/.clint/plugins"，從而引發了段錯誤。怎樣解決？很簡單： mkdir -p /root/.clint/plugins，不過這次執行clint還是會"Segmentation Fault"9。繼續用truss跟蹤，發現clint還需要這個目錄"/root/.clint/plugins/python"，建好這個目錄後clint終於能夠正常執行了。

案例二：vim啟動速度明顯變慢

作業系統：FreeBSD-5.2.1-release

vim版本為6.2.154，從命令列執行vim後，要等待近半分鐘才能進入編輯介面，而且沒有任何錯誤輸出。仔細檢查了.vimrc和所有的vim指令碼都沒有錯誤配置，在網上也找不到類似問題的解決辦法，難不成要hacking source code？沒有必要，用truss就能找到問題所在：

# truss -f -D -o vim.truss vim

這裡-D引數的作用是：在每行輸出前加上相對時間戳，即每執行一條系統呼叫所耗費的時間。我們只要關注哪些系統呼叫耗費的時間比較長就可以了，用less仔細檢視輸出檔案vim.truss，很快就找到了疑點：

735: 0.000021511 socket(0x2,0x1,0x0) = 4 (0x4)
735: 0.000014248 setsockopt(0x4,0x6,0x1,0xbfbfe3c8,0x4) = 0 (0x0)
735: 0.000013688 setsockopt(0x4,0xffff,0x8,0xbfbfe2ec,0x4) = 0 (0x0)
735: 0.000203657 connect(0x4,{ AF_INET 10.57.18.27:6000 },16) ERR#61 'Connection refused'
735: 0.000017042 close(4) = 0 (0x0)
735: 1.009366553 nanosleep(0xbfbfe468,0xbfbfe460) = 0 (0x0)
735: 0.000019556 socket(0x2,0x1,0x0) = 4 (0x4)
735: 0.000013409 setsockopt(0x4,0x6,0x1,0xbfbfe3c8,0x4) = 0 (0x0)
735: 0.000013130 setsockopt(0x4,0xffff,0x8,0xbfbfe2ec,0x4) = 0 (0x0)
735: 0.000272102 connect(0x4,{ AF_INET 10.57.18.27:6000 },16) ERR#61 'Connection refused'
735: 0.000015924 close(4) = 0 (0x0)
735: 1.009338338 nanosleep(0xbfbfe468,0xbfbfe460) = 0 (0x0)

vim試圖連線10.57.18.27這臺主機的6000埠（第四行的connect（）），連線失敗後，睡眠一秒鐘繼續重試（第6行的nanosleep（））。以上片斷迴圈出現了十幾次，每次都要耗費一秒多鐘的時間，這就是vim明顯變慢的原因。可是，你肯定會納悶："vim怎麼會無緣無故連線其它計算機的6000埠呢？"。問得好，那麼請你回想一下6000是什麼服務的埠？沒錯，就是X Server。看來vim是要把輸出定向到一個遠端X Server，那麼Shell中肯定定義了DISPLAY變數，檢視.cshrc，果然有這麼一行： setenv DISPLAY ${REMOTEHOST}:0，把它註釋掉，再重新登入，問題就解決了。

案例三：用除錯工具掌握軟體的工作原理

作業系統：Red Hat Linux 9.0

用除錯工具實時跟蹤軟體的執行情況不僅是診斷軟體"疑難雜症"的有效的手段，也可幫助我們理清軟體的"脈絡"，即快速掌握軟體的執行流程和工作原理，不失為一種學習原始碼的輔助方法。下面這個案例展現瞭如何使用strace透過跟蹤別的軟體來"觸發靈感"，從而解決軟體開發中的難題的。

大家都知道，在程式內開啟一個檔案，都有唯一一個檔案描述符（fd：file descriptor）與這個檔案對應。而本人在開發一個軟體過程中遇到這樣一個問題：已知一個fd ，如何獲取這個fd所對應檔案的完整路徑？不管是Linux、FreeBSD或是其它Unix系統都沒有提供這樣的API，怎麼辦呢？我們換個角度思考：Unix下有沒有什麼軟體可以獲取程式開啟了哪些檔案？如果你經驗足夠豐富，很容易想到lsof，使用它既可以知道程式開啟了哪些檔案，也可以瞭解一個檔案被哪個程式開啟。

好，我們用一個小程式來試驗一下lsof，看它是如何獲取程式開啟了哪些檔案。

/* testlsof.c */
#include
#include
#include
#include
#include

int main(void)
{
open("/tmp/foo", O_CREAT|O_RDONLY); /* 開啟檔案/tmp/foo */
sleep(1200); /* 睡眠1200秒，以便進行後續操作 */
return 0;
}

將testlsof放入後臺執行，其pid為3125。命令lsof -p 3125檢視程式3125開啟了哪些檔案，我們用strace跟蹤lsof的執行，輸出結果儲存在lsof.strace中：

# gcc testlsof.c -o testlsof
# ./testlsof &
[1] 3125
# strace -o lsof.strace lsof -p 3125

我們以"/tmp/foo"為關鍵字搜尋輸出檔案lsof.strace，結果只有一條：

# grep '/tmp/foo' lsof.strace
readlink("/proc/3125/fd/3", "/tmp/foo", 4096) = 8

原來lsof巧妙的利用了/proc/nnnn/fd/目錄（nnnn為pid）：Linux核心會為每一個程式在/proc/建立一個以其pid為名的目錄用來儲存程式的相關資訊，而其子目錄fd儲存的是該程式開啟的所有檔案的fd。目標離我們很近了。好，我們到/proc/3125/fd/看個究竟：

# cd /proc/3125/fd/
# ls -l
total 0
lrwx------ 1 root root 64 Nov 5 09:50 0 -> /dev/pts/0
lrwx------ 1 root root 64 Nov 5 09:50 1 -> /dev/pts/0
lrwx------ 1 root root 64 Nov 5 09:50 2 -> /dev/pts/0
lr-x------ 1 root root 64 Nov 5 09:50 3 -> /tmp/foo
# readlink /proc/3125/fd/3
/tmp/foo

答案已經很明顯了：/proc/nnnn/fd/目錄下的每一個fd檔案都是符號連結，而此連結就指向被該程式開啟的一個檔案。我們只要用readlink()系統呼叫就可以獲取某個fd對應的檔案了，程式碼如下：

#include
#include
#include
#include
#include
#include
int get_pathname_from_fd(int fd, char pathname[], int n)
{
char buf[1024];
pid_t pid;
bzero(buf, 1024);
pid = getpid();
snprintf(buf, 1024, "/proc/%i/fd/%i", pid, fd);
return readlink(buf, pathname, n);
}
int main(void)
{
int fd;
char pathname[4096];
bzero(pathname, 4096);
fd = open("/tmp/foo", O_CREAT|O_RDONLY);
get_pathname_from_fd(fd, pathname, 4096);
printf("fd=%d; pathname=%sn", fd, pathname);
return 0;
}

【注】出於安全方面的考慮，在FreeBSD 5 之後系統預設已經不再自動裝載proc檔案系統，因此，要想使用truss或strace跟蹤程式，你必須手工裝載proc檔案系統：mount -t procfs proc /proc；或者在/etc/fstab中加上一行：

proc /proc procfs rw 0 0

ltrace不需要使用procfs。

參考資料

truss(1) manual page

strace(1) manual page

ltrace(1) manual page

ptrace(2) manual page

lsof(1) manual page

Debugging with strace： http://www.devchannel.org/devtoolschannel/03/10/24/2057246.shtml