]> git.saurik.com Git - apple/xnu.git/blob - osfmk/kern/locks.h
xnu-792.17.14.tar.gz
[apple/xnu.git] / osfmk / kern / locks.h
1 /*
2 * Copyright (c) 2003-2005 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 _KERN_LOCKS_H_
30 #define _KERN_LOCKS_H_
31
32 #include <sys/cdefs.h>
33 #include <sys/appleapiopts.h>
34 #include <mach/boolean.h>
35 #include <mach/mach_types.h>
36 #include <kern/kern_types.h>
37 #include <machine/locks.h>
38
39 #ifdef MACH_KERNEL_PRIVATE
40 #include <kern/queue.h>
41
42 extern void lck_mod_init(
43 void);
44
45 typedef unsigned int lck_type_t;
46
47 #define LCK_TYPE_SPIN 1
48 #define LCK_TYPE_MTX 2
49 #define LCK_TYPE_RW 3
50
51 #endif
52
53 typedef unsigned int lck_sleep_action_t;
54
55 #define LCK_SLEEP_DEFAULT 0x00 /* Release the lock while waiting for the event, then reclaim */
56 /* RW locks are returned in the same mode */
57 #define LCK_SLEEP_UNLOCK 0x01 /* Release the lock and return unheld */
58 #define LCK_SLEEP_SHARED 0x02 /* Reclaim the lock in shared mode (RW only) */
59 #define LCK_SLEEP_EXCLUSIVE 0x04 /* Reclaim the lock in exclusive mode (RW only) */
60
61 #define LCK_SLEEP_MASK 0x07 /* Valid actions */
62
63 #ifdef MACH_KERNEL_PRIVATE
64
65 typedef struct {
66 uint64_t lck_grp_spin_util_cnt;
67 uint64_t lck_grp_spin_held_cnt;
68 uint64_t lck_grp_spin_miss_cnt;
69 uint64_t lck_grp_spin_held_max;
70 uint64_t lck_grp_spin_held_cum;
71 } lck_grp_spin_stat_t;
72
73 typedef struct {
74 uint64_t lck_grp_mtx_util_cnt;
75 uint64_t lck_grp_mtx_held_cnt;
76 uint64_t lck_grp_mtx_miss_cnt;
77 uint64_t lck_grp_mtx_wait_cnt;
78 uint64_t lck_grp_mtx_held_max;
79 uint64_t lck_grp_mtx_held_cum;
80 uint64_t lck_grp_mtx_wait_max;
81 uint64_t lck_grp_mtx_wait_cum;
82 } lck_grp_mtx_stat_t;
83
84 typedef struct {
85 uint64_t lck_grp_rw_util_cnt;
86 uint64_t lck_grp_rw_held_cnt;
87 uint64_t lck_grp_rw_miss_cnt;
88 uint64_t lck_grp_rw_wait_cnt;
89 uint64_t lck_grp_rw_held_max;
90 uint64_t lck_grp_rw_held_cum;
91 uint64_t lck_grp_rw_wait_max;
92 uint64_t lck_grp_rw_wait_cum;
93 } lck_grp_rw_stat_t;
94
95 typedef struct _lck_grp_stat_ {
96 lck_grp_spin_stat_t lck_grp_spin_stat;
97 lck_grp_mtx_stat_t lck_grp_mtx_stat;
98 lck_grp_rw_stat_t lck_grp_rw_stat;
99 } lck_grp_stat_t;
100
101 #define LCK_GRP_MAX_NAME 64
102
103 typedef struct _lck_grp_ {
104 queue_chain_t lck_grp_link;
105 unsigned int lck_grp_refcnt;
106 unsigned int lck_grp_spincnt;
107 unsigned int lck_grp_mtxcnt;
108 unsigned int lck_grp_rwcnt;
109 unsigned int lck_grp_attr;
110 char lck_grp_name[LCK_GRP_MAX_NAME];
111 lck_grp_stat_t lck_grp_stat;
112 } lck_grp_t;
113
114 #define LCK_GRP_NULL (lck_grp_t *)0
115
116 #else
117 typedef struct __lck_grp__ lck_grp_t;
118 #endif
119
120 #ifdef MACH_KERNEL_PRIVATE
121 typedef struct _lck_grp_attr_ {
122 unsigned int grp_attr_val;
123 } lck_grp_attr_t;
124
125 extern lck_grp_attr_t LockDefaultGroupAttr;
126
127 #define LCK_GRP_ATTR_STAT 0x1
128
129 #else
130 typedef struct __lck_grp_attr__ lck_grp_attr_t;
131 #endif
132
133 #define LCK_GRP_ATTR_NULL (lck_grp_attr_t *)0
134
135 __BEGIN_DECLS
136
137 extern lck_grp_attr_t *lck_grp_attr_alloc_init(
138 void);
139
140 extern void lck_grp_attr_setdefault(
141 lck_grp_attr_t *attr);
142
143 extern void lck_grp_attr_setstat(
144 lck_grp_attr_t *attr);
145
146 extern void lck_grp_attr_free(
147 lck_grp_attr_t *attr);
148
149 extern lck_grp_t *lck_grp_alloc_init(
150 const char* grp_name,
151 lck_grp_attr_t *attr);
152
153 __END_DECLS
154
155 #ifdef MACH_KERNEL_PRIVATE
156 extern void lck_grp_init(
157 lck_grp_t *grp,
158 const char* grp_name,
159 lck_grp_attr_t *attr);
160
161 extern void lck_grp_reference(
162 lck_grp_t *grp);
163
164 extern void lck_grp_deallocate(
165 lck_grp_t *grp);
166
167 extern void lck_grp_lckcnt_incr(
168 lck_grp_t *grp,
169 lck_type_t lck_type);
170
171 extern void lck_grp_lckcnt_decr(
172 lck_grp_t *grp,
173 lck_type_t lck_type);
174 #endif
175
176 __BEGIN_DECLS
177
178 extern void lck_grp_free(
179 lck_grp_t *grp);
180
181 __END_DECLS
182
183 #ifdef MACH_KERNEL_PRIVATE
184 typedef struct _lck_attr_ {
185 unsigned int lck_attr_val;
186 } lck_attr_t;
187
188 extern lck_attr_t LockDefaultLckAttr;
189
190 #define LCK_ATTR_NONE 0
191 #define LCK_ATTR_DEBUG 0x1
192
193 #else
194 typedef struct __lck_attr__ lck_attr_t;
195 #endif
196
197 #define LCK_ATTR_NULL (lck_attr_t *)0
198
199 __BEGIN_DECLS
200
201 extern lck_attr_t *lck_attr_alloc_init(
202 void);
203
204 extern void lck_attr_setdefault(
205 lck_attr_t *attr);
206
207 extern void lck_attr_setdebug(
208 lck_attr_t *attr);
209
210 extern void lck_attr_free(
211 lck_attr_t *attr);
212
213 #define decl_lck_spin_data(class,name) class lck_spin_t name;
214
215 extern lck_spin_t *lck_spin_alloc_init(
216 lck_grp_t *grp,
217 lck_attr_t *attr);
218
219 extern void lck_spin_init(
220 lck_spin_t *lck,
221 lck_grp_t *grp,
222 lck_attr_t *attr);
223
224 extern void lck_spin_lock(
225 lck_spin_t *lck);
226
227 extern void lck_spin_unlock(
228 lck_spin_t *lck);
229
230 extern void lck_spin_destroy(
231 lck_spin_t *lck,
232 lck_grp_t *grp);
233
234 extern void lck_spin_free(
235 lck_spin_t *lck,
236 lck_grp_t *grp);
237
238 extern wait_result_t lck_spin_sleep(
239 lck_spin_t *lck,
240 lck_sleep_action_t lck_sleep_action,
241 event_t event,
242 wait_interrupt_t interruptible);
243
244 extern wait_result_t lck_spin_sleep_deadline(
245 lck_spin_t *lck,
246 lck_sleep_action_t lck_sleep_action,
247 event_t event,
248 wait_interrupt_t interruptible,
249 uint64_t deadline);
250
251 #ifdef KERNEL_PRIVATE
252
253 extern boolean_t lck_spin_try_lock(
254 lck_spin_t *lck);
255
256 #endif
257
258
259 #define decl_lck_mtx_data(class,name) class lck_mtx_t name;
260
261 extern lck_mtx_t *lck_mtx_alloc_init(
262 lck_grp_t *grp,
263 lck_attr_t *attr);
264
265 extern void lck_mtx_init(
266 lck_mtx_t *lck,
267 lck_grp_t *grp,
268 lck_attr_t *attr);
269
270 extern void lck_mtx_lock(
271 lck_mtx_t *lck);
272
273 extern void lck_mtx_unlock(
274 lck_mtx_t *lck);
275
276 extern void lck_mtx_destroy(
277 lck_mtx_t *lck,
278 lck_grp_t *grp);
279
280 extern void lck_mtx_free(
281 lck_mtx_t *lck,
282 lck_grp_t *grp);
283
284 extern wait_result_t lck_mtx_sleep(
285 lck_mtx_t *lck,
286 lck_sleep_action_t lck_sleep_action,
287 event_t event,
288 wait_interrupt_t interruptible);
289
290 extern wait_result_t lck_mtx_sleep_deadline(
291 lck_mtx_t *lck,
292 lck_sleep_action_t lck_sleep_action,
293 event_t event,
294 wait_interrupt_t interruptible,
295 uint64_t deadline);
296
297 #ifdef KERNEL_PRIVATE
298
299 extern boolean_t lck_mtx_try_lock(
300 lck_mtx_t *lck);
301
302 #endif /* KERNEL_PRIVATE */
303
304 extern void lck_mtx_assert(
305 lck_mtx_t *lck,
306 unsigned int type);
307
308 __END_DECLS
309
310 #define LCK_MTX_ASSERT_OWNED 0x01
311 #define LCK_MTX_ASSERT_NOTOWNED 0x02
312
313 #ifdef MACH_KERNEL_PRIVATE
314 extern void lck_mtx_lock_wait(
315 lck_mtx_t *lck,
316 thread_t holder);
317
318 extern int lck_mtx_lock_acquire(
319 lck_mtx_t *lck);
320
321 extern void lck_mtx_unlock_wakeup(
322 lck_mtx_t *lck,
323 thread_t holder);
324
325 extern boolean_t lck_mtx_ilk_unlock(
326 lck_mtx_t *lck);
327 #endif
328
329 #define decl_lck_rw_data(class,name) class lck_rw_t name;
330
331 typedef unsigned int lck_rw_type_t;
332
333 #define LCK_RW_TYPE_SHARED 0x01
334 #define LCK_RW_TYPE_EXCLUSIVE 0x02
335
336 __BEGIN_DECLS
337
338 extern lck_rw_t *lck_rw_alloc_init(
339 lck_grp_t *grp,
340 lck_attr_t *attr);
341
342 extern void lck_rw_init(
343 lck_rw_t *lck,
344 lck_grp_t *grp,
345 lck_attr_t *attr);
346
347 extern void lck_rw_lock(
348 lck_rw_t *lck,
349 lck_rw_type_t lck_rw_type);
350
351 extern void lck_rw_unlock(
352 lck_rw_t *lck,
353 lck_rw_type_t lck_rw_type);
354
355 extern void lck_rw_lock_shared(
356 lck_rw_t *lck);
357
358 extern void lck_rw_unlock_shared(
359 lck_rw_t *lck);
360
361 extern void lck_rw_lock_exclusive(
362 lck_rw_t *lck);
363
364 extern void lck_rw_unlock_exclusive(
365 lck_rw_t *lck);
366
367 #ifdef KERNEL_PRIVATE
368
369 extern lck_rw_type_t lck_rw_done(
370 lck_rw_t *lck);
371 #endif
372
373 extern void lck_rw_destroy(
374 lck_rw_t *lck,
375 lck_grp_t *grp);
376
377 extern void lck_rw_free(
378 lck_rw_t *lck,
379 lck_grp_t *grp);
380
381 extern wait_result_t lck_rw_sleep(
382 lck_rw_t *lck,
383 lck_sleep_action_t lck_sleep_action,
384 event_t event,
385 wait_interrupt_t interruptible);
386
387 extern wait_result_t lck_rw_sleep_deadline(
388 lck_rw_t *lck,
389 lck_sleep_action_t lck_sleep_action,
390 event_t event,
391 wait_interrupt_t interruptible,
392 uint64_t deadline);
393
394 #ifdef KERNEL_PRIVATE
395
396 extern boolean_t lck_rw_lock_shared_to_exclusive(
397 lck_rw_t *lck);
398
399 extern void lck_rw_lock_exclusive_to_shared(
400 lck_rw_t *lck);
401
402 extern boolean_t lck_rw_try_lock(
403 lck_rw_t *lck,
404 lck_rw_type_t lck_rw_type);
405
406 extern boolean_t lck_rw_try_lock_shared(
407 lck_rw_t *lck);
408
409 extern boolean_t lck_rw_try_lock_exclusive(
410 lck_rw_t *lck);
411 #endif
412
413 __END_DECLS
414
415 #endif /* _KERN_LOCKS_H_ */