1.. include:: ../disclaimer-zh_CN.rst 2 3:Original: Documentation/dev-tools/gcov.rst 4:Translator: 赵军奎 Bernard Zhao <bernard@vivo.com> 5 6在Linux内核里使用gcov做代码覆盖率检查 7===================================== 8 9gcov分析核心支持在Linux内核中启用GCC的覆盖率测试工具 gcov_ ，Linux内核 10运行时的代码覆盖率数据会以gcov兼容的格式导出到“gcov”debugfs目录中，可 11以通过gcov的 ``-o`` 选项（如下示例）获得指定文件的代码运行覆盖率统计数据 12（需要跳转到内核编译路径下并且要有root权限）:: 13 14 # cd /tmp/linux-out 15 # gcov -o /sys/kernel/debug/gcov/tmp/linux-out/kernel spinlock.c 16 17这将在当前目录中创建带有执行计数注释的源代码文件。 18在获得这些统计文件后，可以使用图形化的gcov前端工具（比如 lcov_ ），来实现 19自动化处理Linux内核的覆盖率运行数据，同时生成易于阅读的HTML格式文件。 20 21可能的用途: 22 23* 调试（用来判断每一行的代码是否已经运行过） 24* 测试改进（如何修改测试代码，尽可能地覆盖到没有运行过的代码） 25* 内核最小化配置（对于某一个选项配置，如果关联的代码从来没有运行过， 26 是否还需要这个配置） 27 28.. _gcov: https://gcc.gnu.org/onlinedocs/gcc/Gcov.html 29.. _lcov: http://ltp.sourceforge.net/coverage/lcov.php 30 31 32准备 33---- 34 35内核打开如下配置:: 36 37 CONFIG_DEBUG_FS=y 38 CONFIG_GCOV_KERNEL=y 39 40获取整个内核的覆盖率数据，还需要打开:: 41 42 CONFIG_GCOV_PROFILE_ALL=y 43 44需要注意的是，整个内核开启覆盖率统计会造成内核镜像文件尺寸的增大， 45同时内核运行也会变慢一些。 46另外，并不是所有的架构都支持整个内核开启覆盖率统计。 47 48代码运行覆盖率数据只在debugfs挂载完成后才可以访问:: 49 50 mount -t debugfs none /sys/kernel/debug 51 52 53定制化 54------ 55 56如果要单独针对某一个路径或者文件进行代码覆盖率统计，可以在内核相应路 57径的Makefile中增加如下的配置: 58 59- 单独统计单个文件（例如main.o）:: 60 61 GCOV_PROFILE_main.o := y 62 63- 单独统计某一个路径:: 64 65 GCOV_PROFILE := y 66 67如果要在整个内核的覆盖率统计（开启CONFIG_GCOV_PROFILE_ALL）中单独排除 68某一个文件或者路径，可以使用如下的方法:: 69 70 GCOV_PROFILE_main.o := n 71 72和:: 73 74 GCOV_PROFILE := n 75 76此机制仅支持链接到内核镜像或编译为内核模块的文件。 77 78 79相关文件 80-------- 81 82gcov功能需要在debugfs中创建如下文件: 83 84``/sys/kernel/debug/gcov`` 85 gcov相关功能的根路径 86 87``/sys/kernel/debug/gcov/reset`` 88 全局复位文件:向该文件写入数据后会将所有的gcov统计数据清0 89 90``/sys/kernel/debug/gcov/path/to/compile/dir/file.gcda`` 91 gcov工具可以识别的覆盖率统计数据文件，向该文件写入数据后 92 会将本文件的gcov统计数据清0 93 94``/sys/kernel/debug/gcov/path/to/compile/dir/file.gcno`` 95 gcov工具需要的软连接文件（指向编译时生成的信息统计文件），这个文件是 96 在gcc编译时如果配置了选项 ``-ftest-coverage`` 时生成的。 97 98 99针对模块的统计 100-------------- 101 102内核中的模块会动态的加载和卸载，模块卸载时对应的数据会被清除掉。 103gcov提供了一种机制，通过保留相关数据的副本来收集这部分卸载模块的覆盖率数据。 104模块卸载后这些备份数据在debugfs中会继续存在。 105一旦这个模块重新加载，模块关联的运行统计会被初始化成debugfs中备份的数据。 106 107可以通过对内核参数gcov_persist的修改来停用gcov对模块的备份机制:: 108 109 gcov_persist = 0 110 111在运行时，用户还可以通过写入模块的数据文件或者写入gcov复位文件来丢弃已卸 112载模块的数据。 113 114 115编译机和测试机分离 116------------------ 117 118gcov的内核分析插桩支持内核的编译和运行是在同一台机器上，也可以编译和运 119行是在不同的机器上。 120如果内核编译和运行是不同的机器，那么需要额外的准备工作，这取决于gcov工具 121是在哪里使用的: 122 123.. _gcov-test_zh_CN: 124 125a) 若gcov运行在测试机上 126 127 测试机上面gcov工具的版本必须要跟内核编译机器使用的gcc版本相兼容， 128 同时下面的文件要从编译机拷贝到测试机上: 129 130 从源代码中: 131 - 所有的C文件和头文件 132 133 从编译目录中: 134 - 所有的C文件和头文件 135 - 所有的.gcda文件和.gcno文件 136 - 所有目录的链接 137 138 特别需要注意，测试机器上面的目录结构跟编译机器上面的目录机构必须 139 完全一致。 140 如果文件是软链接，需要替换成真正的目录文件（这是由make的当前工作 141 目录变量CURDIR引起的）。 142 143.. _gcov-build_zh_CN: 144 145b) 若gcov运行在编译机上 146 147 测试用例运行结束后，如下的文件需要从测试机中拷贝到编译机上: 148 149 从sysfs中的gcov目录中: 150 - 所有的.gcda文件 151 - 所有的.gcno文件软链接 152 153 这些文件可以拷贝到编译机的任意目录下，gcov使用-o选项指定拷贝的 154 目录。 155 156 比如一个是示例的目录结构如下:: 157 158 /tmp/linux: 内核源码目录 159 /tmp/out: 内核编译文件路径（make O=指定） 160 /tmp/coverage: 从测试机器上面拷贝的数据文件路径 161 162 [user@build] cd /tmp/out 163 [user@build] gcov -o /tmp/coverage/tmp/out/init main.c 164 165 166关于编译器的注意事项 167-------------------- 168 169GCC和LLVM gcov工具不一定兼容。 170如果编译器是GCC，使用 gcov_ 来处理.gcno和.gcda文件，如果是Clang编译器， 171则使用 llvm-cov_ 。 172 173.. _gcov: https://gcc.gnu.org/onlinedocs/gcc/Gcov.html 174.. _llvm-cov: https://llvm.org/docs/CommandGuide/llvm-cov.html 175 176GCC和Clang gcov之间的版本差异由Kconfig处理的。 177kconfig会根据编译工具链的检查自动选择合适的gcov格式。 178 179问题定位 180-------- 181 182可能出现的问题1 183 编译到链接阶段报错终止 184 185问题原因 186 分析标志指定在了源文件但是没有链接到主内核，或者客制化了链接程序 187 188解决方法 189 通过在相应的Makefile中使用 ``GCOV_PROFILE := n`` 190 或者 ``GCOV_PROFILE_basename.o := n`` 来将链接报错的文件排除掉 191 192可能出现的问题2 193 从sysfs复制的文件显示为空或不完整 194 195问题原因 196 由于seq_file的工作方式，某些工具（例如cp或tar）可能无法正确地从 197 sysfs复制文件。 198 199解决方法 200 使用 ``cat`` 读取 ``.gcda`` 文件，使用 ``cp -d`` 复制链接，或者使用附录B 201 中所示的机制。 202 203 204附录A：collect_on_build.sh 205-------------------------- 206 207用于在编译机上收集覆盖率元文件的示例脚本 208（见 :ref:`编译机和测试机分离 a. <gcov-test_zh_CN>` ） 209 210.. code-block:: sh 211 212 #!/bin/bash 213 214 KSRC=$1 215 KOBJ=$2 216 DEST=$3 217 218 if [ -z "$KSRC" ] || [ -z "$KOBJ" ] || [ -z "$DEST" ]; then 219 echo "Usage: $0 <ksrc directory> <kobj directory> <output.tar.gz>" >&2 220 exit 1 221 fi 222 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 -) 225 226 find $KSRC $KOBJ \( -name '*.gcno' -o -name '*.[ch]' -o -type l \) -a \ 227 -perm /u+r,g+r | tar cfz $DEST -P -T - 228 229 if [ $? -eq 0 ] ; then 230 echo "$DEST successfully created, copy to test system and unpack with:" 231 echo " tar xfz $DEST -P" 232 else 233 echo "Could not create file $DEST" 234 fi 235 236 237附录B：collect_on_test.sh 238------------------------- 239 240用于在测试机上收集覆盖率数据文件的示例脚本 241（见 :ref:`编译机和测试机分离 b. <gcov-build_zh_CN>` ） 242 243.. code-block:: sh 244 245 #!/bin/bash -e 246 247 DEST=$1 248 GCDA=/sys/kernel/debug/gcov 249 250 if [ -z "$DEST" ] ; then 251 echo "Usage: $0 <output.tar.gz>" >&2 252 exit 1 253 fi 254 255 TEMPDIR=$(mktemp -d) 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 261 rm -rf $TEMPDIR 262 263 echo "$DEST successfully created, copy to build system and unpack with:" 264 echo " tar xfz $DEST" 265