Print this page
11583 Some man3lib pages are missing parts of the SYNOPSIS
   1 LIBPOOL(3LIB)                 Interface Libraries                LIBPOOL(3LIB)
   2 
   3 
   4 
   5 NAME
   6        libpool - pool configuration manipulation library
   7 
   8 SYNOPSIS
   9        cc [ flag... ] file... [ library... ]
  10        #include <pool.h>
  11 
  12 
  13 DESCRIPTION
  14        The functions in this library define the interface for reading and
  15        writing resource pools configuration files, as well as that for
  16        committing an existing configuration to becoming the running OS
  17        configuration (with respect to partitioning subsystems). The <pool.h>
  18        header provides type and function declarations for all library
  19        services.
  20 
  21 
  22        The resource pools facility brings together process-bindable resources
  23        into a common abstraction called a pool. Processor sets and other
  24        entities can be configured, grouped, and labelled in a persistent
  25        fashion such that workload components can be associated with a subset
  26        of a system's total resources. The libpool library provides a C
  27        language API for accessing this functionality, while pooladm(1M),
  28        poolbind(1M), and poolcfg(1M) make this facility available through
  29        command invocations from a shell. Each of those manual pages describes


 104        If "importance based" allocation is defined, then during a commit the
 105        library will allocate resources to pools using an algorithm that
 106        observes minimum and maximum constraints for resources but favors those
 107        resources with greater importance.
 108 
 109 
 110        If "surplus to default" is defined, then during a commit the library
 111        will allocate minimum resources to all resource sets apart from default
 112        which will receive any surplus.
 113 
 114 
 115        The system.bind-default property defaults to true. This property
 116        interacts with the project.pool resource control to specify the binding
 117        behavior for processes associated with a project. If project.pool is
 118        not specified, then this property has no effect. If project.pool is
 119        specified and the specified pool exists, this property has no effect.
 120        If the specified pool does not exist, perhaps because of a
 121        reconfiguration, then this property controls the binding behavior for
 122        the project member. If system.bind-default is true, then the project
 123        member is bound to the default pool (identified as the pool for which
 124        pool.default is true); otherise the project member is refused access to
 125        the system. Care should be taken with the pools configuration if this
 126        property is set to false, so as to avoid denying users access to the
 127        system.
 128 
 129 
 130        The various poold properties are used to configure the operation of
 131        poold(1M).
 132 
 133 
 134        The system.poold.log-level property is used to specify the level of
 135        detail provided in log messages. Valid values are: ALERT, CRIT, ERR,
 136        WARNING, NOTICE, INFO, and DEBUG.
 137 
 138 
 139        ALERT provides the least level of detail, DEBUG the greatest. See
 140        syslog(3C) for more information about the meaning of these debug
 141        levels.  If this property is not specified, the default value NOTICE is
 142        used.
 143 
 144 
 145        The system.poold.log-location property is used to specify the location
 146        of the logfiles generated by poold. The special value of "syslog"
 147        indicates that logged messages should be written to syslog(). If this


 433        Intro(3), pool_component_info(3POOL), pool_conf_open(3POOL),
 434        pool_conf_to_elem(3POOL), pool_create(3POOL), pool_error(3POOL),
 435        pool_get_binding(3POOL), pool_get_property(3POOL),
 436        pool_get_resource(3POOL), pool_resource_create(3POOL),
 437        pool_value_alloc(3POOL), pool_walk_pools(3POOL), attributes(5), smf(5)
 438 
 439 NOTES
 440        Functions in libpool can be used to manipulate static configurations
 441        even when the pools facility is not enabled. See pooladm(1M) and
 442        pool_set_status(3POOL) for more information about enabling the pools
 443        facility. The pools facility must be enabled, however, to modify the
 444        dynamic configuration.
 445 
 446 
 447        Since the Resource Pools facility is an smf(5) service, it can also be
 448        enabled and disabled using the standard Service Management Facility
 449        (SMF) interfaces.
 450 
 451 
 452 
 453                                  April 9, 2016                   LIBPOOL(3LIB)
   1 LIBPOOL(3LIB)                 Interface Libraries                LIBPOOL(3LIB)
   2 
   3 
   4 
   5 NAME
   6        libpool - pool configuration manipulation library
   7 
   8 SYNOPSIS
   9        cc [ flag... ] file... -lpool [ library... ]
  10        #include <pool.h>
  11 
  12 
  13 DESCRIPTION
  14        The functions in this library define the interface for reading and
  15        writing resource pools configuration files, as well as that for
  16        committing an existing configuration to becoming the running OS
  17        configuration (with respect to partitioning subsystems). The <pool.h>
  18        header provides type and function declarations for all library
  19        services.
  20 
  21 
  22        The resource pools facility brings together process-bindable resources
  23        into a common abstraction called a pool. Processor sets and other
  24        entities can be configured, grouped, and labelled in a persistent
  25        fashion such that workload components can be associated with a subset
  26        of a system's total resources. The libpool library provides a C
  27        language API for accessing this functionality, while pooladm(1M),
  28        poolbind(1M), and poolcfg(1M) make this facility available through
  29        command invocations from a shell. Each of those manual pages describes


 104        If "importance based" allocation is defined, then during a commit the
 105        library will allocate resources to pools using an algorithm that
 106        observes minimum and maximum constraints for resources but favors those
 107        resources with greater importance.
 108 
 109 
 110        If "surplus to default" is defined, then during a commit the library
 111        will allocate minimum resources to all resource sets apart from default
 112        which will receive any surplus.
 113 
 114 
 115        The system.bind-default property defaults to true. This property
 116        interacts with the project.pool resource control to specify the binding
 117        behavior for processes associated with a project. If project.pool is
 118        not specified, then this property has no effect. If project.pool is
 119        specified and the specified pool exists, this property has no effect.
 120        If the specified pool does not exist, perhaps because of a
 121        reconfiguration, then this property controls the binding behavior for
 122        the project member. If system.bind-default is true, then the project
 123        member is bound to the default pool (identified as the pool for which
 124        pool.default is true); otherwise the project member is refused access
 125        to the system. Care should be taken with the pools configuration if
 126        this property is set to false, so as to avoid denying users access to
 127        the system.
 128 
 129 
 130        The various poold properties are used to configure the operation of
 131        poold(1M).
 132 
 133 
 134        The system.poold.log-level property is used to specify the level of
 135        detail provided in log messages. Valid values are: ALERT, CRIT, ERR,
 136        WARNING, NOTICE, INFO, and DEBUG.
 137 
 138 
 139        ALERT provides the least level of detail, DEBUG the greatest. See
 140        syslog(3C) for more information about the meaning of these debug
 141        levels.  If this property is not specified, the default value NOTICE is
 142        used.
 143 
 144 
 145        The system.poold.log-location property is used to specify the location
 146        of the logfiles generated by poold. The special value of "syslog"
 147        indicates that logged messages should be written to syslog(). If this


 433        Intro(3), pool_component_info(3POOL), pool_conf_open(3POOL),
 434        pool_conf_to_elem(3POOL), pool_create(3POOL), pool_error(3POOL),
 435        pool_get_binding(3POOL), pool_get_property(3POOL),
 436        pool_get_resource(3POOL), pool_resource_create(3POOL),
 437        pool_value_alloc(3POOL), pool_walk_pools(3POOL), attributes(5), smf(5)
 438 
 439 NOTES
 440        Functions in libpool can be used to manipulate static configurations
 441        even when the pools facility is not enabled. See pooladm(1M) and
 442        pool_set_status(3POOL) for more information about enabling the pools
 443        facility. The pools facility must be enabled, however, to modify the
 444        dynamic configuration.
 445 
 446 
 447        Since the Resource Pools facility is an smf(5) service, it can also be
 448        enabled and disabled using the standard Service Management Facility
 449        (SMF) interfaces.
 450 
 451 
 452 
 453                                 August 19, 2019                  LIBPOOL(3LIB)