4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 1992, 2010, Oracle and/or its affiliates. All rights reserved.
31 * definitions needed to use the thread synchronization interface
35 #include <sys/machlock.h>
36 #include <sys/time_impl.h>
37 #include <sys/synch.h>
49 typedef struct _sema {
50 /* this structure must be the same as sem_t in <semaphore.h> */
51 uint32_t count; /* semaphore count */
54 upad64_t pad1[3]; /* reserved for a mutex_t */
55 upad64_t pad2[2]; /* reserved for a cond_t */
60 * POSIX.1c requires that <pthread.h> define the structures pthread_mutex_t
61 * and pthread_cond_t. These structures are identical to mutex_t (lwp_mutex_t)
62 * and cond_t (lwp_cond_t) which are defined in <synch.h>. A nested included
63 * of <synch.h> (to allow a "#typedef mutex_t pthread_mutex_t") would pull in
64 * non-posix symbols/constants violating the namespace restrictions. Hence,
65 * pthread_mutex_t/pthread_cond_t have been redefined in <pthread.h> (actually
66 * in <sys/types.h>). Any modifications done to mutex_t/lwp_mutex_t or
67 * cond_t/lwp_cond_t should also be done to pthread_mutex_t/pthread_cond_t.
69 typedef lwp_mutex_t mutex_t;
70 typedef lwp_cond_t cond_t;
73 * Readers/writer locks
75 * NOTE: The layout of this structure should be kept in sync with the layout
76 * of the correponding structure of pthread_rwlock_t in sys/types.h.
77 * Also, there is an identical structure for lwp_rwlock_t in <sys/synch.h>.
78 * Because we have to deal with C++, we cannot redefine this one as that one.
80 typedef struct _rwlock {
81 int32_t readers; /* rwstate word */
84 mutex_t mutex; /* used with process-shared rwlocks */
85 cond_t readercv; /* used only to indicate ownership */
86 cond_t writercv; /* used only to indicate ownership */
90 int _lwp_mutex_lock(lwp_mutex_t *);
91 int _lwp_mutex_unlock(lwp_mutex_t *);
92 int _lwp_mutex_trylock(lwp_mutex_t *);
93 int _lwp_cond_wait(lwp_cond_t *, lwp_mutex_t *);
94 int _lwp_cond_timedwait(lwp_cond_t *, lwp_mutex_t *, timespec_t *);
95 int _lwp_cond_reltimedwait(lwp_cond_t *, lwp_mutex_t *, timespec_t *);
96 int _lwp_cond_signal(lwp_cond_t *);
97 int _lwp_cond_broadcast(lwp_cond_t *);
98 int _lwp_sema_init(lwp_sema_t *, int);
99 int _lwp_sema_wait(lwp_sema_t *);
100 int _lwp_sema_trywait(lwp_sema_t *);
101 int _lwp_sema_post(lwp_sema_t *);
102 int cond_init(cond_t *, int, void *);
103 int cond_destroy(cond_t *);
104 int cond_wait(cond_t *, mutex_t *);
105 int cond_timedwait(cond_t *, mutex_t *, const timespec_t *);
106 int cond_reltimedwait(cond_t *, mutex_t *, const timespec_t *);
107 int cond_signal(cond_t *);
108 int cond_broadcast(cond_t *);
109 int mutex_init(mutex_t *, int, void *);
110 int mutex_destroy(mutex_t *);
111 int mutex_consistent(mutex_t *);
112 int mutex_lock(mutex_t *);
113 int mutex_trylock(mutex_t *);
114 int mutex_unlock(mutex_t *);
115 int rwlock_init(rwlock_t *, int, void *);
116 int rwlock_destroy(rwlock_t *);
117 int rw_rdlock(rwlock_t *);
118 int rw_wrlock(rwlock_t *);
119 int rw_unlock(rwlock_t *);
120 int rw_tryrdlock(rwlock_t *);
121 int rw_trywrlock(rwlock_t *);
122 int sema_init(sema_t *, unsigned int, int, void *);
123 int sema_destroy(sema_t *);
124 int sema_wait(sema_t *);
125 int sema_timedwait(sema_t *, const timespec_t *);
126 int sema_reltimedwait(sema_t *, const timespec_t *);
127 int sema_post(sema_t *);
128 int sema_trywait(sema_t *);
132 int _lwp_mutex_lock();
133 int _lwp_mutex_unlock();
134 int _lwp_mutex_trylock();
135 int _lwp_cond_wait();
136 int _lwp_cond_timedwait();
137 int _lwp_cond_reltimedwait();
138 int _lwp_cond_signal();
139 int _lwp_cond_broadcast();
140 int _lwp_sema_init();
141 int _lwp_sema_wait();
142 int _lwp_sema_trywait();
143 int _lwp_sema_post();
147 int cond_timedwait();
148 int cond_reltimedwait();
150 int cond_broadcast();
153 int mutex_consistent();
158 int rwlock_destroy();
167 int sema_timedwait();
168 int sema_reltimedwait();
172 #endif /* __STDC__ */
176 /* "Magic numbers" tagging synchronization object types */
177 #define MUTEX_MAGIC _MUTEX_MAGIC
178 #define SEMA_MAGIC _SEMA_MAGIC
179 #define COND_MAGIC _COND_MAGIC
180 #define RWL_MAGIC _RWL_MAGIC
184 * DEFAULTMUTEX is defined same as PTHREAD_MUTEX_INITIALIZER in <pthread.h>.
185 * DEFAULTCV is defined same as PTHREAD_COND_INITIALIZER in <pthread.h>.
186 * DEFAULTRWLOCK is defined same as PTHREAD_RWLOCK_INITIALIZER in <pthread.h>.
187 * Any changes to these macros should be reflected in <pthread.h>
189 #define DEFAULTMUTEX \
190 {{0, 0, 0, {USYNC_THREAD}, MUTEX_MAGIC}, \
191 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0}
192 #define SHAREDMUTEX \
193 {{0, 0, 0, {USYNC_PROCESS}, MUTEX_MAGIC}, \
194 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0}
195 #define RECURSIVEMUTEX \
196 {{0, 0, 0, {USYNC_THREAD|LOCK_RECURSIVE}, MUTEX_MAGIC}, \
197 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0}
198 #define ERRORCHECKMUTEX \
199 {{0, 0, 0, {USYNC_THREAD|LOCK_ERRORCHECK}, MUTEX_MAGIC}, \
200 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0}
201 #define RECURSIVE_ERRORCHECKMUTEX \
202 {{0, 0, 0, {USYNC_THREAD|LOCK_RECURSIVE|LOCK_ERRORCHECK}, \
203 MUTEX_MAGIC}, {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0}
205 {{{0, 0, 0, 0}, USYNC_THREAD, COND_MAGIC}, 0}
207 {{{0, 0, 0, 0}, USYNC_PROCESS, COND_MAGIC}, 0}
208 #define DEFAULTSEMA \
209 {0, USYNC_THREAD, SEMA_MAGIC, {0, 0, 0}, {0, 0}}
211 {0, USYNC_PROCESS, SEMA_MAGIC, {0, 0, 0}, {0, 0}}
212 #define DEFAULTRWLOCK \
213 {0, USYNC_THREAD, RWL_MAGIC, DEFAULTMUTEX, DEFAULTCV, DEFAULTCV}
214 #define SHAREDRWLOCK \
215 {0, USYNC_PROCESS, RWL_MAGIC, SHAREDMUTEX, SHAREDCV, SHAREDCV}
218 * Tests on lock states.
220 #define SEMA_HELD(x) _sema_held(x)
221 #define RW_READ_HELD(x) _rw_read_held(x)
222 #define RW_WRITE_HELD(x) _rw_write_held(x)
223 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x))
224 #define MUTEX_HELD(x) _mutex_held(x)
227 * The following definitions are for assertions which can be checked
228 * statically by tools like lock_lint. You can also define your own
229 * run-time test for each. If you don't, we define them to 1 so that
230 * such assertions simply pass.
232 #ifndef NO_LOCKS_HELD
233 #define NO_LOCKS_HELD 1
235 #ifndef NO_COMPETING_THREADS
236 #define NO_COMPETING_THREADS 1
244 * The *_held() functions apply equally well to Solaris threads
245 * and to Posix threads synchronization objects, but the formal
246 * type declarations are different, so we just declare the argument
247 * to each *_held() function to be a void *, expecting that they will
248 * be called with the proper type of argument in each case.
250 int _sema_held(void *); /* sema_t or sem_t */
251 int _rw_read_held(void *); /* rwlock_t or pthread_rwlock_t */
252 int _rw_write_held(void *); /* rwlock_t or pthread_rwlock_t */
253 int _mutex_held(void *); /* mutex_t or pthread_mutex_t */
259 int _rw_write_held();
262 #endif /* __STDC__ */
266 void smt_pause(void);
269 #endif /* __STDC__ */
277 #endif /* _SYNCH_H */