Linux 源代碼分析工具鏈

前言

vim+ctags+cscope

源碼閱讀三劍客.vim配合ctags和cscope,足以在源代碼里面自由翱翔,在函數和變量間自由跳轉.

安裝

sudo apt-get install vim ctags cscope 

使用

vim

ctags

• 使光標在函數或變量上,Ctrl + ]即可跳轉到其定義處
• Ctrl + t可以回到你跳轉之前的位置

對于簡單的代碼,ctags就夠用了,但是對于比較復雜的代碼來說,ctags顯得有點力不從心,于是,下一位劍客就登場了.

cscope

• -R: 在生成索引文件時，搜索子目錄樹中的代碼
• -b: 只生成索引文件，不進入cscope的界面
• -q: 生成cscope.in.out和cscope.po.out文件，加快cscope的索引速度

• s: 查找C語言符號，即查找函數名、宏、枚舉值等出現的地方
• g: 查找函數、宏、枚舉等定義的位置，類似ctags所提供的功能
• d: 查找本函數調用的函數
• c: 查找調用本函數的函數
• t: 查找指定的字符串
• e: 查找egrep模式，相當于egrep功能，但查找速度快多了
• f: 查找并打開文件，類似vim的find功能
• i: 查找包含本文件的文件

例如，我們想在vim 7.0的源代碼中查找調用do_cscope()函數的函數，我們可以輸入：”:cs find c do_cscope“，回車后發現沒有找到匹配的功能，可能并沒有函數調用do_cscope()。我們再輸入”:cs find s do_cscope“，查找這個C符號出現的位置，現在vim列出了這個符號出現的所有位置。

每次都有輸入cs find來查找數據是不是有點麻煩,有沒有更方便的方法呢.當然有,vim的神奇之處在其可定制性.提供一份cscope的配置,將其放在.vimrc中即可.

"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" cscope setting
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
if has("cscope")
  set csprg=/usr/bin/cscope
  set csto=1
  set cst
  set nocsverb
  " add any database in current directory
  if filereadable("cscope.out")
      cs add cscope.out
  endif
  set csverb
endif

nmap <C-@>s :cs find s <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>g :cs find g <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>c :cs find c <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>t :cs find t <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>e :cs find e <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>f :cs find f <C-R>=expand("<cfile>")<CR><CR>
nmap <C-@>i :cs find i ^<C-R>=expand("<cfile>")<CR>$<CR>
nmap <C-@>d :cs find d <C-R>=expand("<cword>")<CR><CR>

上面的配置即把Ctrl + @作為:cs find的快捷鍵,也就是說要查找某個函數名,只需要把光標放在函數名上,按下Ctrl + @ + s即可,簡直不能更方便.而且你可以自己修改配置,映射到自己覺得舒服的快捷鍵上.

本著不重復造輪子的原則,我就簡單的寫了cscope的基本用法,其實基本上就夠用了,進階的用法參考這篇文章 vi/vim使用進階: 程序員的利器 – cscope

doxygen

上面我們講的是用vim來查看源代碼,但是面對幾十萬代碼的時候,想要看清楚各個結構體之間的關系就不是vim能夠做到的了.這時候我們就需要doxygen來幫手了.

當然了,如果這篇文章唯一給出的建議就是看文檔,那這篇文章有什么意義呢.大家都知道看文檔可以解決問題,但是時間成本太高,而且是英文的.寫這篇文章的目的是分享自己學習得到的經驗,讓大家少走彎路,如果不能解決你的問題,只能去看文檔了

接下來我根據我自己看文檔用到的配置跟大家解釋一下.首先,Doxygen里面的配置可謂又臭又長,你絕對不會有讀完它的欲望.所以我給出幾個關鍵的配置項,到時候搜索它修改即可

• 這是針對各種語言優化輸出的選項,默認都是NO,因為它不清楚你用的是什么語言(話說看一下后綴不就知道了嗎…)

  OPTIMIZE_OUTPUT_FOR_C OPTIMIZE_OUTPUT_JAVA OPTIMIZE_FOR_FORTRAN OPTIMIZE_OUTPUT_VHDL 

• 這個是生成文檔的類型的選項,默認生成html和latex,共支持六種類型的文檔,每種類型的生成配置也是很多,具體根據需要配置

  GENERATE_HTML GENERATE_LATEX GENERATE_RTF GENERATE_XML GENERATE_DOCBOOK GENERATE_MAN 

• 關于生成圖像的選項.doxygen使用dot這個工具來繪圖,所以要先執行sudo apt-get install graphviz安裝dot.在設置好這個繪圖選項之后,doxygen就會生成各個結構體的關系,對于類會生成函數調用關系(我沒試過,因為只試過C的).HAVE_DOT (一定要置為YES,后面的選項都依賴這個)
  
  DOT_NUM_THREADS (使用dot繪圖的線程數量,越多越快,我一般是設置跟cpu的核數一樣)

  給一個結構體關系圖,就是doxygen生成的.

  

最后一步,在源碼根目錄執行doxygen,它會自動找到Doxygen配置,根據配置生成文檔.

gdb

后記

以上就是我在閱讀源碼的時候使用的Linux工具,三劍客 vim+ctags+cscope ,兩板斧 doxygen gdb ,足以馳騁源代碼的江湖.

以上工具,vim和gdb是最難學的,學習曲線很陡峭.但是學好之后,就能守得云開見月明.