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