如何提高閱讀源碼的效率

我發(fā)現(xiàn)函數(shù)調(diào)用圖可以讓我們更加直觀地了解到源碼函數(shù)直接的調(diào)用和層次關(guān)系,提高閱讀源碼的效率。

1 前言

看源碼的時候,心血來潮想弄一下函數(shù)之前的調(diào)用關(guān)系,想起以前doxygen配合graphviz使用可以生成比較直觀的函數(shù)調(diào)用關(guān)系圖,但是前提是函數(shù)的注釋需要嚴(yán)格按照doxygen的規(guī)范,具體可以自己去搜索一下,當(dāng)然使用source insight等利器也很方便；

本文主要通過gcc+egypt+graphviz(dot)三個工具輕松生成源碼的函數(shù)調(diào)用關(guān)系圖；下圖是本人在閱讀FreeRTOS源碼tasks.c時生成的調(diào)用關(guān)系圖,具體如下所示；

一個例子

2 graphviz 安裝

Graphviz （Graph Visualization Software的縮寫）是一個由AT&T實驗室啟動的開源工具包，用于繪制DOT語言腳本描述的圖形。ubuntu下可以直接安裝；

sudoapt-getinstallgraphviz

直接輸入指令后，系統(tǒng)開始安裝；

成功安裝graphviz，這里我們就可以使用dot工具了,具體使用方法如下；

3 egypt 安裝

egypt官網(wǎng): http://www.gson.org/egypt/

簡潔的首頁

下載后的文件為egypt-1.10.tar.gz;找到文件所在路徑；

sudofind-nameegypt-1.10.tar.gz

然后解壓:

sudotar-xvfegypt-1.10.tar.gz

解壓得到egypt-1.10;

cdegypt-1.10&&sduochmod+xegypt

最終可以看到文件結(jié)構(gòu)如下；

將egypt移動到/usr/bin,方便后面直接調(diào)用,或者將當(dāng)前egypt所在路徑添加到環(huán)境變量中；

sudocpegypt/usr/bin

以上,已經(jīng)完成了egypt的安裝；

使用方法如下;

egypt[--omitfunction,function,...][--include-external]...|dotty-
egypt[--omitfunction,function,...][--include-external]...|dot

4 測試

編寫程序test.c,具體如下所示；

#include

voidtest0();
voidtest1();
voidtest2();
voidtest3();

intmain()
{
test1();
test2();
test3();
return0;
}

voidtest0(void){
printf("hello");
}

voidtest1(void)
{
test0();
}

voidtest2(void)
{
test1();
}

voidtest3(void)
{

}

編譯需要加上參數(shù)-fdump-rtl-expand生成相應(yīng)的dump文件；

gcc-fdump-rtl-expand-ctest.c

這里有我們需要的文件test.c.229r.expand;

輸入如下指令；

egypttest.c.229r.expand|dot-Tpng-otest.png

最終生成了順利生成test.png,具體如下圖所示；

最終調(diào)用關(guān)系圖

5 結(jié)論

對C語言源碼的閱讀用這個辦法還是有點小麻煩，無法一鍵生成調(diào)用關(guān)系,，

另外還需要gcc編譯源碼生成dumpfile文件，如果想要方便一些,可能還需要自己寫腳本實現(xiàn)自動化，如果大佬有更好的辦法，歡迎留言區(qū)討論。

原文標(biāo)題：一個超級實用的源碼閱讀小技巧

文章出處：【微信公眾號：FPGA之家】歡迎添加關(guān)注！文章轉(zhuǎn)載請注明出處。