Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 | /* * Copyright (c) 2000-2005 Apple Computer, 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 * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * 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, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * 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@ */ #ifndef _MACH_TASK_POLICY_H_ #define _MACH_TASK_POLICY_H_ #include <mach/mach_types.h> /* * These are the calls for accessing the policy parameters * of a particular task. * * The extra 'get_default' parameter to the second call is * IN/OUT as follows: * 1) if asserted on the way in it indicates that the default * values should be returned, not the ones currently set, in * this case 'get_default' will always be asserted on return; * 2) if unasserted on the way in, the current settings are * desired and if still unasserted on return, then the info * returned reflects the current settings, otherwise if * 'get_default' returns asserted, it means that there are no * current settings due to other parameters taking precedence, * and the default ones are being returned instead. */ typedef natural_t task_policy_flavor_t; typedef integer_t *task_policy_t; /* kern_return_t task_policy_set( task_t task, task_policy_flavor_t flavor, task_policy_t policy_info, mach_msg_type_number_t count); kern_return_t task_policy_get( task_t task, task_policy_flavor_t flavor, task_policy_t policy_info, mach_msg_type_number_t *count, boolean_t *get_default); */ /* * Defined flavors. */ /* * TASK_CATEGORY_POLICY: * * This provides information to the kernel about the role * of the task in the system. * * Parameters: * * role: Enumerated as follows: * * TASK_UNSPECIFIED is the default, since the role is not * inherited from the parent. * * TASK_FOREGROUND_APPLICATION should be assigned when the * task is a normal UI application in the foreground from * the HI point of view. * **N.B. There may be more than one of these at a given time. * * TASK_BACKGROUND_APPLICATION should be assigned when the * task is a normal UI application in the background from * the HI point of view. * * TASK_CONTROL_APPLICATION should be assigned to the unique * UI application which implements the pop-up application dialog. * There can only be one task at a time with this designation, * which is assigned FCFS. * * TASK_GRAPHICS_SERVER should be assigned to the graphics * management (window) server. There can only be one task at * a time with this designation, which is assigned FCFS. */ #define TASK_CATEGORY_POLICY 1 #define TASK_SUPPRESSION_POLICY 3 #define TASK_POLICY_STATE 4 #define TASK_BASE_QOS_POLICY 8 #define TASK_OVERRIDE_QOS_POLICY 9 #define TASK_BASE_LATENCY_QOS_POLICY 10 #define TASK_BASE_THROUGHPUT_QOS_POLICY 11 enum task_role { TASK_RENICED = -1, TASK_UNSPECIFIED = 0, TASK_FOREGROUND_APPLICATION, TASK_BACKGROUND_APPLICATION, TASK_CONTROL_APPLICATION, TASK_GRAPHICS_SERVER, TASK_THROTTLE_APPLICATION, TASK_NONUI_APPLICATION, TASK_DEFAULT_APPLICATION }; typedef integer_t task_role_t; struct task_category_policy { task_role_t role; }; typedef struct task_category_policy task_category_policy_data_t; typedef struct task_category_policy *task_category_policy_t; #define TASK_CATEGORY_POLICY_COUNT ((mach_msg_type_number_t) \ (sizeof (task_category_policy_data_t) / sizeof (integer_t))) enum task_latency_qos { LATENCY_QOS_TIER_UNSPECIFIED = 0x0, LATENCY_QOS_TIER_0 = ((0xFF<<16) | 1), LATENCY_QOS_TIER_1 = ((0xFF<<16) | 2), LATENCY_QOS_TIER_2 = ((0xFF<<16) | 3), LATENCY_QOS_TIER_3 = ((0xFF<<16) | 4), LATENCY_QOS_TIER_4 = ((0xFF<<16) | 5), LATENCY_QOS_TIER_5 = ((0xFF<<16) | 6) }; typedef integer_t task_latency_qos_t; enum task_throughput_qos { THROUGHPUT_QOS_TIER_UNSPECIFIED = 0x0, THROUGHPUT_QOS_TIER_0 = ((0xFE<<16) | 1), THROUGHPUT_QOS_TIER_1 = ((0xFE<<16) | 2), THROUGHPUT_QOS_TIER_2 = ((0xFE<<16) | 3), THROUGHPUT_QOS_TIER_3 = ((0xFE<<16) | 4), THROUGHPUT_QOS_TIER_4 = ((0xFE<<16) | 5), THROUGHPUT_QOS_TIER_5 = ((0xFE<<16) | 6), }; #define LATENCY_QOS_LAUNCH_DEFAULT_TIER LATENCY_QOS_TIER_3 #define THROUGHPUT_QOS_LAUNCH_DEFAULT_TIER THROUGHPUT_QOS_TIER_3 typedef integer_t task_throughput_qos_t; struct task_qos_policy { task_latency_qos_t task_latency_qos_tier; task_throughput_qos_t task_throughput_qos_tier; }; typedef struct task_qos_policy *task_qos_policy_t; #define TASK_QOS_POLICY_COUNT ((mach_msg_type_number_t) \ (sizeof (struct task_qos_policy) / sizeof (integer_t))) /* These should be removed - they belong in proc_info.h */ #define PROC_FLAG_DARWINBG 0x8000 /* process in darwin background */ #define PROC_FLAG_EXT_DARWINBG 0x10000 /* process in darwin background - external enforcement */ #define PROC_FLAG_IOS_APPLEDAEMON 0x20000 /* process is apple ios daemon */ #define PROC_FLAG_IOS_IMPPROMOTION 0x80000 /* process is apple ios daemon */ #define PROC_FLAG_ADAPTIVE 0x100000 /* Process is adaptive */ #define PROC_FLAG_ADAPTIVE_IMPORTANT 0x200000 /* Process is adaptive, and is currently important */ #define PROC_FLAG_IMPORTANCE_DONOR 0x400000 /* Process is marked as an importance donor */ #define PROC_FLAG_SUPPRESSED 0x800000 /* Process is suppressed */ #define PROC_FLAG_APPLICATION 0x1000000 /* Process is an application */ #define PROC_FLAG_IOS_APPLICATION PROC_FLAG_APPLICATION /* Process is an application */ #ifdef PRIVATE struct task_requested_policy { /* Task and thread policy (inherited) */ uint64_t int_darwinbg :1, /* marked as darwinbg via setpriority */ ext_darwinbg :1, int_iotier :2, /* IO throttle tier */ ext_iotier :2, int_iopassive :1, /* should IOs cause lower tiers to be throttled */ ext_iopassive :1, bg_iotier :2, /* what IO throttle tier should apply to me when I'm darwinbg? (pushed to threads) */ terminated :1, /* all throttles should be removed for quick exit or SIGTERM handling */ /* Thread only policy */ th_pidbind_bg :1, /* thread only: task i'm bound to is marked 'watchbg' */ th_workq_bg :1, /* thread only: currently running a background priority workqueue */ thrp_qos :3, /* thread only: thread qos class */ thrp_qos_relprio :4, /* thread only: thread qos relative priority (store as inverse, -10 -> 0xA) */ thrp_qos_override :3, /* thread only: thread qos class override */ /* Task only policy */ t_apptype :3, /* What apptype did launchd tell us this was (inherited) */ t_boosted :1, /* Has a non-zero importance assertion count */ t_int_gpu_deny :1, /* don't allow access to GPU */ t_ext_gpu_deny :1, t_role :3, /* task's system role */ t_tal_enabled :1, /* TAL mode is enabled */ t_base_latency_qos :3, /* Timer latency QoS */ t_over_latency_qos :3, /* Timer latency QoS override */ t_base_through_qos :3, /* Computation throughput QoS */ t_over_through_qos :3, /* Computation throughput QoS override */ t_sfi_managed :1, /* SFI Managed task */ t_qos_clamp :3, /* task qos clamp */ /* Task only: suppression policies (non-embedded only) */ t_sup_active :1, /* Suppression is on */ t_sup_lowpri_cpu :1, /* Wants low priority CPU (MAXPRI_THROTTLE) */ t_sup_timer :3, /* Wanted timer throttling QoS tier */ t_sup_disk :1, /* Wants disk throttling */ t_sup_cpu_limit :1, /* Wants CPU limit (not hooked up yet)*/ t_sup_suspend :1, /* Wants to be suspended */ t_sup_throughput :3, /* Wants throughput QoS tier */ t_sup_cpu :1, /* Wants suppressed CPU priority (MAXPRI_SUPPRESSED) */ t_sup_bg_sockets :1, /* Wants background sockets */ reserved :2; }; struct task_effective_policy { /* Task and thread policy */ uint64_t darwinbg :1, /* marked as 'background', and sockets are marked bg when created */ lowpri_cpu :1, /* cpu priority == MAXPRI_THROTTLE */ io_tier :2, /* effective throttle tier */ io_passive :1, /* should IOs cause lower tiers to be throttled */ all_sockets_bg :1, /* All existing sockets in process are marked as bg (thread: all created by thread) */ new_sockets_bg :1, /* Newly created sockets should be marked as bg */ bg_iotier :2, /* What throttle tier should I be in when darwinbg is set? */ terminated :1, /* all throttles have been removed for quick exit or SIGTERM handling */ qos_ui_is_urgent :1, /* bump UI-Interactive QoS up to the urgent preemption band */ /* Thread only policy */ thep_qos :3, /* thread only: thread qos class */ thep_qos_relprio :4, /* thread only: thread qos relative priority (store as inverse, -10 -> 0xA) */ /* Task only policy */ t_gpu_deny :1, /* not allowed to access GPU */ t_tal_engaged :1, /* TAL mode is in effect */ t_suspended :1, /* task_suspend-ed due to suppression */ t_watchers_bg :1, /* watchers are BG-ed */ t_latency_qos :3, /* Timer latency QoS level */ t_through_qos :3, /* Computation throughput QoS level */ t_sup_active :1, /* suppression behaviors are in effect */ t_role :3, /* task's system role */ t_suppressed_cpu :1, /* cpu priority == MAXPRI_SUPPRESSED (trumped by lowpri_cpu) */ t_sfi_managed :1, /* SFI Managed task */ t_live_donor :1, /* task is a live importance boost donor */ t_qos_clamp :3, /* task qos clamp (applies to qos-disabled threads too) */ t_qos_ceiling :3, /* task qos ceiling (applies to only qos-participating threads) */ reserved :23; }; struct task_pended_policy { uint64_t t_updating_policy :1, /* Busy bit for task to prevent concurrent 'complete' operations */ /* Task and thread policy */ update_sockets :1, /* Task only policy */ t_update_timers :1, t_update_watchers :1, reserved :60; }; #endif #ifdef MACH_KERNEL_PRIVATE extern const struct task_requested_policy default_task_requested_policy; extern const struct task_effective_policy default_task_effective_policy; extern const struct task_pended_policy default_task_pended_policy; extern kern_return_t qos_latency_policy_validate(task_latency_qos_t); extern kern_return_t qos_throughput_policy_validate(task_throughput_qos_t); extern uint32_t qos_extract(uint32_t); extern uint32_t qos_latency_policy_package(uint32_t); extern uint32_t qos_throughput_policy_package(uint32_t); #endif /* MACH_KERNEL_PRIVATE */ #ifdef PRIVATE /* * Control structure for applying suppression behaviors to tasks */ struct task_suppression_policy { integer_t active; integer_t lowpri_cpu; /* priority MAXPRI_THROTTLE cpu */ integer_t timer_throttle; integer_t disk_throttle; integer_t cpu_limit; integer_t suspend; integer_t throughput_qos; integer_t suppressed_cpu; /* priority MAXPRI_SUPPRESSED cpu */ integer_t background_sockets; integer_t reserved[7]; }; typedef struct task_suppression_policy *task_suppression_policy_t; #define TASK_SUPPRESSION_POLICY_COUNT ((mach_msg_type_number_t) \ (sizeof (struct task_suppression_policy) / sizeof (integer_t))) struct task_policy_state { uint64_t requested; uint64_t effective; uint64_t pending; uint32_t imp_assertcnt; uint32_t imp_externcnt; uint64_t flags; uint64_t imp_transitions; uint64_t reserved[2]; }; typedef struct task_policy_state *task_policy_state_t; #define TASK_POLICY_STATE_COUNT ((mach_msg_type_number_t) \ (sizeof (struct task_policy_state) / sizeof (integer_t))) /* * Definitions for munging and unmunging a policy struct * Used in task_policy_state and in tracepoints * * Note: this is tightly bound to the implementation of task policy * and the values exported through this API may change or change meaning at any time * * Do not rely on these values, especially apptype, to decide behaviors at runtime. * * All per-thread state must be in the first 32 bits of the bitfield. */ #define TASK_APPTYPE_NONE 0 #define TASK_APPTYPE_DAEMON_INTERACTIVE 1 #define TASK_APPTYPE_DAEMON_STANDARD 2 #define TASK_APPTYPE_DAEMON_ADAPTIVE 3 #define TASK_APPTYPE_DAEMON_BACKGROUND 4 #define TASK_APPTYPE_APP_DEFAULT 5 #define TASK_APPTYPE_APP_TAL 6 /* task policy state flags */ #define TASK_IMP_RECEIVER 0x00000001 #define TASK_IMP_DONOR 0x00000002 #define TASK_IMP_LIVE_DONOR 0x00000004 #define TASK_DENAP_RECEIVER 0x00000008 /* requested_policy */ #define POLICY_REQ_INT_DARWIN_BG 0x00000001 #define POLICY_REQ_EXT_DARWIN_BG 0x00000002 #define POLICY_REQ_INT_IO_TIER_MASK 0x0000000c /* 2 bits */ #define POLICY_REQ_INT_IO_TIER_SHIFT 2 #define POLICY_REQ_EXT_IO_TIER_MASK 0x00000030 /* 2 bits */ #define POLICY_REQ_EXT_IO_TIER_SHIFT 4 #define POLICY_REQ_INT_PASSIVE_IO 0x00000040 #define POLICY_REQ_EXT_PASSIVE_IO 0x00000080 #define POLICY_REQ_BG_IOTIER_MASK 0x00000300 /* 2 bits */ #define POLICY_REQ_BG_IOTIER_SHIFT 8 /* thread requested policy */ #define POLICY_REQ_PIDBIND_BG 0x00000400 #define POLICY_REQ_WORKQ_BG 0x00000800 #define POLICY_REQ_TH_QOS_MASK 0x07000000 /* 3 bits (overlaps with ROLE) */ #define POLICY_REQ_TH_QOS_SHIFT 24 #define POLICY_REQ_TH_QOS_OVER_MASK 0x70000000 /* 3 bits (overlaps with TAL and SFI) */ #define POLICY_REQ_TH_QOS_OVER_SHIFT 28 /* task_requested_policy */ #define POLICY_REQ_TERMINATED 0x00001000 #define POLICY_REQ_BOOSTED 0x00002000 #define POLICY_REQ_INT_GPU_DENY 0x00004000 #define POLICY_REQ_EXT_GPU_DENY 0x00008000 #define POLICY_REQ_APPTYPE_MASK 0x00070000 /* 3 bits */ #define POLICY_REQ_APPTYPE_SHIFT 16 #define POLICY_REQ_BASE_LATENCY_QOS_MASK 0x00700000 /* 3 bits */ #define POLICY_REQ_BASE_LATENCY_QOS_SHIFT 20 #define POLICY_REQ_ROLE_MASK 0x07000000 /* 3 bits */ #define POLICY_REQ_ROLE_SHIFT 24 #define POLICY_REQ_TAL_ENABLED 0x40000000 #define POLICY_REQ_SFI_MANAGED 0x80000000 /* requested suppression behaviors (note: clipped off in 32-bit tracepoints) */ #define POLICY_REQ_SUP_ACTIVE 0x0000000100000000 #define POLICY_REQ_SUP_LOWPRI_CPU 0x0000000200000000 #define POLICY_REQ_SUP_CPU 0x0000000400000000 #define POLICY_REQ_SUP_DISK_THROTTLE 0x0000003000000000 /* 2 bits */ #define POLICY_REQ_SUP_CPU_LIMIT 0x0000004000000000 #define POLICY_REQ_SUP_SUSPEND 0x0000008000000000 #define POLICY_REQ_OVER_LATENCY_QOS_MASK 0x0000070000000000 /* 3 bits */ #define POLICY_REQ_OVER_LATENCY_QOS_SHIFT 40 #define POLICY_REQ_BASE_THROUGH_QOS_MASK 0x0000700000000000 /* 3 bits */ #define POLICY_REQ_BASE_THROUGH_QOS_SHIFT 44 #define POLICY_REQ_OVER_THROUGH_QOS_MASK 0x0007000000000000 /* 3 bits */ #define POLICY_REQ_OVER_THROUGH_QOS_SHIFT 48 #define POLICY_REQ_SUP_TIMER_THROTTLE_MASK 0x0070000000000000 /* 3 bits */ #define POLICY_REQ_SUP_TIMER_THROTTLE_SHIFT 52 #define POLICY_REQ_SUP_THROUGHPUT_MASK 0x0700000000000000 /* 3 bits */ #define POLICY_REQ_SUP_THROUGHPUT_SHIFT 56 #define POLICY_REQ_SUP_BG_SOCKETS 0x0800008000000000 #define POLICY_REQ_QOS_CLAMP_MASK 0x7000000000000000 /* 3 bits */ #define POLICY_REQ_QOS_CLAMP_SHIFT 60 /* effective policy */ #define POLICY_EFF_IO_TIER_MASK 0x00000003 /* 2 bits */ #define POLICY_EFF_IO_TIER_SHIFT 0 #define POLICY_EFF_IO_PASSIVE 0x00000008 #define POLICY_EFF_DARWIN_BG 0x00000010 #define POLICY_EFF_LOWPRI_CPU 0x00000020 #define POLICY_EFF_ALL_SOCKETS_BG 0x00000040 #define POLICY_EFF_NEW_SOCKETS_BG 0x00000080 #define POLICY_EFF_BG_IOTIER_MASK 0x00000300 /* 2 bits */ #define POLICY_EFF_BG_IOTIER_SHIFT 8 #define POLICY_EFF_TERMINATED 0x00000400 #define POLICY_EFF_QOS_UI_IS_URGENT 0x80000000 /* thread effective policy */ #define POLICY_EFF_TH_QOS_MASK 0x00700000 /* 3 bits (overlaps with ROLE) */ #define POLICY_EFF_TH_QOS_SHIFT 20 #define POLICY_EFF_LATENCY_QOS_MASK 0x00070000 /* 3 bits */ #define POLICY_EFF_LATENCY_QOS_SHIFT 16 #define POLICY_EFF_THROUGH_QOS_MASK 0x07000000 /* 3 bits */ #define POLICY_EFF_THROUGH_QOS_SHIFT 24 /* task effective policy */ #define POLICY_EFF_GPU_DENY 0x00001000 #define POLICY_EFF_TAL_ENGAGED 0x00002000 #define POLICY_EFF_SUSPENDED 0x00004000 #define POLICY_EFF_WATCHERS_BG 0x00008000 #define POLICY_EFF_SUP_ACTIVE 0x00080000 #define POLICY_EFF_ROLE_MASK 0x00700000 /* 3 bits */ #define POLICY_EFF_ROLE_SHIFT 20 #define POLICY_EFF_SUP_CPU 0x00800000 #define POLICY_EFF_SFI_MANAGED 0x08000000 #define POLICY_EFF_QOS_CEILING_MASK 0x70000000 #define POLICY_EFF_QOS_CEILING_SHIFT 28 /* pending policy */ #define POLICY_PEND_UPDATING 0x00000001 #define POLICY_PEND_SOCKETS 0x00000002 #define POLICY_PEND_TIMERS 0x00000004 #define POLICY_PEND_WATCHERS 0x00000008 #endif /* PRIVATE */ #endif /* _MACH_TASK_POLICY_H_ */ |