]> git.saurik.com Git - apple/xnu.git/blob - bsd/sys/process_policy.h
xnu-3789.41.3.tar.gz
[apple/xnu.git] / bsd / sys / process_policy.h
1 /*
2 * Copyright (c) 2010 Apple Computer, 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
29 #ifndef _SYS_PROCESS_POLICY_H
30 #define _SYS_PROCESS_POLICY_H
31
32 #include <sys/cdefs.h>
33 #include <sys/param.h>
34 #include <sys/types.h>
35 #include <stdint.h>
36
37 #ifndef XNU_KERNEL_PRIVATE
38 #include <TargetConditionals.h>
39 #endif
40
41 __BEGIN_DECLS
42
43 /* defns of scope */
44 #define PROC_POLICY_SCOPE_PROCESS 1 /* the policy setting is for process wide effect */
45 #define PROC_POLICY_SCOPE_THREAD 2 /* the policy setting is for thread inside a proc */
46
47 /* defns of actions with no attributes */
48 #define PROC_POLICY_ACTION_APPLY 1 /* enforce the set policy */
49 #define PROC_POLICY_ACTION_RESTORE 2 /* revert the applied action back */
50 #define PROC_POLICY_ACTION_DENYINHERIT 3 /* set for no inheritence of the specified policy */
51 #define PROC_POLICY_ACTION_DENYSELFSET 4 /* set for the process to set its own policy */
52 #define PROC_POLICY_ACTION_ENABLE 5 /* enable policy and its actions */
53 #define PROC_POLICY_ACTION_DISABLE 6 /* disable policy and its actions, also clears any actions that have already happened */
54 /* defns of actions with attributes */
55 #define PROC_POLICY_ACTION_SET 10 /* set the policy attributes */
56 #define PROC_POLICY_ACTION_GET 11 /* get the policy attributes */
57 #define PROC_POLICY_ACTION_ADD 12 /* add a policy attribute */
58 #define PROC_POLICY_ACTION_REMOVE 13 /* remove a policy attribute */
59 #define PROC_POLICY_ACTION_HOLD 14 /* hold an importance boost assertion */
60 #define PROC_POLICY_ACTION_DROP 15 /* drop an importance boost assertion */
61
62 /* policies */
63 #define PROC_POLICY NONE 0
64 #define PROC_POLICY_BACKGROUND 1 /* darwin background policy */
65 #define PROC_POLICY_HARDWARE_ACCESS 2 /* access to various hardware */
66 #define PROC_POLICY_RESOURCE_STARVATION 3 /* behavior on resource starvation */
67 #define PROC_POLICY_RESOURCE_USAGE 4 /* behavior on resource consumption */
68 #define PROC_POLICY_RESERVED 5 /* behavior on resource consumption */
69 #define PROC_POLICY_APPTYPE 6 /* behavior on resource consumption */
70 #define PROC_POLICY_BOOST 7 /* importance boost/drop */
71
72 /* sub policies for background policy */
73 #define PROC_POLICY_BG_NONE 0 /* none */
74 #define PROC_POLICY_BG_LOWCPUPRI 1 /* Low cpu priority */
75 #define PROC_POLICY_BG_DISKTHROTTLE 2 /* disk accesses throttled */
76 #define PROC_POLICY_BG_NETTHROTTLE 4 /* network accesses throttled */
77 #define PROC_POLICY_BG_GPUDENY 8 /* no access to GPU */
78 #define PROC_POLICY_BG_ALL 0x07
79 #define PROC_POLICY_BG_DEFAULT PROC_POLICY_BG_ALL
80
81 /* sub policies for hardware */
82 #define PROC_POLICY_HWACCESS_NONE 0
83 #define PROC_POLICY_HWACCESS_DISK 1 /* disk access */
84 #define PROC_POLICY_HWACCESS_GPU 2 /* GPU access */
85 #define PROC_POLICY_HWACCESS_NETWORK 3 /* network access */
86 #define PROC_POLICY_HWACCESS_CPU 4 /* cpu access */
87
88 /* attribute values for disk hardware access, bit different as it should reflect IOPOL_XXX */
89 #define PROC_POLICY_DISKACC_NONE 0
90 #define PROC_POLICY_DISKACC_NORMAL 1 /* normal access to the disk */
91 #define PROC_POLICY_DISKACC_FULLACCESS 1 /* normal access to the disk */
92 #define PROC_POLICY_DISKACC_PASSIVE 2 /* treat the I/Os as passive */
93 #define PROC_POLICY_DISKACC_THROTTLE 3 /* throttle the disk IOs */
94 #define PROC_POLICY_DISKACC_DEFAULT PROC_POLICY_DISKACC_FULLACCESS
95
96 /* attribute values for GPU hardware access */
97 #define PROC_POLICY_GPUACC_NONE 0
98 #define PROC_POLICY_GPUACC_FULLACCESS 0 /* complete access to the GPU */
99 #define PROC_POLICY_GPUACC_DENYACCESS 1 /* deny any access to the GPU */
100 #define PROC_POLICY_GPUACC_DEFAULT PROC_POLICY_GPUACC_FULLACCESS /* default is complete access */
101
102 /* atrribute values for network hardware access */
103 #define PROC_POLICY_NETACC_NONE 0
104 #define PROC_POLICY_NETACC_FULLACCESS 0 /* complete access to the network */
105 #define PROC_POLICY_NETACC_THROTTLE 1 /* throttle access to network */
106 #define PROC_POLICY_NETACC_DEFAULT PROC_POLICY_NETACC_FULLACCESS /* default is complete access */
107
108 /* atrribute values for network hardware access */
109 #define PROC_POLICY_CPUACC_NONE 0
110 #define PROC_POLICY_CPUACC_FULLACCESS 0 /* access to all avialable cpus */
111 #define PROC_POLICY_CPUACC_ONE 1 /* access to only one available cpu */
112 #define PROC_POLICY_CPUACC_LLCACHE 2 /* access to only one last level cache */
113 #define PROC_POLICY_CPUACC_DEFAULT PROC_POLICY_CPUACC_FULLACCESS /* default is access to all cpus */
114
115
116 /* System Resource management (ie usage and starvation related) definitions */
117
118 /* sub policies for resource starvation */
119 #define PROC_POLICY_RS_NONE 0
120 #define PROC_POLICY_RS_VIRTUALMEM 1 /* virtual memory starvation */
121
122 /* sub policies for resource usage */
123 #define PROC_POLICY_RUSAGE_NONE 0
124 #define PROC_POLICY_RUSAGE_WIREDMEM 1 /* wired memory usages */
125 #define PROC_POLICY_RUSAGE_VIRTMEM 2 /* virtual memory usage */
126 #define PROC_POLICY_RUSAGE_CPU 3 /* amount of cpu usage */
127 #define PROC_POLICY_RUSAGE_DISK 4 /* amount of disk usage */
128 #define PROC_POLICY_RUSAGE_NETWORK 5 /* amount of network usage */
129 #define PROC_POLICY_RUSAGE_POWER 6 /* amount of power/battery consumption */
130
131 /* attribute values for the resource usage and low resource - MUST match corresponding task definitions */
132 #define PROC_POLICY_RSRCACT_NONE 0
133 #define PROC_POLICY_RSRCACT_THROTTLE 1 /* throttle on resource condition */
134 #define PROC_POLICY_RSRCACT_SUSPEND 2 /* suspend on resource condition */
135 #define PROC_POLICY_RSRCACT_TERMINATE 3 /* kill on resource condition */
136 #define PROC_POLICY_RSRCACT_NOTIFY_KQ 4 /* send kqueue notification */
137 #define PROC_POLICY_RSRCACT_NOTIFY_EXC 5 /* send exception */
138
139 #define PROC_POLICY_CPUMON_DISABLE 0xFF /* Disable CPU usage monitor */
140 #define PROC_POLICY_CPUMON_DEFAULTS 0xFE /* Set default CPU usage monitor params */
141
142 /* sub policies for importance boost/drop */
143 #define PROC_POLICY_IMP_IMPORTANT 1 /* Important-level boost */
144 #define PROC_POLICY_IMP_STANDARD 2 /* Standard-level boost */
145 #define PROC_POLICY_IMP_DONATION 3 /* Mark a task as an importance source */
146
147 typedef struct proc_policy_attribute {
148 uint32_t ppattr_attribute; /* the policy attribute to be modified or returned */
149 uint32_t ppattr_resv; /* pad field */
150 uint64_t ppattr_value1; /* 64bit policy specific attribute */
151 uint64_t ppattr_value2; /* 64bit policy specific attribute */
152 uint64_t ppattr_value3; /* 64bit policy specific attribute */
153 uint64_t ppattr_resv1[4]; /* reserved for future use */
154 } proc_policy_attribute_t;
155
156
157 typedef struct proc_policy_cpuusage_attr {
158 uint32_t ppattr_cpu_attr ; /* specified action as in PROC_POLICY_RSRCACT_xx */
159 uint32_t ppattr_cpu_percentage; /* percentage of interval */
160 uint64_t ppattr_cpu_attr_interval; /* 64bit interval in nsecs */
161 uint64_t ppattr_cpu_attr_deadline; /* 64bit deadline in nsecs */
162 } proc_policy_cpuusage_attr_t;
163
164
165 /* sub policies for PROC_POLICY_APPTYPE */
166 #define PROC_POLICY_APPTYPE_NONE 0 /* does nothing.. */
167 #define PROC_POLICY_APPTYPE_MODIFY 1 /* sets the app to various lifecycle states */
168
169 /* exported apptypes for PROC_POLICY_APPTYPE */
170 #define PROC_POLICY_OSX_APPTYPE_TAL 1 /* TAL-launched app */
171
172 #define PROC_POLICY_OSX_APPTYPE_DASHCLIENT 2 /* Dashboard client (deprecated) */
173 #define PROC_POLICY_IOS_DONATEIMP 6 /* donates priority imp (deprecated) */
174 #define PROC_POLICY_IOS_HOLDIMP 7 /* hold importance assertion (deprecated) */
175 #define PROC_POLICY_IOS_DROPIMP 8 /* drop importance assertion (deprecated) */
176
177 #ifndef KERNEL
178 int process_policy(int scope, int action, int policy, int policy_subtype, proc_policy_attribute_t * attrp, pid_t target_pid, uint64_t target_threadid);
179 #endif /* KERNEL */
180
181
182 __END_DECLS
183
184 #endif /*_SYS_PROCESS_POLICY_H */