xref: /openbsd/sys/arch/sparc64/include/mutex.h (revision cecf84d4)
1 /*	$OpenBSD: mutex.h,v 1.4 2014/03/29 18:09:30 guenther Exp $	*/
2 
3 /*
4  * Copyright (c) 2004 Artur Grabowski <art@openbsd.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
17  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
18  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
19  * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef _MACHINE_MUTEX_H_
29 #define _MACHINE_MUTEX_H_
30 
31 struct mutex {
32 	volatile void *mtx_owner; /* mutex.S relies upon this being first */
33 	int mtx_wantipl;
34 	int mtx_oldipl;
35 };
36 
37 /*
38  * To prevent lock ordering problems with the kernel lock, we need to
39  * make sure we block all interrupts that can grab the kernel lock.
40  * The simplest way to achieve this is to make sure mutexes always
41  * raise the interrupt priority level to the highest level that has
42  * interrupts that grab the kernel lock.
43  */
44 #ifdef MULTIPROCESSOR
45 #define __MUTEX_IPL(ipl) \
46     (((ipl) > IPL_NONE && (ipl) < IPL_SERIAL) ? IPL_SERIAL : (ipl))
47 #else
48 #define __MUTEX_IPL(ipl) (ipl)
49 #endif
50 
51 #define MUTEX_INITIALIZER(ipl) { NULL, __MUTEX_IPL((ipl)), 0 }
52 
53 void __mtx_init(struct mutex *, int);
54 #define mtx_init(mtx, ipl) __mtx_init((mtx), __MUTEX_IPL((ipl)))
55 
56 #ifdef DIAGNOSTIC
57 #define MUTEX_ASSERT_LOCKED(mtx) do {					\
58 	if ((mtx)->mtx_owner != curcpu())				\
59 		panic("mutex %p not held in %s", (mtx), __func__);	\
60 } while (0)
61 
62 #define MUTEX_ASSERT_UNLOCKED(mtx) do {					\
63 	if ((mtx)->mtx_owner == curcpu())				\
64 		panic("mutex %p held in %s", (mtx), __func__);		\
65 } while (0)
66 #else
67 #define MUTEX_ASSERT_LOCKED(mtx) do { } while (0)
68 #define MUTEX_ASSERT_UNLOCKED(mtx) do { } while (0)
69 #endif
70 
71 #define MUTEX_OLDIPL(mtx)	(mtx)->mtx_oldipl
72 
73 #endif
74