annotate clang/lib/Headers/stdatomic.h @ 176:de4ac79aef9d

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