GCOV(1)

๐Ÿ“ฆ
version 12.5.0 ยท 3 versions
, in ubuntu questing, ubuntu resolute, ubuntu stonking

๐Ÿ‘‘ gcov(1) โ€” GNUโ€™s own coverage queen ๐Ÿ‘‘

ok so this is the manual page for <pink>gcov</pink>, and yes itโ€™s a GNU thing, and yes it is about to become your whole personality for the next however-long. sit down bestie, weโ€™re doing coverage. ๐Ÿ’…


โœจ NAME โœจ

gcov โ€” coverage testing tool ๐ŸŽ€


๐Ÿฆ‹ SYNOPSIS ๐Ÿฆ‹

gcov [-v|--version] [-h|--help]
     [-a|--all-blocks]
     [-b|--branch-probabilities]
     [-c|--branch-counts]
     [-d|--display-progress]
     [-f|--function-summaries]
     [-j|--json-format]
     [-H|--human-readable]
     [-k|--use-colors]
     [-l|--long-file-names]
     [-m|--demangled-names]
     [-n|--no-output]
     [-o|--object-directory directory|file]
     [-p|--preserve-paths]
     [-q|--use-hotness-colors]
     [-r|--relative-only]
     [-s|--source-prefix directory]
     [-t|--stdout]
     [-u|--unconditional-branches]
     [-x|--hash-filenames]
     files

thatโ€™s the whole vibe right there. files at the end, everything else is optional flags. no cap.


๐Ÿ’– DESCRIPTION ๐Ÿ’–

okay so <pink>gcov</pink> is a test coverage program. like, its whole job is finding out which parts of your code actually ran and which parts are just sitting there collecting dust. ๐Ÿซง

you use it in concert with GCC to analyze your programs, so you can make more efficient, faster running code, and so you can discover the untested parts of your program. you can also use <pink>gcov</pink> as a profiling tool โ€” the kind that tells you where your optimization efforts will best affect your code. and you can run it alongside the other profiling tool, <purple>gprof</purple>, to assess which parts of your code are eating the greatest amount of computing time. teamwork!! ๐Ÿค

profiling tools help you analyze your codeโ€™s performance. with a profiler like <pink>gcov</pink> or <purple>gprof</purple>, you can find out some basic performance statistics, like:

  • how often each line of code executes ๐Ÿ‘€
  • what lines of code are actually executed ๐Ÿ’€ (some of them are NOT. the audacity.)
  • how much computing time each section of code uses โฑ๏ธ

once you know these things about how your code works when compiled, you can look at each module to see which modules should be optimized. <pink>gcov</pink> helps you determine where to work on optimization. sheโ€™s basically your little optimization compass. ๐Ÿงญ

software developers also use coverage testing in concert with testsuites, to make sure software is actually good enough for a release. testsuites can verify that a program works as expected; a coverage program tests to see how much of the program is exercised by the testsuite. then developers can determine what kinds of test cases need to be added to the testsuites, so they get both better testing and a better final product. itโ€™s giving โœจpersonal growthโœจ.

okay this next part is IMPORTANT bestie so read it twice:

you should compile your code without optimization if you plan to use <pink>gcov</pink>, because the optimization โ€” by combining some lines of code into one function โ€” may not give you as much information as you need to look for 'hot spots' where the code is using a great deal of computer time. ๐Ÿ”ฅ

likewise, because <pink>gcov</pink> accumulates statistics by line (at the lowest resolution), it works best with a programming style that places only one statement on each line. if you use complicated macros that expand to loops or to other control structures, the statistics are less helpful โ€” they only report on the line where the macro call appears. ๐Ÿ˜ญ if your complex macros behave like functions, you can replace them with inline functions to solve this problem. slay, problem solved. ๐Ÿ’…

<pink>gcov</pink> creates a logfile called sourcefile.gcov which indicates how many times each line of a source file sourcefile.c has executed. you can use these logfiles along with <purple>gprof</purple> to aid in fine-tuning the performance of your programs. <purple>gprof</purple> gives timing information you can use along with the information you get from <pink>gcov</pink>. iconic duo fr fr. ๐Ÿซถ

๐Ÿšจ real talk: <pink>gcov</pink> works only on code compiled with GCC. it is not compatible with any other profiling or test coverage mechanism. sheโ€™s exclusive. she has a type. itโ€™s GCC. ๐Ÿ’…

๐ŸŒˆ OPTIONS ๐ŸŒˆ

  • -a, --all-blocks โ€” write individual execution counts for every basic block. normally <pink>gcov</pink> only outputs execution counts for the main blocks of a line. with this option you can determine if blocks within a single line are not being executed. deep dive energy ๐Ÿ”
  • -b, --branch-probabilities โ€” write branch frequencies to the output file, and write branch summary info to the standard output. this option lets you see how often each branch in your program was taken. unconditional branches will not be shown, unless the -u option is given. (sheโ€™s picky like that ๐Ÿ’…)
  • -c, --branch-counts โ€” write branch frequencies as the number of branches taken, rather than the percentage of branches taken. numbers girlies rise ๐Ÿงฎ
  • -d, --display-progress โ€” display the progress on the standard output. so you can watch her work. โœจ
  • -f, --function-summaries โ€” output summaries for each function, in addition to the file level summary. every single one. no function left behind ๐Ÿซถ
  • -h, --help โ€” display help about using <pink>gcov</pink> (on the standard output), and exit without doing any further processing. a polite little exit. ๐ŸŽ€
  • -j, --json-format โ€” output the <pink>gcov</pink> file in an easy-to-parse JSON intermediate format which does not require source code for generation. the JSON file is compressed with gzip compression algorithm and the files have .gcov.json.gz extension. ๐Ÿ—œ๏ธ

structure of the JSON is following:

{
  "current_working_directory": "foo/bar",
  "data_file": "a.out",
  "format_version": "1",
  "gcc_version": "11.1.1 20210510"
  "files": ["$file"]
}

fields of the root element have following semantics:

  • current_working_directory: working directory where a compilation unit was compiled
  • data_file: name of the data file (GCDA)
  • format_version: semantic version of the format
  • gcc_version: version of the GCC compiler

each file has the following form:

{
  "file": "a.c",
  "functions": ["$function"],
  "lines": ["$line"]
}

fields of the file element have following semantics:

  • file_name: name of the source file

each function has the following form:

{
  "blocks": 2,
  "blocks_executed": 2,
  "demangled_name": "foo",
  "end_column": 1,
  "end_line": 4,
  "execution_count": 1,
  "name": "foo",
  "start_column": 5,
  "start_line": 1
}

fields of the function element have following semantics:

  • blocks: number of blocks that are in the function
  • blocks_executed: number of executed blocks of the function
  • demangled_name: demangled name of the function
  • end_column: column in the source file where the function ends
  • end_line: line in the source file where the function ends
  • execution_count: number of executions of the function
  • name: name of the function
  • start_column: column in the source file where the function begins
  • start_line: line in the source file where the function begins
note that line numbers and column numbers number from 1. in the current implementation, start_line and start_column do not include any template parameters and the leading return type but that this is likely to be fixed in the future. (future update pending, bestie โณ)

each line has the following form:

{
  "branches": ["$branch"],
  "count": 2,
  "line_number": 15,
  "unexecuted_block": false,
  "function_name": "foo",
}

branches are present only with -b option. fields of the line element have following semantics:

  • count: number of executions of the line
  • line_number: line number
  • unexecuted_block: flag whether the line contains an unexecuted block (not all statements on the line are executed)
  • function_name: a name of a function this line belongs to (for a line with an inlined statements can be not set)

each branch has the following form:

{
  "count": 11,
  "fallthrough": true,
  "throw": false
}

fields of the branch element have following semantics:

  • count: number of executions of the branch
  • fallthrough: true when the branch is a fall through branch
  • throw: true when the branch is an exceptional branch
  • -H, --human-readable โ€” write counts in human readable format (like 24.6k). because 24600 is not the moment, but 24.6k is ๐Ÿ’…
  • -k, --use-colors โ€” use colors for lines of code that have zero coverage. we use red color for non-exceptional lines and cyan for exceptional. same colors are used for basic blocks with the -a option. aesthetic AND informative ๐ŸŒˆ
  • -l, --long-file-names โ€” create long file names for included source files. for example, if the header file x.h contains code, and was included in the file a.c, then running <pink>gcov</pink> on the file a.c will produce an output file called a.c##x.h.gcov instead of x.h.gcov. this can be useful if x.h is included in multiple source files and you want to see the individual contributions. if you use the -p option, both the including and included file names will be complete path names. ๐Ÿงต
  • -m, --demangled-names โ€” display demangled function names in output. the default is to show mangled function names. (mangled names are giving _ZN3fooEv ๐Ÿ’€, demangled is giving foo ๐Ÿซถ)
  • -n, --no-output โ€” do not create the <pink>gcov</pink> output file. look but donโ€™t touch energy ๐Ÿ™ˆ
  • -o directory|file, --object-directory directory, --object-file file โ€” specify either the directory containing the <pink>gcov</pink> data files, or the object path name. the .gcno, and .gcda data files are searched for using this option. if a directory is specified, the data files are in that directory and named after the input file name, without its extension. if a file is specified here, the data files are named after that file, without its extension. ๐Ÿ“
  • -p, --preserve-paths โ€” preserve complete path information in the names of generated .gcov files. without this option, just the filename component is used. with this option, all directories are used, with / characters translated to # characters, . directory components removed and unremoveable .. components renamed to ^. this is useful if sourcefiles are in several different directories. (the path gettin a whole makeover ๐Ÿ’…)
  • -q, --use-hotness-colors โ€” emit perf-like colored output for hot lines. legend of the color scale is printed at the very beginning of the output file. ๐Ÿ”ฅ hot lines stay hot ๐Ÿ”ฅ
  • -r, --relative-only โ€” only output information about source files with a relative pathname (after source prefix elision). absolute paths are usually system header files and coverage of any inline functions therein is normally uninteresting. we donโ€™t care about them, respectfully ๐Ÿ’€
  • -s directory, --source-prefix directory โ€” bestie, this one is a prefix for source file names that you want stripped off when gcov makes its output coverage files. It's literally made for when you build in a whole separate directory and you do not want that long source path showing up in the output filenames. Heads up though: this prefix detection happens before gcov figures out whether the source file is absolute. So order matters, okay? ๐Ÿ’…
  • -t, --stdout โ€” output goes to standard output instead of into output files. Simple as that. โœจ
  • -u, --unconditional-branches โ€” when branch probabilities are being printed, this says include the unconditional branches too. Normally unconditional branches are just not interesting, so they get left out. But if you want the full tea, here you go. ๐Ÿต
  • -v, --version โ€” shows the gcov version number on standard output, then dips out immediately. No further processing, periodt. ๐Ÿ‘‘
  • -w, --verbose โ€” prints verbose info related to basic blocks and arcs. That's it. ๐Ÿงš
  • -x, --hash-filenames โ€” okay so when you use --preserve-paths, gcov uses the full pathname of the source files to build an output filename. That can give you long filenames that straight up overflow filesystem limits. This option instead makes names of the form source-file##md5.gcov, where the source-file part is just the final filename part, and the md5 part is calculated from the full mangled name that would've been used otherwise. It's an alternative to --preserve-paths on systems that have a filesystem limit. ๐ŸŒˆ

gcov should be run with the current directory being the same as when you invoked the compiler. Otherwise it will not be able to locate the source files. No cap. ๐Ÿ˜ญ

gcov produces files called mangledname.gcov in the current directory. These contain the coverage information of the source file they correspond to. One .gcov file is produced for each source (or header) file containing code that was compiled to produce the data files. The mangledname part of the output file name is usually just the source file name, but it can be something more complicated if the -l or -p options are given. Refer to those options for details. ๐Ÿ’–

If you invoke gcov with multiple input files, the contributions from each input file are summed. Typically you'd invoke it with the same list of files as the final link of your executable. Slay. โœจ

The .gcov files contain : separated fields along with program source code. The format is:

<execution_count>:<line_number>:<source line text>

Additional block information may succeed each line, when requested by command line option. The execution_count is - for lines containing no code. Unexecuted lines are marked ##### or =====, depending on whether they are reachable by non-exceptional paths or only exceptional paths such as C++ exception handlers, respectively. Given the -a option, unexecuted blocks are marked $$$$$ or %%%%%, depending on whether a basic block is reachable via non-exceptional or exceptional paths. Executed basic blocks having a statement with zero execution_count end with * character and are colored with magenta color with the -k option. This functionality is not supported in Ada. ๐Ÿ’€

Note that GCC can completely remove the bodies of functions that are not needed โ€” for instance if they are inlined everywhere. Such functions are marked with -, which can be confusing. Use the -fkeep-inline-functions and -fkeep-static-functions options to retain these functions and allow gcov to properly show their execution_count. ๐Ÿ™ˆ

Some lines of information at the start have line_number of zero. These preamble lines are of the form:

-:0:<tag>:<value>

The ordering and number of these preamble lines will be augmented as gcov development progresses โ€” do not rely on them remaining unchanged. Use tag to locate a particular preamble line. ๐ŸŽ€

The additional block information is of the form:

<tag> <information>

The information is human readable, but designed to be simple enough for machine parsing too. ๐Ÿฆ‹

When printing percentages, 0% and 100% are only printed when the values are exactly 0% and 100% respectively. Other values which would conventionally be rounded to 0% or 100% are instead printed as the nearest non-boundary value. ๐ŸŒธ

When using gcov, you must first compile your program with a special GCC option --coverage. This tells the compiler to generate additional information needed by gcov (basically a flow graph of the program) and also includes additional code in the object files for generating the extra profiling information needed by gcov. These additional files are placed in the directory where the object file is located. ๐Ÿ”ฅ

Running the program will cause profile output to be generated. For each source file compiled with -fprofile-arcs, an accompanying .gcda file will be placed in the object file directory. ๐Ÿ‘‘

Running gcov with your program's source file names as arguments will now produce a listing of the code along with frequency of execution for each line. For example, if your program is called tmp.cpp, this is what you see when you use the basic gcov facility:

$ g++ --coverage tmp.cpp -c
$ g++ --coverage tmp.o
$ a.out
$ gcov tmp.cpp -m
File 'tmp.cpp'
Lines executed:92.86% of 14
Creating 'tmp.cpp.gcov'

The file tmp.cpp.gcov contains output from gcov. Here is a sample:

                -:    0:Source:tmp.cpp
                -:    0:Working directory:/home/gcc/testcase
                -:    0:Graph:tmp.gcno
                -:    0:Data:tmp.gcda
                -:    0:Runs:1
                -:    0:Programs:1
                -:    1:#include <stdio.h>
                -:    2:
                -:    3:template<class T>
                -:    4:class Foo
                -:    5:{
                -:    6:  public:
               1*:    7:  Foo(): b (1000) {}
        ------------------
        Foo<char>::Foo():
            #####:    7:  Foo(): b (1000) {}
        ------------------
        Foo<int>::Foo():
                1:    7:  Foo(): b (1000) {}
        ------------------
               2*:    8:  void inc () { b++; }
        ------------------
        Foo<char>::inc():
            #####:    8:  void inc () { b++; }
        ------------------
        Foo<int>::inc():
                2:    8:  void inc () { b++; }
        ------------------
                -:    9:
                -:   10:  private:
                -:   11:  int b;
                -:   12:};
                -:   13:
                -:   14:template class Foo<int>;
                -:   15:template class Foo<char>;
                -:   16:
                -:   17:int
                1:   18:main (void)
                -:   19:{
                -:   20:  int i, total;
                1:   21:  Foo<int> counter;
                -:   22:
                1:   23:  counter.inc();
                1:   24:  counter.inc();
                1:   25:  total = 0;
                -:   26:
               11:   27:  for (i = 0; i < 10; i++)
               10:   28:    total += i;
                -:   29:
               1*:   30:  int v = total > 100 ? 1 : 2;
                -:   31:
                1:   32:  if (total != 45)
            #####:   33:    printf ("Failure\n");
                -:   34:  else
                1:   35:    printf ("Success\n");
                1:   36:  return 0;
                -:   37:}

Note that line 7 is shown in the report multiple times. First occurrence presents total number of execution of the line and the next two belong to instances of class Foo constructors. As you can also see, line 30 contains some unexecuted basic blocks and thus execution count has asterisk symbol. ๐Ÿ˜ญ

When you use the -a option, you will get individual block counts, and the output looks like this:

                -:    0:Source:tmp.cpp
                -:    0:Working directory:/home/gcc/testcase
                -:    0:Graph:tmp.gcno
                -:    0:Data:tmp.gcda
                -:    0:Runs:1
                -:    0:Programs:1
                -:    1:#include <stdio.h>
                -:    2:
                -:    3:template<class T>
                -:    4:class Foo
                -:    5:{
                -:    6:  public:
               1*:    7:  Foo(): b (1000) {}
        ------------------
        Foo<char>::Foo():
            #####:    7:  Foo(): b (1000) {}
        ------------------
        Foo<int>::Foo():
                1:    7:  Foo(): b (1000) {}
        ------------------
               2*:    8:  void inc () { b++; }
        ------------------
        Foo<char>::inc():
            #####:    8:  void inc () { b++; }
        ------------------
        Foo<int>::inc():
                2:    8:  void inc () { b++; }
        ------------------
                -:    9:
                -:   10:  private:
                -:   11:  int b;
                -:   12:};
                -:   13:
                -:   14:template class Foo<int>;
                -:   15:template class Foo<char>;
                -:   16:
                -:   17:int
                1:   18:main (void)
                -:   19:{
                -:   20:  int i, total;
                1:   21:  Foo<int> counter;
                1:   21-block  0
                -:   22:
                1:   23:  counter.inc();
                1:   23-block  0
                1:   24:  counter.inc();
                1:   24-block  0
                1:   25:  total = 0;
                -:   26:
               11:   27:  for (i = 0; i < 10; i++)
                1:   27-block  0
               11:   27-block  1
               10:   28:    total += i;
               10:   28-block  0
                -:   29:
               1*:   30:  int v = total > 100 ? 1 : 2;
                1:   30-block  0
            %%%%%:   30-block  1
                1:   30-block  2
                -:   31:
                1:   32:  if (total != 45)
                1:   32-block  0
            #####:   33:    printf ("Failure\n");
            %%%%%:   33-block  0
                -:   34:  else
                1:   35:    printf ("Success\n");
                1:   35-block  0
                1:   36:  return 0;
                1:   36-block  0
                -:   37:}

okay so in this mode, every basic block gets exactly one line of screentime โ€” and it's the last line of the block, bestie. ๐Ÿ’… That's the whole vibe.

Which means a multi-line block only contributes to the execution count of that last line, and the other lines won't be shown as containing code โ€” unless previous blocks end on those lines. The total execution count of a line gets shown, and then the lines after it show the execution counts for the individual blocks that end on that line. And after each block? You get that block's branch and call counts, if you passed the -b option. โœจ

Also, because of the way GCC instruments calls, you can get a call count hanging out after a line that has no individual blocks at all. And like โ€” as you can see, line 33 contains a basic block that was not executed. ๐Ÿ’€ iconic behaviour, honestly.

When you use the -b option, your output looks like this:

                       -:    0:Source:tmp.cpp
                       -:    0:Working directory:/home/gcc/testcase
                       -:    0:Graph:tmp.gcno
                       -:    0:Data:tmp.gcda
                       -:    0:Runs:1
                       -:    0:Programs:1
                       -:    1:#include <stdio.h>
                       -:    2:
                       -:    3:template<class T>
                       -:    4:class Foo
                       -:    5:{
                       -:    6:  public:
                      1*:    7:  Foo(): b (1000) {}
               ------------------
               Foo<char>::Foo():
               function Foo<char>::Foo() called 0 returned 0% blocks executed 0%
                   #####:    7:  Foo(): b (1000) {}
               ------------------
               Foo<int>::Foo():
               function Foo<int>::Foo() called 1 returned 100% blocks executed 100%
                       1:    7:  Foo(): b (1000) {}
               ------------------
                      2*:    8:  void inc () { b++; }
               ------------------
               Foo<char>::inc():
               function Foo<char>::inc() called 0 returned 0% blocks executed 0%
                   #####:    8:  void inc () { b++; }
               ------------------
               Foo<int>::inc():
               function Foo<int>::inc() called 2 returned 100% blocks executed 100%
                       2:    8:  void inc () { b++; }
               ------------------
                       -:    9:
                       -:   10:  private:
                       -:   11:  int b;
                       -:   12:};
                       -:   13:
                       -:   14:template class Foo<int>;
                       -:   15:template class Foo<char>;
                       -:   16:
                       -:   17:int
               function main called 1 returned 100% blocks executed 81%
                       1:   18:main (void)
                       -:   19:{
                       -:   20:  int i, total;
                       1:   21:  Foo<int> counter;
               call    0 returned 100%
               branch  1 taken 100% (fallthrough)
               branch  2 taken 0% (throw)
                       -:   22:
                       1:   23:  counter.inc();
               call    0 returned 100%
               branch  1 taken 100% (fallthrough)
               branch  2 taken 0% (throw)
                       1:   24:  counter.inc();
               call    0 returned 100%
               branch  1 taken 100% (fallthrough)
               branch  2 taken 0% (throw)
                       1:   25:  total = 0;
                       -:   26:
                      11:   27:  for (i = 0; i < 10; i++)
               branch  0 taken 91% (fallthrough)
               branch  1 taken 9%
                      10:   28:    total += i;
                       -:   29:
                      1*:   30:  int v = total > 100 ? 1 : 2;
               branch  0 taken 0% (fallthrough)
               branch  1 taken 100%
                       -:   31:
                       1:   32:  if (total != 45)
               branch  0 taken 0% (fallthrough)
               branch  1 taken 100%
                   #####:   33:    printf ("Failure\n");
               call    0 never executed
               branch  1 never executed
               branch  2 never executed
                       -:   34:  else
                       1:   35:    printf ("Success\n");
               call    0 returned 100%
               branch  1 taken 100% (fallthrough)
               branch  2 taken 0% (throw)
                       1:   36:  return 0;
                       -:   37:}

So for each function, a line gets printed telling you how many times the function is called, how many times it returns, and what percentage of the function's blocks were executed. slay. ๐Ÿ“Š

For each basic block, a line gets printed after the last line of that basic block, describing the branch or call that ends it. And listen โ€” there can be multiple branches and calls listed for a single source line, if multiple basic blocks end on that line. In that case, the branches and the calls each get given a number. ๐Ÿ˜Œ There's no simple way to map those branches and calls back to source constructs, ngl. But in general? The lowest-numbered branch or call corresponds to the leftmost construct on the source line. iykyk.

For a branch: if it was executed at least once, you get a percentage โ€” the number of times the branch was taken divided by the number of times it was executed. Otherwise you just get the message "never executed". ๐Ÿ˜ญ

For a call: if it was executed at least once, you get a percentage โ€” the number of times the call returned divided by the number of times the call was executed. This is usually 100%, but it can be less for functions that call "exit" or "longjmp", because they might not return every single time they're called. fair. ๐Ÿ’…

The execution counts are cumulative. So if the example program got executed again without removing the .gcda file, the count for how many times each line in the source was executed would get added to the results of the previous run(s). Which is lowkey super useful in a few ways โ€” like, you could accumulate data over a number of program runs as part of a test verification suite, or get more accurate long-term info over a huge number of program runs. obsessed. ๐ŸŒธ

The data in the .gcda files gets saved immediately before the program exits. For each source file compiled with -fprofile-arcs, the profiling code first tries to read in an existing .gcda file; if the file doesn't match the executable (like, differing number of basic block counts), it just ignores the contents of the file. Then it adds in the new execution counts, and finally writes the data to the file. periodt. โœจ

๐ŸŽ€ Using gcov with GCC Optimization ๐ŸŽ€

So if you're planning to use gcov to help optimize your code, you first have to compile your program with a special GCC option โ€” --coverage. Aside from that, you can use any other GCC options you want. BUT โ€” and this is the important bit, bestie โ€” if you want to prove that every single line in your program was executed, you should not compile with optimization at the same time. ๐Ÿšซ

Why? On some machines the optimizer can eliminate some simple code lines by combining them with other lines. For example, code like this:

        if (a != b)
          c = 1;
        else
          c = 0;

can get compiled into one instruction on some machines. And in that case, there is no way for gcov to calculate separate execution counts for each line, because there isn't separate code for each line. ๐Ÿ˜ญ So the gcov output looks like this if you compiled the program with optimization:

                      100:   12:if (a != b)
                      100:   13:  c = 1;
                      100:   14:else
                      100:   15:  c = 0;

The output shows that this block of code, combined by optimization, executed 100 times. In one sense that result is correct โ€” there was only one instruction representing all four of those lines. However, the output does not indicate how many times the result was 0 and how many times the result was 1. ๐Ÿ’€

Inlineable functions can also create unexpected line counts. Line counts get shown for the source code of the inlineable function, but what's shown depends on where the function is inlined, or if it isn't inlined at all. ๐Ÿฆ‹

If the function is not inlined, the compiler has to emit an out of line copy of the function, in any object file that needs it. So if fileA.o and fileB.o both contain out of line bodies of a particular inlineable function, they'll also both contain coverage counts for that function. And when fileA.o and fileB.o get linked together, the linker will โ€” on many systems โ€” select one of those out of line bodies for all calls to that function, and remove or ignore the other. Unfortunately, it will not remove the coverage counters for the unused function body. ๐Ÿ˜ค Hence, when instrumented, all but one use of that function will show zero counts.

If the function is inlined in several places, the block structure in each location might not be the same. For instance, a condition might now be calculable at compile time in some instances. And because the coverage of all the uses of the inline function gets shown for the same source lines, the line counts themselves might seem inconsistent. ๐Ÿ™ˆ

Long-running applications can use the "__gcov_reset" and "__gcov_dump" facilities to restrict profile collection to the program region of interest. Calling "__gcov_reset(void)" clears all run-time profile counters to zero, and calling "__gcov_dump(void)" causes the profile information collected at that point to be dumped to .gcda output files. ๐Ÿ“

Instrumented applications use a static destructor with priority 99 to invoke the "__gcov_dump" function. So "__gcov_dump" is executed after all user defined static destructors, as well as handlers registered with "atexit". โœจ

Heads up bestie: if an executable loads a dynamic shared object via dlopen functionality, -Wl,--dynamic-list-data is needed to dump all profile data. don't skip that one. ๐Ÿ’…

The profiling run-time library reports various errors related to profile manipulation and profile saving. Those errors get printed into standard error output, or into the GCOV_ERROR_FILE file, if that environment variable is used. And if you want to terminate immediately after an error occurs, set the GCOV_EXIT_AT_ERROR environment variable. ๐Ÿ›‘

That can help users find profile clashing, which leads to a misleading profile. so like, genuinely helpful, no cap. ๐Ÿซถ


๐Ÿ‘‘ SEE ALSO ๐Ÿ‘‘

gpl(7), gfdl(7), fsf-funding(7), gcc(1) and the Info entry for gcc.


Copyright (c) 1996-2022 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with the Invariant Sections being "GNU General Public License" and "Funding Free Software", the Front-Cover texts being (a) (see below), and with the Back-Cover Texts being (b) (see below). A copy of the license is included in the gfdl(7) man page.

(a) The FSF's Front-Cover Text is:

     A GNU Manual

(b) The FSF's Back-Cover Text is:

     You have freedom to copy and modify this GNU Manual, like GNU
     software.  Copies published by the Free Software Foundation raise
     funds for GNU development.

and that's the whole page, bestie โ€” this one's from gcc-12.5.0, dated 2025-07-11, and it's the GCOV(1) manual page. go forth and profile responsibly. ๐Ÿ’–โœจ๐ŸŽ€

๐Ÿ“ฆ where this page comes from