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

   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 (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH RESOURCE.H 3HEAD "Sep 10, 2004"
  47 .SH NAME
  48 resource.h, resource \- definitions for resource operations
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBsys/resource.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBsys/resource.h\fR> header defines the symbolic constants listed below
  59 as possible values of the \fIwhich\fR argument of \fBgetpriority()\fR and
  60 \fBsetpriority()\fR. See \fBgetpriority\fR(3C).
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBPRIO_PROCESS\fR\fR
  65 .ad
  66 .RS 16n
  67 identifies the \fIwho\fR argument as a process ID
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBPRIO_PGRP\fR\fR
  74 .ad
  75 .RS 16n
  76 identifies the \fIwho\fR argument as a process group ID
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBPRIO_USER\fR\fR
  83 .ad
  84 .RS 16n
  85 identifies the \fIwho\fR argument as a user  ID
  86 .RE
  87
  88 .sp
  89 .LP
  90 The following type is defined through \fBtypedef\fR:
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBrlim_t\fR\fR
  95 .ad
  96 .RS 10n
  97 unsigned integer type used for limit values
  98 .RE
  99
 100 .sp
 101 .LP
 102 The following symbolic constants are defined:
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBRLIM_INFINITY\fR\fR
 107 .ad
 108 .RS 18n
 109 a value of \fBrlim_t\fR indicating no limit
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBRLIM_SAVED_MAX\fR\fR
 116 .ad
 117 .RS 18n
 118 a value of type \fBrlim_t\fR indicating an unrepresentable saved hard limit
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBRLIM_SAVED_CUR\fR\fR
 125 .ad
 126 .RS 18n
 127 a value of type \fBrlim_t\fR indicating an unrepresentable saved soft limit
 128 .RE
 129
 130 .sp
 131 .LP
 132 The symbolic constants listed below are defined as possible values of the
 133 \fIwho\fR parameter of \fBgetrusage()\fR. See \fBgetrusage\fR(3C).
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBRUSAGE_SELF\fR\fR
 138 .ad
 139 .RS 19n
 140 returns information about the current process
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBRUSAGE_CHILDREN\fR\fR
 147 .ad
 148 .RS 19n
 149 returns information about children of the current process
 150 .RE
 151
 152 .sp
 153 .LP
 154 The <\fBsys/resource.h\fR> header defines the \fBrlimit\fR structure, which
 155 includes  the following members:
 156 .sp
 157 .in +2
 158 .nf
 159 rlim_t rlim_cur     /* the current (soft) limit */
 160 rlim_t rlim_max     /* the hard limit */
 161 .fi
 162 .in -2
 163
 164 .sp
 165 .LP
 166 The <\fBsys/resource.h\fR> header defines the \fBrusage\fR structure, which
 167 includes the following members:
 168 .sp
 169 .in +2
 170 .nf
 171 struct timeval ru_utime     /* user time used */
 172 struct timeval ru_stime     /* system time used */
 173 .fi
 174 .in -2
 175
 176 .sp
 177 .LP
 178 The \fBtimeval\fR structure is defined as described in <\fBsys/time.h\fR>.
 179 .sp
 180 .LP
 181 The symbolic constants listed below are defined as possible values for the
 182 \fIresource\fR argument of \fBgetrlimit()\fR and \fBsetrlimit()\fR. See
 183 \fBgetrlimit\fR(2).
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fBRLIMIT_CORE\fR\fR
 188 .ad
 189 .RS 17n
 190 limit on size of core dump file
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fBRLIMIT_CPU\fR\fR
 197 .ad
 198 .RS 17n
 199 limit on CPU time per process
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fBRLIMIT_DATA\fR\fR
 206 .ad
 207 .RS 17n
 208 limit on data segment size
 209 .RE
 210
 211 .sp
 212 .ne 2
 213 .na
 214 \fB\fBRLIMIT_FSIZE\fR\fR
 215 .ad
 216 .RS 17n
 217 limit on file size
 218 .RE
 219
 220 .sp
 221 .ne 2
 222 .na
 223 \fB\fBRLIMIT_NOFILE\fR\fR
 224 .ad
 225 .RS 17n
 226 limit on number of open files
 227 .RE
 228
 229 .sp
 230 .ne 2
 231 .na
 232 \fB\fBRLIMIT_STACK\fR\fR
 233 .ad
 234 .RS 17n
 235 limit on stack size
 236 .RE
 237
 238 .sp
 239 .ne 2
 240 .na
 241 \fB\fBRLIMIT_AS\fR\fR
 242 .ad
 243 .RS 17n
 244 limit on address space size
 245 .RE
 246
 247 .sp
 248 .LP
 249 The \fBid_t\fR type is defined through \fBtypedef\fR as described in
 250 <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD).
 251 .sp
 252 .LP
 253 Inclusion of the <\fBsys/resource.h\fR> header can also make visible all
 254 symbols from <\fBsys/time.h\fR>. See \fBtime.h\fR(3HEAD).
 255 .SH ATTRIBUTES
 256 .sp
 257 .LP
 258 See \fBattributes\fR(5) for descriptions of the following attributes:
 259 .sp
 260
 261 .sp
 262 .TS
 263 box;
 264 c | c
 265 l | l .
 266 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 267 _
 268 Interface Stability     Standard
 269 .TE
 270
 271 .SH SEE ALSO
 272 .sp
 273 .LP
 274 \fBgetrlimit\fR(2), \fBgetpriority\fR(3C), \fBtime.h\fR(3HEAD),
 275 \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)