SDL  2.0
SDL_atomic.h File Reference
#include "SDL_stdinc.h"
#include "SDL_platform.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_atomic.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_atomic_t
 A type representing an atomic integer value. It is a struct so people don't accidentally use numeric operations on it. More...
 

Macros

#define SDL_CompilerBarrier()   { SDL_SpinLock _tmp = 0; SDL_AtomicLock(&_tmp); SDL_AtomicUnlock(&_tmp); }
 
#define SDL_MemoryBarrierRelease()   SDL_CompilerBarrier()
 
#define SDL_MemoryBarrierAcquire()   SDL_CompilerBarrier()
 
#define SDL_AtomicIncRef(a)   SDL_AtomicAdd(a, 1)
 Increment an atomic variable used as a reference count. More...
 
#define SDL_AtomicDecRef(a)   (SDL_AtomicAdd(a, -1) == 1)
 Decrement an atomic variable used as a reference count. More...
 

Functions

void SDL_MemoryBarrierReleaseFunction (void)
 
void SDL_MemoryBarrierAcquireFunction (void)
 
SDL_bool SDL_AtomicCAS (SDL_atomic_t *a, int oldval, int newval)
 Set an atomic variable to a new value if it is currently an old value. More...
 
int SDL_AtomicSet (SDL_atomic_t *a, int v)
 Set an atomic variable to a value. More...
 
int SDL_AtomicGet (SDL_atomic_t *a)
 Get the value of an atomic variable. More...
 
int SDL_AtomicAdd (SDL_atomic_t *a, int v)
 Add to an atomic variable. More...
 
SDL_bool SDL_AtomicCASPtr (void **a, void *oldval, void *newval)
 Set a pointer to a new value if it is currently an old value. More...
 
voidSDL_AtomicSetPtr (void **a, void *v)
 Set a pointer to a value atomically. More...
 
voidSDL_AtomicGetPtr (void **a)
 Get the value of a pointer atomically. More...
 

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.

typedef int SDL_SpinLock
 
SDL_bool SDL_AtomicTryLock (SDL_SpinLock *lock)
 Try to lock a spin lock by setting it to a non-zero value. More...
 
void SDL_AtomicLock (SDL_SpinLock *lock)
 Lock a spin lock by setting it to a non-zero value. More...
 
void SDL_AtomicUnlock (SDL_SpinLock *lock)
 Unlock a spin lock by setting it to 0. Always returns immediately. More...
 

Detailed Description

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! ^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

There's also lots of good information here: http://www.1024cores.net/home/lock-free-algorithms http://preshing.com/

These operations may or may not actually be implemented using 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.

Definition in file SDL_atomic.h.

Macro Definition Documentation

◆ SDL_AtomicDecRef

#define SDL_AtomicDecRef (   a)    (SDL_AtomicAdd(a, -1) == 1)

Decrement an atomic variable used as a reference count.

Returns
SDL_TRUE if the variable reached zero after decrementing, SDL_FALSE otherwise

Definition at line 244 of file SDL_atomic.h.

Referenced by DequeueEvent_LockFree(), EnqueueEvent_LockFree(), FIFO_Watcher(), RunBasicTest(), and SDL_free().

◆ SDL_AtomicIncRef

#define SDL_AtomicIncRef (   a)    SDL_AtomicAdd(a, 1)

Increment an atomic variable used as a reference count.

Definition at line 234 of file SDL_atomic.h.

Referenced by DequeueEvent_LockFree(), EnqueueEvent_LockFree(), FIFO_Watcher(), RunBasicTest(), SDL_AddTimer(), SDL_calloc(), SDL_malloc(), SDL_realloc(), and SDL_TLSCreate().

◆ SDL_CompilerBarrier

#define SDL_CompilerBarrier ( )    { SDL_SpinLock _tmp = 0; SDL_AtomicLock(&_tmp); SDL_AtomicUnlock(&_tmp); }

The compiler barrier prevents the compiler from reordering reads and writes to globally visible variables across the call.

Definition at line 132 of file SDL_atomic.h.

Referenced by SDL_AtomicUnlock().

◆ SDL_MemoryBarrierAcquire

#define SDL_MemoryBarrierAcquire ( )    SDL_CompilerBarrier()

◆ SDL_MemoryBarrierRelease

#define SDL_MemoryBarrierRelease ( )    SDL_CompilerBarrier()

Typedef Documentation

◆ SDL_SpinLock

typedef int SDL_SpinLock

Definition at line 89 of file SDL_atomic.h.

Function Documentation

◆ SDL_AtomicAdd()

int SDL_AtomicAdd ( SDL_atomic_t a,
int  v 
)

Add to an atomic variable.

Returns
The previous value of the atomic variable.
Note
This same style can be used for any number operation

Definition at line 237 of file SDL_atomic.c.

References SDL_AtomicCAS(), and SDL_atomic_t::value.

238 {
239 #ifdef HAVE_MSC_ATOMICS
240  return _InterlockedExchangeAdd((long*)&a->value, v);
241 #elif defined(HAVE_WATCOM_ATOMICS)
242  return _SDL_xadd_watcom(&a->value, v);
243 #elif defined(HAVE_GCC_ATOMICS)
244  return __sync_fetch_and_add(&a->value, v);
245 #elif defined(__SOLARIS__)
246  int pv = a->value;
247  membar_consumer();
248 #if defined(_LP64)
249  atomic_add_64((volatile uint64_t*)&a->value, v);
250 #elif !defined(_LP64)
251  atomic_add_32((volatile uint32_t*)&a->value, v);
252 #endif
253  return pv;
254 #else
255  int value;
256  do {
257  value = a->value;
258  } while (!SDL_AtomicCAS(a, value, (value + v)));
259  return value;
260 #endif
261 }
const GLdouble * v
Definition: SDL_opengl.h:2064
unsigned long long uint64_t
GLsizei const GLfloat * value
unsigned int uint32_t
SDL_bool SDL_AtomicCAS(SDL_atomic_t *a, int oldval, int newval)
Set an atomic variable to a new value if it is currently an old value.
Definition: SDL_atomic.c:129

◆ SDL_AtomicCAS()

SDL_bool SDL_AtomicCAS ( SDL_atomic_t a,
int  oldval,
int  newval 
)

Set an atomic variable to a new value if it is currently an old value.

Returns
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!

Definition at line 129 of file SDL_atomic.c.

References enterLock(), leaveLock(), retval, SDL_FALSE, SDL_TRUE, and SDL_atomic_t::value.

Referenced by SDL_AtomicAdd(), SDL_AtomicGet(), and SDL_AtomicSet().

130 {
131 #ifdef HAVE_MSC_ATOMICS
132  return (_InterlockedCompareExchange((long*)&a->value, (long)newval, (long)oldval) == (long)oldval);
133 #elif defined(HAVE_WATCOM_ATOMICS)
134  return (SDL_bool) _SDL_cmpxchg_watcom(&a->value, newval, oldval);
135 #elif defined(HAVE_GCC_ATOMICS)
136  return (SDL_bool) __sync_bool_compare_and_swap(&a->value, oldval, newval);
137 #elif defined(__MACOSX__) /* this is deprecated in 10.12 sdk; favor gcc atomics. */
138  return (SDL_bool) OSAtomicCompareAndSwap32Barrier(oldval, newval, &a->value);
139 #elif defined(__SOLARIS__) && defined(_LP64)
140  return (SDL_bool) ((int) atomic_cas_64((volatile uint64_t*)&a->value, (uint64_t)oldval, (uint64_t)newval) == oldval);
141 #elif defined(__SOLARIS__) && !defined(_LP64)
142  return (SDL_bool) ((int) atomic_cas_32((volatile uint32_t*)&a->value, (uint32_t)oldval, (uint32_t)newval) == oldval);
143 #elif EMULATE_CAS
145 
146  enterLock(a);
147  if (a->value == oldval) {
148  a->value = newval;
149  retval = SDL_TRUE;
150  }
151  leaveLock(a);
152 
153  return retval;
154 #else
155  #error Please define your platform.
156 #endif
157 }
unsigned long long uint64_t
SDL_bool retval
static SDL_INLINE void leaveLock(void *a)
Definition: SDL_atomic.c:119
static SDL_INLINE void enterLock(void *a)
Definition: SDL_atomic.c:111
SDL_bool
Definition: SDL_stdinc.h:139
unsigned int uint32_t

◆ SDL_AtomicCASPtr()

SDL_bool SDL_AtomicCASPtr ( void **  a,
void oldval,
void newval 
)

Set a pointer to a new value if it is currently an old value.

Returns
SDL_TRUE if the pointer was set, SDL_FALSE otherwise.
Note
If you don't know what this function is for, you shouldn't use it!

Definition at line 160 of file SDL_atomic.c.

References enterLock(), leaveLock(), retval, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_AtomicGetPtr(), and SDL_AtomicSetPtr().

161 {
162 #if defined(HAVE_MSC_ATOMICS) && (_M_IX86)
163  return (_InterlockedCompareExchange((long*)a, (long)newval, (long)oldval) == (long)oldval);
164 #elif defined(HAVE_MSC_ATOMICS) && (!_M_IX86)
165  return (_InterlockedCompareExchangePointer(a, newval, oldval) == oldval);
166 #elif defined(HAVE_WATCOM_ATOMICS)
167  return (SDL_bool) _SDL_cmpxchg_watcom((int *)a, (long)newval, (long)oldval);
168 #elif defined(HAVE_GCC_ATOMICS)
169  return __sync_bool_compare_and_swap(a, oldval, newval);
170 #elif defined(__MACOSX__) && defined(__LP64__) /* this is deprecated in 10.12 sdk; favor gcc atomics. */
171  return (SDL_bool) OSAtomicCompareAndSwap64Barrier((int64_t)oldval, (int64_t)newval, (int64_t*) a);
172 #elif defined(__MACOSX__) && !defined(__LP64__) /* this is deprecated in 10.12 sdk; favor gcc atomics. */
173  return (SDL_bool) OSAtomicCompareAndSwap32Barrier((int32_t)oldval, (int32_t)newval, (int32_t*) a);
174 #elif defined(__SOLARIS__)
175  return (SDL_bool) (atomic_cas_ptr(a, oldval, newval) == oldval);
176 #elif EMULATE_CAS
178 
179  enterLock(a);
180  if (*a == oldval) {
181  *a = newval;
182  retval = SDL_TRUE;
183  }
184  leaveLock(a);
185 
186  return retval;
187 #else
188  #error Please define your platform.
189 #endif
190 }
signed int int32_t
SDL_bool retval
static SDL_INLINE void leaveLock(void *a)
Definition: SDL_atomic.c:119
static SDL_INLINE void enterLock(void *a)
Definition: SDL_atomic.c:111
SDL_bool
Definition: SDL_stdinc.h:139
GLboolean GLboolean GLboolean GLboolean a
signed long long int64_t

◆ SDL_AtomicGet()

int SDL_AtomicGet ( SDL_atomic_t a)

Get the value of an atomic variable.

Definition at line 264 of file SDL_atomic.c.

References SDL_AtomicCAS(), and SDL_atomic_t::value.

265 {
266 #ifdef HAVE_ATOMIC_LOAD_N
267  return __atomic_load_n(&a->value, __ATOMIC_SEQ_CST);
268 #else
269  int value;
270  do {
271  value = a->value;
272  } while (!SDL_AtomicCAS(a, value, value));
273  return value;
274 #endif
275 }
GLsizei const GLfloat * value
SDL_bool SDL_AtomicCAS(SDL_atomic_t *a, int oldval, int newval)
Set an atomic variable to a new value if it is currently an old value.
Definition: SDL_atomic.c:129

◆ SDL_AtomicGetPtr()

void* SDL_AtomicGetPtr ( void **  a)

Get the value of a pointer atomically.

Definition at line 278 of file SDL_atomic.c.

References SDL_AtomicCASPtr().

279 {
280 #ifdef HAVE_ATOMIC_LOAD_N
281  return __atomic_load_n(a, __ATOMIC_SEQ_CST);
282 #else
283  void *value;
284  do {
285  value = *a;
286  } while (!SDL_AtomicCASPtr(a, value, value));
287  return value;
288 #endif
289 }
SDL_bool SDL_AtomicCASPtr(void **a, void *oldval, void *newval)
Set a pointer to a new value if it is currently an old value.
Definition: SDL_atomic.c:160
GLsizei const GLfloat * value
GLboolean GLboolean GLboolean GLboolean a

◆ SDL_AtomicLock()

void SDL_AtomicLock ( SDL_SpinLock lock)

Lock a spin lock by setting it to a non-zero value.

Parameters
lockPoints to the lock.

Definition at line 120 of file SDL_spinlock.c.

References SDL_AtomicTryLock(), and SDL_Delay.

121 {
122  /* FIXME: Should we have an eventual timeout? */
123  while (!SDL_AtomicTryLock(lock)) {
124  SDL_Delay(0);
125  }
126 }
#define SDL_Delay
SDL_mutex * lock
Definition: SDL_events.c:78
SDL_bool SDL_AtomicTryLock(SDL_SpinLock *lock)
Try to lock a spin lock by setting it to a non-zero value.
Definition: SDL_spinlock.c:47

◆ SDL_AtomicSet()

int SDL_AtomicSet ( SDL_atomic_t a,
int  v 
)

Set an atomic variable to a value.

Returns
The previous value of the atomic variable.

Definition at line 193 of file SDL_atomic.c.

References SDL_AtomicCAS(), and SDL_atomic_t::value.

194 {
195 #ifdef HAVE_MSC_ATOMICS
196  return _InterlockedExchange((long*)&a->value, v);
197 #elif defined(HAVE_WATCOM_ATOMICS)
198  return _SDL_xchg_watcom(&a->value, v);
199 #elif defined(HAVE_GCC_ATOMICS)
200  return __sync_lock_test_and_set(&a->value, v);
201 #elif defined(__SOLARIS__) && defined(_LP64)
202  return (int) atomic_swap_64((volatile uint64_t*)&a->value, (uint64_t)v);
203 #elif defined(__SOLARIS__) && !defined(_LP64)
204  return (int) atomic_swap_32((volatile uint32_t*)&a->value, (uint32_t)v);
205 #else
206  int value;
207  do {
208  value = a->value;
209  } while (!SDL_AtomicCAS(a, value, v));
210  return value;
211 #endif
212 }
const GLdouble * v
Definition: SDL_opengl.h:2064
unsigned long long uint64_t
GLsizei const GLfloat * value
unsigned int uint32_t
SDL_bool SDL_AtomicCAS(SDL_atomic_t *a, int oldval, int newval)
Set an atomic variable to a new value if it is currently an old value.
Definition: SDL_atomic.c:129

◆ SDL_AtomicSetPtr()

void* SDL_AtomicSetPtr ( void **  a,
void v 
)

Set a pointer to a value atomically.

Returns
The previous value of the pointer.

Definition at line 215 of file SDL_atomic.c.

References SDL_AtomicCASPtr().

216 {
217 #if defined(HAVE_MSC_ATOMICS) && (_M_IX86)
218  return (void *) _InterlockedExchange((long *)a, (long) v);
219 #elif defined(HAVE_MSC_ATOMICS) && (!_M_IX86)
220  return _InterlockedExchangePointer(a, v);
221 #elif defined(HAVE_WATCOM_ATOMICS)
222  return (void *) _SDL_xchg_watcom((int *)a, (long)v);
223 #elif defined(HAVE_GCC_ATOMICS)
224  return __sync_lock_test_and_set(a, v);
225 #elif defined(__SOLARIS__)
226  return atomic_swap_ptr(a, v);
227 #else
228  void *value;
229  do {
230  value = *a;
231  } while (!SDL_AtomicCASPtr(a, value, v));
232  return value;
233 #endif
234 }
const GLdouble * v
Definition: SDL_opengl.h:2064
SDL_bool SDL_AtomicCASPtr(void **a, void *oldval, void *newval)
Set a pointer to a new value if it is currently an old value.
Definition: SDL_atomic.c:160
GLsizei const GLfloat * value
GLboolean GLboolean GLboolean GLboolean a

◆ SDL_AtomicTryLock()

SDL_bool SDL_AtomicTryLock ( SDL_SpinLock lock)

Try to lock a spin lock by setting it to a non-zero value.

Parameters
lockPoints to the lock.
Returns
SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already held.

Definition at line 47 of file SDL_spinlock.c.

References lock, SDL_COMPILE_TIME_ASSERT, SDL_CreateMutex, SDL_FALSE, SDL_LockMutex, SDL_TRUE, and SDL_UnlockMutex.

Referenced by SDL_AtomicLock().

48 {
49 #if SDL_ATOMIC_DISABLED
50  /* Terrible terrible damage */
51  static SDL_mutex *_spinlock_mutex;
52 
53  if (!_spinlock_mutex) {
54  /* Race condition on first lock... */
55  _spinlock_mutex = SDL_CreateMutex();
56  }
57  SDL_LockMutex(_spinlock_mutex);
58  if (*lock == 0) {
59  *lock = 1;
60  SDL_UnlockMutex(_spinlock_mutex);
61  return SDL_TRUE;
62  } else {
63  SDL_UnlockMutex(_spinlock_mutex);
64  return SDL_FALSE;
65  }
66 
67 #elif defined(_MSC_VER)
68  SDL_COMPILE_TIME_ASSERT(locksize, sizeof(*lock) == sizeof(long));
69  return (InterlockedExchange((long*)lock, 1) == 0);
70 
71 #elif defined(__WATCOMC__) && defined(__386__)
72  return _SDL_xchg_watcom(lock, 1) == 0;
73 
74 #elif HAVE_GCC_ATOMICS || HAVE_GCC_SYNC_LOCK_TEST_AND_SET
75  return (__sync_lock_test_and_set(lock, 1) == 0);
76 
77 #elif defined(__GNUC__) && defined(__arm__) && \
78  (defined(__ARM_ARCH_4__) || defined(__ARM_ARCH_4T__) || \
79  defined(__ARM_ARCH_5__) || defined(__ARM_ARCH_5TE__) || \
80  defined(__ARM_ARCH_5TEJ__))
81  int result;
82  __asm__ __volatile__ (
83  "swp %0, %1, [%2]\n"
84  : "=&r,&r" (result) : "r,0" (1), "r,r" (lock) : "memory");
85  return (result == 0);
86 
87 #elif defined(__GNUC__) && defined(__arm__)
88  int result;
89  __asm__ __volatile__ (
90  "ldrex %0, [%2]\nteq %0, #0\nstrexeq %0, %1, [%2]"
91  : "=&r" (result) : "r" (1), "r" (lock) : "cc", "memory");
92  return (result == 0);
93 
94 #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
95  int result;
96  __asm__ __volatile__(
97  "lock ; xchgl %0, (%1)\n"
98  : "=r" (result) : "r" (lock), "0" (1) : "cc", "memory");
99  return (result == 0);
100 
101 #elif defined(__MACOSX__) || defined(__IPHONEOS__)
102  /* Maybe used for PowerPC, but the Intel asm or gcc atomics are favored. */
103  return OSAtomicCompareAndSwap32Barrier(0, 1, lock);
104 
105 #elif defined(__SOLARIS__) && defined(_LP64)
106  /* Used for Solaris with non-gcc compilers. */
107  return (SDL_bool) ((int) atomic_cas_64((volatile uint64_t*)lock, 0, 1) == 0);
108 
109 #elif defined(__SOLARIS__) && !defined(_LP64)
110  /* Used for Solaris with non-gcc compilers. */
111  return (SDL_bool) ((int) atomic_cas_32((volatile uint32_t*)lock, 0, 1) == 0);
112 
113 #else
114 #error Please implement for your platform.
115  return SDL_FALSE;
116 #endif
117 }
#define SDL_LockMutex
GLuint64EXT * result
#define SDL_CreateMutex
unsigned long long uint64_t
SDL_bool
Definition: SDL_stdinc.h:139
unsigned int uint32_t
SDL_mutex * lock
Definition: SDL_events.c:78
#define SDL_UnlockMutex
#define SDL_COMPILE_TIME_ASSERT(name, x)
Definition: SDL_stdinc.h:290

◆ SDL_AtomicUnlock()

void SDL_AtomicUnlock ( SDL_SpinLock lock)

Unlock a spin lock by setting it to 0. Always returns immediately.

Parameters
lockPoints to the lock.

Definition at line 129 of file SDL_spinlock.c.

References SDL_CompilerBarrier.

130 {
131 #if defined(_MSC_VER)
132  _ReadWriteBarrier();
133  *lock = 0;
134 
135 #elif defined(__WATCOMC__) && defined(__386__)
137  *lock = 0;
138 
139 #elif HAVE_GCC_ATOMICS || HAVE_GCC_SYNC_LOCK_TEST_AND_SET
140  __sync_lock_release(lock);
141 
142 #elif defined(__SOLARIS__)
143  /* Used for Solaris when not using gcc. */
144  *lock = 0;
145  membar_producer();
146 
147 #else
148  *lock = 0;
149 #endif
150 }
#define SDL_CompilerBarrier()
Definition: SDL_atomic.h:132
SDL_mutex * lock
Definition: SDL_events.c:78

◆ SDL_MemoryBarrierAcquireFunction()

void SDL_MemoryBarrierAcquireFunction ( void  )

Definition at line 298 of file SDL_atomic.c.

References SDL_MemoryBarrierAcquire.

299 {
301 }
#define SDL_MemoryBarrierAcquire()
Definition: SDL_atomic.h:190

◆ SDL_MemoryBarrierReleaseFunction()

void SDL_MemoryBarrierReleaseFunction ( void  )

Memory barriers are designed to prevent reads and writes from being reordered by the compiler and being seen out of order on multi-core CPUs.

A typical pattern would be for thread A to write some data and a flag, and for thread B to read the flag and get the data. In this case you would insert a release barrier between writing the data and the flag, guaranteeing that the data write completes no later than the flag is written, and you would insert an acquire barrier between reading the flag and reading the data, to ensure that all the reads associated with the flag have completed.

In this pattern you should always see a release barrier paired with an acquire barrier and you should gate the data reads/writes with a single flag variable.

For more information on these semantics, take a look at the blog post: http://preshing.com/20120913/acquire-and-release-semantics

Definition at line 292 of file SDL_atomic.c.

References SDL_MemoryBarrierRelease.

293 {
295 }
#define SDL_MemoryBarrierRelease()
Definition: SDL_atomic.h:189