Linux 交叉编译使用代码覆盖GCOV及LCOV

1. GCOV

GCOV 是 GCC 自带的代码覆盖工具,GCOV

  1. 在 GCC 编译的时加入特殊的编译选项,生成可执行文件,和 *.gcno
  2. 运行(测试)生成的可执行文件,生成了 *.gcda 数据文件;
  3. 有了 *.gcno*.gcda,通过源码生成 gcov 文件,最后生成代码覆盖率报告。

2. 生成 gcno 及 gcda 文件:本机编译运行

CMakeLists.txt

cmake_minimum_required(VERSION 3.0)
project(gtest_sample C CXX)

# cmake set info
set(CMAKE_VERBOSE_MAKEFILE ON)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

# set( GCC_COVERAGE_LINK_FLAGS    "-coverage -lgcov" )
set( CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} -coverage" )
# set( CMAKE_EXE_LINKER_FLAGS  "${CMAKE_EXE_LINKER_FLAGS} ${GCC_COVERAGE_LINK_FLAGS}" )

set( CMAKE_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/bin" )
set( CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/bin" )
include_directories("${PROJECT_SOURCE_DIR}/include")
link_directories(${PROJECT_SOURCE_DIR}/bin)

add_subdirectory(utils)
add_subdirectory(test)
  1. 在 build 目录下,执行 cmake .. && make 之后,在相应的 obj 目录下生成 .gcno 文件:
find -name "*.gcno"
./build/test/CMakeFiles/gtest_sample.dir/main.cc.gcno
./build/utils/CMakeFiles/dcl_utils.dir/utils_logging.cc.gcno
./build/utils/CMakeFiles/dcl_utils.dir/utils_gtest.cc.gcno
  1. 在运行测试用例 gtest_sample 之后,在相应的obj目录下生成 .gcda 文件:
find -name "*.gcda"
./build/test/CMakeFiles/gtest_sample.dir/main.cc.gcda
./build/utils/CMakeFiles/dcl_utils.dir/utils_gtest.cc.gcda
./build/utils/CMakeFiles/dcl_utils.dir/utils_logging.cc.gcda
  1. 改变 .gcda 文件目录

在运行测试代码特别是交叉编译的测试代码时,使用 GCOV_PREFIX 改变 .gcda 文件存放的根目录;使用 GCOV_PREFIX_STRIP 消除 .gcda 存放目录(从顶级目录开始消除)。
比如 main.cc.gcda 实际存放目录为 9 级:

/home/hxf0223/work/gtest_gcov_sample/build/test/CMakeFiles/gtest_sample.dir/main.cc.gcda

操作如下:

export GCOV_PREFIX=$PWD
export GCOV_PREFIX_STRIP=9

再运行 gtest_sample (可以将 gtest_sample 拷贝到其他目录如 ~/tmp/)之后:

ls -lh
total 7.0M
-rwxr-xr-x 1 hxf0223 hxf0223 2.6M May  5 11:04 gtest_sample
-rw-r--r-- 1 hxf0223 hxf0223 4.3M May  5 11:04 libdcl_utils.a
-rw-r--r-- 1 hxf0223 hxf0223 4.6K May  5 11:10 main.cc.gcda
-rw-r--r-- 1 hxf0223 hxf0223 134K May  5 11:10 utils_gtest.cc.gcda
-rw-r--r-- 1 hxf0223 hxf0223 2.4K May  5 11:10 utils_logging.cc.gcda

如果在运行测试之前,设置 GCOV_PREFIX_STRIP 为 5 (即设置相对起始目录为 build),则运行测试之后,生成 build 目录,并从build开始,在各自相对目录下生成 gcda文件。

3. 交叉编译:收集数据,生成报告

# 安装lcov,包含 genhtml
sudo apt install lcov
  1. 运行得到 gcda 文件

将交叉编译得到的 gtest_sample 拷贝到目标板,目标板设置 GCOV_PREFIXGCOV_PREFIX_STRIP,运行得到包含 *.gcda 文件的目录。
将该目录拷贝回主机并覆盖同级目录(即 .gcda 文件与同名 .gcno 文件应该在同一目录)。

  1. 生成报告

进入build目录,使用命令lcov得到报告:

# 收集目录下的所有 `gcno` 及 `gcda` 文件,生成 `info` 文件(可以使用多个-d以添加多个目录)
lcov -c -d ./ -o all.info --gcov-tool=arm-linux-gnueabihf-gcov
# 过滤掉不需要统计的目录
lcov -r all.info "/usr/include/*" "gtest_utils*" -o result.info

# 转换 `.info` 文件为 `html` 文件,存放在 resul t目录下
genhtml -o result result.info
  1. gcov 官方参考

4. 参考

posted @ 2022-05-05 11:21  山岚2013  阅读(1909)  评论(0编辑  收藏  举报