1 POOL_COMPONENT_INFO(3POOL)   Pool Configuration Manipulation Library Functions
   2 
   3 
   4 
   5 NAME
   6        pool_component_info, pool_get_owning_resource - resource pool component
   7        functions
   8 
   9 SYNOPSIS
  10        cc [ flag... ] file... -lpool [ library... ]
  11        #include <pool.h>
  12 
  13        const char *pool_component_info(pool_conf_t *conf,
  14             pool_component_t *component, int flags);
  15 
  16 
  17        pool_resource_t *pool_get_owning_resource(pool_conf_t *conf,
  18             pool_component_t *component);
  19 
  20 
  21 DESCRIPTION
  22        Certain resources, such as processor sets, are composed of resource
  23        components.  Informational and ownership attributes of resource
  24        components are made available with the pool_component_info() and
  25        pool_get_owning_resource() functions. The conf argument for each
  26        function refers to the target configuration to which the operation
  27        applies.
  28 
  29 
  30        The pool_component_info() function returns a string describing
  31        component. The string is allocated with malloc(3C). The caller is
  32        responsible for freeing the returned string. The flags argument is
  33        ignored.
  34 
  35 
  36        The pool_get_owning_resource() function returns the resource currently
  37        containing component.  Every component is contained by a resource.
  38 
  39 RETURN VALUES
  40        Upon successful completion, pool_component_info() returns a string.
  41        Otherwise it returns NULL and pool_error(3POOL) returns the pool-
  42        specific error value.
  43 
  44 
  45        Upon successful completion, pool_get_owning_resource() returns the
  46        owning resource. Otherwise it returns NULL and pool_error() returns the
  47        pool-specific error value.
  48 
  49 ERRORS
  50        The pool_component_info() function will fail if:
  51 
  52        POE_BADPARAM
  53                            The supplied configuration's status is not
  54                            POF_VALID or the flags parameter is neither 0 or 1.
  55 
  56 
  57        POE_INVALID_CONF
  58                            The configuration is invalid.
  59 
  60 
  61        POE_SYSTEM
  62                            A system error has occurred. Check the system error
  63                            code for more details.
  64 
  65 
  66 
  67        The pool_get_owning_resource() function will fail if:
  68 
  69        POE_BADPARAM
  70                        The supplied configuration's status is not POF_VALID.
  71 
  72 
  73 ATTRIBUTES
  74        See attributes(5) for descriptions of the following attributes:
  75 
  76 
  77 
  78 
  79        +--------------------+-----------------+
  80        |  ATTRIBUTE TYPE    | ATTRIBUTE VALUE |
  81        +--------------------+-----------------+
  82        |CSI                 | Enabled         |
  83        +--------------------+-----------------+
  84        |Interface Stability | Unstable        |
  85        +--------------------+-----------------+
  86        |MT-Level            | Safe            |
  87        +--------------------+-----------------+
  88 
  89 SEE ALSO
  90        libpool(3LIB), pool_error(3POOL), attributes(5)
  91 
  92 
  93 
  94                                January 15, 2020     POOL_COMPONENT_INFO(3POOL)