share/man/man8/psrinfo.8

   1 '\" te
   2 .\"  Copyright (c) 2004 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PSRINFO 8 "Feb 21, 2004"
   7 .SH NAME
   8 psrinfo \- displays information about processors
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBpsrinfo\fR [\fB-p\fR] [\fB-v\fR] [\fIprocessor_id\fR]...
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBpsrinfo\fR [\fB-p\fR] \fB-s\fR \fIprocessor_id\fR
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 \fBpsrinfo\fR displays information about processors. Each physical processor
  24 may support multiple virtual processors. Each virtual processor is an entity
  25 with its own interrupt \fBID\fR, capable of executing independent threads.
  26 .sp
  27 .LP
  28 Without the \fIprocessor_id\fR operand, \fBpsrinfo\fR displays one line for
  29 each configured processor, displaying whether it is on-line, non-interruptible
  30 (designated by no-intr), spare, off-line, faulted or powered off, and when that
  31 status last changed. Use the processor_id operand to display information about
  32 a specific processor. See \fBOPERANDS\fR.
  33 .SH OPTIONS
  34 .sp
  35 .LP
  36 The following options are supported:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fB-s\fR\fI processor_id\fR\fR
  41 .ad
  42 .RS 19n
  43 Silent mode. Displays \fB1\fR if the specified processor is fully on-line.
  44 Displays \fB0\fR if the specified processor is non-interruptible, spare,
  45 off-line, faulted or powered off.
  46 .sp
  47 Use silent mode when using \fBpsrinfo\fR in shell scripts.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fB-p\fR\fR
  54 .ad
  55 .RS 19n
  56 Display the number of physical processors in a system.
  57 .sp
  58 When combined with the \fB-v\fR option, reports additional information about
  59 each physical processor.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-v\fR\fR
  66 .ad
  67 .RS 19n
  68 Verbose mode. Displays additional information about the specified processors,
  69 including: processor type, floating point unit type and clock speed. If any of
  70 this information cannot be determined, \fBpsrinfo\fR displays \fBunknown\fR.
  71 .sp
  72 When combined with the \fB-p\fR option, reports additional information about
  73 each physical processor.
  74 .RE
  75
  76 .SH OPERANDS
  77 .sp
  78 .LP
  79 The following operands are supported:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fIprocessor_id\fR\fR
  84 .ad
  85 .RS 16n
  86 The processor \fBID\fR of the processor about which information is to be
  87 displayed.
  88 .sp
  89 Specify \fIprocessor_id\fR as an individual processor number (for example,
  90 \fB3\fR), multiple processor numbers separated by spaces (for example, \fB1 2
  91 3\fR), or a range of processor numbers (for example, \fB1-4\fR). It is also
  92 possible to combine ranges and (individual or multiple) \fIprocessor_id\fRs
  93 (for example, \fB1-3 5 7-8 9\fR).
  94 .RE
  95
  96 .SH EXAMPLES
  97 .LP
  98 \fBExample 1 \fRDisplaying Information About All Configured Processors in
  99 Verbose Mode
 100 .sp
 101 .LP
 102 The following example displays information about all configured processors in
 103 verbose mode.
 104
 105 .sp
 106 .in +2
 107 .nf
 108 \fBpsrinfo \fR\fB-v\fR
 109 .fi
 110 .in -2
 111 .sp
 112
 113 .LP
 114 \fBExample 2 \fRDetermining If a Processor is On-line
 115 .sp
 116 .LP
 117 The following example uses \fBpsrinfo\fR in a shell script to determine if a
 118 processor is on-line.
 119
 120 .sp
 121 .in +2
 122 .nf
 123 if [ "`psrinfo \fB-s\fR 3 2> /dev/null`" \(mieq 1 ]
 124 then
 125         echo "processor 3 is up"
 126 fi
 127 .fi
 128 .in -2
 129 .sp
 130
 131 .LP
 132 \fBExample 3 \fRDisplaying Information About the Physical Processors in the
 133 System
 134 .sp
 135 .LP
 136 With no additional arguments, the \fB-p\fR option displays a single integer:
 137 the number of physical processors in the system:
 138
 139 .sp
 140 .in +2
 141 .nf
 142 > psrinfo -p
 143                 8
 144 .fi
 145 .in -2
 146 .sp
 147
 148 .sp
 149 .LP
 150 \fBpsrinfo\fR also accepts command line arguments (processor \fBID\fRs):
 151
 152 .sp
 153 .in +2
 154 .nf
 155 > psrinfo -p 0 512   # IDs 0 and 512 exist on the
 156 1                    # same physical processor
 157
 158 > psrinfo -p 0 1     # IDs 0 and 1 exist on different
 159 2                    # physical processors
 160 .fi
 161 .in -2
 162 .sp
 163
 164 .sp
 165 .LP
 166 In this example, virtual processors \fB0\fR and \fB512\fR exist on the same
 167 physical processor. Virtual processors \fB0\fR and \fB1\fR do not. This is
 168 specific to this example and is and not a general rule.
 169
 170 .SH EXIT STATUS
 171 .sp
 172 .LP
 173 The following exit values are returned:
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB0\fR\fR
 178 .ad
 179 .RS 6n
 180 Successful completion.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fB>0\fR\fR
 187 .ad
 188 .RS 6n
 189 An error occurred.
 190 .RE
 191
 192 .SH SEE ALSO
 193 .sp
 194 .LP
 195 \fBpsradm\fR(8), \fBp_online\fR(2), \fBprocessor_info\fR(2),
 196 \fBattributes\fR(5)
 197 .SH DIAGNOSTICS
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fBpsrinfo:\fR \fBprocessor\fR \fB9:\fR \fBInvalid\fR \fBargument\fR\fR
 202 .ad
 203 .sp .6
 204 .RS 4n
 205 The specified processor does not exist.
 206 .RE
 207