gcc/gcov.1

   1 .\" Automatically generated by Pod::Man version 1.1
   2 .\" Mon Feb 19 19:31:56 2001
   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.1" "2001-02-19" "GNU"
 142 .UC
 143 .SH "NAME"
 144 gcov \- coverage testing tool
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 gcov [\fB\-b\fR] [\fB\-c\fR] [\fB\-v\fR] [\fB\-n\fR] [\fB\-l\fR] [\fB\-f\fR] [\fB\-o\fR \fIdirectory\fR] \fIsourcefile\fR
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 \&\f(CW\*(C`gcov\*(C'\fR is a test coverage program.  Use it in concert with \s-1GNU\s0
 151 \&\s-1CC\s0 to analyze your programs to help create more efficient, faster
 152 running code.  You can use \f(CW\*(C`gcov\*(C'\fR as a profiling tool to help
 153 discover where your optimization efforts will best affect your code.  You
 154 can also use \f(CW\*(C`gcov\*(C'\fR along with the other profiling tool,
 155 \&\f(CW\*(C`gprof\*(C'\fR, to assess which parts of your code use the greatest amount
 156 of computing time.
 157 .PP
 158 Profiling tools help you analyze your code's performance.  Using a
 159 profiler such as \f(CW\*(C`gcov\*(C'\fR or \f(CW\*(C`gprof\*(C'\fR, you can find out some
 160 basic performance statistics, such as:
 161 .Ip "\(bu" 4
 162 how often each line of code executes
 163 .Ip "\(bu" 4
 164 what lines of code are actually executed
 165 .Ip "\(bu" 4
 166 how much computing time each section of code uses
 167 .PP
 168 Once you know these things about how your code works when compiled, you
 169 can look at each module to see which modules should be optimized.
 170 \&\f(CW\*(C`gcov\*(C'\fR helps you determine where to work on optimization.
 171 .PP
 172 Software developers also use coverage testing in concert with
 173 testsuites, to make sure software is actually good enough for a release.
 174 Testsuites can verify that a program works as expected; a coverage
 175 program tests to see how much of the program is exercised by the
 176 testsuite.  Developers can then determine what kinds of test cases need
 177 to be added to the testsuites to create both better testing and a better
 178 final product.
 179 .PP
 180 You should compile your code without optimization if you plan to use
 181 \&\f(CW\*(C`gcov\*(C'\fR because the optimization, by combining some lines of code
 182 into one function, may not give you as much information as you need to
 183 look for `hot spots' where the code is using a great deal of computer
 184 time.  Likewise, because \f(CW\*(C`gcov\*(C'\fR accumulates statistics by line (at
 185 the lowest resolution), it works best with a programming style that
 186 places only one statement on each line.  If you use complicated macros
 187 that expand to loops or to other control structures, the statistics are
 188 less helpful\-\-\-they only report on the line where the macro call
 189 appears.  If your complex macros behave like functions, you can replace
 190 them with inline functions to solve this problem.
 191 .PP
 192 \&\f(CW\*(C`gcov\*(C'\fR creates a logfile called \fI\fIsourcefile\fI.gcov\fR which
 193 indicates how many times each line of a source file \fI\fIsourcefile\fI.c\fR
 194 has executed.  You can use these logfiles along with \f(CW\*(C`gprof\*(C'\fR to aid
 195 in fine-tuning the performance of your programs.  \f(CW\*(C`gprof\*(C'\fR gives
 196 timing information you can use along with the information you get from
 197 \&\f(CW\*(C`gcov\*(C'\fR.
 198 .PP
 199 \&\f(CW\*(C`gcov\*(C'\fR works only on code compiled with \s-1GNU\s0 \s-1CC\s0.  It is not
 200 compatible with any other profiling or test coverage mechanism.
 201 .SH "OPTIONS"
 202 .IX Header "OPTIONS"
 203 .if n .Ip "\f(CW""\-b""\fR" 4
 204 .el .Ip "\f(CW\-b\fR" 4
 205 .IX Item "-b"
 206 Write branch frequencies to the output file, and write branch summary
 207 info to the standard output.  This option allows you to see how often
 208 each branch in your program was taken.
 209 .if n .Ip "\f(CW""\-c""\fR" 4
 210 .el .Ip "\f(CW\-c\fR" 4
 211 .IX Item "-c"
 212 Write branch frequencies as the number of branches taken, rather than
 213 the percentage of branches taken.
 214 .if n .Ip "\f(CW""\-v""\fR" 4
 215 .el .Ip "\f(CW\-v\fR" 4
 216 .IX Item "-v"
 217 Display the \f(CW\*(C`gcov\*(C'\fR version number (on the standard error stream).
 218 .if n .Ip "\f(CW""\-n""\fR" 4
 219 .el .Ip "\f(CW\-n\fR" 4
 220 .IX Item "-n"
 221 Do not create the \f(CW\*(C`gcov\*(C'\fR output file.
 222 .if n .Ip "\f(CW""\-l""\fR" 4
 223 .el .Ip "\f(CW\-l\fR" 4
 224 .IX Item "-l"
 225 Create long file names for included source files.  For example, if the
 226 header file \fBx.h\fR contains code, and was included in the file
 227 \&\fBa.c\fR, then running \f(CW\*(C`gcov\*(C'\fR on the file \fBa.c\fR will produce
 228 an output file called \fBa.c.x.h.gcov\fR instead of \fBx.h.gcov\fR.
 229 This can be useful if \fBx.h\fR is included in multiple source files.
 230 .if n .Ip "\f(CW""\-f""\fR" 4
 231 .el .Ip "\f(CW\-f\fR" 4
 232 .IX Item "-f"
 233 Output summaries for each function in addition to the file level summary.
 234 .if n .Ip "\f(CW""\-o""\fR" 4
 235 .el .Ip "\f(CW\-o\fR" 4
 236 .IX Item "-o"
 237 The directory where the object files live.  Gcov will search for \f(CW\*(C`.bb\*(C'\fR,
 238 \&\f(CW\*(C`.bbg\*(C'\fR, and \f(CW\*(C`.da\*(C'\fR files in this directory.
 239 .PP
 240 When using \f(CW\*(C`gcov\*(C'\fR, you must first compile your program with two
 241 special \s-1GNU\s0 \s-1CC\s0 options: \fB\-fprofile-arcs \-ftest-coverage\fR.
 242 This tells the compiler to generate additional information needed by
 243 gcov (basically a flow graph of the program) and also includes
 244 additional code in the object files for generating the extra profiling
 245 information needed by gcov.  These additional files are placed in the
 246 directory where the source code is located.
 247 .PP
 248 Running the program will cause profile output to be generated.  For each
 249 source file compiled with \-fprofile-arcs, an accompanying \f(CW\*(C`.da\*(C'\fR
 250 file will be placed in the source directory.
 251 .PP
 252 Running \f(CW\*(C`gcov\*(C'\fR with your program's source file names as arguments
 253 will now produce a listing of the code along with frequency of execution
 254 for each line.  For example, if your program is called \fBtmp.c\fR, this
 255 is what you see when you use the basic \f(CW\*(C`gcov\*(C'\fR facility:
 256 .PP
 257 .Vb 5
 258 \&        $ gcc -fprofile-arcs -ftest-coverage tmp.c
 259 \&        $ a.out
 260 \&        $ gcov tmp.c
 261 \&         87.50% of 8 source lines executed in file tmp.c
 262 \&        Creating tmp.c.gcov.
 263 .Ve
 264 The file \fItmp.c.gcov\fR contains output from \f(CW\*(C`gcov\*(C'\fR.
 265 Here is a sample:
 266 .PP
 267 .Vb 3
 268 \&                        main()
 269 \&                        {
 270 \&                   1      int i, total;
 271 .Ve
 272 .Vb 1
 273 \&                   1      total = 0;
 274 .Ve
 275 .Vb 2
 276 \&                  11      for (i = 0; i < 10; i++)
 277 \&                  10        total += i;
 278 .Ve
 279 .Vb 5
 280 \&                   1      if (total != 45)
 281 \&              ######        printf ("Failure\en");
 282 \&                          else
 283 \&                   1        printf ("Success\en");
 284 \&                   1    }
 285 .Ve
 286 When you use the \fB\-b\fR option, your output looks like this:
 287 .PP
 288 .Vb 6
 289 \&        $ gcov -b tmp.c
 290 \&         87.50% of 8 source lines executed in file tmp.c
 291 \&         80.00% of 5 branches executed in file tmp.c
 292 \&         80.00% of 5 branches taken at least once in file tmp.c
 293 \&         50.00% of 2 calls executed in file tmp.c
 294 \&        Creating tmp.c.gcov.
 295 .Ve
 296 Here is a sample of a resulting \fItmp.c.gcov\fR file:
 297 .PP
 298 .Vb 3
 299 \&                        main()
 300 \&                        {
 301 \&                   1      int i, total;
 302 .Ve
 303 .Vb 1
 304 \&                   1      total = 0;
 305 .Ve
 306 .Vb 5
 307 \&                  11      for (i = 0; i < 10; i++)
 308 \&        branch 0 taken = 91%
 309 \&        branch 1 taken = 100%
 310 \&        branch 2 taken = 100%
 311 \&                  10        total += i;
 312 .Ve
 313 .Vb 9
 314 \&                   1      if (total != 45)
 315 \&        branch 0 taken = 100%
 316 \&              ######        printf ("Failure\en");
 317 \&        call 0 never executed
 318 \&        branch 1 never executed
 319 \&                          else
 320 \&                   1        printf ("Success\en");
 321 \&        call 0 returns = 100%
 322 \&                   1    }
 323 .Ve
 324 For each basic block, a line is printed after the last line of the basic
 325 block describing the branch or call that ends the basic block.  There can
 326 be multiple branches and calls listed for a single source line if there
 327 are multiple basic blocks that end on that line.  In this case, the
 328 branches and calls are each given a number.  There is no simple way to map
 329 these branches and calls back to source constructs.  In general, though,
 330 the lowest numbered branch or call will correspond to the leftmost construct
 331 on the source line.
 332 .PP
 333 For a branch, if it was executed at least once, then a percentage
 334 indicating the number of times the branch was taken divided by the
 335 number of times the branch was executed will be printed.  Otherwise, the
 336 message ``never executed'' is printed.
 337 .PP
 338 For a call, if it was executed at least once, then a percentage
 339 indicating the number of times the call returned divided by the number
 340 of times the call was executed will be printed.  This will usually be
 341 100%, but may be less for functions call \f(CW\*(C`exit\*(C'\fR or \f(CW\*(C`longjmp\*(C'\fR,
 342 and thus may not return every time they are called.
 343 .PP
 344 The execution counts are cumulative.  If the example program were
 345 executed again without removing the \f(CW\*(C`.da\*(C'\fR file, the count for the
 346 number of times each line in the source was executed would be added to
 347 the results of the previous \fIrun\fR\|(s).  This is potentially useful in
 348 several ways.  For example, it could be used to accumulate data over a
 349 number of program runs as part of a test verification suite, or to
 350 provide more accurate long-term information over a large number of
 351 program runs.
 352 .PP
 353 The data in the \f(CW\*(C`.da\*(C'\fR files is saved immediately before the program
 354 exits.  For each source file compiled with \-fprofile-arcs, the profiling
 355 code first attempts to read in an existing \f(CW\*(C`.da\*(C'\fR file; if the file
 356 doesn't match the executable (differing number of basic block counts) it
 357 will ignore the contents of the file.  It then adds in the new execution
 358 counts and finally writes the data to the file.
 359 .if n .Sh "Using \f(CW""gcov""\fP with \s-1GCC\s0 Optimization"
 360 .el .Sh "Using \f(CWgcov\fP with \s-1GCC\s0 Optimization"
 361 .IX Subsection "Using gcov with GCC Optimization"
 362 If you plan to use \f(CW\*(C`gcov\*(C'\fR to help optimize your code, you must
 363 first compile your program with two special \s-1GNU\s0 \s-1CC\s0 options:
 364 \&\fB\-fprofile-arcs \-ftest-coverage\fR.  Aside from that, you can use any
 365 other \s-1GNU\s0 \s-1CC\s0 options; but if you want to prove that every single line
 366 in your program was executed, you should not compile with optimization
 367 at the same time.  On some machines the optimizer can eliminate some
 368 simple code lines by combining them with other lines.  For example, code
 369 like this:
 370 .PP
 371 .Vb 4
 372 \&        if (a != b)
 373 \&          c = 1;
 374 \&        else
 375 \&          c = 0;
 376 .Ve
 377 can be compiled into one instruction on some machines.  In this case,
 378 there is no way for \f(CW\*(C`gcov\*(C'\fR to calculate separate execution counts
 379 for each line because there isn't separate code for each line.  Hence
 380 the \f(CW\*(C`gcov\*(C'\fR output looks like this if you compiled the program with
 381 optimization:
 382 .PP
 383 .Vb 4
 384 \&              100  if (a != b)
 385 \&              100    c = 1;
 386 \&              100  else
 387 \&              100    c = 0;
 388 .Ve
 389 The output shows that this block of code, combined by optimization,
 390 executed 100 times.  In one sense this result is correct, because there
 391 was only one instruction representing all four of these lines.  However,
 392 the output does not indicate how many times the result was 0 and how
 393 many times the result was 1.
 394 .SH "SEE ALSO"
 395 .IX Header "SEE ALSO"
 396 \&\fIgcc\fR\|(1) and the Info entry for \fIgcc\fR.
 397 .SH "COPYRIGHT"
 398 .IX Header "COPYRIGHT"
 399 Copyright (c) 1996, 1997, 1999, 2000 Free Software Foundation, Inc.
 400 .PP
 401 Permission is granted to make and distribute verbatim copies of this
 402 manual provided the copyright notice and this permission notice are
 403 preserved on all copies.
 404 .PP
 405 Permission is granted to copy and distribute modified versions of this
 406 manual under the conditions for verbatim copying, provided also that the
 407 entire resulting derived work is distributed under the terms of a
 408 permission notice identical to this one.
 409 .PP
 410 Permission is granted to copy and distribute translations of this manual
 411 into another language, under the above conditions for modified versions,
 412 except that this permission notice may be included in translations
 413 approved by the Free Software Foundation instead of in the original
 414 English.