1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
|
/* Thread-local storage in multithreaded situations.
Copyright (C) 2005, 2007-2018 Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. */
/* Written by Bruno Haible <bruno@clisp.org>, 2005. */
/* This file contains thread-local storage primitives for use with a given
thread library. It does not contain primitives for creating threads or
for other multithreading primitives.
Type: gl_tls_key_t
Initialization: gl_tls_key_init (name, destructor);
Getting per-thread value: gl_tls_get (name)
Setting per-thread value: gl_tls_set (name, pointer);
De-initialization: gl_tls_key_destroy (name);
Equivalent functions with control of error handling:
Initialization: err = glthread_tls_key_init (&name, destructor);
Setting per-thread value: err = glthread_tls_set (&name, pointer);
De-initialization: err = glthread_tls_key_destroy (&name);
A per-thread value is of type 'void *'.
A destructor is a function pointer of type 'void (*) (void *)', called
when a thread exits, and taking the last per-thread value as argument. It
is unspecified whether the destructor function is called when the last
per-thread value is NULL. On some platforms, the destructor function is
not called at all.
*/
#ifndef _TLS_H
#define _TLS_H
#include <errno.h>
#include <stdlib.h>
/* ========================================================================= */
#if USE_POSIX_THREADS
/* Use the POSIX threads library. */
# include <pthread.h>
# if PTHREAD_IN_USE_DETECTION_HARD
/* The pthread_in_use() detection needs to be done at runtime. */
# define pthread_in_use() \
glthread_in_use ()
extern int glthread_in_use (void);
# endif
# if USE_POSIX_THREADS_WEAK
/* Use weak references to the POSIX threads library. */
# pragma weak pthread_key_create
# pragma weak pthread_getspecific
# pragma weak pthread_setspecific
# pragma weak pthread_key_delete
# ifndef pthread_self
# pragma weak pthread_self
# endif
# if !PTHREAD_IN_USE_DETECTION_HARD
# pragma weak pthread_mutexattr_gettype
# define pthread_in_use() (pthread_mutexattr_gettype != NULL)
# endif
# else
# if !PTHREAD_IN_USE_DETECTION_HARD
# define pthread_in_use() 1
# endif
# endif
/* ------------------------- gl_tls_key_t datatype ------------------------- */
typedef union
{
void *singlethread_value;
pthread_key_t key;
}
gl_tls_key_t;
# define glthread_tls_key_init(KEY, DESTRUCTOR) \
(pthread_in_use () \
? pthread_key_create (&(KEY)->key, DESTRUCTOR) \
: ((KEY)->singlethread_value = NULL, 0))
# define gl_tls_get(NAME) \
(pthread_in_use () \
? pthread_getspecific ((NAME).key) \
: (NAME).singlethread_value)
# define glthread_tls_set(KEY, POINTER) \
(pthread_in_use () \
? pthread_setspecific ((KEY)->key, (POINTER)) \
: ((KEY)->singlethread_value = (POINTER), 0))
# define glthread_tls_key_destroy(KEY) \
(pthread_in_use () ? pthread_key_delete ((KEY)->key) : 0)
#endif
/* ========================================================================= */
#if USE_PTH_THREADS
/* Use the GNU Pth threads library. */
# include <pth.h>
# if USE_PTH_THREADS_WEAK
/* Use weak references to the GNU Pth threads library. */
# pragma weak pth_key_create
# pragma weak pth_key_getdata
# pragma weak pth_key_setdata
# pragma weak pth_key_delete
# pragma weak pth_cancel
# define pth_in_use() (pth_cancel != NULL)
# else
# define pth_in_use() 1
# endif
/* ------------------------- gl_tls_key_t datatype ------------------------- */
typedef union
{
void *singlethread_value;
pth_key_t key;
}
gl_tls_key_t;
# define glthread_tls_key_init(KEY, DESTRUCTOR) \
(pth_in_use () \
? (!pth_key_create (&(KEY)->key, DESTRUCTOR) ? errno : 0) \
: ((KEY)->singlethread_value = NULL, 0))
# define gl_tls_get(NAME) \
(pth_in_use () \
? pth_key_getdata ((NAME).key) \
: (NAME).singlethread_value)
# define glthread_tls_set(KEY, POINTER) \
(pth_in_use () \
? (!pth_key_setdata ((KEY)->key, (POINTER)) ? errno : 0) \
: ((KEY)->singlethread_value = (POINTER), 0))
# define glthread_tls_key_destroy(KEY) \
(pth_in_use () \
? (!pth_key_delete ((KEY)->key) ? errno : 0) \
: 0)
#endif
/* ========================================================================= */
#if USE_SOLARIS_THREADS
/* Use the old Solaris threads library. */
# include <thread.h>
# if USE_SOLARIS_THREADS_WEAK
/* Use weak references to the old Solaris threads library. */
# pragma weak thr_keycreate
# pragma weak thr_getspecific
# pragma weak thr_setspecific
# pragma weak thr_suspend
# define thread_in_use() (thr_suspend != NULL)
# else
# define thread_in_use() 1
# endif
/* ------------------------- gl_tls_key_t datatype ------------------------- */
typedef union
{
void *singlethread_value;
thread_key_t key;
}
gl_tls_key_t;
# define glthread_tls_key_init(KEY, DESTRUCTOR) \
(thread_in_use () \
? thr_keycreate (&(KEY)->key, DESTRUCTOR) \
: ((KEY)->singlethread_value = NULL, 0))
# define gl_tls_get(NAME) \
(thread_in_use () \
? glthread_tls_get_multithreaded ((NAME).key) \
: (NAME).singlethread_value)
extern void *glthread_tls_get_multithreaded (thread_key_t key);
# define glthread_tls_set(KEY, POINTER) \
(thread_in_use () \
? thr_setspecific ((KEY)->key, (POINTER)) \
: ((KEY)->singlethread_value = (POINTER), 0))
# define glthread_tls_key_destroy(KEY) \
/* Unsupported. */ \
0
#endif
/* ========================================================================= */
#if USE_WINDOWS_THREADS
# define WIN32_LEAN_AND_MEAN /* avoid including junk */
# include <windows.h>
/* ------------------------- gl_tls_key_t datatype ------------------------- */
typedef DWORD gl_tls_key_t;
# define glthread_tls_key_init(KEY, DESTRUCTOR) \
/* The destructor is unsupported. */ \
((*(KEY) = TlsAlloc ()) == (DWORD)-1 ? EAGAIN : ((void) (DESTRUCTOR), 0))
# define gl_tls_get(NAME) \
TlsGetValue (NAME)
# define glthread_tls_set(KEY, POINTER) \
(!TlsSetValue (*(KEY), POINTER) ? EINVAL : 0)
# define glthread_tls_key_destroy(KEY) \
(!TlsFree (*(KEY)) ? EINVAL : 0)
#endif
/* ========================================================================= */
#if !(USE_POSIX_THREADS || USE_PTH_THREADS || USE_SOLARIS_THREADS || USE_WINDOWS_THREADS)
/* Provide dummy implementation if threads are not supported. */
/* ------------------------- gl_tls_key_t datatype ------------------------- */
typedef struct
{
void *singlethread_value;
}
gl_tls_key_t;
# define glthread_tls_key_init(KEY, DESTRUCTOR) \
((KEY)->singlethread_value = NULL, \
(void) (DESTRUCTOR), \
0)
# define gl_tls_get(NAME) \
(NAME).singlethread_value
# define glthread_tls_set(KEY, POINTER) \
((KEY)->singlethread_value = (POINTER), 0)
# define glthread_tls_key_destroy(KEY) \
0
#endif
/* ========================================================================= */
/* Macros with built-in error handling. */
/* ------------------------- gl_tls_key_t datatype ------------------------- */
#define gl_tls_key_init(NAME, DESTRUCTOR) \
do \
{ \
if (glthread_tls_key_init (&NAME, DESTRUCTOR)) \
abort (); \
} \
while (0)
#define gl_tls_set(NAME, POINTER) \
do \
{ \
if (glthread_tls_set (&NAME, POINTER)) \
abort (); \
} \
while (0)
#define gl_tls_key_destroy(NAME) \
do \
{ \
if (glthread_tls_key_destroy (&NAME)) \
abort (); \
} \
while (0)
/* ========================================================================= */
#endif /* _TLS_H */
|