File: /usr/include/sys/resource.h

Green shading in the line number column means the source is part of the translation unit, red means it is conditionally excluded. Highlighted line numbers link to the translation unit page. Highlighted macros link to the macro page.

       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: #include <Availability.h>
      76: 
      77: /* [XSI] The timeval structure shall be defined as described in
      78:  * <sys/time.h>
      79:  */
      80: #include <sys/_types/_timeval.h>
      81: 
      82: /* The id_t type shall be defined as described in <sys/types.h> */
      83: #include <sys/_types/_id_t.h>
      84: 
      85: 
      86: /*
      87:  * Resource limit type (low 63 bits, excluding the sign bit)
      88:  */
      89: typedef __uint64_t    rlim_t;
      90: 
      91: 
      92: /*****
      93:  * PRIORITY
      94:  */
      95: 
      96: /*
      97:  * Possible values of the first parameter to getpriority()/setpriority(),
      98:  * used to indicate the type of the second parameter.
      99:  */
     100: #define    PRIO_PROCESS    0        /* Second argument is a PID */
     101: #define    PRIO_PGRP    1        /* Second argument is a GID */
     102: #define    PRIO_USER    2        /* Second argument is a UID */
     103: 
     104: #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
     105: #define    PRIO_DARWIN_THREAD    3        /* Second argument is always 0 (current thread) */
     106: #define    PRIO_DARWIN_PROCESS    4        /* Second argument is a PID */
     107: 
     108: 
     109: /*
     110:  * Range limitations for the value of the third parameter to setpriority().
     111:  */
     112: #define    PRIO_MIN    -20
     113: #define    PRIO_MAX    20
     114: 
     115: /* 
     116:  * use PRIO_DARWIN_BG to set the current thread into "background" state
     117:  * which lowers CPU, disk IO, and networking priorites until thread terminates
     118:  * or "background" state is revoked
     119:  */
     120: #define PRIO_DARWIN_BG 0x1000
     121: 
     122: /*
     123:  * use PRIO_DARWIN_NONUI to restrict a process's ability to make calls to
     124:  * the GPU. (deprecated)
     125:  */
     126: #define PRIO_DARWIN_NONUI 0x1001
     127: 
     128: #endif    /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     129: 
     130: 
     131: 
     132: /*****
     133:  * RESOURCE USAGE
     134:  */
     135: 
     136: /*
     137:  * Possible values of the first parameter to getrusage(), used to indicate
     138:  * the scope of the information to be returned.
     139:  */
     140: #define    RUSAGE_SELF    0        /* Current process information */
     141: #define    RUSAGE_CHILDREN    -1        /* Current process' children */
     142: 
     143: /*
     144:  * A structure representing an accounting of resource utilization.  The
     145:  * address of an instance of this structure is the second parameter to
     146:  * getrusage().
     147:  *
     148:  * Note: All values other than ru_utime and ru_stime are implementaiton
     149:  *       defined and subject to change in a future release.  Their use
     150:  *       is discouraged for standards compliant programs.
     151:  */
     152: struct    rusage {
     153:     struct timeval ru_utime;    /* user time used (PL) */
     154:     struct timeval ru_stime;    /* system time used (PL) */
     155: #if __DARWIN_C_LEVEL < __DARWIN_C_FULL
     156:     long    ru_opaque[14];        /* implementation defined */
     157: #else
     158:     /*
     159:      * Informational aliases for source compatibility with programs
     160:      * that need more information than that provided by standards,
     161:      * and which do not mind being OS-dependent.
     162:      */
     163:     long    ru_maxrss;        /* max resident set size (PL) */
     164: #define    ru_first    ru_ixrss    /* internal: ruadd() range start */
     165:     long    ru_ixrss;        /* integral shared memory size (NU) */
     166:     long    ru_idrss;        /* integral unshared data (NU)  */
     167:     long    ru_isrss;        /* integral unshared stack (NU) */
     168:     long    ru_minflt;        /* page reclaims (NU) */
     169:     long    ru_majflt;        /* page faults (NU) */
     170:     long    ru_nswap;        /* swaps (NU) */
     171:     long    ru_inblock;        /* block input operations (atomic) */
     172:     long    ru_oublock;        /* block output operations (atomic) */
     173:     long    ru_msgsnd;        /* messages sent (atomic) */
     174:     long    ru_msgrcv;        /* messages received (atomic) */
     175:     long    ru_nsignals;        /* signals received (atomic) */
     176:     long    ru_nvcsw;        /* voluntary context switches (atomic) */
     177:     long    ru_nivcsw;        /* involuntary " */
     178: #define    ru_last        ru_nivcsw    /* internal: ruadd() range end */
     179: #endif    /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     180: };
     181: 
     182: #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
     183: /*
     184:  * Flavors for proc_pid_rusage().
     185:  */
     186: #define RUSAGE_INFO_V0    0
     187: #define RUSAGE_INFO_V1    1
     188: #define RUSAGE_INFO_V2    2
     189: #define RUSAGE_INFO_V3    3
     190: #define    RUSAGE_INFO_CURRENT RUSAGE_INFO_V3
     191: 
     192: typedef void *rusage_info_t;
     193: 
     194: struct rusage_info_v0 {
     195:     uint8_t  ri_uuid[16];
     196:     uint64_t ri_user_time;
     197:     uint64_t ri_system_time;
     198:     uint64_t ri_pkg_idle_wkups;
     199:     uint64_t ri_interrupt_wkups;
     200:     uint64_t ri_pageins;
     201:     uint64_t ri_wired_size;
     202:     uint64_t ri_resident_size;    
     203:     uint64_t ri_phys_footprint;
     204:     uint64_t ri_proc_start_abstime;
     205:     uint64_t ri_proc_exit_abstime;
     206: };
     207: 
     208: struct rusage_info_v1 {
     209:     uint8_t  ri_uuid[16];
     210:     uint64_t ri_user_time;
     211:     uint64_t ri_system_time;
     212:     uint64_t ri_pkg_idle_wkups;
     213:     uint64_t ri_interrupt_wkups;
     214:     uint64_t ri_pageins;
     215:     uint64_t ri_wired_size;
     216:     uint64_t ri_resident_size;    
     217:     uint64_t ri_phys_footprint;
     218:     uint64_t ri_proc_start_abstime;
     219:     uint64_t ri_proc_exit_abstime;
     220:     uint64_t ri_child_user_time;
     221:     uint64_t ri_child_system_time;
     222:     uint64_t ri_child_pkg_idle_wkups;
     223:     uint64_t ri_child_interrupt_wkups;
     224:     uint64_t ri_child_pageins;
     225:     uint64_t ri_child_elapsed_abstime;
     226: };
     227: 
     228: struct rusage_info_v2 {
     229:     uint8_t  ri_uuid[16];
     230:     uint64_t ri_user_time;
     231:     uint64_t ri_system_time;
     232:     uint64_t ri_pkg_idle_wkups;
     233:     uint64_t ri_interrupt_wkups;
     234:     uint64_t ri_pageins;
     235:     uint64_t ri_wired_size;
     236:     uint64_t ri_resident_size;    
     237:     uint64_t ri_phys_footprint;
     238:     uint64_t ri_proc_start_abstime;
     239:     uint64_t ri_proc_exit_abstime;
     240:     uint64_t ri_child_user_time;
     241:     uint64_t ri_child_system_time;
     242:     uint64_t ri_child_pkg_idle_wkups;
     243:     uint64_t ri_child_interrupt_wkups;
     244:     uint64_t ri_child_pageins;
     245:     uint64_t ri_child_elapsed_abstime;
     246:     uint64_t ri_diskio_bytesread;
     247:     uint64_t ri_diskio_byteswritten;
     248: };
     249: 
     250: struct rusage_info_v3 {
     251:     uint8_t  ri_uuid[16];
     252:     uint64_t ri_user_time;
     253:     uint64_t ri_system_time;
     254:     uint64_t ri_pkg_idle_wkups;
     255:     uint64_t ri_interrupt_wkups;
     256:     uint64_t ri_pageins;
     257:     uint64_t ri_wired_size;
     258:     uint64_t ri_resident_size;    
     259:     uint64_t ri_phys_footprint;
     260:     uint64_t ri_proc_start_abstime;
     261:     uint64_t ri_proc_exit_abstime;
     262:     uint64_t ri_child_user_time;
     263:     uint64_t ri_child_system_time;
     264:     uint64_t ri_child_pkg_idle_wkups;
     265:     uint64_t ri_child_interrupt_wkups;
     266:     uint64_t ri_child_pageins;
     267:     uint64_t ri_child_elapsed_abstime;
     268:     uint64_t ri_diskio_bytesread;
     269:     uint64_t ri_diskio_byteswritten;
     270:     uint64_t ri_cpu_time_qos_default;
     271:     uint64_t ri_cpu_time_qos_maintenance;
     272:     uint64_t ri_cpu_time_qos_background;
     273:     uint64_t ri_cpu_time_qos_utility;
     274:     uint64_t ri_cpu_time_qos_legacy;
     275:     uint64_t ri_cpu_time_qos_user_initiated;
     276:     uint64_t ri_cpu_time_qos_user_interactive;
     277:     uint64_t ri_billed_system_time;
     278:     uint64_t ri_serviced_system_time;
     279: };
     280: 
     281: typedef struct rusage_info_v3 rusage_info_current;
     282: 
     283: #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     284: 
     285: 
     286: 
     287: /*****
     288:  * RESOURCE LIMITS
     289:  */
     290: 
     291: /*
     292:  * Symbolic constants for resource limits; since all limits are representable
     293:  * as a type rlim_t, we are permitted to define RLIM_SAVED_* in terms of
     294:  * RLIM_INFINITY.
     295:  */
     296: #define    RLIM_INFINITY    (((__uint64_t)1 << 63) - 1)    /* no limit */
     297: #define    RLIM_SAVED_MAX    RLIM_INFINITY    /* Unrepresentable hard limit */
     298: #define    RLIM_SAVED_CUR    RLIM_INFINITY    /* Unrepresentable soft limit */
     299: 
     300: /*
     301:  * Possible values of the first parameter to getrlimit()/setrlimit(), to
     302:  * indicate for which resource the operation is being performed.
     303:  */
     304: #define    RLIMIT_CPU    0        /* cpu time per process */
     305: #define    RLIMIT_FSIZE    1        /* file size */
     306: #define    RLIMIT_DATA    2        /* data segment size */
     307: #define    RLIMIT_STACK    3        /* stack size */
     308: #define    RLIMIT_CORE    4        /* core file size */
     309: #define    RLIMIT_AS    5        /* address space (resident set size) */
     310: #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
     311: #define    RLIMIT_RSS    RLIMIT_AS    /* source compatibility alias */
     312: #define    RLIMIT_MEMLOCK    6        /* locked-in-memory address space */
     313: #define    RLIMIT_NPROC    7        /* number of processes */
     314: #endif    /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     315: #define    RLIMIT_NOFILE    8        /* number of open files */
     316: #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
     317: #define    RLIM_NLIMITS    9        /* total number of resource limits */
     318: #endif    /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     319: #define _RLIMIT_POSIX_FLAG    0x1000    /* Set bit for strict POSIX */
     320: 
     321: /*
     322:  * A structure representing a resource limit.  The address of an instance
     323:  * of this structure is the second parameter to getrlimit()/setrlimit().
     324:  */
     325: struct rlimit {
     326:     rlim_t    rlim_cur;        /* current (soft) limit */
     327:     rlim_t    rlim_max;        /* maximum value for rlim_cur */
     328: };
     329: 
     330: #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
     331: /*
     332:  * proc_rlimit_control()
     333:  *
     334:  * Resource limit flavors
     335:  */
     336: #define RLIMIT_WAKEUPS_MONITOR        0x1 /* Configure the wakeups monitor. */
     337: #define    RLIMIT_CPU_USAGE_MONITOR    0x2 /* Configure the CPU usage monitor. */
     338: #define    RLIMIT_THREAD_CPULIMITS        0x3 /* Configure a blocking, per-thread, CPU limits. */
     339: 
     340: /*
     341:  * Flags for wakeups monitor control.
     342:  */
     343: #define WAKEMON_ENABLE            0x01
     344: #define WAKEMON_DISABLE            0x02
     345: #define WAKEMON_GET_PARAMS        0x04
     346: #define WAKEMON_SET_DEFAULTS        0x08
     347: #define    WAKEMON_MAKE_FATAL        0x10 /* Configure the task so that violations are fatal. */
     348: /*
     349:  * Flags for CPU usage monitor control.
     350:  */
     351: #define    CPUMON_MAKE_FATAL        0x1000
     352: 
     353: struct proc_rlimit_control_wakeupmon {
     354:     uint32_t wm_flags;
     355:     int32_t wm_rate;
     356: };
     357: 
     358: /* I/O type */
     359: #define IOPOL_TYPE_DISK    0
     360: 
     361: /* scope */
     362: #define IOPOL_SCOPE_PROCESS   0
     363: #define IOPOL_SCOPE_THREAD    1
     364: #define IOPOL_SCOPE_DARWIN_BG 2
     365: 
     366: /* I/O Priority */
     367: #define IOPOL_DEFAULT        0
     368: #define IOPOL_IMPORTANT        1
     369: #define IOPOL_PASSIVE        2
     370: #define IOPOL_THROTTLE        3
     371: #define IOPOL_UTILITY        4
     372: #define IOPOL_STANDARD        5
     373: 
     374: /* compatibility with older names */
     375: #define IOPOL_APPLICATION       IOPOL_STANDARD
     376: #define IOPOL_NORMAL            IOPOL_IMPORTANT
     377: 
     378: 
     379: #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     380: 
     381: 
     382: __BEGIN_DECLS
     383: int    getpriority(int, id_t);
     384: #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
     385: int    getiopolicy_np(int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
     386: #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     387: int    getrlimit(int, struct rlimit *) __DARWIN_ALIAS(getrlimit);
     388: int    getrusage(int, struct rusage *);
     389: int    setpriority(int, id_t, int);
     390: #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
     391: int    setiopolicy_np(int, int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
     392: #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
     393: int    setrlimit(int, const struct rlimit *) __DARWIN_ALIAS(setrlimit);
     394: __END_DECLS
     395: 
     396: #endif    /* !_SYS_RESOURCE_H_ */
     397: