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