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