lib/libthr/thread/thr_umtx.h

   1 /*-
   2  * Copyright (c) 2005 David Xu <davidxu@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 AUTHOR 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 AUTHOR 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 _THR_FBSD_UMTX_H_
  30 #define _THR_FBSD_UMTX_H_
  31
  32 #include <strings.h>
  33 #include <sys/umtx.h>
  34
  35 #define DEFAULT_UMUTEX  {0,0,{0,0},{0,0,0,0}}
  36 #define DEFAULT_URWLOCK {0,0,0,0,{0,0,0,0}}
  37
  38 int _umtx_op_err(void *, int op, u_long, void *, void *) __hidden;
  39 int __thr_umutex_lock(struct umutex *mtx, uint32_t id) __hidden;
  40 int __thr_umutex_lock_spin(struct umutex *mtx, uint32_t id) __hidden;
  41 int __thr_umutex_timedlock(struct umutex *mtx, uint32_t id,
  42         const struct timespec *timeout) __hidden;
  43 int __thr_umutex_unlock(struct umutex *mtx, uint32_t id) __hidden;
  44 int __thr_umutex_trylock(struct umutex *mtx) __hidden;
  45 int __thr_umutex_set_ceiling(struct umutex *mtx, uint32_t ceiling,
  46         uint32_t *oldceiling) __hidden;
  47
  48 void _thr_umutex_init(struct umutex *mtx) __hidden;
  49 void _thr_urwlock_init(struct urwlock *rwl) __hidden;
  50
  51 int _thr_umtx_wait(volatile long *mtx, long exp,
  52         const struct timespec *timeout) __hidden;
  53 int _thr_umtx_wait_uint(volatile u_int *mtx, u_int exp,
  54         const struct timespec *timeout, int shared) __hidden;
  55 int _thr_umtx_timedwait_uint(volatile u_int *mtx, u_int exp, int clockid,
  56         const struct timespec *timeout, int shared) __hidden;
  57 int _thr_umtx_wake(volatile void *mtx, int count, int shared) __hidden;
  58 int _thr_ucond_wait(struct ucond *cv, struct umutex *m,
  59         const struct timespec *timeout, int check_unpaking) __hidden;
  60 void _thr_ucond_init(struct ucond *cv) __hidden;
  61 int _thr_ucond_signal(struct ucond *cv) __hidden;
  62 int _thr_ucond_broadcast(struct ucond *cv) __hidden;
  63
  64 int __thr_rwlock_rdlock(struct urwlock *rwlock, int flags, struct timespec *tsp) __hidden;
  65 int __thr_rwlock_wrlock(struct urwlock *rwlock, struct timespec *tsp) __hidden;
  66 int __thr_rwlock_unlock(struct urwlock *rwlock) __hidden;
  67
  68 /* Internal used only */
  69 void _thr_rwl_rdlock(struct urwlock *rwlock) __hidden;
  70 void _thr_rwl_wrlock(struct urwlock *rwlock) __hidden;
  71 void _thr_rwl_unlock(struct urwlock *rwlock) __hidden;
  72
  73 static inline int
  74 _thr_umutex_trylock(struct umutex *mtx, uint32_t id)
  75 {
  76     if (atomic_cmpset_acq_32(&mtx->m_owner, UMUTEX_UNOWNED, id))
  77         return (0);
  78     if ((mtx->m_flags & UMUTEX_PRIO_PROTECT) == 0)
  79         return (EBUSY);
  80     return (__thr_umutex_trylock(mtx));
  81 }
  82
  83 static inline int
  84 _thr_umutex_trylock2(struct umutex *mtx, uint32_t id)
  85 {
  86     if (atomic_cmpset_acq_32(&mtx->m_owner, UMUTEX_UNOWNED, id) != 0)
  87         return (0);
  88     if ((uint32_t)mtx->m_owner == UMUTEX_CONTESTED &&
  89         __predict_true((mtx->m_flags & (UMUTEX_PRIO_PROTECT | UMUTEX_PRIO_INHERIT)) == 0))
  90         if (atomic_cmpset_acq_32(&mtx->m_owner, UMUTEX_CONTESTED, id | UMUTEX_CONTESTED))
  91                 return (0);
  92     return (EBUSY);
  93 }
  94
  95 static inline int
  96 _thr_umutex_lock(struct umutex *mtx, uint32_t id)
  97 {
  98     if (_thr_umutex_trylock2(mtx, id) == 0)
  99         return (0);
 100     return (__thr_umutex_lock(mtx, id));
 101 }
 102
 103 static inline int
 104 _thr_umutex_lock_spin(struct umutex *mtx, uint32_t id)
 105 {
 106     if (_thr_umutex_trylock2(mtx, id) == 0)
 107         return (0);
 108     return (__thr_umutex_lock_spin(mtx, id));
 109 }
 110
 111 static inline int
 112 _thr_umutex_timedlock(struct umutex *mtx, uint32_t id,
 113         const struct timespec *timeout)
 114 {
 115     if (_thr_umutex_trylock2(mtx, id) == 0)
 116         return (0);
 117     return (__thr_umutex_timedlock(mtx, id, timeout));
 118 }
 119
 120 static inline int
 121 _thr_umutex_unlock(struct umutex *mtx, uint32_t id)
 122 {
 123         if (atomic_cmpset_rel_32(&mtx->m_owner, id, UMUTEX_UNOWNED))
 124                 return (0);
 125         return (__thr_umutex_unlock(mtx, id));
 126 }
 127
 128 static inline int
 129 _thr_rwlock_tryrdlock(struct urwlock *rwlock, int flags)
 130 {
 131         int32_t state;
 132         int32_t wrflags;
 133
 134         if (flags & URWLOCK_PREFER_READER || rwlock->rw_flags & URWLOCK_PREFER_READER)
 135                 wrflags = URWLOCK_WRITE_OWNER;
 136         else
 137                 wrflags = URWLOCK_WRITE_OWNER | URWLOCK_WRITE_WAITERS;
 138         state = rwlock->rw_state;
 139         while (!(state & wrflags)) {
 140                 if (__predict_false(URWLOCK_READER_COUNT(state) == URWLOCK_MAX_READERS))
 141                         return (EAGAIN);
 142                 if (atomic_cmpset_acq_32(&rwlock->rw_state, state, state + 1))
 143                         return (0);
 144                 state = rwlock->rw_state;
 145         }
 146
 147         return (EBUSY);
 148 }
 149
 150 static inline int
 151 _thr_rwlock_trywrlock(struct urwlock *rwlock)
 152 {
 153         int32_t state;
 154
 155         state = rwlock->rw_state;
 156         while (!(state & URWLOCK_WRITE_OWNER) && URWLOCK_READER_COUNT(state) == 0) {
 157                 if (atomic_cmpset_acq_32(&rwlock->rw_state, state, state | URWLOCK_WRITE_OWNER))
 158                         return (0);
 159                 state = rwlock->rw_state;
 160         }
 161
 162         return (EBUSY);
 163 }
 164
 165 static inline int
 166 _thr_rwlock_rdlock(struct urwlock *rwlock, int flags, struct timespec *tsp)
 167 {
 168         if (_thr_rwlock_tryrdlock(rwlock, flags) == 0)
 169                 return (0);
 170         return (__thr_rwlock_rdlock(rwlock, flags, tsp));
 171 }
 172
 173 static inline int
 174 _thr_rwlock_wrlock(struct urwlock *rwlock, struct timespec *tsp)
 175 {
 176         if (_thr_rwlock_trywrlock(rwlock) == 0)
 177                 return (0);
 178         return (__thr_rwlock_wrlock(rwlock, tsp));
 179 }
 180
 181 static inline int
 182 _thr_rwlock_unlock(struct urwlock *rwlock)
 183 {
 184         int32_t state;
 185
 186         state = rwlock->rw_state;
 187         if (state & URWLOCK_WRITE_OWNER) {
 188                 if (atomic_cmpset_rel_32(&rwlock->rw_state, URWLOCK_WRITE_OWNER, 0))
 189                         return (0);
 190         } else {
 191                 for (;;) {
 192                         if (__predict_false(URWLOCK_READER_COUNT(state) == 0))
 193                                 return (EPERM);
 194                         if (!((state & (URWLOCK_WRITE_WAITERS |
 195                             URWLOCK_READ_WAITERS)) &&
 196                             URWLOCK_READER_COUNT(state) == 1)) {
 197                                 if (atomic_cmpset_rel_32(&rwlock->rw_state,
 198                                     state, state-1))
 199                                         return (0);
 200                                 state = rwlock->rw_state;
 201                         } else {
 202                                 break;
 203                         }
 204                 }
 205         }
 206         return (__thr_rwlock_unlock(rwlock));
 207 }
 208 #endif