Go to main content

man pages section 3: Extended Library Functions, Volume 3

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pool_get_owning_resource(3POOL)

Name

pool_component_info, pool_get_owning_resource - resource pool component functions

Synopsis

cc [ flag… ] file–lpool [ library… ] 
#include <pool.h>

const char *pool_component_info(pool_conf_t *conf,
     pool_component_t *component, int flags);
pool_resource_t *pool_get_owning_resource(pool_conf_t *conf,
     pool_component_t *component);

Description

Psets are the only type of resource supported by resource pools. Psets are composed of cpus, which are the only type of component. Informational and ownership properties of cpus are made available with the pool_component_info() and pool_get_owning_resource() functions. The conf argument for each function refers to the target configuration to which the operation applies.

The pool_component_info() function returns a string describing the cpu. The string is allocated with malloc(3C). The caller is responsible for freeing the returned string. The flags argument is ignored.

The pool_get_owning_resource() function returns the pset currently containing the cpu. Every cpu is contained by a pset.

Return Values

Upon successful completion, pool_component_info() returns a string. Otherwise it returns NULL and pool_error(3POOL) returns the pool-specific error value.

Upon successful completion, pool_get_owning_resource() returns the owning pset. Otherwise it returns NULL and pool_error() returns the pool-specific error value.

Errors

The pool_component_info() function will fail if:

POE_BADPARAM

The supplied configuration's status is not POF_VALID or the flags parameter is neither 0 or 1.

POE_INVALID_CONF

The configuration is invalid.

POE_SYSTEM

A system error has occurred. Check the system error code for more details.

The pool_get_owning_resource() function will fail if:

POE_BADPARAM

The supplied configuration's status is not POF_VALID.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
CSI
Enabled
Interface Stability
Uncommitted
MT-Level
Safe

See Also

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