1/* 2 * Copyright (c) 2000-2008 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */ 29/* 30 * Copyright (c) 1982, 1986, 1993 31 * The Regents of the University of California. All rights reserved. 32 * 33 * Redistribution and use in source and binary forms, with or without 34 * modification, are permitted provided that the following conditions 35 * are met: 36 * 1. Redistributions of source code must retain the above copyright 37 * notice, this list of conditions and the following disclaimer. 38 * 2. Redistributions in binary form must reproduce the above copyright 39 * notice, this list of conditions and the following disclaimer in the 40 * documentation and/or other materials provided with the distribution. 41 * 3. All advertising materials mentioning features or use of this software 42 * must display the following acknowledgement: 43 * This product includes software developed by the University of 44 * California, Berkeley and its contributors. 45 * 4. Neither the name of the University nor the names of its contributors 46 * may be used to endorse or promote products derived from this software 47 * without specific prior written permission. 48 * 49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 59 * SUCH DAMAGE. 60 * 61 * @(#)resource.h 8.2 (Berkeley) 1/4/94 62 */ 63 64#ifndef _SYS_RESOURCE_H_ 65#define _SYS_RESOURCE_H_ 66 67#include <sys/appleapiopts.h> 68#include <sys/cdefs.h> 69#include <sys/_types.h> 70 71#ifndef KERNEL 72#include <Availability.h> 73#endif 74 75/* [XSI] The timeval structure shall be defined as described in 76 * <sys/time.h> 77 */ 78#define __need_struct_timeval 79#ifdef KERNEL 80#define __need_struct_user32_timeval 81#define __need_struct_user64_timeval 82#endif 83#include <sys/_structs.h> 84 85/* The id_t type shall be defined as described in <sys/types.h> */ 86#ifndef _ID_T 87#define _ID_T 88typedef __darwin_id_t id_t; /* can hold pid_t, gid_t, or uid_t */ 89#endif 90 91 92/* 93 * Resource limit type (low 63 bits, excluding the sign bit) 94 */ 95typedef __uint64_t rlim_t; 96 97 98/***** 99 * PRIORITY 100 */ 101 102/* 103 * Possible values of the first parameter to getpriority()/setpriority(), 104 * used to indicate the type of the second parameter. 105 */ 106#define PRIO_PROCESS 0 /* Second argument is a PID */ 107#define PRIO_PGRP 1 /* Second argument is a GID */ 108#define PRIO_USER 2 /* Second argument is a UID */ 109 110#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 111#define PRIO_DARWIN_THREAD 3 /* Second argument is always 0 (current thread) */ 112#define PRIO_DARWIN_PROCESS 4 /* Second argument is a PID */ 113 114/* 115 * Range limitations for the value of the third parameter to setpriority(). 116 */ 117#define PRIO_MIN -20 118#define PRIO_MAX 20 119 120/* 121 * use PRIO_DARWIN_BG to set the current thread into "background" state 122 * which lowers CPU, disk IO, and networking priorites until thread terminates 123 * or "background" state is revoked 124 */ 125#define PRIO_DARWIN_BG 0x1000 126 127/* 128 * use PRIO_DARWIN_NONUI to restrict a process's ability to make calls to 129 * the GPU. 130 */ 131#define PRIO_DARWIN_NONUI 0x1001 132 133#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */ 134 135 136 137/***** 138 * RESOURCE USAGE 139 */ 140 141/* 142 * Possible values of the first parameter to getrusage(), used to indicate 143 * the scope of the information to be returned. 144 */ 145#define RUSAGE_SELF 0 /* Current process information */ 146#define RUSAGE_CHILDREN -1 /* Current process' children */ 147 148/* 149 * A structure representing an accounting of resource utilization. The 150 * address of an instance of this structure is the second parameter to 151 * getrusage(). 152 * 153 * Note: All values other than ru_utime and ru_stime are implementaiton 154 * defined and subject to change in a future release. Their use 155 * is discouraged for standards compliant programs. 156 */ 157struct rusage { 158 struct timeval ru_utime; /* user time used (PL) */ 159 struct timeval ru_stime; /* system time used (PL) */ 160#if defined(_POSIX_C_SOURCE) && !defined(_DARWIN_C_SOURCE) 161 long ru_opaque[14]; /* implementation defined */ 162#else /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */ 163 /* 164 * Informational aliases for source compatibility with programs 165 * that need more information than that provided by standards, 166 * and which do not mind being OS-dependent. 167 */ 168 long ru_maxrss; /* max resident set size (PL) */ 169#define ru_first ru_ixrss /* internal: ruadd() range start */ 170 long ru_ixrss; /* integral shared memory size (NU) */ 171 long ru_idrss; /* integral unshared data (NU) */ 172 long ru_isrss; /* integral unshared stack (NU) */ 173 long ru_minflt; /* page reclaims (NU) */ 174 long ru_majflt; /* page faults (NU) */ 175 long ru_nswap; /* swaps (NU) */ 176 long ru_inblock; /* block input operations (atomic) */ 177 long ru_oublock; /* block output operations (atomic) */ 178 long ru_msgsnd; /* messages sent (atomic) */ 179 long ru_msgrcv; /* messages received (atomic) */ 180 long ru_nsignals; /* signals received (atomic) */ 181 long ru_nvcsw; /* voluntary context switches (atomic) */ 182 long ru_nivcsw; /* involuntary " */ 183#define ru_last ru_nivcsw /* internal: ruadd() range end */ 184#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */ 185}; 186 187 188#ifdef KERNEL 189 190struct user64_rusage { 191 struct user64_timeval ru_utime; /* user time used */ 192 struct user64_timeval ru_stime; /* system time used */ 193 user64_long_t ru_maxrss; /* max resident set size */ 194 user64_long_t ru_ixrss; /* integral shared memory size */ 195 user64_long_t ru_idrss; /* integral unshared data " */ 196 user64_long_t ru_isrss; /* integral unshared stack " */ 197 user64_long_t ru_minflt; /* page reclaims */ 198 user64_long_t ru_majflt; /* page faults */ 199 user64_long_t ru_nswap; /* swaps */ 200 user64_long_t ru_inblock; /* block input operations */ 201 user64_long_t ru_oublock; /* block output operations */ 202 user64_long_t ru_msgsnd; /* messages sent */ 203 user64_long_t ru_msgrcv; /* messages received */ 204 user64_long_t ru_nsignals; /* signals received */ 205 user64_long_t ru_nvcsw; /* voluntary context switches */ 206 user64_long_t ru_nivcsw; /* involuntary " */ 207}; 208 209struct user32_rusage { 210 struct user32_timeval ru_utime; /* user time used */ 211 struct user32_timeval ru_stime; /* system time used */ 212 user32_long_t ru_maxrss; /* max resident set size */ 213 user32_long_t ru_ixrss; /* integral shared memory size */ 214 user32_long_t ru_idrss; /* integral unshared data " */ 215 user32_long_t ru_isrss; /* integral unshared stack " */ 216 user32_long_t ru_minflt; /* page reclaims */ 217 user32_long_t ru_majflt; /* page faults */ 218 user32_long_t ru_nswap; /* swaps */ 219 user32_long_t ru_inblock; /* block input operations */ 220 user32_long_t ru_oublock; /* block output operations */ 221 user32_long_t ru_msgsnd; /* messages sent */ 222 user32_long_t ru_msgrcv; /* messages received */ 223 user32_long_t ru_nsignals; /* signals received */ 224 user32_long_t ru_nvcsw; /* voluntary context switches */ 225 user32_long_t ru_nivcsw; /* involuntary " */ 226}; 227 228#endif /* KERNEL */ 229 230 231/***** 232 * RESOURCE LIMITS 233 */ 234 235/* 236 * Symbolic constants for resource limits; since all limits are representable 237 * as a type rlim_t, we are permitted to define RLIM_SAVED_* in terms of 238 * RLIM_INFINITY. 239 */ 240#define RLIM_INFINITY (((__uint64_t)1 << 63) - 1) /* no limit */ 241#define RLIM_SAVED_MAX RLIM_INFINITY /* Unrepresentable hard limit */ 242#define RLIM_SAVED_CUR RLIM_INFINITY /* Unrepresentable soft limit */ 243 244/* 245 * Possible values of the first parameter to getrlimit()/setrlimit(), to 246 * indicate for which resource the operation is being performed. 247 */ 248#define RLIMIT_CPU 0 /* cpu time per process */ 249#define RLIMIT_FSIZE 1 /* file size */ 250#define RLIMIT_DATA 2 /* data segment size */ 251#define RLIMIT_STACK 3 /* stack size */ 252#define RLIMIT_CORE 4 /* core file size */ 253#define RLIMIT_AS 5 /* address space (resident set size) */ 254#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 255#define RLIMIT_RSS RLIMIT_AS /* source compatibility alias */ 256#define RLIMIT_MEMLOCK 6 /* locked-in-memory address space */ 257#define RLIMIT_NPROC 7 /* number of processes */ 258#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */ 259#define RLIMIT_NOFILE 8 /* number of open files */ 260#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 261#define RLIM_NLIMITS 9 /* total number of resource limits */ 262#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */ 263#define _RLIMIT_POSIX_FLAG 0x1000 /* Set bit for strict POSIX */ 264 265/* 266 * A structure representing a resource limit. The address of an instance 267 * of this structure is the second parameter to getrlimit()/setrlimit(). 268 */ 269struct rlimit { 270 rlim_t rlim_cur; /* current (soft) limit */ 271 rlim_t rlim_max; /* maximum value for rlim_cur */ 272}; 273 274#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 275/* I/O type */ 276#define IOPOL_TYPE_DISK 0 277 278/* scope */ 279#define IOPOL_SCOPE_PROCESS 0 280#define IOPOL_SCOPE_THREAD 1 281 282/* I/O Priority */ 283#define IOPOL_DEFAULT 0 284#define IOPOL_NORMAL 1 285#define IOPOL_PASSIVE 2 286#define IOPOL_THROTTLE 3 287#define IOPOL_UTILITY 4 288 289#ifdef PRIVATE 290/* 291 * Structures for use in communicating via iopolicysys() between Lic and the 292 * kernel. Not to be used by uesr programs directly. 293 */ 294 295/* 296 * the command to iopolicysys() 297 */ 298#define IOPOL_CMD_GET 0x00000001 /* Get I/O policy */ 299#define IOPOL_CMD_SET 0x00000002 /* Set I/O policy */ 300 301/* 302 * Second parameter to iopolicysys() 303 */ 304struct _iopol_param_t { 305 int iop_scope; /* current process or a thread */ 306 int iop_iotype; 307 int iop_policy; 308}; 309 310#endif /* PRIVATE */ 311#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */ 312 313#ifndef KERNEL 314 315__BEGIN_DECLS 316int getpriority(int, id_t); 317#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 318int getiopolicy_np(int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0); 319#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */ 320int getrlimit(int, struct rlimit *) __DARWIN_ALIAS(getrlimit); 321int getrusage(int, struct rusage *); 322int setpriority(int, id_t, int); 323#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 324int setiopolicy_np(int, int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0); 325#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */ 326int setrlimit(int, const struct rlimit *) __DARWIN_ALIAS(setrlimit); 327__END_DECLS 328 329#endif /* !KERNEL */ 330#endif /* !_SYS_RESOURCE_H_ */ 331