2003-08-30 Richard Earnshaw <rearnsha@arm.com>
[official-gcc.git] / gcc / doc / gcov.texi
blob731a37a871f603055d014b57442ecc18449a2c13
1 @c Copyright (C) 1996, 1997, 1999, 2000, 2001,
2 @c 2002, 2003 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1996, 1997, 1999, 2000, 2001, 2002, 2003
9 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcov
31 @settitle coverage testing tool
32 @end ignore
34 @node Gcov
35 @chapter @command{gcov}---a Test Coverage Program
37 @command{gcov} is a tool you can use in conjunction with GCC to
38 test code coverage in your programs.
40 @menu
41 * Gcov Intro::                  Introduction to gcov.
42 * Invoking Gcov::               How to use gcov.
43 * Gcov and Optimization::       Using gcov with GCC optimization.
44 * Gcov Data Files::             The files used by gcov.
45 @end menu
47 @node Gcov Intro
48 @section Introduction to @command{gcov}
49 @c man begin DESCRIPTION
51 @command{gcov} is a test coverage program.  Use it in concert with GCC
52 to analyze your programs to help create more efficient, faster running
53 code and to discover untested parts of your program.  You can use
54 @command{gcov} as a profiling tool to help discover where your
55 optimization efforts will best affect your code.  You can also use
56 @command{gcov} along with the other profiling tool, @command{gprof}, to
57 assess which parts of your code use the greatest amount of computing
58 time.
60 Profiling tools help you analyze your code's performance.  Using a
61 profiler such as @command{gcov} or @command{gprof}, you can find out some
62 basic performance statistics, such as:
64 @itemize @bullet
65 @item
66 how often each line of code executes
68 @item
69 what lines of code are actually executed
71 @item
72 how much computing time each section of code uses
73 @end itemize
75 Once you know these things about how your code works when compiled, you
76 can look at each module to see which modules should be optimized.
77 @command{gcov} helps you determine where to work on optimization.
79 Software developers also use coverage testing in concert with
80 testsuites, to make sure software is actually good enough for a release.
81 Testsuites can verify that a program works as expected; a coverage
82 program tests to see how much of the program is exercised by the
83 testsuite.  Developers can then determine what kinds of test cases need
84 to be added to the testsuites to create both better testing and a better
85 final product.
87 You should compile your code without optimization if you plan to use
88 @command{gcov} because the optimization, by combining some lines of code
89 into one function, may not give you as much information as you need to
90 look for `hot spots' where the code is using a great deal of computer
91 time.  Likewise, because @command{gcov} accumulates statistics by line (at
92 the lowest resolution), it works best with a programming style that
93 places only one statement on each line.  If you use complicated macros
94 that expand to loops or to other control structures, the statistics are
95 less helpful---they only report on the line where the macro call
96 appears.  If your complex macros behave like functions, you can replace
97 them with inline functions to solve this problem.
99 @command{gcov} creates a logfile called @file{@var{sourcefile}.gcov} which
100 indicates how many times each line of a source file @file{@var{sourcefile}.c}
101 has executed.  You can use these logfiles along with @command{gprof} to aid
102 in fine-tuning the performance of your programs.  @command{gprof} gives
103 timing information you can use along with the information you get from
104 @command{gcov}.
106 @command{gcov} works only on code compiled with GCC@.  It is not
107 compatible with any other profiling or test coverage mechanism.
109 @c man end
111 @node Invoking Gcov
112 @section Invoking gcov
114 @smallexample
115 gcov @r{[}@var{options}@r{]} @var{sourcefile}
116 @end smallexample
118 @command{gcov} accepts the following options:
120 @ignore
121 @c man begin SYNOPSIS
122 gcov [@option{-v}|@option{--version}] [@option{-h}|@option{--help}]
123      [@option{-a}|@option{--all-blocks}]
124      [@option{-b}|@option{--branch-probabilities}]
125      [@option{-c}|@option{--branch-counts}]
126      [@option{-n}|@option{--no-output}]
127      [@option{-l}|@option{--long-file-names}]
128      [@option{-p}|@option{--preserve-paths}]
129      [@option{-f}|@option{--function-summaries}]
130      [@option{-o}|@option{--object-directory} @var{directory|file}] @var{sourcefile}
131      [@option{-u}|@option{--unconditional-branches}]
132 @c man end
133 @c man begin SEEALSO
134 gpl(7), gfdl(7), fsf-funding(7), gcc(1) and the Info entry for @file{gcc}.
135 @c man end
136 @end ignore
138 @c man begin OPTIONS
139 @table @gcctabopt
140 @item -h
141 @itemx --help
142 Display help about using @command{gcov} (on the standard output), and
143 exit without doing any further processing.
145 @item -v
146 @itemx --version
147 Display the @command{gcov} version number (on the standard output),
148 and exit without doing any further processing.
150 @item -a
151 @itemx --all-blocks
152 Write individual execution counts for every basic block. Normally gcov
153 outputs execution counts only for the main blocks of a line. With this
154 option you can determine if blocks within a single line are not being
155 executed.
157 @item -b
158 @itemx --branch-probabilities
159 Write branch frequencies to the output file, and write branch summary
160 info to the standard output.  This option allows you to see how often
161 each branch in your program was taken. Unconditional branches will not
162 be shown, unless the @option{-u} option is given.
164 @item -c
165 @itemx --branch-counts
166 Write branch frequencies as the number of branches taken, rather than
167 the percentage of branches taken.
169 @item -n
170 @itemx --no-output
171 Do not create the @command{gcov} output file.
173 @item -l
174 @itemx --long-file-names
175 Create long file names for included source files.  For example, if the
176 header file @file{x.h} contains code, and was included in the file
177 @file{a.c}, then running @command{gcov} on the file @file{a.c} will produce
178 an output file called @file{a.c##x.h.gcov} instead of @file{x.h.gcov}.
179 This can be useful if @file{x.h} is included in multiple source
180 files. If you uses the @samp{-p} option, both the including and
181 included file names will be complete path names.
183 @item -p
184 @itemx --preserve-paths
185 Preserve complete path information in the names of generated
186 @file{.gcov} files. Without this option, just the filename component is
187 used. With this option, all directories are used, with '/' characters
188 translated to '#' characters, '.' directory components removed and '..'
189 components renamed to '^'. This is useful if sourcefiles are in several
190 different directories. It also affects the @samp{-l} option.
192 @item -f
193 @itemx --function-summaries
194 Output summaries for each function in addition to the file level summary.
196 @item -o @var{directory|file}
197 @itemx --object-directory @var{directory}
198 @itemx --object-file @var{file}
199 Specify either the directory containing the gcov data files, or the
200 object path name. The @file{.gcno}, and
201 @file{.gcda} data files are searched for using this option. If a directory
202 is specified, the data files are in that directory and named after the
203 source file name, without its extension. If a file is specified here,
204 the data files are named after that file, without its extension. If this
205 option is not supplied, it defaults to the current directory.
207 @item -u
208 @itemx --unconditional-branches
209 When branch counts are given, include those of unconditional branches.
210 Unconditional branches are normally not interesting.
212 @end table
214 @command{gcov} should be run with the current directory the same as that 
215 when you invoked the compiler. Otherwise it will not be able to locate 
216 the source files. @command{gcov} produces files called 
217 @file{@var{mangledname}.gcov} in the current directory. These contain 
218 the coverage information of the source file they correspond to. 
219 One @file{.gcov} file is produced for each source file containing code, 
220 which was compiled to produce the data files. The @var{mangledname} part
221 of the output file name is usually simply the source file name, but can
222 be something more complicated if the @samp{-l} or @samp{-p} options are
223 given. Refer to those options for details.
225 The @file{.gcov} files contain the ':' separated fields along with
226 program source code. The format is
228 @smallexample
229 @var{execution_count}:@var{line_number}:@var{source line text}
230 @end smallexample
232 Additional block information may succeed each line, when requested by
233 command line option. The @var{execution_count} is @samp{-} for lines
234 containing no code and @samp{#####} for lines which were never
235 executed. Some lines of information at the start have @var{line_number}
236 of zero.
238 When printing percentages, 0% and 100% are only printed when the values
239 are @emph{exactly} 0% and 100% respectively. Other values which would
240 conventionally be rounded to 0% or 100% are instead printed as the
241 nearest non-boundary value.
243 When using @command{gcov}, you must first compile your program with two
244 special GCC options: @samp{-fprofile-arcs -ftest-coverage}.
245 This tells the compiler to generate additional information needed by
246 gcov (basically a flow graph of the program) and also includes
247 additional code in the object files for generating the extra profiling
248 information needed by gcov.  These additional files are placed in the
249 directory where the object file is located.
251 Running the program will cause profile output to be generated.  For each
252 source file compiled with @option{-fprofile-arcs}, an accompanying @file{.da}
253 file will be placed in the object file directory.
255 Running @command{gcov} with your program's source file names as arguments
256 will now produce a listing of the code along with frequency of execution
257 for each line.  For example, if your program is called @file{tmp.c}, this
258 is what you see when you use the basic @command{gcov} facility:
260 @smallexample
261 $ gcc -fprofile-arcs -ftest-coverage tmp.c
262 $ a.out
263 $ gcov tmp.c
264 90.00% of 10 source lines executed in file tmp.c
265 Creating tmp.c.gcov.
266 @end smallexample
268 The file @file{tmp.c.gcov} contains output from @command{gcov}.
269 Here is a sample:
271 @smallexample
272         -:    0:Source:tmp.c
273         -:    0:Graph:tmp.gcno
274         -:    0:Data:tmp.gcda
275         -:    0:Runs:1
276         -:    0:Programs:1
277         -:    1:#include <stdio.h>
278         -:    2:
279         -:    3:int main (void)
280 function main called 1 returned 1 blocks executed 75%
281         1:    4:@{
282         1:    5:  int i, total;
283         -:    6:  
284         1:    7:  total = 0;
285         -:    8:  
286        11:    9:  for (i = 0; i < 10; i++)
287        10:   10:    total += i;
288         -:   11:  
289         1:   12:  if (total != 45)
290     #####:   13:    printf ("Failure\n");
291         -:   14:  else
292         1:   15:    printf ("Success\n");
293         1:   16:  return 0;
294         -:   17:@}
295 @end smallexample
297 When you use the @option{-a} option, you will get individual block
298 counts, and the output looks like this:
300 @smallexample
301         -:    0:Source:tmp.c
302         -:    0:Graph:tmp.gcno
303         -:    0:Data:tmp.gcda
304         -:    0:Runs:1
305         -:    0:Programs:1
306         -:    1:#include <stdio.h>
307         -:    2:
308         -:    3:int main (void)
309 function main called 1 returned 1 blocks executed 75%
310         1:    4:@{
311         1:    4-block  0
312         1:    5:  int i, total;
313         -:    6:  
314         1:    7:  total = 0;
315         -:    8:  
316        11:    9:  for (i = 0; i < 10; i++)
317        11:    9-block  0
318        10:   10:    total += i;
319        10:   10-block  0
320         -:   11:  
321         1:   12:  if (total != 45)
322         1:   12-block  0
323     #####:   13:    printf ("Failure\n");
324     $$$$$:   13-block  0
325         -:   14:  else
326         1:   15:    printf ("Success\n");
327         1:   15-block  0
328         1:   16:  return 0;
329         1:   16-block  0
330         -:   17:@}
331 @end smallexample
333 In this mode, each basic block is only shown on one line -- the last
334 line of the block. A multi-line block will only contribute to the
335 execution count of that last line, and other lines will not be shown
336 to contain code, unless previous blocks end on those lines.
337 The total execution count of a line is shown and subsequent lines show
338 the execution counts for individual blocks that end on that line. After each
339 block, the branch and call counts of the block will be shown, if the
340 @option{-b} option is given.
342 Because of the way gcc instruments calls, a call count can be shown
343 after a line with no individual blocks.
344 As you can see, line 13 contains a basic block that was not executed.
346 @need 450
347 When you use the @option{-b} option, your output looks like this:
349 @smallexample
350 $ gcov -b tmp.c
351 90.00% of 10 source lines executed in file tmp.c
352 80.00% of 5 branches executed in file tmp.c
353 80.00% of 5 branches taken at least once in file tmp.c
354 50.00% of 2 calls executed in file tmp.c
355 Creating tmp.c.gcov.
356 @end smallexample
358 Here is a sample of a resulting @file{tmp.c.gcov} file:
360 @smallexample
361         -:    0:Source:tmp.c
362         -:    0:Graph:tmp.gcno
363         -:    0:Data:tmp.gcda
364         -:    0:Runs:1
365         -:    0:Programs:1
366         -:    1:#include <stdio.h>
367         -:    2:
368         -:    3:int main (void)
369 function main called 1 returned 1 blocks executed 75%
370         1:    4:@{
371         1:    5:  int i, total;
372         -:    6:  
373         1:    7:  total = 0;
374         -:    8:  
375        11:    9:  for (i = 0; i < 10; i++)
376 branch  0 taken 91% (fallthrough)
377 branch  1 taken 9%
378        10:   10:    total += i;
379         -:   11:  
380         1:   12:  if (total != 45)
381 branch  0 taken 0% (fallthrough)
382 branch  1 taken 100%
383     #####:   13:    printf ("Failure\n");
384 call    0 never executed
385         -:   14:  else
386         1:   15:    printf ("Success\n");
387 call    0 called 1 returned 100%
388         1:   16:  return 0;
389         -:   17:@}
390 @end smallexample
392 For each basic block, a line is printed after the last line of the basic
393 block describing the branch or call that ends the basic block.  There can
394 be multiple branches and calls listed for a single source line if there
395 are multiple basic blocks that end on that line.  In this case, the
396 branches and calls are each given a number.  There is no simple way to map
397 these branches and calls back to source constructs.  In general, though,
398 the lowest numbered branch or call will correspond to the leftmost construct
399 on the source line.
401 For a branch, if it was executed at least once, then a percentage
402 indicating the number of times the branch was taken divided by the
403 number of times the branch was executed will be printed.  Otherwise, the
404 message ``never executed'' is printed.
406 For a call, if it was executed at least once, then a percentage
407 indicating the number of times the call returned divided by the number
408 of times the call was executed will be printed.  This will usually be
409 100%, but may be less for functions call @code{exit} or @code{longjmp},
410 and thus may not return every time they are called.
412 The execution counts are cumulative.  If the example program were
413 executed again without removing the @file{.da} file, the count for the
414 number of times each line in the source was executed would be added to
415 the results of the previous run(s).  This is potentially useful in
416 several ways.  For example, it could be used to accumulate data over a
417 number of program runs as part of a test verification suite, or to
418 provide more accurate long-term information over a large number of
419 program runs.
421 The data in the @file{.da} files is saved immediately before the program
422 exits.  For each source file compiled with @option{-fprofile-arcs}, the
423 profiling code first attempts to read in an existing @file{.da} file; if
424 the file doesn't match the executable (differing number of basic block
425 counts) it will ignore the contents of the file.  It then adds in the
426 new execution counts and finally writes the data to the file.
428 @node Gcov and Optimization
429 @section Using @command{gcov} with GCC Optimization
431 If you plan to use @command{gcov} to help optimize your code, you must
432 first compile your program with two special GCC options:
433 @samp{-fprofile-arcs -ftest-coverage}.  Aside from that, you can use any
434 other GCC options; but if you want to prove that every single line
435 in your program was executed, you should not compile with optimization
436 at the same time.  On some machines the optimizer can eliminate some
437 simple code lines by combining them with other lines.  For example, code
438 like this:
440 @smallexample
441 if (a != b)
442   c = 1;
443 else
444   c = 0;
445 @end smallexample
447 @noindent
448 can be compiled into one instruction on some machines.  In this case,
449 there is no way for @command{gcov} to calculate separate execution counts
450 for each line because there isn't separate code for each line.  Hence
451 the @command{gcov} output looks like this if you compiled the program with
452 optimization:
454 @smallexample
455       100:   12:if (a != b)
456       100:   13:  c = 1;
457       100:   14:else
458       100:   15:  c = 0;
459 @end smallexample
461 The output shows that this block of code, combined by optimization,
462 executed 100 times.  In one sense this result is correct, because there
463 was only one instruction representing all four of these lines.  However,
464 the output does not indicate how many times the result was 0 and how
465 many times the result was 1.
466 @c man end
468 @node Gcov Data Files
469 @section Brief description of @command{gcov} data files
471 @command{gcov} uses two files for profiling.  The names of these files
472 are derived from the original @emph{object} file by substituting the
473 file suffix with either @file{.gcno}, or @file{.gcda}.  All of these files
474 are placed in the same directory as the object file, and contain data
475 stored in a platform-independent format.
477 The @file{.gcno} file is generated when the source file is compiled with
478 the GCC @option{-ftest-coverage} option.  It contains information to
479 reconstruct the basic block graphs and assign source line numbers to
480 blocks.
482 The @file{.gcda} file is generated when a program containing object files
483 built with the GCC @option{-fprofile-arcs} option is executed.  A
484 separate @file{.gcda} file is created for each object file compiled with
485 this option. It contains arc transition counts, and some summary
486 information.
488 The full details of the file format is specified in @file{gcov-io.h},
489 and functions provided in that header file should be used to access the
490 coverage files.