gcc/ginclude/stdatomic.h

   1 /* Copyright (C) 2013-2015 Free Software Foundation, Inc.
   2
   3 This file is part of GCC.
   4
   5 GCC is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 3, or (at your option)
   8 any later version.
   9
  10 GCC is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 Under Section 7 of GPL version 3, you are granted additional
  16 permissions described in the GCC Runtime Library Exception, version
  17 3.1, as published by the Free Software Foundation.
  18
  19 You should have received a copy of the GNU General Public License and
  20 a copy of the GCC Runtime Library Exception along with this program;
  21 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  22 <http://www.gnu.org/licenses/>.  */
  23
  24 /* ISO C11 Standard:  7.17  Atomics <stdatomic.h>.  */
  25
  26 #ifndef _STDATOMIC_H
  27 #define _STDATOMIC_H
  28
  29 typedef enum
  30   {
  31     memory_order_relaxed = __ATOMIC_RELAXED,
  32     memory_order_consume = __ATOMIC_CONSUME,
  33     memory_order_acquire = __ATOMIC_ACQUIRE,
  34     memory_order_release = __ATOMIC_RELEASE,
  35     memory_order_acq_rel = __ATOMIC_ACQ_REL,
  36     memory_order_seq_cst = __ATOMIC_SEQ_CST
  37   } memory_order;
  38
  39
  40 typedef _Atomic _Bool atomic_bool;
  41 typedef _Atomic char atomic_char;
  42 typedef _Atomic signed char atomic_schar;
  43 typedef _Atomic unsigned char atomic_uchar;
  44 typedef _Atomic short atomic_short;
  45 typedef _Atomic unsigned short atomic_ushort;
  46 typedef _Atomic int atomic_int;
  47 typedef _Atomic unsigned int atomic_uint;
  48 typedef _Atomic long atomic_long;
  49 typedef _Atomic unsigned long atomic_ulong;
  50 typedef _Atomic long long atomic_llong;
  51 typedef _Atomic unsigned long long atomic_ullong;
  52 typedef _Atomic __CHAR16_TYPE__ atomic_char16_t;
  53 typedef _Atomic __CHAR32_TYPE__ atomic_char32_t;
  54 typedef _Atomic __WCHAR_TYPE__ atomic_wchar_t;
  55 typedef _Atomic __INT_LEAST8_TYPE__ atomic_int_least8_t;
  56 typedef _Atomic __UINT_LEAST8_TYPE__ atomic_uint_least8_t;
  57 typedef _Atomic __INT_LEAST16_TYPE__ atomic_int_least16_t;
  58 typedef _Atomic __UINT_LEAST16_TYPE__ atomic_uint_least16_t;
  59 typedef _Atomic __INT_LEAST32_TYPE__ atomic_int_least32_t;
  60 typedef _Atomic __UINT_LEAST32_TYPE__ atomic_uint_least32_t;
  61 typedef _Atomic __INT_LEAST64_TYPE__ atomic_int_least64_t;
  62 typedef _Atomic __UINT_LEAST64_TYPE__ atomic_uint_least64_t;
  63 typedef _Atomic __INT_FAST8_TYPE__ atomic_int_fast8_t;
  64 typedef _Atomic __UINT_FAST8_TYPE__ atomic_uint_fast8_t;
  65 typedef _Atomic __INT_FAST16_TYPE__ atomic_int_fast16_t;
  66 typedef _Atomic __UINT_FAST16_TYPE__ atomic_uint_fast16_t;
  67 typedef _Atomic __INT_FAST32_TYPE__ atomic_int_fast32_t;
  68 typedef _Atomic __UINT_FAST32_TYPE__ atomic_uint_fast32_t;
  69 typedef _Atomic __INT_FAST64_TYPE__ atomic_int_fast64_t;
  70 typedef _Atomic __UINT_FAST64_TYPE__ atomic_uint_fast64_t;
  71 typedef _Atomic __INTPTR_TYPE__ atomic_intptr_t;
  72 typedef _Atomic __UINTPTR_TYPE__ atomic_uintptr_t;
  73 typedef _Atomic __SIZE_TYPE__ atomic_size_t;
  74 typedef _Atomic __PTRDIFF_TYPE__ atomic_ptrdiff_t;
  75 typedef _Atomic __INTMAX_TYPE__ atomic_intmax_t;
  76 typedef _Atomic __UINTMAX_TYPE__ atomic_uintmax_t;
  77
  78
  79 #define ATOMIC_VAR_INIT(VALUE)  (VALUE)
  80 #define atomic_init(PTR, VAL)                   \
  81   do                                            \
  82     {                                           \
  83       *(PTR) = (VAL);                           \
  84     }                                           \
  85   while (0)
  86
  87 #define kill_dependency(Y)                      \
  88   __extension__                                 \
  89   ({                                            \
  90     __auto_type __kill_dependency_tmp = (Y);    \
  91     __kill_dependency_tmp;                      \
  92   })
  93
  94 extern void atomic_thread_fence (memory_order);
  95 #define atomic_thread_fence(MO) __atomic_thread_fence (MO)
  96 extern void atomic_signal_fence (memory_order);
  97 #define atomic_signal_fence(MO) __atomic_signal_fence  (MO)
  98 #define atomic_is_lock_free(OBJ) __atomic_is_lock_free (sizeof (*(OBJ)), (OBJ))
  99
 100 #define ATOMIC_BOOL_LOCK_FREE           __GCC_ATOMIC_BOOL_LOCK_FREE
 101 #define ATOMIC_CHAR_LOCK_FREE           __GCC_ATOMIC_CHAR_LOCK_FREE
 102 #define ATOMIC_CHAR16_T_LOCK_FREE       __GCC_ATOMIC_CHAR16_T_LOCK_FREE
 103 #define ATOMIC_CHAR32_T_LOCK_FREE       __GCC_ATOMIC_CHAR32_T_LOCK_FREE
 104 #define ATOMIC_WCHAR_T_LOCK_FREE        __GCC_ATOMIC_WCHAR_T_LOCK_FREE
 105 #define ATOMIC_SHORT_LOCK_FREE          __GCC_ATOMIC_SHORT_LOCK_FREE
 106 #define ATOMIC_INT_LOCK_FREE            __GCC_ATOMIC_INT_LOCK_FREE
 107 #define ATOMIC_LONG_LOCK_FREE           __GCC_ATOMIC_LONG_LOCK_FREE
 108 #define ATOMIC_LLONG_LOCK_FREE          __GCC_ATOMIC_LLONG_LOCK_FREE
 109 #define ATOMIC_POINTER_LOCK_FREE        __GCC_ATOMIC_POINTER_LOCK_FREE
 110
 111
 112 /* Note that these macros require __typeof__ and __auto_type to remove
 113    _Atomic qualifiers (and const qualifiers, if those are valid on
 114    macro operands).
 115
 116    Also note that the header file uses the generic form of __atomic
 117    builtins, which requires the address to be taken of the value
 118    parameter, and then we pass that value on.  This allows the macros
 119    to work for any type, and the compiler is smart enough to convert
 120    these to lock-free _N variants if possible, and throw away the
 121    temps.  */
 122
 123 #define atomic_store_explicit(PTR, VAL, MO)                             \
 124   __extension__                                                         \
 125   ({                                                                    \
 126     __auto_type __atomic_store_ptr = (PTR);                             \
 127     __typeof__ (*__atomic_store_ptr) __atomic_store_tmp = (VAL);        \
 128     __atomic_store (__atomic_store_ptr, &__atomic_store_tmp, (MO));     \
 129   })
 130
 131 #define atomic_store(PTR, VAL)                          \
 132   atomic_store_explicit (PTR, VAL, __ATOMIC_SEQ_CST)
 133
 134
 135 #define atomic_load_explicit(PTR, MO)                                   \
 136   __extension__                                                         \
 137   ({                                                                    \
 138     __auto_type __atomic_load_ptr = (PTR);                              \
 139     __typeof__ (*__atomic_load_ptr) __atomic_load_tmp;                  \
 140     __atomic_load (__atomic_load_ptr, &__atomic_load_tmp, (MO));        \
 141     __atomic_load_tmp;                                                  \
 142   })
 143
 144 #define atomic_load(PTR)  atomic_load_explicit (PTR, __ATOMIC_SEQ_CST)
 145
 146
 147 #define atomic_exchange_explicit(PTR, VAL, MO)                          \
 148   __extension__                                                         \
 149   ({                                                                    \
 150     __auto_type __atomic_exchange_ptr = (PTR);                          \
 151     __typeof__ (*__atomic_exchange_ptr) __atomic_exchange_val = (VAL);  \
 152     __typeof__ (*__atomic_exchange_ptr) __atomic_exchange_tmp;          \
 153     __atomic_exchange (__atomic_exchange_ptr, &__atomic_exchange_val,   \
 154                        &__atomic_exchange_tmp, (MO));                   \
 155     __atomic_exchange_tmp;                                              \
 156   })
 157
 158 #define atomic_exchange(PTR, VAL)                       \
 159   atomic_exchange_explicit (PTR, VAL, __ATOMIC_SEQ_CST)
 160
 161
 162 #define atomic_compare_exchange_strong_explicit(PTR, VAL, DES, SUC, FAIL) \
 163   __extension__                                                         \
 164   ({                                                                    \
 165     __auto_type __atomic_compare_exchange_ptr = (PTR);                  \
 166     __typeof__ (*__atomic_compare_exchange_ptr) __atomic_compare_exchange_tmp \
 167       = (DES);                                                          \
 168     __atomic_compare_exchange (__atomic_compare_exchange_ptr, (VAL),    \
 169                                &__atomic_compare_exchange_tmp, 0,       \
 170                                (SUC), (FAIL));                          \
 171   })
 172
 173 #define atomic_compare_exchange_strong(PTR, VAL, DES)                      \
 174   atomic_compare_exchange_strong_explicit (PTR, VAL, DES, __ATOMIC_SEQ_CST, \
 175                                            __ATOMIC_SEQ_CST)
 176
 177 #define atomic_compare_exchange_weak_explicit(PTR, VAL, DES, SUC, FAIL) \
 178   __extension__                                                         \
 179   ({                                                                    \
 180     __auto_type __atomic_compare_exchange_ptr = (PTR);                  \
 181     __typeof__ (*__atomic_compare_exchange_ptr) __atomic_compare_exchange_tmp \
 182       = (DES);                                                          \
 183     __atomic_compare_exchange (__atomic_compare_exchange_ptr, (VAL),    \
 184                                &__atomic_compare_exchange_tmp, 1,       \
 185                                (SUC), (FAIL));                          \
 186   })
 187
 188 #define atomic_compare_exchange_weak(PTR, VAL, DES)                     \
 189   atomic_compare_exchange_weak_explicit (PTR, VAL, DES, __ATOMIC_SEQ_CST, \
 190                                          __ATOMIC_SEQ_CST)
 191
 192
 193
 194 #define atomic_fetch_add(PTR, VAL) __atomic_fetch_add ((PTR), (VAL),    \
 195                                                        __ATOMIC_SEQ_CST)
 196 #define atomic_fetch_add_explicit(PTR, VAL, MO)                         \
 197                           __atomic_fetch_add ((PTR), (VAL), (MO))
 198
 199 #define atomic_fetch_sub(PTR, VAL) __atomic_fetch_sub ((PTR), (VAL),    \
 200                                                        __ATOMIC_SEQ_CST)
 201 #define atomic_fetch_sub_explicit(PTR, VAL, MO)                         \
 202                           __atomic_fetch_sub ((PTR), (VAL), (MO))
 203
 204 #define atomic_fetch_or(PTR, VAL) __atomic_fetch_or ((PTR), (VAL),      \
 205                                                        __ATOMIC_SEQ_CST)
 206 #define atomic_fetch_or_explicit(PTR, VAL, MO)                  \
 207                           __atomic_fetch_or ((PTR), (VAL), (MO))
 208
 209 #define atomic_fetch_xor(PTR, VAL) __atomic_fetch_xor ((PTR), (VAL),    \
 210                                                        __ATOMIC_SEQ_CST)
 211 #define atomic_fetch_xor_explicit(PTR, VAL, MO)                         \
 212                           __atomic_fetch_xor ((PTR), (VAL), (MO))
 213
 214 #define atomic_fetch_and(PTR, VAL) __atomic_fetch_and ((PTR), (VAL),    \
 215                                                        __ATOMIC_SEQ_CST)
 216 #define atomic_fetch_and_explicit(PTR, VAL, MO)                         \
 217                           __atomic_fetch_and ((PTR), (VAL), (MO))
 218
 219
 220 typedef _Atomic struct
 221 {
 222 #if __GCC_ATOMIC_TEST_AND_SET_TRUEVAL == 1
 223   _Bool __val;
 224 #else
 225   unsigned char __val;
 226 #endif
 227 } atomic_flag;
 228
 229 #define ATOMIC_FLAG_INIT        { 0 }
 230
 231
 232 extern _Bool atomic_flag_test_and_set (volatile atomic_flag *);
 233 #define atomic_flag_test_and_set(PTR)                                   \
 234                         __atomic_test_and_set ((PTR), __ATOMIC_SEQ_CST)
 235 extern _Bool atomic_flag_test_and_set_explicit (volatile atomic_flag *,
 236                                                 memory_order);
 237 #define atomic_flag_test_and_set_explicit(PTR, MO)                      \
 238                         __atomic_test_and_set ((PTR), (MO))
 239
 240 extern void atomic_flag_clear (volatile atomic_flag *);
 241 #define atomic_flag_clear(PTR)  __atomic_clear ((PTR), __ATOMIC_SEQ_CST)
 242 extern void atomic_flag_clear_explicit (volatile atomic_flag *, memory_order);
 243 #define atomic_flag_clear_explicit(PTR, MO)   __atomic_clear ((PTR), (MO))
 244
 245 #endif  /* _STDATOMIC_H */