1 /*===---- stdatomic.h - Standard header for atomic types and operations -----=== 2 * 3 * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 * See https://llvm.org/LICENSE.txt for license information. 5 * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 * 7 *===-----------------------------------------------------------------------=== 8 */ 9 10 #ifndef __CLANG_STDATOMIC_H 11 #define __CLANG_STDATOMIC_H 12 13 /* If we're hosted, fall back to the system's stdatomic.h. FreeBSD, for 14 * example, already has a Clang-compatible stdatomic.h header. 15 * 16 * Exclude the MSVC path as well as the MSVC header as of the 14.31.30818 17 * explicitly disallows `stdatomic.h` in the C mode via an `#error`. Fallback 18 * to the clang resource header until that is fully supported. 19 */ 20 #if __STDC_HOSTED__ && \ 21 __has_include_next(<stdatomic.h>) && !(defined(_MSC_VER) && !defined(__cplusplus)) 22 # include_next <stdatomic.h> 23 #else 24 25 #include <stddef.h> 26 #include <stdint.h> 27 28 #ifdef __cplusplus 29 extern "C" { 30 #endif 31 32 /* 7.17.1 Introduction */ 33 34 #define ATOMIC_BOOL_LOCK_FREE __CLANG_ATOMIC_BOOL_LOCK_FREE 35 #define ATOMIC_CHAR_LOCK_FREE __CLANG_ATOMIC_CHAR_LOCK_FREE 36 #define ATOMIC_CHAR16_T_LOCK_FREE __CLANG_ATOMIC_CHAR16_T_LOCK_FREE 37 #define ATOMIC_CHAR32_T_LOCK_FREE __CLANG_ATOMIC_CHAR32_T_LOCK_FREE 38 #define ATOMIC_WCHAR_T_LOCK_FREE __CLANG_ATOMIC_WCHAR_T_LOCK_FREE 39 #define ATOMIC_SHORT_LOCK_FREE __CLANG_ATOMIC_SHORT_LOCK_FREE 40 #define ATOMIC_INT_LOCK_FREE __CLANG_ATOMIC_INT_LOCK_FREE 41 #define ATOMIC_LONG_LOCK_FREE __CLANG_ATOMIC_LONG_LOCK_FREE 42 #define ATOMIC_LLONG_LOCK_FREE __CLANG_ATOMIC_LLONG_LOCK_FREE 43 #define ATOMIC_POINTER_LOCK_FREE __CLANG_ATOMIC_POINTER_LOCK_FREE 44 45 /* 7.17.2 Initialization */ 46 47 #define ATOMIC_VAR_INIT(value) (value) 48 #if (__STDC_VERSION__ >= 201710L || __cplusplus >= 202002L) && \ 49 !defined(_CLANG_DISABLE_CRT_DEPRECATION_WARNINGS) 50 /* ATOMIC_VAR_INIT was deprecated in C17 and C++20. */ 51 #pragma clang deprecated(ATOMIC_VAR_INIT) 52 #endif 53 #define atomic_init __c11_atomic_init 54 55 /* 7.17.3 Order and consistency */ 56 57 typedef enum memory_order { 58 memory_order_relaxed = __ATOMIC_RELAXED, 59 memory_order_consume = __ATOMIC_CONSUME, 60 memory_order_acquire = __ATOMIC_ACQUIRE, 61 memory_order_release = __ATOMIC_RELEASE, 62 memory_order_acq_rel = __ATOMIC_ACQ_REL, 63 memory_order_seq_cst = __ATOMIC_SEQ_CST 64 } memory_order; 65 66 #define kill_dependency(y) (y) 67 68 /* 7.17.4 Fences */ 69 70 /* These should be provided by the libc implementation. */ 71 void atomic_thread_fence(memory_order); 72 void atomic_signal_fence(memory_order); 73 74 #define atomic_thread_fence(order) __c11_atomic_thread_fence(order) 75 #define atomic_signal_fence(order) __c11_atomic_signal_fence(order) 76 77 /* 7.17.5 Lock-free property */ 78 79 #define atomic_is_lock_free(obj) __c11_atomic_is_lock_free(sizeof(*(obj))) 80 81 /* 7.17.6 Atomic integer types */ 82 83 #ifdef __cplusplus 84 typedef _Atomic(bool) atomic_bool; 85 #else 86 typedef _Atomic(_Bool) atomic_bool; 87 #endif 88 typedef _Atomic(char) atomic_char; 89 typedef _Atomic(signed char) atomic_schar; 90 typedef _Atomic(unsigned char) atomic_uchar; 91 typedef _Atomic(short) atomic_short; 92 typedef _Atomic(unsigned short) atomic_ushort; 93 typedef _Atomic(int) atomic_int; 94 typedef _Atomic(unsigned int) atomic_uint; 95 typedef _Atomic(long) atomic_long; 96 typedef _Atomic(unsigned long) atomic_ulong; 97 typedef _Atomic(long long) atomic_llong; 98 typedef _Atomic(unsigned long long) atomic_ullong; 99 typedef _Atomic(uint_least16_t) atomic_char16_t; 100 typedef _Atomic(uint_least32_t) atomic_char32_t; 101 typedef _Atomic(wchar_t) atomic_wchar_t; 102 typedef _Atomic(int_least8_t) atomic_int_least8_t; 103 typedef _Atomic(uint_least8_t) atomic_uint_least8_t; 104 typedef _Atomic(int_least16_t) atomic_int_least16_t; 105 typedef _Atomic(uint_least16_t) atomic_uint_least16_t; 106 typedef _Atomic(int_least32_t) atomic_int_least32_t; 107 typedef _Atomic(uint_least32_t) atomic_uint_least32_t; 108 typedef _Atomic(int_least64_t) atomic_int_least64_t; 109 typedef _Atomic(uint_least64_t) atomic_uint_least64_t; 110 typedef _Atomic(int_fast8_t) atomic_int_fast8_t; 111 typedef _Atomic(uint_fast8_t) atomic_uint_fast8_t; 112 typedef _Atomic(int_fast16_t) atomic_int_fast16_t; 113 typedef _Atomic(uint_fast16_t) atomic_uint_fast16_t; 114 typedef _Atomic(int_fast32_t) atomic_int_fast32_t; 115 typedef _Atomic(uint_fast32_t) atomic_uint_fast32_t; 116 typedef _Atomic(int_fast64_t) atomic_int_fast64_t; 117 typedef _Atomic(uint_fast64_t) atomic_uint_fast64_t; 118 typedef _Atomic(intptr_t) atomic_intptr_t; 119 typedef _Atomic(uintptr_t) atomic_uintptr_t; 120 typedef _Atomic(size_t) atomic_size_t; 121 typedef _Atomic(ptrdiff_t) atomic_ptrdiff_t; 122 typedef _Atomic(intmax_t) atomic_intmax_t; 123 typedef _Atomic(uintmax_t) atomic_uintmax_t; 124 125 /* 7.17.7 Operations on atomic types */ 126 127 #define atomic_store(object, desired) __c11_atomic_store(object, desired, __ATOMIC_SEQ_CST) 128 #define atomic_store_explicit __c11_atomic_store 129 130 #define atomic_load(object) __c11_atomic_load(object, __ATOMIC_SEQ_CST) 131 #define atomic_load_explicit __c11_atomic_load 132 133 #define atomic_exchange(object, desired) __c11_atomic_exchange(object, desired, __ATOMIC_SEQ_CST) 134 #define atomic_exchange_explicit __c11_atomic_exchange 135 136 #define atomic_compare_exchange_strong(object, expected, desired) __c11_atomic_compare_exchange_strong(object, expected, desired, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST) 137 #define atomic_compare_exchange_strong_explicit __c11_atomic_compare_exchange_strong 138 139 #define atomic_compare_exchange_weak(object, expected, desired) __c11_atomic_compare_exchange_weak(object, expected, desired, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST) 140 #define atomic_compare_exchange_weak_explicit __c11_atomic_compare_exchange_weak 141 142 #define atomic_fetch_add(object, operand) __c11_atomic_fetch_add(object, operand, __ATOMIC_SEQ_CST) 143 #define atomic_fetch_add_explicit __c11_atomic_fetch_add 144 145 #define atomic_fetch_sub(object, operand) __c11_atomic_fetch_sub(object, operand, __ATOMIC_SEQ_CST) 146 #define atomic_fetch_sub_explicit __c11_atomic_fetch_sub 147 148 #define atomic_fetch_or(object, operand) __c11_atomic_fetch_or(object, operand, __ATOMIC_SEQ_CST) 149 #define atomic_fetch_or_explicit __c11_atomic_fetch_or 150 151 #define atomic_fetch_xor(object, operand) __c11_atomic_fetch_xor(object, operand, __ATOMIC_SEQ_CST) 152 #define atomic_fetch_xor_explicit __c11_atomic_fetch_xor 153 154 #define atomic_fetch_and(object, operand) __c11_atomic_fetch_and(object, operand, __ATOMIC_SEQ_CST) 155 #define atomic_fetch_and_explicit __c11_atomic_fetch_and 156 157 /* 7.17.8 Atomic flag type and operations */ 158 159 typedef struct atomic_flag { atomic_bool _Value; } atomic_flag; 160 161 #define ATOMIC_FLAG_INIT { 0 } 162 163 /* These should be provided by the libc implementation. */ 164 #ifdef __cplusplus 165 bool atomic_flag_test_and_set(volatile atomic_flag *); 166 bool atomic_flag_test_and_set_explicit(volatile atomic_flag *, memory_order); 167 #else 168 _Bool atomic_flag_test_and_set(volatile atomic_flag *); 169 _Bool atomic_flag_test_and_set_explicit(volatile atomic_flag *, memory_order); 170 #endif 171 void atomic_flag_clear(volatile atomic_flag *); 172 void atomic_flag_clear_explicit(volatile atomic_flag *, memory_order); 173 174 #define atomic_flag_test_and_set(object) __c11_atomic_exchange(&(object)->_Value, 1, __ATOMIC_SEQ_CST) 175 #define atomic_flag_test_and_set_explicit(object, order) __c11_atomic_exchange(&(object)->_Value, 1, order) 176 177 #define atomic_flag_clear(object) __c11_atomic_store(&(object)->_Value, 0, __ATOMIC_SEQ_CST) 178 #define atomic_flag_clear_explicit(object, order) __c11_atomic_store(&(object)->_Value, 0, order) 179 180 #ifdef __cplusplus 181 } 182 #endif 183 184 #endif /* __STDC_HOSTED__ */ 185 #endif /* __CLANG_STDATOMIC_H */ 186 187