1 | /* |
2 | * Copyright (c) 2007 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 | * @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 | #ifdef KERNEL_PRIVATE |
58 | |
59 | #ifndef _ARM_SIMPLE_LOCK_TYPES_H_ |
60 | #define _ARM_SIMPLE_LOCK_TYPES_H_ |
61 | |
62 | #ifdef KERNEL_PRIVATE |
63 | #include <mach/boolean.h> |
64 | #include <kern/kern_types.h> |
65 | |
66 | #include <sys/appleapiopts.h> |
67 | #ifdef MACH_KERNEL_PRIVATE |
68 | #include <arm/hw_lock_types.h> |
69 | #include <arm/locks.h> |
70 | #include <mach_ldebug.h> |
71 | #endif |
72 | |
73 | #ifdef MACH_KERNEL_PRIVATE |
74 | |
75 | typedef uint32_t hw_lock_bit_t; |
76 | |
77 | extern void hw_lock_bit( |
78 | hw_lock_bit_t *, |
79 | unsigned int); |
80 | |
81 | extern void hw_lock_bit_nopreempt( |
82 | hw_lock_bit_t *, |
83 | unsigned int); |
84 | |
85 | extern void hw_unlock_bit( |
86 | hw_lock_bit_t *, |
87 | unsigned int); |
88 | |
89 | extern void hw_unlock_bit_nopreempt( |
90 | hw_lock_bit_t *, |
91 | unsigned int); |
92 | |
93 | extern unsigned int hw_lock_bit_try( |
94 | hw_lock_bit_t *, |
95 | unsigned int); |
96 | |
97 | extern unsigned int hw_lock_bit_to( |
98 | hw_lock_bit_t *, |
99 | unsigned int, |
100 | uint32_t); |
101 | |
102 | #define hw_lock_bit_held(l,b) (((*(l))&(1<<b))!=0) |
103 | |
104 | |
105 | extern uint32_t LockTimeOut; /* Number of hardware ticks of a lock timeout */ |
106 | extern uint32_t LockTimeOutUsec; /* Number of microseconds for lock timeout */ |
107 | |
108 | /* |
109 | * USLOCK_DEBUG is broken on ARM and has been disabled. |
110 | * There are no callers to any of the usld_lock functions and data structures |
111 | * don't match between between usimple_lock_data_t and lck_spin_t |
112 | */ |
113 | |
114 | /* |
115 | #if MACH_LDEBUG |
116 | #define USLOCK_DEBUG 1 |
117 | #else |
118 | #define USLOCK_DEBUG 0 |
119 | #endif |
120 | */ |
121 | |
122 | #if !USLOCK_DEBUG |
123 | |
124 | typedef lck_spin_t usimple_lock_data_t, *usimple_lock_t; |
125 | |
126 | #else |
127 | |
128 | typedef struct uslock_debug { |
129 | void *lock_pc; /* pc where lock operation began */ |
130 | void *lock_thread; /* thread that acquired lock */ |
131 | unsigned long duration[2]; |
132 | unsigned short state; |
133 | unsigned char lock_cpu; |
134 | void *unlock_thread; /* last thread to release lock */ |
135 | unsigned char unlock_cpu; |
136 | void *unlock_pc; /* pc where lock operation ended */ |
137 | } uslock_debug; |
138 | |
139 | typedef struct { |
140 | hw_lock_data_t interlock; /* must be first... see lock.c */ |
141 | unsigned short lock_type; /* must be second... see lock.c */ |
142 | #define USLOCK_TAG 0x5353 |
143 | uslock_debug debug; |
144 | } usimple_lock_data_t, *usimple_lock_t; |
145 | |
146 | #endif /* USLOCK_DEBUG */ |
147 | |
148 | #else |
149 | |
150 | #if defined(__arm__) |
151 | typedef struct slock { |
152 | unsigned int lock_data[10]; |
153 | } usimple_lock_data_t, *usimple_lock_t; |
154 | #elif defined(__arm64__) |
155 | /* |
156 | * ARM64_TODO: this is quite a waste of space (and a |
157 | * poorly packed data structure). See if anyone's |
158 | * using these outside of osfmk. |
159 | * NOTE: only osfmk uses this structure in xnu-2624 |
160 | */ |
161 | typedef struct slock { |
162 | uint64_t lock_data[9]; |
163 | } usimple_lock_data_t, *usimple_lock_t; |
164 | #else |
165 | #error Unknown architecture. |
166 | #endif |
167 | |
168 | #endif /* MACH_KERNEL_PRIVATE */ |
169 | |
170 | #define USIMPLE_LOCK_NULL ((usimple_lock_t) 0) |
171 | |
172 | #if !defined(decl_simple_lock_data) |
173 | |
174 | typedef usimple_lock_data_t *simple_lock_t; |
175 | typedef usimple_lock_data_t simple_lock_data_t; |
176 | |
177 | #define decl_simple_lock_data(class,name) \ |
178 | class simple_lock_data_t name; |
179 | |
180 | #endif /* !defined(decl_simple_lock_data) */ |
181 | |
182 | #ifdef MACH_KERNEL_PRIVATE |
183 | |
184 | #define MACHINE_SIMPLE_LOCK |
185 | |
186 | extern void arm_usimple_lock_init(simple_lock_t, __unused unsigned short); |
187 | |
188 | #define simple_lock_init(l,t) arm_usimple_lock_init(l,t) |
189 | #define simple_lock(l) lck_spin_lock(l) |
190 | #define simple_lock_nopreempt(l) lck_spin_lock_nopreempt(l) |
191 | #define simple_unlock(l) lck_spin_unlock(l) |
192 | #define simple_unlock_nopreempt(l) lck_spin_unlock_nopreempt(l) |
193 | #define simple_lock_try(l) lck_spin_try_lock(l) |
194 | #define simple_lock_try_nopreempt(l) lck_spin_try_lock_nopreempt(l) |
195 | #define simple_lock_try_lock_loop(l) simple_lock(l) |
196 | #define simple_lock_addr(l) (&(l)) |
197 | #define simple_lock_assert(l,t) lck_spin_assert(l,t) |
198 | #define kdp_simple_lock_is_acquired(l) kdp_lck_spin_is_acquired(l) |
199 | |
200 | #endif /* MACH_KERNEL_PRIVATE */ |
201 | #endif /* KERNEL_PRIVATE */ |
202 | |
203 | #endif /* !_ARM_SIMPLE_LOCK_TYPES_H_ */ |
204 | |
205 | #endif /* KERNEL_PRIVATE */ |
206 | |