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