]> git.saurik.com Git - apple/xnu.git/blob - osfmk/kern/locks.h
projects / apple / xnu.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
xnu-792.18.15.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
192 #define LCK_ATTR_DEBUG 0x00000001
193 #define LCK_ATTR_RW_SHARED_PRIORITY 0x00010000
194
195 #else
196 typedef struct __lck_attr__ lck_attr_t;
197 #endif
198
199 #define LCK_ATTR_NULL (lck_attr_t *)0
200
201 __BEGIN_DECLS
202
203 extern lck_attr_t *lck_attr_alloc_init(
204 void);
205
206 extern void lck_attr_setdefault(
207 lck_attr_t *attr);
208
209 extern void lck_attr_setdebug(
210 lck_attr_t *attr);
211
212 #ifdef XNU_KERNEL_PRIVATE
213 extern void lck_attr_rw_shared_priority(
214 lck_attr_t *attr);
215 #endif
216
217 extern void lck_attr_free(
218 lck_attr_t *attr);
219
220 #define decl_lck_spin_data(class,name) class lck_spin_t name;
221
222 extern lck_spin_t *lck_spin_alloc_init(
223 lck_grp_t *grp,
224 lck_attr_t *attr);
225
226 extern void lck_spin_init(
227 lck_spin_t *lck,
228 lck_grp_t *grp,
229 lck_attr_t *attr);
230
231 extern void lck_spin_lock(
232 lck_spin_t *lck);
233
234 extern void lck_spin_unlock(
235 lck_spin_t *lck);
236
237 extern void lck_spin_destroy(
238 lck_spin_t *lck,
239 lck_grp_t *grp);
240
241 extern void lck_spin_free(
242 lck_spin_t *lck,
243 lck_grp_t *grp);
244
245 extern wait_result_t lck_spin_sleep(
246 lck_spin_t *lck,
247 lck_sleep_action_t lck_sleep_action,
248 event_t event,
249 wait_interrupt_t interruptible);
250
251 extern wait_result_t lck_spin_sleep_deadline(
252 lck_spin_t *lck,
253 lck_sleep_action_t lck_sleep_action,
254 event_t event,
255 wait_interrupt_t interruptible,
256 uint64_t deadline);
257
258 #ifdef KERNEL_PRIVATE
259
260 extern boolean_t lck_spin_try_lock(
261 lck_spin_t *lck);
262
263 #endif
264
265
266 #define decl_lck_mtx_data(class,name) class lck_mtx_t name;
267
268 extern lck_mtx_t *lck_mtx_alloc_init(
269 lck_grp_t *grp,
270 lck_attr_t *attr);
271
272 extern void lck_mtx_init(
273 lck_mtx_t *lck,
274 lck_grp_t *grp,
275 lck_attr_t *attr);
276
277 extern void lck_mtx_lock(
278 lck_mtx_t *lck);
279
280 extern void lck_mtx_unlock(
281 lck_mtx_t *lck);
282
283 extern void lck_mtx_destroy(
284 lck_mtx_t *lck,
285 lck_grp_t *grp);
286
287 extern void lck_mtx_free(
288 lck_mtx_t *lck,
289 lck_grp_t *grp);
290
291 extern wait_result_t lck_mtx_sleep(
292 lck_mtx_t *lck,
293 lck_sleep_action_t lck_sleep_action,
294 event_t event,
295 wait_interrupt_t interruptible);
296
297 extern wait_result_t lck_mtx_sleep_deadline(
298 lck_mtx_t *lck,
299 lck_sleep_action_t lck_sleep_action,
300 event_t event,
301 wait_interrupt_t interruptible,
302 uint64_t deadline);
303
304 #ifdef KERNEL_PRIVATE
305
306 extern boolean_t lck_mtx_try_lock(
307 lck_mtx_t *lck);
308
309 #endif /* KERNEL_PRIVATE */
310
311 extern void lck_mtx_assert(
312 lck_mtx_t *lck,
313 unsigned int type);
314
315 __END_DECLS
316
317 #define LCK_MTX_ASSERT_OWNED 0x01
318 #define LCK_MTX_ASSERT_NOTOWNED 0x02
319
320 #ifdef MACH_KERNEL_PRIVATE
321 extern void lck_mtx_lock_wait(
322 lck_mtx_t *lck,
323 thread_t holder);
324
325 extern int lck_mtx_lock_acquire(
326 lck_mtx_t *lck);
327
328 extern void lck_mtx_unlock_wakeup(
329 lck_mtx_t *lck,
330 thread_t holder);
331
332 extern boolean_t lck_mtx_ilk_unlock(
333 lck_mtx_t *lck);
334 #endif
335
336 #define decl_lck_rw_data(class,name) class lck_rw_t name;
337
338 typedef unsigned int lck_rw_type_t;
339
340 #define LCK_RW_TYPE_SHARED 0x01
341 #define LCK_RW_TYPE_EXCLUSIVE 0x02
342
343 __BEGIN_DECLS
344
345 extern lck_rw_t *lck_rw_alloc_init(
346 lck_grp_t *grp,
347 lck_attr_t *attr);
348
349 extern void lck_rw_init(
350 lck_rw_t *lck,
351 lck_grp_t *grp,
352 lck_attr_t *attr);
353
354 extern void lck_rw_lock(
355 lck_rw_t *lck,
356 lck_rw_type_t lck_rw_type);
357
358 extern void lck_rw_unlock(
359 lck_rw_t *lck,
360 lck_rw_type_t lck_rw_type);
361
362 extern void lck_rw_lock_shared(
363 lck_rw_t *lck);
364
365 extern void lck_rw_unlock_shared(
366 lck_rw_t *lck);
367
368 extern void lck_rw_lock_exclusive(
369 lck_rw_t *lck);
370
371 extern void lck_rw_unlock_exclusive(
372 lck_rw_t *lck);
373
374 #ifdef KERNEL_PRIVATE
375
376 extern lck_rw_type_t lck_rw_done(
377 lck_rw_t *lck);
378 #endif
379
380 extern void lck_rw_destroy(
381 lck_rw_t *lck,
382 lck_grp_t *grp);
383
384 extern void lck_rw_free(
385 lck_rw_t *lck,
386 lck_grp_t *grp);
387
388 extern wait_result_t lck_rw_sleep(
389 lck_rw_t *lck,
390 lck_sleep_action_t lck_sleep_action,
391 event_t event,
392 wait_interrupt_t interruptible);
393
394 extern wait_result_t lck_rw_sleep_deadline(
395 lck_rw_t *lck,
396 lck_sleep_action_t lck_sleep_action,
397 event_t event,
398 wait_interrupt_t interruptible,
399 uint64_t deadline);
400
401 #ifdef KERNEL_PRIVATE
402
403 extern boolean_t lck_rw_lock_shared_to_exclusive(
404 lck_rw_t *lck);
405
406 extern void lck_rw_lock_exclusive_to_shared(
407 lck_rw_t *lck);
408
409 extern boolean_t lck_rw_try_lock(
410 lck_rw_t *lck,
411 lck_rw_type_t lck_rw_type);
412
413 extern boolean_t lck_rw_try_lock_shared(
414 lck_rw_t *lck);
415
416 extern boolean_t lck_rw_try_lock_exclusive(
417 lck_rw_t *lck);
418 #endif
419
420 __END_DECLS
421
422 #endif /* _KERN_LOCKS_H_ */
mirror of XNU