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#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 72#include <stdint.h> 73#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 74 75#ifndef KERNEL 76#include <Availability.h> 77#endif 78 79/* [XSI] The timeval structure shall be defined as described in 80 * <sys/time.h> 81 */ 82#include <sys/_types/_timeval.h> 83#ifdef KERNEL 84#include <sys/_types/_user32_timeval.h> 85#include <sys/_types/_user64_timeval.h> 86#endif 87 88/* The id_t type shall be defined as described in <sys/types.h> */ 89#include <sys/_types/_id_t.h> 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 __DARWIN_C_LEVEL >= __DARWIN_C_FULL 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#ifdef PRIVATE 115 116#define PRIO_DARWIN_GPU 5 /* Second argument is a PID */ 117 118#define PRIO_DARWIN_GPU_ALLOW 0x1 119#define PRIO_DARWIN_GPU_DENY 0x2 120 121#define PRIO_DARWIN_ROLE 6 /* Second argument is a PID */ 122 123#define PRIO_DARWIN_ROLE_DEFAULT 0x0 /* Default state */ 124#define PRIO_DARWIN_ROLE_UI_FOCAL 0x1 /* On screen, focal UI */ 125#define PRIO_DARWIN_ROLE_UI 0x2 /* On screen, non-focal UI */ 126#define PRIO_DARWIN_ROLE_NON_UI 0x3 /* Off screen, non-focal UI */ 127 128#endif /* PRIVATE */ 129 130/* 131 * Range limitations for the value of the third parameter to setpriority(). 132 */ 133#define PRIO_MIN -20 134#define PRIO_MAX 20 135 136/* 137 * use PRIO_DARWIN_BG to set the current thread into "background" state 138 * which lowers CPU, disk IO, and networking priorites until thread terminates 139 * or "background" state is revoked 140 */ 141#define PRIO_DARWIN_BG 0x1000 142 143/* 144 * use PRIO_DARWIN_NONUI to restrict a process's ability to make calls to 145 * the GPU. (deprecated) 146 */ 147#define PRIO_DARWIN_NONUI 0x1001 148 149#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 150 151 152 153/***** 154 * RESOURCE USAGE 155 */ 156 157/* 158 * Possible values of the first parameter to getrusage(), used to indicate 159 * the scope of the information to be returned. 160 */ 161#define RUSAGE_SELF 0 /* Current process information */ 162#define RUSAGE_CHILDREN -1 /* Current process' children */ 163 164/* 165 * A structure representing an accounting of resource utilization. The 166 * address of an instance of this structure is the second parameter to 167 * getrusage(). 168 * 169 * Note: All values other than ru_utime and ru_stime are implementaiton 170 * defined and subject to change in a future release. Their use 171 * is discouraged for standards compliant programs. 172 */ 173struct rusage { 174 struct timeval ru_utime; /* user time used (PL) */ 175 struct timeval ru_stime; /* system time used (PL) */ 176#if __DARWIN_C_LEVEL < __DARWIN_C_FULL 177 long ru_opaque[14]; /* implementation defined */ 178#else 179 /* 180 * Informational aliases for source compatibility with programs 181 * that need more information than that provided by standards, 182 * and which do not mind being OS-dependent. 183 */ 184 long ru_maxrss; /* max resident set size (PL) */ 185#define ru_first ru_ixrss /* internal: ruadd() range start */ 186 long ru_ixrss; /* integral shared memory size (NU) */ 187 long ru_idrss; /* integral unshared data (NU) */ 188 long ru_isrss; /* integral unshared stack (NU) */ 189 long ru_minflt; /* page reclaims (NU) */ 190 long ru_majflt; /* page faults (NU) */ 191 long ru_nswap; /* swaps (NU) */ 192 long ru_inblock; /* block input operations (atomic) */ 193 long ru_oublock; /* block output operations (atomic) */ 194 long ru_msgsnd; /* messages sent (atomic) */ 195 long ru_msgrcv; /* messages received (atomic) */ 196 long ru_nsignals; /* signals received (atomic) */ 197 long ru_nvcsw; /* voluntary context switches (atomic) */ 198 long ru_nivcsw; /* involuntary " */ 199#define ru_last ru_nivcsw /* internal: ruadd() range end */ 200#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 201}; 202 203#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 204/* 205 * Flavors for proc_pid_rusage(). 206 */ 207#define RUSAGE_INFO_V0 0 208#define RUSAGE_INFO_V1 1 209#define RUSAGE_INFO_V2 2 210#define RUSAGE_INFO_V3 3 211#define RUSAGE_INFO_CURRENT RUSAGE_INFO_V3 212 213typedef void *rusage_info_t; 214 215struct rusage_info_v0 { 216 uint8_t ri_uuid[16]; 217 uint64_t ri_user_time; 218 uint64_t ri_system_time; 219 uint64_t ri_pkg_idle_wkups; 220 uint64_t ri_interrupt_wkups; 221 uint64_t ri_pageins; 222 uint64_t ri_wired_size; 223 uint64_t ri_resident_size; 224 uint64_t ri_phys_footprint; 225 uint64_t ri_proc_start_abstime; 226 uint64_t ri_proc_exit_abstime; 227}; 228 229struct rusage_info_v1 { 230 uint8_t ri_uuid[16]; 231 uint64_t ri_user_time; 232 uint64_t ri_system_time; 233 uint64_t ri_pkg_idle_wkups; 234 uint64_t ri_interrupt_wkups; 235 uint64_t ri_pageins; 236 uint64_t ri_wired_size; 237 uint64_t ri_resident_size; 238 uint64_t ri_phys_footprint; 239 uint64_t ri_proc_start_abstime; 240 uint64_t ri_proc_exit_abstime; 241 uint64_t ri_child_user_time; 242 uint64_t ri_child_system_time; 243 uint64_t ri_child_pkg_idle_wkups; 244 uint64_t ri_child_interrupt_wkups; 245 uint64_t ri_child_pageins; 246 uint64_t ri_child_elapsed_abstime; 247}; 248 249struct rusage_info_v2 { 250 uint8_t ri_uuid[16]; 251 uint64_t ri_user_time; 252 uint64_t ri_system_time; 253 uint64_t ri_pkg_idle_wkups; 254 uint64_t ri_interrupt_wkups; 255 uint64_t ri_pageins; 256 uint64_t ri_wired_size; 257 uint64_t ri_resident_size; 258 uint64_t ri_phys_footprint; 259 uint64_t ri_proc_start_abstime; 260 uint64_t ri_proc_exit_abstime; 261 uint64_t ri_child_user_time; 262 uint64_t ri_child_system_time; 263 uint64_t ri_child_pkg_idle_wkups; 264 uint64_t ri_child_interrupt_wkups; 265 uint64_t ri_child_pageins; 266 uint64_t ri_child_elapsed_abstime; 267 uint64_t ri_diskio_bytesread; 268 uint64_t ri_diskio_byteswritten; 269}; 270 271struct rusage_info_v3 { 272 uint8_t ri_uuid[16]; 273 uint64_t ri_user_time; 274 uint64_t ri_system_time; 275 uint64_t ri_pkg_idle_wkups; 276 uint64_t ri_interrupt_wkups; 277 uint64_t ri_pageins; 278 uint64_t ri_wired_size; 279 uint64_t ri_resident_size; 280 uint64_t ri_phys_footprint; 281 uint64_t ri_proc_start_abstime; 282 uint64_t ri_proc_exit_abstime; 283 uint64_t ri_child_user_time; 284 uint64_t ri_child_system_time; 285 uint64_t ri_child_pkg_idle_wkups; 286 uint64_t ri_child_interrupt_wkups; 287 uint64_t ri_child_pageins; 288 uint64_t ri_child_elapsed_abstime; 289 uint64_t ri_diskio_bytesread; 290 uint64_t ri_diskio_byteswritten; 291 uint64_t ri_cpu_time_qos_default; 292 uint64_t ri_cpu_time_qos_maintenance; 293 uint64_t ri_cpu_time_qos_background; 294 uint64_t ri_cpu_time_qos_utility; 295 uint64_t ri_cpu_time_qos_legacy; 296 uint64_t ri_cpu_time_qos_user_initiated; 297 uint64_t ri_cpu_time_qos_user_interactive; 298 uint64_t ri_billed_system_time; 299 uint64_t ri_serviced_system_time; 300}; 301 302typedef struct rusage_info_v3 rusage_info_current; 303 304#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 305 306#ifdef KERNEL 307 308struct rusage_superset { 309 struct rusage ru; 310 rusage_info_current ri; 311}; 312 313struct rusage_info_child { 314 uint64_t ri_child_user_time; 315 uint64_t ri_child_system_time; 316 uint64_t ri_child_pkg_idle_wkups; 317 uint64_t ri_child_interrupt_wkups; 318 uint64_t ri_child_pageins; 319 uint64_t ri_child_elapsed_abstime; 320}; 321 322struct user64_rusage { 323 struct user64_timeval ru_utime; /* user time used */ 324 struct user64_timeval ru_stime; /* system time used */ 325 user64_long_t ru_maxrss; /* max resident set size */ 326 user64_long_t ru_ixrss; /* integral shared memory size */ 327 user64_long_t ru_idrss; /* integral unshared data " */ 328 user64_long_t ru_isrss; /* integral unshared stack " */ 329 user64_long_t ru_minflt; /* page reclaims */ 330 user64_long_t ru_majflt; /* page faults */ 331 user64_long_t ru_nswap; /* swaps */ 332 user64_long_t ru_inblock; /* block input operations */ 333 user64_long_t ru_oublock; /* block output operations */ 334 user64_long_t ru_msgsnd; /* messages sent */ 335 user64_long_t ru_msgrcv; /* messages received */ 336 user64_long_t ru_nsignals; /* signals received */ 337 user64_long_t ru_nvcsw; /* voluntary context switches */ 338 user64_long_t ru_nivcsw; /* involuntary " */ 339}; 340 341struct user32_rusage { 342 struct user32_timeval ru_utime; /* user time used */ 343 struct user32_timeval ru_stime; /* system time used */ 344 user32_long_t ru_maxrss; /* max resident set size */ 345 user32_long_t ru_ixrss; /* integral shared memory size */ 346 user32_long_t ru_idrss; /* integral unshared data " */ 347 user32_long_t ru_isrss; /* integral unshared stack " */ 348 user32_long_t ru_minflt; /* page reclaims */ 349 user32_long_t ru_majflt; /* page faults */ 350 user32_long_t ru_nswap; /* swaps */ 351 user32_long_t ru_inblock; /* block input operations */ 352 user32_long_t ru_oublock; /* block output operations */ 353 user32_long_t ru_msgsnd; /* messages sent */ 354 user32_long_t ru_msgrcv; /* messages received */ 355 user32_long_t ru_nsignals; /* signals received */ 356 user32_long_t ru_nvcsw; /* voluntary context switches */ 357 user32_long_t ru_nivcsw; /* involuntary " */ 358}; 359 360#endif /* KERNEL */ 361 362 363/***** 364 * RESOURCE LIMITS 365 */ 366 367/* 368 * Symbolic constants for resource limits; since all limits are representable 369 * as a type rlim_t, we are permitted to define RLIM_SAVED_* in terms of 370 * RLIM_INFINITY. 371 */ 372#define RLIM_INFINITY (((__uint64_t)1 << 63) - 1) /* no limit */ 373#define RLIM_SAVED_MAX RLIM_INFINITY /* Unrepresentable hard limit */ 374#define RLIM_SAVED_CUR RLIM_INFINITY /* Unrepresentable soft limit */ 375 376/* 377 * Possible values of the first parameter to getrlimit()/setrlimit(), to 378 * indicate for which resource the operation is being performed. 379 */ 380#define RLIMIT_CPU 0 /* cpu time per process */ 381#define RLIMIT_FSIZE 1 /* file size */ 382#define RLIMIT_DATA 2 /* data segment size */ 383#define RLIMIT_STACK 3 /* stack size */ 384#define RLIMIT_CORE 4 /* core file size */ 385#define RLIMIT_AS 5 /* address space (resident set size) */ 386#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 387#define RLIMIT_RSS RLIMIT_AS /* source compatibility alias */ 388#define RLIMIT_MEMLOCK 6 /* locked-in-memory address space */ 389#define RLIMIT_NPROC 7 /* number of processes */ 390#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 391#define RLIMIT_NOFILE 8 /* number of open files */ 392#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 393#define RLIM_NLIMITS 9 /* total number of resource limits */ 394#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 395#define _RLIMIT_POSIX_FLAG 0x1000 /* Set bit for strict POSIX */ 396 397/* 398 * A structure representing a resource limit. The address of an instance 399 * of this structure is the second parameter to getrlimit()/setrlimit(). 400 */ 401struct rlimit { 402 rlim_t rlim_cur; /* current (soft) limit */ 403 rlim_t rlim_max; /* maximum value for rlim_cur */ 404}; 405 406#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 407/* 408 * proc_rlimit_control() 409 * 410 * Resource limit flavors 411 */ 412#define RLIMIT_WAKEUPS_MONITOR 0x1 /* Configure the wakeups monitor. */ 413#define RLIMIT_CPU_USAGE_MONITOR 0x2 /* Configure the CPU usage monitor. */ 414#define RLIMIT_THREAD_CPULIMITS 0x3 /* Configure a blocking, per-thread, CPU limits. */ 415 416/* 417 * Flags for wakeups monitor control. 418 */ 419#define WAKEMON_ENABLE 0x01 420#define WAKEMON_DISABLE 0x02 421#define WAKEMON_GET_PARAMS 0x04 422#define WAKEMON_SET_DEFAULTS 0x08 423#define WAKEMON_MAKE_FATAL 0x10 /* Configure the task so that violations are fatal. */ 424/* 425 * Flags for CPU usage monitor control. 426 */ 427#define CPUMON_MAKE_FATAL 0x1000 428 429struct proc_rlimit_control_wakeupmon { 430 uint32_t wm_flags; 431 int32_t wm_rate; 432}; 433 434/* I/O type */ 435#define IOPOL_TYPE_DISK 0 436#if PRIVATE 437#define IOPOL_TYPE_VFS_HFS_CASE_SENSITIVITY 1 438#endif 439 440/* scope */ 441#define IOPOL_SCOPE_PROCESS 0 442#define IOPOL_SCOPE_THREAD 1 443#define IOPOL_SCOPE_DARWIN_BG 2 444 445/* I/O Priority */ 446#define IOPOL_DEFAULT 0 447#define IOPOL_IMPORTANT 1 448#define IOPOL_PASSIVE 2 449#define IOPOL_THROTTLE 3 450#define IOPOL_UTILITY 4 451#define IOPOL_STANDARD 5 452 453/* compatibility with older names */ 454#define IOPOL_APPLICATION IOPOL_STANDARD 455#define IOPOL_NORMAL IOPOL_IMPORTANT 456 457#if PRIVATE 458#define IOPOL_VFS_HFS_CASE_SENSITIVITY_DEFAULT 0 459#define IOPOL_VFS_HFS_CASE_SENSITIVITY_FORCE_CASE_SENSITIVE 1 460#endif 461 462#ifdef PRIVATE 463/* 464 * Structures for use in communicating via iopolicysys() between Libc and the 465 * kernel. Not to be used by user programs directly. 466 */ 467 468/* 469 * the command to iopolicysys() 470 */ 471#define IOPOL_CMD_GET 0x00000001 /* Get I/O policy */ 472#define IOPOL_CMD_SET 0x00000002 /* Set I/O policy */ 473 474/* 475 * Second parameter to iopolicysys() 476 */ 477struct _iopol_param_t { 478 int iop_scope; /* current process or a thread */ 479 int iop_iotype; 480 int iop_policy; 481}; 482 483#endif /* PRIVATE */ 484#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 485 486#ifndef KERNEL 487 488__BEGIN_DECLS 489int getpriority(int, id_t); 490#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 491int getiopolicy_np(int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0); 492#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 493int getrlimit(int, struct rlimit *) __DARWIN_ALIAS(getrlimit); 494int getrusage(int, struct rusage *); 495int setpriority(int, id_t, int); 496#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 497int setiopolicy_np(int, int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0); 498#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 499int setrlimit(int, const struct rlimit *) __DARWIN_ALIAS(setrlimit); 500__END_DECLS 501 502#endif /* !KERNEL */ 503#endif /* !_SYS_RESOURCE_H_ */ 504