contrib/gcc/doc/gcov.1

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb  5 03:13:55 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "GCOV 1"
 141 .TH GCOV 1 "gcc-3.2.2" "2003-02-05" "GNU"
 142 .UC
 143 .SH "NAME"
 144 gcov \- coverage testing tool
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 gcov [\fB\-v\fR|\fB\*(--version\fR] [\fB\-h\fR|\fB\*(--help\fR]
 148      [\fB\-b\fR|\fB\*(--branch-probabilities\fR] [\fB\-c\fR|\fB\*(--branch-counts\fR]
 149      [\fB\-n\fR|\fB\*(--no-output\fR] [\fB\-l\fR|\fB\*(--long-file-names\fR]
 150      [\fB\-f\fR|\fB\*(--function-summaries\fR]
 151      [\fB\-o\fR|\fB\*(--object-directory\fR \fIdirectory\fR] \fIsourcefile\fR
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fBgcov\fR is a test coverage program.  Use it in concert with \s-1GCC\s0
 155 to analyze your programs to help create more efficient, faster
 156 running code.  You can use \fBgcov\fR as a profiling tool to help
 157 discover where your optimization efforts will best affect your code.  You
 158 can also use \fBgcov\fR along with the other profiling tool,
 159 \&\fBgprof\fR, to assess which parts of your code use the greatest amount
 160 of computing time.
 161 .PP
 162 Profiling tools help you analyze your code's performance.  Using a
 163 profiler such as \fBgcov\fR or \fBgprof\fR, you can find out some
 164 basic performance statistics, such as:
 165 .Ip "\(bu" 4
 166 how often each line of code executes
 167 .Ip "\(bu" 4
 168 what lines of code are actually executed
 169 .Ip "\(bu" 4
 170 how much computing time each section of code uses
 171 .PP
 172 Once you know these things about how your code works when compiled, you
 173 can look at each module to see which modules should be optimized.
 174 \&\fBgcov\fR helps you determine where to work on optimization.
 175 .PP
 176 Software developers also use coverage testing in concert with
 177 testsuites, to make sure software is actually good enough for a release.
 178 Testsuites can verify that a program works as expected; a coverage
 179 program tests to see how much of the program is exercised by the
 180 testsuite.  Developers can then determine what kinds of test cases need
 181 to be added to the testsuites to create both better testing and a better
 182 final product.
 183 .PP
 184 You should compile your code without optimization if you plan to use
 185 \&\fBgcov\fR because the optimization, by combining some lines of code
 186 into one function, may not give you as much information as you need to
 187 look for `hot spots' where the code is using a great deal of computer
 188 time.  Likewise, because \fBgcov\fR accumulates statistics by line (at
 189 the lowest resolution), it works best with a programming style that
 190 places only one statement on each line.  If you use complicated macros
 191 that expand to loops or to other control structures, the statistics are
 192 less helpful\-\-\-they only report on the line where the macro call
 193 appears.  If your complex macros behave like functions, you can replace
 194 them with inline functions to solve this problem.
 195 .PP
 196 \&\fBgcov\fR creates a logfile called \fI\fIsourcefile\fI.gcov\fR which
 197 indicates how many times each line of a source file \fI\fIsourcefile\fI.c\fR
 198 has executed.  You can use these logfiles along with \fBgprof\fR to aid
 199 in fine-tuning the performance of your programs.  \fBgprof\fR gives
 200 timing information you can use along with the information you get from
 201 \&\fBgcov\fR.
 202 .PP
 203 \&\fBgcov\fR works only on code compiled with \s-1GCC\s0.  It is not
 204 compatible with any other profiling or test coverage mechanism.
 205 .SH "OPTIONS"
 206 .IX Header "OPTIONS"
 207 .Ip "\fB\-h\fR" 4
 208 .IX Item "-h"
 209 .PD 0
 210 .Ip "\fB\*(--help\fR" 4
 211 .IX Item "help"
 212 .PD
 213 Display help about using \fBgcov\fR (on the standard output), and
 214 exit without doing any further processing.
 215 .Ip "\fB\-v\fR" 4
 216 .IX Item "-v"
 217 .PD 0
 218 .Ip "\fB\*(--version\fR" 4
 219 .IX Item "version"
 220 .PD
 221 Display the \fBgcov\fR version number (on the standard output),
 222 and exit without doing any further processing.
 223 .Ip "\fB\-b\fR" 4
 224 .IX Item "-b"
 225 .PD 0
 226 .Ip "\fB\*(--branch-probabilities\fR" 4
 227 .IX Item "branch-probabilities"
 228 .PD
 229 Write branch frequencies to the output file, and write branch summary
 230 info to the standard output.  This option allows you to see how often
 231 each branch in your program was taken.
 232 .Ip "\fB\-c\fR" 4
 233 .IX Item "-c"
 234 .PD 0
 235 .Ip "\fB\*(--branch-counts\fR" 4
 236 .IX Item "branch-counts"
 237 .PD
 238 Write branch frequencies as the number of branches taken, rather than
 239 the percentage of branches taken.
 240 .Ip "\fB\-n\fR" 4
 241 .IX Item "-n"
 242 .PD 0
 243 .Ip "\fB\*(--no-output\fR" 4
 244 .IX Item "no-output"
 245 .PD
 246 Do not create the \fBgcov\fR output file.
 247 .Ip "\fB\-l\fR" 4
 248 .IX Item "-l"
 249 .PD 0
 250 .Ip "\fB\*(--long-file-names\fR" 4
 251 .IX Item "long-file-names"
 252 .PD
 253 Create long file names for included source files.  For example, if the
 254 header file \fIx.h\fR contains code, and was included in the file
 255 \&\fIa.c\fR, then running \fBgcov\fR on the file \fIa.c\fR will produce
 256 an output file called \fIa.c.x.h.gcov\fR instead of \fIx.h.gcov\fR.
 257 This can be useful if \fIx.h\fR is included in multiple source files.
 258 .Ip "\fB\-f\fR" 4
 259 .IX Item "-f"
 260 .PD 0
 261 .Ip "\fB\*(--function-summaries\fR" 4
 262 .IX Item "function-summaries"
 263 .PD
 264 Output summaries for each function in addition to the file level summary.
 265 .Ip "\fB\-o\fR \fIdirectory\fR" 4
 266 .IX Item "-o directory"
 267 .PD 0
 268 .Ip "\fB\*(--object-directory\fR \fIdirectory\fR" 4
 269 .IX Item "object-directory directory"
 270 .PD
 271 The directory where the object files live.  Gcov will search for \fI.bb\fR,
 272 \&\fI.bbg\fR, and \fI.da\fR files in this directory.
 273 .PP
 274 When using \fBgcov\fR, you must first compile your program with two
 275 special \s-1GCC\s0 options: \fB\-fprofile-arcs \-ftest-coverage\fR.
 276 This tells the compiler to generate additional information needed by
 277 gcov (basically a flow graph of the program) and also includes
 278 additional code in the object files for generating the extra profiling
 279 information needed by gcov.  These additional files are placed in the
 280 directory where the source code is located.
 281 .PP
 282 Running the program will cause profile output to be generated.  For each
 283 source file compiled with \fB\-fprofile-arcs\fR, an accompanying \fI.da\fR
 284 file will be placed in the source directory.
 285 .PP
 286 Running \fBgcov\fR with your program's source file names as arguments
 287 will now produce a listing of the code along with frequency of execution
 288 for each line.  For example, if your program is called \fItmp.c\fR, this
 289 is what you see when you use the basic \fBgcov\fR facility:
 290 .PP
 291 .Vb 5
 292 \&        $ gcc -fprofile-arcs -ftest-coverage tmp.c
 293 \&        $ a.out
 294 \&        $ gcov tmp.c
 295 \&         87.50% of 8 source lines executed in file tmp.c
 296 \&        Creating tmp.c.gcov.
 297 .Ve
 298 The file \fItmp.c.gcov\fR contains output from \fBgcov\fR.
 299 Here is a sample:
 300 .PP
 301 .Vb 3
 302 \&                        main()
 303 \&                        {
 304 \&                   1      int i, total;
 305 .Ve
 306 .Vb 1
 307 \&                   1      total = 0;
 308 .Ve
 309 .Vb 2
 310 \&                  11      for (i = 0; i < 10; i++)
 311 \&                  10        total += i;
 312 .Ve
 313 .Vb 5
 314 \&                   1      if (total != 45)
 315 \&              ######        printf ("Failure\en");
 316 \&                          else
 317 \&                   1        printf ("Success\en");
 318 \&                   1    }
 319 .Ve
 320 When you use the \fB\-b\fR option, your output looks like this:
 321 .PP
 322 .Vb 6
 323 \&        $ gcov -b tmp.c
 324 \&         87.50% of 8 source lines executed in file tmp.c
 325 \&         80.00% of 5 branches executed in file tmp.c
 326 \&         80.00% of 5 branches taken at least once in file tmp.c
 327 \&         50.00% of 2 calls executed in file tmp.c
 328 \&        Creating tmp.c.gcov.
 329 .Ve
 330 Here is a sample of a resulting \fItmp.c.gcov\fR file:
 331 .PP
 332 .Vb 3
 333 \&                        main()
 334 \&                        {
 335 \&                   1      int i, total;
 336 .Ve
 337 .Vb 1
 338 \&                   1      total = 0;
 339 .Ve
 340 .Vb 5
 341 \&                  11      for (i = 0; i < 10; i++)
 342 \&        branch 0 taken = 91%
 343 \&        branch 1 taken = 100%
 344 \&        branch 2 taken = 100%
 345 \&                  10        total += i;
 346 .Ve
 347 .Vb 9
 348 \&                   1      if (total != 45)
 349 \&        branch 0 taken = 100%
 350 \&              ######        printf ("Failure\en");
 351 \&        call 0 never executed
 352 \&        branch 1 never executed
 353 \&                          else
 354 \&                   1        printf ("Success\en");
 355 \&        call 0 returns = 100%
 356 \&                   1    }
 357 .Ve
 358 For each basic block, a line is printed after the last line of the basic
 359 block describing the branch or call that ends the basic block.  There can
 360 be multiple branches and calls listed for a single source line if there
 361 are multiple basic blocks that end on that line.  In this case, the
 362 branches and calls are each given a number.  There is no simple way to map
 363 these branches and calls back to source constructs.  In general, though,
 364 the lowest numbered branch or call will correspond to the leftmost construct
 365 on the source line.
 366 .PP
 367 For a branch, if it was executed at least once, then a percentage
 368 indicating the number of times the branch was taken divided by the
 369 number of times the branch was executed will be printed.  Otherwise, the
 370 message ``never executed'' is printed.
 371 .PP
 372 For a call, if it was executed at least once, then a percentage
 373 indicating the number of times the call returned divided by the number
 374 of times the call was executed will be printed.  This will usually be
 375 100%, but may be less for functions call \f(CW\*(C`exit\*(C'\fR or \f(CW\*(C`longjmp\*(C'\fR,
 376 and thus may not return every time they are called.
 377 .PP
 378 The execution counts are cumulative.  If the example program were
 379 executed again without removing the \fI.da\fR file, the count for the
 380 number of times each line in the source was executed would be added to
 381 the results of the previous \fIrun\fR\|(s).  This is potentially useful in
 382 several ways.  For example, it could be used to accumulate data over a
 383 number of program runs as part of a test verification suite, or to
 384 provide more accurate long-term information over a large number of
 385 program runs.
 386 .PP
 387 The data in the \fI.da\fR files is saved immediately before the program
 388 exits.  For each source file compiled with \fB\-fprofile-arcs\fR, the profiling
 389 code first attempts to read in an existing \fI.da\fR file; if the file
 390 doesn't match the executable (differing number of basic block counts) it
 391 will ignore the contents of the file.  It then adds in the new execution
 392 counts and finally writes the data to the file.
 393 .Sh "Using \fBgcov\fP with \s-1GCC\s0 Optimization"
 394 .IX Subsection "Using gcov with GCC Optimization"
 395 If you plan to use \fBgcov\fR to help optimize your code, you must
 396 first compile your program with two special \s-1GCC\s0 options:
 397 \&\fB\-fprofile-arcs \-ftest-coverage\fR.  Aside from that, you can use any
 398 other \s-1GCC\s0 options; but if you want to prove that every single line
 399 in your program was executed, you should not compile with optimization
 400 at the same time.  On some machines the optimizer can eliminate some
 401 simple code lines by combining them with other lines.  For example, code
 402 like this:
 403 .PP
 404 .Vb 4
 405 \&        if (a != b)
 406 \&          c = 1;
 407 \&        else
 408 \&          c = 0;
 409 .Ve
 410 can be compiled into one instruction on some machines.  In this case,
 411 there is no way for \fBgcov\fR to calculate separate execution counts
 412 for each line because there isn't separate code for each line.  Hence
 413 the \fBgcov\fR output looks like this if you compiled the program with
 414 optimization:
 415 .PP
 416 .Vb 4
 417 \&              100  if (a != b)
 418 \&              100    c = 1;
 419 \&              100  else
 420 \&              100    c = 0;
 421 .Ve
 422 The output shows that this block of code, combined by optimization,
 423 executed 100 times.  In one sense this result is correct, because there
 424 was only one instruction representing all four of these lines.  However,
 425 the output does not indicate how many times the result was 0 and how
 426 many times the result was 1.
 427 .SH "SEE ALSO"
 428 .IX Header "SEE ALSO"
 429 \&\fIgpl\fR\|(7), \fIgfdl\fR\|(7), \fIfsf-funding\fR\|(7), \fIgcc\fR\|(1) and the Info entry for \fIgcc\fR.
 430 .SH "COPYRIGHT"
 431 .IX Header "COPYRIGHT"
 432 Copyright (c) 1996, 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
 433 .PP
 434 Permission is granted to copy, distribute and/or modify this document
 435 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1 or
 436 any later version published by the Free Software Foundation; with the
 437 Invariant Sections being ``\s-1GNU\s0 General Public License'' and ``Funding
 438 Free Software'', the Front-Cover texts being (a) (see below), and with
 439 the Back-Cover Texts being (b) (see below).  A copy of the license is
 440 included in the \fIgfdl\fR\|(7) man page.
 441 .PP
 442 (a) The \s-1FSF\s0's Front-Cover Text is:
 443 .PP
 444 .Vb 1
 445 \&     A GNU Manual
 446 .Ve
 447 (b) The \s-1FSF\s0's Back-Cover Text is:
 448 .PP
 449 .Vb 3
 450 \&     You have freedom to copy and modify this GNU Manual, like GNU
 451 \&     software.  Copies published by the Free Software Foundation raise
 452 \&     funds for GNU development.
 453 .Ve