1 .. include:: ../disclaimer-zh_TW.rst
3 :Original: Documentation/dev-tools/gcov.rst
4 :Translator: 趙軍奎 Bernard Zhao <bernard@vivo.com>
6 在Linux內核裏使用gcov做代碼覆蓋率檢查
7 =====================================
9 gcov分析核心支持在Linux內核中啓用GCC的覆蓋率測試工具 gcov_ ,Linux內核
10 運行時的代碼覆蓋率數據會以gcov兼容的格式導出到“gcov”debugfs目錄中,可
11 以通過gcov的 ``-o`` 選項(如下示例)獲得指定文件的代碼運行覆蓋率統計數據
12 (需要跳轉到內核編譯路徑下並且要有root權限)::
15 # gcov -o /sys/kernel/debug/gcov/tmp/linux-out/kernel spinlock.c
17 這將在當前目錄中創建帶有執行計數註釋的源代碼文件。
18 在獲得這些統計文件後,可以使用圖形化的gcov前端工具(比如 lcov_ ),來實現
19 自動化處理Linux內核的覆蓋率運行數據,同時生成易於閱讀的HTML格式文件。
23 * 調試(用來判斷每一行的代碼是否已經運行過)
24 * 測試改進(如何修改測試代碼,儘可能地覆蓋到沒有運行過的代碼)
25 * 內核最小化配置(對於某一個選項配置,如果關聯的代碼從來沒有運行過,
28 .. _gcov: https://gcc.gnu.org/onlinedocs/gcc/Gcov.html
29 .. _lcov: http://ltp.sourceforge.net/coverage/lcov.php
42 CONFIG_GCOV_PROFILE_ALL=y
44 需要注意的是,整個內核開啓覆蓋率統計會造成內核鏡像文件尺寸的增大,
46 另外,並不是所有的架構都支持整個內核開啓覆蓋率統計。
48 代碼運行覆蓋率數據只在debugfs掛載完成後纔可以訪問::
50 mount -t debugfs none /sys/kernel/debug
56 如果要單獨針對某一個路徑或者文件進行代碼覆蓋率統計,可以在內核相應路
59 - 單獨統計單個文件(例如main.o)::
61 GCOV_PROFILE_main.o := y
67 如果要在整個內核的覆蓋率統計(開啓CONFIG_GCOV_PROFILE_ALL)中單獨排除
70 GCOV_PROFILE_main.o := n
76 此機制僅支持鏈接到內核鏡像或編譯爲內核模塊的文件。
82 gcov功能需要在debugfs中創建如下文件:
84 ``/sys/kernel/debug/gcov``
87 ``/sys/kernel/debug/gcov/reset``
88 全局復位文件:向該文件寫入數據後會將所有的gcov統計數據清0
90 ``/sys/kernel/debug/gcov/path/to/compile/dir/file.gcda``
91 gcov工具可以識別的覆蓋率統計數據文件,向該文件寫入數據後
94 ``/sys/kernel/debug/gcov/path/to/compile/dir/file.gcno``
95 gcov工具需要的軟連接文件(指向編譯時生成的信息統計文件),這個文件是
96 在gcc編譯時如果配置了選項 ``-ftest-coverage`` 時生成的。
102 內核中的模塊會動態的加載和卸載,模塊卸載時對應的數據會被清除掉。
103 gcov提供了一種機制,通過保留相關數據的副本來收集這部分卸載模塊的覆蓋率數據。
104 模塊卸載後這些備份數據在debugfs中會繼續存在。
105 一旦這個模塊重新加載,模塊關聯的運行統計會被初始化成debugfs中備份的數據。
107 可以通過對內核參數gcov_persist的修改來停用gcov對模塊的備份機制::
111 在運行時,用戶還可以通過寫入模塊的數據文件或者寫入gcov復位文件來丟棄已卸
118 gcov的內核分析插樁支持內核的編譯和運行是在同一臺機器上,也可以編譯和運
120 如果內核編譯和運行是不同的機器,那麼需要額外的準備工作,這取決於gcov工具
127 測試機上面gcov工具的版本必須要跟內核編譯機器使用的gcc版本相兼容,
138 特別需要注意,測試機器上面的目錄結構跟編譯機器上面的目錄機構必須
140 如果文件是軟鏈接,需要替換成真正的目錄文件(這是由make的當前工作
147 測試用例運行結束後,如下的文件需要從測試機中拷貝到編譯機上:
153 這些文件可以拷貝到編譯機的任意目錄下,gcov使用-o選項指定拷貝的
159 /tmp/out: 內核編譯文件路徑(make O=指定)
160 /tmp/coverage: 從測試機器上面拷貝的數據文件路徑
162 [user@build] cd /tmp/out
163 [user@build] gcov -o /tmp/coverage/tmp/out/init main.c
169 GCC和LLVM gcov工具不一定兼容。
170 如果編譯器是GCC,使用 gcov_ 來處理.gcno和.gcda文件,如果是Clang編譯器,
173 .. _gcov: https://gcc.gnu.org/onlinedocs/gcc/Gcov.html
174 .. _llvm-cov: https://llvm.org/docs/CommandGuide/llvm-cov.html
176 GCC和Clang gcov之間的版本差異由Kconfig處理的。
177 kconfig會根據編譯工具鏈的檢查自動選擇合適的gcov格式。
186 分析標誌指定在了源文件但是沒有鏈接到主內核,或者客製化了鏈接程序
189 通過在相應的Makefile中使用 ``GCOV_PROFILE := n``
190 或者 ``GCOV_PROFILE_basename.o := n`` 來將鏈接報錯的文件排除掉
196 由於seq_file的工作方式,某些工具(例如cp或tar)可能無法正確地從
200 使用 ``cat`` 讀取 ``.gcda`` 文件,使用 ``cp -d`` 複製鏈接,或者使用附錄B
204 附錄A:collect_on_build.sh
205 --------------------------
208 (見 :ref:`編譯機和測試機分離 a. <gcov-test_zh>` )
218 if [ -z "$KSRC" ] || [ -z "$KOBJ" ] || [ -z "$DEST" ]; then
219 echo "Usage: $0 <ksrc directory> <kobj directory> <output.tar.gz>" >&2
223 KSRC=$(cd $KSRC; printf "all:\n\t@echo \${CURDIR}\n" | make -f -)
224 KOBJ=$(cd $KOBJ; printf "all:\n\t@echo \${CURDIR}\n" | make -f -)
226 find $KSRC $KOBJ \( -name '*.gcno' -o -name '*.[ch]' -o -type l \) -a \
227 -perm /u+r,g+r | tar cfz $DEST -P -T -
229 if [ $? -eq 0 ] ; then
230 echo "$DEST successfully created, copy to test system and unpack with:"
231 echo " tar xfz $DEST -P"
233 echo "Could not create file $DEST"
237 附錄B:collect_on_test.sh
238 -------------------------
240 用於在測試機上收集覆蓋率數據文件的示例腳本
241 (見 :ref:`編譯機和測試機分離 b. <gcov-build_zh>` )
248 GCDA=/sys/kernel/debug/gcov
250 if [ -z "$DEST" ] ; then
251 echo "Usage: $0 <output.tar.gz>" >&2
256 echo Collecting data..
257 find $GCDA -type d -exec mkdir -p $TEMPDIR/\{\} \;
258 find $GCDA -name '*.gcda' -exec sh -c 'cat < $0 > '$TEMPDIR'/$0' {} \;
259 find $GCDA -name '*.gcno' -exec sh -c 'cp -d $0 '$TEMPDIR'/$0' {} \;
260 tar czf $DEST -C $TEMPDIR sys
263 echo "$DEST successfully created, copy to build system and unpack with:"
264 echo " tar xfz $DEST"