-
Notifications
You must be signed in to change notification settings - Fork 5
/
locks.h
470 lines (353 loc) · 11.4 KB
/
locks.h
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
469
470
/*
* Copyright (c) 2003-2007 Apple 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 _KERN_LOCKS_H_
#define _KERN_LOCKS_H_
#include <sys/cdefs.h>
#include <sys/appleapiopts.h>
#include <mach/boolean.h>
#include <mach/mach_types.h>
#include <kern/kern_types.h>
#include <machine/locks.h>
#ifdef MACH_KERNEL_PRIVATE
#include <kern/queue.h>
extern void lck_mod_init(
void) __attribute__((section("__TEXT, initcode")));
typedef unsigned int lck_type_t;
#define LCK_TYPE_SPIN 1
#define LCK_TYPE_MTX 2
#define LCK_TYPE_RW 3
#endif
typedef unsigned int lck_sleep_action_t;
#define LCK_SLEEP_DEFAULT 0x00 /* Release the lock while waiting for the event, then reclaim */
/* RW locks are returned in the same mode */
#define LCK_SLEEP_UNLOCK 0x01 /* Release the lock and return unheld */
#define LCK_SLEEP_SHARED 0x02 /* Reclaim the lock in shared mode (RW only) */
#define LCK_SLEEP_EXCLUSIVE 0x04 /* Reclaim the lock in exclusive mode (RW only) */
#define LCK_SLEEP_SPIN 0x08 /* Reclaim the lock in spin mode (mutex only) */
#define LCK_SLEEP_MASK 0x0f /* Valid actions */
#ifdef MACH_KERNEL_PRIVATE
typedef struct {
uint64_t lck_grp_spin_util_cnt;
uint64_t lck_grp_spin_held_cnt;
uint64_t lck_grp_spin_miss_cnt;
uint64_t lck_grp_spin_held_max;
uint64_t lck_grp_spin_held_cum;
} lck_grp_spin_stat_t;
typedef struct {
uint64_t lck_grp_mtx_util_cnt;
/* On x86, this is used as the "direct wait" count */
uint64_t lck_grp_mtx_held_cnt;
uint64_t lck_grp_mtx_miss_cnt;
uint64_t lck_grp_mtx_wait_cnt;
/* Rest currently unused */
uint64_t lck_grp_mtx_held_max;
uint64_t lck_grp_mtx_held_cum;
uint64_t lck_grp_mtx_wait_max;
uint64_t lck_grp_mtx_wait_cum;
} lck_grp_mtx_stat_t;
typedef struct {
uint64_t lck_grp_rw_util_cnt;
uint64_t lck_grp_rw_held_cnt;
uint64_t lck_grp_rw_miss_cnt;
uint64_t lck_grp_rw_wait_cnt;
uint64_t lck_grp_rw_held_max;
uint64_t lck_grp_rw_held_cum;
uint64_t lck_grp_rw_wait_max;
uint64_t lck_grp_rw_wait_cum;
} lck_grp_rw_stat_t;
typedef struct _lck_grp_stat_ {
lck_grp_spin_stat_t lck_grp_spin_stat;
lck_grp_mtx_stat_t lck_grp_mtx_stat;
lck_grp_rw_stat_t lck_grp_rw_stat;
} lck_grp_stat_t;
#define LCK_GRP_MAX_NAME 64
typedef struct _lck_grp_ {
queue_chain_t lck_grp_link;
uint32_t lck_grp_refcnt;
uint32_t lck_grp_spincnt;
uint32_t lck_grp_mtxcnt;
uint32_t lck_grp_rwcnt;
uint32_t lck_grp_attr;
char lck_grp_name[LCK_GRP_MAX_NAME];
lck_grp_stat_t lck_grp_stat;
} lck_grp_t;
#define LCK_GRP_NULL (lck_grp_t *)0
#else
typedef struct __lck_grp__ lck_grp_t;
#endif
#ifdef MACH_KERNEL_PRIVATE
typedef struct _lck_grp_attr_ {
uint32_t grp_attr_val;
} lck_grp_attr_t;
extern lck_grp_attr_t LockDefaultGroupAttr;
#define LCK_GRP_ATTR_STAT 0x1
#else
typedef struct __lck_grp_attr__ lck_grp_attr_t;
#endif
#define LCK_GRP_ATTR_NULL (lck_grp_attr_t *)0
__BEGIN_DECLS
extern lck_grp_attr_t *lck_grp_attr_alloc_init(
void);
extern void lck_grp_attr_setdefault(
lck_grp_attr_t *attr);
extern void lck_grp_attr_setstat(
lck_grp_attr_t *attr);
extern void lck_grp_attr_free(
lck_grp_attr_t *attr);
extern lck_grp_t *lck_grp_alloc_init(
const char* grp_name,
lck_grp_attr_t *attr);
__END_DECLS
#ifdef MACH_KERNEL_PRIVATE
extern void lck_grp_init(
lck_grp_t *grp,
const char* grp_name,
lck_grp_attr_t *attr);
extern void lck_grp_reference(
lck_grp_t *grp);
extern void lck_grp_deallocate(
lck_grp_t *grp);
extern void lck_grp_lckcnt_incr(
lck_grp_t *grp,
lck_type_t lck_type);
extern void lck_grp_lckcnt_decr(
lck_grp_t *grp,
lck_type_t lck_type);
#endif
__BEGIN_DECLS
extern void lck_grp_free(
lck_grp_t *grp);
__END_DECLS
#ifdef MACH_KERNEL_PRIVATE
typedef struct _lck_attr_ {
unsigned int lck_attr_val;
} lck_attr_t;
extern lck_attr_t LockDefaultLckAttr;
#define LCK_ATTR_NONE 0
#define LCK_ATTR_DEBUG 0x00000001
#define LCK_ATTR_RW_SHARED_PRIORITY 0x00010000
#else
typedef struct __lck_attr__ lck_attr_t;
#endif
#define LCK_ATTR_NULL (lck_attr_t *)0
__BEGIN_DECLS
extern lck_attr_t *lck_attr_alloc_init(
void);
extern void lck_attr_setdefault(
lck_attr_t *attr);
extern void lck_attr_setdebug(
lck_attr_t *attr);
extern void lck_attr_cleardebug(
lck_attr_t *attr);
#ifdef XNU_KERNEL_PRIVATE
extern void lck_attr_rw_shared_priority(
lck_attr_t *attr);
#endif
extern void lck_attr_free(
lck_attr_t *attr);
#define decl_lck_spin_data(class,name) class lck_spin_t name;
extern lck_spin_t *lck_spin_alloc_init(
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_spin_init(
lck_spin_t *lck,
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_spin_lock(
lck_spin_t *lck);
extern void lck_spin_unlock(
lck_spin_t *lck);
extern void lck_spin_destroy(
lck_spin_t *lck,
lck_grp_t *grp);
extern void lck_spin_free(
lck_spin_t *lck,
lck_grp_t *grp);
extern wait_result_t lck_spin_sleep(
lck_spin_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible);
extern wait_result_t lck_spin_sleep_deadline(
lck_spin_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible,
uint64_t deadline);
#ifdef KERNEL_PRIVATE
extern boolean_t lck_spin_try_lock(
lck_spin_t *lck);
struct _lck_mtx_ext_;
extern void lck_mtx_init_ext(lck_mtx_t *lck, struct _lck_mtx_ext_ *lck_ext,
lck_grp_t *grp, lck_attr_t *attr);
#endif
#define decl_lck_mtx_data(class,name) class lck_mtx_t name;
extern lck_mtx_t *lck_mtx_alloc_init(
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_mtx_init(
lck_mtx_t *lck,
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_mtx_lock(
lck_mtx_t *lck);
extern void lck_mtx_unlock(
lck_mtx_t *lck);
extern void lck_mtx_destroy(
lck_mtx_t *lck,
lck_grp_t *grp);
extern void lck_mtx_free(
lck_mtx_t *lck,
lck_grp_t *grp);
extern wait_result_t lck_mtx_sleep(
lck_mtx_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible);
extern wait_result_t lck_mtx_sleep_deadline(
lck_mtx_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible,
uint64_t deadline);
#ifdef KERNEL_PRIVATE
extern boolean_t lck_mtx_try_lock(
lck_mtx_t *lck);
extern void mutex_pause(uint32_t);
extern void lck_mtx_yield (
lck_mtx_t *lck);
#if defined(i386) || defined(x86_64)
extern boolean_t lck_mtx_try_lock_spin(
lck_mtx_t *lck);
extern void lck_mtx_lock_spin(
lck_mtx_t *lck);
extern void lck_mtx_convert_spin(
lck_mtx_t *lck);
#else
#define lck_mtx_try_lock_spin(l) lck_mtx_try_lock(l)
#define lck_mtx_lock_spin(l) lck_mtx_lock(l)
#define lck_mtx_convert_spin(l) do {} while (0)
#endif
#endif /* KERNEL_PRIVATE */
extern void lck_mtx_assert(
lck_mtx_t *lck,
unsigned int type);
__END_DECLS
#define LCK_MTX_ASSERT_OWNED 0x01
#define LCK_MTX_ASSERT_NOTOWNED 0x02
#ifdef MACH_KERNEL_PRIVATE
extern void lck_mtx_lock_wait(
lck_mtx_t *lck,
thread_t holder);
extern int lck_mtx_lock_acquire(
lck_mtx_t *lck);
extern void lck_mtx_unlock_wakeup(
lck_mtx_t *lck,
thread_t holder);
extern void lck_mtx_unlockspin_wakeup(
lck_mtx_t *lck);
extern boolean_t lck_mtx_ilk_unlock(
lck_mtx_t *lck);
#endif
#define decl_lck_rw_data(class,name) class lck_rw_t name;
typedef unsigned int lck_rw_type_t;
#define LCK_RW_TYPE_SHARED 0x01
#define LCK_RW_TYPE_EXCLUSIVE 0x02
#ifdef XNU_KERNEL_PRIVATE
#define LCK_RW_ASSERT_SHARED 0x01
#define LCK_RW_ASSERT_EXCLUSIVE 0x02
#define LCK_RW_ASSERT_HELD (LCK_RW_ASSERT_SHARED | LCK_RW_ASSERT_EXCLUSIVE)
#endif
__BEGIN_DECLS
extern lck_rw_t *lck_rw_alloc_init(
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_rw_init(
lck_rw_t *lck,
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_rw_lock(
lck_rw_t *lck,
lck_rw_type_t lck_rw_type);
extern void lck_rw_unlock(
lck_rw_t *lck,
lck_rw_type_t lck_rw_type);
extern void lck_rw_lock_shared(
lck_rw_t *lck);
extern void lck_rw_unlock_shared(
lck_rw_t *lck);
extern void lck_rw_lock_exclusive(
lck_rw_t *lck);
extern void lck_rw_unlock_exclusive(
lck_rw_t *lck);
#ifdef XNU_KERNEL_PRIVATE
/*
* CAUTION
* read-write locks do not have a concept of ownership, so lck_rw_assert()
* merely asserts that someone is holding the lock, not necessarily the caller.
*/
extern void lck_rw_assert(
lck_rw_t *lck,
unsigned int type);
#endif
#ifdef KERNEL_PRIVATE
extern lck_rw_type_t lck_rw_done(
lck_rw_t *lck);
#endif
extern void lck_rw_destroy(
lck_rw_t *lck,
lck_grp_t *grp);
extern void lck_rw_free(
lck_rw_t *lck,
lck_grp_t *grp);
extern wait_result_t lck_rw_sleep(
lck_rw_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible);
extern wait_result_t lck_rw_sleep_deadline(
lck_rw_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible,
uint64_t deadline);
extern boolean_t lck_rw_lock_shared_to_exclusive(
lck_rw_t *lck);
extern void lck_rw_lock_exclusive_to_shared(
lck_rw_t *lck);
extern boolean_t lck_rw_try_lock(
lck_rw_t *lck,
lck_rw_type_t lck_rw_type);
#ifdef KERNEL_PRIVATE
extern boolean_t lck_rw_try_lock_shared(
lck_rw_t *lck);
extern boolean_t lck_rw_try_lock_exclusive(
lck_rw_t *lck);
#endif
__END_DECLS
#endif /* _KERN_LOCKS_H_ */