GCOV+LCOV 代码调试和覆盖率统计工具

CSDN GitHub
GCOV+LCOV 代码调试和覆盖率统计工具 AderXCoding/system/tools/gdb/gcov


知识共享许可协议

本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可, 转载请注明出处, 谢谢合作

因本人技术水平和知识面有限, 内容如有纰漏或者需要修正的地方, 欢迎大家指正, 也欢迎大家提供一些其他好的调试工具以供收录, 鄙人在此谢谢啦


1 GCOV介绍


2 GCOV使用方法


gcovLinuxGCC 自带的一个 C/C++ 代码覆盖率分析工具.

gcov 常用参数 :

参数 描述
-a 输出每个基本块的运行计数, 此选项可用于统计在同一行中的若干语句的各自运行次数
-b 输出分支语句频率信息到输出文件, 以及概要信息到标准输出, 但不显示无条件分支
-c 以数字而不是百分比显示分支频率
-n 不创建输出文件
-l 创建的输出文件名中包含头文件名, 这对于头文件中包含代码并被多个源文件使用时有用
-p .gocv 文件名中加入完整的路径信息, 此时路径中的 ‘/’ 用 ‘#’ 表示, ‘..’ 用 ‘^’ 表示
-f 输出每个函数的概要信息

.gcov 文件的基本格式是 :

执行次数(- 表示该行没代码, ##### 表示该行从未执行过):行号:该行代码

交叉 profiling :

gcov 要求运行时在目标系统中有相同的编译时的绝对目录路径, 为了支持交叉编译, 可使用下面两个
环境变量重定位数据文件 :

环境变量 描述
GCOV PREFIX 指定加入到目标文件中的绝对路径前缀, 默认没有前缀
GCOV PREFIX STRIP 指示要跳过的目录层次

比如编译后目标文件在 /user/build/foo.o, 编译后的程序执行时会创建 /user/build/foo.gcda 文件. 但若把程序拷贝到目标系统中运行时, 可能并没有这个目录, 此时设置环境变量.

‘GCOV_PREFIX=/target/run’

‘GCOV_PREFIX_STRIP=1’

这样, 运行时将输出到 /target/run/build/foo.gcda 文件. 然后可把生成的所有. gcda 文件拷贝到本机编译时的代码目录中使用 gcov 工具.

  • 编译程序

使用方法 : 在 gcc 或者 g++ 后面添加参数 -fprofile-arcs -ftest-coverage

注意 :

-fprofile-arcs -ftest-coverage

必须同时在编译器和链接器上设置, Makefile 里面可以加在 CFLAGSLDFLAGS 上, 如果连接的时候出现 undefined reference to '__gcov_init' 错误, 则还要加上 -lgocv

  • 运行程序生成 gcda 数据文件

编译成功后运行编译好的程序, 然后退出程序. 程序会在当前目录下生成 *.gcda 文件.

  • 使用 gcov 生成 .gcov 代码覆盖数据

然后使用 gcov *.c 或者 gcov *.cpp 生成代码覆盖信息, 这个时候需要将原始代码文件 *.cpp 或者 *.c 放在 *.gcda 文件一个目录中.

完成后会生成 *.c.gcov 或者 *.cpp.gcov 文件, 里面包含了代码覆盖信息.

  • lcov 生成 info 图形化数据

由于 *.gcov 是文字模式的, linux 还自带了一个 lcov 工具, 可以帮助我们把文字的信息转换成更直观的图形表格模式.

lcov -d . -t '表格名称' -o '文件名称.info' -b . -c
  • gethtml 生成 html 图形文件

此时还没完, 这个指令只是输出了一个 info 的中间文件, 要变成 html 格式的图形文件.

还要下面的指令 :

genhtml -o 输出目录名 文件名.info

这样才会在输出目录中生成完整的 html 图形文件, 用浏览器在文件目录中打开 index 文件就能看到了.

3 示例


3.1 示例程序


我们的程序由两个文件 test.cmain.c 组成.

想要用 gcov 收集代码覆盖信息, 需要在 gcc 编译代码的时候加上这 2 个选项 -fprofile-arcs -ftest-coverage.

// test.c
#include <stdio.h>

void test(int count)
{
    int i;
    for (i = 1; i < count; i++)
    {
        if (i % 3 == 0)
            printf ("%d is divisible by 3\n", i);
        if (i % 11 == 0)
            printf ("%d is divisible by 11\n", i);
        if (i % 13 == 0)
            printf ("%d is divisible by 13\n", i);
    }
}
// main.c
#include <stdio.h>
#include <stdlib.h>

void test(int vount);

int main(int argc, char *argv[])
{
    int i = 0;
    if(argc == 2)
        i = atoi(argv[1]);
    else
        i = 10;

    printf("arg is %d\n", i);

    test(i);

    return EXIT_SUCCESS;
}
// Makefile
GCOV_FLAGS=-fprofile-arcs -ftest-coverage
CFLAGS+=$(GCOV_FLAGS)
LDFLAGS+=-lpthread $(GCOV_FLAGS)

target=main


all:$(target)


main : test.o main.o
    $(CC) $(CFLAGS) $^ -o $@ $(LDFLAGS)
    @echo "gdb-gcov测试程序覆盖率..."


%.o : %.c
    $(CC) -g -c $^ -o $@  $(CFLAGS) $(DEFINES)

.PHONY : clean
clean :
    rm -rf *.o
    rm -rf $(target)
    rm -rf  *.gcov *.gcda *.gcno

3.2 编译程序


编译后会得到一个可执行文件 main, 然后每个 C 文件都对应一个 *.gcno 文件

当用 gcc 编译文件的时候, 如果带有 "-ftest-coverage" 参数, 就会生成这个 *.gcno 文件, 它包含了程序块和行号等信息.

编译程序

3.3 运行程序


接下来可以运行这个 main 的程序

./main

运行结束以后会生成一个 main.gcda 文件, 如果一个可执行文件带有 "-fprofile-arcs" 参数编译出来, 并且运行过至少一次, 就会生成. 这个文件包含了程序基本块跳转的信息.

运行程序

3.4 GCOV 生成代码覆盖数据


接下来可以用 gcov 生成代码覆盖信息

gcov main.c
gcov test.c

运行结束以后会生成2个文件hello.c.gcov和myfunc.c.gcov。打开看里面的信息:

生成 <code>gcov</code> 数据

被标记为 ##### 的代码行就是没有被执行过的, 代码覆盖的信息是正确的, 但是让人去读这些文字, 实在是一个杯具. 不用担心, 有另外一个工具叫 lcov, 可以用程序解析这些晦涩的字符, 最终输出成 html格式的报告.

3.5 lcov生成 info 数据


指定 lcov 在当前目录 “.” 去找代码覆盖的信息, 输出为 main_test.info, 这个 main_test.info 是一个中间结果, 需要把它用 1genhtml 来处理一下, genhtmllcov里面的一个工具。

lcov生成info数据

3.6 生成 html 数据


genhtml -o result main_test.info

指定输出目录是 result. 一个完整的 html 报告就生成了, 做一个连接, 把这个目录连到随便一个 web server 的目录下, 就可以看报告了.

生成 <code>html</code>

生成的信息

整体数据

显示 <code>main</code> 的信息

显示 <code>test</code> 的信息

4 参考


Gcov 详解 + 内核函数覆盖率测试方法详述及产生错误解决办法

代码覆盖率——gcov lcov的使用

GCOV 使用用例

gcov lcov覆盖率统计工具

代码覆盖率分析(gcov)

gcov分析代码覆盖率/gcov输出文件路径问题

GCOV 用法

试用内核gcov

gcov-kernel - a gcov infrastructure for the Linux kernel

Gcov单元测试覆盖率 ( by quqi99 )

GCC Coverage代码分析-.gcda/.gcno文件及其格式分析


猜你喜欢

转载自blog.csdn.net/gatieme/article/details/78368667