te
Copyright (c) 2003, 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_resource_create, pool_resource_destroy, pool_resource_info, pool_query_resource_components, pool_resource_transfer, pool_resource_xtransfer - resource pool resource manipulation functions

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

pool_resource_t *pool_resource_create(pool_conf_t *conf,
 const char *type, const char *name);

int pool_resource_destroy(pool_conf_t *conf,
 pool_resource_t *resource);

const char *pool_resource_info(pool_conf_t *conf
 pool_resource_t *resource, int flags);

pool_component_t **pool_query_resource_components(
 pool_conf_t *conf, pool_resource_t *resource,
 uint_t *nelem, pool_value_t **props);

int pool_resource_transfer(pool_conf_t *conf,
 pool_resource_t *source, pool_resource_t *target,
 uint64_t size);

int pool_resource_xtransfer(pool_conf_t *conf,
 pool_resource_t *source, pool_resource_t *target,
 pool_component_t **components);

The pool_resource_create() function creates and returns a new resource of the given name and type in the provided configuration. If there is already a resource of the given name, the operation will fail.

The pool_resource_destroy() function removes the specified resource from its configuration file.

The pool_resource_info() function returns a string describing the given resource. The string is allocated with malloc(3C). The caller is reponsible for freeing the returned string. If the flags argument is non-zero, the string returned also describes the components (if any) contained in the resource.

The pool_query_resource_components() function returns a null-terminated array of the components (if any) that comprise the given resource.

The pool_resource_transfer() function transfers size basic units from the source resource to the target. Both resources must be of the same type for the operation to succeed. Transferring component resources, such as processors, is always performed as series of pool_resource_xtransfer() operations, since discrete resources must be identified for transfer.

The pool_resource_xtransfer() function transfers the specific components from the source resource to the target. Both resources must be of the same type, and of a type that contains components (such as processor sets). The components argument is a null-terminated list of pool_component_t.

The conf argument for each function refers to the target configuration to which the operation applies.

Upon successful completion, pool_resource_create() returns a new pool_resource_t with default properties initialized. Otherwise, NULL is returned and pool_error(3POOL) returns the pool-specific error value.

Upon successful completion, pool_resource_destroy() returns 0. Otherwise, -1 is returned and pool_error() returns the pool-specific error value.

Upon successful completion, pool_resource_info() returns a string describing the given resource (and optionally its components). Otherwise, NULL is returned and pool_error() returns the pool-specific error value.

Upon successful completion, pool_query_resource_components() returns a null-terminated array of pool_component_t * that match the provided null-terminated property list and are contained in the given resource. Otherwise, NULL is returned and pool_error() returns the pool-specific error value.

Upon successful completion, pool_resource_transfer() and pool_resource_xtransfer() return 0. Otherwise -1 is returned and pool_error() returns the pool-specific error value.

The pool_resource_create() function will fail if: POE_BADPARAM

POE_INVALID_CONF POE_PUTPROP POE_SYSTEM

The pool_resource_destroy() function will fail if: POE_BADPARAM

The pool_resource_info() function will fail if: POE_BADPARAM

POE_INVALID_CONF POE_SYSTEM

The pool_query_resource_components() function will fail if: POE_BADPARAM

POE_INVALID_CONF POE_SYSTEM

The pool_resource_transfer() function will fail if: POE_BADPARAM

POE_SYSTEM

The pool_resource_xtransfer() function will fail if: POE_BADPARAM

POE_INVALID_CONF POE_SYSTEM

Example 1 Create a new resource of type pset named foo.

#include <pool.h>
#include <stdio.h>

...

pool_conf_t *conf;
pool_resource_t *resource;
...

if ((resource = pool_resource_create(conf, "pset",
 "foo")) == NULL) {
 (void) fprintf(stderr, "Cannot create resource\\B{}n");
 ...
}

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)