usr/src/man/man1m/psradm.1m

   1 '\" te
   2 .\"  Copyright (c) 2008 Sun Microsystems, Inc.
   3 .\" All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH PSRADM 1M "Feb 25, 2008"
   8 .SH NAME
   9 psradm \- change processor operational status
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBpsradm\fR \fB-f\fR | \fB-i\fR | \fB-n\fR | \fB-s\fR [\fB-v\fR] [\fB-F\fR] \fIprocessor_id\fR
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fBpsradm\fR \fB-a\fR \fB-f\fR | \fB-i\fR | \fB-n\fR | \fB-s\fR [\fB-v\fR] [\fB-F\fR]
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBpsradm\fR utility changes the operational status of processors. The
  25 legal states for the processor are \fBon-line\fR, \fBoff-line\fR, \fBspare\fR,
  26 \fBfaulted\fR, and \fBno-intr\fR.
  27 .sp
  28 .LP
  29 An \fBon-line\fR processor processes \fBLWPs\fR (lightweight processes) and can
  30 be interrupted by I/O devices in the system.
  31 .sp
  32 .LP
  33 An \fBoff-line\fR processor does not process any \fBLWPs.\fR Usually, an
  34 \fBoff-line\fR processor is not interruptible by I/O devices in the system. On
  35 some processors or under certain conditions, it might not be possible to
  36 disable interrupts for an \fBoff-line\fR processor. Thus, the actual effect of
  37 being \fBoff-line\fR might vary from machine to machine.
  38 .sp
  39 .LP
  40 A spare processor does not process any LWPs. A spare processor can be brought
  41 \fBon-line\fR, \fBoff-line\fR or to \fBno-intr\fR by a privileged user of the
  42 system or by the kernel in response to changes in the system state.
  43 .sp
  44 .LP
  45 A faulted processor is identified by the kernel, which monitors the behavior of
  46 processors over time. A privileged user can set the state of a faulted
  47 processor to be \fBon-line\fR, \fBoff-line\fR, \fBspare\fR or \fBno-intr\fR,
  48 but must use the force option to do so.
  49 .sp
  50 .LP
  51 A \fBno-intr\fR processor processes \fBLWPs\fR but is not interruptible by I/O
  52 devices.
  53 .sp
  54 .LP
  55 A processor can not be taken \fBoff-line\fR or made \fBspare\fR if there are
  56 LWPs that are bound to the processor unless the additional \fB-F\fR option is
  57 used. The \fB-F\fR option removes processor bindings of such LWPs before
  58 changing the processor's operational status. On some architectures, it might
  59 not be possible to take certain processors \fBoff-line\fR or \fBspare\fR if,
  60 for example, the system depends on some resource provided by the processor.
  61 .sp
  62 .LP
  63 At least one processor in the system must be able to process \fBLWPs.\fR At
  64 least one processor must also be able to be interrupted. Since an
  65 \fBoff-line\fR or \fBspare\fR processor can be interruptible, it is possible to
  66 have an operational system with one processor \fBno-intr\fR and all other
  67 processors \fBoff-line\fR or \fBspare\fR but with one or more accepting
  68 interrupts.
  69 .sp
  70 .LP
  71 If any of the specified processors are powered off, \fBpsradm\fR might power on
  72 one or more processors.
  73 .sp
  74 .LP
  75 Only users with the \fBPRIV_SYS_RES_CONFIG\fR privilege can use the
  76 \fBpsradm\fR utility.
  77 .SH OPTIONS
  78 .sp
  79 .LP
  80 The following options are supported:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-a\fR\fR
  85 .ad
  86 .RS 6n
  87 Perform the action on all processors, or as many as possible.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB-f\fR\fR
  94 .ad
  95 .RS 6n
  96 Take the specified processors \fBoff-line\fR.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB-F\fR\fR
 103 .ad
 104 .RS 6n
 105 Force the transition to the additional specified state. Required if one or more
 106 of the specified processors was in the faulted state. Set the specified
 107 processors to faulted, if no other transition option was specified. Forced
 108 transitions can only be made to \fBfaulted\fR, \fBspare\fR, or \fBoff-line\fR
 109 states. Administrators are encouraged to use the \fB-Q\fR option for
 110 \fBpbind\fR(1M) to find out which threads will be affected by forced a
 111 processor state transition.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB-i\fR\fR
 118 .ad
 119 .RS 6n
 120 Set the specified processors \fBno-intr\fR.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fB-n\fR\fR
 127 .ad
 128 .RS 6n
 129 Bring the specified processors \fBon-line\fR.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fB-s\fR\fR
 136 .ad
 137 .RS 6n
 138 Make the specified processors spare.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB-v\fR\fR
 145 .ad
 146 .RS 6n
 147 Output a message giving the results of each attempted operation.
 148 .RE
 149
 150 .SH OPERANDS
 151 .sp
 152 .LP
 153 The following operands are supported:
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fIprocessor_id\fR\fR
 158 .ad
 159 .RS 16n
 160 The processor \fBID\fR of the processor to be set \fBon-line\fR or
 161 \fBoff-line\fR, \fBspare\fR, or \fBno-intr\fR.
 162 .sp
 163 Specify \fIprocessor_id\fR as an individual processor number (for example,
 164 \fB3\fR), multiple processor numbers separated by spaces (for example, \fB1 2
 165 3\fR), or a range of processor numbers (for example, \fB1-4\fR). It is also
 166 possible to combine ranges and (individual or multiple) \fIprocessor_id\fRs
 167 (for example, \fB1-3 5 7-8 9\fR).
 168 .RE
 169
 170 .SH EXAMPLES
 171 .LP
 172 \fBExample 1 \fRSetting Processors to \fBoff-line\fR
 173 .sp
 174 .LP
 175 The following example sets processors 2 and 3 \fBoff-line\fR:
 176
 177 .sp
 178 .in +2
 179 .nf
 180 % psradm \fB-f\fR 2 3
 181 .fi
 182 .in -2
 183 .sp
 184
 185 .LP
 186 \fBExample 2 \fRSetting Processors to no-intr
 187 .sp
 188 .LP
 189 The following example sets processors 1 and 2 \fBno-intr\fR:
 190
 191 .sp
 192 .in +2
 193 .nf
 194 % psradm \fB-i\fR 1 2
 195 .fi
 196 .in -2
 197 .sp
 198
 199 .LP
 200 \fBExample 3 \fRSetting Processors to \fBspare\fR
 201 .sp
 202 .LP
 203 The following example sets processors 1 and 2 spare, even if either of the
 204 processors was in the faulted state:
 205
 206 .sp
 207 .in +2
 208 .nf
 209 % psradm -F -s 1 2
 210 .fi
 211 .in -2
 212 .sp
 213
 214 .LP
 215 \fBExample 4 \fRSetting All Processors \fBon-line\fR
 216 .sp
 217 .in +2
 218 .nf
 219 % psradm \fB-a\fR \fB-n\fR
 220 .fi
 221 .in -2
 222 .sp
 223
 224 .LP
 225 \fBExample 5 \fRForcing Processors to \fBoff-line\fR
 226 .sp
 227 .LP
 228 The following example sets processors 1 and 2 offline, and revokes the
 229 processor bindings from the processes bound to them:
 230
 231 .sp
 232 .in +2
 233 .nf
 234 % psradm \fB-F\fR \fB-f\fR 1 2
 235 .fi
 236 .in -2
 237 .sp
 238
 239 .SH EXIT STATUS
 240 .sp
 241 .LP
 242 The following exit values are returned:
 243 .sp
 244 .ne 2
 245 .na
 246 \fB\fB0\fR\fR
 247 .ad
 248 .RS 6n
 249 Successful completion.
 250 .RE
 251
 252 .sp
 253 .ne 2
 254 .na
 255 \fB\fB>0\fR\fR
 256 .ad
 257 .RS 6n
 258 An error occurred.
 259 .RE
 260
 261 .SH FILES
 262 .sp
 263 .ne 2
 264 .na
 265 \fB\fB/etc/wtmpx\fR\fR
 266 .ad
 267 .RS 14n
 268 Records logging processor status changes
 269 .RE
 270
 271 .SH SEE ALSO
 272 .sp
 273 .LP
 274 \fBpbind\fR(1M), \fBpsrinfo\fR(1M), \fBpsrset\fR(1M), \fBp_online\fR(2),
 275 \fBprocessor_bind\fR(2), \fBattributes\fR(5)
 276 .SH DIAGNOSTICS
 277 .sp
 278 .ne 2
 279 .na
 280 \fB\fBpsradm: processor 4: Invalid argument\fR\fR
 281 .ad
 282 .sp .6
 283 .RS 4n
 284 The specified processor does not exist in the configuration.
 285 .RE
 286
 287 .sp
 288 .ne 2
 289 .na
 290 \fB\fBpsradm: processor 3: Device busy\fR\fR
 291 .ad
 292 .sp .6
 293 .RS 4n
 294 The specified processor could not be taken \fBoff-line\fR because it either has
 295 LWPs bound to it, is the last \fBon-line\fR processor in the system, or is
 296 needed by the system because it provides some essential service.
 297 .RE
 298
 299 .sp
 300 .ne 2
 301 .na
 302 \fB\fBpsradm: processor 3: Device busy\fR\fR
 303 .ad
 304 .sp .6
 305 .RS 4n
 306 The specified processor could not be set \fBno-intr\fR because it is the last
 307 interruptible processor in the system, or or it is the only processor in the
 308 system that can service interrupts needed by the system.
 309 .RE
 310
 311 .sp
 312 .ne 2
 313 .na
 314 \fB\fBpsradm: processor 3: Device busy\fR\fR
 315 .ad
 316 .sp .6
 317 .RS 4n
 318 The specified processor is powered off, and it cannot be powered on because
 319 some platform-specific resource is unavailable.
 320 .RE
 321
 322 .sp
 323 .ne 2
 324 .na
 325 \fB\fBpsradm: processor 0: Not owner\fR\fR
 326 .ad
 327 .sp .6
 328 .RS 4n
 329 The user does not have permission to change processor status.
 330 .RE
 331
 332 .sp
 333 .ne 2
 334 .na
 335 \fB\fBpsradm: processor 2: Operation not supported\fR\fR
 336 .ad
 337 .sp .6
 338 .RS 4n
 339 The specified processor is powered off, and the platform does not support power
 340 on of individual processors.
 341 .RE
 342