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.\" @(#)kgmon.8 8.1 (Berkeley) 6/6/93
33.\" $FreeBSD: head/usr.sbin/kgmon/kgmon.8 93301 2002-03-28 00:16:49Z rwatson $
34.\"
35.Dd June 6, 1993
36.Dt KGMON 8
37.Os
38.Sh NAME
39.Nm kgmon
40.Nd generate a dump of the operating system's profile buffers
41.Sh SYNOPSIS
42.Nm
43.Op Fl Bbhpr
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
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
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 high resolution profile data.
68.It Fl b
69Resume the collection of low resolution profile data.
70.It Fl h
71Stop the collection of profile data.
72.It Fl p
73Dump the contents of the profile buffers into a
74.Pa gmon.out
75file.
76.It Fl r
77Reset all the profile buffers.
78If the
79.Fl p
80flag is also specified, the
81.Pa gmon.out
82file is generated before the buffers are reset.
83.It Fl M
84Extract values associated with the name list from the specified core
85instead of the default
86.Pa /dev/kmem .
87.It Fl N
88Extract the name list from the specified system instead of the
89default
90.Pa /boot/kernel/kernel .
91.El
92.Pp
93If neither
94.Fl B
95nor
96.Fl b
97nor
98.Fl h
99is specified, the state of profiling collection remains unchanged.
100For example, if the
101.Fl p
102flag is specified and profile data is being collected,
103profiling will be momentarily suspended,
104the operating system profile buffers will be dumped,
105and profiling will be immediately resumed.
106.Pp
107The profile buffers should be reset when the resolution
108of the profile data is changed.
109.Sh FILES
110.Bl -tag -width /dev/kmemx -compact
111.It Pa /boot/kernel/kernel
112the default system
113.It Pa /dev/kmem
114the default memory
115.El
116.Sh SEE ALSO
117.Xr gprof 1 ,
118.Xr config 8
119.Sh DIAGNOSTICS
120Users with only read permission on
121.Pa /dev/kmem
122cannot change the state
123of profiling collection.
124They can get a
125.Pa gmon.out
126file with the warning that the data may be
127inconsistent if profiling is in progress.
128.Sh HISTORY
129The
130.Nm
131command appeared in
132.Bx 4.2 .
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.\" @(#)kgmon.8 8.1 (Berkeley) 6/6/93
33.\" $FreeBSD: head/usr.sbin/kgmon/kgmon.8 93301 2002-03-28 00:16:49Z rwatson $
34.\"
35.Dd June 6, 1993
36.Dt KGMON 8
37.Os
38.Sh NAME
39.Nm kgmon
40.Nd generate a dump of the operating system's profile buffers
41.Sh SYNOPSIS
42.Nm
43.Op Fl Bbhpr
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
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
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 high resolution profile data.
68.It Fl b
69Resume the collection of low resolution profile data.
70.It Fl h
71Stop the collection of profile data.
72.It Fl p
73Dump the contents of the profile buffers into a
74.Pa gmon.out
75file.
76.It Fl r
77Reset all the profile buffers.
78If the
79.Fl p
80flag is also specified, the
81.Pa gmon.out
82file is generated before the buffers are reset.
83.It Fl M
84Extract values associated with the name list from the specified core
85instead of the default
86.Pa /dev/kmem .
87.It Fl N
88Extract the name list from the specified system instead of the
89default
90.Pa /boot/kernel/kernel .
91.El
92.Pp
93If neither
94.Fl B
95nor
96.Fl b
97nor
98.Fl h
99is specified, the state of profiling collection remains unchanged.
100For example, if the
101.Fl p
102flag is specified and profile data is being collected,
103profiling will be momentarily suspended,
104the operating system profile buffers will be dumped,
105and profiling will be immediately resumed.
106.Pp
107The profile buffers should be reset when the resolution
108of the profile data is changed.
109.Sh FILES
110.Bl -tag -width /dev/kmemx -compact
111.It Pa /boot/kernel/kernel
112the default system
113.It Pa /dev/kmem
114the default memory
115.El
116.Sh SEE ALSO
117.Xr gprof 1 ,
118.Xr config 8
119.Sh DIAGNOSTICS
120Users with only read permission on
121.Pa /dev/kmem
122cannot change the state
123of profiling collection.
124They can get a
125.Pa gmon.out
126file with the warning that the data may be
127inconsistent if profiling is in progress.
128.Sh HISTORY
129The
130.Nm
131command appeared in
132.Bx 4.2 .