]> git.saurik.com Git - apple/xnu.git/blame_incremental - osfmk/kern/lock.h
xnu-792.22.5.tar.gz
[apple/xnu.git] / osfmk / kern / lock.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2000-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 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56/*
57 * File: kern/lock.h
58 * Author: Avadis Tevanian, Jr., Michael Wayne Young
59 * Date: 1985
60 *
61 * Higher Level Locking primitives definitions
62 */
63
64#ifdef KERNEL_PRIVATE
65
66#ifndef _KERN_LOCK_H_
67#define _KERN_LOCK_H_
68
69#include <kern/simple_lock.h>
70#include <machine/lock.h>
71#include <sys/cdefs.h>
72
73__BEGIN_DECLS
74
75#ifndef MACH_KERNEL_PRIVATE
76
77typedef struct __mutex__ mutex_t;
78
79#else /* MACH_KERNEL_PRIVATE */
80
81#define decl_mutex_data(class,name) class mutex_t name;
82#define mutex_addr(m) (&(m))
83
84extern void mutex_init(
85 mutex_t *mutex,
86 unsigned short tag);
87
88#endif /* MACH_KERNEL_PRIVATE */
89
90extern mutex_t *mutex_alloc(
91 unsigned short tag);
92
93extern void mutex_free(
94 mutex_t *mutex);
95
96extern void mutex_lock(
97 mutex_t *mutex);
98
99extern void mutex_unlock(
100 mutex_t *mutex);
101
102extern boolean_t mutex_try(
103 mutex_t *mutex);
104
105extern void mutex_pause(void);
106
107#define MA_OWNED 0x01
108#define MA_NOTOWNED 0x02
109
110void _mutex_assert (
111 mutex_t *mutex,
112 unsigned int what);
113
114#define mutex_assert(a, b) _mutex_assert(a, b)
115
116#ifndef MACH_KERNEL_PRIVATE
117
118typedef struct __lock__ lock_t;
119
120#else /* MACH_KERNEL_PRIVATE */
121
122extern void lock_init(
123 lock_t *lock,
124 boolean_t can_sleep,
125 unsigned short tag0,
126 unsigned short tag1);
127
128#endif /* MACH_KERNEL_PRIVATE */
129
130extern lock_t *lock_alloc(
131 boolean_t can_sleep,
132 unsigned short tag0,
133 unsigned short tag1);
134
135extern void lock_free(
136 lock_t *lock);
137
138extern void lock_write(
139 lock_t *lock);
140
141extern void lock_read(
142 lock_t *lock);
143
144extern void lock_done(
145 lock_t *lock);
146
147extern void lock_write_to_read(
148 lock_t *lock);
149
150#define lock_read_done(l) lock_done(l)
151#define lock_write_done(l) lock_done(l)
152
153extern boolean_t lock_read_to_write(
154 lock_t *lock);
155
156
157/* Sleep, unlocking and then relocking a usimple_lock in the process */
158extern wait_result_t thread_sleep_usimple_lock(
159 event_t event,
160 usimple_lock_t lock,
161 wait_interrupt_t interruptible);
162
163/* Sleep, unlocking and then relocking a mutex in the process */
164extern wait_result_t thread_sleep_mutex(
165 event_t event,
166 mutex_t *mutex,
167 wait_interrupt_t interruptible);
168
169/* Sleep with a deadline, unlocking and then relocking a mutex in the process */
170extern wait_result_t thread_sleep_mutex_deadline(
171 event_t event,
172 mutex_t *mutex,
173 uint64_t deadline,
174 wait_interrupt_t interruptible);
175
176/* Sleep, unlocking and then relocking a write lock in the process */
177extern wait_result_t thread_sleep_lock_write(
178 event_t event,
179 lock_t *lock,
180 wait_interrupt_t interruptible);
181__END_DECLS
182
183#ifdef MACH_KERNEL_PRIVATE
184
185extern wait_result_t thread_sleep_fast_usimple_lock(
186 event_t event,
187 simple_lock_t lock,
188 wait_interrupt_t interruptible);
189#endif /* MACH_KERNEL_PRIVATE */
190
191#endif /* _KERN_LOCK_H_ */
192
193#endif /* KERNEL_PRIVATE */