Linux下程式碼覆蓋率工具：gcov

對於C/C++軟體開發，常常需要通過程式碼覆蓋率報告來了解測試用例的場景覆蓋情況，對於測試用例未覆蓋的程式碼分支流程，需要補充用例，以保證測試用例的全面性與完整性，不漏測任何一個分支BUG。Linux下可用gcov工具生成覆蓋率統計資訊，然後藉助gcov的圖形化工具lcov，可生成html格式的程式碼覆蓋率報告，進一步提高覆蓋率測試結果的可讀性。

1、Gcov實現原理

Gcc中新增-ftest-coverage編譯選項後，則：

1）輸出目標檔案中留出一段儲存區用於儲存統計資料；

2）原始碼中每一行可執行語句生成的程式碼之後注入一段更新覆蓋率統計結果的程式碼；

3）在可執行程序檔案中，進入main函式之前呼叫 gcov_init初始化統計資料區，並將gcov_exit註冊為 exit handlers；

4）使用者側程式碼呼叫exit 時，將呼叫gcov_exit，其繼續呼叫__gcov_flush函式輸出統計資料到*.gcda檔案中。

從gcov實現原理可知，若使用者程序並未呼叫 exit退出，就得不到覆蓋率統計資料，也就無從生成報告了。而後臺服務程式一旦啟動很少主動退出。為了解決這個問題，我們可以給待測程式註冊一個訊號處理函式（signal handler），處理SIGINT、SIGQUIT、SIGTERM等常見強制退出訊號，並在訊號處理函式中主動呼叫

exit或 __gcov_flush函式，以便輸出統計結果。

上述方案需要修改待測程式程式碼，可以借用動態庫預載入技術和gcc擴充套件的constructor屬性，將signal handler和註冊過程都封裝到一個獨立的動態庫中，並在預載入動態庫時實現訊號攔截註冊。這樣，就可以通過如下命令列來實現異常退出時的統計結果輸出：

LD_PRELOAD=./gcov_preload.so./test

測試完成後，直接kill掉test程序，即可獲得正常的統計結果檔案*.gcda。其中，gcov_preload.so是你自己寫的一個程式，接受SIG，然後exit，以觸發gcov進行輸出。

接下來，我們詳細說明

gcov的使用步驟。

Gcov屬於gcc工具集之一，是隨gcc一起釋出的，並不需要獨立安裝。lcov需要自己下載開源軟體安裝。Lcov開源軟體的下載地址：

https://sourceforge.net/projects/ltp/files/Coverage%20Analysis/

以lcov-1.13.tar.gz為例，安裝步驟比較簡單：

tar –zxvf lcov-1.13.tar.gz

cd lcov-1.13/

make install

lcov可執行二進位制預設安裝在/usr/local/bin目錄下，若該路徑不在環境變數$PATH中，可先用export PATH=$PATH: /usr/local/bin新增進來，以便後續使用。

2、編譯連結

為了生成生成覆蓋率統計資訊，需要在編譯時新增編譯選項：

編譯選項CFLAGS += -fprofile-arcs -ftest-coverage，或CFLAGS += --coverage，其中-fprofile-arcs用於生成.gcno檔案，-ftest-coverage用於生成.gcda檔案。

連結選項LDFLAGS += -lgcov，注：此選項僅在使用ld連結時需要，使用gcc時不需要。

舉例說明，編輯一個test.c檔案，內容如下：

#include <stdio.h>

#include <stdlib.h>

int func_1(char *ptr)

{

if (NULL == ptr)

{

printf("func_1:ptr==NULL!\n");

return 1;

}

printf("func_1: ptr: %p\n", ptr);

return 0;

}

void func_2(char *ptr)

{

printf("func_2: ptr: %p\n", ptr);

}

void func_3(void)

{

printf("func_3...\n");

}

void main(int argc, char *argv[])

{

char *ptr = NULL;

func_1(ptr);

ptr = (char *)malloc(8);

func_2(ptr);

free(ptr);

return;

}

執行gcc編譯命令：

[[email protected] gcov]# gcc -fprofile-arcs -ftest-coverage test.c -o test

[[email protected] gcov]# ls

lcov-1.13testtest.ctest.gcno

編譯生成test可執行程式的同時，也生成了同名的.gcno檔案。

3、執行

執行test程式，生成同名的.gcda檔案：

[[email protected] gcov]# ./test

func_1:ptr==NULL!

func_2:ptr: 0x99b5008

[[email protected] gcov]# ls

lcov-1.13testtest.ctest.gcdatest.gcno

執行gcov命令，生成覆蓋率資訊檔案，即.gcov檔案：

[[email protected] gcov]#gcov test.c

File'test.c'

Linesexecuted:73.68% of 19

test.c:creating'test.c.gcov'

[[email protected] gcov]# ls

lcov-1.13testtest.ctest.c.gcovtest.gcdatest.gcno

test.c.gcov就是程式碼覆蓋資訊檔案，但看起來並不直觀，下面我們進一步分析。

4、覆蓋率分析

覆蓋率分析過程分兩步。

首先，藉助lcov對覆蓋率檔案test.c.gcov進行改造，生成了test.info檔案：

[[email protected] gcov]#lcov -c -d . -o 'test.info' -b .

Capturing coverage data from .

Found gcov version: 4.4.7

Scanning. for .gcda files ...

Found 1 data files in .

Processing test.gcda

Finished .info-file creation

[[email protected] gcov]# ls

lcov-1.13testtest.ctest.gcdatest.gcnotest.info

其次，通過genhtml工具（lcov工具集中帶有）生成result資料夾，其中就包含index.html，可以直接雙擊開啟檢視：

[[email protected] gcov]# genhtml -o result test.info

Reading data file test.info

Found 1 entries.

Found common filename prefix "/home/hanlzh/test"

Writing .css and .png files.

Generating output.

Processing file gcov/test.c

Writing directory view page.

Overall coverage rate:

lines......: 73.7% (14 of 19 lines)

functions..: 75.0% (3 of 4 functions)

[[email protected] gcov]# ls

lcov-1.13resulttesttest.ctest.gcdatest.gcnotest.info

[[email protected] gcov]# ls result/

amber.pngemerald.pnggcovgcov.cssglass.pngindex.htmlindex-sort-f.htmlindex-sort-l.htmlruby.pngsnow.pngupdown.png

最後，檢視結果：

1）在windows介面下，雙擊index.html，顯示目錄級別下的覆蓋率統計資訊；

2）進一步點選目錄gcov，顯示檔案級別的覆蓋率統計資訊；

3）進一步點選檔案test.c，顯示檔案內分支語句的覆蓋率詳細資訊；

顯然地，標紅行是執行./test時沒有執行到的語句，可以為我們進一步優化程式碼或補充測試用例提供了參考。

5、總結

Lcov和genhtml的功能比較豐富，選項引數比較多，感興趣的讀者可以通過man lcov和man genhtml查閱。