Print this page 
6591 resource_controls(5) should talk about project.cpu-cap not project.cpu-caps
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man5/resource_controls.5
          +++ new/usr/src/man/man5/resource_controls.5
   1    1  '\" te
   2    2  .\" Copyright (c) 2007, 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    6  .TH RESOURCE_CONTROLS 5 "Jul 19, 2013"
   7    7  .SH NAME
   8    8  resource_controls \- resource controls available through project database
   9    9  .SH DESCRIPTION
  10      -.sp
  11   10  .LP
  12   11  The resource controls facility is configured through the project database. See
  13   12  \fBproject\fR(4). You can set and modify resource controls through the
  14   13  following utilities:
  15   14  .RS +4
  16   15  .TP
  17   16  .ie t \(bu
  18   17  .el o
  19   18  \fBprctl\fR(1)
  20   19  .RE
↓ open down ↓ 164 lines elided ↑ open up ↑ 
 185  184  .ad
 186  185  .sp .6
 187  186  .RS 4n
 188  187  Maximum stack memory segment available to this process, expressed as a number
 189  188  of bytes.
 190  189  .RE
 191  190  
 192  191  .sp
 193  192  .ne 2
 194  193  .na
 195      -\fB\fBproject.cpu-caps\fR\fR
      194 +\fB\fBproject.cpu-cap\fR\fR
 196  195  .ad
 197  196  .sp .6
 198  197  .RS 4n
 199  198  Maximum amount of CPU resources that a project can use. The unit used is the
 200  199  percentage of a single CPU that can be used by all user threads in a project.
 201  200  Expressed as an integer. The cap does not apply to threads running in real-time
 202  201  scheduling class. This resource control does not support the \fBsyslog\fR
 203  202  action.
 204  203  .RE
 205  204
↓ open down ↓ 264 lines elided ↑ open up ↑ 
 470  469  .sp .6
 471  470  .RS 4n
 472  471  Total amount of swap that can be consumed by user process address space
 473  472  mappings and \fBtmpfs\fR mounts for this zone.
 474  473  .RE
 475  474  
 476  475  .sp
 477  476  .LP
 478  477  See \fBzones\fR(5).
 479  478  .SS "Units Used in Resource Controls"
 480      -.sp
 481  479  .LP
 482  480  Resource controls can be expressed as in units of size (bytes), time (seconds),
 483  481  or as a count (integer). These units use the strings specified below.
 484  482  .sp
 485  483  .in +2
 486  484  .nf
 487  485  Category             Res Ctrl      Modifier  Scale
 488  486                       Type String
 489  487  -----------          -----------   --------  -----
 490  488  Size                 bytes         B         1
↓ open down ↓ 65 lines elided ↑ open up ↑ 
 556  554  
 557  555  .sp
 558  556  .LP
 559  557  The preceding examples use the scaling factors specified in the table above.
 560  558  .sp
 561  559  .LP
 562  560  Note that unit modifiers (for example, \fB5G\fR) are accepted by the
 563  561  \fBprctl\fR(1), \fBprojadd\fR(1M), and \fBprojmod\fR(1M) commands. You cannot
 564  562  use unit modifiers in the project database itself.
 565  563  .SS "Resource Control Values and Privilege Levels"
 566      -.sp
 567  564  .LP
 568  565  A threshold value on a resource control constitutes a point at which local
 569  566  actions can be triggered or global actions, such as logging, can occur.
 570  567  .sp
 571  568  .LP
 572  569  Each threshold value on a resource control must be associated with a privilege
 573  570  level. The privilege level must be one of the following three types:
 574  571  .sp
 575  572  .ne 2
 576  573  .na
↓ open down ↓ 48 lines elided ↑ open up ↑ 
 625  622  In specifying the privilege level of \fBprivileged\fR, you can use the
 626  623  abbreviation \fBpriv\fR. For example:
 627  624  .sp
 628  625  .in +2
 629  626  .nf
 630  627  task.max-lwps=(priv,1K,deny)
 631  628  .fi
 632  629  .in -2
 633  630  
 634  631  .SS "Global and Local Actions on Resource Control Values"
 635      -.sp
 636  632  .LP
 637  633  There are two categories of actions on resource control values: global and
 638  634  local.
 639  635  .sp
 640  636  .LP
 641  637  Global actions apply to resource control values for every resource control on
 642  638  the system. You can use \fBrctladm\fR(1M) to perform the following actions:
 643  639  .RS +4
 644  640  .TP
 645  641  .ie t \(bu
↓ open down ↓ 205 lines elided ↑ open up ↑ 
 851  847  \fB\fBSIGXCPU\fR\fR
 852  848  .ad
 853  849  .sp .6
 854  850  .RS 4n
 855  851  Terminate the process. CPU time limit exceeded. Available only to resource
 856  852  controls with the \fBRCTL_GLOBAL_CPUTIME\fR property
 857  853  (\fBprocess.max-cpu-time\fR). See \fBrctlblk_set_value\fR(3C).
 858  854  .RE
 859  855  
 860  856  .SS "Resource Control Flags and Properties"
 861      -.sp
 862  857  .LP
 863  858  Each resource control on the system has a certain set of associated properties.
 864  859  This set of properties is defined as a set of flags, which are associated with
 865  860  all controlled instances of that resource. Global flags cannot be modified, but
 866  861  the flags can be retrieved by using either \fBrctladm\fR(1M) or the
 867  862  \fBsetrctl\fR(2) system call.
 868  863  .sp
 869  864  .LP
 870  865  Local flags define the default behavior and configuration for a specific
 871  866  threshold value of that resource control on a specific process or process
↓ open down ↓ 84 lines elided ↑ open up ↑ 
 956  951  .in -2
 957  952  
 958  953  .sp
 959  954  .LP
 960  955  The \fBmax\fR (\fBRCTL_LOCAL_MAXIMAL\fR) flag is set for both threshold values,
 961  956  and the \fBinf\fR (\fBRCTL_GLOBAL_INFINITE\fR) flag is defined for this
 962  957  resource control. An \fBinf\fR value has an infinite quantity. The value is
 963  958  never enforced. Hence, as configured, both threshold quantities represent
 964  959  infinite values that are never exceeded.
 965  960  .SS "Resource Control Enforcement"
 966      -.sp
 967  961  .LP
 968  962  More than one resource control can exist on a resource. A resource control can
 969  963  exist at each containment level in the process model. If resource controls are
 970  964  active on the same resource at different container levels, the smallest
 971  965  container's control is enforced first. Thus, action is taken on
 972  966  \fBprocess.max-cpu-time\fR before \fBtask.max-cpu-time\fR if both controls are
 973  967  encountered simultaneously.
 974  968  .SH ATTRIBUTES
 975      -.sp
 976  969  .LP
 977  970  See \fBattributes\fR(5) for a description of the following attributes:
 978  971  .sp
 979  972  
 980  973  .sp
 981  974  .TS
 982  975  box;
 983  976  c | c
 984  977  l | l .
 985  978  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 986  979  _
 987  980  Interface Stability     Evolving
 988  981  .TE
 989  982  
 990  983  .SH SEE ALSO
 991      -.sp
 992  984  .LP
 993  985  \fBprctl\fR(1), \fBpooladm\fR(1M), \fBpoolcfg\fR(1M), \fBprojadd\fR(1M),
 994  986  \fBprojmod\fR(1M), \fBrctladm\fR(1M), \fBsetrctl\fR(2),
 995  987  \fBrctlblk_set_value\fR(3C), \fBlibpool\fR(3LIB), \fBproject\fR(4),
 996  988  \fBattributes\fR(5), \fBFSS\fR(7)
 997  989  .sp
 998  990  .LP
 999  991  \fISystem Administration Guide:  Virtualization Using the Solaris Operating
1000  992  System\fR
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX