lib/libc/gmon/moncontrol.3

   1 .\" Copyright (c) 1980, 1991, 1992, 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 .\" 4. 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 .\"     @(#)moncontrol.3        8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 14, 2004
  32 .Dt MONCONTROL 3
  33 .Os
  34 .Sh NAME
  35 .Nm moncontrol ,
  36 .Nm monstartup
  37 .Nd control execution profile
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In sys/gmon.h
  43 .Ft void
  44 .Fn moncontrol "int mode"
  45 .Ft void
  46 .Fn monstartup "u_long lowpc" "u_long highpc"
  47 .Sh DESCRIPTION
  48 An executable program compiled using the
  49 .Fl pg
  50 option to
  51 .Xr cc 1
  52 automatically includes calls to collect statistics for the
  53 .Xr gprof 1
  54 call-graph execution profiler.
  55 In typical operation, profiling begins at program startup
  56 and ends when the program calls exit.
  57 When the program exits, the profiling data are written to the file
  58 .Ar progname Ns Pa .gmon ,
  59 where progname is the name of the program, then
  60 .Xr gprof 1
  61 can be used to examine the results.
  62 .Pp
  63 The
  64 .Fn moncontrol
  65 function
  66 selectively controls profiling within a program.
  67 When the program starts, profiling begins.
  68 To stop the collection of histogram ticks and call counts use
  69 .Fn moncontrol 0 ;
  70 to resume the collection of histogram ticks and call counts use
  71 .Fn moncontrol 1 .
  72 This feature allows the cost of particular operations to be measured.
  73 Note that an output file will be produced on program exit
  74 regardless of the state of
  75 .Fn moncontrol .
  76 .Pp
  77 Programs that are not loaded with
  78 .Fl pg
  79 may selectively collect profiling statistics by calling
  80 .Fn monstartup
  81 with the range of addresses to be profiled.
  82 The
  83 .Fa lowpc
  84 and
  85 .Fa highpc
  86 arguments
  87 specify the address range that is to be sampled;
  88 the lowest address sampled is that of
  89 .Fa lowpc
  90 and the highest is just below
  91 .Fa highpc .
  92 Only functions in that range that have been compiled with the
  93 .Fl pg
  94 option to
  95 .Xr cc 1
  96 will appear in the call graph part of the output;
  97 however, all functions in that address range will
  98 have their execution time measured.
  99 Profiling begins on return from
 100 .Fn monstartup .
 101 .Sh ENVIRONMENT
 102 The following environment variables affect the execution of
 103 .Nm :
 104 .Bl -tag -width ".Ev PROFIL_USE_PID"
 105 .It PROFIL_USE_PID
 106 If set, the pid of the process is inserted into the filename.
 107 .El
 108 .Sh FILES
 109 .Bl -tag -width progname.gmon -compact
 110 .It Pa progname.gmon
 111 execution data file
 112 .El
 113 .Sh SEE ALSO
 114 .Xr cc 1 ,
 115 .Xr gprof 1 ,
 116 .Xr profil 2 ,
 117 .Xr clocks 7