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