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