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.Dd June 14, 2004 29.Dt MONCONTROL 3 30.Os 31.Sh NAME 32.Nm moncontrol , 33.Nm monstartup 34.Nd control execution profile 35.Sh LIBRARY 36.Lb libc 37.Sh SYNOPSIS 38.In sys/types.h 39.In sys/gmon.h 40.Ft void 41.Fn moncontrol "int mode" 42.Ft void 43.Fn monstartup "u_long lowpc" "u_long highpc" 44.Sh DESCRIPTION 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.Ar progname Ns Pa .gmon , 56where progname is the name of the program, then 57.Xr gprof 1 58can be used to examine the results. 59.Pp 60The 61.Fn moncontrol 62function 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. 79The 80.Fa lowpc 81and 82.Fa highpc 83arguments 84specify the address range that is to be sampled; 85the lowest address sampled is that of 86.Fa lowpc 87and the highest is just below 88.Fa highpc . 89Only functions in that range that have been compiled with the 90.Fl pg 91option to 92.Xr cc 1 93will appear in the call graph part of the output; 94however, all functions in that address range will 95have their execution time measured. 96Profiling begins on return from 97.Fn monstartup . 98.Sh ENVIRONMENT 99The following environment variables affect the execution of 100.Nm : 101.Bl -tag -width ".Ev PROFIL_USE_PID" 102.It PROFIL_USE_PID 103If set, the pid of the process is inserted into the filename. 104.El 105.Sh FILES 106.Bl -tag -width progname.gmon -compact 107.It Pa progname.gmon 108execution data file 109.El 110.Sh SEE ALSO 111.Xr cc 1 , 112.Xr gprof 1 , 113.Xr profil 2 , 114.Xr clocks 7 115