1 | /* |
2 | * Copyright (c) 2017 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 | |
29 | #ifndef _KERN_WORK_INTERVAL_H_ |
30 | #define _KERN_WORK_INTERVAL_H_ |
31 | |
32 | #include <sys/cdefs.h> |
33 | |
34 | #include <stdint.h> |
35 | #include <kern/kern_types.h> |
36 | |
37 | #include <kern/thread_group.h> |
38 | #include <kern/recount.h> |
39 | |
40 | __BEGIN_DECLS |
41 | |
42 | struct work_interval; |
43 | |
44 | struct kern_work_interval_args { |
45 | uint64_t work_interval_id; |
46 | uint64_t start; |
47 | uint64_t finish; |
48 | uint64_t deadline; |
49 | uint64_t next_start; |
50 | uint32_t notify_flags; |
51 | uint32_t create_flags; |
52 | uint16_t urgency; |
53 | }; |
54 | |
55 | struct kern_work_interval_create_args { |
56 | uint64_t wica_id; /* out param */ |
57 | mach_port_name_t wica_port; /* out param */ |
58 | uint32_t wica_create_flags; |
59 | }; |
60 | |
61 | struct kern_work_interval_workload_id_args { |
62 | uint32_t wlida_flags; /* in/out param */ |
63 | uint32_t wlida_wicreate_flags; /* in/out param */ |
64 | char * wlida_name; /* in param */ |
65 | uint64_t wlida_syscall_mask[2]; /* out param */ |
66 | }; |
67 | |
68 | /* |
69 | * Allocate/assign a single work interval ID for a thread, |
70 | * and support deallocating it. |
71 | */ |
72 | extern kern_return_t |
73 | kern_work_interval_create(thread_t thread, struct kern_work_interval_create_args *create_params); |
74 | |
75 | extern kern_return_t |
76 | kern_work_interval_get_flags_from_port(mach_port_name_t port_name, uint32_t*flags); |
77 | |
78 | #if CONFIG_THREAD_GROUPS |
79 | /* |
80 | * A private interface for kevent subsystem. |
81 | * Returns following scheduling policies associated with a work interval, if available. |
82 | * : Priority |
83 | * : Scheduling policy/mode |
84 | * : +1 ref on the backing thread group |
85 | */ |
86 | extern kern_return_t |
87 | kern_work_interval_get_policy_from_port(mach_port_name_t port_name, |
88 | integer_t *policy, integer_t *priority, struct thread_group **tg); |
89 | #endif /* CONFIG_THREAD_GROUPS */ |
90 | |
91 | |
92 | extern kern_return_t |
93 | kern_work_interval_destroy(thread_t thread, uint64_t work_interval_id); |
94 | extern kern_return_t |
95 | kern_work_interval_join(thread_t thread, mach_port_name_t port_name); |
96 | |
97 | extern kern_return_t |
98 | kern_work_interval_notify(thread_t thread, struct kern_work_interval_args* kwi_args); |
99 | extern kern_return_t |
100 | kern_work_interval_set_name(mach_port_name_t port_name, char *name, size_t len); |
101 | extern kern_return_t |
102 | kern_work_interval_set_workload_id(mach_port_name_t port_name, |
103 | struct kern_work_interval_workload_id_args *workload_id_args); |
104 | |
105 | #ifdef MACH_KERNEL_PRIVATE |
106 | |
107 | bool work_interval_port_type_render_server(mach_port_name_t port_name); |
108 | |
109 | #if CONFIG_SCHED_AUTO_JOIN |
110 | bool work_interval_should_propagate(thread_t cthread, thread_t thread); |
111 | void work_interval_auto_join_propagate(thread_t from, thread_t to); |
112 | void work_interval_auto_join_unwind(thread_t thread); |
113 | void work_interval_auto_join_demote(thread_t thread); |
114 | #endif /* CONFIG_SCHED_AUTO_JOIN */ |
115 | |
116 | |
117 | struct recount_track *work_interval_get_recount_tracks(struct work_interval *work_interval); |
118 | |
119 | extern kern_return_t work_interval_thread_terminate(thread_t thread); |
120 | extern int work_interval_get_priority(thread_t thread); |
121 | |
122 | #endif /* MACH_KERNEL_PRIVATE */ |
123 | |
124 | #ifdef KERNEL_PRIVATE |
125 | |
126 | __enum_closed_decl(wi_class_t, uint8_t, { |
127 | WI_CLASS_NONE = 0, |
128 | WI_CLASS_DISCRETIONARY = 1, |
129 | WI_CLASS_BEST_EFFORT = 2, |
130 | WI_CLASS_APPLICATION = 3, |
131 | WI_CLASS_SYSTEM = 4, |
132 | WI_CLASS_SYSTEM_CRITICAL = 5, |
133 | WI_CLASS_REALTIME = 6, |
134 | WI_CLASS_REALTIME_CRITICAL = 7, |
135 | WI_CLASS_APP_SUPPORT = 8, |
136 | |
137 | WI_CLASS_COUNT |
138 | }); |
139 | |
140 | #endif |
141 | |
142 | __END_DECLS |
143 | |
144 | #endif /* !defined(_KERN_WORK_INTERVAL_H_) */ |
145 | |