usr/src/man/man2/ulimit.2

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  45 .\" Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH ULIMIT 2 "Feb 1, 2003"
  48 .SH NAME
  49 ulimit \- get and set process limits
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <ulimit.h>
  54
  55 \fBlong\fR \fBulimit\fR(\fBint\fR \fIcmd\fR, \fB/*\fR \fInewlimit\fR */...);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBulimit()\fR function provides for control over process limits. It is
  62 effective in limiting the growth of regular files. Pipes are limited to
  63 \fBPIPE_MAX\fR bytes.
  64 .sp
  65 .LP
  66 The \fIcmd\fR values, defined in <\fBulimit.h\fR>, include:
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBUL_GETFSIZE\fR\fR
  71 .ad
  72 .RS 15n
  73 Return the soft file size limit of the process. The limit is in units of
  74 512-byte blocks and is inherited by child processes. Files of any size can be
  75 read. The return value is the integer part of the soft file size limit divided
  76 by 512.  If the result cannot be represented as a \fBlong int\fR, the result is
  77 unspecified.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBUL_SETFSIZE\fR\fR
  84 .ad
  85 .RS 15n
  86 Set the hard and soft file size limits for output operations of the process to
  87 the value of the second argument, taken as a \fBlong int\fR. Any process may
  88 decrease its own hard limit, but only a process with appropriate privileges may
  89 increase the limit. The new file size limit is returned. The hard and soft file
  90 size limits are set to the specified value multiplied by 512.  If the result
  91 would overflow an \fBrlimit_t\fR, the actual value set is unspecified.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBUL_GMEMLIM\fR\fR
  98 .ad
  99 .RS 15n
 100 Get the maximum possible break value (see \fBbrk\fR(2)).
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBUL_GDESLIM\fR\fR
 107 .ad
 108 .RS 15n
 109 Get the current value of the maximum number of open files per process
 110 configured in the system.
 111 .RE
 112
 113 .SH RETURN VALUES
 114 .sp
 115 .LP
 116 Upon successful completion, \fBulimit()\fR returns the value of the requested
 117 limit.  Otherwise, \fB\(mi1\fR is returned, the limit is not changed, and
 118 \fBerrno\fR is set to indicate the error.
 119 .SH ERRORS
 120 .sp
 121 .LP
 122 The \fBulimit()\fR function will fail if:
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBEINVAL\fR\fR
 127 .ad
 128 .RS 10n
 129 The \fIcmd\fR argument is not valid.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBEPERM\fR\fR
 136 .ad
 137 .RS 10n
 138 A process that has not asserted {\fBPRIV_SYS_RESOURCE\fR} in its effective set
 139 is trying to increase its file size limit.
 140 .RE
 141
 142 .SH USAGE
 143 .sp
 144 .LP
 145 Since all return values are permissible in a successful situation, an
 146 application wishing to check for error situations should set \fBerrno\fR to 0,
 147 then call \fBulimit()\fR, and if it returns \fB\(mi1\fR, check if \fBerrno\fR
 148 is non-zero.
 149 .sp
 150 .LP
 151 The \fBgetrlimit()\fR and \fBsetrlimit()\fR functions provide a more general
 152 interface for controlling process limits, and are preferred over
 153 \fBulimit()\fR. See \fBgetrlimit\fR(2).
 154 .SH ATTRIBUTES
 155 .sp
 156 .LP
 157 See \fBattributes\fR(5) for descriptions of the following attributes:
 158 .sp
 159
 160 .sp
 161 .TS
 162 box;
 163 c | c
 164 l | l .
 165 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 166 _
 167 Interface Stability     Standard
 168 .TE
 169
 170 .SH SEE ALSO
 171 .sp
 172 .LP
 173 \fBbrk\fR(2), \fBgetrlimit\fR(2), \fBwrite\fR(2), \fBattributes\fR(5),
 174 \fBprivileges\fR(5), \fBstandards\fR(5)