xref: /illumos-gate/usr/src/man/man2/pset_list.2 (revision 5422785d352a2bb398daceab3d1898a8aa64d006)
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]
PSET_LIST 2 "Jun 28, 2004"
NAME
pset_list - get list of processor sets
SYNOPSIS

#include <sys/pset.h>

int pset_list(psetid_t *psetlist, uint_t *numpsets);
DESCRIPTION

The pset_list() function returns a list of processor sets in the system.

If numpsets is non-null, then on successful completion the number of processor sets in the system will be stored in the location pointed to by numpsets.

If numpsets and psetlist are both non-null, then psetlist points to a buffer where a list of processor sets in the system is to be stored, and numpsets points to the maximum number of processor set IDs the buffer can hold. On successful completion, the list of processor sets up to the maximum buffer size is stored in the buffer pointed to by psetlist.

RETURN VALUES

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

ERRORS

The pset_list() function will fail if: EFAULT

The location pointed to by psetlist or numpsets was not null and not writable by the user.

USAGE

If the caller is in a non-global zone and the pools facility is active, pset_list() returns only the processor set of the pool to which the zone is bound.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Stable
MT-Level Async-Signal-Safe
SEE ALSO

pooladm(1M), psrset(1M), zoneadm(1M), processor_info(2), pset_bind(2), pset_create(2), pset_info(2), pset_getloadavg(3C), attributes(5)