sbin/hastd/synch.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2009-2010 The FreeBSD Foundation
   5  * All rights reserved.
   6  *
   7  * This software was developed by Pawel Jakub Dawidek under sponsorship from
   8  * the FreeBSD Foundation.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _SYNCH_H_
  35 #define _SYNCH_H_
  36
  37 #include <errno.h>
  38 #include <pthread.h>
  39 #include <pthread_np.h>
  40 #include <stdbool.h>
  41 #include <time.h>
  42
  43 #include <pjdlog.h>
  44
  45 #ifndef PJDLOG_ASSERT
  46 #include <assert.h>
  47 #define PJDLOG_ASSERT(...)      assert(__VA_ARGS__)
  48 #endif
  49
  50 static __inline void
  51 mtx_init(pthread_mutex_t *lock) __requires_unlocked(*lock)
  52 {
  53         int error;
  54
  55         error = pthread_mutex_init(lock, NULL);
  56         PJDLOG_ASSERT(error == 0);
  57 }
  58 static __inline void
  59 mtx_destroy(pthread_mutex_t *lock) __requires_unlocked(*lock)
  60 {
  61         int error;
  62
  63         error = pthread_mutex_destroy(lock);
  64         PJDLOG_ASSERT(error == 0);
  65 }
  66 static __inline void
  67 mtx_lock(pthread_mutex_t *lock) __locks_exclusive(*lock)
  68 {
  69         int error;
  70
  71         error = pthread_mutex_lock(lock);
  72         PJDLOG_ASSERT(error == 0);
  73 }
  74 static __inline bool
  75 mtx_trylock(pthread_mutex_t *lock) __trylocks_exclusive(true, *lock)
  76 {
  77         int error;
  78
  79         error = pthread_mutex_trylock(lock);
  80         PJDLOG_ASSERT(error == 0 || error == EBUSY);
  81         return (error == 0);
  82 }
  83 static __inline void
  84 mtx_unlock(pthread_mutex_t *lock) __unlocks(*lock)
  85 {
  86         int error;
  87
  88         error = pthread_mutex_unlock(lock);
  89         PJDLOG_ASSERT(error == 0);
  90 }
  91 static __inline bool
  92 mtx_owned(pthread_mutex_t *lock)
  93 {
  94
  95         return (pthread_mutex_isowned_np(lock) != 0);
  96 }
  97
  98 static __inline void
  99 rw_init(pthread_rwlock_t *lock) __requires_unlocked(*lock)
 100 {
 101         int error;
 102
 103         error = pthread_rwlock_init(lock, NULL);
 104         PJDLOG_ASSERT(error == 0);
 105 }
 106 static __inline void
 107 rw_destroy(pthread_rwlock_t *lock) __requires_unlocked(*lock)
 108 {
 109         int error;
 110
 111         error = pthread_rwlock_destroy(lock);
 112         PJDLOG_ASSERT(error == 0);
 113 }
 114 static __inline void
 115 rw_rlock(pthread_rwlock_t *lock) __locks_shared(*lock)
 116 {
 117         int error;
 118
 119         error = pthread_rwlock_rdlock(lock);
 120         PJDLOG_ASSERT(error == 0);
 121 }
 122 static __inline void
 123 rw_wlock(pthread_rwlock_t *lock) __locks_exclusive(*lock)
 124 {
 125         int error;
 126
 127         error = pthread_rwlock_wrlock(lock);
 128         PJDLOG_ASSERT(error == 0);
 129 }
 130 static __inline void
 131 rw_unlock(pthread_rwlock_t *lock) __unlocks(*lock)
 132 {
 133         int error;
 134
 135         error = pthread_rwlock_unlock(lock);
 136         PJDLOG_ASSERT(error == 0);
 137 }
 138
 139 static __inline void
 140 cv_init(pthread_cond_t *cv)
 141 {
 142         pthread_condattr_t attr;
 143         int error;
 144
 145         error = pthread_condattr_init(&attr);
 146         PJDLOG_ASSERT(error == 0);
 147         error = pthread_condattr_setclock(&attr, CLOCK_MONOTONIC);
 148         PJDLOG_ASSERT(error == 0);
 149         error = pthread_cond_init(cv, &attr);
 150         PJDLOG_ASSERT(error == 0);
 151         error = pthread_condattr_destroy(&attr);
 152         PJDLOG_ASSERT(error == 0);
 153 }
 154 static __inline void
 155 cv_wait(pthread_cond_t *cv, pthread_mutex_t *lock) __requires_exclusive(*lock)
 156 {
 157         int error;
 158
 159         error = pthread_cond_wait(cv, lock);
 160         PJDLOG_ASSERT(error == 0);
 161 }
 162 static __inline bool
 163 cv_timedwait(pthread_cond_t *cv, pthread_mutex_t *lock, int timeout)
 164     __requires_exclusive(*lock)
 165 {
 166         struct timespec ts;
 167         int error;
 168
 169         if (timeout == 0) {
 170                 cv_wait(cv, lock);
 171                 return (false);
 172         }
 173
 174         error = clock_gettime(CLOCK_MONOTONIC, &ts);
 175         PJDLOG_ASSERT(error == 0);
 176         ts.tv_sec += timeout;
 177         error = pthread_cond_timedwait(cv, lock, &ts);
 178         PJDLOG_ASSERT(error == 0 || error == ETIMEDOUT);
 179         return (error == ETIMEDOUT);
 180 }
 181 static __inline void
 182 cv_signal(pthread_cond_t *cv)
 183 {
 184         int error;
 185
 186         error = pthread_cond_signal(cv);
 187         PJDLOG_ASSERT(error == 0);
 188 }
 189 static __inline void
 190 cv_broadcast(pthread_cond_t *cv)
 191 {
 192         int error;
 193
 194         error = pthread_cond_broadcast(cv);
 195         PJDLOG_ASSERT(error == 0);
 196 }
 197 #endif  /* !_SYNCH_H_ */