usr/src/man/man2/pset_info.2

   1 '\" te
   2 .\" Copyright (c) 20034, 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 PSET_INFO 2 "Jun 28, 2004"
   7 .SH NAME
   8 pset_info \- get information about a processor set
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pset.h>
  13
  14 \fBint\fR \fBpset_info\fR(\fBpsetid_t\fR \fIpset\fR, \fBint *\fR\fItype\fR, \fBuint_t *\fR\fInumcpus\fR,
  15      \fBprocessorid_t *\fR\fIcpulist\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBpset_info()\fR function returns information on the processor set
  22 \fIpset\fR.
  23 .sp
  24 .LP
  25 If \fItype\fR is non-null, then on successful completion the type of the
  26 processor set will be stored in the location pointed to by \fItype\fR. The only
  27 type supported for active processor sets is \fBPS_PRIVATE\fR.
  28 .sp
  29 .LP
  30 If \fInumcpus\fR is non-null, then on successful completion the number of
  31 processors in the processor set will be stored in the location pointed to by
  32 \fInumcpus\fR.
  33 .sp
  34 .LP
  35 If \fInumcpus\fR and \fIcpulist\fR are both non-null, then \fIcpulist\fR points
  36 to a buffer where a list of processors assigned to the processor set is to be
  37 stored, and \fInumcpus\fR points to the maximum number of processor IDs the
  38 buffer can hold. On successful completion, the list of processors up to the
  39 maximum buffer size is stored in the buffer pointed to by \fIcpulist\fR.
  40 .sp
  41 .LP
  42 If \fIpset\fR is \fBPS_NONE\fR, the list of processors not assigned to any
  43 processor set will be stored in the buffer pointed to by \fIcpulist\fR, and the
  44 number of such processors will be stored in the location pointed to by
  45 \fInumcpus\fR. The location pointed to by \fItype\fR will be set to
  46 \fBPS_NONE\fR.
  47 .sp
  48 .LP
  49 If \fIpset\fR is \fBPS_MYID\fR, the processor list and number of processors
  50 returned will be those of the processor set to which the caller is bound. If
  51 the caller is not bound to a processor set, the result will be equivalent to
  52 setting pset to \fBPS_NONE\fR.
  53 .SH RETURN VALUES
  54 .sp
  55 .LP
  56 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  57 returned and \fBerrno\fR is set to indicate the error.
  58 .SH ERRORS
  59 .sp
  60 .LP
  61 The \fBpset_info()\fR function will fail if:
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBEFAULT\fR\fR
  66 .ad
  67 .RS 10n
  68 The location pointed to by \fItype\fR, \fInumcpus\fR, or \fIcpulist\fR was not
  69 null and not writable by the user.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEINVAL\fR\fR
  76 .ad
  77 .RS 10n
  78 An invalid processor set \fBID\fR was specified.
  79 .sp
  80 The caller is in a non-global zone, the pools facility is active, and the
  81 processor is not a member of the zone's pool's processor set.
  82 .RE
  83
  84 .SH ATTRIBUTES
  85 .sp
  86 .LP
  87 See \fBattributes\fR(5) for descriptions of the following attributes:
  88 .sp
  89
  90 .sp
  91 .TS
  92 box;
  93 c | c
  94 l | l .
  95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  96 _
  97 Interface Stability     Stable
  98 _
  99 MT-Level        Async-Signal-Safe
 100 .TE
 101
 102 .SH SEE ALSO
 103 .sp
 104 .LP
 105 \fBpooladm\fR(1M), \fBpsrinfo\fR(1M), \fBpsrset\fR(1M), \fBzoneadm\fR(1M),
 106 \fBprocessor_info\fR(2), \fBpset_assign\fR(2), \fBpset_bind\fR(2),
 107 \fBpset_create\fR(2), \fBpset_destroy\fR(2), \fBpset_getloadavg\fR(3C),
 108 \fBattributes\fR(5)
 109 .SH NOTES
 110 .sp
 111 .LP
 112 The processor set of type \fBPS_SYSTEM\fR is no longer supported.