projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| 01a3eda7 KM |
1 | .\" Copyright (c) 1983 Regents of the University of California. |
| 2 | .\" All rights reserved. The Berkeley software License Agreement | |
| 3 | .\" specifies the terms and conditions for redistribution. | |
| 4 | .\" | |
| 43598d14 | 5 | .\" @(#)kgmon.8 6.1 (Berkeley) %G% |
| 01a3eda7 | 6 | .\" |
| 43598d14 | 7 | .TH KGMON 8 "" |
| 01a3eda7 KM |
8 | .UC 5 |
| 9 | .SH NAME | |
| 10 | kgmon \- generate a dump of the operating system's profile buffers | |
| 11 | .SH SYNOPSIS | |
| 12 | .B /etc/kgmon | |
| 13 | [ | |
| 14 | .B \-b | |
| 15 | ] [ | |
| 16 | .B \-h | |
| 17 | ] [ | |
| 18 | .B \-r | |
| 19 | ] [ | |
| 20 | .B \-p | |
| 21 | ] [ system ] [ memory ] | |
| 22 | .SH DESCRIPTION | |
| 23 | .I Kgmon | |
| 24 | is a tool used when profiling the operating system. | |
| 25 | When no arguments are supplied, | |
| 26 | .I kgmon | |
| 27 | indicates the state of operating system profiling as running, | |
| 28 | off, or not configured. | |
| 29 | (see | |
| 30 | .IR config (8)) | |
| 31 | If the | |
| 32 | .B \-p | |
| 33 | flag is specified, | |
| 34 | .I kgmon | |
| 35 | extracts profile data from the operating system and produces a | |
| 36 | .I gmon.out | |
| 37 | file suitable for later analysis by | |
| 38 | .IR gprof (1). | |
| 39 | .PP | |
| 40 | The following options may be specified: | |
| 41 | .TP | |
| 42 | .B \-b | |
| 43 | Resume the collection of profile data. | |
| 44 | .TP | |
| 45 | .B \-h | |
| 46 | Stop the collection of profile data. | |
| 47 | .TP | |
| 48 | .B \-p | |
| 49 | Dump the contents of the profile buffers into a | |
| 50 | .I gmon.out | |
| 51 | file. | |
| 52 | .TP | |
| 53 | .B \-r | |
| 54 | Reset all the profile buffers. | |
| 55 | If the | |
| 56 | .B \-p | |
| 57 | flag is also specified, the | |
| 58 | .I gmon.out | |
| 59 | file is generated before the buffers are reset. | |
| 60 | .PP | |
| 61 | If neither | |
| 62 | .B \-b | |
| 63 | nor | |
| 64 | .B \-h | |
| 65 | is specified, the state of profiling collection remains unchanged. | |
| 66 | For example, if the | |
| 67 | .B \-p | |
| 68 | flag is specified and profile data is being collected, | |
| 69 | profiling will be momentarily suspended, | |
| 70 | the operating system profile buffers will be dumped, | |
| 71 | and profiling will be immediately resumed. | |
| 72 | .SH FILES | |
| 73 | /vmunix \- the default system | |
| 74 | .br | |
| 75 | /dev/kmem \- the default memory | |
| 76 | .SH "SEE ALSO" | |
| 77 | gprof(1), | |
| 78 | config(8) | |
| 79 | .SH DIAGNOSTICS | |
| 80 | Users with only read permission on /dev/kmem cannot change the state | |
| 81 | of profiling collection. | |
| 82 | They can get a | |
| 83 | .I gmon.out | |
| 84 | file with the warning that the data may be | |
| 85 | inconsistent if profiling is in progress. |