Go to main content

Resource Management and Oracle® Solaris Zones Developer's Guide

Exit Print View

Updated: February 2021
 
 

Resource Pools API Functions

This section lists all of the resource pool functions. Each function has a link to the man page and a short description of the function's purpose. The functions are divided into two groups, depending on whether the function performs an action or a query:

The imported interfaces for libpool for swap sets is identical to the ones defined in this document.

Functions for Operating on Resource Pools and Associated Elements

The following interfaces perform actions related to pools and the associated elements. A man page is available for each interface name.

pool_associate

Associate a resource with a specified pool.

pool_component_to_elem

Convert specified component to the pool element type.

pool_conf_alloc

Create a pool configuration.

pool_conf_close

Close the specified pool configuration and release the associated resources.

pool_conf_commit

Commit changes made to the specified pool configuration to permanent storage.

pool_conf_export

Save the given configuration to the specified location.

pool_conf_free

Release a pool configuration.

pool_conf_open

Create a pool configuration at the specified location.

pool_conf_remove

Removes the permanent storage for the configuration.

pool_conf_rollback

Restore the configuration state to the state that is held in the pool configuration's permanent storage.

pool_conf_to_elem

Convert specified pool configuration to the pool element type.

pool_conf_update

Update the library snapshot of kernel state.

pool_create

Create a new pool with the default properties and with default resources for each type.

pool_destroy

Destroy the specified pool. The associated resources are not modified.

pool_dissociate

Remove the association between the given resource and pool.

pool_put_property

Set the named property on the element to the specified value.

pool_resource_create

Create a new resource with the specified name and type for the provided configuration.

pool_resource_destroy

Remove the specified resource from the configuration file.

pool_resource_to_elem

Convert specified pool resource to the pool element type.

pool_resource_transfer

Transfer basic units from the source resource to the target resource.

pool_resource_xtransfer

Transfer the specified components from the source resource to the target resource.

pool_rm_property

Remove the named property from the element.

pool_set_binding

Bind the specified processes to the resources that are associated with pool on the running system.

pool_set_status

Modify the current state of the pools facility.

pool_to_elem

Convert specified pool to the pool element type.

pool_value_alloc

Allocate and return an opaque container for a pool property value.

pool_value_free

Release an allocated property values.

pool_value_set_bool

Set a property value of type boolean.

pool_value_set_double

Set a property value of type double.

pool_value_set_int64

Set a property value of type int64.

pool_value_set_name

Set a name=value pair for a pool property.

pool_value_set_string

Copy the string that was passed in.

pool_value_set_uint64

Set a property value of type uint64.

Functions for Querying Resource Pools and Associated Elements

The following interfaces perform queries related to pools and the associated elements. A man page is available for each interface name.

pool_component_info

Return a string that describes the given component.

pool_conf_info

Return a string describing the entire configuration.

pool_conf_location

Return the location string that was provided to the pool_conf_open function for the specified configuration.

pool_conf_status

Return the validity status for a pool configuration.

pool_conf_validate

Check the validity of the contents of the given configuration.

pool_conf_validate

Return the location that was used by the pools framework to store the dynamic configuration.

pool_error

Return the error value of the last failure that was recorded by calling a resource pool configuration library function.

pool_get_binding

Return the name of the pool on the running system that contains the set of resources to which the specified process is bound.

pool_get_owning_resource

Return the resource that currently contains the specified component.

pool_get_pool

Return the pool with the specified name from the provided configuration.

pool_get_property

Retrieve the value of the named property from the element.

pool_get_resource

Return the resource with the given name and type from the provided configuration.

pool_get_resource_binding

Return the name of the pool on the running system that contains the set of resources to which the given process is bound.

pool_get_status

Retrieve the current state of the pools facility.

pool_info

Return a description of the specified pool.

pool_query_components

Retrieve all resource components that match the specified list of properties.

pool_query_pool_resources

Return a null-terminated array of resources currently associated with the pool.

pool_query_pools

Return the list of pools that match the specified list of properties.

pool_query_resource_components

Return a null-terminated array of the components that make up the specified resource.

pool_query_resources

Return the list of resources that match the specified list of properties.

pool_resource_info

Return a description of the specified resource.

pool_resource_type_list

Enumerate the resource types that are supported by the pools framework on this platform.

pool_static_location

Return the location that was used by the pools framework to store the default configuration for pools framework instantiation.

pool_strerror

Return a description of each valid pool error code.

pool_value_get_bool

Get a property value of type boolean.

pool_value_get_double

Get a property value of type double.

pool_value_get_int64

Get a property value of type int64.

pool_value_get_name

Return the name that was assigned to the specified pool property.

pool_value_get_string

Get a property value of type string.

pool_value_get_type

Return the type of the data that is contained by the specified pool value.

pool_value_get_uint64

Get a property value of type uint64.

pool_version

Get the version number of the pool library.

pool_walk_components

Invoke callback on all components that are contained in the resource.

pool_walk_pools

Invoke callback on all pools that are defined in the configuration.

pool_walk_properties

Invoke callback on all properties defined for the given element.

pool_walk_resources

Invoke callback on all resources that are associated with the pool.