1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH KSTAT 1M "Mar 23, 2009"
   7 .SH NAME
   8 kstat \- display kernel statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBkstat\fR [\fB-lpq\fR] [\fB-T\fR u | d ] [\fB-c\fR \fIclass\fR] [\fB-m\fR \fImodule\fR]
  13      [\fB-i\fR \fIinstance\fR] [\fB-n\fR \fIname\fR] [\fB-s\fR \fIstatistic\fR]
  14      [interval [count]]
  15 .fi
  16 
  17 .LP
  18 .nf
  19 \fBkstat\fR [\fB-lpq\fR] [\fB-T\fR u | d ] [\fB-c\fR \fIclass\fR]
  20      [\fImodule\fR:\fIinstance\fR:\fIname\fR:\fIstatistic\fR]...
  21      [interval [count]]
  22 .fi
  23 
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBkstat\fR utility examines the available kernel statistics, or kstats, on
  28 the system and reports those statistics which match the criteria specified on
  29 the command line. Each matching statistic is printed with its module, instance,
  30 and name fields, as well as its actual value.
  31 .sp
  32 .LP
  33 Kernel statistics may be published by various kernel subsystems, such as
  34 drivers or loadable modules; each kstat has a module field that denotes its
  35 publisher. Since each module might have countable entities (such as multiple
  36 disks associated with the \fBsd\fR(7D) driver) for which it wishes to report
  37 statistics, the kstat also has an instance field to index the statistics for
  38 each entity; kstat instances are numbered starting from zero. Finally, the
  39 kstat is given a name unique within its module.

  42 Each kstat may be a special kstat type, an array of name-value pairs, or raw
  43 data. In the name-value case, each reported value is given a label, which we
  44 refer to as the statistic. Known raw and special kstats are given statistic
  45 labels for each of their values by \fBkstat\fR; thus, all published values can
  46 be referenced as \fImodule\fR:\fIinstance\fR:\fIname\fR:\fIstatistic\fR.
  47 .sp
  48 .LP
  49 When invoked without any module operands or options, kstat will match all
  50 defined statistics on the system. Example invocations are provided below. All
  51 times are displayed as fractional seconds since system boot.
  52 .SH OPTIONS
  53 .sp
  54 .LP
  55 The tests specified by the following options are logically ANDed, and all
  56 matching kstats will be selected. A regular expression containing shell
  57 metacharacters must be protected from the shell by enclosing it with the
  58 appropriate quotes.
  59 .sp
  60 .LP
  61 The argument for the \fB-c\fR, \fB-i\fR, \fB-m\fR, \fB-n\fR, and \fB-s\fR
  62 options may be specified as a shell glob pattern, or a Perl regular expression
  63 enclosed in '/' characters.
  64 .sp
  65 .ne 2
  66 .na









  67 \fB\fB-c\fR \fIclass\fR\fR
  68 .ad
  69 .RS 16n
  70 Displays only kstats that match the specified class. \fIclass\fR is a
  71 kernel-defined string which classifies the "type" of the kstat.
  72 .RE
  73 
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-i\fR \fIinstance\fR\fR
  78 .ad
  79 .RS 16n
  80 Displays only kstats that match the specified instance.
  81 .RE
  82 
  83 .sp
  84 .ne 2
  85 .na









  86 \fB\fB-l\fR\fR
  87 .ad
  88 .RS 16n
  89 Lists matching kstat names without displaying values.
  90 .RE
  91 
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB-m\fR \fImodule\fR\fR
  96 .ad
  97 .RS 16n
  98 Displays only kstats that match the specified module.
  99 .RE
 100 
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-n\fR \fIname\fR\fR
 105 .ad

 144 .ad
 145 .RS 16n
 146 Displays a time stamp before each statistics block, either in \fBdate\fR(1)
 147 format (\fBd\fR) or as an alphanumeric representation of the value returned by
 148 \fBtime\fR(2) (\fBu\fR).
 149 .RE
 150 
 151 .SH OPERANDS
 152 .sp
 153 .LP
 154 The following operands are supported:
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fImodule\fR:\fIinstance\fR:\fIname\fR:\fIstatistic\fR\fR
 159 .ad
 160 .sp .6
 161 .RS 4n
 162 Alternate method of specifying module, instance, name, and statistic as
 163 described above. Each of the module, instance, name, or statistic specifiers
 164 may be a shell glob pattern or a Perl regular expression enclosed by '/'
 165 characters. It is possible to use both specifier types within a single operand.
 166 Leaving a specifier empty is equivalent to using the '*' glob pattern for that
 167 specifier.
 168 .RE
 169 
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fIinterval\fR\fR
 174 .ad
 175 .sp .6
 176 .RS 4n
 177 The number of seconds between reports.
 178 .RE
 179 
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fIcount\fR\fR
 184 .ad

 350 
 351 .SH FILES
 352 .sp
 353 .ne 2
 354 .na
 355 \fB\fB/dev/kstat\fR\fR
 356 .ad
 357 .RS 14n
 358 kernel statistics driver
 359 .RE
 360 
 361 .SH SEE ALSO
 362 .sp
 363 .LP
 364 \fBdate\fR(1), \fBsh\fR(1), \fBtime\fR(2), \fBgmatch\fR(3GEN),
 365 \fBkstat\fR(3KSTAT), \fBattributes\fR(5), \fBkstat\fR(7D), \fBsd\fR(7D),
 366 \fBkstat\fR(9S)
 367 .SH NOTES
 368 .sp
 369 .LP
 370 If the pattern argument contains glob or Perl RE metacharacters which are also
 371 shell metacharacters, it will be necessary to enclose the pattern with
 372 appropriate shell quotes.

   1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH KSTAT 1M "Jan 9, 2013"
   7 .SH NAME
   8 kstat \- display kernel statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBkstat\fR [\fB-Cjlpq\fR] [\fB-T\fR u | d ] [\fB-c\fR \fIclass\fR] [\fB-m\fR \fImodule\fR]
  13      [\fB-i\fR \fIinstance\fR] [\fB-n\fR \fIname\fR] [\fB-s\fR \fIstatistic\fR]
  14      [interval [count]]
  15 .fi
  16 
  17 .LP
  18 .nf
  19 \fBkstat\fR [\fB-Cjlpq\fR] [\fB-T\fR u | d ] [\fB-c\fR \fIclass\fR]
  20      [\fImodule\fR:\fIinstance\fR:\fIname\fR:\fIstatistic\fR]...
  21      [interval [count]]
  22 .fi
  23 
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBkstat\fR utility examines the available kernel statistics, or kstats, on
  28 the system and reports those statistics which match the criteria specified on
  29 the command line. Each matching statistic is printed with its module, instance,
  30 and name fields, as well as its actual value.
  31 .sp
  32 .LP
  33 Kernel statistics may be published by various kernel subsystems, such as
  34 drivers or loadable modules; each kstat has a module field that denotes its
  35 publisher. Since each module might have countable entities (such as multiple
  36 disks associated with the \fBsd\fR(7D) driver) for which it wishes to report
  37 statistics, the kstat also has an instance field to index the statistics for
  38 each entity; kstat instances are numbered starting from zero. Finally, the
  39 kstat is given a name unique within its module.

  42 Each kstat may be a special kstat type, an array of name-value pairs, or raw
  43 data. In the name-value case, each reported value is given a label, which we
  44 refer to as the statistic. Known raw and special kstats are given statistic
  45 labels for each of their values by \fBkstat\fR; thus, all published values can
  46 be referenced as \fImodule\fR:\fIinstance\fR:\fIname\fR:\fIstatistic\fR.
  47 .sp
  48 .LP
  49 When invoked without any module operands or options, kstat will match all
  50 defined statistics on the system. Example invocations are provided below. All
  51 times are displayed as fractional seconds since system boot.
  52 .SH OPTIONS
  53 .sp
  54 .LP
  55 The tests specified by the following options are logically ANDed, and all
  56 matching kstats will be selected. A regular expression containing shell
  57 metacharacters must be protected from the shell by enclosing it with the
  58 appropriate quotes.
  59 .sp
  60 .LP
  61 The argument for the \fB-c\fR, \fB-i\fR, \fB-m\fR, \fB-n\fR, and \fB-s\fR
  62 options may be specified as a shell glob pattern, or a regular expression
  63 enclosed in '/' characters.
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fB-C\fR\fR
  68 .ad
  69 .RS 16n
  70 Displays output in parseable format with a colon as separator.
  71 .RE
  72 
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fB-c\fR \fIclass\fR\fR
  77 .ad
  78 .RS 16n
  79 Displays only kstats that match the specified class. \fIclass\fR is a
  80 kernel-defined string which classifies the "type" of the kstat.
  81 .RE
  82 
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fB-i\fR \fIinstance\fR\fR
  87 .ad
  88 .RS 16n
  89 Displays only kstats that match the specified instance.
  90 .RE
  91 
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB-j\fR\fR
  96 .ad
  97 .RS 16n
  98 Displays output in JSON format.
  99 .RE
 100 
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-l\fR\fR
 105 .ad
 106 .RS 16n
 107 Lists matching kstat names without displaying values.
 108 .RE
 109 
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fB-m\fR \fImodule\fR\fR
 114 .ad
 115 .RS 16n
 116 Displays only kstats that match the specified module.
 117 .RE
 118 
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fB-n\fR \fIname\fR\fR
 123 .ad

 162 .ad
 163 .RS 16n
 164 Displays a time stamp before each statistics block, either in \fBdate\fR(1)
 165 format (\fBd\fR) or as an alphanumeric representation of the value returned by
 166 \fBtime\fR(2) (\fBu\fR).
 167 .RE
 168 
 169 .SH OPERANDS
 170 .sp
 171 .LP
 172 The following operands are supported:
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fImodule\fR:\fIinstance\fR:\fIname\fR:\fIstatistic\fR\fR
 177 .ad
 178 .sp .6
 179 .RS 4n
 180 Alternate method of specifying module, instance, name, and statistic as
 181 described above. Each of the module, instance, name, or statistic specifiers
 182 may be a shell glob pattern or a regular expression enclosed by '/'
 183 characters. It is possible to use both specifier types within a single operand.
 184 Leaving a specifier empty is equivalent to using the '*' glob pattern for that
 185 specifier.
 186 .RE
 187 
 188 .sp
 189 .ne 2
 190 .na
 191 \fB\fIinterval\fR\fR
 192 .ad
 193 .sp .6
 194 .RS 4n
 195 The number of seconds between reports.
 196 .RE
 197 
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fIcount\fR\fR
 202 .ad

 368 
 369 .SH FILES
 370 .sp
 371 .ne 2
 372 .na
 373 \fB\fB/dev/kstat\fR\fR
 374 .ad
 375 .RS 14n
 376 kernel statistics driver
 377 .RE
 378 
 379 .SH SEE ALSO
 380 .sp
 381 .LP
 382 \fBdate\fR(1), \fBsh\fR(1), \fBtime\fR(2), \fBgmatch\fR(3GEN),
 383 \fBkstat\fR(3KSTAT), \fBattributes\fR(5), \fBkstat\fR(7D), \fBsd\fR(7D),
 384 \fBkstat\fR(9S)
 385 .SH NOTES
 386 .sp
 387 .LP
 388 If the pattern argument contains glob or RE metacharacters which are also
 389 shell metacharacters, it will be necessary to enclose the pattern with
 390 appropriate shell quotes.