使用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) = 0x8062aa8brk(0x8063000) = 0x8063000mmap2(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.cppSegmentation fault (core dumped)

 

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

# truss -f -o clint.truss clintSegmentation 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 11SIGNAL 11Process stopped because of: 16process 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 <stdio.h>#include <unistd.h>#include <sys/types.h>#include <sys/stat.h>#include <fcntl.h>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.stracereadlink("/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 -ltotal 0lrwx------ 1 root root 64 Nov 5 09:50 0 -> /dev/pts/0lrwx------ 1 root root 64 Nov 5 09:50 1 -> /dev/pts/0lrwx------ 1 root root 64 Nov 5 09:50 2 -> /dev/pts/0lr-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 <stdio.h>#include <string.h>#include <sys/types.h>#include <unistd.h>#include <fcntl.h>#include <sys/stat.h>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=%s\n", 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