1.\" $NetBSD: kgmon.8,v 1.13 2002/01/19 03:20:33 wiz Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 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.\" from: @(#)kgmon.8 8.1 (Berkeley) 6/6/93 35.\" 36.Dd June 6, 1993 37.Dt KGMON 8 38.Os 39.Sh NAME 40.Nm kgmon 41.Nd generate a dump of the operating system's profile buffers 42.Sh SYNOPSIS 43.Nm kgmon 44.Op Fl bdhpr 45.Op Fl M Ar core 46.Op Fl N Ar system 47.Sh DESCRIPTION 48.Nm 49is a tool used when profiling the operating system. 50When no arguments are supplied, 51.Nm kgmon 52indicates the state of operating system profiling as running, 53off, or not configured. 54(see 55.Xr config 8 ) 56If the 57.Fl p 58flag is specified, 59.Nm kgmon 60extracts profile data from the operating system and produces a 61.Pa gmon.out 62file suitable for later analysis by 63.Xr gprof 1 . 64.Pp 65The options are as follows: 66.Bl -tag -width Ds 67.It Fl b 68Resume the collection of profile data. 69.It Fl d 70Enable debug output. 71.It Fl h 72Stop the collection of profile data. 73.It Fl p 74Dump the contents of the profile buffers into a 75.Pa gmon.out 76file. 77.It Fl r 78Reset all the profile buffers. 79If the 80.Fl p 81flag is also specified, the 82.Pa gmon.out 83file is generated before the buffers are reset. 84.It Fl M 85Extract values associated with the name list from the specified core 86instead of the default 87.Pa /dev/kmem . 88.It Fl N 89Extract the name list from the specified system instead of the 90default 91.Pa /netbsd . 92.El 93.Pp 94If neither 95.Fl b 96nor 97.Fl h 98is specified, the state of profiling collection remains unchanged. 99For example, if the 100.Fl p 101flag is specified and profile data is being collected, 102profiling will be momentarily suspended, 103the operating system profile buffers will be dumped, 104and profiling will be immediately resumed. 105.Sh FILES 106.Bl -tag -width /dev/kmemx -compact 107.It Pa /netbsd 108the default system 109.It Pa /dev/kmem 110the default memory 111.El 112.Sh DIAGNOSTICS 113Users with only read permission on 114.Pa /dev/kmem 115cannot change the state 116of profiling collection. 117They can get a 118.Pa gmon.out 119file with the warning that the data may be 120inconsistent if profiling is in progress. 121.Sh SEE ALSO 122.Xr gprof 1 , 123.Xr config 8 124.Sh HISTORY 125The 126.Nm 127command appeared in 128.Bx 4.2 . 129