mutex.h revision 1.1 
1/*	$NetBSD: mutex.h,v 1.1 2007/02/18 07:24:52 matt Exp $	*/
2
3/*-
4 * Copyright (c) 2002, 2007 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe and Andrew Doran.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *	This product includes software developed by the NetBSD
21 *	Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 *    contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39#ifndef _ARM_MUTEX_H_
40#define	_ARM_MUTEX_H_
41
42/*
43 * The arm mutex implementation is troublesome, because arm lacks a
44 * compare-and-set operation.  However, there aren't MP arms.
45 * SMP for spin mutexes is easy - we don't need
46 * to know who owns the lock.  For adaptive mutexes, we need an aditional
47 * interlock.
48 *
49 * The locked byte set by the sparc 'ldstub' instruction is 0xff.  sparc
50 * kernels are always loaded above 0xe0000000, and the low 5 bits of any
51 * "struct lwp *" are always zero.  So, to record the lock owner, we only
52 * need 23 bits of space.  mtxa_owner contains the mutex owner's address
53 * shifted right by 5: the top three bits of which will always be 0xe,
54 * overlapping with the interlock at the top byte, which is always 0xff
55 * when the mutex is held.
56 *
57 * For a mutex acquisition, the owner field is set in two steps: first,
58 * acquire the interlock (top byte), and then test the owner's address.
59 * Once the owner field is non zero, it will appear that the mutex is held,
60 * by which LWP it does not matter: other LWPs competing for the lock will
61 * fall through to mutex_vector_enter(), and either spin or sleep.
62 *
63 * As a result there is no space for a waiters bit in the owner field.  No
64 * problem, because it would be hard to synchronise using one without a CAS
65 * operation.  Note that in order to do unlocked release of adaptive
66 * mutexes, we need the effect of MUTEX_SET_WAITERS() to be immediatley
67 * visible on the bus.  So, adaptive mutexes share the spin lock byte with
68 * spin mutexes (set with ldstub), but it is not treated as a lock in its
69 * own right, rather as a flag that can be atomically set or cleared.
70 *
71 * When releasing an adaptive mutex, we first clear the owners field, and
72 * then check to see if the waiters byte is set.  This ensures that there
73 * will always be someone to wake any sleeping waiters up (even it the mutex
74 * is acquired immediately after we release it, or if we are preempted
75 * immediatley after clearing the owners field).  The setting or clearing of
76 * the waiters byte is serialized by the turnstile chain lock associated
77 * with the mutex.
78 *
79 * See comments in kern_mutex.c about releasing adaptive mutexes without
80 * an interlocking step.
81 */
82
83#ifndef __MUTEX_PRIVATE
84
85struct kmutex {
86	uintptr_t	mtx_pad1;
87	uint32_t	mtx_pad2[4];
88};
89
90#else	/* __MUTEX_PRIVATE */
91
92struct kmutex {
93	volatile uintptr_t	mtx_owner;		/* 0-3 */
94	__cpu_simple_lock_t	mtx_interlock;		/* 4-7 */
95	ipl_cookie_t		mtx_ipl;		/* 8-11 */
96	__cpu_simple_lock_t	mtx_lock;		/* 12-15 */
97	uint32_t		mtx_id;			/* 16-19 */
98};
99
100#if 0
101#define	__HAVE_MUTEX_STUBS	1
102#define	__HAVE_SPIN_MUTEX_STUBS	1
103#endif
104
105static inline uintptr_t
106MUTEX_OWNER(uintptr_t owner)
107{
108	return owner;
109}
110
111static inline int
112MUTEX_OWNED(uintptr_t owner)
113{
114	return owner != 0;
115}
116
117static inline int
118MUTEX_SET_WAITERS(kmutex_t *mtx, uintptr_t owner)
119{
120	(void)__cpu_simple_lock_try(&mtx->mtx_lock);
121 	return mtx->mtx_owner != 0;
122}
123
124static inline void
125MUTEX_CLEAR_WAITERS(kmutex_t *mtx)
126{
127	__cpu_simple_unlock(&mtx->mtx_lock);
128}
129
130static inline int
131MUTEX_HAS_WAITERS(volatile kmutex_t *mtx)
132{
133	if (mtx->mtx_owner == 0)
134		return 0;
135	return mtx->mtx_lock == __SIMPLELOCK_LOCKED;
136}
137
138static inline void
139MUTEX_INITIALIZE_SPIN(kmutex_t *mtx, u_int id, int ipl)
140{
141	mtx->mtx_id = (id << 1) | 1;
142	mtx->mtx_ipl = makeiplcookie(ipl);
143	mtx->mtx_interlock = __SIMPLELOCK_LOCKED;
144	__cpu_simple_lock_init(&mtx->mtx_lock);
145}
146
147static inline void
148MUTEX_INITIALIZE_ADAPTIVE(kmutex_t *mtx, u_int id)
149{
150	mtx->mtx_id = (id << 1) | 0;
151	__cpu_simple_lock_init(&mtx->mtx_interlock);
152	__cpu_simple_lock_init(&mtx->mtx_lock);
153}
154
155static inline void
156MUTEX_DESTROY(kmutex_t *mtx)
157{
158	mtx->mtx_owner = (uintptr_t)-1L;
159	mtx->mtx_id = ~0;
160}
161
162static inline u_int
163MUTEX_GETID(kmutex_t *mtx)
164{
165	return mtx->mtx_id >> 1;
166}
167
168static inline bool
169MUTEX_SPIN_P(volatile kmutex_t *mtx)
170{
171	return (mtx->mtx_id & 1) == 1;
172}
173
174static inline bool
175MUTEX_ADAPTIVE_P(volatile kmutex_t *mtx)
176{
177	return (mtx->mtx_id & 1) == 0;
178}
179
180static inline int
181MUTEX_ACQUIRE(kmutex_t *mtx, uintptr_t curthread)
182{
183	if (!__cpu_simple_lock_try(&mtx->mtx_interlock))
184		return 0;
185	mtx->mtx_owner = curthread;
186	return 1;
187}
188
189static inline void
190MUTEX_RELEASE(kmutex_t *mtx)
191{
192	mtx->mtx_owner = 0;
193	__cpu_simple_unlock(&mtx->mtx_lock);
194	__cpu_simple_unlock(&mtx->mtx_interlock);
195}
196
197#endif	/* __MUTEX_PRIVATE */
198
199#endif /* _ARM_MUTEX_H_ */
200