sys/sys/umtx.h

   1 /*-
   2  * Copyright (c) 2002, Jeffrey Roberson <jeff@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 unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  *
  28  */
  29
  30 #ifndef _SYS_UMTX_H_
  31 #define _SYS_UMTX_H_
  32
  33 #include <sys/_umtx.h>
  34 #include <sys/limits.h>
  35
  36 #define UMTX_UNOWNED            0x0
  37 #define UMTX_CONTESTED          LONG_MIN
  38
  39 #define USYNC_PROCESS_SHARED    0x0001  /* Process shared sync objs */
  40
  41 #define UMUTEX_UNOWNED          0x0
  42 #define UMUTEX_CONTESTED        0x80000000U
  43
  44 #define UMUTEX_ERROR_CHECK      0x0002  /* Error-checking mutex */
  45 #define UMUTEX_PRIO_INHERIT     0x0004  /* Priority inherited mutex */
  46 #define UMUTEX_PRIO_PROTECT     0x0008  /* Priority protect mutex */
  47
  48 /* urwlock flags */
  49 #define URWLOCK_PREFER_READER   0x0002
  50
  51 #define URWLOCK_WRITE_OWNER     0x80000000U
  52 #define URWLOCK_WRITE_WAITERS   0x40000000U
  53 #define URWLOCK_READ_WAITERS    0x20000000U
  54 #define URWLOCK_MAX_READERS     0x1fffffffU
  55 #define URWLOCK_READER_COUNT(c) ((c) & URWLOCK_MAX_READERS)
  56
  57 /* _usem flags */
  58 #define SEM_NAMED       0x0002
  59
  60 /* op code for _umtx_op */
  61 #define UMTX_OP_LOCK            0
  62 #define UMTX_OP_UNLOCK          1
  63 #define UMTX_OP_WAIT            2
  64 #define UMTX_OP_WAKE            3
  65 #define UMTX_OP_MUTEX_TRYLOCK   4
  66 #define UMTX_OP_MUTEX_LOCK      5
  67 #define UMTX_OP_MUTEX_UNLOCK    6
  68 #define UMTX_OP_SET_CEILING     7
  69 #define UMTX_OP_CV_WAIT         8
  70 #define UMTX_OP_CV_SIGNAL       9
  71 #define UMTX_OP_CV_BROADCAST    10
  72 #define UMTX_OP_WAIT_UINT       11
  73 #define UMTX_OP_RW_RDLOCK       12
  74 #define UMTX_OP_RW_WRLOCK       13
  75 #define UMTX_OP_RW_UNLOCK       14
  76 #define UMTX_OP_WAIT_UINT_PRIVATE       15
  77 #define UMTX_OP_WAKE_PRIVATE    16
  78 #define UMTX_OP_MUTEX_WAIT      17
  79 #define UMTX_OP_MUTEX_WAKE      18
  80 #define UMTX_OP_SEM_WAIT        19
  81 #define UMTX_OP_SEM_WAKE        20
  82 #define UMTX_OP_MAX             21
  83
  84 /* flags for UMTX_OP_CV_WAIT */
  85 #define UMTX_CHECK_UNPARKING    0x01
  86
  87 #ifndef _KERNEL
  88
  89 int _umtx_op(void *obj, int op, u_long val, void *uaddr, void *uaddr2);
  90
  91 /*
  92  * Old (deprecated) userland mutex system calls.
  93  */
  94 int _umtx_lock(struct umtx *mtx);
  95 int _umtx_unlock(struct umtx *mtx);
  96
  97 /*
  98  * Standard api.  Try uncontested acquire/release and asks the
  99  * kernel to resolve failures.
 100  */
 101 static __inline void
 102 umtx_init(struct umtx *umtx)
 103 {
 104         umtx->u_owner = UMTX_UNOWNED;
 105 }
 106
 107 static __inline u_long
 108 umtx_owner(struct umtx *umtx)
 109 {
 110         return (umtx->u_owner & ~LONG_MIN);
 111 }
 112
 113 static __inline int
 114 umtx_lock(struct umtx *umtx, u_long id)
 115 {
 116         if (atomic_cmpset_acq_long(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
 117                 if (_umtx_lock(umtx) == -1)
 118                         return (errno);
 119         return (0);
 120 }
 121
 122 static __inline int
 123 umtx_trylock(struct umtx *umtx, u_long id)
 124 {
 125         if (atomic_cmpset_acq_long(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
 126                 return (EBUSY);
 127         return (0);
 128 }
 129
 130 static __inline int
 131 umtx_timedlock(struct umtx *umtx, u_long id, const struct timespec *timeout)
 132 {
 133         if (atomic_cmpset_acq_long(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
 134                 if (_umtx_op(umtx, UMTX_OP_LOCK, id, 0,
 135                     __DECONST(void *, timeout)) == -1)
 136                         return (errno);
 137         return (0);
 138 }
 139
 140 static __inline int
 141 umtx_unlock(struct umtx *umtx, u_long id)
 142 {
 143         if (atomic_cmpset_rel_long(&umtx->u_owner, id, UMTX_UNOWNED) == 0)
 144                 if (_umtx_unlock(umtx) == -1)
 145                         return (errno);
 146         return (0);
 147 }
 148
 149 static __inline int
 150 umtx_wait(u_long *p, long val, const struct timespec *timeout)
 151 {
 152         if (_umtx_op(p, UMTX_OP_WAIT, val, 0,
 153             __DECONST(void *, timeout)) == -1)
 154                 return (errno);
 155         return (0);
 156 }
 157
 158 /* Wake threads waiting on a user address. */
 159 static __inline int
 160 umtx_wake(u_long *p, int nr_wakeup)
 161 {
 162         if (_umtx_op(p, UMTX_OP_WAKE, nr_wakeup, 0, 0) == -1)
 163                 return (errno);
 164         return (0);
 165 }
 166
 167 #else
 168
 169 struct thread;
 170
 171 struct umtx_q *umtxq_alloc(void);
 172 void umtxq_free(struct umtx_q *);
 173 int kern_umtx_wake(struct thread *, void *, int, int);
 174 void umtx_pi_adjust(struct thread *, u_char);
 175 void umtx_thread_init(struct thread *);
 176 void umtx_thread_fini(struct thread *);
 177 void umtx_thread_alloc(struct thread *);
 178 void umtx_thread_exit(struct thread *);
 179 #endif /* !_KERNEL */
 180 #endif /* !_SYS_UMTX_H_ */