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