1 // Copyright (c) 2011 Helge Bahmann
2 // Copyright (c) 2020 Andrey Semashev
3 //
4 // Distributed under the Boost Software License, Version 1.0.
5 // See accompanying file LICENSE_1_0.txt or copy at
6 // http://www.boost.org/LICENSE_1_0.txt)
7
8 // Verify that definition of the "LOCK_FREE" macros and the
9 // "is_lock_free" members is consistent and matches expectations.
10 // Also, if any operation is lock-free, then the platform
11 // implementation must provide overridden fence implementations.
12
13 #include <boost/atomic.hpp>
14
15 #include <iostream>
16 #include <boost/config.hpp>
17 #include <boost/core/lightweight_test.hpp>
18 #include "aligned_object.hpp"
19
20 static const char* const lock_free_level[] =
21 {
22 "never",
23 "sometimes",
24 "always"
25 };
26
27 template< typename T >
verify_lock_free(const char * type_name,int lock_free_macro_val,int lock_free_expect)28 void verify_lock_free(const char* type_name, int lock_free_macro_val, int lock_free_expect)
29 {
30 BOOST_TEST(lock_free_macro_val >= 0 && lock_free_macro_val <= 2);
31 BOOST_TEST_EQ(lock_free_macro_val, lock_free_expect);
32
33 boost::atomic<T> value;
34
35 if (lock_free_macro_val == 0)
36 BOOST_TEST(!value.is_lock_free());
37 if (lock_free_macro_val == 2)
38 BOOST_TEST(value.is_lock_free());
39
40 BOOST_TEST_EQ(boost::atomic<T>::is_always_lock_free, (lock_free_expect == 2));
41
42 std::cout << "atomic<" << type_name << "> is " << lock_free_level[lock_free_macro_val] << " lock free\n";
43
44 // atomic<T> may use larger storage than sizeof(T) to achieve lock-free property. In this case atomic_ref<T> may not be lock-free.
45 if (sizeof(boost::atomic<T>) == sizeof(T))
46 {
47 aligned_object<T, boost::atomic_ref<T>::required_alignment> object;
48 boost::atomic_ref<T> ref(object.get());
49
50 BOOST_TEST_EQ(ref.is_lock_free(), value.is_lock_free());
51 BOOST_TEST_EQ(boost::atomic_ref<T>::is_always_lock_free, boost::atomic<T>::is_always_lock_free);
52 }
53 }
54
55 #if (defined(__GNUC__) || defined(__SUNPRO_CC)) && defined(__i386__)
56
57 #define EXPECT_CHAR_LOCK_FREE 2
58 #define EXPECT_SHORT_LOCK_FREE 2
59 #define EXPECT_INT_LOCK_FREE 2
60 #define EXPECT_LONG_LOCK_FREE 2
61 #if defined(BOOST_ATOMIC_DETAIL_X86_HAS_CMPXCHG8B) || defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_8) ||\
62 defined(__i586__) || defined(__i686__) || defined(__SSE__)
63 #define EXPECT_LLONG_LOCK_FREE 2
64 #else
65 #define EXPECT_LLONG_LOCK_FREE 0
66 #endif
67 #define EXPECT_INT128_LOCK_FREE 0
68 #define EXPECT_POINTER_LOCK_FREE 2
69 #define EXPECT_BOOL_LOCK_FREE 2
70
71 #elif (defined(__GNUC__) || defined(__SUNPRO_CC)) && defined(__x86_64__)
72
73 #define EXPECT_CHAR_LOCK_FREE 2
74 #define EXPECT_SHORT_LOCK_FREE 2
75 #define EXPECT_INT_LOCK_FREE 2
76 #define EXPECT_LONG_LOCK_FREE 2
77 #define EXPECT_LLONG_LOCK_FREE 2
78 #if defined(BOOST_ATOMIC_DETAIL_X86_HAS_CMPXCHG16B) || defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_16)
79 #define EXPECT_INT128_LOCK_FREE 2
80 #else
81 #define EXPECT_INT128_LOCK_FREE 0
82 #endif
83 #define EXPECT_POINTER_LOCK_FREE 2
84 #define EXPECT_BOOL_LOCK_FREE 2
85
86 #elif defined(__GNUC__) && (defined(__POWERPC__) || defined(__PPC__))
87
88 #define EXPECT_CHAR_LOCK_FREE 2
89 #define EXPECT_CHAR16_T_LOCK_FREE 2
90 #define EXPECT_CHAR32_T_LOCK_FREE 2
91 #define EXPECT_WCHAR_T_LOCK_FREE 2
92 #define EXPECT_SHORT_LOCK_FREE 2
93 #define EXPECT_INT_LOCK_FREE 2
94 #define EXPECT_LONG_LOCK_FREE 2
95 #if defined(__powerpc64__)
96 #define EXPECT_LLONG_LOCK_FREE 2
97 #else
98 #define EXPECT_LLONG_LOCK_FREE 0
99 #endif
100 #define EXPECT_INT128_LOCK_FREE 0
101 #define EXPECT_POINTER_LOCK_FREE 2
102 #define EXPECT_BOOL_LOCK_FREE 2
103
104 #elif defined(__GNUC__) && defined(__alpha__)
105
106 #define EXPECT_CHAR_LOCK_FREE 2
107 #define EXPECT_CHAR16_T_LOCK_FREE 2
108 #define EXPECT_CHAR32_T_LOCK_FREE 2
109 #define EXPECT_WCHAR_T_LOCK_FREE 2
110 #define EXPECT_SHORT_LOCK_FREE 2
111 #define EXPECT_INT_LOCK_FREE 2
112 #define EXPECT_LONG_LOCK_FREE 2
113 #define EXPECT_LLONG_LOCK_FREE 2
114 #define EXPECT_INT128_LOCK_FREE 0
115 #define EXPECT_POINTER_LOCK_FREE 2
116 #define EXPECT_BOOL_LOCK_FREE 2
117
118 #elif defined(__GNUC__) && defined(__aarch64__)
119
120 #define EXPECT_CHAR_LOCK_FREE 2
121 #define EXPECT_SHORT_LOCK_FREE 2
122 #define EXPECT_INT_LOCK_FREE 2
123 #define EXPECT_LONG_LOCK_FREE 2
124 #define EXPECT_LLONG_LOCK_FREE 2
125 #define EXPECT_INT128_LOCK_FREE 2
126 #define EXPECT_POINTER_LOCK_FREE 2
127 #define EXPECT_BOOL_LOCK_FREE 2
128
129 #elif defined(__GNUC__) && defined(__arm__) &&\
130 (\
131 (defined(__ARM_ARCH) && __ARM_ARCH >= 6) ||\
132 defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) ||\
133 defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6Z__) ||\
134 defined(__ARM_ARCH_6ZK__) ||\
135 defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7A__) ||\
136 defined(__ARM_ARCH_7R__) || defined(__ARM_ARCH_7M__) ||\
137 defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_7S__) ||\
138 defined(__ARM_ARCH_8A__)\
139 )
140
141 #define EXPECT_CHAR_LOCK_FREE 2
142 #define EXPECT_SHORT_LOCK_FREE 2
143 #define EXPECT_INT_LOCK_FREE 2
144 #define EXPECT_LONG_LOCK_FREE 2
145 #if !(defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6Z__)\
146 || ((defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6ZK__)) && defined(__thumb__)) || defined(__ARM_ARCH_7M__))
147 #define EXPECT_LLONG_LOCK_FREE 2
148 #else
149 #define EXPECT_LLONG_LOCK_FREE 0
150 #endif
151 #define EXPECT_INT128_LOCK_FREE 0
152 #define EXPECT_POINTER_LOCK_FREE 2
153 #define EXPECT_BOOL_LOCK_FREE 2
154
155 #elif defined(__linux__) && defined(__arm__)
156
157 #define EXPECT_CHAR_LOCK_FREE 2
158 #define EXPECT_SHORT_LOCK_FREE 2
159 #define EXPECT_INT_LOCK_FREE 2
160 #define EXPECT_LONG_LOCK_FREE 2
161 #define EXPECT_LLONG_LOCK_FREE 0
162 #define EXPECT_INT128_LOCK_FREE 0
163 #define EXPECT_POINTER_LOCK_FREE 2
164 #define EXPECT_BOOL_LOCK_FREE 2
165
166 #elif (defined(__GNUC__) || defined(__SUNPRO_CC)) && (defined(__sparcv8plus) || defined(__sparc_v9__))
167
168 #define EXPECT_CHAR_LOCK_FREE 2
169 #define EXPECT_SHORT_LOCK_FREE 2
170 #define EXPECT_INT_LOCK_FREE 2
171 #define EXPECT_LONG_LOCK_FREE 2
172 #define EXPECT_LLONG_LOCK_FREE 2
173 #define EXPECT_INT128_LOCK_FREE 0
174 #define EXPECT_POINTER_LOCK_FREE 2
175 #define EXPECT_BOOL_LOCK_FREE 2
176
177 #elif defined(BOOST_USE_WINDOWS_H) || defined(_WIN32_CE) || defined(BOOST_MSVC) || defined(BOOST_INTEL_WIN) || defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__)
178
179 #define EXPECT_CHAR_LOCK_FREE 2
180 #define EXPECT_SHORT_LOCK_FREE 2
181 #define EXPECT_INT_LOCK_FREE 2
182 #define EXPECT_LONG_LOCK_FREE 2
183 #if defined(_WIN64) || defined(BOOST_ATOMIC_DETAIL_X86_HAS_CMPXCHG8B) || defined(_M_AMD64) || defined(_M_IA64) || (_MSC_VER >= 1700 && (defined(_M_ARM) || defined(_M_ARM64)))
184 #define EXPECT_LLONG_LOCK_FREE 2
185 #else
186 #define EXPECT_LLONG_LOCK_FREE 0
187 #endif
188 #define EXPECT_INT128_LOCK_FREE 0
189 #define EXPECT_POINTER_LOCK_FREE 2
190 #define EXPECT_BOOL_LOCK_FREE 2
191
192 #else
193
194 #define EXPECT_CHAR_LOCK_FREE 0
195 #define EXPECT_SHORT_LOCK_FREE 0
196 #define EXPECT_INT_LOCK_FREE 0
197 #define EXPECT_LONG_LOCK_FREE 0
198 #define EXPECT_LLONG_LOCK_FREE 0
199 #define EXPECT_INT128_LOCK_FREE 0
200 #define EXPECT_POINTER_LOCK_FREE 0
201 #define EXPECT_BOOL_LOCK_FREE 0
202
203 #endif
204
main(int,char * [])205 int main(int, char *[])
206 {
207 verify_lock_free<char>("char", BOOST_ATOMIC_CHAR_LOCK_FREE, EXPECT_CHAR_LOCK_FREE);
208 verify_lock_free<short>("short", BOOST_ATOMIC_SHORT_LOCK_FREE, EXPECT_SHORT_LOCK_FREE);
209 verify_lock_free<int>("int", BOOST_ATOMIC_INT_LOCK_FREE, EXPECT_INT_LOCK_FREE);
210 verify_lock_free<long>("long", BOOST_ATOMIC_LONG_LOCK_FREE, EXPECT_LONG_LOCK_FREE);
211 #ifdef BOOST_HAS_LONG_LONG
212 verify_lock_free<long long>("long long", BOOST_ATOMIC_LLONG_LOCK_FREE, EXPECT_LLONG_LOCK_FREE);
213 #endif
214 #ifdef BOOST_HAS_INT128
215 verify_lock_free<boost::int128_type>("int128", BOOST_ATOMIC_INT128_LOCK_FREE, EXPECT_INT128_LOCK_FREE);
216 #endif
217 verify_lock_free<void *>("void *", BOOST_ATOMIC_POINTER_LOCK_FREE, EXPECT_SHORT_LOCK_FREE);
218 verify_lock_free<bool>("bool", BOOST_ATOMIC_BOOL_LOCK_FREE, EXPECT_BOOL_LOCK_FREE);
219
220 #ifndef BOOST_ATOMIC_NO_FLOATING_POINT
221
222 verify_lock_free<float>("float", BOOST_ATOMIC_FLOAT_LOCK_FREE,
223 sizeof(float) == 1 ? EXPECT_CHAR_LOCK_FREE : (sizeof(float) == 2 ? EXPECT_SHORT_LOCK_FREE :
224 (sizeof(float) <= 4 ? EXPECT_INT_LOCK_FREE : (sizeof(float) <= 8 ? EXPECT_LLONG_LOCK_FREE : (sizeof(float) <= 16 ? EXPECT_INT128_LOCK_FREE : 0)))));
225
226 verify_lock_free<double>("double", BOOST_ATOMIC_DOUBLE_LOCK_FREE,
227 sizeof(double) == 1 ? EXPECT_CHAR_LOCK_FREE : (sizeof(double) == 2 ? EXPECT_SHORT_LOCK_FREE :
228 (sizeof(double) <= 4 ? EXPECT_INT_LOCK_FREE : (sizeof(double) <= 8 ? EXPECT_LLONG_LOCK_FREE : (sizeof(double) <= 16 ? EXPECT_INT128_LOCK_FREE : 0)))));
229
230 verify_lock_free<long double>("long double", BOOST_ATOMIC_LONG_DOUBLE_LOCK_FREE,
231 sizeof(long double) == 1 ? EXPECT_CHAR_LOCK_FREE : (sizeof(long double) == 2 ? EXPECT_SHORT_LOCK_FREE :
232 (sizeof(long double) <= 4 ? EXPECT_INT_LOCK_FREE : (sizeof(long double) <= 8 ? EXPECT_LLONG_LOCK_FREE : (sizeof(long double) <= 16 ? EXPECT_INT128_LOCK_FREE : 0)))));
233
234 #if defined(BOOST_HAS_INT128) && defined(BOOST_HAS_FLOAT128)
235 verify_lock_free<boost::float128_type>("float128", BOOST_ATOMIC_INT128_LOCK_FREE, EXPECT_INT128_LOCK_FREE);
236 #endif
237
238 #endif // BOOST_ATOMIC_NO_FLOATING_POINT
239
240 bool any_lock_free =
241 BOOST_ATOMIC_CHAR_LOCK_FREE > 0 ||
242 BOOST_ATOMIC_SHORT_LOCK_FREE > 0 ||
243 BOOST_ATOMIC_INT_LOCK_FREE > 0 ||
244 BOOST_ATOMIC_LONG_LOCK_FREE > 0 ||
245 BOOST_ATOMIC_LLONG_LOCK_FREE > 0 ||
246 BOOST_ATOMIC_BOOL_LOCK_FREE > 0;
247
248 BOOST_TEST(!any_lock_free || BOOST_ATOMIC_THREAD_FENCE > 0);
249
250 return boost::report_errors();
251 }
252