代碼閱讀工具簡介
對(duì)于學(xué)習(xí)Linux內(nèi)核的人來說，源代碼的閱讀尤為重要。因?yàn)樗性O(shè)計(jì)思想、內(nèi)部機(jī)制都是
以代碼的形式實(shí)現(xiàn)，所有的資料也都是為了更好的詮釋代碼。那么一個(gè)好的閱讀工具，能
夠提高閱讀的效率和效果。常見的代碼閱讀工具有，Source Navigator、Source Insight
、lxr、Cscope、Kscope等。
• "Source Navigator"是紅帽子公司的，以GNU GPL發(fā)布，可從官方網(wǎng)站[1]下載使用。
• "Source Insight"目前只有Windows平臺(tái)的，官方網(wǎng)站[2]。需要注冊(cè)才能使用，或者
從網(wǎng)上下載注冊(cè)機(jī)生成注冊(cè)碼。在Linux下通過wine模擬雖然可以方便使用，但它畢竟
是Windows平臺(tái)的東西，并不能很自由的使用。
• lxr(linux cross reference)[3]為程序源代碼建立索引數(shù)據(jù)庫,利用perl腳本CGI動(dòng)態(tài)
生成包含源碼的web頁面,你可以用任何一種瀏覽器查閱。缺點(diǎn)是需要服務(wù)器支持，還
有速度。
• "Cscope"[4]為終端下的代碼閱讀工具，資源消耗少，對(duì)那些忠于命令行的行操作的人
，使用起來更加方便、靈活。這也是這篇文章推薦使用的一個(gè)重要原因。也有人把
Cscope和Emasc綁定閱讀源碼。當(dāng)然工具的選取，也取決于個(gè)人習(xí)慣。
Vim+Ctags+Cscope
cscope的工作需要vim、ctags的配合，它們都是基于命令行的。在Ubuntu下，用戶只需執(zhí)
行“sudo apt-get install cscope cscope-indexer ctags vim-full”即可完成軟件安裝。
下面只是給出了三種工具的常用方法，更多功能可查看man手冊(cè)，或者官方文檔。
Vim
vim被看作是專門為程序員打造的文本編輯器，其豐富的編輯命令都是常用的簡單字符，用
戶很容易上手。vim可對(duì)180多種語言的語法高亮,對(duì)C語言自動(dòng)縮進(jìn)，真則表達(dá)式字符匹配
查找，功能強(qiáng)大，并支持多個(gè)操作系統(tǒng)平臺(tái)。關(guān)于vim的使用，這里不做講解。vim中文文
檔[5]。
在Ubuntu下默認(rèn)安裝的vim，沒有語法加亮功能。所以需要安裝vim－full，并在vim 配置
文件 ~/.vimrc中添加一行 "syntax on" 這樣在vim中打開的源碼就有了語法高亮顯示。
vim自帶了很多顏色主題，可以直接選取下面一行添加到vim配置文件當(dāng)中，重新打開vim即
可生效。
colorscheme elflord "我使用這個(gè)
colorscheme darkblue
colorscheme evening
colorscheme murphy
colorscheme torte
colorscheme desert
Ctags
在源代碼根目錄下執(zhí)行 ctags -r 命令用來為程序源代碼生成標(biāo)簽文件，其-r選項(xiàng)表示遞
歸操作，同時(shí)為子目錄也生成標(biāo)簽文件。vim利用生成的標(biāo)簽文件，可以進(jìn)行相應(yīng)檢索、并
在不同的文件C語言元素之間來回切換。
在vim中ctags的簡單使用
1) 跳轉(zhuǎn)到指定的函數(shù)進(jìn)入vim后，用 “:tag func_name“ 跳到函數(shù)func_name處。使用tag
命令時(shí)，可以使用TAB鍵進(jìn)行匹配查找，繼續(xù)按TAB鍵向下切換。
某個(gè)函數(shù)有多個(gè)定義時(shí)
:tag
跳到第一個(gè)定義處，優(yōu)先跳轉(zhuǎn)到當(dāng)前文件
:tnext
跳到第一個(gè)
:tfirst
跳到前count個(gè)
:[count]tprevious
跳到后count個(gè)
:[count]tnext
跳到最后一個(gè)
:tlast
你也可以在所有tagname中選擇：
:tselect tagname
如果想跳到包含block的標(biāo)識(shí)符:“tag /block” 然后用TAB鍵來選擇。這里'/'就是告訴vim
'block'是一個(gè)語句塊標(biāo)簽。
2)用“CTRL + ]“快捷鍵，跳轉(zhuǎn)到光標(biāo)所在函數(shù)標(biāo)識(shí)符的定義處。
3)使用“CTRL + T”退回上層。如果想在以write_開頭的標(biāo)識(shí)符中選擇一下， :tselect /^
write_ 這里，'^'表示開頭，同理，'$'表示末尾。多個(gè)同名的標(biāo)識(shí)符
Cscope
運(yùn)行cscope命令，出現(xiàn)兩個(gè)面板，上方是一個(gè)查找結(jié)果的顯示面板，下方是一個(gè)查找條件
指定面板。使用TAB鍵在兩個(gè)面板間切換，也可使用上下左右方向件和翻頁鍵在同一面板內(nèi)
貼換位置。選中顯示面板的某個(gè)項(xiàng)，回車即可進(jìn)入該文件，這是調(diào)用vim打開文件，這時(shí)就
可以結(jié)合ctags使用了。當(dāng)然也可以直接使用vim打開文件，結(jié)合ctags閱讀源碼。
使用前，必須現(xiàn)使用“cscope-indexer -r”命令遞歸生成索引信息文件。特殊情況下，還需
要用戶使用find命令，主動(dòng)生成索引信息文件，并指定給cscope工具。 cscope提供了如下
九種查詢方式：
Find this C symbol:
#查找指定的C符號(hào)
Find this global definition:
#查找指定的全局定義
Find functions called by this function:
#查找指定函數(shù)調(diào)用的函數(shù)
Find functions calling this function:
#查找調(diào)用指定函數(shù)的函數(shù)
Find this text string:
#查找字符串
Change this text string:
#修改指定字符串
Find this egrep pattern:
#查找匹配字符
Find this file:
#查找指定文件
Find files #including this file:
#指定引用頭文件進(jìn)行查找
在對(duì)應(yīng)某一項(xiàng)中輸入查找條件，回車即可進(jìn)行查詢，并將結(jié)果顯示在顯示面板。
應(yīng)用實(shí)例
下面以使用cscope閱讀內(nèi)核源代碼為例：
$ wget
http://kernel.org/pub/linux/kernel/v2.6/linux-2.6.27.6.tar.bz2
#從Linux內(nèi)核官網(wǎng)下載內(nèi)核源代碼
$ tar xvfj linux-2.6.27.6.tar.bz2
#解壓文件
$ cd linux-2.6.27.6
#進(jìn)入源代碼根目錄
$ ctags -R
#遞歸生成標(biāo)簽文件
$ cscope-indexer -r
#遞歸生成索引信息文件
$ cscope
#使用cscope閱讀源碼
標(biāo)簽文件、索引信息文件只需要第一次或者代碼發(fā)生變動(dòng)時(shí)生成，以后使用直接運(yùn)行
cscope即可。
[1]
http://sourcenav.sourceforge.net/ [2]
http://www.sourceinsight.com/ [3]
http://lxr.linux.no/ [4]
http://cscope.sourceforge.net/ [5]
http://vcd.gro.clinux.org/