Copyright (c) 2008 Sun Microsystems, Inc.
All Rights Reserved
Copyright 2019 Joyent, Inc.
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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
psradm -f | -i | -n | -s [-v] [-F] processor_id
psradm -a -f | -i | -n | -s [-v] [-F]
psradm -aS [-v]
The psradm utility changes the operational status of processors. The legal states for the processor are on-line, off-line, spare, faulted, no-intr, and disabled.
An on-line processor processes LWPs (lightweight processes) and can be interrupted by I/O devices in the system.
An off-line processor does not process any LWPs. Usually, an off-line processor is not interruptible by I/O devices in the system. On some processors or under certain conditions, it might not be possible to disable interrupts for an off-line processor. Thus, the actual effect of being off-line might vary from machine to machine.
A spare processor does not process any LWPs. A spare processor can be brought on-line, off-line or to no-intr by a privileged user of the system or by the kernel in response to changes in the system state.
A faulted processor is identified by the kernel, which monitors the behavior of processors over time. A privileged user can set the state of a faulted processor to be on-line, off-line, spare or no-intr, but must use the force option to do so.
A no-intr processor processes LWPs but is not interruptible by I/O devices.
With the -aS option, simultaneous multi-threading is disabled. The -a option means "apply to every core" and is currently required. Each CPU core has its SMT siblings placed in the disabled state, and they will effectively stay unused. That is, only one CPU in each core will be processing I/O, scheduling processes, etc. A CPU can only be moved back out of the disabled state with the -F option.
A processor can not be taken off-line, disabled, or made spare if there are LWPs that are bound to the processor unless the additional -F option is used. The -F option removes processor bindings of such LWPs before changing the processor's operational status. On some architectures, it might not be possible to take certain processors off-line or spare if, for example, the system depends on some resource provided by the processor.
At least one processor in the system must be able to process LWPs. At least one processor must also be able to be interrupted. Since an off-line or spare processor can be interruptible, it is possible to have an operational system with one processor no-intr and all other processors off-line or spare but with one or more accepting interrupts.
If any of the specified processors are powered off, psradm might power on one or more processors.
Only users with the PRIV_SYS_RES_CONFIG privilege can use the psradm utility.
The following options are supported: -a
Perform the action on all processors, or as many as possible.
Take the specified processors off-line.
Force the transition to the additional specified state. Required if one or more of the specified processors was in the faulted state. Set the specified processors to faulted, if no other transition option was specified. Forced transitions can only be made to faulted, spare, or off-line states. Administrators are encouraged to use the -Q option for pbind(8) to find out which threads will be affected by forced a processor state transition.
Set the specified processors no-intr.
Bring the specified processors on-line.
Disable simultaneous multi-threading (hyper-threading).
Make the specified processors spare.
Output a message giving the results of each attempted operation.
The following operands are supported: processor_id
The processor ID of the processor to be set on-line or off-line, spare, or no-intr. Specify processor_id as an individual processor number (for example, 3), multiple processor numbers separated by spaces (for example, 1 2 3), or a range of processor numbers (for example, 1-4). It is also possible to combine ranges and (individual or multiple) processor_ids (for example, 1-3 5 7-8 9).
Example 1 Setting Processors to off-line
The following example sets processors 2 and 3 off-line:
% psradm -f 2 3
Example 2 Setting Processors to no-intr
The following example sets processors 1 and 2 no-intr:
% psradm -i 1 2
Example 3 Setting Processors to spare
The following example sets processors 1 and 2 spare, even if either of the processors was in the faulted state:
% psradm -F -s 1 2
Example 4 Setting All Processors on-line
% psradm -a -n
Example 5 Forcing Processors to off-line
The following example sets processors 1 and 2 offline, and revokes the processor bindings from the processes bound to them:
% psradm -F -f 1 2
The following exit values are returned: 0
Successful completion.
An error occurred.
Records logging processor status changes
p_online (2), processor_bind (2), attributes (7), pbind (8), psrinfo (8), psrset (8)
The specified processor does not exist in the configuration.
The specified processor could not be taken off-line because it either has LWPs bound to it, is the last on-line processor in the system, or is needed by the system because it provides some essential service.
The specified processor could not be set no-intr because it is the last interruptible processor in the system, or it is the only processor in the system that can service interrupts needed by the system.
The specified processor is powered off, and it cannot be powered on because some platform-specific resource is unavailable.
The user does not have permission to change processor status.
The specified processor is powered off, and the platform does not support power on of individual processors.