man/man2/processor_bind.2

         te
 Copyright (c) 2009, 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_BIND 2 "Dec 27, 2015"
 NAME
processor_bind - bind LWPs to a processor
 SYNOPSIS

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

int processor_bind(idtype_t idtype, id_t id, processorid_t processorid,
 processorid_t *obind);


 DESCRIPTION

The processor_bind() function binds the LWP (lightweight process) or set
of LWPs specified by idtype and id to the processor specified by
processorid. If obind is not NULL, this function also sets
the processorid_t variable pointed to by obind to the previous
binding of one of the specified LWPs, or to PBIND_NONE if the selected
LWP was not bound.

If idtype is P_PID, the binding affects all LWPs of the process
with process ID (PID) id.

If idtype is P_LWPID, the binding affects the LWP of the current
process with LWP ID id.

If idtype is P_TASKID, the binding affects all LWPs of all
processes with task ID id.

If idtype is P_PROJID, the binding affects all LWPs of all
processes with project ID id.

If idtype is P_CTID, the binding affects all LWPs of all processes
with process contract ID id.

If idtype is P_ZONEID, the binding affects all LWPs of all
processes with zone ID id.

If id is P_MYID, the specified LWP, process, task, or project is
the current one.

If processorid is PBIND_NONE, the processor bindings of the
specified LWPs are cleared.

If processorid is PBIND_QUERY, the processor bindings are not
changed.

The {PRIV_PROC_OWNER} privilege must be asserted in the effective set of
the calling process or the real or effective user ID of the calling process
must match the real or effective user ID of the LWPs being bound. If the
calling process does not have permission to change all of the specified LWPs,
the bindings of the LWPs for which it does have permission will be changed even
though an error is returned.

Processor bindings are inherited across fork(2) and exec(2).
 RETURN VALUES

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

The processor_bind() function will fail if:
EFAULT

The location pointed to by obind was not NULL and not writable by
the user.


EINVAL

The processor is not on-line.
The LWP is bound to a processor set or resource pool for which the
processor is not a member.
The idtype argument is not P_PID, P_LWPID,
P_PROJID, P_TASKID, P_CTID, or P_ZONEID.


ENOTSUP

Binding a system process to a processor set is not supported.


EPERM

The {PRIV_PROC_OWNER} privilege is not asserted in the effective set of
the calling process and its real or effective user ID does not match the real
or effective user ID of one of the LWPs being bound.


ESRCH

No processes, LWPs, or tasks were found to match the criteria specified
by idtype and id.


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


ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Async-Signal-Safe


 SEE ALSO
pooladm(1M), psradm(1M), psrinfo(1M), zoneadm(1M),
exec(2), fork(2), p_online(2), pset_bind(2),
sysconf(3C), process(4), project(4), attributes(5),
privileges(5)