.\" Copyright (c) 1980, 1991 The Regents of the University of California.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" @(#)getrlimit.2 6.7 (Berkeley) 3/10/91
.Nd control maximum system resource consumption
.Fd #include <sys/time.h>
.Fd #include <sys/resource.h>
.Fn getrlimit "int resource" "struct rlimit *rlp"
.Fn setrlimit "int resource" "struct rlimit *rlp"
Limits on the consumption of system resources by the current process
and each process it creates may be obtained with the
parameter is one of the following:
.Bl -tag -width RLIMIT_FSIZEAA
the maximum amount of cpu time (in seconds) to be used by
the largest size, in bytes, of any single file that may be created.
the maximum size, in bytes, of the data segment for a process;
this defines how far a program may extend its break with the
the maximum size, in bytes, of the stack segment for a process;
this defines how far a program's stack segment may be extended.
Stack extension is performed automatically by the system.
the largest size, in bytes, of a
file that may be created.
the maximum size, in bytes, to which a process's resident set size may
grow. This imposes a limit on the amount of physical memory
to be given to a process; if memory is tight, the system will
prefer to take memory from processes that are exceeding their
declared resident set size.
A resource limit is specified as a soft limit and a hard limit. When a
soft limit is exceeded a process may receive a signal (for example, if
the cpu time or file size is exceeded), but it will be allowed to
continue execution until it reaches the hard limit (or modifies
structure is used to specify the hard and soft limits on a resource,
.Bd -literal -offset indent
int rlim_cur; /* current (soft) limit */
int rlim_max; /* hard limit */
Only the super-user may raise the maximum limits. Other users
within the range from 0 to
value for a limit is defined as
(0x7\&f\&f\&f\&f\&f\&f\&f).
Because this information is stored in the per-process information,
this system call must be executed directly by the shell if it
is to affect all future processes created by the shell;
is thus a built-in command to
The system refuses to extend the data or stack space when the limits
would be exceeded in the normal way: a
call fails if the data space limit is reached.
When the stack limit is reached, the process receives
caught by a handler using the signal stack, this signal
A file I/O operation that would create a file larger that the process'
soft limit will cause the write to fail and a signal
generated; this normally terminates the process, but may be caught. When
the soft cpu time limit is exceeded, a signal
A 0 return value indicates that the call succeeded, changing
or returning the resource limit. A return value of -1 indicates
that an error occurred, and an error code is stored in the global
The address specified for
raised the maximum limit value, and the caller is not the super-user.
function call appeared in