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