Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 1 | /** |
| 2 | * threads.c: set of generic threading related routines |
| 3 | * |
| 4 | * See Copyright for the status of this software. |
| 5 | * |
| 6 | * Gary Pennington <Gary.Pennington@uk.sun.com> |
| 7 | * daniel@veillard.com |
| 8 | */ |
| 9 | |
Daniel Veillard | 34ce8be | 2002-03-18 19:37:11 +0000 | [diff] [blame] | 10 | #define IN_LIBXML |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 11 | #include "libxml.h" |
| 12 | |
| 13 | #include <string.h> |
| 14 | |
| 15 | #include <libxml/threads.h> |
| 16 | #include <libxml/globals.h> |
| 17 | |
| 18 | #ifdef HAVE_SYS_TYPES_H |
| 19 | #include <sys/types.h> |
| 20 | #endif |
| 21 | #ifdef HAVE_UNISTD_H |
| 22 | #include <unistd.h> |
| 23 | #endif |
| 24 | #ifdef HAVE_STDLIB_H |
| 25 | #include <stdlib.h> |
| 26 | #endif |
| 27 | #ifdef HAVE_PTHREAD_H |
| 28 | #include <pthread.h> |
| 29 | #endif |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 30 | |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 31 | #ifdef HAVE_WIN32_THREADS |
| 32 | #include <windows.h> |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 33 | #ifndef HAVE_COMPILER_TLS |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 34 | #include <process.h> |
| 35 | #endif |
| 36 | #endif |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 37 | |
| 38 | #if defined(SOLARIS) |
| 39 | #include <note.h> |
| 40 | #endif |
| 41 | |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 42 | /* #define DEBUG_THREADS */ |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 43 | |
| 44 | /* |
| 45 | * TODO: this module still uses malloc/free and not xmlMalloc/xmlFree |
| 46 | * to avoid some crazyness since xmlMalloc/xmlFree may actually |
| 47 | * be hosted on allocated blocks needing them for the allocation ... |
| 48 | */ |
| 49 | |
| 50 | /* |
| 51 | * xmlMutex are a simple mutual exception locks |
| 52 | */ |
| 53 | struct _xmlMutex { |
| 54 | #ifdef HAVE_PTHREAD_H |
| 55 | pthread_mutex_t lock; |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 56 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 57 | HANDLE mutex; |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 58 | #else |
| 59 | int empty; |
| 60 | #endif |
| 61 | }; |
| 62 | |
| 63 | /* |
| 64 | * xmlRMutex are reentrant mutual exception locks |
| 65 | */ |
| 66 | struct _xmlRMutex { |
| 67 | #ifdef HAVE_PTHREAD_H |
| 68 | pthread_mutex_t lock; |
| 69 | unsigned int held; |
| 70 | unsigned int waiters; |
| 71 | pthread_t tid; |
| 72 | pthread_cond_t cv; |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 73 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 74 | CRITICAL_SECTION cs; |
| 75 | unsigned int count; |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 76 | #else |
| 77 | int empty; |
| 78 | #endif |
| 79 | }; |
| 80 | /* |
| 81 | * This module still has some internal static data. |
| 82 | * - xmlLibraryLock a global lock |
| 83 | * - globalkey used for per-thread data |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 84 | */ |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 85 | |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 86 | #ifdef HAVE_PTHREAD_H |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 87 | static pthread_key_t globalkey; |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 88 | static pthread_t mainthread; |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 89 | static pthread_once_t once_control = PTHREAD_ONCE_INIT; |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 90 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 91 | #if defined(HAVE_COMPILER_TLS) |
| 92 | static __declspec(thread) xmlGlobalState tlstate; |
| 93 | static __declspec(thread) int tlstate_inited = 0; |
| 94 | #else /* HAVE_COMPILER_TLS */ |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 95 | static DWORD globalkey = TLS_OUT_OF_INDEXES; |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 96 | #endif /* HAVE_COMPILER_TLS */ |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 97 | static DWORD mainthread; |
| 98 | static int run_once_init = 1; |
| 99 | #endif /* HAVE_WIN32_THREADS */ |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 100 | |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 101 | static xmlRMutexPtr xmlLibraryLock = NULL; |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 102 | static void xmlOnceInit(void); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 103 | |
| 104 | /** |
Daniel Veillard | 01c13b5 | 2002-12-10 15:19:08 +0000 | [diff] [blame] | 105 | * xmlNewMutex: |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 106 | * |
| 107 | * xmlNewMutex() is used to allocate a libxml2 token struct for use in |
| 108 | * synchronizing access to data. |
| 109 | * |
| 110 | * Returns a new simple mutex pointer or NULL in case of error |
| 111 | */ |
| 112 | xmlMutexPtr |
| 113 | xmlNewMutex(void) |
| 114 | { |
| 115 | xmlMutexPtr tok; |
| 116 | |
| 117 | if ((tok = malloc(sizeof(xmlMutex))) == NULL) |
| 118 | return (NULL); |
| 119 | #ifdef HAVE_PTHREAD_H |
| 120 | pthread_mutex_init(&tok->lock, NULL); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 121 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 122 | tok->mutex = CreateMutex(NULL, FALSE, NULL); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 123 | #endif |
| 124 | return (tok); |
| 125 | } |
| 126 | |
| 127 | /** |
| 128 | * xmlFreeMutex: |
| 129 | * @tok: the simple mutex |
| 130 | * |
| 131 | * xmlFreeMutex() is used to reclaim resources associated with a libxml2 token |
| 132 | * struct. |
| 133 | */ |
| 134 | void |
| 135 | xmlFreeMutex(xmlMutexPtr tok) |
| 136 | { |
Daniel Veillard | df101d8 | 2003-07-08 14:03:36 +0000 | [diff] [blame] | 137 | if (tok == NULL) return; |
| 138 | |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 139 | #ifdef HAVE_PTHREAD_H |
| 140 | pthread_mutex_destroy(&tok->lock); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 141 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 142 | CloseHandle(tok->mutex); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 143 | #endif |
| 144 | free(tok); |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * xmlMutexLock: |
| 149 | * @tok: the simple mutex |
| 150 | * |
| 151 | * xmlMutexLock() is used to lock a libxml2 token. |
| 152 | */ |
| 153 | void |
Daniel Veillard | 70bcb0e | 2003-08-08 14:00:28 +0000 | [diff] [blame] | 154 | xmlMutexLock(xmlMutexPtr tok) |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 155 | { |
Daniel Veillard | 70bcb0e | 2003-08-08 14:00:28 +0000 | [diff] [blame] | 156 | if (tok == NULL) |
| 157 | return; |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 158 | #ifdef HAVE_PTHREAD_H |
| 159 | pthread_mutex_lock(&tok->lock); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 160 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 161 | WaitForSingleObject(tok->mutex, INFINITE); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 162 | #endif |
| 163 | |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * xmlMutexUnlock: |
| 168 | * @tok: the simple mutex |
| 169 | * |
| 170 | * xmlMutexUnlock() is used to unlock a libxml2 token. |
| 171 | */ |
| 172 | void |
Daniel Veillard | 5805be2 | 2003-08-28 08:03:23 +0000 | [diff] [blame] | 173 | xmlMutexUnlock(xmlMutexPtr tok) |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 174 | { |
Daniel Veillard | 5805be2 | 2003-08-28 08:03:23 +0000 | [diff] [blame] | 175 | if (tok == NULL) |
| 176 | return; |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 177 | #ifdef HAVE_PTHREAD_H |
| 178 | pthread_mutex_unlock(&tok->lock); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 179 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 180 | ReleaseMutex(tok->mutex); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 181 | #endif |
| 182 | } |
| 183 | |
| 184 | /** |
Daniel Veillard | 01c13b5 | 2002-12-10 15:19:08 +0000 | [diff] [blame] | 185 | * xmlNewRMutex: |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 186 | * |
| 187 | * xmlRNewMutex() is used to allocate a reentrant mutex for use in |
| 188 | * synchronizing access to data. token_r is a re-entrant lock and thus useful |
| 189 | * for synchronizing access to data structures that may be manipulated in a |
| 190 | * recursive fashion. |
| 191 | * |
| 192 | * Returns the new reentrant mutex pointer or NULL in case of error |
| 193 | */ |
| 194 | xmlRMutexPtr |
| 195 | xmlNewRMutex(void) |
| 196 | { |
| 197 | xmlRMutexPtr tok; |
| 198 | |
| 199 | if ((tok = malloc(sizeof(xmlRMutex))) == NULL) |
| 200 | return (NULL); |
| 201 | #ifdef HAVE_PTHREAD_H |
| 202 | pthread_mutex_init(&tok->lock, NULL); |
| 203 | tok->held = 0; |
| 204 | tok->waiters = 0; |
William M. Brack | 59002e7 | 2003-07-04 17:01:59 +0000 | [diff] [blame] | 205 | pthread_cond_init(&tok->cv, NULL); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 206 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 207 | InitializeCriticalSection(&tok->cs); |
| 208 | tok->count = 0; |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 209 | #endif |
| 210 | return (tok); |
| 211 | } |
| 212 | |
| 213 | /** |
Daniel Veillard | 01c13b5 | 2002-12-10 15:19:08 +0000 | [diff] [blame] | 214 | * xmlFreeRMutex: |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 215 | * @tok: the reentrant mutex |
| 216 | * |
| 217 | * xmlRFreeMutex() is used to reclaim resources associated with a |
| 218 | * reentrant mutex. |
| 219 | */ |
| 220 | void |
Daniel Veillard | 0ba5923 | 2002-02-10 13:20:39 +0000 | [diff] [blame] | 221 | xmlFreeRMutex(xmlRMutexPtr tok ATTRIBUTE_UNUSED) |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 222 | { |
| 223 | #ifdef HAVE_PTHREAD_H |
| 224 | pthread_mutex_destroy(&tok->lock); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 225 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 226 | DeleteCriticalSection(&tok->cs); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 227 | #endif |
| 228 | free(tok); |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * xmlRMutexLock: |
| 233 | * @tok: the reentrant mutex |
| 234 | * |
| 235 | * xmlRMutexLock() is used to lock a libxml2 token_r. |
| 236 | */ |
| 237 | void |
Daniel Veillard | 0ba5923 | 2002-02-10 13:20:39 +0000 | [diff] [blame] | 238 | xmlRMutexLock(xmlRMutexPtr tok ATTRIBUTE_UNUSED) |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 239 | { |
| 240 | #ifdef HAVE_PTHREAD_H |
| 241 | pthread_mutex_lock(&tok->lock); |
| 242 | if (tok->held) { |
| 243 | if (pthread_equal(tok->tid, pthread_self())) { |
| 244 | tok->held++; |
| 245 | pthread_mutex_unlock(&tok->lock); |
| 246 | return; |
| 247 | } else { |
| 248 | tok->waiters++; |
| 249 | while (tok->held) |
| 250 | pthread_cond_wait(&tok->cv, &tok->lock); |
| 251 | tok->waiters--; |
| 252 | } |
| 253 | } |
| 254 | tok->tid = pthread_self(); |
| 255 | tok->held = 1; |
| 256 | pthread_mutex_unlock(&tok->lock); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 257 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 258 | EnterCriticalSection(&tok->cs); |
| 259 | ++tok->count; |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 260 | #endif |
| 261 | } |
| 262 | |
| 263 | /** |
| 264 | * xmlRMutexUnlock: |
| 265 | * @tok: the reentrant mutex |
| 266 | * |
| 267 | * xmlRMutexUnlock() is used to unlock a libxml2 token_r. |
| 268 | */ |
| 269 | void |
Daniel Veillard | 0ba5923 | 2002-02-10 13:20:39 +0000 | [diff] [blame] | 270 | xmlRMutexUnlock(xmlRMutexPtr tok ATTRIBUTE_UNUSED) |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 271 | { |
| 272 | #ifdef HAVE_PTHREAD_H |
| 273 | pthread_mutex_lock(&tok->lock); |
| 274 | tok->held--; |
| 275 | if (tok->held == 0) { |
| 276 | if (tok->waiters) |
| 277 | pthread_cond_signal(&tok->cv); |
| 278 | tok->tid = 0; |
| 279 | } |
| 280 | pthread_mutex_unlock(&tok->lock); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 281 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 282 | if (!--tok->count) |
| 283 | LeaveCriticalSection(&tok->cs); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 284 | #endif |
| 285 | } |
| 286 | |
| 287 | /************************************************************************ |
| 288 | * * |
| 289 | * Per thread global state handling * |
| 290 | * * |
| 291 | ************************************************************************/ |
| 292 | |
Daniel Veillard | 8bdb91d | 2001-10-31 17:52:43 +0000 | [diff] [blame] | 293 | #ifdef LIBXML_THREAD_ENABLED |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 294 | /** |
| 295 | * xmlFreeGlobalState: |
| 296 | * @state: a thread global state |
| 297 | * |
| 298 | * xmlFreeGlobalState() is called when a thread terminates with a non-NULL |
| 299 | * global state. It is is used here to reclaim memory resources. |
| 300 | */ |
| 301 | static void |
| 302 | xmlFreeGlobalState(void *state) |
| 303 | { |
| 304 | free(state); |
| 305 | } |
| 306 | |
| 307 | /** |
| 308 | * xmlNewGlobalState: |
| 309 | * |
| 310 | * xmlNewGlobalState() allocates a global state. This structure is used to |
| 311 | * hold all data for use by a thread when supporting backwards compatibility |
Daniel Veillard | cbaf399 | 2001-12-31 16:16:02 +0000 | [diff] [blame] | 312 | * of libxml2 to pre-thread-safe behaviour. |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 313 | * |
| 314 | * Returns the newly allocated xmlGlobalStatePtr or NULL in case of error |
| 315 | */ |
| 316 | static xmlGlobalStatePtr |
| 317 | xmlNewGlobalState(void) |
| 318 | { |
| 319 | xmlGlobalState *gs; |
| 320 | |
| 321 | gs = malloc(sizeof(xmlGlobalState)); |
| 322 | if (gs == NULL) |
| 323 | return(NULL); |
| 324 | |
William M. Brack | 8b2c7f1 | 2002-11-22 05:07:29 +0000 | [diff] [blame] | 325 | memset(gs, 0, sizeof(xmlGlobalState)); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 326 | xmlInitializeGlobalState(gs); |
| 327 | return (gs); |
| 328 | } |
Daniel Veillard | 8bdb91d | 2001-10-31 17:52:43 +0000 | [diff] [blame] | 329 | #endif /* LIBXML_THREAD_ENABLED */ |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 330 | |
| 331 | |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 332 | #ifdef HAVE_WIN32_THREADS |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 333 | #if !defined(HAVE_COMPILER_TLS) && defined(LIBXML_STATIC) |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 334 | typedef struct _xmlGlobalStateCleanupHelperParams |
| 335 | { |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 336 | HANDLE thread; |
| 337 | void *memory; |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 338 | } xmlGlobalStateCleanupHelperParams; |
| 339 | |
Daniel Veillard | 01c13b5 | 2002-12-10 15:19:08 +0000 | [diff] [blame] | 340 | static void xmlGlobalStateCleanupHelper (void *p) |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 341 | { |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 342 | xmlGlobalStateCleanupHelperParams *params = (xmlGlobalStateCleanupHelperParams *) p; |
| 343 | WaitForSingleObject(params->thread, INFINITE); |
| 344 | CloseHandle(params->thread); |
| 345 | xmlFreeGlobalState(params->memory); |
| 346 | free(params); |
| 347 | _endthread(); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 348 | } |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 349 | #endif /* HAVE_COMPILER_TLS && LIBXML_STATIC */ |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 350 | #endif /* HAVE_WIN32_THREADS */ |
| 351 | |
Daniel Veillard | 01c13b5 | 2002-12-10 15:19:08 +0000 | [diff] [blame] | 352 | /** |
| 353 | * xmlGetGlobalState: |
| 354 | * |
| 355 | * xmlGetGlobalState() is called to retrieve the global state for a thread. |
| 356 | * |
| 357 | * Returns the thread global state or NULL in case of error |
| 358 | */ |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 359 | xmlGlobalStatePtr |
| 360 | xmlGetGlobalState(void) |
| 361 | { |
| 362 | #ifdef HAVE_PTHREAD_H |
| 363 | xmlGlobalState *globalval; |
| 364 | |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 365 | pthread_once(&once_control, xmlOnceInit); |
| 366 | |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 367 | if ((globalval = (xmlGlobalState *) |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 368 | pthread_getspecific(globalkey)) == NULL) { |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 369 | xmlGlobalState *tsd = xmlNewGlobalState(); |
| 370 | |
| 371 | pthread_setspecific(globalkey, tsd); |
| 372 | return (tsd); |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 373 | } |
| 374 | return (globalval); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 375 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 376 | #if defined(HAVE_COMPILER_TLS) |
| 377 | if (!tlstate_inited) { |
| 378 | tlstate_inited = 1; |
| 379 | xmlInitializeGlobalState(&tlstate); |
| 380 | } |
| 381 | return &tlstate; |
| 382 | #else /* HAVE_COMPILER_TLS */ |
| 383 | xmlGlobalState *globalval; |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 384 | |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 385 | if (run_once_init) { |
| 386 | run_once_init = 0; |
| 387 | xmlOnceInit(); |
| 388 | } |
| 389 | if ((globalval = (xmlGlobalState *) TlsGetValue(globalkey)) == NULL) { |
| 390 | xmlGlobalState *tsd = xmlNewGlobalState(); |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 391 | #if defined(LIBXML_STATIC) |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 392 | xmlGlobalStateCleanupHelperParams *p = |
| 393 | (xmlGlobalStateCleanupHelperParams *) malloc(sizeof(xmlGlobalStateCleanupHelperParams)); |
| 394 | p->memory = tsd; |
| 395 | DuplicateHandle(GetCurrentProcess(), GetCurrentThread(), |
| 396 | GetCurrentProcess(), &p->thread, 0, TRUE, DUPLICATE_SAME_ACCESS); |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 397 | #endif |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 398 | TlsSetValue(globalkey, tsd); |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 399 | #if defined(LIBXML_STATIC) |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 400 | _beginthread(xmlGlobalStateCleanupHelper, 0, p); |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 401 | #endif |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 402 | |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 403 | return (tsd); |
| 404 | } |
| 405 | return (globalval); |
| 406 | #endif /* HAVE_COMPILER_TLS */ |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 407 | #else |
| 408 | return(NULL); |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 409 | #endif |
| 410 | } |
| 411 | |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 412 | /************************************************************************ |
| 413 | * * |
| 414 | * Library wide thread interfaces * |
| 415 | * * |
| 416 | ************************************************************************/ |
| 417 | |
| 418 | /** |
Daniel Veillard | 3c01b1d | 2001-10-17 15:58:35 +0000 | [diff] [blame] | 419 | * xmlGetThreadId: |
| 420 | * |
| 421 | * xmlGetThreadId() find the current thread ID number |
| 422 | * |
| 423 | * Returns the current thread ID number |
| 424 | */ |
| 425 | int |
| 426 | xmlGetThreadId(void) |
| 427 | { |
| 428 | #ifdef HAVE_PTHREAD_H |
| 429 | return((int) pthread_self()); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 430 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 431 | return GetCurrentThreadId(); |
Daniel Veillard | 3c01b1d | 2001-10-17 15:58:35 +0000 | [diff] [blame] | 432 | #else |
| 433 | return((int) 0); |
| 434 | #endif |
| 435 | } |
| 436 | |
| 437 | /** |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 438 | * xmlIsMainThread: |
| 439 | * |
Daniel Veillard | cbaf399 | 2001-12-31 16:16:02 +0000 | [diff] [blame] | 440 | * xmlIsMainThread() check whether the current thread is the main thread. |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 441 | * |
| 442 | * Returns 1 if the current thread is the main thread, 0 otherwise |
| 443 | */ |
| 444 | int |
| 445 | xmlIsMainThread(void) |
| 446 | { |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 447 | #ifdef HAVE_PTHREAD_H |
| 448 | pthread_once(&once_control, xmlOnceInit); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 449 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 450 | if (run_once_init) { |
| 451 | run_once_init = 0; |
| 452 | xmlOnceInit (); |
| 453 | } |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 454 | #endif |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 455 | |
| 456 | #ifdef DEBUG_THREADS |
| 457 | xmlGenericError(xmlGenericErrorContext, "xmlIsMainThread()\n"); |
| 458 | #endif |
| 459 | #ifdef HAVE_PTHREAD_H |
| 460 | return(mainthread == pthread_self()); |
Daniel Veillard | db0eb8d | 2002-01-13 13:35:00 +0000 | [diff] [blame] | 461 | #elif defined HAVE_WIN32_THREADS |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 462 | return(mainthread == GetCurrentThreadId ()); |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 463 | #else |
| 464 | return(1); |
| 465 | #endif |
| 466 | } |
| 467 | |
| 468 | /** |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 469 | * xmlLockLibrary: |
| 470 | * |
| 471 | * xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 |
| 472 | * library. |
| 473 | */ |
| 474 | void |
| 475 | xmlLockLibrary(void) |
| 476 | { |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 477 | #ifdef DEBUG_THREADS |
| 478 | xmlGenericError(xmlGenericErrorContext, "xmlLockLibrary()\n"); |
| 479 | #endif |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 480 | xmlRMutexLock(xmlLibraryLock); |
| 481 | } |
| 482 | |
| 483 | /** |
| 484 | * xmlUnlockLibrary: |
| 485 | * |
| 486 | * xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 |
| 487 | * library. |
| 488 | */ |
| 489 | void |
| 490 | xmlUnlockLibrary(void) |
| 491 | { |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 492 | #ifdef DEBUG_THREADS |
| 493 | xmlGenericError(xmlGenericErrorContext, "xmlUnlockLibrary()\n"); |
| 494 | #endif |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 495 | xmlRMutexUnlock(xmlLibraryLock); |
| 496 | } |
| 497 | |
| 498 | /** |
| 499 | * xmlInitThreads: |
| 500 | * |
| 501 | * xmlInitThreads() is used to to initialize all the thread related |
| 502 | * data of the libxml2 library. |
| 503 | */ |
| 504 | void |
| 505 | xmlInitThreads(void) |
| 506 | { |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 507 | #ifdef DEBUG_THREADS |
| 508 | xmlGenericError(xmlGenericErrorContext, "xmlInitThreads()\n"); |
| 509 | #endif |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 510 | } |
| 511 | |
| 512 | /** |
| 513 | * xmlCleanupThreads: |
| 514 | * |
| 515 | * xmlCleanupThreads() is used to to cleanup all the thread related |
| 516 | * data of the libxml2 library once processing has ended. |
| 517 | */ |
| 518 | void |
| 519 | xmlCleanupThreads(void) |
| 520 | { |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 521 | #ifdef DEBUG_THREADS |
| 522 | xmlGenericError(xmlGenericErrorContext, "xmlCleanupThreads()\n"); |
| 523 | #endif |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 524 | } |
Daniel Veillard | 6f35029 | 2001-10-14 09:56:15 +0000 | [diff] [blame] | 525 | |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 526 | /** |
| 527 | * xmlOnceInit |
| 528 | * |
| 529 | * xmlOnceInit() is used to initialize the value of mainthread for use |
| 530 | * in other routines. This function should only be called using |
| 531 | * pthread_once() in association with the once_control variable to ensure |
| 532 | * that the function is only called once. See man pthread_once for more |
| 533 | * details. |
| 534 | */ |
| 535 | static void |
| 536 | xmlOnceInit(void) { |
| 537 | #ifdef HAVE_PTHREAD_H |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 538 | (void) pthread_key_create(&globalkey, xmlFreeGlobalState); |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 539 | mainthread = pthread_self(); |
Igor Zlatkovic | f2160a0 | 2002-10-31 15:58:42 +0000 | [diff] [blame] | 540 | #endif |
| 541 | |
| 542 | #if defined(HAVE_WIN32_THREADS) |
| 543 | #if !defined(HAVE_COMPILER_TLS) |
| 544 | globalkey = TlsAlloc(); |
| 545 | #endif |
| 546 | mainthread = GetCurrentThreadId(); |
Daniel Veillard | e28313b | 2001-12-06 14:08:31 +0000 | [diff] [blame] | 547 | #endif |
Daniel Veillard | b847864 | 2001-10-12 17:29:10 +0000 | [diff] [blame] | 548 | } |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 549 | |
| 550 | /** |
William M. Brack | 7a82165 | 2003-08-15 07:27:40 +0000 | [diff] [blame] | 551 | * DllMain: |
| 552 | * @hinstDLL: handle to DLL instance |
| 553 | * @fdwReason: Reason code for entry |
| 554 | * @lpvReserved: generic pointer (depends upon reason code) |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 555 | * |
| 556 | * Entry point for Windows library. It is being used to free thread-specific |
| 557 | * storage. |
William M. Brack | 7a82165 | 2003-08-15 07:27:40 +0000 | [diff] [blame] | 558 | * |
| 559 | * Returns TRUE always |
Igor Zlatkovic | d58a42d | 2003-05-17 10:55:15 +0000 | [diff] [blame] | 560 | */ |
| 561 | #if defined(HAVE_WIN32_THREADS) && !defined(LIBXML_STATIC) |
| 562 | BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) |
| 563 | { |
| 564 | switch(fdwReason) { |
| 565 | case DLL_THREAD_DETACH: |
| 566 | if (globalkey != TLS_OUT_OF_INDEXES) { |
| 567 | xmlGlobalState *globalval = (xmlGlobalState *)TlsGetValue(globalkey); |
| 568 | if (globalval) { |
| 569 | xmlFreeGlobalState(globalval); |
| 570 | TlsSetValue(globalkey, NULL); |
| 571 | } |
| 572 | } |
| 573 | break; |
| 574 | case DLL_PROCESS_DETACH: |
| 575 | if (globalkey != TLS_OUT_OF_INDEXES) { |
| 576 | TlsFree(globalkey); |
| 577 | globalkey = TLS_OUT_OF_INDEXES; |
| 578 | } |
| 579 | break; |
| 580 | } |
| 581 | return TRUE; |
| 582 | } |
| 583 | #endif |
| 584 | |