Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Interface Librarieslibpool(3LIB)


NAME

 libpool - pool configuration manipulation library

SYNOPSIS

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

DESCRIPTION

 

The functions in this library define the interface for reading and writing resource pools configuration files, as well as that for commiting an existing configuration to becoming the running OS configuration (with respect to partitioning subsystems). The <pool.h> header provides type and function declarations for all library services.

The resource pools facility brings together process-bindable resources into a common abstraction called a pool. Processor sets and other entities can be configured, grouped, and labelled in a persistent fashion such that workload components can be associated with a subset of a system's total resources. The libpool library provides a C language API for accessing this functionality, while pooladm(1M), poolbind(1M), and poolcfg(1M) make this facility available through command invocations from a shell. Each of those manual pages describes aspects of the pools facility; this page describes the properties available to the various entities managed within the pools facility. These entities include the system, pools, and the pset resources for processor sets.

Each active entity within the resource pools framework can have an arbitrary collection of named, typed properties associated with it. Properties supported by the pools framework are listed, with descriptions, under each entity below. In general, resource properties may be one of five types: boolean, signed and unsigned integers, floating point, and string values.

All entities and resources support a string property for commenting purposes; this property is available for use by management applications to record descriptions and other administrator oriented data. The comment field is not used by the default pools commands, except when a configuration is initiated by the poolcfg utility, in which case an informative message is placed in the system.comment property for that configuration.

System

 
Property nameTypeDescription
system.bind-defaultbooleanIf specified pool not found, bind to pool with 'pool.default' property set to true.
system.commentstringUser description of system.
system.versionintlibpool version required to manipulate this configuration.

The system.bind-default and system.comment properties are writable; the system.version property is not.

Pools

 
Property nameTypeDescription
pool.activebooleanMark this pool as active, if true.
pool.commentstringUser description of pool.
pool.defaultbooleanMark this pool as the default pool, if true; see system.bind-default property.
pool.importanceintRelative importance of this pool; for possible resource dispute resolution.
pool.namestringUser name for pool; used by setproject3PROJECT as value for 'project.pool' project attribute in project4 database.
pool.schedulerstringScheduler class to which consumers of this pool will be bound. This property is optional and if not specified, the scheduler bindings for consumers of this pool are not affected.

All of the above listed properties are writable.

Processor Sets

 
Property nameTypeDescription
pset.commentstringUser description of resource.
pset.defaultbooleanMarks default processor set.
pset.escapablebooleanRepresents whether PSET_NOESCAPE is set for this pset (see pset_setattr2)
pset.maxuintMaximum number of CPUs permitted in this processor set.
pset.minuintMinimum number of CPUs permitted in this processor set.
pset.namestringUser name for resource.
pset.sizeuintCurrent number of CPUs in this processor set.
pset.sys_idintSystem-assigned processor set ID.
pset.typestringNames resource type; value for all processor sets is pset.
pset.unitsstringIdentifies meaning of size-related properties; value for all processor sets is population.

The pset.comment, pset.default, pset.escapable, pset.max, pset.min, pset.min, and pset.name properties are writable; the pset.size, pset.sys_id, pset.type, and pset.units properties are not.

INTERFACES

 

The shared object libpool.so.1 provides the public interfaces defined below. See intro(3) for additional information on shared object interfaces.

pool_associatepool_component_info
pool_component_to_elempool_conf_alloc
pool_conf_closepool_conf_commit
pool_conf_exportpool_conf_free
pool_conf_infopool_conf_location
pool_conf_openpool_conf_remove
pool_conf_rollbackpool_conf_status
pool_conf_to_elempool_conf_validate
pool_createpool_destroy
pool_dissociatepool_dynamic_location
pool_errorpool_get_binding
pool_get_owning_resourcepool_get_pool
pool_get_propertypool_get_resource
pool_get_resource_bindingpool_info
pool_put_propertypool_query_components
pool_query_pool_resourcespool_query_pools
pool_query_resource_componentspool_query_resources
pool_resource_createpool_resource_destroy
pool_resource_infopool_resource_to_elem
pool_resource_transferpool_resource_xtransfer
pool_rm_propertypool_set_binding
pool_static_locationpool_strerror
pool_to_elempool_value_alloc
pool_value_freepool_value_get_bool
pool_value_get_doublepool_value_get_int64
pool_value_get_namepool_value_get_string
pool_value_get_typepool_value_get_uint64
pool_value_set_boolpool_value_set_double
pool_value_set_int64pool_value_set_name
pool_value_set_stringpool_value_set_uint64
pool_versionpool_walk_components
pool_walk_poolspool_walk_properties
pool_walk_resources 

FILES

 
/usr/lib/libpool.so.1
shared object
/usr/lib/sparcv9/libpool.so.1
64-bit shared object

ATTRIBUTES

 

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

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWpool (32-bit)
 SUNWpoolx (64-bit)
CSIEnabled
Interface StabilityEvolving
MT-LevelUnsafe

SEE ALSO

 

intro(3), pool_component_info(3POOL), pool_conf_open(3POOL), pool_conf_to_elem(3POOL), pool_create(3POOL), pool_error(3POOL), pool_get_binding(3POOL), pool_get_property(3POOL), pool_get_resource(3POOL), pool_resource_create(3POOL), pool_value_alloc(3POOL), pool_walk_pools(3POOL), attributes(5)

NOTES

 

Functions in libpool are unsafe for use in multithreaded applications where multiple configurations are being simultaneously manipulated by the application, due to shared state in the backing repository facility.


SunOS 5.9Go To TopLast Changed 2 Sep 2001

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.