projects / unix-history / blobdiff
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
use isinf(3) and isnan(3) instead of rolling our own
[unix-history] / usr / src / lib / libc / sys / getrlimit.2
diff --git a/usr/src/lib/libc/sys/getrlimit.2 b/usr/src/lib/libc/sys/getrlimit.2
index 18636b2..e924dc4 100644 (file)
--- a/usr/src/lib/libc/sys/getrlimit.2
+++ b/usr/src/lib/libc/sys/getrlimit.2
@@ -1,144 +1,155 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 The Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.\"    @(#)getrlimit.2 6.1 (Berkeley) %G%
+.\" %sccs.include.redist.man%
 .\"
 .\"
-.TH GETRLIMIT 2 ""
-.UC 4
-.SH NAME
-getrlimit, setrlimit \- control maximum system resource consumption
-.SH SYNOPSIS
-.ft B
-.nf
-#include <sys/time.h>
-#include <sys/resource.h>
-.PP
-.ft B
-getrlimit(resource, rlp)
-int resource;
-struct rlimit *rlp;
-.PP
-.ft B
-setrlimit(resource, rlp)
-int resource;
-struct rlimit *rlp;
-.fi
-.ft R
-.SH DESCRIPTION
+.\"     @(#)getrlimit.2        6.7 (Berkeley) %G%
+.\"
+.Dd 
+.Dt GETRLIMIT 2
+.Os BSD 4
+.Sh NAME
+.Nm getrlimit ,
+.Nm setrlimit
+.Nd control maximum system resource consumption
+.Sh SYNOPSIS
+.Fd #include <sys/time.h>
+.Fd #include <sys/resource.h>
+.Ft int
+.Fn getrlimit "int resource" "struct rlimit *rlp"
+.Ft int
+.Fn setrlimit "int resource" "struct rlimit *rlp"
+.Sh DESCRIPTION
 Limits on the consumption of system resources by the current process
 and each process it creates may be obtained with the
 Limits on the consumption of system resources by the current process
 and each process it creates may be obtained with the
-.I getrlimit
+.Fn getrlimit
 call, and set with the
 call, and set with the
-.I setrlimit
+.Fn setrlimit
 call.  
 call.  
-.PP
+.Pp
 The
 The
-.I resource
+.Fa resource
 parameter is one of the following:
 parameter is one of the following:
-.TP 17
-RLIMIT_CPU
+.Bl -tag -width RLIMIT_FSIZEAA
+.It Dv RLIMIT_CPU
 the maximum amount of cpu time (in seconds) to be used by
 each process.
 the maximum amount of cpu time (in seconds) to be used by
 each process.
-.TP 17
-RLIMIT_FSIZE
-the largest size, in bytes, of any single file which may be created.
-.TP 17
-RLIMIT_DATA
+.It Dv RLIMIT_FSIZE
+the largest size, in bytes, of any single file that may be created.
+.It Dv RLIMIT_DATA
 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 data segment for a process;
 this defines how far a program may extend its break with the
-.IR sbrk (2)
+.Xr sbrk 2
 system call.
 system call.
-.TP 17
-RLIMIT_STACK
+.It Dv RLIMIT_STACK
 the maximum size, in bytes, of the stack segment for a process;
 the maximum size, in bytes, of the stack segment for a process;
-this defines how far a program's stack segment may be extended,
-either automatically by the system, or explicitly by a user with
-the 
-.IR sbrk (2)
-system call.
-.TP 17
-RLIMIT_CORE
+this defines how far a program's stack segment may be extended.
+Stack extension is performed automatically by the system.
+.It Dv RLIMIT_CORE
 the largest size, in bytes, of a 
 the largest size, in bytes, of a 
-.I core
-file which may be created.
-.TP 17
-RLIMIT_RSS
-the maximum size, in bytes, a process's resident set size may
-grow to.  This imposes a limit on the amount of physical memory
+.Xr core
+file that may be created.
+.It Dv RLIMIT_RSS
+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
 to be given to a process; if memory is tight, the system will
-prefer to take memory from processes which are exceeding their
+prefer to take memory from processes that are exceeding their
 declared resident set size.
 declared resident set size.
-.PP
-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 is exceeded), but it will be allowed
-to continue execution until it reaches the hard limit (or modifies
+.El
+.Pp
+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
 its resource limit).  The 
 its resource limit).  The 
-.I rlimit
+.Em rlimit
 structure is used to specify the hard and soft limits on a resource,
 structure is used to specify the hard and soft limits on a resource,
-.PP
-.nf
-.RS
-.DT
+.Bd -literal -offset indent
 struct rlimit {
        int     rlim_cur;       /* current (soft) limit */
        int     rlim_max;       /* hard limit */
 };
 struct rlimit {
        int     rlim_cur;       /* current (soft) limit */
        int     rlim_max;       /* hard limit */
 };
-.RE
-.fi
-.PP
+.Ed
+.Pp
 Only the super-user may raise the maximum limits.  Other users
 may only alter 
 Only the super-user may raise the maximum limits.  Other users
 may only alter 
-.I rlim_cur
+.Fa rlim_cur
 within the range from 0 to 
 within the range from 0 to 
-.I rlim_max
+.Fa rlim_max
 or (irreversibly) lower
 or (irreversibly) lower
-.IR rlim_max .
-.PP
-An \*(lqinfinite\*(rq value for a limit is defined as RLIM_INFINITY
+.Fa rlim_max .
+.Pp
+An
+.Dq infinite
+value for a limit is defined as
+.Dv RLIM_INFINITY
 (0x7\&f\&f\&f\&f\&f\&f\&f).
 (0x7\&f\&f\&f\&f\&f\&f\&f).
-.PP
+.Pp
 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;
 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;
-.I limit
+.Ic limit
 is thus a built-in command to
 is thus a built-in command to
-.IR csh (1).
-.PP
+.Xr csh 1 .
+.Pp
 The system refuses to extend the data or stack space when the limits
 would be exceeded in the normal way: a
 The system refuses to extend the data or stack space when the limits
 would be exceeded in the normal way: a
-.I break
-call fails if the data space limit is reached, or the process is
-killed when the stack limit is reached (since the stack cannot be
-extended, there is no way to send a signal!).
-.PP
-A file i/o operation which would create a file which is too large
-will cause a signal SIGXFSZ to be generated, this normally terminates
-the process, but may be caught.
-When the soft cpu time limit is exceeded, a signal SIGXCPU is sent to the
+.Xr break
+call fails if the data space limit is reached.
+When the stack limit is reached, the process receives
+a segmentation fault
+.Pq Dv SIGSEGV ;
+if this signal is not
+caught by a handler using the signal stack, this signal
+will kill the process.
+.Pp
+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
+.Dv SIGXFSZ
+to be
+generated; this normally terminates the process, but may be caught.  When
+the soft cpu time limit is exceeded, a signal
+.Dv SIGXCPU
+is sent to the
 offending process.
 offending process.
-.SH "RETURN VALUE
+.Sh RETURN VALUES
 A 0 return value indicates that the call succeeded, changing
 A 0 return value indicates that the call succeeded, changing
-or returning the resource limit.   A return value of \-1 indicates
+or returning the resource limit.   A return value of -1 indicates
 that an error occurred, and an error code is stored in the global
 that an error occurred, and an error code is stored in the global
-location \fIerrno\fP.
-.SH "ERRORS
-The possible errors are:
-.TP 15
-[EFAULT]
-The address specified for \fIrlp\fP is invalid.
-.TP 15
-[EPERM]        The limit specified to \fIsetrlimit\fP would have
+location
+.Va errno .
+.Sh ERRORS
+.Fn Getrlimit
+and
+.Fn setrlimit
+will fail if:
+.Bl -tag -width Er
+.It Bq Er EFAULT
+The address specified for
+.Fa rlp
+is invalid.
+.It Bq Er EPERM
+The limit specified to
+.Fn setrlimit
+would have
 raised the maximum limit value, and the caller is not the super-user.
 raised the maximum limit value, and the caller is not the super-user.
-.SH SEE ALSO
-csh(1), quota(2)
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr csh 1 ,
+.Xr quota 2 ,
+.Xr sigvec 2 ,
+.Xr sigstack 2
+.Sh BUGS
 There should be 
 There should be 
-.I limit
+.Ic limit
 and
 and
-.I unlimit
+.Ic unlimit
 commands in
 commands in
-.IR sh (1)
+.Xr sh 1
 as well as in
 as well as in
-.IR csh.
+.Xr csh .
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.