1 | /** |
---|
2 | * @file |
---|
3 | * |
---|
4 | * @ingroup rtems_bsd_rtems |
---|
5 | * |
---|
6 | * @brief TODO. |
---|
7 | */ |
---|
8 | |
---|
9 | /* |
---|
10 | * Copyright (c) 2009-2013 embedded brains GmbH. All rights reserved. |
---|
11 | * |
---|
12 | * embedded brains GmbH |
---|
13 | * Dornierstr. 4 |
---|
14 | * 82178 Puchheim |
---|
15 | * Germany |
---|
16 | * <rtems@embedded-brains.de> |
---|
17 | * |
---|
18 | * Redistribution and use in source and binary forms, with or without |
---|
19 | * modification, are permitted provided that the following conditions |
---|
20 | * are met: |
---|
21 | * 1. Redistributions of source code must retain the above copyright |
---|
22 | * notice, this list of conditions and the following disclaimer. |
---|
23 | * 2. Redistributions in binary form must reproduce the above copyright |
---|
24 | * notice, this list of conditions and the following disclaimer in the |
---|
25 | * documentation and/or other materials provided with the distribution. |
---|
26 | * |
---|
27 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
---|
28 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
29 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
30 | * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
---|
31 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
---|
32 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
---|
33 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
---|
34 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
---|
35 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
---|
36 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
---|
37 | * SUCH DAMAGE. |
---|
38 | */ |
---|
39 | |
---|
40 | #include <machine/rtems-bsd-config.h> |
---|
41 | #include <machine/rtems-bsd-thread.h> |
---|
42 | #include <machine/rtems-bsd-support.h> |
---|
43 | |
---|
44 | #include <rtems/score/objectimpl.h> |
---|
45 | #include <rtems/rtems/attrimpl.h> |
---|
46 | #include <rtems/rtems/semimpl.h> |
---|
47 | |
---|
48 | #include <rtems/bsd/sys/param.h> |
---|
49 | #include <rtems/bsd/sys/types.h> |
---|
50 | #include <sys/systm.h> |
---|
51 | #include <rtems/bsd/sys/lock.h> |
---|
52 | #include <sys/mutex.h> |
---|
53 | #include <sys/proc.h> |
---|
54 | |
---|
55 | static void assert_mtx(struct lock_object *lock, int what); |
---|
56 | static void lock_mtx(struct lock_object *lock, int how); |
---|
57 | #ifdef KDTRACE_HOOKS |
---|
58 | static int owner_mtx(struct lock_object *lock, struct thread **owner); |
---|
59 | #endif |
---|
60 | static int unlock_mtx(struct lock_object *lock); |
---|
61 | |
---|
62 | RTEMS_CHAIN_DEFINE_EMPTY(rtems_bsd_mtx_chain); |
---|
63 | |
---|
64 | /* |
---|
65 | * Lock classes for sleep and spin mutexes. |
---|
66 | */ |
---|
67 | struct lock_class lock_class_mtx_sleep = { |
---|
68 | .lc_name = "sleep mutex", |
---|
69 | .lc_flags = LC_SLEEPLOCK | LC_RECURSABLE, |
---|
70 | .lc_assert = assert_mtx, |
---|
71 | #ifdef DDB |
---|
72 | .lc_ddb_show = db_show_mtx, |
---|
73 | #endif |
---|
74 | .lc_lock = lock_mtx, |
---|
75 | .lc_unlock = unlock_mtx, |
---|
76 | #ifdef KDTRACE_HOOKS |
---|
77 | .lc_owner = owner_mtx, |
---|
78 | #endif |
---|
79 | }; |
---|
80 | |
---|
81 | struct lock_class lock_class_mtx_spin = { |
---|
82 | .lc_name = "spin mutex", |
---|
83 | .lc_flags = LC_SPINLOCK | LC_RECURSABLE, |
---|
84 | .lc_assert = assert_mtx, |
---|
85 | #ifdef DDB |
---|
86 | .lc_ddb_show = db_show_mtx, |
---|
87 | #endif |
---|
88 | .lc_lock = lock_mtx, |
---|
89 | .lc_unlock = unlock_mtx, |
---|
90 | #ifdef KDTRACE_HOOKS |
---|
91 | .lc_owner = owner_mtx, |
---|
92 | #endif |
---|
93 | }; |
---|
94 | |
---|
95 | struct mtx Giant; |
---|
96 | |
---|
97 | void |
---|
98 | assert_mtx(struct lock_object *lock, int what) |
---|
99 | { |
---|
100 | mtx_assert((struct mtx *)lock, what); |
---|
101 | } |
---|
102 | |
---|
103 | void |
---|
104 | lock_mtx(struct lock_object *lock, int how) |
---|
105 | { |
---|
106 | |
---|
107 | mtx_lock((struct mtx *)lock); |
---|
108 | } |
---|
109 | |
---|
110 | int |
---|
111 | unlock_mtx(struct lock_object *lock) |
---|
112 | { |
---|
113 | struct mtx *m; |
---|
114 | |
---|
115 | m = (struct mtx *)lock; |
---|
116 | mtx_assert(m, MA_OWNED | MA_NOTRECURSED); |
---|
117 | mtx_unlock(m); |
---|
118 | return (0); |
---|
119 | } |
---|
120 | |
---|
121 | |
---|
122 | #ifdef KDTRACE_HOOKS |
---|
123 | int |
---|
124 | owner_mtx(struct lock_object *lock, struct thread **owner) |
---|
125 | { |
---|
126 | struct mtx *m = (struct mtx *)lock; |
---|
127 | |
---|
128 | *owner = mtx_owner(m); |
---|
129 | return (mtx_unowned(m) == 0); |
---|
130 | } |
---|
131 | #endif |
---|
132 | |
---|
133 | void |
---|
134 | mtx_init(struct mtx *m, const char *name, const char *type, int opts) |
---|
135 | { |
---|
136 | struct lock_class *class; |
---|
137 | int i; |
---|
138 | rtems_status_code sc = RTEMS_SUCCESSFUL; |
---|
139 | rtems_id id = RTEMS_ID_NONE; |
---|
140 | rtems_attribute attr = RTEMS_LOCAL | RTEMS_BINARY_SEMAPHORE | RTEMS_PRIORITY | RTEMS_INHERIT_PRIORITY; |
---|
141 | |
---|
142 | if ((opts & MTX_RECURSE) != 0 ) |
---|
143 | { |
---|
144 | /*FIXME*/ |
---|
145 | } |
---|
146 | |
---|
147 | /* Determine lock class and lock flags. */ |
---|
148 | if (opts & MTX_SPIN) |
---|
149 | class = &lock_class_mtx_spin; |
---|
150 | else |
---|
151 | class = &lock_class_mtx_sleep; |
---|
152 | |
---|
153 | /* Check for double-init and zero object. */ |
---|
154 | KASSERT(!lock_initalized(&m->lock_object), ("lock \"%s\" %p already initialized", name, m->lock_object)); |
---|
155 | |
---|
156 | /* Look up lock class to find its index. */ |
---|
157 | for (i = 0; i < LOCK_CLASS_MAX; i++) |
---|
158 | { |
---|
159 | if (lock_classes[i] == class) |
---|
160 | { |
---|
161 | m->lock_object.lo_flags = i << LO_CLASSSHIFT; |
---|
162 | break; |
---|
163 | } |
---|
164 | } |
---|
165 | KASSERT(i < LOCK_CLASS_MAX, ("unknown lock class %p", class)); |
---|
166 | |
---|
167 | sc = rtems_semaphore_create( |
---|
168 | rtems_build_name('_', 'M', 'T', 'X'), |
---|
169 | 1, |
---|
170 | attr, |
---|
171 | BSD_TASK_PRIORITY_RESOURCE_OWNER, |
---|
172 | &id |
---|
173 | ); |
---|
174 | BSD_ASSERT_SC(sc); |
---|
175 | |
---|
176 | m->lock_object.lo_name = name; |
---|
177 | m->lock_object.lo_flags |= LO_INITIALIZED; |
---|
178 | m->lock_object.lo_id = id; |
---|
179 | |
---|
180 | rtems_chain_append(&rtems_bsd_mtx_chain, &m->lock_object.lo_node); |
---|
181 | } |
---|
182 | |
---|
183 | void |
---|
184 | _mtx_lock_flags(struct mtx *m, int opts, const char *file, int line) |
---|
185 | { |
---|
186 | rtems_status_code sc = RTEMS_SUCCESSFUL; |
---|
187 | |
---|
188 | sc = rtems_semaphore_obtain(m->lock_object.lo_id, RTEMS_WAIT, RTEMS_NO_TIMEOUT); |
---|
189 | BSD_ASSERT_SC(sc); |
---|
190 | } |
---|
191 | |
---|
192 | int |
---|
193 | _mtx_trylock(struct mtx *m, int opts, const char *file, int line) |
---|
194 | { |
---|
195 | rtems_status_code sc = RTEMS_SUCCESSFUL; |
---|
196 | |
---|
197 | sc = rtems_semaphore_obtain(m->lock_object.lo_id, RTEMS_NO_WAIT, 0); |
---|
198 | if (sc == RTEMS_SUCCESSFUL) { |
---|
199 | return 1; |
---|
200 | } else if (sc == RTEMS_UNSATISFIED) { |
---|
201 | return 0; |
---|
202 | } else { |
---|
203 | BSD_ASSERT_SC(sc); |
---|
204 | |
---|
205 | return 0; |
---|
206 | } |
---|
207 | } |
---|
208 | |
---|
209 | void |
---|
210 | _mtx_unlock_flags(struct mtx *m, int opts, const char *file, int line) |
---|
211 | { |
---|
212 | rtems_status_code sc = RTEMS_SUCCESSFUL; |
---|
213 | |
---|
214 | sc = rtems_semaphore_release(m->lock_object.lo_id); |
---|
215 | BSD_ASSERT_SC(sc); |
---|
216 | } |
---|
217 | |
---|
218 | /* |
---|
219 | * The backing function for the INVARIANTS-enabled mtx_assert() |
---|
220 | */ |
---|
221 | #ifdef INVARIANT_SUPPORT |
---|
222 | void |
---|
223 | _mtx_assert(struct mtx *m, int what, const char *file, int line) |
---|
224 | { |
---|
225 | |
---|
226 | if (panicstr != NULL || dumping) |
---|
227 | return; |
---|
228 | switch (what) { |
---|
229 | case MA_OWNED: |
---|
230 | case MA_OWNED | MA_RECURSED: |
---|
231 | case MA_OWNED | MA_NOTRECURSED: |
---|
232 | if (!mtx_owned(m)) |
---|
233 | panic("mutex %s not owned at %s:%d", |
---|
234 | m->lock_object.lo_name, file, line); |
---|
235 | if (mtx_recursed(m)) { |
---|
236 | if ((what & MA_NOTRECURSED) != 0) |
---|
237 | panic("mutex %s recursed at %s:%d", |
---|
238 | m->lock_object.lo_name, file, line); |
---|
239 | } else if ((what & MA_RECURSED) != 0) { |
---|
240 | panic("mutex %s unrecursed at %s:%d", |
---|
241 | m->lock_object.lo_name, file, line); |
---|
242 | } |
---|
243 | break; |
---|
244 | case MA_NOTOWNED: |
---|
245 | if (mtx_owned(m)) |
---|
246 | panic("mutex %s owned at %s:%d", |
---|
247 | m->lock_object.lo_name, file, line); |
---|
248 | break; |
---|
249 | default: |
---|
250 | panic("unknown mtx_assert at %s:%d", file, line); |
---|
251 | } |
---|
252 | } |
---|
253 | #endif |
---|
254 | |
---|
255 | int mtx_owned(struct mtx *m) |
---|
256 | { |
---|
257 | Objects_Locations location; |
---|
258 | Semaphore_Control *sema = _Semaphore_Get(m->lock_object.lo_id, &location); |
---|
259 | |
---|
260 | if (location == OBJECTS_LOCAL && !_Attributes_Is_counting_semaphore(sema->attribute_set)) { |
---|
261 | int owned = sema->Core_control.mutex.holder_id == rtems_task_self(); |
---|
262 | |
---|
263 | _Thread_Enable_dispatch(); |
---|
264 | |
---|
265 | return owned; |
---|
266 | } else { |
---|
267 | _Thread_Enable_dispatch(); |
---|
268 | |
---|
269 | BSD_PANIC("unexpected semaphore location or attributes"); |
---|
270 | } |
---|
271 | } |
---|
272 | |
---|
273 | int mtx_recursed(struct mtx *m) |
---|
274 | { |
---|
275 | Objects_Locations location; |
---|
276 | Semaphore_Control *sema = _Semaphore_Get(m->lock_object.lo_id, &location); |
---|
277 | |
---|
278 | if (location == OBJECTS_LOCAL && !_Attributes_Is_counting_semaphore(sema->attribute_set)) { |
---|
279 | int recursed = sema->Core_control.mutex.nest_count != 0; |
---|
280 | |
---|
281 | _Thread_Enable_dispatch(); |
---|
282 | |
---|
283 | return recursed; |
---|
284 | } else { |
---|
285 | _Thread_Enable_dispatch(); |
---|
286 | |
---|
287 | BSD_PANIC("unexpected semaphore location or attributes"); |
---|
288 | } |
---|
289 | } |
---|
290 | |
---|
291 | void |
---|
292 | mtx_sysinit(void *arg) |
---|
293 | { |
---|
294 | struct mtx_args *margs = arg; |
---|
295 | |
---|
296 | mtx_init(margs->ma_mtx, margs->ma_desc, NULL, margs->ma_opts); |
---|
297 | } |
---|
298 | |
---|
299 | void |
---|
300 | mtx_destroy(struct mtx *m) |
---|
301 | { |
---|
302 | rtems_status_code sc; |
---|
303 | |
---|
304 | do { |
---|
305 | sc = rtems_semaphore_delete(m->lock_object.lo_id); |
---|
306 | if (sc == RTEMS_RESOURCE_IN_USE) { |
---|
307 | BSD_ASSERT(mtx_owned(m)); |
---|
308 | |
---|
309 | mtx_unlock(m); |
---|
310 | } else { |
---|
311 | BSD_ASSERT_SC(sc); |
---|
312 | } |
---|
313 | } while (sc != RTEMS_SUCCESSFUL); |
---|
314 | |
---|
315 | rtems_chain_extract(&m->lock_object.lo_node); |
---|
316 | |
---|
317 | m->lock_object.lo_id = 0; |
---|
318 | m->lock_object.lo_flags &= ~LO_INITIALIZED; |
---|
319 | } |
---|
320 | |
---|
321 | void |
---|
322 | mutex_init(void) |
---|
323 | { |
---|
324 | mtx_init(&Giant, "Giant", NULL, MTX_DEF | MTX_RECURSE); |
---|
325 | } |
---|