share/man/man8/intrstat.8

   1 '\" te
   2 .\" Copyright (c) 2009, 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 INTRSTAT 8 "Jun 16, 2009"
   7 .SH NAME
   8 intrstat \- report interrupt statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/intrstat\fR [\fB-c\fR \fIcpulist\fR | \fB-C\fR \fIprocessor_set_id\fR] [\fB-T\fR u | d ]
  13      [\fB-x\fR \fIopt\fR[=\fIval\fR]] [\fIinterval\fR [\fIcount\fR]]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBintrstat\fR utility gathers and displays run-time interrupt statistics.
  20 The output is a table of device names and CPU IDs, where each row of the table
  21 denotes a device, and each column of the table denotes a CPU. Each cell in the
  22 table contains both the raw number of interrupts for the given device on the
  23 given CPU, and the percentage of absolute time spent in that device's interrupt
  24 handler on that CPU.
  25 .sp
  26 .LP
  27 The device name is given in the form of
  28 \fB{\fR\fIname\fR}\fI#\fR\fB{\fR\fIinstance\fR\fB}\fR. The name is the
  29 normalized driver name, and typically corresponds to the name of the module
  30 implementing the driver. See \fBddi_driver_name\fR(9F). Many Sun-delivered
  31 drivers have their own manual pages. See \fBIntro\fR(7).
  32 .sp
  33 .LP
  34 If standard output is a terminal, the table contains as many columns of data as
  35 can fit within the terminal width. If standard output is not a terminal, the
  36 table contains at most four columns of data. By default, data is gathered and
  37 displayed for all CPUs. If the data cannot fit in a single table, it is printed
  38 across multiple tables. The set of CPUs for which data is displayed can be
  39 optionally specified with the \fB-c\fR or \fB-C\fR option.
  40 .sp
  41 .LP
  42 By default, \fBintrstat\fR displays data once per second and runs indefinitely.
  43 Both of these behaviors can be optionally controlled with the interval and
  44 count parameters, respectively. See \fBOPERANDS\fR.
  45 .sp
  46 .LP
  47 Because \fBintrstat\fR uses dynamic discovery, it reports only on devices that
  48 raise interrupts while the command is running. Any devices that  are silent
  49 while \fBintrstat\fR is running are not displayed.
  50 .sp
  51 .LP
  52 \fBintrstat\fR induces a small system-wide performance degradation. As a
  53 result, only the super-user can run \fBintrstat\fR by default. The \fISolaris
  54 Dynamic Tracing Guide\fR explains how administrators can grant privileges to
  55 other users to permit them to run \fBintrstat\fR.
  56 .SH OPTIONS
  57 .sp
  58 .LP
  59 The following options are supported:
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fB-c\fR \fIcpulist\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 Displays data for the CPUs specified by \fIcpulist\fR.
  68 .sp
  69 \fIcpulist\fR can be a single processor ID (for example, \fB4\fR), a range of
  70 processor IDs (for example, \fB4-6\fR), or a comma separated list of processor
  71 IDs or processor ID ranges (for example, \fB4,5,6\fR or \fB4,6-8\fR).
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-C\fR \fIprocessor_set_id\fR\fR
  78 .ad
  79 .sp .6
  80 .RS 4n
  81 Displays data for the CPUs in the processor set specified by
  82 \fIprocessor_set_id\fR.
  83 .sp
  84 \fBintrstat\fR modifies its output to always reflect the CPUs in the specified
  85 processor set. If a CPU is added to the set, \fBintrstat\fR modifies its output
  86 to include the added CPU. If a CPU is removed from the set, \fBintrstat\fR
  87 modifies its output to exclude the removed CPU. At most one processor set can
  88 be specified.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-T\fR \fBu\fR | \fBd\fR\fR
  95 .ad
  96 .sp .6
  97 .RS 4n
  98 Display a time stamp.
  99 .sp
 100 Specify \fBu\fR for a printed representation of the internal representation of
 101 time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See
 102 \fBdate\fR(1).
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB-x\fR \fIopt\fR[=\fIval\fR]\fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 Enable or modify a DTrace runtime option or D compiler option. The list of
 113 options is found in the \fISolaris Dynamic Tracing Guide\fR. A boolean option
 114 is enabled by specifying its name. Options with values are set by separating
 115 the option name and value with an equal sign (\fB=\fR)
 116 .RE
 117
 118 .SH OPERANDS
 119 .sp
 120 .LP
 121 The following operands are supported:
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fIcount\fR\fR
 126 .ad
 127 .sp .6
 128 .RS 4n
 129 Indicates the number of intervals to execute before exiting.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fIinterval\fR\fR
 136 .ad
 137 .sp .6
 138 .RS 4n
 139 Indicates the number of seconds to be executed before exiting.
 140 .RE
 141
 142 .SH EXAMPLES
 143 .LP
 144 \fBExample 1 \fRUsing \fBintrstat\fR Without Options
 145 .sp
 146 .LP
 147 Without options, \fBintrstat\fR displays a table of trap types and CPUs. At
 148 most, four columns can fit in the default terminal width. If there are more
 149 than four CPUs, multiple tables are displayed.
 150
 151 .sp
 152 .LP
 153 The following example runs \fBintrstat\fR on a uniprocessor Intel IA/32-based
 154 laptop:
 155
 156 .sp
 157 .in +2
 158 .nf
 159 example# intrstat
 160                device |      cpu0 %tim
 161      -----------------+---------------
 162                 ata#0 |       166  0.4
 163                 ata#1 |         0  0.0
 164           audioi810#0 |         6  0.0
 165               i8042#0 |       281  0.7
 166                iprb#0 |         6  0.0
 167                uhci#1 |         6  0.0
 168                uhci#2 |         6  0.0
 169
 170                device |      cpu0 %tim
 171      -----------------+---------------
 172                 ata#0 |       161  0.5
 173                 ata#1 |         0  0.0
 174           audioi810#0 |         6  0.0
 175               i8042#0 |       303  0.6
 176                iprb#0 |         6  0.0
 177                uhci#1 |         6  0.0
 178                uhci#2 |         6  0.0
 179      ...
 180 .fi
 181 .in -2
 182 .sp
 183
 184 .SH ATTRIBUTES
 185 .sp
 186 .LP
 187 See \fBattributes\fR(5) for descriptions of the following attributes:
 188 .sp
 189
 190 .sp
 191 .TS
 192 box;
 193 c | c
 194 l | l .
 195 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 196 _
 197 Interface Stability     See below.
 198 .TE
 199
 200 .sp
 201 .LP
 202 The command-line syntax is Evolving. The human-readable output is Unstable.
 203 .SH SEE ALSO
 204 .sp
 205 .LP
 206 \fBdtrace\fR(8), \fBtrapstat\fR(8), \fBattributes\fR(5), \fBIntro\fR(7),
 207 \fBddi_driver_name\fR(9F)
 208 .sp
 209 .LP
 210 \fISolaris Dynamic Tracing Guide\fR