1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
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
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
48static __inline void
49mtx_init(pthread_mutex_t *lock) __requires_unlocked(*lock)
50{
51	int error;
52
53	error = pthread_mutex_init(lock, NULL);
54	PJDLOG_ASSERT(error == 0);
55}
56static __inline void
57mtx_destroy(pthread_mutex_t *lock) __requires_unlocked(*lock)
58{
59	int error;
60
61	error = pthread_mutex_destroy(lock);
62	PJDLOG_ASSERT(error == 0);
63}
64static __inline void
65mtx_lock(pthread_mutex_t *lock) __locks_exclusive(*lock)
66{
67	int error;
68
69	error = pthread_mutex_lock(lock);
70	PJDLOG_ASSERT(error == 0);
71}
72static __inline bool
73mtx_trylock(pthread_mutex_t *lock) __trylocks_exclusive(true, *lock)
74{
75	int error;
76
77	error = pthread_mutex_trylock(lock);
78	PJDLOG_ASSERT(error == 0 || error == EBUSY);
79	return (error == 0);
80}
81static __inline void
82mtx_unlock(pthread_mutex_t *lock) __unlocks(*lock)
83{
84	int error;
85
86	error = pthread_mutex_unlock(lock);
87	PJDLOG_ASSERT(error == 0);
88}
89static __inline bool
90mtx_owned(pthread_mutex_t *lock)
91{
92
93	return (pthread_mutex_isowned_np(lock) != 0);
94}
95
96static __inline void
97rw_init(pthread_rwlock_t *lock) __requires_unlocked(*lock)
98{
99	int error;
100
101	error = pthread_rwlock_init(lock, NULL);
102	PJDLOG_ASSERT(error == 0);
103}
104static __inline void
105rw_destroy(pthread_rwlock_t *lock) __requires_unlocked(*lock)
106{
107	int error;
108
109	error = pthread_rwlock_destroy(lock);
110	PJDLOG_ASSERT(error == 0);
111}
112static __inline void
113rw_rlock(pthread_rwlock_t *lock) __locks_shared(*lock)
114{
115	int error;
116
117	error = pthread_rwlock_rdlock(lock);
118	PJDLOG_ASSERT(error == 0);
119}
120static __inline void
121rw_wlock(pthread_rwlock_t *lock) __locks_exclusive(*lock)
122{
123	int error;
124
125	error = pthread_rwlock_wrlock(lock);
126	PJDLOG_ASSERT(error == 0);
127}
128static __inline void
129rw_unlock(pthread_rwlock_t *lock) __unlocks(*lock)
130{
131	int error;
132
133	error = pthread_rwlock_unlock(lock);
134	PJDLOG_ASSERT(error == 0);
135}
136
137static __inline void
138cv_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}
152static __inline void
153cv_wait(pthread_cond_t *cv, pthread_mutex_t *lock) __requires_exclusive(*lock)
154{
155	int error;
156
157	error = pthread_cond_wait(cv, lock);
158	PJDLOG_ASSERT(error == 0);
159}
160static __inline bool
161cv_timedwait(pthread_cond_t *cv, pthread_mutex_t *lock, int timeout)
162    __requires_exclusive(*lock)
163{
164	struct timespec ts;
165	int error;
166
167	if (timeout == 0) {
168		cv_wait(cv, lock);
169		return (false);
170	}
171
172	error = clock_gettime(CLOCK_MONOTONIC, &ts);
173	PJDLOG_ASSERT(error == 0);
174	ts.tv_sec += timeout;
175	error = pthread_cond_timedwait(cv, lock, &ts);
176	PJDLOG_ASSERT(error == 0 || error == ETIMEDOUT);
177	return (error == ETIMEDOUT);
178}
179static __inline void
180cv_signal(pthread_cond_t *cv)
181{
182	int error;
183
184	error = pthread_cond_signal(cv);
185	PJDLOG_ASSERT(error == 0);
186}
187static __inline void
188cv_broadcast(pthread_cond_t *cv)
189{
190	int error;
191
192	error = pthread_cond_broadcast(cv);
193	PJDLOG_ASSERT(error == 0);
194}
195#endif	/* !_SYNCH_H_ */
196