usr.sbin/kgmon/kgmon.8

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