d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2c24ffacd6
freebsd-dev/usr.sbin/kgmon/kgmon.8

131 lines
3.7 KiB
Groff
Raw Normal View History

BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)kgmon.8 8.1 (Berkeley) 6/6/93
$Id$ -> $FreeBSD$
1999-08-28 01:35:59 +00:00
.\" $FreeBSD$
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.\"
.Xr pmcstat(8) from kgmon(8) and gprof(1). MFC after: 2 weeks Sponsored by: DARPA, AFRL
2017-11-27 12:37:14 +00:00
.Dd November 27, 2017
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Dt KGMON 8
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 15:12:08 +00:00
.Os
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Sh NAME
.Nm kgmon
.Nd generate a dump of the operating system's profile buffers
.Sh SYNOPSIS
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 20:10:44 +00:00
.Nm
Implemented non-statistical kernel profiling. This is based on looking at a high resolution clock for each of the following events: function call, function return, interrupt entry, interrupt exit, and interesting branches. The differences between the times of these events are added at appropriate places in a ordinary histogram (as if very fast statistical profiling sampled the pc at those places) so that ordinary gprof can be used to analyze the times. gmon.h: Histogram counters need to be 4 bytes for microsecond resolutions. They will need to be larger for the 586 clock. The comments were vax-centric and wrong even on vaxes. Does anyone disagree? gprof4.c: The standard gprof should support counters of all integral sizes and the size of the counter should be in the gmon header. This hack will do until then. (Use gprof4 -u to examine the results of non-statistical profiling.) config/*: Non-statistical profiling is configured with `config -pp'. `config -p' still gives ordinary profiling. kgmon/*: Non-statistical profiling is enabled with `kgmon -B'. `kgmon -b' still enables ordinary profiling (and distables non-statistical profiling) if non-statistical profiling is configured.
1995-12-29 15:30:05 +00:00
.Op Fl Bbhpr
Format nits.
2004-05-29 06:10:42 +00:00
.Op Fl M Ar core
.Op Fl N Ar system
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Sh DESCRIPTION
The .Nm utility
2002-07-14 14:47:15 +00:00
The
.Nm
utility is used when profiling the operating system.
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
When no arguments are supplied,
Use err(3). Add usage() and prototypes.
1997-09-23 06:38:54 +00:00
.Nm
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
indicates the state of operating system profiling as running,
off, or not configured.
(see
.Xr config 8 )
If the
.Fl p
flag is specified,
Use err(3). Add usage() and prototypes.
1997-09-23 06:38:54 +00:00
.Nm
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
extracts profile data from the operating system and produces a
.Pa gmon.out
file suitable for later analysis by
.Xr gprof 1 .
.Pp
The options are as follows:
.Bl -tag -width Ds
Implemented non-statistical kernel profiling. This is based on looking at a high resolution clock for each of the following events: function call, function return, interrupt entry, interrupt exit, and interesting branches. The differences between the times of these events are added at appropriate places in a ordinary histogram (as if very fast statistical profiling sampled the pc at those places) so that ordinary gprof can be used to analyze the times. gmon.h: Histogram counters need to be 4 bytes for microsecond resolutions. They will need to be larger for the 586 clock. The comments were vax-centric and wrong even on vaxes. Does anyone disagree? gprof4.c: The standard gprof should support counters of all integral sizes and the size of the counter should be in the gmon header. This hack will do until then. (Use gprof4 -u to examine the results of non-statistical profiling.) config/*: Non-statistical profiling is configured with `config -pp'. `config -p' still gives ordinary profiling. kgmon/*: Non-statistical profiling is enabled with `kgmon -B'. `kgmon -b' still enables ordinary profiling (and distables non-statistical profiling) if non-statistical profiling is configured.
1995-12-29 15:30:05 +00:00
.It Fl B
Resume the collection of high resolution profile data.
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.It Fl b
Implemented non-statistical kernel profiling. This is based on looking at a high resolution clock for each of the following events: function call, function return, interrupt entry, interrupt exit, and interesting branches. The differences between the times of these events are added at appropriate places in a ordinary histogram (as if very fast statistical profiling sampled the pc at those places) so that ordinary gprof can be used to analyze the times. gmon.h: Histogram counters need to be 4 bytes for microsecond resolutions. They will need to be larger for the 586 clock. The comments were vax-centric and wrong even on vaxes. Does anyone disagree? gprof4.c: The standard gprof should support counters of all integral sizes and the size of the counter should be in the gmon header. This hack will do until then. (Use gprof4 -u to examine the results of non-statistical profiling.) config/*: Non-statistical profiling is configured with `config -pp'. `config -p' still gives ordinary profiling. kgmon/*: Non-statistical profiling is enabled with `kgmon -B'. `kgmon -b' still enables ordinary profiling (and distables non-statistical profiling) if non-statistical profiling is configured.
1995-12-29 15:30:05 +00:00
Resume the collection of low resolution profile data.
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.It Fl h
Stop the collection of profile data.
.It Fl p
Dump the contents of the profile buffers into a
.Pa gmon.out
file.
.It Fl r
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
Reset all the profile buffers.
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
If the
.Fl p
flag is also specified, the
.Pa gmon.out
file is generated before the buffers are reset.
.It Fl M
Extract values associated with the name list from the specified core
Put file names under .Pa.
1999-11-27 16:52:41 +00:00
instead of the default
.Pa /dev/kmem .
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.It Fl N
Extract the name list from the specified system instead of the
Put file names under .Pa.
1999-11-27 16:52:41 +00:00
default
Update kgmon.8 to refer to /boot/kernel/kernel on -CURRENT, rather than /kernel. kgmon actually appears to use getbootfile(), and the man page might need to be updated to reflect that. Reported by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-03-28 00:16:49 +00:00
.Pa /boot/kernel/kernel .
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.El
.Pp
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
If neither
Implemented non-statistical kernel profiling. This is based on looking at a high resolution clock for each of the following events: function call, function return, interrupt entry, interrupt exit, and interesting branches. The differences between the times of these events are added at appropriate places in a ordinary histogram (as if very fast statistical profiling sampled the pc at those places) so that ordinary gprof can be used to analyze the times. gmon.h: Histogram counters need to be 4 bytes for microsecond resolutions. They will need to be larger for the 586 clock. The comments were vax-centric and wrong even on vaxes. Does anyone disagree? gprof4.c: The standard gprof should support counters of all integral sizes and the size of the counter should be in the gmon header. This hack will do until then. (Use gprof4 -u to examine the results of non-statistical profiling.) config/*: Non-statistical profiling is configured with `config -pp'. `config -p' still gives ordinary profiling. kgmon/*: Non-statistical profiling is enabled with `kgmon -B'. `kgmon -b' still enables ordinary profiling (and distables non-statistical profiling) if non-statistical profiling is configured.
1995-12-29 15:30:05 +00:00
.Fl B
nor
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Fl b
nor
.Fl h
is specified, the state of profiling collection remains unchanged.
For example, if the
.Fl p
flag is specified and profile data is being collected,
profiling will be momentarily suspended,
the operating system profile buffers will be dumped,
and profiling will be immediately resumed.
Implemented non-statistical kernel profiling. This is based on looking at a high resolution clock for each of the following events: function call, function return, interrupt entry, interrupt exit, and interesting branches. The differences between the times of these events are added at appropriate places in a ordinary histogram (as if very fast statistical profiling sampled the pc at those places) so that ordinary gprof can be used to analyze the times. gmon.h: Histogram counters need to be 4 bytes for microsecond resolutions. They will need to be larger for the 586 clock. The comments were vax-centric and wrong even on vaxes. Does anyone disagree? gprof4.c: The standard gprof should support counters of all integral sizes and the size of the counter should be in the gmon header. This hack will do until then. (Use gprof4 -u to examine the results of non-statistical profiling.) config/*: Non-statistical profiling is configured with `config -pp'. `config -p' still gives ordinary profiling. kgmon/*: Non-statistical profiling is enabled with `kgmon -B'. `kgmon -b' still enables ordinary profiling (and distables non-statistical profiling) if non-statistical profiling is configured.
1995-12-29 15:30:05 +00:00
.Pp
The profile buffers should be reset when the resolution
of the profile data is changed.
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Sh FILES
Use correct item to track max width of list
2003-03-24 20:55:28 +00:00
.Bl -tag -width /boot/kernel/kernel -compact
Update kgmon.8 to refer to /boot/kernel/kernel on -CURRENT, rather than /kernel. kgmon actually appears to use getbootfile(), and the man page might need to be updated to reflect that. Reported by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-03-28 00:16:49 +00:00
.It Pa /boot/kernel/kernel
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
the default system
.It Pa /dev/kmem
the default memory
.El
.Sh DIAGNOSTICS
Users with only read permission on
.Pa /dev/kmem
cannot change the state
Remove whitespace at EOL.
2001-07-15 08:06:20 +00:00
of profiling collection.
They can get a
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Pa gmon.out
file with the warning that the data may be
inconsistent if profiling is in progress.
Sort sections.
2005-01-18 20:02:45 +00:00
.Sh SEE ALSO
.Xr gprof 1 ,
.Xr pmcstat(8) from kgmon(8) and gprof(1). MFC after: 2 weeks Sponsored by: DARPA, AFRL
2017-11-27 12:37:14 +00:00
.Xr config 8 ,
.Xr pmcstat 8
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Sh HISTORY
The
.Nm
The .Nm utility
2002-07-14 14:47:15 +00:00
utility appeared in
BSD 4.4 Lite usr.sbin Sources
1994-05-26 05:23:31 +00:00
.Bx 4.2 .
Reference in New Issue Copy Permalink