1277325Sdim/*===---- stdatomic.h - Standard header for atomic types and operations -----=== 2277325Sdim * 3353358Sdim * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4353358Sdim * See https://llvm.org/LICENSE.txt for license information. 5353358Sdim * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6277325Sdim * 7277325Sdim *===-----------------------------------------------------------------------=== 8277325Sdim */ 9277325Sdim 10277325Sdim#ifndef __CLANG_STDATOMIC_H 11277325Sdim#define __CLANG_STDATOMIC_H 12277325Sdim 13277325Sdim/* If we're hosted, fall back to the system's stdatomic.h. FreeBSD, for 14277325Sdim * example, already has a Clang-compatible stdatomic.h header. 15277325Sdim */ 16277325Sdim#if __STDC_HOSTED__ && __has_include_next(<stdatomic.h>) 17277325Sdim# include_next <stdatomic.h> 18277325Sdim#else 19277325Sdim 20277325Sdim#include <stddef.h> 21277325Sdim#include <stdint.h> 22277325Sdim 23277325Sdim#ifdef __cplusplus 24277325Sdimextern "C" { 25277325Sdim#endif 26277325Sdim 27277325Sdim/* 7.17.1 Introduction */ 28277325Sdim 29321369Sdim#define ATOMIC_BOOL_LOCK_FREE __CLANG_ATOMIC_BOOL_LOCK_FREE 30321369Sdim#define ATOMIC_CHAR_LOCK_FREE __CLANG_ATOMIC_CHAR_LOCK_FREE 31321369Sdim#define ATOMIC_CHAR16_T_LOCK_FREE __CLANG_ATOMIC_CHAR16_T_LOCK_FREE 32321369Sdim#define ATOMIC_CHAR32_T_LOCK_FREE __CLANG_ATOMIC_CHAR32_T_LOCK_FREE 33321369Sdim#define ATOMIC_WCHAR_T_LOCK_FREE __CLANG_ATOMIC_WCHAR_T_LOCK_FREE 34321369Sdim#define ATOMIC_SHORT_LOCK_FREE __CLANG_ATOMIC_SHORT_LOCK_FREE 35321369Sdim#define ATOMIC_INT_LOCK_FREE __CLANG_ATOMIC_INT_LOCK_FREE 36321369Sdim#define ATOMIC_LONG_LOCK_FREE __CLANG_ATOMIC_LONG_LOCK_FREE 37321369Sdim#define ATOMIC_LLONG_LOCK_FREE __CLANG_ATOMIC_LLONG_LOCK_FREE 38321369Sdim#define ATOMIC_POINTER_LOCK_FREE __CLANG_ATOMIC_POINTER_LOCK_FREE 39277325Sdim 40277325Sdim/* 7.17.2 Initialization */ 41277325Sdim 42277325Sdim#define ATOMIC_VAR_INIT(value) (value) 43277325Sdim#define atomic_init __c11_atomic_init 44277325Sdim 45277325Sdim/* 7.17.3 Order and consistency */ 46277325Sdim 47277325Sdimtypedef enum memory_order { 48277325Sdim memory_order_relaxed = __ATOMIC_RELAXED, 49277325Sdim memory_order_consume = __ATOMIC_CONSUME, 50277325Sdim memory_order_acquire = __ATOMIC_ACQUIRE, 51277325Sdim memory_order_release = __ATOMIC_RELEASE, 52277325Sdim memory_order_acq_rel = __ATOMIC_ACQ_REL, 53277325Sdim memory_order_seq_cst = __ATOMIC_SEQ_CST 54277325Sdim} memory_order; 55277325Sdim 56277325Sdim#define kill_dependency(y) (y) 57277325Sdim 58277325Sdim/* 7.17.4 Fences */ 59277325Sdim 60288943Sdim/* These should be provided by the libc implementation. */ 61277325Sdimvoid atomic_thread_fence(memory_order); 62277325Sdimvoid atomic_signal_fence(memory_order); 63277325Sdim 64277325Sdim#define atomic_thread_fence(order) __c11_atomic_thread_fence(order) 65277325Sdim#define atomic_signal_fence(order) __c11_atomic_signal_fence(order) 66277325Sdim 67277325Sdim/* 7.17.5 Lock-free property */ 68277325Sdim 69277325Sdim#define atomic_is_lock_free(obj) __c11_atomic_is_lock_free(sizeof(*(obj))) 70277325Sdim 71277325Sdim/* 7.17.6 Atomic integer types */ 72277325Sdim 73277325Sdim#ifdef __cplusplus 74277325Sdimtypedef _Atomic(bool) atomic_bool; 75277325Sdim#else 76277325Sdimtypedef _Atomic(_Bool) atomic_bool; 77277325Sdim#endif 78277325Sdimtypedef _Atomic(char) atomic_char; 79277325Sdimtypedef _Atomic(signed char) atomic_schar; 80277325Sdimtypedef _Atomic(unsigned char) atomic_uchar; 81277325Sdimtypedef _Atomic(short) atomic_short; 82277325Sdimtypedef _Atomic(unsigned short) atomic_ushort; 83277325Sdimtypedef _Atomic(int) atomic_int; 84277325Sdimtypedef _Atomic(unsigned int) atomic_uint; 85277325Sdimtypedef _Atomic(long) atomic_long; 86277325Sdimtypedef _Atomic(unsigned long) atomic_ulong; 87277325Sdimtypedef _Atomic(long long) atomic_llong; 88277325Sdimtypedef _Atomic(unsigned long long) atomic_ullong; 89277325Sdimtypedef _Atomic(uint_least16_t) atomic_char16_t; 90277325Sdimtypedef _Atomic(uint_least32_t) atomic_char32_t; 91277325Sdimtypedef _Atomic(wchar_t) atomic_wchar_t; 92277325Sdimtypedef _Atomic(int_least8_t) atomic_int_least8_t; 93277325Sdimtypedef _Atomic(uint_least8_t) atomic_uint_least8_t; 94277325Sdimtypedef _Atomic(int_least16_t) atomic_int_least16_t; 95277325Sdimtypedef _Atomic(uint_least16_t) atomic_uint_least16_t; 96277325Sdimtypedef _Atomic(int_least32_t) atomic_int_least32_t; 97277325Sdimtypedef _Atomic(uint_least32_t) atomic_uint_least32_t; 98277325Sdimtypedef _Atomic(int_least64_t) atomic_int_least64_t; 99277325Sdimtypedef _Atomic(uint_least64_t) atomic_uint_least64_t; 100277325Sdimtypedef _Atomic(int_fast8_t) atomic_int_fast8_t; 101277325Sdimtypedef _Atomic(uint_fast8_t) atomic_uint_fast8_t; 102277325Sdimtypedef _Atomic(int_fast16_t) atomic_int_fast16_t; 103277325Sdimtypedef _Atomic(uint_fast16_t) atomic_uint_fast16_t; 104277325Sdimtypedef _Atomic(int_fast32_t) atomic_int_fast32_t; 105277325Sdimtypedef _Atomic(uint_fast32_t) atomic_uint_fast32_t; 106277325Sdimtypedef _Atomic(int_fast64_t) atomic_int_fast64_t; 107277325Sdimtypedef _Atomic(uint_fast64_t) atomic_uint_fast64_t; 108277325Sdimtypedef _Atomic(intptr_t) atomic_intptr_t; 109277325Sdimtypedef _Atomic(uintptr_t) atomic_uintptr_t; 110277325Sdimtypedef _Atomic(size_t) atomic_size_t; 111277325Sdimtypedef _Atomic(ptrdiff_t) atomic_ptrdiff_t; 112277325Sdimtypedef _Atomic(intmax_t) atomic_intmax_t; 113277325Sdimtypedef _Atomic(uintmax_t) atomic_uintmax_t; 114277325Sdim 115277325Sdim/* 7.17.7 Operations on atomic types */ 116277325Sdim 117277325Sdim#define atomic_store(object, desired) __c11_atomic_store(object, desired, __ATOMIC_SEQ_CST) 118277325Sdim#define atomic_store_explicit __c11_atomic_store 119277325Sdim 120277325Sdim#define atomic_load(object) __c11_atomic_load(object, __ATOMIC_SEQ_CST) 121277325Sdim#define atomic_load_explicit __c11_atomic_load 122277325Sdim 123277325Sdim#define atomic_exchange(object, desired) __c11_atomic_exchange(object, desired, __ATOMIC_SEQ_CST) 124277325Sdim#define atomic_exchange_explicit __c11_atomic_exchange 125277325Sdim 126277325Sdim#define atomic_compare_exchange_strong(object, expected, desired) __c11_atomic_compare_exchange_strong(object, expected, desired, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST) 127277325Sdim#define atomic_compare_exchange_strong_explicit __c11_atomic_compare_exchange_strong 128277325Sdim 129277325Sdim#define atomic_compare_exchange_weak(object, expected, desired) __c11_atomic_compare_exchange_weak(object, expected, desired, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST) 130277325Sdim#define atomic_compare_exchange_weak_explicit __c11_atomic_compare_exchange_weak 131277325Sdim 132277325Sdim#define atomic_fetch_add(object, operand) __c11_atomic_fetch_add(object, operand, __ATOMIC_SEQ_CST) 133277325Sdim#define atomic_fetch_add_explicit __c11_atomic_fetch_add 134277325Sdim 135277325Sdim#define atomic_fetch_sub(object, operand) __c11_atomic_fetch_sub(object, operand, __ATOMIC_SEQ_CST) 136277325Sdim#define atomic_fetch_sub_explicit __c11_atomic_fetch_sub 137277325Sdim 138277325Sdim#define atomic_fetch_or(object, operand) __c11_atomic_fetch_or(object, operand, __ATOMIC_SEQ_CST) 139277325Sdim#define atomic_fetch_or_explicit __c11_atomic_fetch_or 140277325Sdim 141277325Sdim#define atomic_fetch_xor(object, operand) __c11_atomic_fetch_xor(object, operand, __ATOMIC_SEQ_CST) 142277325Sdim#define atomic_fetch_xor_explicit __c11_atomic_fetch_xor 143277325Sdim 144277325Sdim#define atomic_fetch_and(object, operand) __c11_atomic_fetch_and(object, operand, __ATOMIC_SEQ_CST) 145277325Sdim#define atomic_fetch_and_explicit __c11_atomic_fetch_and 146277325Sdim 147277325Sdim/* 7.17.8 Atomic flag type and operations */ 148277325Sdim 149277325Sdimtypedef struct atomic_flag { atomic_bool _Value; } atomic_flag; 150277325Sdim 151277325Sdim#define ATOMIC_FLAG_INIT { 0 } 152277325Sdim 153288943Sdim/* These should be provided by the libc implementation. */ 154277325Sdim#ifdef __cplusplus 155277325Sdimbool atomic_flag_test_and_set(volatile atomic_flag *); 156277325Sdimbool atomic_flag_test_and_set_explicit(volatile atomic_flag *, memory_order); 157277325Sdim#else 158277325Sdim_Bool atomic_flag_test_and_set(volatile atomic_flag *); 159277325Sdim_Bool atomic_flag_test_and_set_explicit(volatile atomic_flag *, memory_order); 160277325Sdim#endif 161277325Sdimvoid atomic_flag_clear(volatile atomic_flag *); 162277325Sdimvoid atomic_flag_clear_explicit(volatile atomic_flag *, memory_order); 163277325Sdim 164277325Sdim#define atomic_flag_test_and_set(object) __c11_atomic_exchange(&(object)->_Value, 1, __ATOMIC_SEQ_CST) 165277325Sdim#define atomic_flag_test_and_set_explicit(object, order) __c11_atomic_exchange(&(object)->_Value, 1, order) 166277325Sdim 167277325Sdim#define atomic_flag_clear(object) __c11_atomic_store(&(object)->_Value, 0, __ATOMIC_SEQ_CST) 168277325Sdim#define atomic_flag_clear_explicit(object, order) __c11_atomic_store(&(object)->_Value, 0, order) 169277325Sdim 170277325Sdim#ifdef __cplusplus 171277325Sdim} 172277325Sdim#endif 173277325Sdim 174277325Sdim#endif /* __STDC_HOSTED__ */ 175277325Sdim#endif /* __CLANG_STDATOMIC_H */ 176277325Sdim 177