使用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系統調用跟蹤調試運行中的進程,詳細原理不在本文討論范圍內,有興趣可以參考它們的源代碼。
下面舉兩個實例演示如何利用這三個調試工具診斷軟件的"疑難雜癥":
操作系統: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終于能夠正常運行了。
操作系統: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.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 <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