lib/libcr/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 .\"
  35 .Dd June 4, 1993
  36 .Dt GETRLIMIT 2
  37 .Os
  38 .Sh NAME
  39 .Nm getrlimit ,
  40 .Nm setrlimit
  41 .Nd control maximum system resource consumption
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In sys/time.h
  47 .In sys/resource.h
  48 .Ft int
  49 .Fn getrlimit "int resource" "struct rlimit *rlp"
  50 .Ft int
  51 .Fn setrlimit "int resource" "const struct rlimit *rlp"
  52 .Sh DESCRIPTION
  53 Limits on the consumption of system resources by the current process
  54 and each process it creates may be obtained with the
  55 .Fn getrlimit
  56 call, and set with the
  57 .Fn setrlimit
  58 call.
  59 .Pp
  60 The
  61 .Fa resource
  62 parameter is one of the following:
  63 .Bl -tag -width RLIMIT_FSIZEAA
  64 .It Li RLIMIT_CORE
  65 The largest size (in bytes)
  66 .Xr core 5
  67 file that may be created.
  68 .It Li RLIMIT_CPU
  69 The maximum amount of cpu time (in seconds) to be used by
  70 each process.
  71 .It Li RLIMIT_DATA
  72 The maximum size (in bytes) of the data segment for a process;
  73 this defines how far a program may extend its break with the
  74 .Xr sbrk 2
  75 system call.
  76 .It Li RLIMIT_FSIZE
  77 The largest size (in bytes) file that may be created.
  78 .It Li RLIMIT_MEMLOCK
  79 The maximum size (in bytes) which a process may lock into memory
  80 using the
  81 .Xr mlock 2
  82 function.
  83 .It Li RLIMIT_NOFILE
  84 The maximum number of open files for this process.
  85 .It Li RLIMIT_NPROC
  86 The maximum number of simultaneous processes for this user id.
  87 .It Li RLIMIT_RSS
  88 The maximum size (in bytes) to which a process's resident set size may
  89 grow.
  90 This imposes a limit on the amount of physical memory to be given to
  91 a process; if memory is tight, the system will prefer to take memory
  92 from processes that are exceeding their declared resident set size.
  93 .It Li RLIMIT_STACK
  94 The maximum size (in bytes) of the stack segment for a process;
  95 this defines how far a program's stack segment may be extended.
  96 Stack extension is performed automatically by the system.
  97 .It Li RLIMIT_SBSIZE
  98 The maximum size (in bytes) of socket buffer usage for this user.
  99 This limits the amount of network memory, and hence the amount of
 100 mbufs, that this user may hold at any time.
 101 .El
 102 .Pp
 103 A resource limit is specified as a soft limit and a hard limit.  When a
 104 soft limit is exceeded a process may receive a signal (for example, if
 105 the cpu time or file size is exceeded), but it will be allowed to
 106 continue execution until it reaches the hard limit (or modifies
 107 its resource limit).  The
 108 .Em rlimit
 109 structure is used to specify the hard and soft limits on a resource,
 110 .Bd -literal -offset indent
 111 struct rlimit {
 112         rlim_t  rlim_cur;       /* current (soft) limit */
 113         rlim_t  rlim_max;       /* maximum value for rlim_cur */
 114 };
 115 .Ed
 116 .Pp
 117 Only the super-user may raise the maximum limits.  Other users
 118 may only alter
 119 .Fa rlim_cur
 120 within the range from 0 to
 121 .Fa rlim_max
 122 or (irreversibly) lower
 123 .Fa rlim_max .
 124 .Pp
 125 An
 126 .Dq infinite
 127 value for a limit is defined as
 128 .Dv RLIM_INFINITY .
 129 .Pp
 130 Because this information is stored in the per-process information,
 131 this system call must be executed directly by the shell if it
 132 is to affect all future processes created by the shell;
 133 .Ic limit
 134 is thus a built-in command to
 135 .Xr csh 1 .
 136 .Pp
 137 The system refuses to extend the data or stack space when the limits
 138 would be exceeded in the normal way: a
 139 .Xr brk 2
 140 call fails if the data space limit is reached.
 141 When the stack limit is reached, the process receives
 142 a segmentation fault
 143 .Pq Dv SIGSEGV ;
 144 if this signal is not
 145 caught by a handler using the signal stack, this signal
 146 will kill the process.
 147 .Pp
 148 A file I/O operation that would create a file larger that the process'
 149 soft limit will cause the write to fail and a signal
 150 .Dv SIGXFSZ
 151 to be
 152 generated; this normally terminates the process, but may be caught.  When
 153 the soft cpu time limit is exceeded, a signal
 154 .Dv SIGXCPU
 155 is sent to the
 156 offending process.
 157 .Sh RETURN VALUES
 158 .Rv -std
 159 .Sh ERRORS
 160 .Fn Getrlimit
 161 and
 162 .Fn setrlimit
 163 will fail if:
 164 .Bl -tag -width Er
 165 .It Bq Er EFAULT
 166 The address specified for
 167 .Fa rlp
 168 is invalid.
 169 .It Bq Er EPERM
 170 The limit specified to
 171 .Fn setrlimit
 172 would have
 173 raised the maximum limit value, and the caller is not the super-user.
 174 .El
 175 .Sh SEE ALSO
 176 .Xr csh 1 ,
 177 .Xr quota 1 ,
 178 .Xr quotactl 2 ,
 179 .Xr sigaltstack 2 ,
 180 .Xr sigvec 2 ,
 181 .Xr sysctl 3
 182 .Sh HISTORY
 183 The
 184 .Fn getrlimit
 185 function call appeared in
 186 .Bx 4.2 .