include/os/freebsd/spl/sys/mutex.h

   1 /*
   2  * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _OPENSOLARIS_SYS_MUTEX_H_
  30 #define _OPENSOLARIS_SYS_MUTEX_H_
  31
  32 typedef struct sx       kmutex_t;
  33
  34 #include <sys/param.h>
  35 #include <sys/lock.h>
  36 #include_next <sys/sdt.h>
  37 #include_next <sys/mutex.h>
  38 #include <sys/proc.h>
  39 #include <sys/sx.h>
  40
  41 typedef enum {
  42         MUTEX_DEFAULT = 0       /* kernel default mutex */
  43 } kmutex_type_t;
  44
  45 #define MUTEX_HELD(x)           (mutex_owned(x))
  46 #define MUTEX_NOT_HELD(x)       (!mutex_owned(x) || panicstr)
  47
  48 #ifndef OPENSOLARIS_WITNESS
  49 #define MUTEX_FLAGS     (SX_DUPOK | SX_NEW | SX_NOWITNESS)
  50 #else
  51 #define MUTEX_FLAGS     (SX_DUPOK | SX_NEW)
  52 #endif
  53
  54 #define mutex_init(lock, desc, type, arg)       do {                    \
  55         const char *_name;                                              \
  56         ASSERT((type) == MUTEX_DEFAULT);                                \
  57         for (_name = #lock; *_name != '\0'; _name++) {                  \
  58                 if (*_name >= 'a' && *_name <= 'z')                     \
  59                         break;                                          \
  60         }                                                               \
  61         if (*_name == '\0')                                             \
  62                 _name = #lock;                                          \
  63         sx_init_flags((lock), _name, MUTEX_FLAGS);                      \
  64 } while (0)
  65 #define mutex_destroy(lock)     sx_destroy(lock)
  66 #define mutex_enter(lock)       sx_xlock(lock)
  67 #define mutex_enter_interruptible(lock) sx_xlock_sig(lock)
  68 #define mutex_enter_nested(lock, type)  sx_xlock(lock)
  69 #define mutex_tryenter(lock)    sx_try_xlock(lock)
  70 #define mutex_exit(lock)        sx_xunlock(lock)
  71 #define mutex_owned(lock)       sx_xlocked(lock)
  72 #define mutex_owner(lock)       sx_xholder(lock)
  73 #endif  /* _OPENSOLARIS_SYS_MUTEX_H_ */