te
Copyright (c) 2007, 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]
pool_get_binding, pool_set_binding, pool_get_resource_binding - set and query process to resource pool bindings

cc [ flag.\|.\|. ] file.\|.\|. -lpool [ library.\|.\|. ]
#include <pool.h>

char *pool_get_binding(pid_t pid);

int pool_set_binding(const char *pool, idtype_t idtype,
 id_t id);

char *pool_get_resource_binding(const char *type, pid_t pid);

The pool_get_binding() function returns the name of the pool on the running system that contains the set of resources to which the given process is bound. If no such pool exists on the system or the search returns more than one pool (since the set of resources is referred to by more than one pool), NULL is returned and the pool error value is set to POE_INVALID_SEARCH.

It is possible that one of the resources to which the given process is bound is not associated with a pool. This could occur if a processor set was created with one of the pset_() functions and the process was then bound to that set. It could also occur if the process was bound to a resource set not currently associated with a pool, since resources can exist that are not associated with a pool.

The pool_set_binding() function binds the processes matching idtype and id to the resources associated with pool on the running system. This function requires the privilege required by the underlying resource types referenced by the pool; generally, this requirement is equivalent to requiring superuser privilege.

The idtype parameter can be of the following types: P_PID

P_TASKID P_PROJID

The pool_get_resource_binding() function returns the name of the resource of the supplied type to which the supplied process is bound.

The application must explicity free the memory allocated for the return values for pool_get_binding() and pool_get_resource_binding().

Upon successful completion, pool_get_binding() returns the name of the pool to which the process is bound. Otherwise it returns NULL and pool_error(3POOL) returns the pool-specific error value.

Upon successful completion, pool_set_binding() returns PO_SUCCESS. Otherwise, it returns PO_FAIL and pool_error() returns the pool-specific error value.

Upon successful completion, pool_get_resource_binding() returns the name of the resource of the specified type to which the process is bound. Otherwise it returns NULL and pool_error() returns the pool-specific error value.

The pool_get_binding() function will fail if: POE_INVALID_CONF

POE_INVALID_SEARCH POE_SYSTEM

The pool_set_binding() function will fail if: POE_INVALID_SEARCH

POE_INVALID_CONF POE_SYSTEM

The pool_get_resource_binding() function will fail if: POE_INVALID_CONF

POE_INVALID_SEARCH POE_SYSTEM

Example 1 Bind the current process to the pool named "target".

#include <sys/types.h>
#include <pool.h>
#include <unistd.h>

...

id_t pid = getpid();

...

if (pool_set_binding("target", P_PID, pid) == PO_FAIL) \{
 (void) fprintf(stderr, "pool binding failed (\\%d)\\B{}n",
 pool_error());
\}

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

CSI Enabled

Interface Stability Unstable

MT-Level Safe

libpool(3LIB), pool_error(3POOL), attributes(5)