usr/src/man/man2/pset_setattr.2

   1 '\" te
   2 .\" Copyright (c) 2004, 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_SETATTR 2 "Jun 28, 2004"
   7 .SH NAME
   8 pset_setattr, pset_getattr \- set or get processor set attributes
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pset.h>
  13
  14 \fBint\fR \fBpset_setattr\fR(\fBpsetid_t\fR \fIpset\fR, \fBuint_t\fR \fIattr\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fBpset_getattr\fR(\fBpsetid_t\fR \fIpset\fR, \fBuint_t *\fR\fIattr\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBpset_setattr()\fR function sets attributes of the processor set
  26 specified by \fIpset\fR.  The bitmask of attributes to be set or cleared is
  27 specified by \fIattr\fR.
  28 .sp
  29 .LP
  30 The pset_getattr function returns attributes of the processor set specified by
  31 \fIpset\fR. On successful return, \fIattr\fR will contain the bitmask of
  32 attributes for the specified processor set.
  33 .sp
  34 .LP
  35 The value of the \fIattr\fR argument is the bitwise inclusive-OR of these
  36 attributes, defined in <\fBsys/pset.h\fR>:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBPSET_NOESCAPE\fR\fR
  41 .ad
  42 .RS 17n
  43 Unbinding of LWPs from the processor set with this attribute requires the
  44 {\fBPRIV_SYS_RES_CONFIG\fR} privilege to be asserted in the effective set of
  45 the calling process.
  46 .RE
  47
  48 .sp
  49 .LP
  50 The binding of LWPs and processes to processor sets is controlled by
  51 \fBpset_bind\fR(2). When the \fBPSET_NOESCAPE\fR attribute is cleared, a
  52 process calling \fBpset_bind()\fR can clear the processor set binding of any
  53 LWP whose real or effective user ID matches its own real of effective user ID.
  54 Setting \fBPSET_NOESCAPE\fR attribute forces \fBpset_bind()\fR to requires the
  55 {\fBPRIV_SYS_RES_CONFIG\fR} privilege to be asserted in the effective set of
  56 the calling process.
  57 .SH RETURN VALUES
  58 .sp
  59 .LP
  60 Upon successful completion, these functions return 0. Otherwise, -1 is returned
  61 and \fBerrno\fR is set to indicate the error.
  62 .SH ERRORS
  63 .sp
  64 .LP
  65 These function will fail if:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBEFAULT\fR\fR
  70 .ad
  71 .RS 11n
  72 The location pointed to by \fIattr\fR was not writable by the user.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBEINVAL\fR\fR
  79 .ad
  80 .RS 11n
  81 An invalid processor set ID was specified.
  82 .sp
  83 The caller is in a non-global zone, the pools facility is active, and the
  84 processor is not a member of the zone's pool's processor set.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBENOTSUP\fR\fR
  91 .ad
  92 .RS 11n
  93 The pools facility is active. See \fBpooladm\fR(1M) and
  94 \fBpool_set_status\fR(3POOL) for information about enabling and disabling the
  95 pools facility.
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Stable
 112 _
 113 MT-Level        Async-Signal-Safe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBpooladm\fR(1M), \fBpooladm\fR(1M), \fBpsrset\fR(1M), \fBzoneadm\fR(1M),
 120 \fBpset_bind\fR(2), \fBpool_set_status\fR(3POOL), \fBattributes\fR(5)