2 .\" Copyright (c) 2009 Edward Tomasz Napierala
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR THE VOICES IN HIS HEAD BE
18 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 .\" POSSIBILITY OF SUCH DAMAGE.
33 .Nd display and update resource limits database
55 When called without options, the
57 command writes currently defined RCTL rules to standard output.
61 argument is specified, only rules matching the filter are displayed.
62 The options are as follows:
63 .Bl -tag -width indent
69 Display rules applicable to the process defined by
71 Note that this is different from showing the rules when called without
72 any options, as it shows not just the rules with subject equal to that
73 of process, but also rules for the user, jail, and login class applicable
78 from the RCTL database.
80 Display resource utilization for a subject
91 "Human-readable" output.
92 Use unit suffixes: Byte, Kilobyte, Megabyte,
93 Gigabyte, Terabyte and Petabyte.
95 Display user IDs numerically rather than converting them to a user name.
98 Modifying rules affects all currently running and future processes matching
101 Syntax for a rule is subject:subject-id:resource:action=amount/per.
103 .Bl -tag -width "subject-id" -compact -offset indent
105 defines the kind of entity the rule applies to.
115 It can be a process ID, user name, numerical user ID, login class name from
119 identifies the resource the rule controls.
122 section below for details.
124 defines what will happen when a process exceeds the allowed
128 section below for details.
130 defines how much of the resource a process can use before
134 Resources which limit bytes may use prefixes from
135 .Xr expand_number 3 .
137 defines what entity the
140 For example, rule "loginclass:users:vmem:deny=100M/process" means
141 that each process of any user belonging to login class "users" may allocate
142 up to 100MB of virtual memory.
143 Rule "loginclass:users:vmem:deny=100M/user" would mean that for each
144 user belonging to the login class "users", the sum of virtual memory allocated
145 by all the processes of that user will not exceed 100MB.
146 Rule "loginclass:users:vmem:deny=100M/loginclass" would mean that the sum of
147 virtual memory allocated by all processes of all users belonging to that login
148 class will not exceed 100MB.
151 A valid rule has all those fields specified, except for
157 A filter is a rule for which one of more fields other than
160 For example, a filter that matches every rule could be written as ":::=/",
162 A filter that matches all the login classes would be "loginclass:".
163 A filter that matches all defined rules for
168 .Bl -column -offset 3n "pseudoterminals" ".Sy username or numerical User ID"
169 .It Sy process Ta numerical Process ID
170 .It Sy user Ta user name or numerical User ID
171 .It Sy loginclass Ta login class from
173 .It Sy jail Ta jail name
176 .Bl -column -offset 3n "pseudoterminals"
177 .It Sy cputime Ta "CPU time, in seconds"
178 .It Sy datasize Ta "data size, in bytes"
179 .It Sy stacksize Ta "stack size, in bytes"
180 .It Sy coredumpsize Ta "core dump size, in bytes"
181 .It Sy memoryuse Ta "resident set size, in bytes"
182 .It Sy memorylocked Ta "locked memory, in bytes"
183 .It Sy maxproc Ta "number of processes"
184 .It Sy openfiles Ta "file descriptor table size"
185 .It Sy vmemoryuse Ta "address space limit, in bytes"
186 .It Sy pseudoterminals Ta "number of PTYs"
187 .It Sy swapuse Ta "swap space that may be reserved or used, in bytes"
188 .It Sy nthr Ta "number of threads"
189 .It Sy msgqqueued Ta "number of queued SysV messages"
190 .It Sy msgqsize Ta "SysV message queue size, in bytes"
191 .It Sy nmsgq Ta "number of SysV message queues"
192 .It Sy nsem Ta "number of SysV semaphores"
193 .It Sy nsemop Ta "number of SysV semaphores modified in a single semop(2) call"
194 .It Sy nshm Ta "number of SysV shared memory segments"
195 .It Sy shmsize Ta "SysV shared memory size, in bytes"
196 .It Sy wallclock Ta "wallclock time, in seconds"
197 .It Sy pcpu Ta "%CPU, in percents of a single CPU core"
198 .It Sy readbps Ta "filesystem reads, in bytes per second"
199 .It Sy writebps Ta "filesystem writes, in bytes per second"
200 .It Sy readiops Ta "filesystem reads, in operations per second"
201 .It Sy writeiops Ta "filesystem writes, in operations per second"
204 .Bl -column -offset 3n "pseudoterminals"
205 .It Sy deny Ta deny the allocation; not supported for
213 .It Sy log Ta "log a warning to the console"
214 .It Sy devctl Ta "send notification to"
225 send a signal to the offending process.
228 for a list of supported signals
229 .It Sy throttle Ta "slow down process execution"; only supported for
237 Not all actions are supported for all resources.
238 Attempting to add a rule with an action not supported by a given resource will
243 Prevent user "joe" from allocating more than 1GB of virtual memory:
244 .Dl Nm Fl a Ar user:joe:vmemoryuse:deny=1g
246 Remove all RCTL rules:
249 Display resource utilization information for jail named "www":
250 .Dl Nm Fl hu Ar jail:www
252 Display all the rules applicable to process with PID 512:
253 .Dl Nm Fl l Ar process:512
258 Display all rules matching user "joe":
261 Display all rules matching login classes:
262 .Dl Nm Ar loginclass:
276 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
277 under sponsorship from the FreeBSD Foundation.
281 may kill the machine due to thrashing.
287 counters are only approximations.
292 they are calculated in the filesystem layer, where it is difficult
293 or even impossible to observe actual disk device operations.
299 resources generally account for writes to the filesystem cache,
300 not to actual devices.