This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_atomic.h
318 lines (276 loc) · 9.13 KB
1
/*
2
3
Simple DirectMedia Layer
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
8
9
10
11
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
12
13
14
15
16
17
18
19
20
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
21
22
/**
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
* \file SDL_atomic.h
*
* Atomic operations.
*
* IMPORTANT:
* If you are not an expert in concurrent lockless programming, you should
* only be using the atomic lock and reference counting functions in this
* file. In all other cases you should be protecting your data structures
* with full mutexes.
*
* The list of "safe" functions to use are:
* SDL_AtomicLock()
* SDL_AtomicUnlock()
* SDL_AtomicIncRef()
* SDL_AtomicDecRef()
*
* Seriously, here be dragons!
40
* ^^^^^^^^^^^^^^^^^^^^^^^^^^^
41
*
42
43
44
45
* You can find out a little more about lockless programming and the
* subtle issues that can arise here:
* http://msdn.microsoft.com/en-us/library/ee418650%28v=vs.85%29.aspx
*
46
47
48
* There's also lots of good information here:
* http://www.1024cores.net/home/lock-free-algorithms
*
49
* These operations may or may not actually be implemented using
50
51
52
53
54
55
* processor specific atomic operations. When possible they are
* implemented as true processor specific atomic operations. When that
* is not possible the are implemented using locks that *do* use the
* available atomic operations.
*
* All of the atomic operations that modify memory are full memory barriers.
56
57
58
59
60
61
62
63
64
65
*/
#ifndef _SDL_atomic_h_
#define _SDL_atomic_h_
#include "SDL_stdinc.h"
#include "SDL_platform.h"
#include "begin_code.h"
66
67
/* Need to do this here because intrin.h has C++ code in it */
/* Visual Studio 2005 has a bug where intrin.h conflicts with winnt.h */
68
#if defined(_MSC_VER) && (_MSC_VER >= 1500) && !defined(_WIN32_WCE)
69
#include <intrin.h>
70
#define HAVE_MSC_ATOMICS 1
71
72
#endif
73
74
75
76
77
78
79
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
#endif
80
/**
81
82
83
84
85
86
87
88
89
90
91
92
93
* \name SDL AtomicLock
*
* The atomic locks are efficient spinlocks using CPU instructions,
* but are vulnerable to starvation and can spin forever if a thread
* holding a lock has been terminated. For this reason you should
* minimize the code executed inside an atomic lock and never do
* expensive things like API or system calls while holding them.
*
* The atomic locks are not safe to lock recursively.
*
* Porting Note:
* The spin lock functions and type are required and can not be
* emulated because they are used in the atomic emulation code.
94
*/
95
/*@{*/
96
97
98
99
100
101
102
103
104
105
106
typedef int SDL_SpinLock;
/**
* \brief Try to lock a spin lock by setting it to a non-zero value.
*
* \param lock Points to the lock.
*
* \return SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already held.
*/
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTryLock(SDL_SpinLock *lock);
107
108
/**
109
110
111
* \brief Lock a spin lock by setting it to a non-zero value.
*
* \param lock Points to the lock.
112
*/
113
extern DECLSPEC void SDLCALL SDL_AtomicLock(SDL_SpinLock *lock);
114
115
/**
116
* \brief Unlock a spin lock by setting it to 0. Always returns immediately
117
*
118
* \param lock Points to the lock.
119
*/
120
121
extern DECLSPEC void SDLCALL SDL_AtomicUnlock(SDL_SpinLock *lock);
122
/*@}*//*SDL AtomicLock*/
123
124
125
126
127
128
/**
* The compiler barrier prevents the compiler from reordering
* reads and writes to globally visible variables across the call.
*/
129
130
131
132
#ifdef _MSC_VER
void _ReadWriteBarrier(void);
#pragma intrinsic(_ReadWriteBarrier)
#define SDL_CompilerBarrier() _ReadWriteBarrier()
133
#elif defined(__GNUC__)
134
135
136
137
138
139
#define SDL_CompilerBarrier() __asm__ __volatile__ ("" : : : "memory")
#else
#define SDL_CompilerBarrier() \
({ SDL_SpinLock _tmp = 0; SDL_AtomicLock(&_tmp); SDL_AtomicUnlock(&_tmp); })
#endif
140
141
142
/* Platform specific optimized versions of the atomic functions,
* you can disable these by defining SDL_DISABLE_ATOMIC_INLINE
*/
143
144
145
#if SDL_ATOMIC_DISABLED
#define SDL_DISABLE_ATOMIC_INLINE
#endif
146
147
#ifndef SDL_DISABLE_ATOMIC_INLINE
148
#ifdef HAVE_MSC_ATOMICS
149
150
151
152
#define SDL_AtomicSet(a, v) _InterlockedExchange((long*)&(a)->value, (v))
#define SDL_AtomicAdd(a, v) _InterlockedExchangeAdd((long*)&(a)->value, (v))
#define SDL_AtomicCAS(a, oldval, newval) (_InterlockedCompareExchange((long*)&(a)->value, (newval), (oldval)) == (oldval))
153
#define SDL_AtomicSetPtr(a, v) _InterlockedExchangePointer((a), (v))
154
155
156
157
158
#if _M_IX86
#define SDL_AtomicCASPtr(a, oldval, newval) (_InterlockedCompareExchange((long*)(a), (long)(newval), (long)(oldval)) == (long)(oldval))
#else
#define SDL_AtomicCASPtr(a, oldval, newval) (_InterlockedCompareExchangePointer((a), (newval), (oldval)) == (oldval))
#endif
159
160
#elif defined(__MACOSX__)
161
162
#include <libkern/OSAtomic.h>
163
#define SDL_AtomicCAS(a, oldval, newval) OSAtomicCompareAndSwap32Barrier((oldval), (newval), &(a)->value)
164
165
166
167
168
169
#if SIZEOF_VOIDP == 4
#define SDL_AtomicCASPtr(a, oldval, newval) OSAtomicCompareAndSwap32Barrier((int32_t)(oldval), (int32_t)(newval), (int32_t*)(a))
#elif SIZEOF_VOIDP == 8
#define SDL_AtomicCASPtr(a, oldval, newval) OSAtomicCompareAndSwap64Barrier((int64_t)(oldval), (int64_t)(newval), (int64_t*)(a))
#endif
170
#elif defined(HAVE_GCC_ATOMICS)
171
172
173
#define SDL_AtomicSet(a, v) __sync_lock_test_and_set(&(a)->value, v)
#define SDL_AtomicAdd(a, v) __sync_fetch_and_add(&(a)->value, v)
174
#define SDL_AtomicSetPtr(a, v) __sync_lock_test_and_set(a, v)
175
176
177
178
#define SDL_AtomicCAS(a, oldval, newval) __sync_bool_compare_and_swap(&(a)->value, oldval, newval)
#define SDL_AtomicCASPtr(a, oldval, newval) __sync_bool_compare_and_swap(a, oldval, newval)
#endif
179
180
181
182
#endif /* !SDL_DISABLE_ATOMIC_INLINE */
183
/**
184
185
* \brief A type representing an atomic integer value. It is a struct
* so people don't accidentally use numeric operations on it.
186
*/
187
188
189
#ifndef SDL_atomic_t_defined
typedef struct { int value; } SDL_atomic_t;
#endif
190
191
192
193
194
195
196
197
198
199
200
201
202
/**
* \brief Set an atomic variable to a new value if it is currently an old value.
*
* \return SDL_TRUE if the atomic variable was set, SDL_FALSE otherwise.
*
* \note If you don't know what this function is for, you shouldn't use it!
*/
#ifndef SDL_AtomicCAS
#define SDL_AtomicCAS SDL_AtomicCAS_
#endif
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCAS_(SDL_atomic_t *a, int oldval, int newval);
203
/**
204
205
206
* \brief Set an atomic variable to a value.
*
* \return The previous value of the atomic variable.
207
*/
208
#ifndef SDL_AtomicSet
209
210
211
212
213
214
215
216
static __inline__ int SDL_AtomicSet(SDL_atomic_t *a, int v)
{
int value;
do {
value = a->value;
} while (!SDL_AtomicCAS(a, value, v));
return value;
}
217
#endif
218
219
/**
220
* \brief Get the value of an atomic variable
221
*/
222
#ifndef SDL_AtomicGet
223
224
225
226
227
228
static __inline__ int SDL_AtomicGet(SDL_atomic_t *a)
{
int value = a->value;
SDL_CompilerBarrier();
return value;
}
229
#endif
230
231
/**
232
* \brief Add to an atomic variable.
233
234
*
* \return The previous value of the atomic variable.
235
236
*
* \note This same style can be used for any number operation
237
*/
238
#ifndef SDL_AtomicAdd
239
240
241
242
243
244
245
246
static __inline__ int SDL_AtomicAdd(SDL_atomic_t *a, int v)
{
int value;
do {
value = a->value;
} while (!SDL_AtomicCAS(a, value, (value + v)));
return value;
}
247
#endif
248
249
/**
250
* \brief Increment an atomic variable used as a reference count.
251
*/
252
#ifndef SDL_AtomicIncRef
253
#define SDL_AtomicIncRef(a) SDL_AtomicAdd(a, 1)
254
#endif
255
256
/**
257
258
* \brief Decrement an atomic variable used as a reference count.
*
259
* \return SDL_TRUE if the variable reached zero after decrementing,
260
* SDL_FALSE otherwise
261
*/
262
#ifndef SDL_AtomicDecRef
263
#define SDL_AtomicDecRef(a) (SDL_AtomicAdd(a, -1) == 1)
264
#endif
265
266
/**
267
* \brief Set a pointer to a new value if it is currently an old value.
268
*
269
* \return SDL_TRUE if the pointer was set, SDL_FALSE otherwise.
270
271
272
*
* \note If you don't know what this function is for, you shouldn't use it!
*/
273
274
#ifndef SDL_AtomicCASPtr
#define SDL_AtomicCASPtr SDL_AtomicCASPtr_
275
#endif
276
extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCASPtr_(void* *a, void *oldval, void *newval);
277
278
/**
279
* \brief Set a pointer to a value atomically.
280
281
*
* \return The previous value of the pointer.
282
*/
283
#ifndef SDL_AtomicSetPtr
284
285
286
287
288
289
290
291
static __inline__ void* SDL_AtomicSetPtr(void* *a, void* v)
{
void* value;
do {
value = *a;
} while (!SDL_AtomicCASPtr(a, value, v));
return value;
}
292
#endif
293
294
/**
295
* \brief Get the value of a pointer atomically.
296
*/
297
#ifndef SDL_AtomicGetPtr
298
299
300
301
302
303
static __inline__ void* SDL_AtomicGetPtr(void* *a)
{
void* value = *a;
SDL_CompilerBarrier();
return value;
}
304
#endif
305
306
307
308
309
310
311
312
313
314
315
316
317
318
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
#endif
#include "close_code.h"
#endif /* _SDL_atomic_h_ */
/* vi: set ts=4 sw=4 expandtab: */