xref: /illumos-gate/usr/src/man/man2/processor_info.2 (revision d4f95bf4d6ec7ef0f01e5ddf22813ac641edf019)
te
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
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]
PROCESSOR_INFO 2 "Jun 28, 2004"
NAME
processor_info - determine type and status of a processor
SYNOPSIS

#include <sys/types.h>
#include <sys/processor.h>

int processor_info(processorid_t processorid, processor_info_t *infop);
DESCRIPTION

The processor_info() function returns the status of the processor specified by processorid in the processor_info_t structure pointed to by infop.

The structure processor_info_t contains the following members:

int pi_state;
char pi_processor_type[PI_TYPELEN];
char pi_fputypes[PI_FPUTYPE];
int pi_clock;

The pi_state member is the current state of the processor, either P_ONLINE, P_OFFLINE, P_NOINTR, P_FAULTED, P_SPARE, or P_POWEROFF.

The pi_processor_type member is a null-terminated ASCII string specifying the type of the processor.

The pi_fputypes member is a null-terminated ASCII string containing the comma-separated types of floating-point units (FPUs) attached to the processor. This string will be empty if no FPU is attached.

The pi_clock member is the processor clock frequency rounded to the nearest megahertz. It may be 0 if not known.

RETURN VALUES

Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

The processor_info() function will fail if: EINVAL

An non-existent processor ID was specified. The caller is in a non-global zone, the pools facility is active, and the processor is not a member of the zone's pool's processor set.

EFAULT

The processor_info_t structure pointed to by infop was not writable by the user.

SEE ALSO

pooladm(1M), psradm(1M), psrinfo(1M), zoneadm(1M), p_online(2), sysconf(3C)