LCOV/GCOV branch coverage with C++ producing branches all over the place

by

The thing is that GCC also records branch information for each line where a scope exit due to some thrown exception is possible (e.g. on Fedora 25 with GCC 6.3.1 and lcov 1.12).

The value of this information is limited. The main use case for branch coverage data are complicated if-statements that have a multi-clausal logical expression like this:

if (foo < 1 && (bar > x || y == 0))

Say you are interested to verify whether your test suite also covers the bar > x case or if you just have test cases where y == 0.

For this, branch coverage data collection and the visualization by lcov’s genhtml is useful. For simple if-statements like

if (p == nullptr) {
  return false;
}
return true;

you don’t need branch coverage data because you see whether the branch was taken or not via looking at the coverage of the following lines.

The input of genhtml that is generated by lcov is in a relatively simple text format (cf. geninfo(1)). Thus, you can post-process it such that all lines that start with BRDA: and don’t belong to an if-statement are removed. See for example filterbr.py which implements this approach. See also gen-coverage.py for the other lcov/genhtml processing steps and an example project where the resulting trace file is uploaded to codecov (codecov doesn’t use genhtml but can import lcov trace files and displays branch coverage data).

(Non-)Alternatives

  • disabling exceptions is only an option when your C++ code doesn’t use any
  • compiling with something like -O1 -fno-omit-frame-pointer -fno-optimize-sibling-calls somewhat reduces the number of recorded branch coverage data, but not much
  • Clang supports GCOV style coverage collection but also implements a different approach, called ‘source-based code coverage’ (compile with -fprofile-instr-generate -fcoverage-mapping and post-process with llvm-profdata and llvm-cov). That toolchain doesn’t support branch coverage data, though (as of 2017-05-01).
  • by default, lcov+genhtml don’t generate branch coverage data – sometimes you don’t really need it (see above), thus, it is then an option to disable it (cf. --rc lcov_branch_coverage=0 and --no-branch-coverage)

More Related Contents:

  1. What is the branch in the destructor reported by gcov?
  2. Detailed guide on using gcov with CMake/CDash?
  3. Using local variable outside its scope
  4. Regarding time out in code
  5. What are the differences between a pointer variable and a reference variable in C++?
  6. Why is integer assignment on a naturally aligned variable atomic on x86?
  7. Operator[][] overload
  8. How to turn on (literally) ALL of GCC’s warnings?
  9. Why can’t simple initialize (with braces) 2D std::array? [duplicate]
  10. What’s the scope of inline friend functions?
  11. How to convert std::string to LPCWSTR in C++ (Unicode)
  12. How can I get double quotes into a string literal?
  13. How to recompile with -fPIC
  14. Sharing a global/static variable between a process and DLL
  15. Can I use Visual Studio 2010’s C++ compiler with Visual Studio 2008’s C++ Runtime Library?
  16. Repeated Multiple Definition Errors from including same header in multiple cpps
  17. What is the default value for C++ class members
  18. std::map default value
  19. what is “stack alignment”?
  20. Are there any macros to determine if my code is being compiled to Windows? [duplicate]
  21. What are the main purposes of std::forward and which problems does it solve?
  22. MATLAB vs C++ vs OpenCV – imresize
  23. c++ data alignment /member order & inheritance
  24. Get size of terminal window (rows/columns)
  25. Calculate rolling / moving average in C++
  26. Override and overload in C++
  27. Using an iterator to Divide an Array into Parts with Unequal Size
  28. ifstream not reading EOF character
  29. how to assign multiple values into a struct at once?
  30. Is there a safe navigation operator for C++?

Leave a Comment