1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PSET_BIND 2 "Mar 13, 2009"
   7 .SH NAME
   8 pset_bind \- bind LWPs to a set of processors
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pset.h>
  13 
  14 \fBint\fR \fBpset_bind\fR(\fBpsetid_t\fR \fIpset\fR, \fBidtype_t\fR \fIidtype\fR, \fBid_t\fR \fIid\fR, \fBpsetid_t *\fR\fIopset\fR);
  15 .fi
  16 
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBpset_bind()\fR function binds the \fBLWP\fR or set of \fBLWPs\fR
  21 specified by \fIidtype\fR and \fIid\fR to the processor set specified by
  22 \fIpset\fR. If \fIopset\fR is not \fINULL\fR, \fBpset_bind()\fR sets the
  23 \fBpsetid_t\fR variable pointed to by \fIopset\fR to the previous processor set
  24 binding of one of the specified \fBLWP\fR, or to \fBPS_NONE\fR if the selected
  25 \fBLWP\fR was not bound.
  26 .sp
  27 .LP
  28 If \fIidtype\fR is \fBP_PID\fR, the binding affects all \fBLWP\fRs of the
  29 process with process \fBID\fR (PID) \fIid\fR.
  30 .sp
  31 .LP
  32 If \fIidtype\fR is \fBP_LWPID\fR, the binding affects the \fBLWP\fR of the
  33 current process with \fBLWP ID\fR \fIid\fR.
  34 .sp
  35 .LP
  36 If \fIidtype\fR is \fBP_TASKID\fR, the binding affects all LWPs of all
  37 processes with task ID \fIid\fR.
  38 .sp
  39 .LP
  40 If \fIidtype\fR is \fBP_PROJID\fR, the binding affects all LWPs of all
  41 processes with project ID \fIid\fR.
  42 .sp
  43 .LP
  44 If \fIidtype\fR is \fBP_ZONEID\fR, the binding affects all LWPs of all
  45 processes with zone ID \fIid\fR.
  46 .sp
  47 .LP
  48 If \fIidtype\fR is \fBP_CTID\fR, the binding affects all LWPs of all processes
  49 with process contract ID \fIid\fR.
  50 .sp
  51 .LP
  52 If \fIid\fR is \fBP_MYID\fR, the specified LWP, process, task, process, zone,
  53 or process contract is the current one.
  54 .sp
  55 .LP
  56 If \fIpset\fR is \fBPS_NONE\fR, the processor set bindings of the specified
  57 LWPs are cleared.
  58 .sp
  59 .LP
  60 If \fIpset\fR is \fBPS_QUERY\fR, the processor set bindings are not changed.
  61 .sp
  62 .LP
  63 If \fIpset\fR is \fBPS_MYID\fR, the specified LWPs are bound to the same
  64 processor set as the caller. If the caller is not bound to a processor set, the
  65 processor set bindings are cleared.
  66 .sp
  67 .LP
  68 The {\fBPRIV_SYS_RES_CONFIG\fR} privilege must be asserted in the effective set
  69 of the calling process or \fIpset\fR must be \fBPS_QUERY\fR.
  70 .sp
  71 .LP
  72 LWPs that have been bound to a processor with \fBprocessor_bind\fR(2) may also
  73 be bound to a processor set if the processor is part of the processor set. If
  74 this occurs, the binding to the processor remains in effect. If the processor
  75 binding is later removed, the processor set binding becomes effective.
  76 .sp
  77 .LP
  78 Processor set bindings are inherited across \fBfork\fR(2) and \fBexec\fR(2).
  79 .SH RETURN VALUES
  80 .sp
  81 .LP
  82 Upon successful completion, 0 is returned. Otherwise, \(mi1 is returned and
  83 \fBerrno\fR is set to indicate the error.
  84 .SH ERRORS
  85 .sp
  86 .LP
  87 The \fBpset_bind()\fR function will fail if:
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBEBUSY\fR\fR
  92 .ad
  93 .RS 11n
  94 One of the \fBLWP\fRs is bound to a processor, and the specified processor set
  95 does not include that processor.
  96 .RE
  97 
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBEFAULT\fR\fR
 102 .ad
 103 .RS 11n
 104 The location pointed to by \fIopset\fR was not \fINULL\fR and not writable by
 105 the user.
 106 .RE
 107 
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBEINVAL\fR\fR
 112 .ad
 113 .RS 11n
 114 An invalid processor set \fBID\fR was specified;  or \fIidtype\fR was not
 115 \fBP_PID\fR, \fBP_LWPID\fR, \fBP_PROJID\fR, \fBP_TASKID\fR, \fBP_ZONEID\fR, or
 116 \fBP_CTID\fR.
 117 .RE
 118 
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBENOTSUP\fR\fR
 123 .ad
 124 .RS 11n
 125 The pools facility is active.  See \fBpooladm\fR(1M) and
 126 \fBpool_set_status\fR(3POOL) for information about enabling and disabling the
 127 pools facility. Processes can be bound to pools using the \fBpoolbind\fR(1M)
 128 utility or the \fBpool_set_binding\fR(3POOL) function.
 129 .sp
 130 Binding a system process to a processor set is not supported.
 131 .RE
 132 
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBEPERM\fR\fR
 137 .ad
 138 .RS 11n
 139 The {\fBPRIV_PROC_OWNER\fR} is not asserted in the effecive set of the calling
 140 process and either the real or effective user ID of the calling process does
 141 not match the real or effective user \fBID\fR of one of the LWPs being bound,
 142 or the processor set from which one or more of the LWPs are being unbound has
 143 the \fBPSET_NOESCAPE\fR attribute set and {\fBPRIV_SYS_RES_CONFIG\fR) is not
 144 asserted in the effective set of the calling process. See \fBpset_setattr\fR(2)
 145 for more information about processor set attributes.
 146 .RE
 147 
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBESRCH\fR\fR
 152 .ad
 153 .RS 11n
 154 No processes, \fBLWP\fRs, or tasks were found to match the criteria specified
 155 by \fIidtype\fR and \fIid\fR.
 156 .RE
 157 
 158 .SH ATTRIBUTES
 159 .sp
 160 .LP
 161 See \fBattributes\fR(5) for descriptions of the following attributes:
 162 .sp
 163 
 164 .sp
 165 .TS
 166 box;
 167 c | c
 168 l | l .
 169 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 170 _
 171 Interface Stability     Committed
 172 _
 173 MT-Level        Async-Signal-Safe
 174 .TE
 175 
 176 .SH SEE ALSO
 177 .sp
 178 .LP
 179 \fBpbind\fR(1M), \fBpooladm\fR(1M), \fBpoolbind\fR(1M), \fBpsrset\fR(1M),
 180 \fBexec\fR(2), \fBfork\fR(2), \fBprocessor_bind\fR(2), \fBpset_create\fR(2),
 181 \fBpset_info\fR(2), \fBpset_setattr\fR(2), \fBpool_set_binding\fR(3POOL),
 182 \fBpool_set_status\fR(3POOL), \fBpset_getloadavg\fR(3C), \fBprocess\fR(4),
 183 \fBproject\fR(4), \fBattributes\fR(5), \fBprivileges\fR(5)