1 /* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _SYNCH_H 28 #define _SYNCH_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 /* 33 * synch.h: 34 * definitions needed to use the thread synchronization interface 35 */ 36 37 #ifndef _ASM 38 #include <sys/machlock.h> 39 #include <sys/time_impl.h> 40 #include <sys/synch.h> 41 #endif /* _ASM */ 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 #ifndef _ASM 48 49 /* 50 * Semaphores 51 */ 52 typedef struct _sema { 53 /* this structure must be the same as sem_t in <semaphore.h> */ 54 uint32_t count; /* semaphore count */ 55 uint16_t type; 56 uint16_t magic; 57 upad64_t pad1[3]; /* reserved for a mutex_t */ 58 upad64_t pad2[2]; /* reserved for a cond_t */ 59 } sema_t; 60 61 /* 62 * POSIX.1c Note: 63 * POSIX.1c requires that <pthread.h> define the structures pthread_mutex_t 64 * and pthread_cond_t. These structures are identical to mutex_t (lwp_mutex_t) 65 * and cond_t (lwp_cond_t) which are defined in <synch.h>. A nested included 66 * of <synch.h> (to allow a "#typedef mutex_t pthread_mutex_t") would pull in 67 * non-posix symbols/constants violating the namespace restrictions. Hence, 68 * pthread_mutex_t/pthread_cond_t have been redefined in <pthread.h> (actually 69 * in <sys/types.h>). Any modifications done to mutex_t/lwp_mutex_t or 70 * cond_t/lwp_cond_t should also be done to pthread_mutex_t/pthread_cond_t. 71 */ 72 typedef lwp_mutex_t mutex_t; 73 typedef lwp_cond_t cond_t; 74 75 /* 76 * Readers/writer locks 77 * 78 * NOTE: The layout of this structure should be kept in sync with the layout 79 * of the correponding structure of pthread_rwlock_t in sys/types.h. 80 * Also, there is an identical structure for lwp_rwlock_t in <sys/synch.h>. 81 * Because we have to deal with C++, we cannot redefine this one as that one. 82 */ 83 typedef struct _rwlock { 84 int32_t readers; /* rwstate word */ 85 uint16_t type; 86 uint16_t magic; 87 mutex_t mutex; /* used with process-shared rwlocks */ 88 cond_t readercv; /* used only to indicate ownership */ 89 cond_t writercv; /* used only to indicate ownership */ 90 } rwlock_t; 91 92 #ifdef __STDC__ 93 int _lwp_mutex_lock(lwp_mutex_t *); 94 int _lwp_mutex_unlock(lwp_mutex_t *); 95 int _lwp_mutex_trylock(lwp_mutex_t *); 96 int _lwp_cond_wait(lwp_cond_t *, lwp_mutex_t *); 97 int _lwp_cond_timedwait(lwp_cond_t *, lwp_mutex_t *, timespec_t *); 98 int _lwp_cond_reltimedwait(lwp_cond_t *, lwp_mutex_t *, timespec_t *); 99 int _lwp_cond_signal(lwp_cond_t *); 100 int _lwp_cond_broadcast(lwp_cond_t *); 101 int _lwp_sema_init(lwp_sema_t *, int); 102 int _lwp_sema_wait(lwp_sema_t *); 103 int _lwp_sema_trywait(lwp_sema_t *); 104 int _lwp_sema_post(lwp_sema_t *); 105 int cond_init(cond_t *, int, void *); 106 int cond_destroy(cond_t *); 107 int cond_wait(cond_t *, mutex_t *); 108 int cond_timedwait(cond_t *, mutex_t *, const timespec_t *); 109 int cond_reltimedwait(cond_t *, mutex_t *, const timespec_t *); 110 int cond_signal(cond_t *); 111 int cond_broadcast(cond_t *); 112 int mutex_init(mutex_t *, int, void *); 113 int mutex_destroy(mutex_t *); 114 int mutex_consistent(mutex_t *); 115 int mutex_lock(mutex_t *); 116 int mutex_trylock(mutex_t *); 117 int mutex_unlock(mutex_t *); 118 int rwlock_init(rwlock_t *, int, void *); 119 int rwlock_destroy(rwlock_t *); 120 int rw_rdlock(rwlock_t *); 121 int rw_wrlock(rwlock_t *); 122 int rw_unlock(rwlock_t *); 123 int rw_tryrdlock(rwlock_t *); 124 int rw_trywrlock(rwlock_t *); 125 int sema_init(sema_t *, unsigned int, int, void *); 126 int sema_destroy(sema_t *); 127 int sema_wait(sema_t *); 128 int sema_timedwait(sema_t *, const timespec_t *); 129 int sema_reltimedwait(sema_t *, const timespec_t *); 130 int sema_post(sema_t *); 131 int sema_trywait(sema_t *); 132 133 #else /* __STDC__ */ 134 135 int _lwp_mutex_lock(); 136 int _lwp_mutex_unlock(); 137 int _lwp_mutex_trylock(); 138 int _lwp_cond_wait(); 139 int _lwp_cond_timedwait(); 140 int _lwp_cond_reltimedwait(); 141 int _lwp_cond_signal(); 142 int _lwp_cond_broadcast(); 143 int _lwp_sema_init(); 144 int _lwp_sema_wait(); 145 int _lwp_sema_trywait(); 146 int _lwp_sema_post(); 147 int cond_init(); 148 int cond_destroy(); 149 int cond_wait(); 150 int cond_timedwait(); 151 int cond_reltimedwait(); 152 int cond_signal(); 153 int cond_broadcast(); 154 int mutex_init(); 155 int mutex_destroy(); 156 int mutex_consistent(); 157 int mutex_lock(); 158 int mutex_trylock(); 159 int mutex_unlock(); 160 int rwlock_init(); 161 int rwlock_destroy(); 162 int rw_rdlock(); 163 int rw_wrlock(); 164 int rw_unlock(); 165 int rw_tryrdlock(); 166 int rw_trywrlock(); 167 int sema_init(); 168 int sema_destroy(); 169 int sema_wait(); 170 int sema_timedwait(); 171 int sema_reltimedwait(); 172 int sema_post(); 173 int sema_trywait(); 174 175 #endif /* __STDC__ */ 176 177 #endif /* _ASM */ 178 179 /* "Magic numbers" tagging synchronization object types */ 180 #define MUTEX_MAGIC _MUTEX_MAGIC 181 #define SEMA_MAGIC _SEMA_MAGIC 182 #define COND_MAGIC _COND_MAGIC 183 #define RWL_MAGIC _RWL_MAGIC 184 185 /* 186 * POSIX.1c Note: 187 * DEFAULTMUTEX is defined same as PTHREAD_MUTEX_INITIALIZER in <pthread.h>. 188 * DEFAULTCV is defined same as PTHREAD_COND_INITIALIZER in <pthread.h>. 189 * DEFAULTRWLOCK is defined same as PTHREAD_RWLOCK_INITIALIZER in <pthread.h>. 190 * Any changes to these macros should be reflected in <pthread.h> 191 */ 192 #define DEFAULTMUTEX \ 193 {{0, 0, 0, {USYNC_THREAD}, MUTEX_MAGIC}, \ 194 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0} 195 #define SHAREDMUTEX \ 196 {{0, 0, 0, {USYNC_PROCESS}, MUTEX_MAGIC}, \ 197 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0} 198 #define RECURSIVEMUTEX \ 199 {{0, 0, 0, {USYNC_THREAD|LOCK_RECURSIVE}, MUTEX_MAGIC}, \ 200 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0} 201 #define ERRORCHECKMUTEX \ 202 {{0, 0, 0, {USYNC_THREAD|LOCK_ERRORCHECK}, MUTEX_MAGIC}, \ 203 {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0} 204 #define RECURSIVE_ERRORCHECKMUTEX \ 205 {{0, 0, 0, {USYNC_THREAD|LOCK_RECURSIVE|LOCK_ERRORCHECK}, \ 206 MUTEX_MAGIC}, {{{0, 0, 0, 0, 0, 0, 0, 0}}}, 0} 207 #define DEFAULTCV \ 208 {{{0, 0, 0, 0}, USYNC_THREAD, COND_MAGIC}, 0} 209 #define SHAREDCV \ 210 {{{0, 0, 0, 0}, USYNC_PROCESS, COND_MAGIC}, 0} 211 #define DEFAULTSEMA \ 212 {0, USYNC_THREAD, SEMA_MAGIC, {0, 0, 0}, {0, 0}} 213 #define SHAREDSEMA \ 214 {0, USYNC_PROCESS, SEMA_MAGIC, {0, 0, 0}, {0, 0}} 215 #define DEFAULTRWLOCK \ 216 {0, USYNC_THREAD, RWL_MAGIC, DEFAULTMUTEX, DEFAULTCV, DEFAULTCV} 217 #define SHAREDRWLOCK \ 218 {0, USYNC_PROCESS, RWL_MAGIC, SHAREDMUTEX, SHAREDCV, SHAREDCV} 219 220 /* 221 * Tests on lock states. 222 */ 223 #define SEMA_HELD(x) _sema_held(x) 224 #define RW_READ_HELD(x) _rw_read_held(x) 225 #define RW_WRITE_HELD(x) _rw_write_held(x) 226 #define RW_LOCK_HELD(x) (RW_READ_HELD(x) || RW_WRITE_HELD(x)) 227 #define MUTEX_HELD(x) _mutex_held(x) 228 229 /* 230 * The following definitions are for assertions which can be checked 231 * statically by tools like lock_lint. You can also define your own 232 * run-time test for each. If you don't, we define them to 1 so that 233 * such assertions simply pass. 234 */ 235 #ifndef NO_LOCKS_HELD 236 #define NO_LOCKS_HELD 1 237 #endif 238 #ifndef NO_COMPETING_THREADS 239 #define NO_COMPETING_THREADS 1 240 #endif 241 242 #ifndef _ASM 243 244 #ifdef __STDC__ 245 246 int _sema_held(sema_t *); 247 int _rw_read_held(rwlock_t *); 248 int _rw_write_held(rwlock_t *); 249 int _mutex_held(mutex_t *); 250 251 #else /* __STDC__ */ 252 253 int _sema_held(); 254 int _rw_read_held(); 255 int _rw_write_held(); 256 int _mutex_held(); 257 258 #endif /* __STDC__ */ 259 260 #endif /* _ASM */ 261 262 #ifdef __cplusplus 263 } 264 #endif 265 266 #endif /* _SYNCH_H */ 267