usr.bin/gprof/gprof.1

   1 .\" Copyright (c) 1983, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd November 27, 2017
  29 .Dt GPROF 1
  30 .Os
  31 .Sh NAME
  32 .Nm gprof
  33 .Nd display call graph profile data
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl abKlLsuz
  37 .Op Fl C Ar count
  38 .Op Fl e Ar name
  39 .Op Fl E Ar name
  40 .Op Fl f Ar name
  41 .Op Fl F Ar name
  42 .Op Fl k Ar fromname toname
  43 .Op Ar a.out Op Ar a.out.gmon ...
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility produces an execution profile of C, Pascal, or Fortran77 programs.
  48 The effect of called routines is incorporated in the profile of each caller.
  49 The profile data is taken from the call graph profile file
  50 which is created by programs that are compiled with the
  51 .Fl pg
  52 option of
  53 .Xr cc 1 ,
  54 .Xr pc 1 ,
  55 and
  56 .Xr f77 1 .
  57 The
  58 .Fl pg
  59 option also links in versions of the library routines
  60 that are compiled for profiling.
  61 By convention these libraries have their name suffixed with
  62 .Pa _p ,
  63 i.e., the profiled version of
  64 .Pa libc.a
  65 is
  66 .Pa libc_p.a
  67 and if you specify libraries directly to the
  68 compiler or linker you can use
  69 .Fl l Ns Ar c_p
  70 instead of
  71 .Fl l Ns Ar c .
  72 Read the given object file (the default is
  73 .Pa a.out )
  74 and establishes the relation between its symbol table
  75 and the call graph profile.
  76 The default graph profile file name is the name
  77 of the executable with the suffix
  78 .Pa .gmon
  79 appended.
  80 If more than one profile file is specified,
  81 the
  82 .Nm
  83 output shows the sum of the profile information in the given profile files.
  84 .Pp
  85 The
  86 .Nm
  87 utility calculates the amount of time spent in each routine.
  88 Next, these times are propagated along the edges of the call graph.
  89 Cycles are discovered, and calls into a cycle are made to share the time
  90 of the cycle.
  91 The first listing shows the functions
  92 sorted according to the time they represent
  93 including the time of their call graph descendants.
  94 Below each function entry is shown its (direct) call graph children,
  95 and how their times are propagated to this function.
  96 A similar display above the function shows how this function's time and the
  97 time of its descendants is propagated to its (direct) call graph parents.
  98 .Pp
  99 Cycles are also shown, with an entry for the cycle as a whole and
 100 a listing of the members of the cycle and their contributions to the
 101 time and call counts of the cycle.
 102 .Pp
 103 Second, a flat profile is given,
 104 similar to that provided by
 105 .Xr prof 1 .
 106 This listing gives the total execution times, the call counts,
 107 the time that the call spent in the routine itself, and
 108 the time that the call spent in the routine itself including
 109 its descendants.
 110 The units for the per-call times are normally milliseconds,
 111 but they are nanoseconds if the profiling clock frequency
 112 is 10 million or larger,
 113 and if a function appears to be never called then its total self time
 114 is printed as a percentage in the self time per call column.
 115 The very high profiling clock frequencies needed to get sufficient
 116 accuracy in the per-call times for short-lived programs are only
 117 implemented for
 118 .Dq high resolution
 119 (non-statistical) kernel profiling.
 120 .Pp
 121 Finally, an index of the function names is provided.
 122 .Pp
 123 The following options are available:
 124 .Bl -tag -width indent
 125 .It Fl a
 126 Suppress the printing of statically declared functions.
 127 If this option is given, all relevant information about the static function
 128 (e.g., time samples, calls to other functions, calls from other functions)
 129 belongs to the function loaded just before the static function in the
 130 .Pa a.out
 131 file.
 132 .It Fl b
 133 Suppress the printing of a description of each field in the profile.
 134 .It Fl C Ar count
 135 Find a minimal set of arcs that can be broken to eliminate all cycles with
 136 .Ar count
 137 or more members.
 138 Caution: the algorithm used to break cycles is exponential,
 139 so using this option may cause
 140 .Nm
 141 to run for a very long time.
 142 .It Fl e Ar name
 143 Suppress the printing of the graph profile entry for routine
 144 .Ar name
 145 and all its descendants
 146 (unless they have other ancestors that are not suppressed).
 147 More than one
 148 .Fl e
 149 option may be given.
 150 Only one
 151 .Ar name
 152 may be given with each
 153 .Fl e
 154 option.
 155 .It Fl E Ar name
 156 Suppress the printing of the graph profile entry for routine
 157 .Ar name
 158 (and its descendants) as
 159 .Fl e ,
 160 above, and also excludes the time spent in
 161 .Ar name
 162 (and its descendants) from the total and percentage time computations.
 163 (For example,
 164 .Fl E
 165 .Ar mcount
 166 .Fl E
 167 .Ar mcleanup
 168 is the default.)
 169 .It Fl f Ar name
 170 Print the graph profile entry of only the specified routine
 171 .Ar name
 172 and its descendants.
 173 More than one
 174 .Fl f
 175 option may be given.
 176 Only one
 177 .Ar name
 178 may be given with each
 179 .Fl f
 180 option.
 181 .It Fl F Ar name
 182 Print the graph profile entry of only the routine
 183 .Ar name
 184 and its descendants (as
 185 .Fl f ,
 186 above) and also uses only the times of the printed routines
 187 in total time and percentage computations.
 188 More than one
 189 .Fl F
 190 option may be given.
 191 Only one
 192 .Ar name
 193 may be given with each
 194 .Fl F
 195 option.
 196 The
 197 .Fl F
 198 option
 199 overrides
 200 the
 201 .Fl E
 202 option.
 203 .It Fl k Ar fromname Ar toname
 204 Will delete any arcs from routine
 205 .Ar fromname
 206 to routine
 207 .Ar toname .
 208 This can be used to break undesired cycles.
 209 More than one
 210 .Fl k
 211 option may be given.
 212 Only one pair of routine names may be given with each
 213 .Fl k
 214 option.
 215 .It Fl K
 216 Gather information about symbols from the currently-running kernel using the
 217 .Xr sysctl 3
 218 and
 219 .Xr kldsym 2
 220 interfaces.
 221 This forces the
 222 .Pa a.out
 223 argument to be ignored, and allows for symbols in
 224 .Xr kld 4
 225 modules to be used.
 226 .It Fl l
 227 Suppress the printing of the call-graph profile.
 228 .It Fl L
 229 Suppress the printing of the flat profile.
 230 .It Fl s
 231 A profile file
 232 .Pa gmon.sum
 233 is produced that represents
 234 the sum of the profile information in all the specified profile files.
 235 This summary profile file may be given to later
 236 executions of gprof (probably also with a
 237 .Fl s )
 238 to accumulate profile data across several runs of an
 239 .Pa a.out
 240 file.
 241 .It Fl u
 242 Suppress the printing of functions whose names are not visible to
 243 C programs.
 244 For the ELF object format, this means names that
 245 contain the
 246 .Ql .\&
 247 character.
 248 For the a.out object format, it means names that do not
 249 begin with a
 250 .Ql _
 251 character.
 252 All relevant information about such functions belongs to the
 253 (non-suppressed) function with the next lowest address.
 254 This is useful for eliminating "functions" that are just labels
 255 inside other functions.
 256 .It Fl z
 257 Display routines that have zero usage (as shown by call counts
 258 and accumulated time).
 259 .El
 260 .Sh FILES
 261 .Bl -tag -width a.out.gmon -compact
 262 .It Pa a.out
 263 The namelist and text space.
 264 .It Pa a.out.gmon
 265 Dynamic call graph and profile.
 266 .It Pa gmon.sum
 267 Summarized dynamic call graph and profile.
 268 .El
 269 .Sh SEE ALSO
 270 .Xr cc 1 ,
 271 .Xr profil 2 ,
 272 .Xr clocks 7 ,
 273 .Xr pmcstat 8
 274 .\" .Xr monitor 3 ,
 275 .\" .Xr prof 1
 276 .Rs
 277 .%T "An Execution Profiler for Modular Programs"
 278 .%A S. Graham
 279 .%A P. Kessler
 280 .%A M. McKusick
 281 .%J "Software - Practice and Experience"
 282 .%V 13
 283 .%P pp. 671-685
 284 .%D 1983
 285 .Re
 286 .Rs
 287 .%T "gprof: A Call Graph Execution Profiler"
 288 .%A S. Graham
 289 .%A P. Kessler
 290 .%A M. McKusick
 291 .%J "Proceedings of the SIGPLAN '82 Symposium on Compiler Construction, SIGPLAN Notices"
 292 .%V 17
 293 .%N 6
 294 .%P pp. 120-126
 295 .%D June 1982
 296 .Re
 297 .Sh HISTORY
 298 The
 299 .Nm
 300 profiler
 301 appeared in
 302 .Bx 4.2 .
 303 .Sh BUGS
 304 The granularity of the sampling is shown, but remains
 305 statistical at best.
 306 We assume that the time for each execution of a function
 307 can be expressed by the total time for the function divided
 308 by the number of times the function is called.
 309 Thus the time propagated along the call graph arcs to the function's
 310 parents is directly proportional to the number of times that
 311 arc is traversed.
 312 .Pp
 313 Parents that are not themselves profiled will have the time of
 314 their profiled children propagated to them, but they will appear
 315 to be spontaneously invoked in the call graph listing, and will
 316 not have their time propagated further.
 317 Similarly, signal catchers, even though profiled, will appear
 318 to be spontaneous (although for more obscure reasons).
 319 Any profiled children of signal catchers should have their times
 320 propagated properly, unless the signal catcher was invoked during
 321 the execution of the profiling routine, in which case all is lost.
 322 .Pp
 323 The profiled program must call
 324 .Xr exit 3
 325 or return normally for the profiling information to be saved
 326 in the graph profile file.