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