gprof/gprof.1

   1 .\" Copyright (c) 1983, 1990 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms are permitted provided
   5 .\" that: (1) source distributions retain this entire copyright notice and
   6 .\" comment, and (2) distributions including binaries display the following
   7 .\" acknowledgement:  ``This product includes software developed by the
   8 .\" University of California, Berkeley and its contributors'' in the
   9 .\" documentation or other materials provided with the distribution and in
  10 .\" all advertising materials mentioning features or use of this software.
  11 .\" Neither the name of the University nor the names of its contributors may
  12 .\" be used to endorse or promote products derived from this software without
  13 .\" specific prior written permission.
  14 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  15 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  16 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  17 .\"
  18 .\"     @(#)gprof.1     6.6 (Berkeley) 7/24/90
  19 .\"
  20 .TH GPROF 1 "July 24, 1990"
  21 .SH NAME
  22 gprof \- display call graph profile data
  23 .SH SYNOPSIS
  24 .B gprof
  25 .RB "[\|" a.out "\|]"
  26 .B
  27 gmon.out ...
  28 .SH DESCRIPTION
  29 .B gprof
  30 produces an execution profile of C, Pascal, or Fortran77 programs.
  31 The effect of called routines is incorporated in the profile of each caller.
  32 The profile data is taken from the call graph profile file
  33 \&(`gmon.out' default) which is created by programs
  34 that are compiled with the
  35 .B \-pg
  36 option of
  37 .BR cc ( 1 ) ,
  38 .BR pc ( 1 ) ,
  39 and
  40 .BR f77 ( 1 ) .
  41 The
  42 .B \-pg
  43 option also links in versions of the library routines
  44 that are compiled for profiling.
  45 .B Gprof
  46 reads the given object file (the default is `a.out')
  47 and establishes the relation between its symbol table
  48 and the call graph profile from `gmon.out'.
  49 If more than one profile file is specified,
  50 the
  51 .B gprof
  52 output shows the sum of the profile information in the given profile files.
  53 .PP
  54 .B Gprof
  55 calculates the amount of time spent in each routine.
  56 Next, these times are propagated along the edges of the call graph.
  57 Cycles are discovered, and calls into a cycle are made to share the time
  58 of the cycle.
  59 The first listing shows the functions
  60 sorted according to the time they represent
  61 including the time of their call graph descendents.
  62 Below each function entry is shown its (direct) call graph children,
  63 and how their times are propagated to this function.
  64 A similar display above the function shows how this function's time and the
  65 time of its descendents is propagated to its (direct) call graph parents.
  66 .PP
  67 Cycles are also shown, with an entry for the cycle as a whole and
  68 a listing of the members of the cycle and their contributions to the
  69 time and call counts of the cycle.
  70 .PP
  71 Second, a flat profile is given,
  72 similar to that provided by
  73 .BR prof ( 1 )  .
  74 This listing gives the total execution times, the call counts,
  75 the time in milleseconds the call spent in the routine itself, and
  76 the time in milleseconds the call spent in the routine itself including
  77 its descendents.
  78 .PP
  79 Finally, an index of the function names is provided.
  80 .SH OPTIONS
  81 The following options are available:
  82 .TP
  83 .B \-a
  84 suppresses the printing of statically declared functions.
  85 If this option is given, all relevant information about the static function
  86 (e.g., time samples, calls to other functions, calls from other functions)
  87 belongs to the function loaded just before the static function in the
  88 \&`a.out' file.
  89 .TP
  90 .B \-b
  91 suppresses the printing of a description of each field in the profile.
  92 .TP
  93 .B \-c
  94 the static call graph of the program is discovered by a heuristic
  95 that examines the text space of the object file.
  96 Static-only parents or children are shown
  97 with call counts of 0.
  98 .TP
  99 .BI "\-e " name
 100 suppresses the printing of the graph profile entry for routine
 101 .I name
 102 and all its descendants
 103 (unless they have other ancestors that aren't suppressed).
 104 More than one
 105 .B \-e
 106 option may be given.
 107 Only one
 108 .I name
 109 may be given with each
 110 .B \-e
 111 option.
 112 .TP
 113 .BI "\-E " name
 114 suppresses the printing of the graph profile entry for routine
 115 .I name
 116 (and its descendants) as
 117 .B \-e  ,
 118 above, and also excludes the time spent in
 119 .I name
 120 (and its descendants) from the total and percentage time computations.
 121 (For example,
 122 .BI "\-E " mcount
 123 .BI "\-E " mcleanup
 124 is the default.)
 125 .TP
 126 .BI "\-f " name
 127 prints the graph profile entry of only the specified routine
 128 .I name
 129 and its descendants.
 130 More than one
 131 .B \-f
 132 option may be given.
 133 Only one
 134 .I name
 135 may be given with each
 136 .B \-f
 137 option.
 138 .TP
 139 .BI "\-F " name
 140 prints the graph profile entry of only the routine
 141 .I name
 142 and its descendants (as
 143 .B \-f ,
 144 above) and also uses only the times of the printed routines
 145 in total time and percentage computations.
 146 More than one
 147 .B \-F
 148 option may be given.
 149 Only one
 150 .I name
 151 may be given with each
 152 .B \-F
 153 option.
 154 The
 155 .B \-F
 156 option
 157 overrides
 158 the
 159 .B \-E
 160 option.
 161 .TP
 162 .BI "\-k " "fromname toname"
 163 will delete any arcs from routine
 164 .I fromname
 165 to routine
 166 .IR toname  .
 167 This can be used to break undesired cycles.
 168 More than one
 169 .B \-k
 170 option may be given.
 171 Only one pair of routine names may be given with each
 172 .B \-k
 173 option.
 174 .TP
 175 .B \-s
 176 a profile file `gmon.sum' is produced that represents
 177 the sum of the profile information in all the specified profile files.
 178 This summary profile file may be given to later
 179 executions of gprof (probably also with a
 180 .BR \-s  )
 181 to accumulate profile data across several runs of an `a.out' file.
 182 .TP
 183 .B -z
 184 displays routines that have zero usage (as shown by call counts
 185 and accumulated time).
 186 This is useful with the
 187 .B \-c
 188 option for discovering which routines were never called.
 189 .PP
 190 .SH FILES
 191 .ta \w'gmon.sum 'u
 192 a.out   the namelist and text space.
 193 .br
 194 gmon.out        dynamic call graph and profile.
 195 .br
 196 gmon.sum summarized dynamic call graph and profile.
 197 .SH SEE ALSO
 198 .BR monitor ( 3 ) ,
 199 .BR profil ( 2 ) ,
 200 .BR cc ( 1 ) ,
 201 .BR prof ( 1 )
 202 .sp
 203 ``An Execution Profiler for Modular Programs'',
 204 by S. Graham, P. Kessler, M. McKusick;
 205 .I
 206 Software \- Practice and Experience,
 207 Vol. 13, pp. 671-685, 1983.
 208 .sp
 209 ``gprof: A Call Graph Execution Profiler'',
 210 by S. Graham, P. Kessler, M. McKusick;
 211 .I
 212 Proceedings of the SIGPLAN '82 Symposium on Compiler Construction,
 213 SIGPLAN Notices, Vol. 17, No  6, pp. 120-126, June 1982.
 214 .SH HISTORY
 215 .B Gprof
 216 appeared in 4.2 BSD.
 217 .SH BUGS
 218 The granularity of the sampling is shown, but remains
 219 statistical at best.
 220 We assume that the time for each execution of a function
 221 can be expressed by the total time for the function divided
 222 by the number of times the function is called.
 223 Thus the time propagated along the call graph arcs to the function's
 224 parents is directly proportional to the number of times that
 225 arc is traversed.
 226 .PP
 227 Parents that are not themselves profiled will have the time of
 228 their profiled children propagated to them, but they will appear
 229 to be spontaneously invoked in the call graph listing, and will
 230 not have their time propagated further.
 231 Similarly, signal catchers, even though profiled, will appear
 232 to be spontaneous (although for more obscure reasons).
 233 Any profiled children of signal catchers should have their times
 234 propagated properly, unless the signal catcher was invoked during
 235 the execution of the profiling routine, in which case all is lost.
 236 .PP
 237 The profiled program must call
 238 .BR exit ( 2 )
 239 or return normally for the profiling information to be saved
 240 in the `gmon.out' file.