LLVM OpenMP* Runtime Library
kmp_os.h
1 /*
2  * kmp_os.h -- KPTS runtime header file.
3  */
4 
5 
6 //===----------------------------------------------------------------------===//
7 //
8 // The LLVM Compiler Infrastructure
9 //
10 // This file is dual licensed under the MIT and the University of Illinois Open
11 // Source Licenses. See LICENSE.txt for details.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 
16 #ifndef KMP_OS_H
17 #define KMP_OS_H
18 
19 #include "kmp_config.h"
20 #include <stdlib.h>
21 
22 #define KMP_FTN_PLAIN 1
23 #define KMP_FTN_APPEND 2
24 #define KMP_FTN_UPPER 3
25 /*
26 #define KMP_FTN_PREPEND 4
27 #define KMP_FTN_UAPPEND 5
28 */
29 
30 #define KMP_PTR_SKIP (sizeof(void *))
31 
32 /* -------------------------- Compiler variations ------------------------ */
33 
34 #define KMP_OFF 0
35 #define KMP_ON 1
36 
37 #define KMP_MEM_CONS_VOLATILE 0
38 #define KMP_MEM_CONS_FENCE 1
39 
40 #ifndef KMP_MEM_CONS_MODEL
41 #define KMP_MEM_CONS_MODEL KMP_MEM_CONS_VOLATILE
42 #endif
43 
44 /* ------------------------- Compiler recognition ---------------------- */
45 #define KMP_COMPILER_ICC 0
46 #define KMP_COMPILER_GCC 0
47 #define KMP_COMPILER_CLANG 0
48 #define KMP_COMPILER_MSVC 0
49 
50 #if defined(__INTEL_COMPILER)
51 #undef KMP_COMPILER_ICC
52 #define KMP_COMPILER_ICC 1
53 #elif defined(__clang__)
54 #undef KMP_COMPILER_CLANG
55 #define KMP_COMPILER_CLANG 1
56 #elif defined(__GNUC__)
57 #undef KMP_COMPILER_GCC
58 #define KMP_COMPILER_GCC 1
59 #elif defined(_MSC_VER)
60 #undef KMP_COMPILER_MSVC
61 #define KMP_COMPILER_MSVC 1
62 #else
63 #error Unknown compiler
64 #endif
65 
66 #if (KMP_OS_LINUX || KMP_OS_WINDOWS) && !KMP_OS_CNK && !KMP_ARCH_PPC64
67 #define KMP_AFFINITY_SUPPORTED 1
68 #if KMP_OS_WINDOWS && KMP_ARCH_X86_64
69 #define KMP_GROUP_AFFINITY 1
70 #else
71 #define KMP_GROUP_AFFINITY 0
72 #endif
73 #else
74 #define KMP_AFFINITY_SUPPORTED 0
75 #define KMP_GROUP_AFFINITY 0
76 #endif
77 
78 /* Check for quad-precision extension. */
79 #define KMP_HAVE_QUAD 0
80 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
81 #if KMP_COMPILER_ICC
82 /* _Quad is already defined for icc */
83 #undef KMP_HAVE_QUAD
84 #define KMP_HAVE_QUAD 1
85 #elif KMP_COMPILER_CLANG
86 /* Clang doesn't support a software-implemented
87  128-bit extended precision type yet */
88 typedef long double _Quad;
89 #elif KMP_COMPILER_GCC
90 typedef __float128 _Quad;
91 #undef KMP_HAVE_QUAD
92 #define KMP_HAVE_QUAD 1
93 #elif KMP_COMPILER_MSVC
94 typedef long double _Quad;
95 #endif
96 #else
97 #if __LDBL_MAX_EXP__ >= 16384 && KMP_COMPILER_GCC
98 typedef long double _Quad;
99 #undef KMP_HAVE_QUAD
100 #define KMP_HAVE_QUAD 1
101 #endif
102 #endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
103 
104 #if KMP_OS_WINDOWS
105 typedef char kmp_int8;
106 typedef unsigned char kmp_uint8;
107 typedef short kmp_int16;
108 typedef unsigned short kmp_uint16;
109 typedef int kmp_int32;
110 typedef unsigned int kmp_uint32;
111 #define KMP_INT32_SPEC "d"
112 #define KMP_UINT32_SPEC "u"
113 #ifndef KMP_STRUCT64
114 typedef __int64 kmp_int64;
115 typedef unsigned __int64 kmp_uint64;
116 #define KMP_INT64_SPEC "I64d"
117 #define KMP_UINT64_SPEC "I64u"
118 #else
119 struct kmp_struct64 {
120  kmp_int32 a, b;
121 };
122 typedef struct kmp_struct64 kmp_int64;
123 typedef struct kmp_struct64 kmp_uint64;
124 /* Not sure what to use for KMP_[U]INT64_SPEC here */
125 #endif
126 #if KMP_ARCH_X86_64
127 #define KMP_INTPTR 1
128 typedef __int64 kmp_intptr_t;
129 typedef unsigned __int64 kmp_uintptr_t;
130 #define KMP_INTPTR_SPEC "I64d"
131 #define KMP_UINTPTR_SPEC "I64u"
132 #endif
133 #endif /* KMP_OS_WINDOWS */
134 
135 #if KMP_OS_UNIX
136 typedef char kmp_int8;
137 typedef unsigned char kmp_uint8;
138 typedef short kmp_int16;
139 typedef unsigned short kmp_uint16;
140 typedef int kmp_int32;
141 typedef unsigned int kmp_uint32;
142 typedef long long kmp_int64;
143 typedef unsigned long long kmp_uint64;
144 #define KMP_INT32_SPEC "d"
145 #define KMP_UINT32_SPEC "u"
146 #define KMP_INT64_SPEC "lld"
147 #define KMP_UINT64_SPEC "llu"
148 #endif /* KMP_OS_UNIX */
149 
150 #if KMP_ARCH_X86 || KMP_ARCH_ARM || KMP_ARCH_MIPS
151 #define KMP_SIZE_T_SPEC KMP_UINT32_SPEC
152 #elif KMP_ARCH_X86_64 || KMP_ARCH_PPC64 || KMP_ARCH_AARCH64 || KMP_ARCH_MIPS64
153 #define KMP_SIZE_T_SPEC KMP_UINT64_SPEC
154 #else
155 #error "Can't determine size_t printf format specifier."
156 #endif
157 
158 #if KMP_ARCH_X86
159 #define KMP_SIZE_T_MAX (0xFFFFFFFF)
160 #else
161 #define KMP_SIZE_T_MAX (0xFFFFFFFFFFFFFFFF)
162 #endif
163 
164 typedef size_t kmp_size_t;
165 typedef float kmp_real32;
166 typedef double kmp_real64;
167 
168 #ifndef KMP_INTPTR
169 #define KMP_INTPTR 1
170 typedef long kmp_intptr_t;
171 typedef unsigned long kmp_uintptr_t;
172 #define KMP_INTPTR_SPEC "ld"
173 #define KMP_UINTPTR_SPEC "lu"
174 #endif
175 
176 #ifdef BUILD_I8
177 typedef kmp_int64 kmp_int;
178 typedef kmp_uint64 kmp_uint;
179 #else
180 typedef kmp_int32 kmp_int;
181 typedef kmp_uint32 kmp_uint;
182 #endif /* BUILD_I8 */
183 #define KMP_INT_MAX ((kmp_int32)0x7FFFFFFF)
184 #define KMP_INT_MIN ((kmp_int32)0x80000000)
185 
186 #ifdef __cplusplus
187 // macros to cast out qualifiers and to re-interpret types
188 #define CCAST(type, var) const_cast<type>(var)
189 #define RCAST(type, var) reinterpret_cast<type>(var)
190 //-------------------------------------------------------------------------
191 // template for debug prints specification ( d, u, lld, llu ), and to obtain
192 // signed/unsigned flavors of a type
193 template <typename T> struct traits_t {};
194 // int
195 template <> struct traits_t<signed int> {
196  typedef signed int signed_t;
197  typedef unsigned int unsigned_t;
198  typedef double floating_t;
199  static char const *spec;
200  static const signed_t max_value = 0x7fffffff;
201  static const signed_t min_value = 0x80000000;
202  static const int type_size = sizeof(signed_t);
203 };
204 // unsigned int
205 template <> struct traits_t<unsigned int> {
206  typedef signed int signed_t;
207  typedef unsigned int unsigned_t;
208  typedef double floating_t;
209  static char const *spec;
210  static const unsigned_t max_value = 0xffffffff;
211  static const unsigned_t min_value = 0x00000000;
212  static const int type_size = sizeof(unsigned_t);
213 };
214 // long long
215 template <> struct traits_t<signed long long> {
216  typedef signed long long signed_t;
217  typedef unsigned long long unsigned_t;
218  typedef long double floating_t;
219  static char const *spec;
220  static const signed_t max_value = 0x7fffffffffffffffLL;
221  static const signed_t min_value = 0x8000000000000000LL;
222  static const int type_size = sizeof(signed_t);
223 };
224 // unsigned long long
225 template <> struct traits_t<unsigned long long> {
226  typedef signed long long signed_t;
227  typedef unsigned long long unsigned_t;
228  typedef long double floating_t;
229  static char const *spec;
230  static const unsigned_t max_value = 0xffffffffffffffffLL;
231  static const unsigned_t min_value = 0x0000000000000000LL;
232  static const int type_size = sizeof(unsigned_t);
233 };
234 //-------------------------------------------------------------------------
235 #else
236 #define CCAST(type, var) (type)(var)
237 #define RCAST(type, var) (type)(var)
238 #endif // __cplusplus
239 
240 #define KMP_EXPORT extern /* export declaration in guide libraries */
241 
242 #if __GNUC__ >= 4
243 #define __forceinline __inline
244 #endif
245 
246 #if KMP_OS_WINDOWS
247 #include <windows.h>
248 
249 static inline int KMP_GET_PAGE_SIZE(void) {
250  SYSTEM_INFO si;
251  GetSystemInfo(&si);
252  return si.dwPageSize;
253 }
254 #else
255 #define KMP_GET_PAGE_SIZE() getpagesize()
256 #endif
257 
258 #define PAGE_ALIGNED(_addr) \
259  (!((size_t)_addr & (size_t)(KMP_GET_PAGE_SIZE() - 1)))
260 #define ALIGN_TO_PAGE(x) \
261  (void *)(((size_t)(x)) & ~((size_t)(KMP_GET_PAGE_SIZE() - 1)))
262 
263 /* ---------- Support for cache alignment, padding, etc. ----------------*/
264 
265 #ifdef __cplusplus
266 extern "C" {
267 #endif // __cplusplus
268 
269 #define INTERNODE_CACHE_LINE 4096 /* for multi-node systems */
270 
271 /* Define the default size of the cache line */
272 #ifndef CACHE_LINE
273 #define CACHE_LINE 128 /* cache line size in bytes */
274 #else
275 #if (CACHE_LINE < 64) && !defined(KMP_OS_DARWIN)
276 // 2006-02-13: This produces too many warnings on OS X*. Disable for now
277 #warning CACHE_LINE is too small.
278 #endif
279 #endif /* CACHE_LINE */
280 
281 #define KMP_CACHE_PREFETCH(ADDR) /* nothing */
282 
283 /* Temporary note: if performance testing of this passes, we can remove
284  all references to KMP_DO_ALIGN and replace with KMP_ALIGN. */
285 #if KMP_OS_UNIX && defined(__GNUC__)
286 #define KMP_DO_ALIGN(bytes) __attribute__((aligned(bytes)))
287 #define KMP_ALIGN_CACHE __attribute__((aligned(CACHE_LINE)))
288 #define KMP_ALIGN_CACHE_INTERNODE __attribute__((aligned(INTERNODE_CACHE_LINE)))
289 #define KMP_ALIGN(bytes) __attribute__((aligned(bytes)))
290 #else
291 #define KMP_DO_ALIGN(bytes) __declspec(align(bytes))
292 #define KMP_ALIGN_CACHE __declspec(align(CACHE_LINE))
293 #define KMP_ALIGN_CACHE_INTERNODE __declspec(align(INTERNODE_CACHE_LINE))
294 #define KMP_ALIGN(bytes) __declspec(align(bytes))
295 #endif
296 
297 /* General purpose fence types for memory operations */
298 enum kmp_mem_fence_type {
299  kmp_no_fence, /* No memory fence */
300  kmp_acquire_fence, /* Acquire (read) memory fence */
301  kmp_release_fence, /* Release (write) memory fence */
302  kmp_full_fence /* Full (read+write) memory fence */
303 };
304 
305 // Synchronization primitives
306 
307 #if KMP_ASM_INTRINS && KMP_OS_WINDOWS
308 
309 #pragma intrinsic(InterlockedExchangeAdd)
310 #pragma intrinsic(InterlockedCompareExchange)
311 #pragma intrinsic(InterlockedExchange)
312 #pragma intrinsic(InterlockedExchange64)
313 
314 // Using InterlockedIncrement / InterlockedDecrement causes a library loading
315 // ordering problem, so we use InterlockedExchangeAdd instead.
316 #define KMP_TEST_THEN_INC32(p) InterlockedExchangeAdd((volatile long *)(p), 1)
317 #define KMP_TEST_THEN_INC_ACQ32(p) \
318  InterlockedExchangeAdd((volatile long *)(p), 1)
319 #define KMP_TEST_THEN_ADD4_32(p) InterlockedExchangeAdd((volatile long *)(p), 4)
320 #define KMP_TEST_THEN_ADD4_ACQ32(p) \
321  InterlockedExchangeAdd((volatile long *)(p), 4)
322 #define KMP_TEST_THEN_DEC32(p) InterlockedExchangeAdd((volatile long *)(p), -1)
323 #define KMP_TEST_THEN_DEC_ACQ32(p) \
324  InterlockedExchangeAdd((volatile long *)(p), -1)
325 #define KMP_TEST_THEN_ADD32(p, v) \
326  InterlockedExchangeAdd((volatile long *)(p), (v))
327 
328 #define KMP_COMPARE_AND_STORE_RET32(p, cv, sv) \
329  InterlockedCompareExchange((volatile long *)(p), (long)(sv), (long)(cv))
330 
331 #define KMP_XCHG_FIXED32(p, v) \
332  InterlockedExchange((volatile long *)(p), (long)(v))
333 #define KMP_XCHG_FIXED64(p, v) \
334  InterlockedExchange64((volatile kmp_int64 *)(p), (kmp_int64)(v))
335 
336 inline kmp_real32 KMP_XCHG_REAL32(volatile kmp_real32 *p, kmp_real32 v) {
337  kmp_int32 tmp = InterlockedExchange((volatile long *)p, *(long *)&v);
338  return *(kmp_real32 *)&tmp;
339 }
340 
341 // Routines that we still need to implement in assembly.
342 extern kmp_int8 __kmp_test_then_add8(volatile kmp_int8 *p, kmp_int8 v);
343 extern kmp_int8 __kmp_test_then_or8(volatile kmp_int8 *p, kmp_int8 v);
344 extern kmp_int8 __kmp_test_then_and8(volatile kmp_int8 *p, kmp_int8 v);
345 extern kmp_int32 __kmp_test_then_add32(volatile kmp_int32 *p, kmp_int32 v);
346 extern kmp_uint32 __kmp_test_then_or32(volatile kmp_uint32 *p, kmp_uint32 v);
347 extern kmp_uint32 __kmp_test_then_and32(volatile kmp_uint32 *p, kmp_uint32 v);
348 extern kmp_int64 __kmp_test_then_add64(volatile kmp_int64 *p, kmp_int64 v);
349 extern kmp_uint64 __kmp_test_then_or64(volatile kmp_uint64 *p, kmp_uint64 v);
350 extern kmp_uint64 __kmp_test_then_and64(volatile kmp_uint64 *p, kmp_uint64 v);
351 
352 extern kmp_int8 __kmp_compare_and_store8(volatile kmp_int8 *p, kmp_int8 cv,
353  kmp_int8 sv);
354 extern kmp_int16 __kmp_compare_and_store16(volatile kmp_int16 *p, kmp_int16 cv,
355  kmp_int16 sv);
356 extern kmp_int32 __kmp_compare_and_store32(volatile kmp_int32 *p, kmp_int32 cv,
357  kmp_int32 sv);
358 extern kmp_int32 __kmp_compare_and_store64(volatile kmp_int64 *p, kmp_int64 cv,
359  kmp_int64 sv);
360 extern kmp_int8 __kmp_compare_and_store_ret8(volatile kmp_int8 *p, kmp_int8 cv,
361  kmp_int8 sv);
362 extern kmp_int16 __kmp_compare_and_store_ret16(volatile kmp_int16 *p,
363  kmp_int16 cv, kmp_int16 sv);
364 extern kmp_int32 __kmp_compare_and_store_ret32(volatile kmp_int32 *p,
365  kmp_int32 cv, kmp_int32 sv);
366 extern kmp_int64 __kmp_compare_and_store_ret64(volatile kmp_int64 *p,
367  kmp_int64 cv, kmp_int64 sv);
368 
369 extern kmp_int8 __kmp_xchg_fixed8(volatile kmp_int8 *p, kmp_int8 v);
370 extern kmp_int16 __kmp_xchg_fixed16(volatile kmp_int16 *p, kmp_int16 v);
371 extern kmp_int32 __kmp_xchg_fixed32(volatile kmp_int32 *p, kmp_int32 v);
372 extern kmp_int64 __kmp_xchg_fixed64(volatile kmp_int64 *p, kmp_int64 v);
373 extern kmp_real32 __kmp_xchg_real32(volatile kmp_real32 *p, kmp_real32 v);
374 extern kmp_real64 __kmp_xchg_real64(volatile kmp_real64 *p, kmp_real64 v);
375 
376 //#define KMP_TEST_THEN_INC32(p) __kmp_test_then_add32((p), 1)
377 //#define KMP_TEST_THEN_INC_ACQ32(p) __kmp_test_then_add32((p), 1)
378 #define KMP_TEST_THEN_INC64(p) __kmp_test_then_add64((p), 1LL)
379 #define KMP_TEST_THEN_INC_ACQ64(p) __kmp_test_then_add64((p), 1LL)
380 //#define KMP_TEST_THEN_ADD4_32(p) __kmp_test_then_add32((p), 4)
381 //#define KMP_TEST_THEN_ADD4_ACQ32(p) __kmp_test_then_add32((p), 4)
382 #define KMP_TEST_THEN_ADD4_64(p) __kmp_test_then_add64((p), 4LL)
383 #define KMP_TEST_THEN_ADD4_ACQ64(p) __kmp_test_then_add64((p), 4LL)
384 //#define KMP_TEST_THEN_DEC32(p) __kmp_test_then_add32((p), -1)
385 //#define KMP_TEST_THEN_DEC_ACQ32(p) __kmp_test_then_add32((p), -1)
386 #define KMP_TEST_THEN_DEC64(p) __kmp_test_then_add64((p), -1LL)
387 #define KMP_TEST_THEN_DEC_ACQ64(p) __kmp_test_then_add64((p), -1LL)
388 //#define KMP_TEST_THEN_ADD32(p, v) __kmp_test_then_add32((p), (v))
389 #define KMP_TEST_THEN_ADD8(p, v) __kmp_test_then_add8((p), (v))
390 #define KMP_TEST_THEN_ADD64(p, v) __kmp_test_then_add64((p), (v))
391 
392 #define KMP_TEST_THEN_OR8(p, v) __kmp_test_then_or8((p), (v))
393 #define KMP_TEST_THEN_AND8(p, v) __kmp_test_then_and8((p), (v))
394 #define KMP_TEST_THEN_OR32(p, v) __kmp_test_then_or32((p), (v))
395 #define KMP_TEST_THEN_AND32(p, v) __kmp_test_then_and32((p), (v))
396 #define KMP_TEST_THEN_OR64(p, v) __kmp_test_then_or64((p), (v))
397 #define KMP_TEST_THEN_AND64(p, v) __kmp_test_then_and64((p), (v))
398 
399 #define KMP_COMPARE_AND_STORE_ACQ8(p, cv, sv) \
400  __kmp_compare_and_store8((p), (cv), (sv))
401 #define KMP_COMPARE_AND_STORE_REL8(p, cv, sv) \
402  __kmp_compare_and_store8((p), (cv), (sv))
403 #define KMP_COMPARE_AND_STORE_ACQ16(p, cv, sv) \
404  __kmp_compare_and_store16((p), (cv), (sv))
405 #define KMP_COMPARE_AND_STORE_REL16(p, cv, sv) \
406  __kmp_compare_and_store16((p), (cv), (sv))
407 #define KMP_COMPARE_AND_STORE_ACQ32(p, cv, sv) \
408  __kmp_compare_and_store32((volatile kmp_int32 *)(p), (kmp_int32)(cv), \
409  (kmp_int32)(sv))
410 #define KMP_COMPARE_AND_STORE_REL32(p, cv, sv) \
411  __kmp_compare_and_store32((volatile kmp_int32 *)(p), (kmp_int32)(cv), \
412  (kmp_int32)(sv))
413 #define KMP_COMPARE_AND_STORE_ACQ64(p, cv, sv) \
414  __kmp_compare_and_store64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
415  (kmp_int64)(sv))
416 #define KMP_COMPARE_AND_STORE_REL64(p, cv, sv) \
417  __kmp_compare_and_store64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
418  (kmp_int64)(sv))
419 
420 #if KMP_ARCH_X86
421 #define KMP_COMPARE_AND_STORE_PTR(p, cv, sv) \
422  __kmp_compare_and_store32((volatile kmp_int32 *)(p), (kmp_int32)(cv), \
423  (kmp_int32)(sv))
424 #else /* 64 bit pointers */
425 #define KMP_COMPARE_AND_STORE_PTR(p, cv, sv) \
426  __kmp_compare_and_store64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
427  (kmp_int64)(sv))
428 #endif /* KMP_ARCH_X86 */
429 
430 #define KMP_COMPARE_AND_STORE_RET8(p, cv, sv) \
431  __kmp_compare_and_store_ret8((p), (cv), (sv))
432 #define KMP_COMPARE_AND_STORE_RET16(p, cv, sv) \
433  __kmp_compare_and_store_ret16((p), (cv), (sv))
434 #define KMP_COMPARE_AND_STORE_RET64(p, cv, sv) \
435  __kmp_compare_and_store_ret64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
436  (kmp_int64)(sv))
437 
438 #define KMP_XCHG_FIXED8(p, v) \
439  __kmp_xchg_fixed8((volatile kmp_int8 *)(p), (kmp_int8)(v));
440 #define KMP_XCHG_FIXED16(p, v) __kmp_xchg_fixed16((p), (v));
441 //#define KMP_XCHG_FIXED32(p, v) __kmp_xchg_fixed32((p), (v));
442 //#define KMP_XCHG_FIXED64(p, v) __kmp_xchg_fixed64((p), (v));
443 //#define KMP_XCHG_REAL32(p, v) __kmp_xchg_real32((p), (v));
444 #define KMP_XCHG_REAL64(p, v) __kmp_xchg_real64((p), (v));
445 
446 #elif (KMP_ASM_INTRINS && KMP_OS_UNIX) || !(KMP_ARCH_X86 || KMP_ARCH_X86_64)
447 
448 /* cast p to correct type so that proper intrinsic will be used */
449 #define KMP_TEST_THEN_INC32(p) \
450  __sync_fetch_and_add((volatile kmp_int32 *)(p), 1)
451 #define KMP_TEST_THEN_INC_ACQ32(p) \
452  __sync_fetch_and_add((volatile kmp_int32 *)(p), 1)
453 #define KMP_TEST_THEN_INC64(p) \
454  __sync_fetch_and_add((volatile kmp_int64 *)(p), 1LL)
455 #define KMP_TEST_THEN_INC_ACQ64(p) \
456  __sync_fetch_and_add((volatile kmp_int64 *)(p), 1LL)
457 #define KMP_TEST_THEN_ADD4_32(p) \
458  __sync_fetch_and_add((volatile kmp_int32 *)(p), 4)
459 #define KMP_TEST_THEN_ADD4_ACQ32(p) \
460  __sync_fetch_and_add((volatile kmp_int32 *)(p), 4)
461 #define KMP_TEST_THEN_ADD4_64(p) \
462  __sync_fetch_and_add((volatile kmp_int64 *)(p), 4LL)
463 #define KMP_TEST_THEN_ADD4_ACQ64(p) \
464  __sync_fetch_and_add((volatile kmp_int64 *)(p), 4LL)
465 #define KMP_TEST_THEN_DEC32(p) \
466  __sync_fetch_and_sub((volatile kmp_int32 *)(p), 1)
467 #define KMP_TEST_THEN_DEC_ACQ32(p) \
468  __sync_fetch_and_sub((volatile kmp_int32 *)(p), 1)
469 #define KMP_TEST_THEN_DEC64(p) \
470  __sync_fetch_and_sub((volatile kmp_int64 *)(p), 1LL)
471 #define KMP_TEST_THEN_DEC_ACQ64(p) \
472  __sync_fetch_and_sub((volatile kmp_int64 *)(p), 1LL)
473 #define KMP_TEST_THEN_ADD8(p, v) \
474  __sync_fetch_and_add((volatile kmp_int8 *)(p), (kmp_int8)(v))
475 #define KMP_TEST_THEN_ADD32(p, v) \
476  __sync_fetch_and_add((volatile kmp_int32 *)(p), (kmp_int32)(v))
477 #define KMP_TEST_THEN_ADD64(p, v) \
478  __sync_fetch_and_add((volatile kmp_int64 *)(p), (kmp_int64)(v))
479 
480 #define KMP_TEST_THEN_OR8(p, v) \
481  __sync_fetch_and_or((volatile kmp_int8 *)(p), (kmp_int8)(v))
482 #define KMP_TEST_THEN_AND8(p, v) \
483  __sync_fetch_and_and((volatile kmp_int8 *)(p), (kmp_int8)(v))
484 #define KMP_TEST_THEN_OR32(p, v) \
485  __sync_fetch_and_or((volatile kmp_uint32 *)(p), (kmp_uint32)(v))
486 #define KMP_TEST_THEN_AND32(p, v) \
487  __sync_fetch_and_and((volatile kmp_uint32 *)(p), (kmp_uint32)(v))
488 #define KMP_TEST_THEN_OR64(p, v) \
489  __sync_fetch_and_or((volatile kmp_uint64 *)(p), (kmp_uint64)(v))
490 #define KMP_TEST_THEN_AND64(p, v) \
491  __sync_fetch_and_and((volatile kmp_uint64 *)(p), (kmp_uint64)(v))
492 
493 #define KMP_COMPARE_AND_STORE_ACQ8(p, cv, sv) \
494  __sync_bool_compare_and_swap((volatile kmp_uint8 *)(p), (kmp_uint8)(cv), \
495  (kmp_uint8)(sv))
496 #define KMP_COMPARE_AND_STORE_REL8(p, cv, sv) \
497  __sync_bool_compare_and_swap((volatile kmp_uint8 *)(p), (kmp_uint8)(cv), \
498  (kmp_uint8)(sv))
499 #define KMP_COMPARE_AND_STORE_ACQ16(p, cv, sv) \
500  __sync_bool_compare_and_swap((volatile kmp_uint16 *)(p), (kmp_uint16)(cv), \
501  (kmp_uint16)(sv))
502 #define KMP_COMPARE_AND_STORE_REL16(p, cv, sv) \
503  __sync_bool_compare_and_swap((volatile kmp_uint16 *)(p), (kmp_uint16)(cv), \
504  (kmp_uint16)(sv))
505 #define KMP_COMPARE_AND_STORE_ACQ32(p, cv, sv) \
506  __sync_bool_compare_and_swap((volatile kmp_uint32 *)(p), (kmp_uint32)(cv), \
507  (kmp_uint32)(sv))
508 #define KMP_COMPARE_AND_STORE_REL32(p, cv, sv) \
509  __sync_bool_compare_and_swap((volatile kmp_uint32 *)(p), (kmp_uint32)(cv), \
510  (kmp_uint32)(sv))
511 #define KMP_COMPARE_AND_STORE_ACQ64(p, cv, sv) \
512  __sync_bool_compare_and_swap((volatile kmp_uint64 *)(p), (kmp_uint64)(cv), \
513  (kmp_uint64)(sv))
514 #define KMP_COMPARE_AND_STORE_REL64(p, cv, sv) \
515  __sync_bool_compare_and_swap((volatile kmp_uint64 *)(p), (kmp_uint64)(cv), \
516  (kmp_uint64)(sv))
517 #define KMP_COMPARE_AND_STORE_PTR(p, cv, sv) \
518  __sync_bool_compare_and_swap((void *volatile *)(p), (void *)(cv), \
519  (void *)(sv))
520 
521 #define KMP_COMPARE_AND_STORE_RET8(p, cv, sv) \
522  __sync_val_compare_and_swap((volatile kmp_uint8 *)(p), (kmp_uint8)(cv), \
523  (kmp_uint8)(sv))
524 #define KMP_COMPARE_AND_STORE_RET16(p, cv, sv) \
525  __sync_val_compare_and_swap((volatile kmp_uint16 *)(p), (kmp_uint16)(cv), \
526  (kmp_uint16)(sv))
527 #define KMP_COMPARE_AND_STORE_RET32(p, cv, sv) \
528  __sync_val_compare_and_swap((volatile kmp_uint32 *)(p), (kmp_uint32)(cv), \
529  (kmp_uint32)(sv))
530 #define KMP_COMPARE_AND_STORE_RET64(p, cv, sv) \
531  __sync_val_compare_and_swap((volatile kmp_uint64 *)(p), (kmp_uint64)(cv), \
532  (kmp_uint64)(sv))
533 
534 #define KMP_XCHG_FIXED8(p, v) \
535  __sync_lock_test_and_set((volatile kmp_uint8 *)(p), (kmp_uint8)(v))
536 #define KMP_XCHG_FIXED16(p, v) \
537  __sync_lock_test_and_set((volatile kmp_uint16 *)(p), (kmp_uint16)(v))
538 #define KMP_XCHG_FIXED32(p, v) \
539  __sync_lock_test_and_set((volatile kmp_uint32 *)(p), (kmp_uint32)(v))
540 #define KMP_XCHG_FIXED64(p, v) \
541  __sync_lock_test_and_set((volatile kmp_uint64 *)(p), (kmp_uint64)(v))
542 
543 inline kmp_real32 KMP_XCHG_REAL32(volatile kmp_real32 *p, kmp_real32 v) {
544  kmp_int32 tmp =
545  __sync_lock_test_and_set((volatile kmp_uint32 *)(p), *(kmp_uint32 *)&v);
546  return *(kmp_real32 *)&tmp;
547 }
548 
549 inline kmp_real64 KMP_XCHG_REAL64(volatile kmp_real64 *p, kmp_real64 v) {
550  kmp_int64 tmp =
551  __sync_lock_test_and_set((volatile kmp_uint64 *)(p), *(kmp_uint64 *)&v);
552  return *(kmp_real64 *)&tmp;
553 }
554 
555 #else
556 
557 extern kmp_int8 __kmp_test_then_add8(volatile kmp_int8 *p, kmp_int8 v);
558 extern kmp_int8 __kmp_test_then_or8(volatile kmp_int8 *p, kmp_int8 v);
559 extern kmp_int8 __kmp_test_then_and8(volatile kmp_int8 *p, kmp_int8 v);
560 extern kmp_int32 __kmp_test_then_add32(volatile kmp_int32 *p, kmp_int32 v);
561 extern kmp_uint32 __kmp_test_then_or32(volatile kmp_uint32 *p, kmp_uint32 v);
562 extern kmp_uint32 __kmp_test_then_and32(volatile kmp_uint32 *p, kmp_uint32 v);
563 extern kmp_int64 __kmp_test_then_add64(volatile kmp_int64 *p, kmp_int64 v);
564 extern kmp_uint64 __kmp_test_then_or64(volatile kmp_uint64 *p, kmp_uint64 v);
565 extern kmp_uint64 __kmp_test_then_and64(volatile kmp_uint64 *p, kmp_uint64 v);
566 
567 extern kmp_int8 __kmp_compare_and_store8(volatile kmp_int8 *p, kmp_int8 cv,
568  kmp_int8 sv);
569 extern kmp_int16 __kmp_compare_and_store16(volatile kmp_int16 *p, kmp_int16 cv,
570  kmp_int16 sv);
571 extern kmp_int32 __kmp_compare_and_store32(volatile kmp_int32 *p, kmp_int32 cv,
572  kmp_int32 sv);
573 extern kmp_int32 __kmp_compare_and_store64(volatile kmp_int64 *p, kmp_int64 cv,
574  kmp_int64 sv);
575 extern kmp_int8 __kmp_compare_and_store_ret8(volatile kmp_int8 *p, kmp_int8 cv,
576  kmp_int8 sv);
577 extern kmp_int16 __kmp_compare_and_store_ret16(volatile kmp_int16 *p,
578  kmp_int16 cv, kmp_int16 sv);
579 extern kmp_int32 __kmp_compare_and_store_ret32(volatile kmp_int32 *p,
580  kmp_int32 cv, kmp_int32 sv);
581 extern kmp_int64 __kmp_compare_and_store_ret64(volatile kmp_int64 *p,
582  kmp_int64 cv, kmp_int64 sv);
583 
584 extern kmp_int8 __kmp_xchg_fixed8(volatile kmp_int8 *p, kmp_int8 v);
585 extern kmp_int16 __kmp_xchg_fixed16(volatile kmp_int16 *p, kmp_int16 v);
586 extern kmp_int32 __kmp_xchg_fixed32(volatile kmp_int32 *p, kmp_int32 v);
587 extern kmp_int64 __kmp_xchg_fixed64(volatile kmp_int64 *p, kmp_int64 v);
588 extern kmp_real32 __kmp_xchg_real32(volatile kmp_real32 *p, kmp_real32 v);
589 extern kmp_real64 __kmp_xchg_real64(volatile kmp_real64 *p, kmp_real64 v);
590 
591 #define KMP_TEST_THEN_INC32(p) \
592  __kmp_test_then_add32((volatile kmp_int32 *)(p), 1)
593 #define KMP_TEST_THEN_INC_ACQ32(p) \
594  __kmp_test_then_add32((volatile kmp_int32 *)(p), 1)
595 #define KMP_TEST_THEN_INC64(p) \
596  __kmp_test_then_add64((volatile kmp_int64 *)(p), 1LL)
597 #define KMP_TEST_THEN_INC_ACQ64(p) \
598  __kmp_test_then_add64((volatile kmp_int64 *)(p), 1LL)
599 #define KMP_TEST_THEN_ADD4_32(p) \
600  __kmp_test_then_add32((volatile kmp_int32 *)(p), 4)
601 #define KMP_TEST_THEN_ADD4_ACQ32(p) \
602  __kmp_test_then_add32((volatile kmp_int32 *)(p), 4)
603 #define KMP_TEST_THEN_ADD4_64(p) \
604  __kmp_test_then_add64((volatile kmp_int64 *)(p), 4LL)
605 #define KMP_TEST_THEN_ADD4_ACQ64(p) \
606  __kmp_test_then_add64((volatile kmp_int64 *)(p), 4LL)
607 #define KMP_TEST_THEN_DEC32(p) \
608  __kmp_test_then_add32((volatile kmp_int32 *)(p), -1)
609 #define KMP_TEST_THEN_DEC_ACQ32(p) \
610  __kmp_test_then_add32((volatile kmp_int32 *)(p), -1)
611 #define KMP_TEST_THEN_DEC64(p) \
612  __kmp_test_then_add64((volatile kmp_int64 *)(p), -1LL)
613 #define KMP_TEST_THEN_DEC_ACQ64(p) \
614  __kmp_test_then_add64((volatile kmp_int64 *)(p), -1LL)
615 #define KMP_TEST_THEN_ADD8(p, v) \
616  __kmp_test_then_add8((volatile kmp_int8 *)(p), (kmp_int8)(v))
617 #define KMP_TEST_THEN_ADD32(p, v) \
618  __kmp_test_then_add32((volatile kmp_int32 *)(p), (kmp_int32)(v))
619 #define KMP_TEST_THEN_ADD64(p, v) \
620  __kmp_test_then_add64((volatile kmp_int64 *)(p), (kmp_int64)(v))
621 
622 #define KMP_TEST_THEN_OR8(p, v) \
623  __kmp_test_then_or8((volatile kmp_int8 *)(p), (kmp_int8)(v))
624 #define KMP_TEST_THEN_AND8(p, v) \
625  __kmp_test_then_and8((volatile kmp_int8 *)(p), (kmp_int8)(v))
626 #define KMP_TEST_THEN_OR32(p, v) \
627  __kmp_test_then_or32((volatile kmp_uint32 *)(p), (kmp_uint32)(v))
628 #define KMP_TEST_THEN_AND32(p, v) \
629  __kmp_test_then_and32((volatile kmp_uint32 *)(p), (kmp_uint32)(v))
630 #define KMP_TEST_THEN_OR64(p, v) \
631  __kmp_test_then_or64((volatile kmp_uint64 *)(p), (kmp_uint64)(v))
632 #define KMP_TEST_THEN_AND64(p, v) \
633  __kmp_test_then_and64((volatile kmp_uint64 *)(p), (kmp_uint64)(v))
634 
635 #define KMP_COMPARE_AND_STORE_ACQ8(p, cv, sv) \
636  __kmp_compare_and_store8((volatile kmp_int8 *)(p), (kmp_int8)(cv), \
637  (kmp_int8)(sv))
638 #define KMP_COMPARE_AND_STORE_REL8(p, cv, sv) \
639  __kmp_compare_and_store8((volatile kmp_int8 *)(p), (kmp_int8)(cv), \
640  (kmp_int8)(sv))
641 #define KMP_COMPARE_AND_STORE_ACQ16(p, cv, sv) \
642  __kmp_compare_and_store16((volatile kmp_int16 *)(p), (kmp_int16)(cv), \
643  (kmp_int16)(sv))
644 #define KMP_COMPARE_AND_STORE_REL16(p, cv, sv) \
645  __kmp_compare_and_store16((volatile kmp_int16 *)(p), (kmp_int16)(cv), \
646  (kmp_int16)(sv))
647 #define KMP_COMPARE_AND_STORE_ACQ32(p, cv, sv) \
648  __kmp_compare_and_store32((volatile kmp_int32 *)(p), (kmp_int32)(cv), \
649  (kmp_int32)(sv))
650 #define KMP_COMPARE_AND_STORE_REL32(p, cv, sv) \
651  __kmp_compare_and_store32((volatile kmp_int32 *)(p), (kmp_int32)(cv), \
652  (kmp_int32)(sv))
653 #define KMP_COMPARE_AND_STORE_ACQ64(p, cv, sv) \
654  __kmp_compare_and_store64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
655  (kmp_int64)(sv))
656 #define KMP_COMPARE_AND_STORE_REL64(p, cv, sv) \
657  __kmp_compare_and_store64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
658  (kmp_int64)(sv))
659 
660 #if KMP_ARCH_X86
661 #define KMP_COMPARE_AND_STORE_PTR(p, cv, sv) \
662  __kmp_compare_and_store32((volatile kmp_int32 *)(p), (kmp_int32)(cv), \
663  (kmp_int32)(sv))
664 #else /* 64 bit pointers */
665 #define KMP_COMPARE_AND_STORE_PTR(p, cv, sv) \
666  __kmp_compare_and_store64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
667  (kmp_int64)(sv))
668 #endif /* KMP_ARCH_X86 */
669 
670 #define KMP_COMPARE_AND_STORE_RET8(p, cv, sv) \
671  __kmp_compare_and_store_ret8((p), (cv), (sv))
672 #define KMP_COMPARE_AND_STORE_RET16(p, cv, sv) \
673  __kmp_compare_and_store_ret16((p), (cv), (sv))
674 #define KMP_COMPARE_AND_STORE_RET32(p, cv, sv) \
675  __kmp_compare_and_store_ret32((volatile kmp_int32 *)(p), (kmp_int32)(cv), \
676  (kmp_int32)(sv))
677 #define KMP_COMPARE_AND_STORE_RET64(p, cv, sv) \
678  __kmp_compare_and_store_ret64((volatile kmp_int64 *)(p), (kmp_int64)(cv), \
679  (kmp_int64)(sv))
680 
681 #define KMP_XCHG_FIXED8(p, v) \
682  __kmp_xchg_fixed8((volatile kmp_int8 *)(p), (kmp_int8)(v));
683 #define KMP_XCHG_FIXED16(p, v) __kmp_xchg_fixed16((p), (v));
684 #define KMP_XCHG_FIXED32(p, v) __kmp_xchg_fixed32((p), (v));
685 #define KMP_XCHG_FIXED64(p, v) __kmp_xchg_fixed64((p), (v));
686 #define KMP_XCHG_REAL32(p, v) __kmp_xchg_real32((p), (v));
687 #define KMP_XCHG_REAL64(p, v) __kmp_xchg_real64((p), (v));
688 
689 #endif /* KMP_ASM_INTRINS */
690 
691 /* ------------- relaxed consistency memory model stuff ------------------ */
692 
693 #if KMP_OS_WINDOWS
694 #ifdef __ABSOFT_WIN
695 #define KMP_MB() asm("nop")
696 #define KMP_IMB() asm("nop")
697 #else
698 #define KMP_MB() /* _asm{ nop } */
699 #define KMP_IMB() /* _asm{ nop } */
700 #endif
701 #endif /* KMP_OS_WINDOWS */
702 
703 #if KMP_ARCH_PPC64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64 || KMP_ARCH_MIPS || \
704  KMP_ARCH_MIPS64
705 #define KMP_MB() __sync_synchronize()
706 #endif
707 
708 #ifndef KMP_MB
709 #define KMP_MB() /* nothing to do */
710 #endif
711 
712 #ifndef KMP_IMB
713 #define KMP_IMB() /* nothing to do */
714 #endif
715 
716 #ifndef KMP_ST_REL32
717 #define KMP_ST_REL32(A, D) (*(A) = (D))
718 #endif
719 
720 #ifndef KMP_ST_REL64
721 #define KMP_ST_REL64(A, D) (*(A) = (D))
722 #endif
723 
724 #ifndef KMP_LD_ACQ32
725 #define KMP_LD_ACQ32(A) (*(A))
726 #endif
727 
728 #ifndef KMP_LD_ACQ64
729 #define KMP_LD_ACQ64(A) (*(A))
730 #endif
731 
732 /* ------------------------------------------------------------------------ */
733 // FIXME - maybe this should this be
734 //
735 // #define TCR_4(a) (*(volatile kmp_int32 *)(&a))
736 // #define TCW_4(a,b) (a) = (*(volatile kmp_int32 *)&(b))
737 //
738 // #define TCR_8(a) (*(volatile kmp_int64 *)(a))
739 // #define TCW_8(a,b) (a) = (*(volatile kmp_int64 *)(&b))
740 //
741 // I'm fairly certain this is the correct thing to do, but I'm afraid
742 // of performance regressions.
743 
744 #define TCR_1(a) (a)
745 #define TCW_1(a, b) (a) = (b)
746 #define TCR_4(a) (a)
747 #define TCW_4(a, b) (a) = (b)
748 #define TCI_4(a) (++(a))
749 #define TCD_4(a) (--(a))
750 #define TCR_8(a) (a)
751 #define TCW_8(a, b) (a) = (b)
752 #define TCI_8(a) (++(a))
753 #define TCD_8(a) (--(a))
754 #define TCR_SYNC_4(a) (a)
755 #define TCW_SYNC_4(a, b) (a) = (b)
756 #define TCX_SYNC_4(a, b, c) \
757  KMP_COMPARE_AND_STORE_REL32((volatile kmp_int32 *)(volatile void *)&(a), \
758  (kmp_int32)(b), (kmp_int32)(c))
759 #define TCR_SYNC_8(a) (a)
760 #define TCW_SYNC_8(a, b) (a) = (b)
761 #define TCX_SYNC_8(a, b, c) \
762  KMP_COMPARE_AND_STORE_REL64((volatile kmp_int64 *)(volatile void *)&(a), \
763  (kmp_int64)(b), (kmp_int64)(c))
764 
765 #if KMP_ARCH_X86 || KMP_ARCH_MIPS
766 // What about ARM?
767 #define TCR_PTR(a) ((void *)TCR_4(a))
768 #define TCW_PTR(a, b) TCW_4((a), (b))
769 #define TCR_SYNC_PTR(a) ((void *)TCR_SYNC_4(a))
770 #define TCW_SYNC_PTR(a, b) TCW_SYNC_4((a), (b))
771 #define TCX_SYNC_PTR(a, b, c) ((void *)TCX_SYNC_4((a), (b), (c)))
772 
773 #else /* 64 bit pointers */
774 
775 #define TCR_PTR(a) ((void *)TCR_8(a))
776 #define TCW_PTR(a, b) TCW_8((a), (b))
777 #define TCR_SYNC_PTR(a) ((void *)TCR_SYNC_8(a))
778 #define TCW_SYNC_PTR(a, b) TCW_SYNC_8((a), (b))
779 #define TCX_SYNC_PTR(a, b, c) ((void *)TCX_SYNC_8((a), (b), (c)))
780 
781 #endif /* KMP_ARCH_X86 */
782 
783 /* If these FTN_{TRUE,FALSE} values change, may need to change several places
784  where they are used to check that language is Fortran, not C. */
785 
786 #ifndef FTN_TRUE
787 #define FTN_TRUE TRUE
788 #endif
789 
790 #ifndef FTN_FALSE
791 #define FTN_FALSE FALSE
792 #endif
793 
794 typedef void (*microtask_t)(int *gtid, int *npr, ...);
795 
796 #ifdef USE_VOLATILE_CAST
797 #define VOLATILE_CAST(x) (volatile x)
798 #else
799 #define VOLATILE_CAST(x) (x)
800 #endif
801 
802 #define KMP_WAIT_YIELD __kmp_wait_yield_4
803 #define KMP_WAIT_YIELD_PTR __kmp_wait_yield_4_ptr
804 #define KMP_EQ __kmp_eq_4
805 #define KMP_NEQ __kmp_neq_4
806 #define KMP_LT __kmp_lt_4
807 #define KMP_GE __kmp_ge_4
808 #define KMP_LE __kmp_le_4
809 
810 /* Workaround for Intel(R) 64 code gen bug when taking address of static array
811  * (Intel(R) 64 Tracker #138) */
812 #if (KMP_ARCH_X86_64 || KMP_ARCH_PPC64) && KMP_OS_LINUX
813 #define STATIC_EFI2_WORKAROUND
814 #else
815 #define STATIC_EFI2_WORKAROUND static
816 #endif
817 
818 // Support of BGET usage
819 #ifndef KMP_USE_BGET
820 #define KMP_USE_BGET 1
821 #endif
822 
823 
824 // Switches for OSS builds
825 #ifndef USE_SYSFS_INFO
826 #define USE_SYSFS_INFO 0
827 #endif
828 #ifndef USE_CMPXCHG_FIX
829 #define USE_CMPXCHG_FIX 1
830 #endif
831 
832 // Enable dynamic user lock
833 #if OMP_45_ENABLED
834 #define KMP_USE_DYNAMIC_LOCK 1
835 #endif
836 
837 // Enable TSX if dynamic user lock is turned on
838 #if KMP_USE_DYNAMIC_LOCK
839 // Visual studio can't handle the asm sections in this code
840 #define KMP_USE_TSX (KMP_ARCH_X86 || KMP_ARCH_X86_64) && !KMP_COMPILER_MSVC
841 #ifdef KMP_USE_ADAPTIVE_LOCKS
842 #undef KMP_USE_ADAPTIVE_LOCKS
843 #endif
844 #define KMP_USE_ADAPTIVE_LOCKS KMP_USE_TSX
845 #endif
846 
847 // Enable tick time conversion of ticks to seconds
848 #if KMP_STATS_ENABLED
849 #define KMP_HAVE_TICK_TIME \
850  (KMP_OS_LINUX && (KMP_MIC || KMP_ARCH_X86 || KMP_ARCH_X86_64))
851 #endif
852 
853 // Warning levels
854 enum kmp_warnings_level {
855  kmp_warnings_off = 0, /* No warnings */
856  kmp_warnings_low, /* Minimal warnings (default) */
857  kmp_warnings_explicit = 6, /* Explicitly set to ON - more warnings */
858  kmp_warnings_verbose /* reserved */
859 };
860 
861 #ifdef __cplusplus
862 } // extern "C"
863 #endif // __cplusplus
864 
865 #endif /* KMP_OS_H */
866 // Safe C API
867 #include "kmp_safe_c_api.h"