lib/libc/sys/getrlimit.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getrlimit.2 8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/getrlimit.2,v 1.10.2.5 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/getrlimit.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt GETRLIMIT 2
  38 .Os
  39 .Sh NAME
  40 .Nm getrlimit ,
  41 .Nm setrlimit
  42 .Nd control maximum system resource consumption
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In sys/time.h
  48 .In sys/resource.h
  49 .Ft int
  50 .Fn getrlimit "int resource" "struct rlimit *rlp"
  51 .Ft int
  52 .Fn setrlimit "int resource" "const struct rlimit *rlp"
  53 .Sh DESCRIPTION
  54 Limits on the consumption of system resources by the current process
  55 and each process it creates may be obtained with the
  56 .Fn getrlimit
  57 call, and set with the
  58 .Fn setrlimit
  59 call.
  60 .Pp
  61 The
  62 .Fa resource
  63 parameter is one of the following:
  64 .Bl -tag -width RLIMIT_FSIZEAA
  65 .It Li RLIMIT_CORE
  66 The largest size (in bytes)
  67 .Xr core 5
  68 file that may be created.
  69 .It Li RLIMIT_CPU
  70 The maximum amount of cpu time (in seconds) to be used by
  71 each process.
  72 .It Li RLIMIT_DATA
  73 The maximum size (in bytes) of the data segment for a process;
  74 this defines how far a program may extend its break with the
  75 .Xr sbrk 2
  76 system call.
  77 .It Li RLIMIT_FSIZE
  78 The largest size (in bytes) file that may be created.
  79 .It Li RLIMIT_MEMLOCK
  80 The maximum size (in bytes) which a process may lock into memory
  81 using the
  82 .Xr mlock 2
  83 function.
  84 .It Li RLIMIT_NOFILE
  85 The maximum number of open files for this process.
  86 .It Li RLIMIT_NPROC
  87 The maximum number of simultaneous processes for this user id.
  88 .It Li RLIMIT_RSS
  89 The maximum size (in bytes) to which a process's resident set size may
  90 grow.
  91 This imposes a limit on the amount of physical memory to be given to
  92 a process; if memory is tight, the system will prefer to take memory
  93 from processes that are exceeding their declared resident set size.
  94 .It Li RLIMIT_STACK
  95 The maximum size (in bytes) of the stack segment for a process;
  96 this defines how far a program's stack segment may be extended.
  97 Stack extension is performed automatically by the system.
  98 .It Li RLIMIT_SBSIZE
  99 The maximum size (in bytes) of socket buffer usage for this user.
 100 This limits the amount of network memory, and hence the amount of
 101 mbufs, that this user may hold at any time.
 102 .El
 103 .Pp
 104 A resource limit is specified as a soft limit and a hard limit.  When a
 105 soft limit is exceeded a process may receive a signal (for example, if
 106 the cpu time or file size is exceeded), but it will be allowed to
 107 continue execution until it reaches the hard limit (or modifies
 108 its resource limit).  The
 109 .Em rlimit
 110 structure is used to specify the hard and soft limits on a resource,
 111 .Bd -literal -offset indent
 112 struct rlimit {
 113         rlim_t  rlim_cur;       /* current (soft) limit */
 114         rlim_t  rlim_max;       /* maximum value for rlim_cur */
 115 };
 116 .Ed
 117 .Pp
 118 Only the super-user may raise the maximum limits.  Other users
 119 may only alter
 120 .Fa rlim_cur
 121 within the range from 0 to
 122 .Fa rlim_max
 123 or (irreversibly) lower
 124 .Fa rlim_max .
 125 .Pp
 126 An
 127 .Dq infinite
 128 value for a limit is defined as
 129 .Dv RLIM_INFINITY .
 130 .Pp
 131 Because this information is stored in the per-process information,
 132 this system call must be executed directly by the shell if it
 133 is to affect all future processes created by the shell;
 134 .Ic limit
 135 is thus a built-in command to
 136 .Xr csh 1 .
 137 .Pp
 138 The system refuses to extend the data or stack space when the limits
 139 would be exceeded in the normal way: a
 140 .Xr brk 2
 141 call fails if the data space limit is reached.
 142 When the stack limit is reached, the process receives
 143 a segmentation fault
 144 .Pq Dv SIGSEGV ;
 145 if this signal is not
 146 caught by a handler using the signal stack, this signal
 147 will kill the process.
 148 .Pp
 149 A file I/O operation that would create a file larger that the process'
 150 soft limit will cause the write to fail and a signal
 151 .Dv SIGXFSZ
 152 to be
 153 generated; this normally terminates the process, but may be caught.  When
 154 the soft cpu time limit is exceeded, a signal
 155 .Dv SIGXCPU
 156 is sent to the
 157 offending process.
 158 .Sh RETURN VALUES
 159 .Rv -std
 160 .Sh ERRORS
 161 .Fn Getrlimit
 162 and
 163 .Fn setrlimit
 164 will fail if:
 165 .Bl -tag -width Er
 166 .It Bq Er EFAULT
 167 The address specified for
 168 .Fa rlp
 169 is invalid.
 170 .It Bq Er EPERM
 171 The limit specified to
 172 .Fn setrlimit
 173 would have
 174 raised the maximum limit value, and the caller is not the super-user.
 175 .El
 176 .Sh SEE ALSO
 177 .Xr csh 1 ,
 178 .Xr quota 1 ,
 179 .Xr quotactl 2 ,
 180 .Xr sigaltstack 2 ,
 181 .Xr sigvec 2 ,
 182 .Xr sysctl 3
 183 .Sh HISTORY
 184 The
 185 .Fn getrlimit
 186 function call appeared in
 187 .Bx 4.2 .