src/lib/libc/gmon/moncontrol.3

   1 .\"     $OpenBSD: moncontrol.3,v 1.6 2007/05/31 19:19:29 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1991, 1992, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .Dd $Mdocdate: May 31 2007 $
  31 .Dt MONCONTROL 3
  32 .Os
  33 .Sh NAME
  34 .Nm moncontrol ,
  35 .Nm monstartup
  36 .Nd control execution profile
  37 .Sh SYNOPSIS
  38 .Fn moncontrol "int mode"
  39 .Fn monstartup "u_long *lowpc" "u_long *highpc"
  40 .Sh DESCRIPTION
  41 An executable program compiled using the
  42 .Fl pg
  43 option to
  44 .Xr cc 1
  45 automatically includes calls to collect statistics for the
  46 .Xr gprof 1
  47 call-graph execution profiler.
  48 In typical operation, profiling begins at program startup
  49 and ends when the program calls exit.
  50 When the program exits, the profiling data are written to the file
  51 .Em gmon.out ,
  52 then
  53 .Xr gprof 1
  54 can be used to examine the results.
  55 .Pp
  56 .Fn moncontrol
  57 selectively controls profiling within a program.
  58 When the program starts, profiling begins.
  59 To stop the collection of histogram ticks and call counts use
  60 .Fn moncontrol 0 ;
  61 to resume the collection of histogram ticks and call counts use
  62 .Fn moncontrol 1 .
  63 This feature allows the cost of particular operations to be measured.
  64 Note that an output file will be produced on program exit
  65 regardless of the state of
  66 .Fn moncontrol .
  67 .Pp
  68 Programs that are not loaded with
  69 .Fl pg
  70 may selectively collect profiling statistics by calling
  71 .Fn monstartup
  72 with the range of addresses to be profiled.
  73 .Fa lowpc
  74 and
  75 .Fa highpc
  76 specify the address range that is to be sampled;
  77 the lowest address sampled is that of
  78 .Fa lowpc
  79 and the highest is just below
  80 .Fa highpc .
  81 Only functions in that range that have been compiled with the
  82 .Fl pg
  83 option to
  84 .Xr cc 1
  85 will appear in the call graph part of the output;
  86 however, all functions in that address range will
  87 have their execution time measured.
  88 Profiling begins on return from
  89 .Fn monstartup .
  90 .Sh FILES
  91 .Bl -tag -width Pa -compact
  92 .It Pa gmon.out execution data file
  93 .El
  94 .Sh SEE ALSO
  95 .Xr cc 1 ,
  96 .Xr gprof 1 ,
  97 .Xr profil 2