GETRLIMIT(2) BSD System Calls Manual GETRLIMIT(2)

NAME
     ggeettrrlliimmiitt, sseettrrlliimmiitt - control maximum system resource consumption

SYNOPSIS
     ##iinncclluuddee <>

     int
     ggeettrrlliimmiitt(int resource, struct rlimit *rlp);

     int
     sseettrrlliimmiitt(int resource, const struct rlimit *rlp);

DESCRIPTION
     Limits on the consumption of system resources by the current process and
     each process it creates may be obtained with the ggeettrrlliimmiitt() call, and
     set with the sseettrrlliimmiitt() call.

     The resource parameter is one of the following:

     RLIMITCORE     The largest size (in bytes) core file that may be cre-
                     ated.

     RLIMITCPU      The maximum amount of cpu time (in seconds) to be used by
                     each process.

     RLIMITDATA     The maximum size (in bytes) of the data segment for a
                     process; this defines how far a program may extend its
                     break with the sbrk(2) system call.

     RLIMITFSIZE    The largest size (in bytes) file that may be created.

     RLIMITMEMLOCK  The maximum size (in bytes) which a process may lock into
                     memory using the mlock(2) function.

     RLIMITNOFILE   The maximum number of open files for this process.

     RLIMITNPROC    The maximum number of simultaneous processes for this
                     user id.

     RLIMITRSS      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 pro-
                     cesses that are exceeding their declared resident set
                     size.

     RLIMITSTACK    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 automati-
                     cally by the system.

     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 con-
     tinue execution until it reaches the hard limit (or modifies its resource
     limit).  The rlimit structure is used to specify the hard and soft limits
     on a resource,

           struct rlimit {
                   rlimt  rlimcur;       /* current (soft) limit */
                   rlimt  rlimmax;       /* hard limit */
           };

     Only the super-user may raise the maximum limits.  Other users may only
     alter rlimcur within the range from 0 to rlimmax or (irreversibly)
     lower rlimmax.

     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; lliimmiitt is thus a built-in command
     to csh(1) and uulliimmiitt is the sh(1) equivalent.

     The system refuses to extend the data or stack space when the limits
     would be exceeded in the normal way: a break call fails if the data space
     limit is reached.  When the stack limit is reached, the process receives
     a segmentation fault (SIGSEGV); if this signal is not caught by a handler
     using the signal stack, this signal will kill the process.

     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 SIGXFSZ to be gener-
     ated; this normally terminates the process, but may be caught.  When the
     soft cpu time limit is exceeded, a signal SIGXCPU is sent to the offend-
     ing process.

RETURN VALUES
     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 location errno.

EERRRROORRSS
     The ggeettrrlliimmiitt() and sseettrrlliimmiitt() system calls will fail if:

     [EFAULT]           The address specified for rlp is invalid.

     [EINVAL]           resource is invalid.

     The sseettrrlliimmiitt() call will fail if:

     [EINVAL]           The specified limit is invalid (e.g., RLIMINFINITY or
                        lower than rlimcur).

     [EPERM]            The limit specified would have raised the maximum
                        limit value and the caller is not the super-user.

LEGACY SYNOPSIS
     ##iinncclluuddee <>
     ##iinncclluuddee <>
     ##iinncclluuddee <>

     The include files  and  are necessary.

CCOOMMPPAATTIIBBIILLIITTYY
     sseettrrlliimmiitt() now returns with errno set to EINVAL in places that histori-
     cally succeeded.  It no longer accepts "rlimcur = RLIMINFINITY" for
     RLIMNOFILE.  Use "rlimcur = min(OPENMAX, rlimmax)".

SEE ALSO
     csh(1), sh(1), quota(2), sigaction(2), sigaltstack(2), sysctl(3),
     compat(5)

HISTORY     The ggeettrrlliimmiitt() function call appeared in 4.2BSD.

4th Berkeley Distribution        June 4, 1993        4th Berkeley Distribution