pthread_types.h revision 1.19
1/* $NetBSD: pthread_types.h,v 1.19 2016/07/17 13:49:43 skrll Exp $ */ 2 3/*- 4 * Copyright (c) 2001, 2008 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Nathan J. Williams. 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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32#ifndef _LIB_PTHREAD_TYPES_H 33#define _LIB_PTHREAD_TYPES_H 34 35/* 36 * We use the "pthread_spin_t" name internally; "pthread_spinlock_t" is the 37 * POSIX spinlock object. 38 * 39 * C++ expects to be using PTHREAD_FOO_INITIALIZER as a member initializer. 40 * This does not work for volatile types. Since C++ does not touch the guts 41 * of those types, we do not include volatile in the C++ definitions. 42 */ 43typedef __cpu_simple_lock_t pthread_spin_t; 44#ifdef __cplusplus 45typedef __cpu_simple_lock_nv_t __pthread_spin_t; 46#define __pthread_volatile 47#else 48typedef pthread_spin_t __pthread_spin_t; 49#define __pthread_volatile volatile 50#endif 51 52/* 53 * Copied from PTQ_HEAD in pthread_queue.h 54 */ 55#define _PTQ_HEAD(name, type) \ 56struct name { \ 57 struct type *ptqh_first;/* first element */ \ 58 struct type **ptqh_last;/* addr of last next element */ \ 59} 60 61_PTQ_HEAD(pthread_queue_struct_t, __pthread_st); 62typedef struct pthread_queue_struct_t pthread_queue_t; 63 64struct __pthread_st; 65struct __pthread_attr_st; 66struct __pthread_mutex_st; 67struct __pthread_mutexattr_st; 68struct __pthread_cond_st; 69struct __pthread_condattr_st; 70struct __pthread_spin_st; 71struct __pthread_rwlock_st; 72struct __pthread_rwlockattr_st; 73struct __pthread_barrier_st; 74struct __pthread_barrierattr_st; 75 76typedef struct __pthread_st *pthread_t; 77typedef struct __pthread_attr_st pthread_attr_t; 78typedef struct __pthread_mutex_st pthread_mutex_t; 79typedef struct __pthread_mutexattr_st pthread_mutexattr_t; 80typedef struct __pthread_cond_st pthread_cond_t; 81typedef struct __pthread_condattr_st pthread_condattr_t; 82typedef struct __pthread_once_st pthread_once_t; 83typedef struct __pthread_spinlock_st pthread_spinlock_t; 84typedef struct __pthread_rwlock_st pthread_rwlock_t; 85typedef struct __pthread_rwlockattr_st pthread_rwlockattr_t; 86typedef struct __pthread_barrier_st pthread_barrier_t; 87typedef struct __pthread_barrierattr_st pthread_barrierattr_t; 88typedef int pthread_key_t; 89 90struct __pthread_attr_st { 91 unsigned int pta_magic; 92 93 int pta_flags; 94 void *pta_private; 95}; 96 97/* 98 * ptm_owner is the actual lock field which is locked via CAS operation. 99 * This structure's layout is designed to compatible with the previous 100 * version used in SA pthreads. 101 */ 102#ifdef __CPU_SIMPLE_LOCK_PAD 103/* 104 * If __SIMPLE_UNLOCKED != 0 and we have to pad, we have to worry about 105 * endianness. Currently that isn't an issue but put in a check in case 106 * something changes in the future. 107 */ 108#if __SIMPLELOCK_UNLOCKED != 0 109#error __CPU_SIMPLE_LOCK_PAD incompatible with __SIMPLELOCK_UNLOCKED == 0 110#endif 111#endif 112struct __pthread_mutex_st { 113 unsigned int ptm_magic; 114 __pthread_spin_t ptm_errorcheck; 115#ifdef __CPU_SIMPLE_LOCK_PAD 116 uint8_t ptm_pad1[3]; 117#endif 118 union { 119 unsigned char ptm_ceiling; 120 __pthread_spin_t ptm_unused; 121 }; 122#ifdef __CPU_SIMPLE_LOCK_PAD 123 uint8_t ptm_pad2[3]; 124#endif 125 __pthread_volatile pthread_t ptm_owner; 126 pthread_t * __pthread_volatile ptm_waiters; 127 unsigned int ptm_recursed; 128 void *ptm_spare2; /* unused - backwards compat */ 129}; 130 131#define _PT_MUTEX_MAGIC 0x33330003 132#define _PT_MUTEX_DEAD 0xDEAD0003 133 134#ifdef __CPU_SIMPLE_LOCK_PAD 135#define _PTHREAD_MUTEX_INITIALIZER { _PT_MUTEX_MAGIC, \ 136 __SIMPLELOCK_UNLOCKED, { 0, 0, 0 }, \ 137 { 0 }, { 0, 0, 0 }, \ 138 NULL, NULL, 0, NULL \ 139 } 140#else 141#define _PTHREAD_MUTEX_INITIALIZER { _PT_MUTEX_MAGIC, \ 142 __SIMPLELOCK_UNLOCKED, \ 143 { 0 } , \ 144 NULL, NULL, 0, NULL \ 145 } 146#endif /* __CPU_SIMPLE_LOCK_PAD */ 147 148 149struct __pthread_mutexattr_st { 150 unsigned int ptma_magic; 151 void *ptma_private; 152}; 153 154#define _PT_MUTEXATTR_MAGIC 0x44440004 155#define _PT_MUTEXATTR_DEAD 0xDEAD0004 156 157 158struct __pthread_cond_st { 159 unsigned int ptc_magic; 160 161 /* Protects the queue of waiters */ 162 __pthread_spin_t ptc_lock; 163 pthread_queue_t ptc_waiters; 164 165 pthread_mutex_t *ptc_mutex; /* Current mutex */ 166 void *ptc_private; 167}; 168 169#define _PT_COND_MAGIC 0x55550005 170#define _PT_COND_DEAD 0xDEAD0005 171 172#define _PTHREAD_COND_INITIALIZER { _PT_COND_MAGIC, \ 173 __SIMPLELOCK_UNLOCKED, \ 174 {NULL, NULL}, \ 175 NULL, \ 176 NULL \ 177 } 178 179struct __pthread_condattr_st { 180 unsigned int ptca_magic; 181 void *ptca_private; 182}; 183 184#define _PT_CONDATTR_MAGIC 0x66660006 185#define _PT_CONDATTR_DEAD 0xDEAD0006 186 187struct __pthread_once_st { 188 pthread_mutex_t pto_mutex; 189 int pto_done; 190}; 191 192#define _PTHREAD_ONCE_INIT { PTHREAD_MUTEX_INITIALIZER, 0 } 193 194struct __pthread_spinlock_st { 195 unsigned int pts_magic; 196 __pthread_spin_t pts_spin; 197 int pts_flags; 198}; 199 200#define _PT_SPINLOCK_MAGIC 0x77770007 201#define _PT_SPINLOCK_DEAD 0xDEAD0007 202#define _PT_SPINLOCK_PSHARED 0x00000001 203 204/* PTHREAD_SPINLOCK_INITIALIZER is an extension not specified by POSIX. */ 205#define _PTHREAD_SPINLOCK_INITIALIZER { _PT_SPINLOCK_MAGIC, \ 206 __SIMPLELOCK_UNLOCKED, \ 207 0 \ 208 } 209 210struct __pthread_rwlock_st { 211 unsigned int ptr_magic; 212 213 /* Protects data below */ 214 __pthread_spin_t ptr_interlock; 215 216 pthread_queue_t ptr_rblocked; 217 pthread_queue_t ptr_wblocked; 218 unsigned int ptr_nreaders; 219 __pthread_volatile pthread_t ptr_owner; 220 void *ptr_private; 221}; 222 223#define _PT_RWLOCK_MAGIC 0x99990009 224#define _PT_RWLOCK_DEAD 0xDEAD0009 225 226#define _PTHREAD_RWLOCK_INITIALIZER { _PT_RWLOCK_MAGIC, \ 227 __SIMPLELOCK_UNLOCKED, \ 228 {NULL, NULL}, \ 229 {NULL, NULL}, \ 230 0, \ 231 NULL, \ 232 NULL, \ 233 } 234 235struct __pthread_rwlockattr_st { 236 unsigned int ptra_magic; 237 void *ptra_private; 238}; 239 240#define _PT_RWLOCKATTR_MAGIC 0x99990909 241#define _PT_RWLOCKATTR_DEAD 0xDEAD0909 242 243struct __pthread_barrier_st { 244 unsigned int ptb_magic; 245 246 /* Protects data below */ 247 pthread_spin_t ptb_lock; 248 249 pthread_queue_t ptb_waiters; 250 unsigned int ptb_initcount; 251 unsigned int ptb_curcount; 252 unsigned int ptb_generation; 253 254 void *ptb_private; 255}; 256 257#define _PT_BARRIER_MAGIC 0x88880008 258#define _PT_BARRIER_DEAD 0xDEAD0008 259 260struct __pthread_barrierattr_st { 261 unsigned int ptba_magic; 262 void *ptba_private; 263}; 264 265#define _PT_BARRIERATTR_MAGIC 0x88880808 266#define _PT_BARRIERATTR_DEAD 0xDEAD0808 267 268#endif /* _LIB_PTHREAD_TYPES_H */ 269