Print this page
11583 Some man3lib pages are missing parts of the SYNOPSIS

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3lib/libpool.3lib
          +++ new/usr/src/man/man3lib/libpool.3lib
   1    1  '\" te
   2    2  .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   3    3  .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4    4  .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5    5  .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6      -.TH LIBPOOL 3LIB "April 9, 2016"
        6 +.TH LIBPOOL 3LIB "Aug 19, 2019"
   7    7  .SH NAME
   8    8  libpool \- pool configuration manipulation library
   9    9  .SH SYNOPSIS
  10      -.LP
  11   10  .nf
  12      -\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
       11 +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpool\fR [ \fIlibrary\fR... ]
  13   12  #include <\fBpool.h\fR>
  14   13  .fi
  15   14  
  16   15  .SH DESCRIPTION
  17      -.LP
  18   16  The functions in this library define the interface for reading and writing
  19   17  resource pools configuration files, as well as that for committing an existing
  20   18  configuration to becoming the running OS configuration (with respect to
  21   19  partitioning subsystems). The <\fBpool.h\fR> header provides type and function
  22   20  declarations for all library services.
  23   21  .sp
  24   22  .LP
  25   23  The resource pools facility brings together process-bindable resources into a
  26   24  common abstraction called a pool. Processor sets and other entities can be
  27   25  configured, grouped, and labelled in a persistent fashion such that workload
↓ open down ↓ 93 lines elided ↑ open up ↑
 121  119  .LP
 122  120  The \fBsystem.bind-default\fR property defaults to true. This property
 123  121  interacts with the \fBproject.pool\fR resource control to specify the binding
 124  122  behavior for processes associated with a project. If \fBproject.pool\fR is not
 125  123  specified, then this property has no effect. If \fBproject.pool\fR is specified
 126  124  and the specified pool exists, this property has no effect. If the specified
 127  125  pool does not exist, perhaps because of a reconfiguration, then this property
 128  126  controls the binding behavior for the project member. If
 129  127  \fBsystem.bind-default\fR is true, then the project member is bound to the
 130  128  default pool (identified as the pool for which \fBpool.default\fR is true);
 131      -otherise the project member is refused access to the system. Care should be
      129 +otherwise the project member is refused access to the system. Care should be
 132  130  taken with the pools configuration if this property is set to false, so as to
 133  131  avoid denying users access to the system.
 134  132  .sp
 135  133  .LP
 136  134  The various \fBpoold\fR properties are used to configure the operation of
 137  135  \fBpoold\fR(1M).
 138  136  .sp
 139  137  .LP
 140  138  The \fBsystem.poold.log-level\fR property is used to specify the level of
 141  139  detail provided in log messages. Valid values are: \fBALERT\fR, \fBCRIT\fR,
↓ open down ↓ 131 lines elided ↑ open up ↑
 273  271  .LP
 274  272  The \fBpset.poold.objectives\fR property specifies an objective which is
 275  273  specific to a particular \fBpset\fR. See the \fBsystem.poold.objectives\fR
 276  274  entry for the specification of this property's syntax.
 277  275  .sp
 278  276  .LP
 279  277  There are two types of objectives that can be set on a \fBpset\fR:
 280  278  .sp
 281  279  .ne 2
 282  280  .na
 283      -\fB\fBlocality\fR\fR
      281 +\fBlocality\fR
 284  282  .ad
 285  283  .RS 15n
 286  284  This objective influences the impact that locality, as measured by lgroup data,
 287  285  has upon the chosen configuration. This objective can take one of three values:
 288  286  .sp
 289  287  .ne 2
 290  288  .na
 291      -\fB\fBtight\fR\fR
      289 +\fBtight\fR
 292  290  .ad
 293  291  .RS 9n
 294  292  If set, configurations that maximize resource locality are favored.
 295  293  .RE
 296  294  
 297  295  .sp
 298  296  .ne 2
 299  297  .na
 300      -\fB\fBloose\fR\fR
      298 +\fBloose\fR
 301  299  .ad
 302  300  .RS 9n
 303  301  If set, configurations that minimize resource locality are favored.
 304  302  .RE
 305  303  
 306  304  .sp
 307  305  .ne 2
 308  306  .na
 309      -\fB\fBnone\fR\fR
      307 +\fBnone\fR
 310  308  .ad
 311  309  .RS 9n
 312  310  This is the default value for this objective. If set, configuration
 313  311  favorability is uninfluenced by resource locality.
 314  312  .RE
 315  313  
 316  314  .RE
 317  315  
 318  316  .sp
 319  317  .ne 2
 320  318  .na
 321      -\fB\fButilization\fR\fR
      319 +\fButilization\fR
 322  320  .ad
 323  321  .RS 15n
 324  322  This objective favors configurations that allocate resources to partitions that
 325  323  are failing to preserve the specified utilization objective.
 326  324  .RE
 327  325  
 328  326  .sp
 329  327  .LP
 330  328  These objectives are specified in terms of an operator and a value. The
 331  329  operators are
 332  330  .sp
 333  331  .ne 2
 334  332  .na
 335      -\fB\fB<\fR\fR
      333 +\fB<\fR
 336  334  .ad
 337  335  .RS 5n
 338  336  The ``less than'' operator is used to indicate that the specified value should
 339  337  be treated as a maximum target value.
 340  338  .RE
 341  339  
 342  340  .sp
 343  341  .ne 2
 344  342  .na
 345      -\fB\fB>\fR\fR
      343 +\fB>\fR
 346  344  .ad
 347  345  .RS 5n
 348  346  The ``greater than'' operator is used to indicate that the specified value
 349  347  should be treated as a minimum target value.
 350  348  .RE
 351  349  
 352  350  .sp
 353  351  .ne 2
 354  352  .na
 355      -\fB\fB~\fR\fR
      353 +\fB~\fR
 356  354  .ad
 357  355  .RS 5n
 358  356  The ``about'' operator is used to indicate that the specified value should be
 359  357  treated as a target value about which some fluctuation is acceptable.
 360  358  .RE
 361  359  
 362  360  .sp
 363  361  .LP
 364  362  Only one objective of each type of operator can be set. For example, if the
 365  363  \fB~\fR operator is set, the \fB<\fR and \fB>\fR operators cannot be set. It is
↓ open down ↓ 16 lines elided ↑ open up ↑
 382  380  .sp
 383  381  .LP
 384  382  The \fBcpu.comment\fR, \fBcpu.pinned\fR, and \fBcpu.status\fR properties are
 385  383  writable.
 386  384  .sp
 387  385  .LP
 388  386  The \fBcpu.status\fR property can be set only to the following values:
 389  387  .sp
 390  388  .ne 2
 391  389  .na
 392      -\fB\fBoff-line\fR\fR
      390 +\fBoff-line\fR
 393  391  .ad
 394  392  .RS 12n
 395  393  Set the CPU offline.
 396  394  .RE
 397  395  
 398  396  .sp
 399  397  .ne 2
 400  398  .na
 401      -\fB\fBon-line\fR\fR
      399 +\fBon-line\fR
 402  400  .ad
 403  401  .RS 12n
 404  402  Set the CPU online.
 405  403  .RE
 406  404  
 407  405  .sp
 408  406  .ne 2
 409  407  .na
 410      -\fB\fBno-intr\fR\fR
      408 +\fBno-intr\fR
 411  409  .ad
 412  410  .RS 12n
 413  411  Disable interrupt processing on the CPU.
 414  412  .RE
 415  413  
 416  414  .sp
 417  415  .LP
 418  416  These values are defined in <\fBsys/processor.h\fR> as the \fBPS_OFFLINE\fR,
 419  417  \fBPS_ONLINE\fR, and \fBPS_NOINTR\fR macros.
 420  418  .SH INTERFACES
 421      -.LP
 422  419  The shared object \fBlibpool.so.1\fR provides the public interfaces defined
 423  420  below. See \fBIntro\fR(3) for additional information on shared object
 424  421  interfaces.
 425  422  .sp
 426  423  
 427  424  .sp
 428  425  .TS
 429  426  l l
 430  427  l l .
 431  428  \fBpool_associate\fR    \fBpool_component_info\fR
↓ open down ↓ 29 lines elided ↑ open up ↑
 461  458  \fBpool_value_set_int64\fR      \fBpool_value_set_name\fR
 462  459  \fBpool_value_set_string\fR     \fBpool_value_set_uint64\fR
 463  460  \fBpool_version\fR      \fBpool_walk_components\fR
 464  461  \fBpool_walk_pools\fR   \fBpool_walk_properties\fR
 465  462  \fBpool_walk_resources\fR       
 466  463  .TE
 467  464  
 468  465  .SH FILES
 469  466  .ne 2
 470  467  .na
 471      -\fB\fB/usr/lib/libpool.so.1\fR\fR
      468 +\fB/usr/lib/libpool.so.1\fR
 472  469  .ad
 473  470  .RS 28n
 474  471  shared object
 475  472  .RE
 476  473  
 477  474  .sp
 478  475  .ne 2
 479  476  .na
 480      -\fB\fB/usr/lib/64/libpool.so.1\fR\fR
      477 +\fB/usr/lib/64/libpool.so.1\fR
 481  478  .ad
 482  479  .RS 28n
 483  480  64-bit shared object
 484  481  .RE
 485  482  
 486  483  .SH ATTRIBUTES
 487      -.LP
 488  484  See \fBattributes\fR(5) for descriptions of the following attributes:
 489  485  .sp
 490  486  
 491  487  .sp
 492  488  .TS
 493  489  box;
 494  490  c | c
 495  491  l | l .
 496  492  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 497  493  _
 498  494  CSI     Enabled
 499  495  _
 500  496  Interface Stability     Unstable
 501  497  _
 502  498  MT-Level        Safe
 503  499  .TE
 504  500  
 505  501  .SH SEE ALSO
 506      -.LP
 507  502  \fBIntro\fR(3), \fBpool_component_info\fR(3POOL), \fBpool_conf_open\fR(3POOL),
 508  503  \fBpool_conf_to_elem\fR(3POOL), \fBpool_create\fR(3POOL),
 509  504  \fBpool_error\fR(3POOL), \fBpool_get_binding\fR(3POOL),
 510  505  \fBpool_get_property\fR(3POOL), \fBpool_get_resource\fR(3POOL),
 511  506  \fBpool_resource_create\fR(3POOL), \fBpool_value_alloc\fR(3POOL),
 512  507  \fBpool_walk_pools\fR(3POOL), \fBattributes\fR(5), \fBsmf\fR(5)
 513  508  .SH NOTES
 514      -.LP
 515  509  Functions in \fBlibpool\fR can be used to manipulate static configurations even
 516  510  when the pools facility is not enabled. See \fBpooladm\fR(1M) and
 517  511  \fBpool_set_status\fR(3POOL) for more information about enabling the pools
 518  512  facility. The pools facility must be enabled, however, to modify the dynamic
 519  513  configuration.
 520  514  .sp
 521  515  .LP
 522  516  Since the Resource Pools facility is an \fBsmf\fR(5) service, it can also be
 523  517  enabled and disabled using the standard Service Management Facility (SMF)
 524  518  interfaces.
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX