thread.h 12.3 KB
Newer Older
Vicent Marti committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
Vicent Marti committed
3 4 5 6
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
7 8
#ifndef INCLUDE_thread_h__
#define INCLUDE_thread_h__
9

10 11 12 13 14
#if defined(GIT_THREADS)

#if defined(__clang__)

# if (__clang_major__ < 3 || (__clang_major__ == 3 && __clang_minor__ < 1))
15
#  error Atomic primitives do not exist on this version of clang; configure libgit2 with -DUSE_THREADS=OFF
16 17 18 19 20 21
# else
#  define GIT_BUILTIN_ATOMIC
# endif

#elif defined(__GNUC__)

22
# if (__GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 1))
23
#  error Atomic primitives do not exist on this version of gcc; configure libgit2 with -DUSE_THREADS=OFF
24
# elif (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7))
25 26 27 28 29
#  define GIT_BUILTIN_ATOMIC
# else
#  define GIT_BUILTIN_SYNC
# endif

30 31
#endif

32 33
#endif /* GIT_THREADS */

Vicent Marti committed
34 35
/* Common operations even if threading has been disabled */
typedef struct {
36
#if defined(GIT_WIN32)
37 38
	volatile long val;
#else
Vicent Marti committed
39
	volatile int val;
40
#endif
41
} git_atomic32;
Vicent Marti committed
42

43 44
#ifdef GIT_ARCH_64

45 46
typedef struct {
#if defined(GIT_WIN32)
47
	volatile __int64 val;
48
#else
49
	volatile int64_t val;
50 51 52
#endif
} git_atomic64;

53 54
typedef git_atomic64 git_atomic_ssize;

55
#define git_atomic_ssize_set git_atomic64_set
56
#define git_atomic_ssize_add git_atomic64_add
57
#define git_atomic_ssize_get git_atomic64_get
58 59 60

#else

61
typedef git_atomic32 git_atomic_ssize;
62

63 64 65
#define git_atomic_ssize_set git_atomic32_set
#define git_atomic_ssize_add git_atomic32_add
#define git_atomic_ssize_get git_atomic32_get
66 67 68

#endif

Vicent Marti committed
69 70
#ifdef GIT_THREADS

71
#ifdef GIT_WIN32
72
#   include "win32/thread.h"
73
#else
74
#   include "unix/pthread.h"
75
#endif
76

77 78 79
/*
 * Atomically sets the contents of *a to be val.
 */
80
GIT_INLINE(void) git_atomic32_set(git_atomic32 *a, int val)
81 82 83
{
#if defined(GIT_WIN32)
	InterlockedExchange(&a->val, (LONG)val);
84 85 86
#elif defined(GIT_BUILTIN_ATOMIC)
	__atomic_store_n(&a->val, val, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
87 88 89 90 91 92
	__sync_lock_test_and_set(&a->val, val);
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

93 94 95 96
/*
 * Atomically increments the contents of *a by 1, and stores the result back into *a.
 * @return the result of the operation.
 */
97
GIT_INLINE(int) git_atomic32_inc(git_atomic32 *a)
Vicent Marti committed
98
{
99
#if defined(GIT_WIN32)
Vicent Marti committed
100
	return InterlockedIncrement(&a->val);
101 102 103
#elif defined(GIT_BUILTIN_ATOMIC)
	return __atomic_add_fetch(&a->val, 1, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
104
	return __sync_add_and_fetch(&a->val, 1);
Vicent Marti committed
105 106 107 108 109
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

110 111 112 113
/*
 * Atomically adds the contents of *a and addend, and stores the result back into *a.
 * @return the result of the operation.
 */
114
GIT_INLINE(int) git_atomic32_add(git_atomic32 *a, int32_t addend)
115 116
{
#if defined(GIT_WIN32)
117
	return InterlockedAdd(&a->val, addend);
118 119 120
#elif defined(GIT_BUILTIN_ATOMIC)
	return __atomic_add_fetch(&a->val, addend, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
121 122 123 124 125 126
	return __sync_add_and_fetch(&a->val, addend);
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

127 128 129 130
/*
 * Atomically decrements the contents of *a by 1, and stores the result back into *a.
 * @return the result of the operation.
 */
131
GIT_INLINE(int) git_atomic32_dec(git_atomic32 *a)
Vicent Marti committed
132
{
133
#if defined(GIT_WIN32)
Vicent Marti committed
134
	return InterlockedDecrement(&a->val);
135 136 137
#elif defined(GIT_BUILTIN_ATOMIC)
	return __atomic_sub_fetch(&a->val, 1, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
138
	return __sync_sub_and_fetch(&a->val, 1);
Vicent Marti committed
139 140 141 142 143
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

144 145 146 147
/*
 * Atomically gets the contents of *a.
 * @return the contents of *a.
 */
148
GIT_INLINE(int) git_atomic32_get(git_atomic32 *a)
149 150 151 152 153 154 155 156 157 158 159 160
{
#if defined(GIT_WIN32)
	return (int)InterlockedCompareExchange(&a->val, 0, 0);
#elif defined(GIT_BUILTIN_ATOMIC)
	return __atomic_load_n(&a->val, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
	return __sync_val_compare_and_swap(&a->val, 0, 0);
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

161
GIT_INLINE(void *) git_atomic__compare_and_swap(
162
	void * volatile *ptr, void *oldval, void *newval)
163 164
{
#if defined(GIT_WIN32)
165
	return InterlockedCompareExchangePointer((volatile PVOID *)ptr, newval, oldval);
166
#elif defined(GIT_BUILTIN_ATOMIC)
167 168 169
	void *foundval = oldval;
	__atomic_compare_exchange(ptr, &foundval, &newval, false, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST);
	return foundval;
170
#elif defined(GIT_BUILTIN_SYNC)
171
	return __sync_val_compare_and_swap(ptr, oldval, newval);
172 173 174 175 176
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

177
GIT_INLINE(volatile void *) git_atomic__swap(
178 179 180 181
	void * volatile *ptr, void *newval)
{
#if defined(GIT_WIN32)
	return InterlockedExchangePointer(ptr, newval);
182
#elif defined(GIT_BUILTIN_ATOMIC)
183
	void * foundval = NULL;
184 185 186
	__atomic_exchange(ptr, &newval, &foundval, __ATOMIC_SEQ_CST);
	return foundval;
#elif defined(GIT_BUILTIN_SYNC)
187
	return (volatile void *)__sync_lock_test_and_set(ptr, newval);
188 189 190 191 192
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

193
GIT_INLINE(volatile void *) git_atomic__load(void * volatile *ptr)
194 195 196
{
#if defined(GIT_WIN32)
	void *newval = NULL, *oldval = NULL;
197
	return (volatile void *)InterlockedCompareExchangePointer((volatile PVOID *)ptr, newval, oldval);
198 199 200 201 202 203
#elif defined(GIT_BUILTIN_ATOMIC)
	return (volatile void *)__atomic_load_n(ptr, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
	return (volatile void *)__sync_val_compare_and_swap(ptr, 0, 0);
#else
#	error "Unsupported architecture for atomic operations"
204 205 206
#endif
}

207 208
#ifdef GIT_ARCH_64

209 210 211 212
/*
 * Atomically adds the contents of *a and addend, and stores the result back into *a.
 * @return the result of the operation.
 */
213
GIT_INLINE(int64_t) git_atomic64_add(git_atomic64 *a, int64_t addend)
214 215
{
#if defined(GIT_WIN32)
216
	return InterlockedAdd64(&a->val, addend);
217 218 219
#elif defined(GIT_BUILTIN_ATOMIC)
	return __atomic_add_fetch(&a->val, addend, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
220 221 222 223 224 225
	return __sync_add_and_fetch(&a->val, addend);
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

226 227 228
/*
 * Atomically sets the contents of *a to be val.
 */
229 230 231 232 233 234 235 236 237 238 239 240 241
GIT_INLINE(void) git_atomic64_set(git_atomic64 *a, int64_t val)
{
#if defined(GIT_WIN32)
	InterlockedExchange64(&a->val, val);
#elif defined(GIT_BUILTIN_ATOMIC)
	__atomic_store_n(&a->val, val, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
	__sync_lock_test_and_set(&a->val, val);
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

242 243 244 245
/*
 * Atomically gets the contents of *a.
 * @return the contents of *a.
 */
246 247 248 249 250 251 252 253 254 255 256 257 258
GIT_INLINE(int64_t) git_atomic64_get(git_atomic64 *a)
{
#if defined(GIT_WIN32)
	return (int64_t)InterlockedCompareExchange64(&a->val, 0, 0);
#elif defined(GIT_BUILTIN_ATOMIC)
	return __atomic_load_n(&a->val, __ATOMIC_SEQ_CST);
#elif defined(GIT_BUILTIN_SYNC)
	return __sync_val_compare_and_swap(&a->val, 0, 0);
#else
#	error "Unsupported architecture for atomic operations"
#endif
}

259 260
#endif

Vicent Marti committed
261 262
#else

263
#define git_threads_global_init	git__noop
264

Vicent Marti committed
265
#define git_thread unsigned int
266 267
#define git_thread_create(t, s, a) git__noop(t, s, a)
#define git_thread_join(i, s)	git__noop_args(i, s)
Vicent Marti committed
268 269 270

/* Pthreads Mutex */
#define git_mutex unsigned int
271 272 273 274 275
#define git_mutex_init(a)	git__noop_args(a)
#define git_mutex_init(a)	git__noop_args(a)
#define git_mutex_lock(a)	git__noop_args(a)
#define git_mutex_unlock(a)	git__noop_args(a)
#define git_mutex_free(a)	git__noop_args(a)
Vicent Marti committed
276

277
/* Pthreads condition vars */
Vicent Marti committed
278
#define git_cond unsigned int
279 280 281 282 283
#define git_cond_init(c)	git__noop_args(c)
#define git_cond_free(c)	git__noop_args(c)
#define git_cond_wait(c, l)	git__noop_args(c, l)
#define git_cond_signal(c)	git__noop_args(c)
#define git_cond_broadcast(c)	git__noop_args(c)
Vicent Marti committed
284

285 286
/* Pthreads rwlock */
#define git_rwlock unsigned int
287 288 289 290 291 292 293
#define git_rwlock_init(a)	git__noop_args(a)
#define git_rwlock_rdlock(a)	git__noop_args(a)
#define git_rwlock_rdunlock(a)	git__noop_args(a)
#define git_rwlock_wrlock(a)	git__noop_args(a)
#define git_rwlock_wrunlock(a)	git__noop_args(a)
#define git_rwlock_free(a)	git__noop_args(a)

294 295 296
#define GIT_RWLOCK_STATIC_INIT	0


297
GIT_INLINE(void) git_atomic32_set(git_atomic32 *a, int val)
298 299 300 301
{
	a->val = val;
}

302
GIT_INLINE(int) git_atomic32_inc(git_atomic32 *a)
Vicent Marti committed
303 304 305 306
{
	return ++a->val;
}

307
GIT_INLINE(int) git_atomic32_add(git_atomic32 *a, int32_t addend)
308 309 310 311 312
{
	a->val += addend;
	return a->val;
}

313
GIT_INLINE(int) git_atomic32_dec(git_atomic32 *a)
Vicent Marti committed
314 315 316 317
{
	return --a->val;
}

318
GIT_INLINE(int) git_atomic32_get(git_atomic32 *a)
319 320 321 322
{
	return (int)a->val;
}

323
GIT_INLINE(void *) git_atomic__compare_and_swap(
324
	void * volatile *ptr, void *oldval, void *newval)
325
{
326 327
	void *foundval = *ptr;
	if (foundval == oldval)
328
		*ptr = newval;
329
	return foundval;
330 331
}

332
GIT_INLINE(volatile void *) git_atomic__swap(
333 334 335 336 337 338 339
	void * volatile *ptr, void *newval)
{
	volatile void *old = *ptr;
	*ptr = newval;
	return old;
}

340
GIT_INLINE(volatile void *) git_atomic__load(void * volatile *ptr)
341 342 343 344
{
	return *ptr;
}

345 346 347
#ifdef GIT_ARCH_64

GIT_INLINE(int64_t) git_atomic64_add(git_atomic64 *a, int64_t addend)
348 349 350 351 352
{
	a->val += addend;
	return a->val;
}

353 354 355 356
GIT_INLINE(void) git_atomic64_set(git_atomic64 *a, int64_t val)
{
	a->val = val;
}
357

358
GIT_INLINE(int64_t) git_atomic64_get(git_atomic64 *a)
359
{
360
	return (int64_t)a->val;
361 362
}

363 364 365 366
#endif

#endif

367 368 369 370 371 372 373 374 375 376 377 378 379 380
/*
 * Atomically replace the contents of *ptr (if they are equal to oldval) with
 * newval. ptr must point to a pointer or a value that is the same size as a
 * pointer. This is semantically compatible with:
 *
 *   #define git_atomic_compare_and_swap(ptr, oldval, newval) \
 *   ({                                                       \
 *       void *foundval = *ptr;                               \
 *       if (foundval == oldval)                              \
 *           *ptr = newval;                                   \
 *       foundval;                                            \
 *   })
 *
 * @return the original contents of *ptr.
381
 */
382 383
#define git_atomic_compare_and_swap(ptr, oldval, newval) \
	git_atomic__compare_and_swap((void * volatile *)ptr, oldval, newval)
384

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
/*
 * Atomically replace the contents of v with newval. v must be the same size as
 * a pointer. This is semantically compatible with:
 *
 *   #define git_atomic_swap(v, newval) \
 *   ({                                 \
 *       volatile void *old = v;        \
 *       v = newval;                    \
 *       old;                           \
 *   })
 *
 * @return the original contents of v.
 */
#define git_atomic_swap(v, newval) \
	(void *)git_atomic__swap((void * volatile *)&(v), newval)
400

401 402 403 404 405 406 407 408 409 410
/*
 * Atomically reads the contents of v. v must be the same size as a pointer.
 * This is semantically compatible with:
 *
 *   #define git_atomic_load(v) v
 *
 * @return the contents of v.
 */
#define git_atomic_load(v) \
	(void *)git_atomic__load((void * volatile *)&(v))
411 412 413 414 415 416 417 418 419 420 421

#if defined(GIT_THREADS)

# if defined(GIT_WIN32)
#  define GIT_MEMORY_BARRIER MemoryBarrier()
# elif defined(GIT_BUILTIN_ATOMIC)
#  define GIT_MEMORY_BARRIER __atomic_thread_fence(__ATOMIC_SEQ_CST)
# elif defined(GIT_BUILTIN_SYNC)
#  define GIT_MEMORY_BARRIER __sync_synchronize()
# endif

422
#else
423

424
# define GIT_MEMORY_BARRIER /* noop */
425

426 427
#endif

428 429 430 431 432 433 434 435 436 437 438
/* Thread-local data */

#if !defined(GIT_THREADS)
# define git_tlsdata_key int
#elif defined(GIT_WIN32)
# define git_tlsdata_key DWORD
#elif defined(_POSIX_THREADS)
# define git_tlsdata_key pthread_key_t
#else
# error unknown threading model
#endif
439 440

/**
441 442 443
 * Create a thread-local data key.  The destroy function will be
 * called upon thread exit.  On some platforms, it may be called
 * when all threads have deleted their keys.
444
 *
445 446 447
 * Note that the tlsdata functions do not set an error message on
 * failure; this is because the error handling in libgit2 is itself
 * handled by thread-local data storage.
448
 *
449 450
 * @param key the tlsdata key
 * @param destroy_fn function pointer called upon thread exit
451 452
 * @return 0 on success, non-zero on failure
 */
453
int git_tlsdata_init(git_tlsdata_key *key, void (GIT_SYSTEM_CALL *destroy_fn)(void *));
454 455

/**
456
 * Set a the thread-local value for the given key.
457
 *
458 459
 * @param key the tlsdata key to store data on
 * @param value the pointer to store
460 461
 * @return 0 on success, non-zero on failure
 */
462
int git_tlsdata_set(git_tlsdata_key key, void *value);
463 464

/**
465
 * Get the thread-local value for the given key.
466
 *
467 468
 * @param key the tlsdata key to retrieve the value of
 * @return the pointer stored with git_tlsdata_set
469
 */
470
void *git_tlsdata_get(git_tlsdata_key key);
471 472

/**
473
 * Delete the given thread-local key.
474
 *
475 476
 * @param key the tlsdata key to dispose
 * @return 0 on success, non-zero on failure
477
 */
478
int git_tlsdata_dispose(git_tlsdata_key key);
479

480
#endif