libmetal  latest
atomic.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 /*
8  * @file atomic.h
9  * @brief Atomic primitives for libmetal.
10  */
11 
12 #ifndef __METAL_ATOMIC__H__
13 #define __METAL_ATOMIC__H__
14 
15 #include <metal/config.h>
16 
17 #if defined(__cplusplus)
18 # include <cstdint>
19 
20 /*
21  * <atomic> has the same functionality as <stdatomic.h> but all members are only
22  * accessible in the std namespace. As the rest of libmetal is pure C, it does
23  * not know about namespaces, even when compiled as part of a C++ file. So we
24  * just export the members of <atomic> into the global namespace.
25  */
26 # include <atomic>
27 using std::atomic_flag;
28 using std::memory_order;
35 
36 using std::atomic_bool;
37 using std::atomic_char;
38 using std::atomic_schar;
39 using std::atomic_uchar;
40 using std::atomic_short;
41 using std::atomic_ushort;
42 using std::atomic_int;
43 using std::atomic_uint;
44 using std::atomic_long;
45 using std::atomic_ulong;
46 using std::atomic_llong;
47 using std::atomic_ullong;
48 using std::atomic_char16_t;
49 using std::atomic_char32_t;
50 using std::atomic_wchar_t;
51 using std::atomic_int_least8_t;
52 using std::atomic_uint_least8_t;
53 using std::atomic_int_least16_t;
54 using std::atomic_uint_least16_t;
55 using std::atomic_int_least32_t;
56 using std::atomic_uint_least32_t;
57 using std::atomic_int_least64_t;
58 using std::atomic_uint_least64_t;
59 using std::atomic_int_fast8_t;
60 using std::atomic_uint_fast8_t;
61 using std::atomic_int_fast16_t;
62 using std::atomic_uint_fast16_t;
63 using std::atomic_int_fast32_t;
64 using std::atomic_uint_fast32_t;
65 using std::atomic_int_fast64_t;
66 using std::atomic_uint_fast64_t;
67 using std::atomic_intptr_t;
69 using std::atomic_size_t;
70 using std::atomic_ptrdiff_t;
71 using std::atomic_intmax_t;
72 using std::atomic_uintmax_t;
73 
78 using std::atomic_init;
80 using std::atomic_store;
82 using std::atomic_load;
102 
103 #elif defined(HAVE_STDATOMIC_H) && !defined(__ARMCC_VERSION) && \
104 !defined(__STDC_NO_ATOMICS__)
105 # include <stdint.h>
106 # include <stdatomic.h>
107 #elif defined(__GNUC__)
108 # include <metal/compiler/gcc/atomic.h>
109 #else
110 #if defined(HAVE_PROCESSOR_ATOMIC_H)
111 # include <metal/processor/@PROJECT_PROCESSOR@/atomic.h>
112 #else
113 # include <metal/processor/generic/atomic.h>
114 #endif /* defined(HAVE_PROCESSOR_ATOMIC_H) */
115 #endif
116 
117 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L && !defined(ATOMIC_VAR_INIT)
118 # define ATOMIC_VAR_INIT(VAL) (VAL)
119 #endif
120 
121 #endif /* __METAL_ATOMIC__H__ */
#define atomic_fetch_sub_explicit(OBJ, VAL, MO)
Definition: atomic.h:101
#define atomic_fetch_add(OBJ, VAL)
Definition: atomic.h:95
#define atomic_signal_fence(MO)
Definition: atomic.h:117
#define atomic_load(OBJ)
Definition: atomic.h:60
memory_order
Definition: atomic.h:35
@ memory_order_consume
Definition: atomic.h:37
@ memory_order_seq_cst
Definition: atomic.h:41
@ memory_order_release
Definition: atomic.h:39
@ memory_order_relaxed
Definition: atomic.h:36
@ memory_order_acq_rel
Definition: atomic.h:40
@ memory_order_acquire
Definition: atomic.h:38
unsigned long long atomic_ullong
Definition: atomic.h:30
unsigned char atomic_uchar
Definition: atomic.h:21
int atomic_int
Definition: atomic.h:24
#define atomic_flag_clear_explicit(FLAG, MO)
Definition: atomic.h:50
#define atomic_compare_exchange_weak_explicit(OBJ, EXP, DES, MO)
Definition: atomic.h:93
#define atomic_flag_test_and_set(FLAG)
Definition: atomic.h:44
#define atomic_fetch_and_explicit(OBJ, VAL, MO)
Definition: atomic.h:113
#define atomic_compare_exchange_strong_explicit(OBJ, EXP, DES, MO)
Definition: atomic.h:89
char atomic_char
Definition: atomic.h:20
#define atomic_flag_clear(FLAG)
Definition: atomic.h:48
unsigned int atomic_uint
Definition: atomic.h:25
#define atomic_fetch_or_explicit(OBJ, VAL, MO)
Definition: atomic.h:105
#define atomic_thread_fence(MO)
Definition: atomic.h:115
#define atomic_compare_exchange_strong(OBJ, EXP, DES)
Definition: atomic.h:79
#define atomic_fetch_and(OBJ, VAL)
Definition: atomic.h:111
short atomic_short
Definition: atomic.h:22
unsigned short atomic_ushort
Definition: atomic.h:23
long atomic_long
Definition: atomic.h:27
unsigned long atomic_ulong
Definition: atomic.h:28
int atomic_flag
Definition: atomic.h:19
#define atomic_init(OBJ, VAL)
Definition: atomic.h:52
#define atomic_fetch_xor_explicit(OBJ, VAL, MO)
Definition: atomic.h:109
atomic_uint atomic_uintptr_t
Definition: atomic.h:26
#define atomic_exchange_explicit(OBJ, DES, MO)
Definition: atomic.h:77
#define atomic_load_explicit(OBJ, MO)
Definition: atomic.h:62
#define atomic_fetch_add_explicit(OBJ, VAL, MO)
Definition: atomic.h:97
#define atomic_store(OBJ, VAL)
Definition: atomic.h:56
long long atomic_llong
Definition: atomic.h:29
#define atomic_exchange(OBJ, DES)
Definition: atomic.h:64
#define atomic_fetch_sub(OBJ, VAL)
Definition: atomic.h:99
#define atomic_is_lock_free(OBJ)
Definition: atomic.h:54
#define atomic_flag_test_and_set_explicit(FLAG, MO)
Definition: atomic.h:46
#define atomic_compare_exchange_weak(OBJ, EXP, DES)
Definition: atomic.h:91
#define atomic_fetch_or(OBJ, VAL)
Definition: atomic.h:103
#define atomic_fetch_xor(OBJ, VAL)
Definition: atomic.h:107
#define atomic_store_explicit(OBJ, VAL, MO)
Definition: atomic.h:58