usr/src/man/man3head/resource.h.3head

   1 '\" te
   2 .\"  Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH RESOURCE.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 resource.h, resource \- definitions for resource operations
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBsys/resource.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBsys/resource.h\fR> header defines the symbolic constants listed below
  23 as possible values of the \fIwhich\fR argument of \fBgetpriority()\fR and
  24 \fBsetpriority()\fR. See \fBgetpriority\fR(3C).
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fBPRIO_PROCESS\fR\fR
  29 .ad
  30 .RS 16n
  31 identifies the \fIwho\fR argument as a process ID
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBPRIO_PGRP\fR\fR
  38 .ad
  39 .RS 16n
  40 identifies the \fIwho\fR argument as a process group ID
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBPRIO_USER\fR\fR
  47 .ad
  48 .RS 16n
  49 identifies the \fIwho\fR argument as a user  ID
  50 .RE
  51
  52 .sp
  53 .LP
  54 The following type is defined through \fBtypedef\fR:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBrlim_t\fR\fR
  59 .ad
  60 .RS 10n
  61 unsigned integer type used for limit values
  62 .RE
  63
  64 .sp
  65 .LP
  66 The following symbolic constants are defined:
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBRLIM_INFINITY\fR\fR
  71 .ad
  72 .RS 18n
  73 a value of \fBrlim_t\fR indicating no limit
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBRLIM_SAVED_MAX\fR\fR
  80 .ad
  81 .RS 18n
  82 a value of type \fBrlim_t\fR indicating an unrepresentable saved hard limit
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBRLIM_SAVED_CUR\fR\fR
  89 .ad
  90 .RS 18n
  91 a value of type \fBrlim_t\fR indicating an unrepresentable saved soft limit
  92 .RE
  93
  94 .sp
  95 .LP
  96 The symbolic constants listed below are defined as possible values of the
  97 \fIwho\fR parameter of \fBgetrusage()\fR. See \fBgetrusage\fR(3C).
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBRUSAGE_SELF\fR\fR
 102 .ad
 103 .RS 19n
 104 returns information about the current process
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBRUSAGE_CHILDREN\fR\fR
 111 .ad
 112 .RS 19n
 113 returns information about children of the current process
 114 .RE
 115
 116 .sp
 117 .LP
 118 The <\fBsys/resource.h\fR> header defines the \fBrlimit\fR structure, which
 119 includes  the following members:
 120 .sp
 121 .in +2
 122 .nf
 123 rlim_t rlim_cur     /* the current (soft) limit */
 124 rlim_t rlim_max     /* the hard limit */
 125 .fi
 126 .in -2
 127
 128 .sp
 129 .LP
 130 The <\fBsys/resource.h\fR> header defines the \fBrusage\fR structure, which
 131 includes the following members:
 132 .sp
 133 .in +2
 134 .nf
 135 struct timeval ru_utime     /* user time used */
 136 struct timeval ru_stime     /* system time used */
 137 .fi
 138 .in -2
 139
 140 .sp
 141 .LP
 142 The \fBtimeval\fR structure is defined as described in <\fBsys/time.h\fR>.
 143 .sp
 144 .LP
 145 The symbolic constants listed below are defined as possible values for the
 146 \fIresource\fR argument of \fBgetrlimit()\fR and \fBsetrlimit()\fR. See
 147 \fBgetrlimit\fR(2).
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBRLIMIT_CORE\fR\fR
 152 .ad
 153 .RS 17n
 154 limit on size of core dump file
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fBRLIMIT_CPU\fR\fR
 161 .ad
 162 .RS 17n
 163 limit on CPU time per process
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fBRLIMIT_DATA\fR\fR
 170 .ad
 171 .RS 17n
 172 limit on data segment size
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fBRLIMIT_FSIZE\fR\fR
 179 .ad
 180 .RS 17n
 181 limit on file size
 182 .RE
 183
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fBRLIMIT_NOFILE\fR\fR
 188 .ad
 189 .RS 17n
 190 limit on number of open files
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fBRLIMIT_STACK\fR\fR
 197 .ad
 198 .RS 17n
 199 limit on stack size
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fBRLIMIT_AS\fR\fR
 206 .ad
 207 .RS 17n
 208 limit on address space size
 209 .RE
 210
 211 .sp
 212 .LP
 213 The \fBid_t\fR type is defined through \fBtypedef\fR as described in
 214 <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD).
 215 .sp
 216 .LP
 217 Inclusion of the <\fBsys/resource.h\fR> header can also make visible all
 218 symbols from <\fBsys/time.h\fR>. See \fBtime.h\fR(3HEAD).
 219 .SH ATTRIBUTES
 220 .sp
 221 .LP
 222 See \fBattributes\fR(5) for descriptions of the following attributes:
 223 .sp
 224
 225 .sp
 226 .TS
 227 box;
 228 c | c
 229 l | l .
 230 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 231 _
 232 Interface Stability     Standard
 233 .TE
 234
 235 .SH SEE ALSO
 236 .sp
 237 .LP
 238 \fBgetrlimit\fR(2), \fBgetpriority\fR(3C), \fBtime.h\fR(3HEAD),
 239 \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)