]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/resource.h
xnu-4903.270.47.tar.gz
[apple/xnu.git] / bsd / sys / resource.h
index 55b553a1b48164f3dab7a0e4d5356101a07c7bd8..357768313cbb0bba7aa4ac9f21d2f9cbfb0c6ef2 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 2000-2018 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
- * 
+ *
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
- * 
+ *
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
- * 
+ *
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
@@ -22,7 +22,7 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
- * 
+ *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
@@ -62,7 +62,7 @@
  */
 
 #ifndef _SYS_RESOURCE_H_
-#define        _SYS_RESOURCE_H_
+#define _SYS_RESOURCE_H_
 
 #include <sys/appleapiopts.h>
 #include <sys/cdefs.h>
@@ -92,7 +92,7 @@
 /*
  * Resource limit type (low 63 bits, excluding the sign bit)
  */
-typedef __uint64_t     rlim_t;
+typedef __uint64_t      rlim_t;
 
 
 /*****
@@ -103,17 +103,17 @@ typedef __uint64_t        rlim_t;
  * Possible values of the first parameter to getpriority()/setpriority(),
  * used to indicate the type of the second parameter.
  */
-#define        PRIO_PROCESS    0               /* Second argument is a PID */
-#define        PRIO_PGRP       1               /* Second argument is a GID */
-#define        PRIO_USER       2               /* Second argument is a UID */
+#define PRIO_PROCESS    0               /* Second argument is a PID */
+#define PRIO_PGRP       1               /* Second argument is a GID */
+#define PRIO_USER       2               /* Second argument is a UID */
 
 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
-#define        PRIO_DARWIN_THREAD      3               /* Second argument is always 0 (current thread) */
-#define        PRIO_DARWIN_PROCESS     4               /* Second argument is a PID */
+#define PRIO_DARWIN_THREAD      3               /* Second argument is always 0 (current thread) */
+#define PRIO_DARWIN_PROCESS     4               /* Second argument is a PID */
 
 #ifdef PRIVATE
 
-#define PRIO_DARWIN_GPU                5               /* Second argument is a PID */
+#define PRIO_DARWIN_GPU         5               /* Second argument is a PID */
 
 #define PRIO_DARWIN_GPU_ALLOW   0x1
 #define PRIO_DARWIN_GPU_DENY    0x2
@@ -133,10 +133,10 @@ typedef __uint64_t        rlim_t;
 /*
  * Range limitations for the value of the third parameter to setpriority().
  */
-#define        PRIO_MIN        -20
-#define        PRIO_MAX        20
+#define PRIO_MIN        -20
+#define PRIO_MAX        20
 
-/* 
+/*
  * use PRIO_DARWIN_BG to set the current thread into "background" state
  * which lowers CPU, disk IO, and networking priorites until thread terminates
  * or "background" state is revoked
@@ -149,7 +149,7 @@ typedef __uint64_t  rlim_t;
  */
 #define PRIO_DARWIN_NONUI 0x1001
 
-#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
+#endif  /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 
 
 
@@ -161,8 +161,8 @@ typedef __uint64_t  rlim_t;
  * Possible values of the first parameter to getrusage(), used to indicate
  * the scope of the information to be returned.
  */
-#define        RUSAGE_SELF     0               /* Current process information */
-#define        RUSAGE_CHILDREN -1              /* Current process' children */
+#define RUSAGE_SELF     0               /* Current process information */
+#define RUSAGE_CHILDREN -1              /* Current process' children */
 
 /*
  * A structure representing an accounting of resource utilization.  The
@@ -173,46 +173,46 @@ typedef __uint64_t        rlim_t;
  *       defined and subject to change in a future release.  Their use
  *       is discouraged for standards compliant programs.
  */
-struct rusage {
-       struct timeval ru_utime;        /* user time used (PL) */
-       struct timeval ru_stime;        /* system time used (PL) */
+struct  rusage {
+       struct timeval ru_utime;        /* user time used (PL) */
+       struct timeval ru_stime;        /* system time used (PL) */
 #if __DARWIN_C_LEVEL < __DARWIN_C_FULL
-       long    ru_opaque[14];          /* implementation defined */
+       long    ru_opaque[14];          /* implementation defined */
 #else
        /*
         * Informational aliases for source compatibility with programs
         * that need more information than that provided by standards,
         * and which do not mind being OS-dependent.
         */
-       long    ru_maxrss;              /* max resident set size (PL) */
-#define        ru_first        ru_ixrss        /* internal: ruadd() range start */
-       long    ru_ixrss;               /* integral shared memory size (NU) */
-       long    ru_idrss;               /* integral unshared data (NU)  */
-       long    ru_isrss;               /* integral unshared stack (NU) */
-       long    ru_minflt;              /* page reclaims (NU) */
-       long    ru_majflt;              /* page faults (NU) */
-       long    ru_nswap;               /* swaps (NU) */
-       long    ru_inblock;             /* block input operations (atomic) */
-       long    ru_oublock;             /* block output operations (atomic) */
-       long    ru_msgsnd;              /* messages sent (atomic) */
-       long    ru_msgrcv;              /* messages received (atomic) */
-       long    ru_nsignals;            /* signals received (atomic) */
-       long    ru_nvcsw;               /* voluntary context switches (atomic) */
-       long    ru_nivcsw;              /* involuntary " */
-#define        ru_last         ru_nivcsw       /* internal: ruadd() range end */
-#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
+       long    ru_maxrss;              /* max resident set size (PL) */
+#define ru_first        ru_ixrss        /* internal: ruadd() range start */
+       long    ru_ixrss;               /* integral shared memory size (NU) */
+       long    ru_idrss;               /* integral unshared data (NU)  */
+       long    ru_isrss;               /* integral unshared stack (NU) */
+       long    ru_minflt;              /* page reclaims (NU) */
+       long    ru_majflt;              /* page faults (NU) */
+       long    ru_nswap;               /* swaps (NU) */
+       long    ru_inblock;             /* block input operations (atomic) */
+       long    ru_oublock;             /* block output operations (atomic) */
+       long    ru_msgsnd;              /* messages sent (atomic) */
+       long    ru_msgrcv;              /* messages received (atomic) */
+       long    ru_nsignals;            /* signals received (atomic) */
+       long    ru_nvcsw;               /* voluntary context switches (atomic) */
+       long    ru_nivcsw;              /* involuntary " */
+#define ru_last         ru_nivcsw       /* internal: ruadd() range end */
+#endif  /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 };
 
 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
 /*
  * Flavors for proc_pid_rusage().
  */
-#define RUSAGE_INFO_V0 0
-#define RUSAGE_INFO_V1 1
-#define RUSAGE_INFO_V2 2
-#define RUSAGE_INFO_V3 3
-#define RUSAGE_INFO_V4 4
-#define RUSAGE_INFO_CURRENT    RUSAGE_INFO_V4
+#define RUSAGE_INFO_V0  0
+#define RUSAGE_INFO_V1  1
+#define RUSAGE_INFO_V2  2
+#define RUSAGE_INFO_V3  3
+#define RUSAGE_INFO_V4  4
+#define RUSAGE_INFO_CURRENT     RUSAGE_INFO_V4
 
 typedef void *rusage_info_t;
 
@@ -338,7 +338,7 @@ struct rusage_info_v4 {
        uint64_t ri_cycles;
        uint64_t ri_billed_energy;
        uint64_t ri_serviced_energy;
-        uint64_t ri_interval_max_phys_footprint; 
+       uint64_t ri_interval_max_phys_footprint;
        // 1 reserve counter(s) remaining for future extension
        uint64_t ri_unused[1];
 };
@@ -350,8 +350,8 @@ typedef struct rusage_info_v4 rusage_info_current;
 #ifdef KERNEL
 
 struct rusage_superset {
-       struct rusage                   ru;
-       rusage_info_current     ri;
+       struct rusage                   ru;
+       rusage_info_current     ri;
 };
 
 struct rusage_info_child {
@@ -363,42 +363,42 @@ struct rusage_info_child {
        uint64_t ri_child_elapsed_abstime;
 };
 
-struct user64_rusage {
-       struct user64_timeval ru_utime; /* user time used */
-       struct user64_timeval ru_stime; /* system time used */
-       user64_long_t   ru_maxrss;              /* max resident set size */
-       user64_long_t   ru_ixrss;               /* integral shared memory size */
-       user64_long_t   ru_idrss;               /* integral unshared data " */
-       user64_long_t   ru_isrss;               /* integral unshared stack " */
-       user64_long_t   ru_minflt;              /* page reclaims */
-       user64_long_t   ru_majflt;              /* page faults */
-       user64_long_t   ru_nswap;               /* swaps */
-       user64_long_t   ru_inblock;             /* block input operations */
-       user64_long_t   ru_oublock;             /* block output operations */
-       user64_long_t   ru_msgsnd;              /* messages sent */
-       user64_long_t   ru_msgrcv;              /* messages received */
-       user64_long_t   ru_nsignals;    /* signals received */
-       user64_long_t   ru_nvcsw;               /* voluntary context switches */
-       user64_long_t   ru_nivcsw;              /* involuntary " */
+struct  user64_rusage {
+       struct user64_timeval ru_utime; /* user time used */
+       struct user64_timeval ru_stime; /* system time used */
+       user64_long_t   ru_maxrss;              /* max resident set size */
+       user64_long_t   ru_ixrss;               /* integral shared memory size */
+       user64_long_t   ru_idrss;               /* integral unshared data " */
+       user64_long_t   ru_isrss;               /* integral unshared stack " */
+       user64_long_t   ru_minflt;              /* page reclaims */
+       user64_long_t   ru_majflt;              /* page faults */
+       user64_long_t   ru_nswap;               /* swaps */
+       user64_long_t   ru_inblock;             /* block input operations */
+       user64_long_t   ru_oublock;             /* block output operations */
+       user64_long_t   ru_msgsnd;              /* messages sent */
+       user64_long_t   ru_msgrcv;              /* messages received */
+       user64_long_t   ru_nsignals;    /* signals received */
+       user64_long_t   ru_nvcsw;               /* voluntary context switches */
+       user64_long_t   ru_nivcsw;              /* involuntary " */
 };
 
-struct user32_rusage {
-       struct user32_timeval ru_utime; /* user time used */
-       struct user32_timeval ru_stime; /* system time used */
-       user32_long_t   ru_maxrss;              /* max resident set size */
-       user32_long_t   ru_ixrss;               /* integral shared memory size */
-       user32_long_t   ru_idrss;               /* integral unshared data " */
-       user32_long_t   ru_isrss;               /* integral unshared stack " */
-       user32_long_t   ru_minflt;              /* page reclaims */
-       user32_long_t   ru_majflt;              /* page faults */
-       user32_long_t   ru_nswap;               /* swaps */
-       user32_long_t   ru_inblock;             /* block input operations */
-       user32_long_t   ru_oublock;             /* block output operations */
-       user32_long_t   ru_msgsnd;              /* messages sent */
-       user32_long_t   ru_msgrcv;              /* messages received */
-       user32_long_t   ru_nsignals;    /* signals received */
-       user32_long_t   ru_nvcsw;               /* voluntary context switches */
-       user32_long_t   ru_nivcsw;              /* involuntary " */
+struct  user32_rusage {
+       struct user32_timeval ru_utime; /* user time used */
+       struct user32_timeval ru_stime; /* system time used */
+       user32_long_t   ru_maxrss;              /* max resident set size */
+       user32_long_t   ru_ixrss;               /* integral shared memory size */
+       user32_long_t   ru_idrss;               /* integral unshared data " */
+       user32_long_t   ru_isrss;               /* integral unshared stack " */
+       user32_long_t   ru_minflt;              /* page reclaims */
+       user32_long_t   ru_majflt;              /* page faults */
+       user32_long_t   ru_nswap;               /* swaps */
+       user32_long_t   ru_inblock;             /* block input operations */
+       user32_long_t   ru_oublock;             /* block output operations */
+       user32_long_t   ru_msgsnd;              /* messages sent */
+       user32_long_t   ru_msgrcv;              /* messages received */
+       user32_long_t   ru_nsignals;    /* signals received */
+       user32_long_t   ru_nvcsw;               /* voluntary context switches */
+       user32_long_t   ru_nivcsw;              /* involuntary " */
 };
 
 #endif /* KERNEL */
@@ -413,38 +413,38 @@ struct    user32_rusage {
  * as a type rlim_t, we are permitted to define RLIM_SAVED_* in terms of
  * RLIM_INFINITY.
  */
-#define        RLIM_INFINITY   (((__uint64_t)1 << 63) - 1)     /* no limit */
-#define        RLIM_SAVED_MAX  RLIM_INFINITY   /* Unrepresentable hard limit */
-#define        RLIM_SAVED_CUR  RLIM_INFINITY   /* Unrepresentable soft limit */
+#define RLIM_INFINITY   (((__uint64_t)1 << 63) - 1)     /* no limit */
+#define RLIM_SAVED_MAX  RLIM_INFINITY   /* Unrepresentable hard limit */
+#define RLIM_SAVED_CUR  RLIM_INFINITY   /* Unrepresentable soft limit */
 
 /*
  * Possible values of the first parameter to getrlimit()/setrlimit(), to
  * indicate for which resource the operation is being performed.
  */
-#define        RLIMIT_CPU      0               /* cpu time per process */
-#define        RLIMIT_FSIZE    1               /* file size */
-#define        RLIMIT_DATA     2               /* data segment size */
-#define        RLIMIT_STACK    3               /* stack size */
-#define        RLIMIT_CORE     4               /* core file size */
-#define        RLIMIT_AS       5               /* address space (resident set size) */
+#define RLIMIT_CPU      0               /* cpu time per process */
+#define RLIMIT_FSIZE    1               /* file size */
+#define RLIMIT_DATA     2               /* data segment size */
+#define RLIMIT_STACK    3               /* stack size */
+#define RLIMIT_CORE     4               /* core file size */
+#define RLIMIT_AS       5               /* address space (resident set size) */
 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
-#define        RLIMIT_RSS      RLIMIT_AS       /* source compatibility alias */
-#define        RLIMIT_MEMLOCK  6               /* locked-in-memory address space */
-#define        RLIMIT_NPROC    7               /* number of processes */
-#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
-#define        RLIMIT_NOFILE   8               /* number of open files */
+#define RLIMIT_RSS      RLIMIT_AS       /* source compatibility alias */
+#define RLIMIT_MEMLOCK  6               /* locked-in-memory address space */
+#define RLIMIT_NPROC    7               /* number of processes */
+#endif  /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
+#define RLIMIT_NOFILE   8               /* number of open files */
 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
-#define        RLIM_NLIMITS    9               /* total number of resource limits */
-#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
-#define _RLIMIT_POSIX_FLAG     0x1000  /* Set bit for strict POSIX */
+#define RLIM_NLIMITS    9               /* total number of resource limits */
+#endif  /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
+#define _RLIMIT_POSIX_FLAG      0x1000  /* Set bit for strict POSIX */
 
 /*
  * A structure representing a resource limit.  The address of an instance
  * of this structure is the second parameter to getrlimit()/setrlimit().
  */
 struct rlimit {
-       rlim_t  rlim_cur;               /* current (soft) limit */
-       rlim_t  rlim_max;               /* maximum value for rlim_cur */
+       rlim_t  rlim_cur;               /* current (soft) limit */
+       rlim_t  rlim_max;               /* maximum value for rlim_cur */
 };
 
 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
@@ -453,29 +453,29 @@ struct rlimit {
  *
  * Resource limit flavors
  */
-#define RLIMIT_WAKEUPS_MONITOR         0x1 /* Configure the wakeups monitor. */
-#define        RLIMIT_CPU_USAGE_MONITOR        0x2 /* Configure the CPU usage monitor. */
-#define        RLIMIT_THREAD_CPULIMITS         0x3 /* Configure a blocking, per-thread, CPU limits. */
-#define        RLIMIT_FOOTPRINT_INTERVAL       0x4 /* Configure memory footprint interval tracking */
+#define RLIMIT_WAKEUPS_MONITOR          0x1 /* Configure the wakeups monitor. */
+#define RLIMIT_CPU_USAGE_MONITOR        0x2 /* Configure the CPU usage monitor. */
+#define RLIMIT_THREAD_CPULIMITS         0x3 /* Configure a blocking, per-thread, CPU limits. */
+#define RLIMIT_FOOTPRINT_INTERVAL       0x4 /* Configure memory footprint interval tracking */
 
 /*
  * Flags for wakeups monitor control.
  */
-#define WAKEMON_ENABLE                 0x01
-#define WAKEMON_DISABLE                        0x02
-#define WAKEMON_GET_PARAMS             0x04
-#define WAKEMON_SET_DEFAULTS           0x08
-#define        WAKEMON_MAKE_FATAL              0x10 /* Configure the task so that violations are fatal. */
+#define WAKEMON_ENABLE                  0x01
+#define WAKEMON_DISABLE                 0x02
+#define WAKEMON_GET_PARAMS              0x04
+#define WAKEMON_SET_DEFAULTS            0x08
+#define WAKEMON_MAKE_FATAL              0x10 /* Configure the task so that violations are fatal. */
 
 /*
  * Flags for CPU usage monitor control.
  */
-#define        CPUMON_MAKE_FATAL               0x1000
+#define CPUMON_MAKE_FATAL               0x1000
 
 /*
  * Flags for memory footprint interval tracking.
  */
-#define        FOOTPRINT_INTERVAL_RESET        0x1 /* Reset the footprint interval counter to zero */
+#define FOOTPRINT_INTERVAL_RESET        0x1 /* Reset the footprint interval counter to zero */
 
 struct proc_rlimit_control_wakeupmon {
        uint32_t wm_flags;
@@ -483,17 +483,17 @@ struct proc_rlimit_control_wakeupmon {
 };
 
 #if PRIVATE
-/* 
+/*
  * Flags for I/O monitor control.
  */
-#define IOMON_ENABLE                   0x01
-#define IOMON_DISABLE                  0x02
+#define IOMON_ENABLE                    0x01
+#define IOMON_DISABLE                   0x02
 
 #endif /* PRIVATE */
 
 
 /* I/O type */
-#define IOPOL_TYPE_DISK        0
+#define IOPOL_TYPE_DISK 0
 #if PRIVATE
 #define IOPOL_TYPE_VFS_HFS_CASE_SENSITIVITY 1
 #endif
@@ -505,24 +505,24 @@ struct proc_rlimit_control_wakeupmon {
 #define IOPOL_SCOPE_DARWIN_BG 2
 
 /* I/O Priority */
-#define IOPOL_DEFAULT          0
-#define IOPOL_IMPORTANT                1
-#define IOPOL_PASSIVE          2
-#define IOPOL_THROTTLE         3
-#define IOPOL_UTILITY          4
-#define IOPOL_STANDARD         5
+#define IOPOL_DEFAULT           0
+#define IOPOL_IMPORTANT         1
+#define IOPOL_PASSIVE           2
+#define IOPOL_THROTTLE          3
+#define IOPOL_UTILITY           4
+#define IOPOL_STANDARD          5
 
 /* compatibility with older names */
 #define IOPOL_APPLICATION       IOPOL_STANDARD
 #define IOPOL_NORMAL            IOPOL_IMPORTANT
 
 #if PRIVATE
-#define IOPOL_VFS_HFS_CASE_SENSITIVITY_DEFAULT 0
-#define IOPOL_VFS_HFS_CASE_SENSITIVITY_FORCE_CASE_SENSITIVE    1
+#define IOPOL_VFS_HFS_CASE_SENSITIVITY_DEFAULT  0
+#define IOPOL_VFS_HFS_CASE_SENSITIVITY_FORCE_CASE_SENSITIVE     1
 #endif
 
-#define IOPOL_ATIME_UPDATES_DEFAULT    0
-#define IOPOL_ATIME_UPDATES_OFF                1
+#define IOPOL_ATIME_UPDATES_DEFAULT     0
+#define IOPOL_ATIME_UPDATES_OFF         1
 
 #ifdef PRIVATE
 /*
@@ -533,36 +533,36 @@ struct proc_rlimit_control_wakeupmon {
 /*
  * the command to iopolicysys()
  */
-#define        IOPOL_CMD_GET           0x00000001      /* Get I/O policy */
-#define        IOPOL_CMD_SET           0x00000002      /* Set I/O policy */
+#define IOPOL_CMD_GET           0x00000001      /* Get I/O policy */
+#define IOPOL_CMD_SET           0x00000002      /* Set I/O policy */
 
 /*
  * Second parameter to iopolicysys()
  */
 struct _iopol_param_t {
-       int iop_scope;  /* current process or a thread */
+       int iop_scope;  /* current process or a thread */
        int iop_iotype;
        int iop_policy;
 };
 
-#endif /* PRIVATE */
+#endif  /* PRIVATE */
 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 
 #ifndef KERNEL
 
 __BEGIN_DECLS
-int    getpriority(int, id_t);
+int     getpriority(int, id_t);
 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
-int    getiopolicy_np(int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
+int     getiopolicy_np(int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
-int    getrlimit(int, struct rlimit *) __DARWIN_ALIAS(getrlimit);
-int    getrusage(int, struct rusage *);
-int    setpriority(int, id_t, int);
+int     getrlimit(int, struct rlimit *) __DARWIN_ALIAS(getrlimit);
+int     getrusage(int, struct rusage *);
+int     setpriority(int, id_t, int);
 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
-int    setiopolicy_np(int, int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
+int     setiopolicy_np(int, int, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
-int    setrlimit(int, const struct rlimit *) __DARWIN_ALIAS(setrlimit);
+int     setrlimit(int, const struct rlimit *) __DARWIN_ALIAS(setrlimit);
 __END_DECLS
 
-#endif /* !KERNEL */
-#endif /* !_SYS_RESOURCE_H_ */
+#endif  /* !KERNEL */
+#endif  /* !_SYS_RESOURCE_H_ */