1 /* $OpenBSD: mutex.h,v 1.6 2015/05/02 10:59:47 dlg 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 #define MUTEX_UNLOCKED { 1, 1, 1, 1 } 32 33 /* Note: mtx_lock must be 16-byte aligned. */ 34 struct mutex { 35 #ifdef MULTIPROCESSOR 36 volatile int mtx_lock[4]; 37 #endif 38 int mtx_wantipl; 39 int mtx_oldipl; 40 void *mtx_owner; 41 }; 42 43 /* 44 * To prevent lock ordering problems with the kernel lock, we need to 45 * make sure we block all interrupts that can grab the kernel lock. 46 * The simplest way to achieve this is to make sure mutexes always 47 * raise the interrupt priority level to the highest level that has 48 * interrupts that grab the kernel lock. 49 */ 50 #ifdef MULTIPROCESSOR 51 #define __MUTEX_IPL(ipl) \ 52 (((ipl) > IPL_NONE && (ipl) < IPL_AUDIO) ? IPL_AUDIO : (ipl)) 53 #define MUTEX_INITIALIZER(ipl) { MUTEX_UNLOCKED, __MUTEX_IPL((ipl)), 0, NULL } 54 #else 55 #define __MUTEX_IPL(ipl) (ipl) 56 #define MUTEX_INITIALIZER(ipl) { __MUTEX_IPL((ipl)), 0, NULL } 57 #endif 58 59 void __mtx_init(struct mutex *, int); 60 #define mtx_init(mtx, ipl) __mtx_init((mtx), __MUTEX_IPL((ipl))) 61 62 #ifdef DIAGNOSTIC 63 #define MUTEX_ASSERT_LOCKED(mtx) do { \ 64 if ((mtx)->mtx_owner != curcpu()) \ 65 panic("mutex %p not held in %s", (mtx), __func__); \ 66 } while (0) 67 68 #define MUTEX_ASSERT_UNLOCKED(mtx) do { \ 69 if ((mtx)->mtx_owner == curcpu()) \ 70 panic("mutex %p held in %s", (mtx), __func__); \ 71 } while (0) 72 #else 73 #define MUTEX_ASSERT_LOCKED(mtx) do { } while (0) 74 #define MUTEX_ASSERT_UNLOCKED(mtx) do { } while (0) 75 #endif 76 77 #define MUTEX_OLDIPL(mtx) (mtx)->mtx_oldipl 78 79 #endif 80