LLVM OpenMP* Runtime Library
kmp.h
1 
2 /*
3  * kmp.h -- KPTS runtime header file.
4  */
5 
6 //===----------------------------------------------------------------------===//
7 //
8 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
9 // See https://llvm.org/LICENSE.txt for license information.
10 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef KMP_H
15 #define KMP_H
16 
17 #include "kmp_config.h"
18 
19 /* #define BUILD_PARALLEL_ORDERED 1 */
20 
21 /* This fix replaces gettimeofday with clock_gettime for better scalability on
22  the Altix. Requires user code to be linked with -lrt. */
23 //#define FIX_SGI_CLOCK
24 
25 /* Defines for OpenMP 3.0 tasking and auto scheduling */
26 
27 #ifndef KMP_STATIC_STEAL_ENABLED
28 #define KMP_STATIC_STEAL_ENABLED 1
29 #endif
30 #define KMP_WEIGHTED_ITERATIONS_SUPPORTED \
31  (KMP_AFFINITY_SUPPORTED && KMP_STATIC_STEAL_ENABLED && \
32  (KMP_ARCH_X86 || KMP_ARCH_X86_64))
33 
34 #define TASK_CURRENT_NOT_QUEUED 0
35 #define TASK_CURRENT_QUEUED 1
36 
37 #define TASK_NOT_PUSHED 1
38 #define TASK_SUCCESSFULLY_PUSHED 0
39 #define TASK_TIED 1
40 #define TASK_UNTIED 0
41 #define TASK_EXPLICIT 1
42 #define TASK_IMPLICIT 0
43 #define TASK_PROXY 1
44 #define TASK_FULL 0
45 #define TASK_DETACHABLE 1
46 #define TASK_UNDETACHABLE 0
47 
48 #define KMP_THREAD_ATTR
49 
50 #if !KMP_OS_WASI
51 #include <signal.h>
52 #endif
53 #include <stdarg.h>
54 #include <stddef.h>
55 #include <stdio.h>
56 #include <stdlib.h>
57 #include <string.h>
58 #include <limits>
59 #include <type_traits>
60 /* include <ctype.h> don't use; problems with /MD on Windows* OS NT due to bad
61  Microsoft library. Some macros provided below to replace these functions */
62 #ifndef __ABSOFT_WIN
63 #include <sys/types.h>
64 #endif
65 #include <limits.h>
66 #include <time.h>
67 
68 #include <errno.h>
69 
70 #include "kmp_os.h"
71 
72 #include "kmp_safe_c_api.h"
73 
74 #if KMP_STATS_ENABLED
75 class kmp_stats_list;
76 #endif
77 
78 #if KMP_USE_HIER_SCHED
79 // Only include hierarchical scheduling if affinity is supported
80 #undef KMP_USE_HIER_SCHED
81 #define KMP_USE_HIER_SCHED KMP_AFFINITY_SUPPORTED
82 #endif
83 
84 // OMPD_SKIP_HWLOC used in libompd/omp-icv.cpp to avoid OMPD depending on hwloc
85 #if KMP_USE_HWLOC && KMP_AFFINITY_SUPPORTED && !defined(OMPD_SKIP_HWLOC)
86 #include "hwloc.h"
87 #define KMP_HWLOC_ENABLED 1
88 #ifndef HWLOC_OBJ_NUMANODE
89 #define HWLOC_OBJ_NUMANODE HWLOC_OBJ_NODE
90 #endif
91 #ifndef HWLOC_OBJ_PACKAGE
92 #define HWLOC_OBJ_PACKAGE HWLOC_OBJ_SOCKET
93 #endif
94 #else
95 #define KMP_HWLOC_ENABLED 0
96 #endif
97 
98 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
99 #include <xmmintrin.h>
100 #endif
101 
102 // The below has to be defined before including "kmp_barrier.h".
103 #define KMP_INTERNAL_MALLOC(sz) malloc(sz)
104 #define KMP_INTERNAL_FREE(p) free(p)
105 #define KMP_INTERNAL_REALLOC(p, sz) realloc((p), (sz))
106 #define KMP_INTERNAL_CALLOC(n, sz) calloc((n), (sz))
107 
108 #include "kmp_debug.h"
109 #include "kmp_lock.h"
110 #include "kmp_version.h"
111 #include "kmp_barrier.h"
112 #if USE_DEBUGGER
113 #include "kmp_debugger.h"
114 #endif
115 #include "kmp_i18n.h"
116 
117 #define KMP_HANDLE_SIGNALS ((KMP_OS_UNIX && !KMP_OS_WASI) || KMP_OS_WINDOWS)
118 
119 #include "kmp_wrapper_malloc.h"
120 #if KMP_OS_UNIX
121 #include <unistd.h>
122 #if !defined NSIG && defined _NSIG
123 #define NSIG _NSIG
124 #endif
125 #endif
126 
127 #if KMP_OS_LINUX
128 #pragma weak clock_gettime
129 #endif
130 
131 #if OMPT_SUPPORT
132 #include "ompt-internal.h"
133 #endif
134 
135 #if OMPD_SUPPORT
136 #include "ompd-specific.h"
137 #endif
138 
139 #ifndef UNLIKELY
140 #define UNLIKELY(x) (x)
141 #endif
142 
143 // Affinity format function
144 #include "kmp_str.h"
145 
146 // 0 - no fast memory allocation, alignment: 8-byte on x86, 16-byte on x64.
147 // 3 - fast allocation using sync, non-sync free lists of any size, non-self
148 // free lists of limited size.
149 #ifndef USE_FAST_MEMORY
150 #define USE_FAST_MEMORY 3
151 #endif
152 
153 // Assume using BGET compare_exchange instruction instead of lock by default.
154 #ifndef USE_CMP_XCHG_FOR_BGET
155 #define USE_CMP_XCHG_FOR_BGET 1
156 #endif
157 
158 // Test to see if queuing lock is better than bootstrap lock for bget
159 // #ifndef USE_QUEUING_LOCK_FOR_BGET
160 // #define USE_QUEUING_LOCK_FOR_BGET
161 // #endif
162 
163 #define KMP_NSEC_PER_SEC 1000000000L
164 #define KMP_USEC_PER_SEC 1000000L
165 #define KMP_NSEC_PER_USEC 1000L
166 
175 enum {
180  /* 0x04 is no longer used */
189  KMP_IDENT_BARRIER_IMPL_MASK = 0x01C0,
190  KMP_IDENT_BARRIER_IMPL_FOR = 0x0040,
191  KMP_IDENT_BARRIER_IMPL_SECTIONS = 0x00C0,
192 
193  KMP_IDENT_BARRIER_IMPL_SINGLE = 0x0140,
194  KMP_IDENT_BARRIER_IMPL_WORKSHARE = 0x01C0,
195 
207  KMP_IDENT_ATOMIC_HINT_UNCONTENDED = 0x010000,
208  KMP_IDENT_ATOMIC_HINT_CONTENDED = 0x020000,
209  KMP_IDENT_ATOMIC_HINT_NONSPECULATIVE = 0x040000,
210  KMP_IDENT_ATOMIC_HINT_SPECULATIVE = 0x080000,
211  KMP_IDENT_OPENMP_SPEC_VERSION_MASK = 0xFF000000
212 };
213 
217 typedef struct ident {
218  kmp_int32 reserved_1;
219  kmp_int32 flags;
221  kmp_int32 reserved_2;
222 #if USE_ITT_BUILD
223 /* but currently used for storing region-specific ITT */
224 /* contextual information. */
225 #endif /* USE_ITT_BUILD */
226  kmp_int32 reserved_3;
227  char const *psource;
231  // Returns the OpenMP version in form major*10+minor (e.g., 50 for 5.0)
232  kmp_int32 get_openmp_version() {
233  return (((flags & KMP_IDENT_OPENMP_SPEC_VERSION_MASK) >> 24) & 0xFF);
234  }
240 // Some forward declarations.
241 typedef union kmp_team kmp_team_t;
242 typedef struct kmp_taskdata kmp_taskdata_t;
243 typedef union kmp_task_team kmp_task_team_t;
244 typedef union kmp_team kmp_team_p;
245 typedef union kmp_info kmp_info_p;
246 typedef union kmp_root kmp_root_p;
247 
248 template <bool C = false, bool S = true> class kmp_flag_32;
249 template <bool C = false, bool S = true> class kmp_flag_64;
250 template <bool C = false, bool S = true> class kmp_atomic_flag_64;
251 class kmp_flag_oncore;
252 
253 #ifdef __cplusplus
254 extern "C" {
255 #endif
256 
257 /* ------------------------------------------------------------------------ */
258 
259 /* Pack two 32-bit signed integers into a 64-bit signed integer */
260 /* ToDo: Fix word ordering for big-endian machines. */
261 #define KMP_PACK_64(HIGH_32, LOW_32) \
262  ((kmp_int64)((((kmp_uint64)(HIGH_32)) << 32) | (kmp_uint64)(LOW_32)))
263 
264 // Generic string manipulation macros. Assume that _x is of type char *
265 #define SKIP_WS(_x) \
266  { \
267  while (*(_x) == ' ' || *(_x) == '\t') \
268  (_x)++; \
269  }
270 #define SKIP_DIGITS(_x) \
271  { \
272  while (*(_x) >= '0' && *(_x) <= '9') \
273  (_x)++; \
274  }
275 #define SKIP_TOKEN(_x) \
276  { \
277  while ((*(_x) >= '0' && *(_x) <= '9') || (*(_x) >= 'a' && *(_x) <= 'z') || \
278  (*(_x) >= 'A' && *(_x) <= 'Z') || *(_x) == '_') \
279  (_x)++; \
280  }
281 #define SKIP_TO(_x, _c) \
282  { \
283  while (*(_x) != '\0' && *(_x) != (_c)) \
284  (_x)++; \
285  }
286 
287 /* ------------------------------------------------------------------------ */
288 
289 #define KMP_MAX(x, y) ((x) > (y) ? (x) : (y))
290 #define KMP_MIN(x, y) ((x) < (y) ? (x) : (y))
291 
292 /* ------------------------------------------------------------------------ */
293 /* Enumeration types */
294 
295 enum kmp_state_timer {
296  ts_stop,
297  ts_start,
298  ts_pause,
299 
300  ts_last_state
301 };
302 
303 enum dynamic_mode {
304  dynamic_default,
305 #ifdef USE_LOAD_BALANCE
306  dynamic_load_balance,
307 #endif /* USE_LOAD_BALANCE */
308  dynamic_random,
309  dynamic_thread_limit,
310  dynamic_max
311 };
312 
313 /* external schedule constants, duplicate enum omp_sched in omp.h in order to
314  * not include it here */
315 #ifndef KMP_SCHED_TYPE_DEFINED
316 #define KMP_SCHED_TYPE_DEFINED
317 typedef enum kmp_sched {
318  kmp_sched_lower = 0, // lower and upper bounds are for routine parameter check
319  // Note: need to adjust __kmp_sch_map global array in case enum is changed
320  kmp_sched_static = 1, // mapped to kmp_sch_static_chunked (33)
321  kmp_sched_dynamic = 2, // mapped to kmp_sch_dynamic_chunked (35)
322  kmp_sched_guided = 3, // mapped to kmp_sch_guided_chunked (36)
323  kmp_sched_auto = 4, // mapped to kmp_sch_auto (38)
324  kmp_sched_upper_std = 5, // upper bound for standard schedules
325  kmp_sched_lower_ext = 100, // lower bound of Intel extension schedules
326  kmp_sched_trapezoidal = 101, // mapped to kmp_sch_trapezoidal (39)
327 #if KMP_STATIC_STEAL_ENABLED
328  kmp_sched_static_steal = 102, // mapped to kmp_sch_static_steal (44)
329 #endif
330  kmp_sched_upper,
331  kmp_sched_default = kmp_sched_static, // default scheduling
332  kmp_sched_monotonic = 0x80000000
333 } kmp_sched_t;
334 #endif
335 
340 enum sched_type : kmp_int32 {
342  kmp_sch_static_chunked = 33,
344  kmp_sch_dynamic_chunked = 35,
346  kmp_sch_runtime = 37,
348  kmp_sch_trapezoidal = 39,
349 
350  /* accessible only through KMP_SCHEDULE environment variable */
351  kmp_sch_static_greedy = 40,
352  kmp_sch_static_balanced = 41,
353  /* accessible only through KMP_SCHEDULE environment variable */
354  kmp_sch_guided_iterative_chunked = 42,
355  kmp_sch_guided_analytical_chunked = 43,
356  /* accessible only through KMP_SCHEDULE environment variable */
357  kmp_sch_static_steal = 44,
358 
359  /* static with chunk adjustment (e.g., simd) */
360  kmp_sch_static_balanced_chunked = 45,
364  /* accessible only through KMP_SCHEDULE environment variable */
368  kmp_ord_static_chunked = 65,
370  kmp_ord_dynamic_chunked = 67,
371  kmp_ord_guided_chunked = 68,
372  kmp_ord_runtime = 69,
374  kmp_ord_trapezoidal = 71,
377  /* Schedules for Distribute construct */
381  /* For the "nomerge" versions, kmp_dispatch_next*() will always return a
382  single iteration/chunk, even if the loop is serialized. For the schedule
383  types listed above, the entire iteration vector is returned if the loop is
384  serialized. This doesn't work for gcc/gcomp sections. */
385  kmp_nm_lower = 160,
387  kmp_nm_static_chunked =
388  (kmp_sch_static_chunked - kmp_sch_lower + kmp_nm_lower),
390  kmp_nm_dynamic_chunked = 163,
392  kmp_nm_runtime = 165,
393  kmp_nm_auto = 166,
394  kmp_nm_trapezoidal = 167,
395 
396  /* accessible only through KMP_SCHEDULE environment variable */
397  kmp_nm_static_greedy = 168,
398  kmp_nm_static_balanced = 169,
399  /* accessible only through KMP_SCHEDULE environment variable */
400  kmp_nm_guided_iterative_chunked = 170,
401  kmp_nm_guided_analytical_chunked = 171,
402  kmp_nm_static_steal =
403  172, /* accessible only through OMP_SCHEDULE environment variable */
404 
405  kmp_nm_ord_static_chunked = 193,
407  kmp_nm_ord_dynamic_chunked = 195,
408  kmp_nm_ord_guided_chunked = 196,
409  kmp_nm_ord_runtime = 197,
411  kmp_nm_ord_trapezoidal = 199,
414  /* Support for OpenMP 4.5 monotonic and nonmonotonic schedule modifiers. Since
415  we need to distinguish the three possible cases (no modifier, monotonic
416  modifier, nonmonotonic modifier), we need separate bits for each modifier.
417  The absence of monotonic does not imply nonmonotonic, especially since 4.5
418  says that the behaviour of the "no modifier" case is implementation defined
419  in 4.5, but will become "nonmonotonic" in 5.0.
420 
421  Since we're passing a full 32 bit value, we can use a couple of high bits
422  for these flags; out of paranoia we avoid the sign bit.
423 
424  These modifiers can be or-ed into non-static schedules by the compiler to
425  pass the additional information. They will be stripped early in the
426  processing in __kmp_dispatch_init when setting up schedules, so most of the
427  code won't ever see schedules with these bits set. */
429  (1 << 29),
431  (1 << 30),
433 #define SCHEDULE_WITHOUT_MODIFIERS(s) \
434  (enum sched_type)( \
436 #define SCHEDULE_HAS_MONOTONIC(s) (((s)&kmp_sch_modifier_monotonic) != 0)
437 #define SCHEDULE_HAS_NONMONOTONIC(s) (((s)&kmp_sch_modifier_nonmonotonic) != 0)
438 #define SCHEDULE_HAS_NO_MODIFIERS(s) \
439  (((s) & (kmp_sch_modifier_nonmonotonic | kmp_sch_modifier_monotonic)) == 0)
440 #define SCHEDULE_GET_MODIFIERS(s) \
441  ((enum sched_type)( \
442  (s) & (kmp_sch_modifier_nonmonotonic | kmp_sch_modifier_monotonic)))
443 #define SCHEDULE_SET_MODIFIERS(s, m) \
444  (s = (enum sched_type)((kmp_int32)s | (kmp_int32)m))
445 #define SCHEDULE_NONMONOTONIC 0
446 #define SCHEDULE_MONOTONIC 1
447 
449 };
450 
451 // Apply modifiers on internal kind to standard kind
452 static inline void
453 __kmp_sched_apply_mods_stdkind(kmp_sched_t *kind,
454  enum sched_type internal_kind) {
455  if (SCHEDULE_HAS_MONOTONIC(internal_kind)) {
456  *kind = (kmp_sched_t)((int)*kind | (int)kmp_sched_monotonic);
457  }
458 }
459 
460 // Apply modifiers on standard kind to internal kind
461 static inline void
462 __kmp_sched_apply_mods_intkind(kmp_sched_t kind,
463  enum sched_type *internal_kind) {
464  if ((int)kind & (int)kmp_sched_monotonic) {
465  *internal_kind = (enum sched_type)((int)*internal_kind |
467  }
468 }
469 
470 // Get standard schedule without modifiers
471 static inline kmp_sched_t __kmp_sched_without_mods(kmp_sched_t kind) {
472  return (kmp_sched_t)((int)kind & ~((int)kmp_sched_monotonic));
473 }
474 
475 /* Type to keep runtime schedule set via OMP_SCHEDULE or omp_set_schedule() */
476 typedef union kmp_r_sched {
477  struct {
478  enum sched_type r_sched_type;
479  int chunk;
480  };
481  kmp_int64 sched;
482 } kmp_r_sched_t;
483 
484 extern enum sched_type __kmp_sch_map[]; // map OMP 3.0 schedule types with our
485 // internal schedule types
486 
487 enum library_type {
488  library_none,
489  library_serial,
490  library_turnaround,
491  library_throughput
492 };
493 
494 #if KMP_MIC_SUPPORTED
495 enum mic_type { non_mic, mic1, mic2, mic3, dummy };
496 #endif
497 
498 // OpenMP 3.1 - Nested num threads array
499 typedef struct kmp_nested_nthreads_t {
500  int *nth;
501  int size;
502  int used;
503 } kmp_nested_nthreads_t;
504 
505 extern kmp_nested_nthreads_t __kmp_nested_nth;
506 
507 /* -- fast reduction stuff ------------------------------------------------ */
508 
509 #undef KMP_FAST_REDUCTION_BARRIER
510 #define KMP_FAST_REDUCTION_BARRIER 1
511 
512 #undef KMP_FAST_REDUCTION_CORE_DUO
513 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
514 #define KMP_FAST_REDUCTION_CORE_DUO 1
515 #endif
516 
517 enum _reduction_method {
518  reduction_method_not_defined = 0,
519  critical_reduce_block = (1 << 8),
520  atomic_reduce_block = (2 << 8),
521  tree_reduce_block = (3 << 8),
522  empty_reduce_block = (4 << 8)
523 };
524 
525 // Description of the packed_reduction_method variable:
526 // The packed_reduction_method variable consists of two enum types variables
527 // that are packed together into 0-th byte and 1-st byte:
528 // 0: (packed_reduction_method & 0x000000FF) is a 'enum barrier_type' value of
529 // barrier that will be used in fast reduction: bs_plain_barrier or
530 // bs_reduction_barrier
531 // 1: (packed_reduction_method & 0x0000FF00) is a reduction method that will
532 // be used in fast reduction;
533 // Reduction method is of 'enum _reduction_method' type and it's defined the way
534 // so that the bits of 0-th byte are empty, so no need to execute a shift
535 // instruction while packing/unpacking
536 
537 #if KMP_FAST_REDUCTION_BARRIER
538 #define PACK_REDUCTION_METHOD_AND_BARRIER(reduction_method, barrier_type) \
539  ((reduction_method) | (barrier_type))
540 
541 #define UNPACK_REDUCTION_METHOD(packed_reduction_method) \
542  ((enum _reduction_method)((packed_reduction_method) & (0x0000FF00)))
543 
544 #define UNPACK_REDUCTION_BARRIER(packed_reduction_method) \
545  ((enum barrier_type)((packed_reduction_method) & (0x000000FF)))
546 #else
547 #define PACK_REDUCTION_METHOD_AND_BARRIER(reduction_method, barrier_type) \
548  (reduction_method)
549 
550 #define UNPACK_REDUCTION_METHOD(packed_reduction_method) \
551  (packed_reduction_method)
552 
553 #define UNPACK_REDUCTION_BARRIER(packed_reduction_method) (bs_plain_barrier)
554 #endif
555 
556 #define TEST_REDUCTION_METHOD(packed_reduction_method, which_reduction_block) \
557  ((UNPACK_REDUCTION_METHOD(packed_reduction_method)) == \
558  (which_reduction_block))
559 
560 #if KMP_FAST_REDUCTION_BARRIER
561 #define TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER \
562  (PACK_REDUCTION_METHOD_AND_BARRIER(tree_reduce_block, bs_reduction_barrier))
563 
564 #define TREE_REDUCE_BLOCK_WITH_PLAIN_BARRIER \
565  (PACK_REDUCTION_METHOD_AND_BARRIER(tree_reduce_block, bs_plain_barrier))
566 #endif
567 
568 typedef int PACKED_REDUCTION_METHOD_T;
569 
570 /* -- end of fast reduction stuff ----------------------------------------- */
571 
572 #if KMP_OS_WINDOWS
573 #define USE_CBLKDATA
574 #if KMP_MSVC_COMPAT
575 #pragma warning(push)
576 #pragma warning(disable : 271 310)
577 #endif
578 #include <windows.h>
579 #if KMP_MSVC_COMPAT
580 #pragma warning(pop)
581 #endif
582 #endif
583 
584 #if KMP_OS_UNIX
585 #if !KMP_OS_WASI
586 #include <dlfcn.h>
587 #endif
588 #include <pthread.h>
589 #endif
590 
591 enum kmp_hw_t : int {
592  KMP_HW_UNKNOWN = -1,
593  KMP_HW_SOCKET = 0,
594  KMP_HW_PROC_GROUP,
595  KMP_HW_NUMA,
596  KMP_HW_DIE,
597  KMP_HW_LLC,
598  KMP_HW_L3,
599  KMP_HW_TILE,
600  KMP_HW_MODULE,
601  KMP_HW_L2,
602  KMP_HW_L1,
603  KMP_HW_CORE,
604  KMP_HW_THREAD,
605  KMP_HW_LAST
606 };
607 
608 typedef enum kmp_hw_core_type_t {
609  KMP_HW_CORE_TYPE_UNKNOWN = 0x0,
610 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
611  KMP_HW_CORE_TYPE_ATOM = 0x20,
612  KMP_HW_CORE_TYPE_CORE = 0x40,
613  KMP_HW_MAX_NUM_CORE_TYPES = 3,
614 #else
615  KMP_HW_MAX_NUM_CORE_TYPES = 1,
616 #endif
617 } kmp_hw_core_type_t;
618 
619 #define KMP_HW_MAX_NUM_CORE_EFFS 8
620 
621 #define KMP_DEBUG_ASSERT_VALID_HW_TYPE(type) \
622  KMP_DEBUG_ASSERT(type >= (kmp_hw_t)0 && type < KMP_HW_LAST)
623 #define KMP_ASSERT_VALID_HW_TYPE(type) \
624  KMP_ASSERT(type >= (kmp_hw_t)0 && type < KMP_HW_LAST)
625 
626 #define KMP_FOREACH_HW_TYPE(type) \
627  for (kmp_hw_t type = (kmp_hw_t)0; type < KMP_HW_LAST; \
628  type = (kmp_hw_t)((int)type + 1))
629 
630 const char *__kmp_hw_get_keyword(kmp_hw_t type, bool plural = false);
631 const char *__kmp_hw_get_catalog_string(kmp_hw_t type, bool plural = false);
632 const char *__kmp_hw_get_core_type_string(kmp_hw_core_type_t type);
633 
634 /* Only Linux* OS and Windows* OS support thread affinity. */
635 #if KMP_AFFINITY_SUPPORTED
636 
637 // GROUP_AFFINITY is already defined for _MSC_VER>=1600 (VS2010 and later).
638 #if KMP_OS_WINDOWS
639 #if _MSC_VER < 1600 && KMP_MSVC_COMPAT
640 typedef struct GROUP_AFFINITY {
641  KAFFINITY Mask;
642  WORD Group;
643  WORD Reserved[3];
644 } GROUP_AFFINITY;
645 #endif /* _MSC_VER < 1600 */
646 #if KMP_GROUP_AFFINITY
647 extern int __kmp_num_proc_groups;
648 #else
649 static const int __kmp_num_proc_groups = 1;
650 #endif /* KMP_GROUP_AFFINITY */
651 typedef DWORD (*kmp_GetActiveProcessorCount_t)(WORD);
652 extern kmp_GetActiveProcessorCount_t __kmp_GetActiveProcessorCount;
653 
654 typedef WORD (*kmp_GetActiveProcessorGroupCount_t)(void);
655 extern kmp_GetActiveProcessorGroupCount_t __kmp_GetActiveProcessorGroupCount;
656 
657 typedef BOOL (*kmp_GetThreadGroupAffinity_t)(HANDLE, GROUP_AFFINITY *);
658 extern kmp_GetThreadGroupAffinity_t __kmp_GetThreadGroupAffinity;
659 
660 typedef BOOL (*kmp_SetThreadGroupAffinity_t)(HANDLE, const GROUP_AFFINITY *,
661  GROUP_AFFINITY *);
662 extern kmp_SetThreadGroupAffinity_t __kmp_SetThreadGroupAffinity;
663 #endif /* KMP_OS_WINDOWS */
664 
665 #if KMP_HWLOC_ENABLED
666 extern hwloc_topology_t __kmp_hwloc_topology;
667 extern int __kmp_hwloc_error;
668 #endif // KMP_HWLOC_ENABLED
669 
670 extern size_t __kmp_affin_mask_size;
671 #define KMP_AFFINITY_CAPABLE() (__kmp_affin_mask_size > 0)
672 #define KMP_AFFINITY_DISABLE() (__kmp_affin_mask_size = 0)
673 #define KMP_AFFINITY_ENABLE(mask_size) (__kmp_affin_mask_size = mask_size)
674 #define KMP_CPU_SET_ITERATE(i, mask) \
675  for (i = (mask)->begin(); (int)i != (mask)->end(); i = (mask)->next(i))
676 #define KMP_CPU_SET(i, mask) (mask)->set(i)
677 #define KMP_CPU_ISSET(i, mask) (mask)->is_set(i)
678 #define KMP_CPU_CLR(i, mask) (mask)->clear(i)
679 #define KMP_CPU_ZERO(mask) (mask)->zero()
680 #define KMP_CPU_ISEMPTY(mask) (mask)->empty()
681 #define KMP_CPU_COPY(dest, src) (dest)->copy(src)
682 #define KMP_CPU_AND(dest, src) (dest)->bitwise_and(src)
683 #define KMP_CPU_COMPLEMENT(max_bit_number, mask) (mask)->bitwise_not()
684 #define KMP_CPU_UNION(dest, src) (dest)->bitwise_or(src)
685 #define KMP_CPU_EQUAL(dest, src) (dest)->is_equal(src)
686 #define KMP_CPU_ALLOC(ptr) (ptr = __kmp_affinity_dispatch->allocate_mask())
687 #define KMP_CPU_FREE(ptr) __kmp_affinity_dispatch->deallocate_mask(ptr)
688 #define KMP_CPU_ALLOC_ON_STACK(ptr) KMP_CPU_ALLOC(ptr)
689 #define KMP_CPU_FREE_FROM_STACK(ptr) KMP_CPU_FREE(ptr)
690 #define KMP_CPU_INTERNAL_ALLOC(ptr) KMP_CPU_ALLOC(ptr)
691 #define KMP_CPU_INTERNAL_FREE(ptr) KMP_CPU_FREE(ptr)
692 #define KMP_CPU_INDEX(arr, i) __kmp_affinity_dispatch->index_mask_array(arr, i)
693 #define KMP_CPU_ALLOC_ARRAY(arr, n) \
694  (arr = __kmp_affinity_dispatch->allocate_mask_array(n))
695 #define KMP_CPU_FREE_ARRAY(arr, n) \
696  __kmp_affinity_dispatch->deallocate_mask_array(arr)
697 #define KMP_CPU_INTERNAL_ALLOC_ARRAY(arr, n) KMP_CPU_ALLOC_ARRAY(arr, n)
698 #define KMP_CPU_INTERNAL_FREE_ARRAY(arr, n) KMP_CPU_FREE_ARRAY(arr, n)
699 #define __kmp_get_system_affinity(mask, abort_bool) \
700  (mask)->get_system_affinity(abort_bool)
701 #define __kmp_set_system_affinity(mask, abort_bool) \
702  (mask)->set_system_affinity(abort_bool)
703 #define __kmp_get_proc_group(mask) (mask)->get_proc_group()
704 
705 class KMPAffinity {
706 public:
707  class Mask {
708  public:
709  void *operator new(size_t n);
710  void operator delete(void *p);
711  void *operator new[](size_t n);
712  void operator delete[](void *p);
713  virtual ~Mask() {}
714  // Set bit i to 1
715  virtual void set(int i) {}
716  // Return bit i
717  virtual bool is_set(int i) const { return false; }
718  // Set bit i to 0
719  virtual void clear(int i) {}
720  // Zero out entire mask
721  virtual void zero() {}
722  // Check whether mask is empty
723  virtual bool empty() const { return true; }
724  // Copy src into this mask
725  virtual void copy(const Mask *src) {}
726  // this &= rhs
727  virtual void bitwise_and(const Mask *rhs) {}
728  // this |= rhs
729  virtual void bitwise_or(const Mask *rhs) {}
730  // this = ~this
731  virtual void bitwise_not() {}
732  // this == rhs
733  virtual bool is_equal(const Mask *rhs) const { return false; }
734  // API for iterating over an affinity mask
735  // for (int i = mask->begin(); i != mask->end(); i = mask->next(i))
736  virtual int begin() const { return 0; }
737  virtual int end() const { return 0; }
738  virtual int next(int previous) const { return 0; }
739 #if KMP_OS_WINDOWS
740  virtual int set_process_affinity(bool abort_on_error) const { return -1; }
741 #endif
742  // Set the system's affinity to this affinity mask's value
743  virtual int set_system_affinity(bool abort_on_error) const { return -1; }
744  // Set this affinity mask to the current system affinity
745  virtual int get_system_affinity(bool abort_on_error) { return -1; }
746  // Only 1 DWORD in the mask should have any procs set.
747  // Return the appropriate index, or -1 for an invalid mask.
748  virtual int get_proc_group() const { return -1; }
749  int get_max_cpu() const {
750  int cpu;
751  int max_cpu = -1;
752  KMP_CPU_SET_ITERATE(cpu, this) {
753  if (cpu > max_cpu)
754  max_cpu = cpu;
755  }
756  return max_cpu;
757  }
758  };
759  void *operator new(size_t n);
760  void operator delete(void *p);
761  // Need virtual destructor
762  virtual ~KMPAffinity() = default;
763  // Determine if affinity is capable
764  virtual void determine_capable(const char *env_var) {}
765  // Bind the current thread to os proc
766  virtual void bind_thread(int proc) {}
767  // Factory functions to allocate/deallocate a mask
768  virtual Mask *allocate_mask() { return nullptr; }
769  virtual void deallocate_mask(Mask *m) {}
770  virtual Mask *allocate_mask_array(int num) { return nullptr; }
771  virtual void deallocate_mask_array(Mask *m) {}
772  virtual Mask *index_mask_array(Mask *m, int index) { return nullptr; }
773  static void pick_api();
774  static void destroy_api();
775  enum api_type {
776  NATIVE_OS
777 #if KMP_HWLOC_ENABLED
778  ,
779  HWLOC
780 #endif // KMP_HWLOC_ENABLED
781  };
782  virtual api_type get_api_type() const {
783  KMP_ASSERT(0);
784  return NATIVE_OS;
785  }
786 
787 private:
788  static bool picked_api;
789 };
790 
791 typedef KMPAffinity::Mask kmp_affin_mask_t;
792 extern KMPAffinity *__kmp_affinity_dispatch;
793 
794 #if !KMP_OS_AIX
795 class kmp_affinity_raii_t {
796  kmp_affin_mask_t *mask;
797  bool restored;
798 
799 public:
800  kmp_affinity_raii_t(const kmp_affin_mask_t *new_mask = nullptr)
801  : mask(nullptr), restored(false) {
802  if (KMP_AFFINITY_CAPABLE()) {
803  KMP_CPU_ALLOC(mask);
804  KMP_ASSERT(mask != NULL);
805  __kmp_get_system_affinity(mask, /*abort_on_error=*/true);
806  if (new_mask)
807  __kmp_set_system_affinity(new_mask, /*abort_on_error=*/true);
808  }
809  }
810  void restore() {
811  if (mask && KMP_AFFINITY_CAPABLE() && !restored) {
812  __kmp_set_system_affinity(mask, /*abort_on_error=*/true);
813  KMP_CPU_FREE(mask);
814  }
815  restored = true;
816  }
817  ~kmp_affinity_raii_t() { restore(); }
818 };
819 #endif // !KMP_OS_AIX
820 
821 // Declare local char buffers with this size for printing debug and info
822 // messages, using __kmp_affinity_print_mask().
823 #define KMP_AFFIN_MASK_PRINT_LEN 1024
824 
825 enum affinity_type {
826  affinity_none = 0,
827  affinity_physical,
828  affinity_logical,
829  affinity_compact,
830  affinity_scatter,
831  affinity_explicit,
832  affinity_balanced,
833  affinity_disabled, // not used outsize the env var parser
834  affinity_default
835 };
836 
837 enum affinity_top_method {
838  affinity_top_method_all = 0, // try all (supported) methods, in order
839 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
840  affinity_top_method_apicid,
841  affinity_top_method_x2apicid,
842  affinity_top_method_x2apicid_1f,
843 #endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
844  affinity_top_method_cpuinfo, // KMP_CPUINFO_FILE is usable on Windows* OS, too
845 #if KMP_GROUP_AFFINITY
846  affinity_top_method_group,
847 #endif /* KMP_GROUP_AFFINITY */
848  affinity_top_method_flat,
849 #if KMP_HWLOC_ENABLED
850  affinity_top_method_hwloc,
851 #endif // KMP_HWLOC_ENABLED
852  affinity_top_method_default
853 };
854 
855 #define affinity_respect_mask_default (2)
856 
857 typedef struct kmp_affinity_flags_t {
858  unsigned dups : 1;
859  unsigned verbose : 1;
860  unsigned warnings : 1;
861  unsigned respect : 2;
862  unsigned reset : 1;
863  unsigned initialized : 1;
864  unsigned core_types_gran : 1;
865  unsigned core_effs_gran : 1;
866  unsigned omp_places : 1;
867  unsigned reserved : 22;
868 } kmp_affinity_flags_t;
869 KMP_BUILD_ASSERT(sizeof(kmp_affinity_flags_t) == 4);
870 
871 typedef struct kmp_affinity_ids_t {
872  int os_id;
873  int ids[KMP_HW_LAST];
874 } kmp_affinity_ids_t;
875 
876 typedef struct kmp_affinity_attrs_t {
877  int core_type : 8;
878  int core_eff : 8;
879  unsigned valid : 1;
880  unsigned reserved : 15;
881 } kmp_affinity_attrs_t;
882 #define KMP_AFFINITY_ATTRS_UNKNOWN \
883  { KMP_HW_CORE_TYPE_UNKNOWN, kmp_hw_attr_t::UNKNOWN_CORE_EFF, 0, 0 }
884 
885 typedef struct kmp_affinity_t {
886  char *proclist;
887  enum affinity_type type;
888  kmp_hw_t gran;
889  int gran_levels;
890  kmp_affinity_attrs_t core_attr_gran;
891  int compact;
892  int offset;
893  kmp_affinity_flags_t flags;
894  unsigned num_masks;
895  kmp_affin_mask_t *masks;
896  kmp_affinity_ids_t *ids;
897  kmp_affinity_attrs_t *attrs;
898  unsigned num_os_id_masks;
899  kmp_affin_mask_t *os_id_masks;
900  const char *env_var;
901 } kmp_affinity_t;
902 
903 #define KMP_AFFINITY_INIT(env) \
904  { \
905  nullptr, affinity_default, KMP_HW_UNKNOWN, -1, KMP_AFFINITY_ATTRS_UNKNOWN, \
906  0, 0, \
907  {TRUE, FALSE, TRUE, affinity_respect_mask_default, FALSE, FALSE, \
908  FALSE, FALSE, FALSE}, \
909  0, nullptr, nullptr, nullptr, 0, nullptr, env \
910  }
911 
912 extern enum affinity_top_method __kmp_affinity_top_method;
913 extern kmp_affinity_t __kmp_affinity;
914 extern kmp_affinity_t __kmp_hh_affinity;
915 extern kmp_affinity_t *__kmp_affinities[2];
916 
917 extern void __kmp_affinity_bind_thread(int which);
918 
919 extern kmp_affin_mask_t *__kmp_affin_fullMask;
920 extern kmp_affin_mask_t *__kmp_affin_origMask;
921 extern char *__kmp_cpuinfo_file;
922 
923 #if KMP_WEIGHTED_ITERATIONS_SUPPORTED
924 extern int __kmp_first_osid_with_ecore;
925 #endif
926 
927 #endif /* KMP_AFFINITY_SUPPORTED */
928 
929 // This needs to be kept in sync with the values in omp.h !!!
930 typedef enum kmp_proc_bind_t {
931  proc_bind_false = 0,
932  proc_bind_true,
933  proc_bind_primary,
934  proc_bind_close,
935  proc_bind_spread,
936  proc_bind_intel, // use KMP_AFFINITY interface
937  proc_bind_default
938 } kmp_proc_bind_t;
939 
940 typedef struct kmp_nested_proc_bind_t {
941  kmp_proc_bind_t *bind_types;
942  int size;
943  int used;
944 } kmp_nested_proc_bind_t;
945 
946 extern kmp_nested_proc_bind_t __kmp_nested_proc_bind;
947 extern kmp_proc_bind_t __kmp_teams_proc_bind;
948 
949 extern int __kmp_display_affinity;
950 extern char *__kmp_affinity_format;
951 static const size_t KMP_AFFINITY_FORMAT_SIZE = 512;
952 #if OMPT_SUPPORT
953 extern int __kmp_tool;
954 extern char *__kmp_tool_libraries;
955 #endif // OMPT_SUPPORT
956 
957 #if KMP_AFFINITY_SUPPORTED
958 #define KMP_PLACE_ALL (-1)
959 #define KMP_PLACE_UNDEFINED (-2)
960 // Is KMP_AFFINITY is being used instead of OMP_PROC_BIND/OMP_PLACES?
961 #define KMP_AFFINITY_NON_PROC_BIND \
962  ((__kmp_nested_proc_bind.bind_types[0] == proc_bind_false || \
963  __kmp_nested_proc_bind.bind_types[0] == proc_bind_intel) && \
964  (__kmp_affinity.num_masks > 0 || __kmp_affinity.type == affinity_balanced))
965 #endif /* KMP_AFFINITY_SUPPORTED */
966 
967 extern int __kmp_affinity_num_places;
968 
969 typedef enum kmp_cancel_kind_t {
970  cancel_noreq = 0,
971  cancel_parallel = 1,
972  cancel_loop = 2,
973  cancel_sections = 3,
974  cancel_taskgroup = 4
975 } kmp_cancel_kind_t;
976 
977 // KMP_HW_SUBSET support:
978 typedef struct kmp_hws_item {
979  int num;
980  int offset;
981 } kmp_hws_item_t;
982 
983 extern kmp_hws_item_t __kmp_hws_socket;
984 extern kmp_hws_item_t __kmp_hws_die;
985 extern kmp_hws_item_t __kmp_hws_node;
986 extern kmp_hws_item_t __kmp_hws_tile;
987 extern kmp_hws_item_t __kmp_hws_core;
988 extern kmp_hws_item_t __kmp_hws_proc;
989 extern int __kmp_hws_requested;
990 extern int __kmp_hws_abs_flag; // absolute or per-item number requested
991 
992 /* ------------------------------------------------------------------------ */
993 
994 #define KMP_PAD(type, sz) \
995  (sizeof(type) + (sz - ((sizeof(type) - 1) % (sz)) - 1))
996 
997 // We need to avoid using -1 as a GTID as +1 is added to the gtid
998 // when storing it in a lock, and the value 0 is reserved.
999 #define KMP_GTID_DNE (-2) /* Does not exist */
1000 #define KMP_GTID_SHUTDOWN (-3) /* Library is shutting down */
1001 #define KMP_GTID_MONITOR (-4) /* Monitor thread ID */
1002 #define KMP_GTID_UNKNOWN (-5) /* Is not known */
1003 #define KMP_GTID_MIN (-6) /* Minimal gtid for low bound check in DEBUG */
1004 
1005 /* OpenMP 5.0 Memory Management support */
1006 
1007 #ifndef __OMP_H
1008 // Duplicate type definitions from omp.h
1009 typedef uintptr_t omp_uintptr_t;
1010 
1011 typedef enum {
1012  omp_atk_sync_hint = 1,
1013  omp_atk_alignment = 2,
1014  omp_atk_access = 3,
1015  omp_atk_pool_size = 4,
1016  omp_atk_fallback = 5,
1017  omp_atk_fb_data = 6,
1018  omp_atk_pinned = 7,
1019  omp_atk_partition = 8,
1020  omp_atk_pin_device = 9,
1021  omp_atk_preferred_device = 10,
1022  omp_atk_device_access = 11,
1023  omp_atk_target_access = 12,
1024  omp_atk_atomic_scope = 13,
1025  omp_atk_part_size = 14
1026 } omp_alloctrait_key_t;
1027 
1028 typedef enum {
1029  omp_atv_false = 0,
1030  omp_atv_true = 1,
1031  omp_atv_contended = 3,
1032  omp_atv_uncontended = 4,
1033  omp_atv_serialized = 5,
1034  omp_atv_sequential = omp_atv_serialized, // (deprecated)
1035  omp_atv_private = 6,
1036  omp_atv_device = 7,
1037  omp_atv_thread = 8,
1038  omp_atv_pteam = 9,
1039  omp_atv_cgroup = 10,
1040  omp_atv_default_mem_fb = 11,
1041  omp_atv_null_fb = 12,
1042  omp_atv_abort_fb = 13,
1043  omp_atv_allocator_fb = 14,
1044  omp_atv_environment = 15,
1045  omp_atv_nearest = 16,
1046  omp_atv_blocked = 17,
1047  omp_atv_interleaved = 18,
1048  omp_atv_all = 19,
1049  omp_atv_single = 20,
1050  omp_atv_multiple = 21,
1051  omp_atv_memspace = 22
1052 } omp_alloctrait_value_t;
1053 #define omp_atv_default ((omp_uintptr_t)-1)
1054 
1055 typedef void *omp_memspace_handle_t;
1056 extern omp_memspace_handle_t const omp_null_mem_space;
1057 extern omp_memspace_handle_t const omp_default_mem_space;
1058 extern omp_memspace_handle_t const omp_large_cap_mem_space;
1059 extern omp_memspace_handle_t const omp_const_mem_space;
1060 extern omp_memspace_handle_t const omp_high_bw_mem_space;
1061 extern omp_memspace_handle_t const omp_low_lat_mem_space;
1062 extern omp_memspace_handle_t const omp_cgroup_mem_space;
1063 extern omp_memspace_handle_t const llvm_omp_target_host_mem_space;
1064 extern omp_memspace_handle_t const llvm_omp_target_shared_mem_space;
1065 extern omp_memspace_handle_t const llvm_omp_target_device_mem_space;
1066 extern omp_memspace_handle_t const kmp_max_mem_space;
1067 
1068 typedef struct {
1069  omp_alloctrait_key_t key;
1070  omp_uintptr_t value;
1071 } omp_alloctrait_t;
1072 
1073 typedef void *omp_allocator_handle_t;
1074 extern omp_allocator_handle_t const omp_null_allocator;
1075 extern omp_allocator_handle_t const omp_default_mem_alloc;
1076 extern omp_allocator_handle_t const omp_large_cap_mem_alloc;
1077 extern omp_allocator_handle_t const omp_const_mem_alloc;
1078 extern omp_allocator_handle_t const omp_high_bw_mem_alloc;
1079 extern omp_allocator_handle_t const omp_low_lat_mem_alloc;
1080 extern omp_allocator_handle_t const omp_cgroup_mem_alloc;
1081 extern omp_allocator_handle_t const omp_pteam_mem_alloc;
1082 extern omp_allocator_handle_t const omp_thread_mem_alloc;
1083 extern omp_allocator_handle_t const llvm_omp_target_host_mem_alloc;
1084 extern omp_allocator_handle_t const llvm_omp_target_shared_mem_alloc;
1085 extern omp_allocator_handle_t const llvm_omp_target_device_mem_alloc;
1086 extern omp_allocator_handle_t const kmp_max_mem_alloc;
1087 extern omp_allocator_handle_t __kmp_def_allocator;
1088 
1089 // end of duplicate type definitions from omp.h
1090 #endif
1091 
1092 extern int __kmp_memkind_available;
1093 extern bool __kmp_hwloc_available;
1094 
1096 typedef struct kmp_memspace_t {
1097  omp_memspace_handle_t memspace; // predefined input memory space
1098  int num_resources = 0; // number of available resources
1099  int *resources = nullptr; // available resources
1100  kmp_memspace_t *next = nullptr; // next memory space handle
1101 } kmp_memspace_t;
1102 
1104 typedef struct kmp_allocator_t {
1105  omp_memspace_handle_t memspace;
1106  void **memkind; // pointer to memkind
1107  size_t alignment;
1108  omp_alloctrait_value_t fb;
1109  kmp_allocator_t *fb_data;
1110  kmp_uint64 pool_size;
1111  kmp_uint64 pool_used;
1112  bool pinned;
1113  omp_alloctrait_value_t partition;
1114  int pin_device;
1115  int preferred_device;
1116  omp_alloctrait_value_t target_access;
1117  omp_alloctrait_value_t atomic_scope;
1118  size_t part_size;
1119 #if KMP_HWLOC_ENABLED
1120  omp_alloctrait_value_t membind;
1121 #endif // KMP_HWLOC_ENABLED
1122 } kmp_allocator_t;
1123 
1124 extern omp_allocator_handle_t __kmpc_init_allocator(int gtid,
1125  omp_memspace_handle_t,
1126  int ntraits,
1127  omp_alloctrait_t traits[]);
1128 extern void __kmpc_destroy_allocator(int gtid, omp_allocator_handle_t al);
1129 extern void __kmpc_set_default_allocator(int gtid, omp_allocator_handle_t al);
1130 extern omp_allocator_handle_t __kmpc_get_default_allocator(int gtid);
1131 // external interfaces, may be used by compiler
1132 extern void *__kmpc_alloc(int gtid, size_t sz, omp_allocator_handle_t al);
1133 extern void *__kmpc_aligned_alloc(int gtid, size_t align, size_t sz,
1134  omp_allocator_handle_t al);
1135 extern void *__kmpc_calloc(int gtid, size_t nmemb, size_t sz,
1136  omp_allocator_handle_t al);
1137 extern void *__kmpc_realloc(int gtid, void *ptr, size_t sz,
1138  omp_allocator_handle_t al,
1139  omp_allocator_handle_t free_al);
1140 extern void __kmpc_free(int gtid, void *ptr, omp_allocator_handle_t al);
1141 // internal interfaces, contain real implementation
1142 extern void *__kmp_alloc(int gtid, size_t align, size_t sz,
1143  omp_allocator_handle_t al);
1144 extern void *__kmp_calloc(int gtid, size_t align, size_t nmemb, size_t sz,
1145  omp_allocator_handle_t al);
1146 extern void *__kmp_realloc(int gtid, void *ptr, size_t sz,
1147  omp_allocator_handle_t al,
1148  omp_allocator_handle_t free_al);
1149 extern void ___kmpc_free(int gtid, void *ptr, omp_allocator_handle_t al);
1150 
1151 extern void __kmp_init_memkind();
1152 extern void __kmp_fini_memkind();
1153 extern void __kmp_init_target_mem();
1154 extern void __kmp_fini_target_mem();
1155 
1156 // OpenMP 6.0 (TR11) Memory Management support
1157 extern omp_memspace_handle_t __kmp_get_devices_memspace(int ndevs,
1158  const int *devs,
1159  omp_memspace_handle_t,
1160  int host);
1161 extern omp_allocator_handle_t __kmp_get_devices_allocator(int ndevs,
1162  const int *devs,
1163  omp_memspace_handle_t,
1164  int host);
1165 extern int __kmp_get_memspace_num_resources(omp_memspace_handle_t memspace);
1166 extern omp_memspace_handle_t
1167 __kmp_get_submemspace(omp_memspace_handle_t memspace, int num_resources,
1168  int *resources);
1169 
1170 /* ------------------------------------------------------------------------ */
1171 
1172 #if ENABLE_LIBOMPTARGET
1173 extern void __kmp_init_target_task();
1174 #endif
1175 
1176 /* ------------------------------------------------------------------------ */
1177 
1178 #define KMP_UINT64_MAX \
1179  (~((kmp_uint64)1 << ((sizeof(kmp_uint64) * (1 << 3)) - 1)))
1180 
1181 #define KMP_MIN_NTH 1
1182 
1183 #ifndef KMP_MAX_NTH
1184 #if defined(PTHREAD_THREADS_MAX) && PTHREAD_THREADS_MAX < INT_MAX
1185 #define KMP_MAX_NTH PTHREAD_THREADS_MAX
1186 #else
1187 #ifdef __ve__
1188 // VE's pthread supports only up to 64 threads per a VE process.
1189 // Please check p. 14 of following documentation for more details.
1190 // https://sxauroratsubasa.sakura.ne.jp/documents/veos/en/VEOS_high_level_design.pdf
1191 #define KMP_MAX_NTH 64
1192 #else
1193 #define KMP_MAX_NTH INT_MAX
1194 #endif
1195 #endif
1196 #endif /* KMP_MAX_NTH */
1197 
1198 #ifdef PTHREAD_STACK_MIN
1199 #define KMP_MIN_STKSIZE ((size_t)PTHREAD_STACK_MIN)
1200 #else
1201 #define KMP_MIN_STKSIZE ((size_t)(32 * 1024))
1202 #endif
1203 
1204 #if KMP_OS_AIX && KMP_ARCH_PPC
1205 #define KMP_MAX_STKSIZE 0x10000000 /* 256Mb max size on 32-bit AIX */
1206 #else
1207 #define KMP_MAX_STKSIZE (~((size_t)1 << ((sizeof(size_t) * (1 << 3)) - 1)))
1208 #endif
1209 
1210 #if KMP_ARCH_X86
1211 #define KMP_DEFAULT_STKSIZE ((size_t)(2 * 1024 * 1024))
1212 #elif KMP_ARCH_X86_64
1213 #define KMP_DEFAULT_STKSIZE ((size_t)(4 * 1024 * 1024))
1214 #define KMP_BACKUP_STKSIZE ((size_t)(2 * 1024 * 1024))
1215 #elif KMP_ARCH_VE
1216 // Minimum stack size for pthread for VE is 4MB.
1217 // https://www.hpc.nec/documents/veos/en/glibc/Difference_Points_glibc.htm
1218 #define KMP_DEFAULT_STKSIZE ((size_t)(4 * 1024 * 1024))
1219 #elif KMP_OS_AIX
1220 // The default stack size for worker threads on AIX is 4MB.
1221 #define KMP_DEFAULT_STKSIZE ((size_t)(4 * 1024 * 1024))
1222 #else
1223 #define KMP_DEFAULT_STKSIZE ((size_t)(1024 * 1024))
1224 #endif
1225 
1226 #define KMP_DEFAULT_MALLOC_POOL_INCR ((size_t)(1024 * 1024))
1227 #define KMP_MIN_MALLOC_POOL_INCR ((size_t)(4 * 1024))
1228 #define KMP_MAX_MALLOC_POOL_INCR \
1229  (~((size_t)1 << ((sizeof(size_t) * (1 << 3)) - 1)))
1230 
1231 #define KMP_MIN_STKOFFSET (0)
1232 #define KMP_MAX_STKOFFSET KMP_MAX_STKSIZE
1233 #if KMP_OS_DARWIN
1234 #define KMP_DEFAULT_STKOFFSET KMP_MIN_STKOFFSET
1235 #else
1236 #define KMP_DEFAULT_STKOFFSET CACHE_LINE
1237 #endif
1238 
1239 #define KMP_MIN_STKPADDING (0)
1240 #define KMP_MAX_STKPADDING (2 * 1024 * 1024)
1241 
1242 #define KMP_BLOCKTIME_MULTIPLIER \
1243  (1000000) /* number of blocktime units per second */
1244 #define KMP_MIN_BLOCKTIME (0)
1245 #define KMP_MAX_BLOCKTIME \
1246  (INT_MAX) /* Must be this for "infinite" setting the work */
1247 
1248 /* __kmp_blocktime is in microseconds */
1249 #define KMP_DEFAULT_BLOCKTIME (__kmp_is_hybrid_cpu() ? (0) : (200000))
1250 
1251 #if KMP_USE_MONITOR
1252 #define KMP_DEFAULT_MONITOR_STKSIZE ((size_t)(64 * 1024))
1253 #define KMP_MIN_MONITOR_WAKEUPS (1) // min times monitor wakes up per second
1254 #define KMP_MAX_MONITOR_WAKEUPS (1000) // max times monitor can wake up per sec
1255 
1256 /* Calculate new number of monitor wakeups for a specific block time based on
1257  previous monitor_wakeups. Only allow increasing number of wakeups */
1258 #define KMP_WAKEUPS_FROM_BLOCKTIME(blocktime, monitor_wakeups) \
1259  (((blocktime) == KMP_MAX_BLOCKTIME) ? (monitor_wakeups) \
1260  : ((blocktime) == KMP_MIN_BLOCKTIME) ? KMP_MAX_MONITOR_WAKEUPS \
1261  : ((monitor_wakeups) > (KMP_BLOCKTIME_MULTIPLIER / (blocktime))) \
1262  ? (monitor_wakeups) \
1263  : (KMP_BLOCKTIME_MULTIPLIER) / (blocktime))
1264 
1265 /* Calculate number of intervals for a specific block time based on
1266  monitor_wakeups */
1267 #define KMP_INTERVALS_FROM_BLOCKTIME(blocktime, monitor_wakeups) \
1268  (((blocktime) + (KMP_BLOCKTIME_MULTIPLIER / (monitor_wakeups)) - 1) / \
1269  (KMP_BLOCKTIME_MULTIPLIER / (monitor_wakeups)))
1270 #else
1271 #define KMP_BLOCKTIME(team, tid) \
1272  (get__bt_set(team, tid) ? get__blocktime(team, tid) : __kmp_dflt_blocktime)
1273 #if KMP_OS_UNIX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
1274 // HW TSC is used to reduce overhead (clock tick instead of nanosecond).
1275 extern kmp_uint64 __kmp_ticks_per_msec;
1276 extern kmp_uint64 __kmp_ticks_per_usec;
1277 #if KMP_COMPILER_ICC || KMP_COMPILER_ICX
1278 #define KMP_NOW() ((kmp_uint64)_rdtsc())
1279 #else
1280 #define KMP_NOW() __kmp_hardware_timestamp()
1281 #endif
1282 #define KMP_BLOCKTIME_INTERVAL(team, tid) \
1283  ((kmp_uint64)KMP_BLOCKTIME(team, tid) * __kmp_ticks_per_usec)
1284 #define KMP_BLOCKING(goal, count) ((goal) > KMP_NOW())
1285 #else
1286 // System time is retrieved sporadically while blocking.
1287 extern kmp_uint64 __kmp_now_nsec();
1288 #define KMP_NOW() __kmp_now_nsec()
1289 #define KMP_BLOCKTIME_INTERVAL(team, tid) \
1290  ((kmp_uint64)KMP_BLOCKTIME(team, tid) * (kmp_uint64)KMP_NSEC_PER_USEC)
1291 #define KMP_BLOCKING(goal, count) ((count) % 1000 != 0 || (goal) > KMP_NOW())
1292 #endif
1293 #endif // KMP_USE_MONITOR
1294 
1295 #define KMP_MIN_STATSCOLS 40
1296 #define KMP_MAX_STATSCOLS 4096
1297 #define KMP_DEFAULT_STATSCOLS 80
1298 
1299 #define KMP_MIN_INTERVAL 0
1300 #define KMP_MAX_INTERVAL (INT_MAX - 1)
1301 #define KMP_DEFAULT_INTERVAL 0
1302 
1303 #define KMP_MIN_CHUNK 1
1304 #define KMP_MAX_CHUNK (INT_MAX - 1)
1305 #define KMP_DEFAULT_CHUNK 1
1306 
1307 #define KMP_MIN_DISP_NUM_BUFF 1
1308 #define KMP_DFLT_DISP_NUM_BUFF 7
1309 #define KMP_MAX_DISP_NUM_BUFF 4096
1310 
1311 #define KMP_MAX_ORDERED 8
1312 
1313 #define KMP_MAX_FIELDS 32
1314 
1315 #define KMP_MAX_BRANCH_BITS 31
1316 
1317 #define KMP_MAX_ACTIVE_LEVELS_LIMIT INT_MAX
1318 
1319 #define KMP_MAX_DEFAULT_DEVICE_LIMIT INT_MAX
1320 
1321 #define KMP_MAX_TASK_PRIORITY_LIMIT INT_MAX
1322 
1323 /* Minimum number of threads before switch to TLS gtid (experimentally
1324  determined) */
1325 /* josh TODO: what about OS X* tuning? */
1326 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
1327 #define KMP_TLS_GTID_MIN 5
1328 #else
1329 #define KMP_TLS_GTID_MIN INT_MAX
1330 #endif
1331 
1332 #define KMP_MASTER_TID(tid) (0 == (tid))
1333 #define KMP_WORKER_TID(tid) (0 != (tid))
1334 
1335 #define KMP_MASTER_GTID(gtid) (0 == __kmp_tid_from_gtid((gtid)))
1336 #define KMP_WORKER_GTID(gtid) (0 != __kmp_tid_from_gtid((gtid)))
1337 #define KMP_INITIAL_GTID(gtid) (0 == (gtid))
1338 
1339 #ifndef TRUE
1340 #define FALSE 0
1341 #define TRUE (!FALSE)
1342 #endif
1343 
1344 /* NOTE: all of the following constants must be even */
1345 
1346 #if KMP_OS_WINDOWS
1347 #define KMP_INIT_WAIT 64U /* initial number of spin-tests */
1348 #define KMP_NEXT_WAIT 32U /* susequent number of spin-tests */
1349 #elif KMP_OS_LINUX
1350 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1351 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1352 #elif KMP_OS_DARWIN
1353 /* TODO: tune for KMP_OS_DARWIN */
1354 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1355 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1356 #elif KMP_OS_DRAGONFLY
1357 /* TODO: tune for KMP_OS_DRAGONFLY */
1358 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1359 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1360 #elif KMP_OS_FREEBSD
1361 /* TODO: tune for KMP_OS_FREEBSD */
1362 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1363 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1364 #elif KMP_OS_NETBSD
1365 /* TODO: tune for KMP_OS_NETBSD */
1366 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1367 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1368 #elif KMP_OS_OPENBSD
1369 /* TODO: tune for KMP_OS_OPENBSD */
1370 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1371 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1372 #elif KMP_OS_HAIKU
1373 /* TODO: tune for KMP_OS_HAIKU */
1374 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1375 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1376 #elif KMP_OS_HURD
1377 /* TODO: tune for KMP_OS_HURD */
1378 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1379 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1380 #elif KMP_OS_SOLARIS
1381 /* TODO: tune for KMP_OS_SOLARIS */
1382 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1383 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1384 #elif KMP_OS_WASI
1385 /* TODO: tune for KMP_OS_WASI */
1386 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1387 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1388 #elif KMP_OS_AIX
1389 /* TODO: tune for KMP_OS_AIX */
1390 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1391 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
1392 #endif
1393 
1394 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
1395 typedef struct kmp_cpuid {
1396  kmp_uint32 eax;
1397  kmp_uint32 ebx;
1398  kmp_uint32 ecx;
1399  kmp_uint32 edx;
1400 } kmp_cpuid_t;
1401 
1402 typedef struct kmp_cpuinfo_flags_t {
1403  unsigned sse2 : 1; // 0 if SSE2 instructions are not supported, 1 otherwise.
1404  unsigned rtm : 1; // 0 if RTM instructions are not supported, 1 otherwise.
1405  unsigned hybrid : 1;
1406  unsigned reserved : 29; // Ensure size of 32 bits
1407 } kmp_cpuinfo_flags_t;
1408 
1409 typedef struct kmp_cpuinfo {
1410  int initialized; // If 0, other fields are not initialized.
1411  int signature; // CPUID(1).EAX
1412  int family; // CPUID(1).EAX[27:20]+CPUID(1).EAX[11:8] (Extended Family+Family)
1413  int model; // ( CPUID(1).EAX[19:16] << 4 ) + CPUID(1).EAX[7:4] ( ( Extended
1414  // Model << 4 ) + Model)
1415  int stepping; // CPUID(1).EAX[3:0] ( Stepping )
1416  kmp_cpuinfo_flags_t flags;
1417  int apic_id;
1418  kmp_uint64 frequency; // Nominal CPU frequency in Hz.
1419  char name[3 * sizeof(kmp_cpuid_t)]; // CPUID(0x80000002,0x80000003,0x80000004)
1420 } kmp_cpuinfo_t;
1421 
1422 extern void __kmp_query_cpuid(kmp_cpuinfo_t *p);
1423 
1424 #if KMP_OS_UNIX
1425 // subleaf is only needed for cache and topology discovery and can be set to
1426 // zero in most cases
1427 static inline void __kmp_x86_cpuid(int leaf, int subleaf, struct kmp_cpuid *p) {
1428  __asm__ __volatile__("cpuid"
1429  : "=a"(p->eax), "=b"(p->ebx), "=c"(p->ecx), "=d"(p->edx)
1430  : "a"(leaf), "c"(subleaf));
1431 }
1432 // Load p into FPU control word
1433 static inline void __kmp_load_x87_fpu_control_word(const kmp_int16 *p) {
1434  __asm__ __volatile__("fldcw %0" : : "m"(*p));
1435 }
1436 // Store FPU control word into p
1437 static inline void __kmp_store_x87_fpu_control_word(kmp_int16 *p) {
1438  __asm__ __volatile__("fstcw %0" : "=m"(*p));
1439 }
1440 static inline void __kmp_clear_x87_fpu_status_word() {
1441 #if KMP_MIC
1442  // 32-bit protected mode x87 FPU state
1443  struct x87_fpu_state {
1444  unsigned cw;
1445  unsigned sw;
1446  unsigned tw;
1447  unsigned fip;
1448  unsigned fips;
1449  unsigned fdp;
1450  unsigned fds;
1451  };
1452  struct x87_fpu_state fpu_state = {0, 0, 0, 0, 0, 0, 0};
1453  __asm__ __volatile__("fstenv %0\n\t" // store FP env
1454  "andw $0x7f00, %1\n\t" // clear 0-7,15 bits of FP SW
1455  "fldenv %0\n\t" // load FP env back
1456  : "+m"(fpu_state), "+m"(fpu_state.sw));
1457 #else
1458  __asm__ __volatile__("fnclex");
1459 #endif // KMP_MIC
1460 }
1461 #if __SSE__
1462 static inline void __kmp_load_mxcsr(const kmp_uint32 *p) { _mm_setcsr(*p); }
1463 static inline void __kmp_store_mxcsr(kmp_uint32 *p) { *p = _mm_getcsr(); }
1464 #else
1465 static inline void __kmp_load_mxcsr(const kmp_uint32 *p) {}
1466 static inline void __kmp_store_mxcsr(kmp_uint32 *p) { *p = 0; }
1467 #endif
1468 #else
1469 // Windows still has these as external functions in assembly file
1470 extern void __kmp_x86_cpuid(int mode, int mode2, struct kmp_cpuid *p);
1471 extern void __kmp_load_x87_fpu_control_word(const kmp_int16 *p);
1472 extern void __kmp_store_x87_fpu_control_word(kmp_int16 *p);
1473 extern void __kmp_clear_x87_fpu_status_word();
1474 static inline void __kmp_load_mxcsr(const kmp_uint32 *p) { _mm_setcsr(*p); }
1475 static inline void __kmp_store_mxcsr(kmp_uint32 *p) { *p = _mm_getcsr(); }
1476 #endif // KMP_OS_UNIX
1477 
1478 #define KMP_X86_MXCSR_MASK 0xffffffc0 /* ignore status flags (6 lsb) */
1479 
1480 // User-level Monitor/Mwait
1481 #if KMP_HAVE_UMWAIT
1482 // We always try for UMWAIT first
1483 #if KMP_HAVE_WAITPKG_INTRINSICS
1484 #if KMP_HAVE_IMMINTRIN_H
1485 #include <immintrin.h>
1486 #elif KMP_HAVE_INTRIN_H
1487 #include <intrin.h>
1488 #endif
1489 #endif // KMP_HAVE_WAITPKG_INTRINSICS
1490 
1491 KMP_ATTRIBUTE_TARGET_WAITPKG
1492 static inline int __kmp_tpause(uint32_t hint, uint64_t counter) {
1493 #if !KMP_HAVE_WAITPKG_INTRINSICS
1494  uint32_t timeHi = uint32_t(counter >> 32);
1495  uint32_t timeLo = uint32_t(counter & 0xffffffff);
1496  char flag;
1497  __asm__ volatile("#tpause\n.byte 0x66, 0x0F, 0xAE, 0xF1\n"
1498  "setb %0"
1499  // The "=q" restraint means any register accessible as rl
1500  // in 32-bit mode: a, b, c, and d;
1501  // in 64-bit mode: any integer register
1502  : "=q"(flag)
1503  : "a"(timeLo), "d"(timeHi), "c"(hint)
1504  :);
1505  return flag;
1506 #else
1507  return _tpause(hint, counter);
1508 #endif
1509 }
1510 KMP_ATTRIBUTE_TARGET_WAITPKG
1511 static inline void __kmp_umonitor(void *cacheline) {
1512 #if !KMP_HAVE_WAITPKG_INTRINSICS
1513  __asm__ volatile("# umonitor\n.byte 0xF3, 0x0F, 0xAE, 0x01 "
1514  :
1515  : "a"(cacheline)
1516  :);
1517 #else
1518  _umonitor(cacheline);
1519 #endif
1520 }
1521 KMP_ATTRIBUTE_TARGET_WAITPKG
1522 static inline int __kmp_umwait(uint32_t hint, uint64_t counter) {
1523 #if !KMP_HAVE_WAITPKG_INTRINSICS
1524  uint32_t timeHi = uint32_t(counter >> 32);
1525  uint32_t timeLo = uint32_t(counter & 0xffffffff);
1526  char flag;
1527  __asm__ volatile("#umwait\n.byte 0xF2, 0x0F, 0xAE, 0xF1\n"
1528  "setb %0"
1529  // The "=q" restraint means any register accessible as rl
1530  // in 32-bit mode: a, b, c, and d;
1531  // in 64-bit mode: any integer register
1532  : "=q"(flag)
1533  : "a"(timeLo), "d"(timeHi), "c"(hint)
1534  :);
1535  return flag;
1536 #else
1537  return _umwait(hint, counter);
1538 #endif
1539 }
1540 #elif KMP_HAVE_MWAIT
1541 #if KMP_OS_UNIX
1542 #include <pmmintrin.h>
1543 #else
1544 #include <intrin.h>
1545 #endif
1546 #if KMP_OS_UNIX
1547 __attribute__((target("sse3")))
1548 #endif
1549 static inline void
1550 __kmp_mm_monitor(void *cacheline, unsigned extensions, unsigned hints) {
1551  _mm_monitor(cacheline, extensions, hints);
1552 }
1553 #if KMP_OS_UNIX
1554 __attribute__((target("sse3")))
1555 #endif
1556 static inline void
1557 __kmp_mm_mwait(unsigned extensions, unsigned hints) {
1558  _mm_mwait(extensions, hints);
1559 }
1560 #endif // KMP_HAVE_UMWAIT
1561 
1562 #if KMP_ARCH_X86
1563 extern void __kmp_x86_pause(void);
1564 #elif KMP_MIC
1565 // Performance testing on KNC (C0QS-7120 P/A/X/D, 61-core, 16 GB Memory) showed
1566 // regression after removal of extra PAUSE from spin loops. Changing
1567 // the delay from 100 to 300 showed even better performance than double PAUSE
1568 // on Spec OMP2001 and LCPC tasking tests, no regressions on EPCC.
1569 static inline void __kmp_x86_pause(void) { _mm_delay_32(300); }
1570 #else
1571 static inline void __kmp_x86_pause(void) { _mm_pause(); }
1572 #endif
1573 #define KMP_CPU_PAUSE() __kmp_x86_pause()
1574 #elif KMP_ARCH_PPC64
1575 #define KMP_PPC64_PRI_LOW() __asm__ volatile("or 1, 1, 1")
1576 #define KMP_PPC64_PRI_MED() __asm__ volatile("or 2, 2, 2")
1577 #define KMP_PPC64_PRI_LOC_MB() __asm__ volatile("" : : : "memory")
1578 #define KMP_CPU_PAUSE() \
1579  do { \
1580  KMP_PPC64_PRI_LOW(); \
1581  KMP_PPC64_PRI_MED(); \
1582  KMP_PPC64_PRI_LOC_MB(); \
1583  } while (0)
1584 #else
1585 #define KMP_CPU_PAUSE() /* nothing to do */
1586 #endif
1587 
1588 #define KMP_INIT_YIELD(count) \
1589  { (count) = __kmp_yield_init; }
1590 
1591 #define KMP_INIT_BACKOFF(time) \
1592  { (time) = __kmp_pause_init; }
1593 
1594 #define KMP_OVERSUBSCRIBED \
1595  (TCR_4(__kmp_nth) > (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc))
1596 
1597 #define KMP_TRY_YIELD \
1598  ((__kmp_use_yield == 1) || (__kmp_use_yield == 2 && (KMP_OVERSUBSCRIBED)))
1599 
1600 #define KMP_TRY_YIELD_OVERSUB \
1601  ((__kmp_use_yield == 1 || __kmp_use_yield == 2) && (KMP_OVERSUBSCRIBED))
1602 
1603 #define KMP_YIELD(cond) \
1604  { \
1605  KMP_CPU_PAUSE(); \
1606  if ((cond) && (KMP_TRY_YIELD)) \
1607  __kmp_yield(); \
1608  }
1609 
1610 #define KMP_YIELD_OVERSUB() \
1611  { \
1612  KMP_CPU_PAUSE(); \
1613  if ((KMP_TRY_YIELD_OVERSUB)) \
1614  __kmp_yield(); \
1615  }
1616 
1617 // Note the decrement of 2 in the following Macros. With KMP_LIBRARY=turnaround,
1618 // there should be no yielding since initial value from KMP_INIT_YIELD() is odd.
1619 #define KMP_YIELD_SPIN(count) \
1620  { \
1621  KMP_CPU_PAUSE(); \
1622  if (KMP_TRY_YIELD) { \
1623  (count) -= 2; \
1624  if (!(count)) { \
1625  __kmp_yield(); \
1626  (count) = __kmp_yield_next; \
1627  } \
1628  } \
1629  }
1630 
1631 // If TPAUSE is available & enabled, use it. If oversubscribed, use the slower
1632 // (C0.2) state, which improves performance of other SMT threads on the same
1633 // core, otherwise, use the fast (C0.1) default state, or whatever the user has
1634 // requested. Uses a timed TPAUSE, and exponential backoff. If TPAUSE isn't
1635 // available, fall back to the regular CPU pause and yield combination.
1636 #if KMP_HAVE_UMWAIT
1637 #define KMP_TPAUSE_MAX_MASK ((kmp_uint64)0xFFFF)
1638 #define KMP_YIELD_OVERSUB_ELSE_SPIN(count, time) \
1639  { \
1640  if (__kmp_tpause_enabled) { \
1641  if (KMP_OVERSUBSCRIBED) { \
1642  __kmp_tpause(0, (time)); \
1643  } else { \
1644  __kmp_tpause(__kmp_tpause_hint, (time)); \
1645  } \
1646  (time) = (time << 1 | 1) & KMP_TPAUSE_MAX_MASK; \
1647  } else { \
1648  KMP_CPU_PAUSE(); \
1649  if ((KMP_TRY_YIELD_OVERSUB)) { \
1650  __kmp_yield(); \
1651  } else if (__kmp_use_yield == 1) { \
1652  (count) -= 2; \
1653  if (!(count)) { \
1654  __kmp_yield(); \
1655  (count) = __kmp_yield_next; \
1656  } \
1657  } \
1658  } \
1659  }
1660 #else
1661 #define KMP_YIELD_OVERSUB_ELSE_SPIN(count, time) \
1662  { \
1663  KMP_CPU_PAUSE(); \
1664  if ((KMP_TRY_YIELD_OVERSUB)) \
1665  __kmp_yield(); \
1666  else if (__kmp_use_yield == 1) { \
1667  (count) -= 2; \
1668  if (!(count)) { \
1669  __kmp_yield(); \
1670  (count) = __kmp_yield_next; \
1671  } \
1672  } \
1673  }
1674 #endif // KMP_HAVE_UMWAIT
1675 
1676 /* ------------------------------------------------------------------------ */
1677 /* Support datatypes for the orphaned construct nesting checks. */
1678 /* ------------------------------------------------------------------------ */
1679 
1680 /* When adding to this enum, add its corresponding string in cons_text_c[]
1681  * array in kmp_error.cpp */
1682 enum cons_type {
1683  ct_none,
1684  ct_parallel,
1685  ct_pdo,
1686  ct_pdo_ordered,
1687  ct_psections,
1688  ct_psingle,
1689  ct_critical,
1690  ct_ordered_in_parallel,
1691  ct_ordered_in_pdo,
1692  ct_master,
1693  ct_reduce,
1694  ct_barrier,
1695  ct_masked
1696 };
1697 
1698 #define IS_CONS_TYPE_ORDERED(ct) ((ct) == ct_pdo_ordered)
1699 
1700 struct cons_data {
1701  ident_t const *ident;
1702  enum cons_type type;
1703  int prev;
1704  kmp_user_lock_p
1705  name; /* address exclusively for critical section name comparison */
1706 };
1707 
1708 struct cons_header {
1709  int p_top, w_top, s_top;
1710  int stack_size, stack_top;
1711  struct cons_data *stack_data;
1712 };
1713 
1714 struct kmp_region_info {
1715  char *text;
1716  int offset[KMP_MAX_FIELDS];
1717  int length[KMP_MAX_FIELDS];
1718 };
1719 
1720 /* ---------------------------------------------------------------------- */
1721 /* ---------------------------------------------------------------------- */
1722 
1723 #if KMP_OS_WINDOWS
1724 typedef HANDLE kmp_thread_t;
1725 typedef DWORD kmp_key_t;
1726 #endif /* KMP_OS_WINDOWS */
1727 
1728 #if KMP_OS_UNIX
1729 typedef pthread_t kmp_thread_t;
1730 typedef pthread_key_t kmp_key_t;
1731 #endif
1732 
1733 extern kmp_key_t __kmp_gtid_threadprivate_key;
1734 
1735 typedef struct kmp_sys_info {
1736  long maxrss; /* the maximum resident set size utilized (in kilobytes) */
1737  long minflt; /* the number of page faults serviced without any I/O */
1738  long majflt; /* the number of page faults serviced that required I/O */
1739  long nswap; /* the number of times a process was "swapped" out of memory */
1740  long inblock; /* the number of times the file system had to perform input */
1741  long oublock; /* the number of times the file system had to perform output */
1742  long nvcsw; /* the number of times a context switch was voluntarily */
1743  long nivcsw; /* the number of times a context switch was forced */
1744 } kmp_sys_info_t;
1745 
1746 #if USE_ITT_BUILD
1747 // We cannot include "kmp_itt.h" due to circular dependency. Declare the only
1748 // required type here. Later we will check the type meets requirements.
1749 typedef int kmp_itt_mark_t;
1750 #define KMP_ITT_DEBUG 0
1751 #endif /* USE_ITT_BUILD */
1752 
1753 typedef kmp_int32 kmp_critical_name[8];
1754 
1764 typedef void (*kmpc_micro)(kmp_int32 *global_tid, kmp_int32 *bound_tid, ...);
1765 typedef void (*kmpc_micro_bound)(kmp_int32 *bound_tid, kmp_int32 *bound_nth,
1766  ...);
1767 
1772 /* ---------------------------------------------------------------------------
1773  */
1774 /* Threadprivate initialization/finalization function declarations */
1775 
1776 /* for non-array objects: __kmpc_threadprivate_register() */
1777 
1782 typedef void *(*kmpc_ctor)(void *);
1783 
1788 typedef void (*kmpc_dtor)(
1789  void * /*, size_t */); /* 2nd arg: magic number for KCC unused by Intel
1790  compiler */
1795 typedef void *(*kmpc_cctor)(void *, void *);
1796 
1797 /* for array objects: __kmpc_threadprivate_register_vec() */
1798 /* First arg: "this" pointer */
1799 /* Last arg: number of array elements */
1805 typedef void *(*kmpc_ctor_vec)(void *, size_t);
1811 typedef void (*kmpc_dtor_vec)(void *, size_t);
1817 typedef void *(*kmpc_cctor_vec)(void *, void *,
1818  size_t); /* function unused by compiler */
1819 
1824 /* keeps tracked of threadprivate cache allocations for cleanup later */
1825 typedef struct kmp_cached_addr {
1826  void **addr; /* address of allocated cache */
1827  void ***compiler_cache; /* pointer to compiler's cache */
1828  void *data; /* pointer to global data */
1829  struct kmp_cached_addr *next; /* pointer to next cached address */
1830 } kmp_cached_addr_t;
1831 
1832 struct private_data {
1833  struct private_data *next; /* The next descriptor in the list */
1834  void *data; /* The data buffer for this descriptor */
1835  int more; /* The repeat count for this descriptor */
1836  size_t size; /* The data size for this descriptor */
1837 };
1838 
1839 struct private_common {
1840  struct private_common *next;
1841  struct private_common *link;
1842  void *gbl_addr;
1843  void *par_addr; /* par_addr == gbl_addr for PRIMARY thread */
1844  size_t cmn_size;
1845 };
1846 
1847 struct shared_common {
1848  struct shared_common *next;
1849  struct private_data *pod_init;
1850  void *obj_init;
1851  void *gbl_addr;
1852  union {
1853  kmpc_ctor ctor;
1854  kmpc_ctor_vec ctorv;
1855  } ct;
1856  union {
1857  kmpc_cctor cctor;
1858  kmpc_cctor_vec cctorv;
1859  } cct;
1860  union {
1861  kmpc_dtor dtor;
1862  kmpc_dtor_vec dtorv;
1863  } dt;
1864  size_t vec_len;
1865  int is_vec;
1866  size_t cmn_size;
1867 };
1868 
1869 #define KMP_HASH_TABLE_LOG2 9 /* log2 of the hash table size */
1870 #define KMP_HASH_TABLE_SIZE \
1871  (1 << KMP_HASH_TABLE_LOG2) /* size of the hash table */
1872 #define KMP_HASH_SHIFT 3 /* throw away this many low bits from the address */
1873 #define KMP_HASH(x) \
1874  ((((kmp_uintptr_t)x) >> KMP_HASH_SHIFT) & (KMP_HASH_TABLE_SIZE - 1))
1875 
1876 struct common_table {
1877  struct private_common *data[KMP_HASH_TABLE_SIZE];
1878 };
1879 
1880 struct shared_table {
1881  struct shared_common *data[KMP_HASH_TABLE_SIZE];
1882 };
1883 
1884 /* ------------------------------------------------------------------------ */
1885 
1886 #if KMP_USE_HIER_SCHED
1887 // Shared barrier data that exists inside a single unit of the scheduling
1888 // hierarchy
1889 typedef struct kmp_hier_private_bdata_t {
1890  kmp_int32 num_active;
1891  kmp_uint64 index;
1892  kmp_uint64 wait_val[2];
1893 } kmp_hier_private_bdata_t;
1894 #endif
1895 
1896 typedef struct kmp_sched_flags {
1897  unsigned ordered : 1;
1898  unsigned nomerge : 1;
1899  unsigned contains_last : 1;
1900  unsigned use_hier : 1; // Used in KMP_USE_HIER_SCHED code
1901  unsigned use_hybrid : 1; // Used in KMP_WEIGHTED_ITERATIONS_SUPPORTED code
1902  unsigned unused : 27;
1903 } kmp_sched_flags_t;
1904 
1905 KMP_BUILD_ASSERT(sizeof(kmp_sched_flags_t) == 4);
1906 
1907 #if KMP_STATIC_STEAL_ENABLED
1908 typedef struct KMP_ALIGN_CACHE dispatch_private_info32 {
1909  kmp_int32 count;
1910  kmp_int32 ub;
1911  /* Adding KMP_ALIGN_CACHE here doesn't help / can hurt performance */
1912  kmp_int32 lb;
1913  kmp_int32 st;
1914  kmp_int32 tc;
1915  kmp_lock_t *steal_lock; // lock used for chunk stealing
1916 
1917  kmp_uint32 ordered_lower;
1918  kmp_uint32 ordered_upper;
1919 
1920  // KMP_ALIGN(32) ensures (if the KMP_ALIGN macro is turned on)
1921  // a) parm3 is properly aligned and
1922  // b) all parm1-4 are on the same cache line.
1923  // Because of parm1-4 are used together, performance seems to be better
1924  // if they are on the same cache line (not measured though).
1925 
1926  struct KMP_ALIGN(32) {
1927  kmp_int32 parm1;
1928  kmp_int32 parm2;
1929  kmp_int32 parm3;
1930  kmp_int32 parm4;
1931  };
1932 
1933 #if KMP_WEIGHTED_ITERATIONS_SUPPORTED
1934  kmp_uint32 pchunks;
1935  kmp_uint32 num_procs_with_pcore;
1936  kmp_int32 first_thread_with_ecore;
1937 #endif
1938 #if KMP_OS_WINDOWS
1939  kmp_int32 last_upper;
1940 #endif /* KMP_OS_WINDOWS */
1941 } dispatch_private_info32_t;
1942 
1943 #if CACHE_LINE <= 128
1944 KMP_BUILD_ASSERT(sizeof(dispatch_private_info32_t) <= 128);
1945 #endif
1946 
1947 typedef struct KMP_ALIGN_CACHE dispatch_private_info64 {
1948  kmp_int64 count; // current chunk number for static & static-steal scheduling
1949  kmp_int64 ub; /* upper-bound */
1950  /* Adding KMP_ALIGN_CACHE here doesn't help / can hurt performance */
1951  kmp_int64 lb; /* lower-bound */
1952  kmp_int64 st; /* stride */
1953  kmp_int64 tc; /* trip count (number of iterations) */
1954  kmp_lock_t *steal_lock; // lock used for chunk stealing
1955 
1956  kmp_uint64 ordered_lower;
1957  kmp_uint64 ordered_upper;
1958  /* parm[1-4] are used in different ways by different scheduling algorithms */
1959 
1960  // KMP_ALIGN(32) ensures ( if the KMP_ALIGN macro is turned on )
1961  // a) parm3 is properly aligned and
1962  // b) all parm1-4 are in the same cache line.
1963  // Because of parm1-4 are used together, performance seems to be better
1964  // if they are in the same line (not measured though).
1965  struct KMP_ALIGN(32) {
1966  kmp_int64 parm1;
1967  kmp_int64 parm2;
1968  kmp_int64 parm3;
1969  kmp_int64 parm4;
1970  };
1971 
1972 #if KMP_WEIGHTED_ITERATIONS_SUPPORTED
1973  kmp_uint64 pchunks;
1974  kmp_uint64 num_procs_with_pcore;
1975  kmp_int64 first_thread_with_ecore;
1976 #endif
1977 
1978 #if KMP_OS_WINDOWS
1979  kmp_int64 last_upper;
1980 #endif /* KMP_OS_WINDOWS */
1981 } dispatch_private_info64_t;
1982 
1983 #if CACHE_LINE <= 128
1984 KMP_BUILD_ASSERT(sizeof(dispatch_private_info64_t) <= 128);
1985 #endif
1986 
1987 #else /* KMP_STATIC_STEAL_ENABLED */
1988 typedef struct KMP_ALIGN_CACHE dispatch_private_info32 {
1989  kmp_int32 lb;
1990  kmp_int32 ub;
1991  kmp_int32 st;
1992  kmp_int32 tc;
1993 
1994  kmp_int32 parm1;
1995  kmp_int32 parm2;
1996  kmp_int32 parm3;
1997  kmp_int32 parm4;
1998 
1999  kmp_int32 count;
2000 
2001  kmp_uint32 ordered_lower;
2002  kmp_uint32 ordered_upper;
2003 #if KMP_OS_WINDOWS
2004  kmp_int32 last_upper;
2005 #endif /* KMP_OS_WINDOWS */
2006 } dispatch_private_info32_t;
2007 
2008 typedef struct KMP_ALIGN_CACHE dispatch_private_info64 {
2009  kmp_int64 lb; /* lower-bound */
2010  kmp_int64 ub; /* upper-bound */
2011  kmp_int64 st; /* stride */
2012  kmp_int64 tc; /* trip count (number of iterations) */
2013 
2014  /* parm[1-4] are used in different ways by different scheduling algorithms */
2015  kmp_int64 parm1;
2016  kmp_int64 parm2;
2017  kmp_int64 parm3;
2018  kmp_int64 parm4;
2019 
2020  kmp_int64 count; /* current chunk number for static scheduling */
2021 
2022  kmp_uint64 ordered_lower;
2023  kmp_uint64 ordered_upper;
2024 #if KMP_OS_WINDOWS
2025  kmp_int64 last_upper;
2026 #endif /* KMP_OS_WINDOWS */
2027 } dispatch_private_info64_t;
2028 #endif /* KMP_STATIC_STEAL_ENABLED */
2029 
2030 typedef struct KMP_ALIGN_CACHE dispatch_private_info {
2031  union private_info {
2032  dispatch_private_info32_t p32;
2033  dispatch_private_info64_t p64;
2034  } u;
2035  enum sched_type schedule; /* scheduling algorithm */
2036  kmp_sched_flags_t flags; /* flags (e.g., ordered, nomerge, etc.) */
2037  std::atomic<kmp_uint32> steal_flag; // static_steal only, state of a buffer
2038  kmp_int32 ordered_bumped;
2039  // Stack of buffers for nest of serial regions
2040  struct dispatch_private_info *next;
2041  kmp_int32 type_size; /* the size of types in private_info */
2042 #if KMP_USE_HIER_SCHED
2043  kmp_int32 hier_id;
2044  void *parent; /* hierarchical scheduling parent pointer */
2045 #endif
2046  enum cons_type pushed_ws;
2047 } dispatch_private_info_t;
2048 
2049 typedef struct dispatch_shared_info32 {
2050  /* chunk index under dynamic, number of idle threads under static-steal;
2051  iteration index otherwise */
2052  volatile kmp_uint32 iteration;
2053  volatile kmp_int32 num_done;
2054  volatile kmp_uint32 ordered_iteration;
2055  // Dummy to retain the structure size after making ordered_iteration scalar
2056  kmp_int32 ordered_dummy[KMP_MAX_ORDERED - 1];
2057 } dispatch_shared_info32_t;
2058 
2059 typedef struct dispatch_shared_info64 {
2060  /* chunk index under dynamic, number of idle threads under static-steal;
2061  iteration index otherwise */
2062  volatile kmp_uint64 iteration;
2063  volatile kmp_int64 num_done;
2064  volatile kmp_uint64 ordered_iteration;
2065  // Dummy to retain the structure size after making ordered_iteration scalar
2066  kmp_int64 ordered_dummy[KMP_MAX_ORDERED - 3];
2067 } dispatch_shared_info64_t;
2068 
2069 typedef struct dispatch_shared_info {
2070  union shared_info {
2071  dispatch_shared_info32_t s32;
2072  dispatch_shared_info64_t s64;
2073  } u;
2074  volatile kmp_uint32 buffer_index;
2075  volatile kmp_int32 doacross_buf_idx; // teamwise index
2076  volatile kmp_uint32 *doacross_flags; // shared array of iteration flags (0/1)
2077  kmp_int32 doacross_num_done; // count finished threads
2078 #if KMP_USE_HIER_SCHED
2079  void *hier;
2080 #endif
2081 #if KMP_HWLOC_ENABLED
2082  // When linking with libhwloc, the ORDERED EPCC test slows down on big
2083  // machines (> 48 cores). Performance analysis showed that a cache thrash
2084  // was occurring and this padding helps alleviate the problem.
2085  char padding[64];
2086 #endif // KMP_HWLOC_ENABLED
2087 } dispatch_shared_info_t;
2088 
2089 typedef struct kmp_disp {
2090  /* Vector for ORDERED SECTION */
2091  void (*th_deo_fcn)(int *gtid, int *cid, ident_t *);
2092  /* Vector for END ORDERED SECTION */
2093  void (*th_dxo_fcn)(int *gtid, int *cid, ident_t *);
2094 
2095  dispatch_shared_info_t *th_dispatch_sh_current;
2096  dispatch_private_info_t *th_dispatch_pr_current;
2097 
2098  dispatch_private_info_t *th_disp_buffer;
2099  kmp_uint32 th_disp_index;
2100  kmp_int32 th_doacross_buf_idx; // thread's doacross buffer index
2101  volatile kmp_uint32 *th_doacross_flags; // pointer to shared array of flags
2102  kmp_int64 *th_doacross_info; // info on loop bounds
2103 #if KMP_USE_INTERNODE_ALIGNMENT
2104  char more_padding[INTERNODE_CACHE_LINE];
2105 #endif
2106 } kmp_disp_t;
2107 
2108 /* ------------------------------------------------------------------------ */
2109 /* Barrier stuff */
2110 
2111 /* constants for barrier state update */
2112 #define KMP_INIT_BARRIER_STATE 0 /* should probably start from zero */
2113 #define KMP_BARRIER_SLEEP_BIT 0 /* bit used for suspend/sleep part of state */
2114 #define KMP_BARRIER_UNUSED_BIT 1 // bit that must never be set for valid state
2115 #define KMP_BARRIER_BUMP_BIT 2 /* lsb used for bump of go/arrived state */
2116 
2117 #define KMP_BARRIER_SLEEP_STATE (1 << KMP_BARRIER_SLEEP_BIT)
2118 #define KMP_BARRIER_UNUSED_STATE (1 << KMP_BARRIER_UNUSED_BIT)
2119 #define KMP_BARRIER_STATE_BUMP (1 << KMP_BARRIER_BUMP_BIT)
2120 
2121 #if (KMP_BARRIER_SLEEP_BIT >= KMP_BARRIER_BUMP_BIT)
2122 #error "Barrier sleep bit must be smaller than barrier bump bit"
2123 #endif
2124 #if (KMP_BARRIER_UNUSED_BIT >= KMP_BARRIER_BUMP_BIT)
2125 #error "Barrier unused bit must be smaller than barrier bump bit"
2126 #endif
2127 
2128 // Constants for release barrier wait state: currently, hierarchical only
2129 #define KMP_BARRIER_NOT_WAITING 0 // Normal state; worker not in wait_sleep
2130 #define KMP_BARRIER_OWN_FLAG \
2131  1 // Normal state; worker waiting on own b_go flag in release
2132 #define KMP_BARRIER_PARENT_FLAG \
2133  2 // Special state; worker waiting on parent's b_go flag in release
2134 #define KMP_BARRIER_SWITCH_TO_OWN_FLAG \
2135  3 // Special state; tells worker to shift from parent to own b_go
2136 #define KMP_BARRIER_SWITCHING \
2137  4 // Special state; worker resets appropriate flag on wake-up
2138 
2139 #define KMP_NOT_SAFE_TO_REAP \
2140  0 // Thread th_reap_state: not safe to reap (tasking)
2141 #define KMP_SAFE_TO_REAP 1 // Thread th_reap_state: safe to reap (not tasking)
2142 
2143 // The flag_type describes the storage used for the flag.
2144 enum flag_type {
2145  flag32,
2146  flag64,
2147  atomic_flag64,
2148  flag_oncore,
2149  flag_unset
2150 };
2151 
2152 enum barrier_type {
2153  bs_plain_barrier = 0, /* 0, All non-fork/join barriers (except reduction
2154  barriers if enabled) */
2155  bs_forkjoin_barrier, /* 1, All fork/join (parallel region) barriers */
2156 #if KMP_FAST_REDUCTION_BARRIER
2157  bs_reduction_barrier, /* 2, All barriers that are used in reduction */
2158 #endif // KMP_FAST_REDUCTION_BARRIER
2159  bs_last_barrier /* Just a placeholder to mark the end */
2160 };
2161 
2162 // to work with reduction barriers just like with plain barriers
2163 #if !KMP_FAST_REDUCTION_BARRIER
2164 #define bs_reduction_barrier bs_plain_barrier
2165 #endif // KMP_FAST_REDUCTION_BARRIER
2166 
2167 typedef enum kmp_bar_pat { /* Barrier communication patterns */
2168  bp_linear_bar =
2169  0, /* Single level (degenerate) tree */
2170  bp_tree_bar =
2171  1, /* Balanced tree with branching factor 2^n */
2172  bp_hyper_bar = 2, /* Hypercube-embedded tree with min
2173  branching factor 2^n */
2174  bp_hierarchical_bar = 3, /* Machine hierarchy tree */
2175  bp_dist_bar = 4, /* Distributed barrier */
2176  bp_last_bar /* Placeholder to mark the end */
2177 } kmp_bar_pat_e;
2178 
2179 #define KMP_BARRIER_ICV_PUSH 1
2180 
2181 /* Record for holding the values of the internal controls stack records */
2182 typedef struct kmp_internal_control {
2183  int serial_nesting_level; /* corresponds to the value of the
2184  th_team_serialized field */
2185  kmp_int8 dynamic; /* internal control for dynamic adjustment of threads (per
2186  thread) */
2187  kmp_int8
2188  bt_set; /* internal control for whether blocktime is explicitly set */
2189  int blocktime; /* internal control for blocktime */
2190 #if KMP_USE_MONITOR
2191  int bt_intervals; /* internal control for blocktime intervals */
2192 #endif
2193  int nproc; /* internal control for #threads for next parallel region (per
2194  thread) */
2195  int thread_limit; /* internal control for thread-limit-var */
2196  int task_thread_limit; /* internal control for thread-limit-var of a task*/
2197  int max_active_levels; /* internal control for max_active_levels */
2198  kmp_r_sched_t
2199  sched; /* internal control for runtime schedule {sched,chunk} pair */
2200  kmp_proc_bind_t proc_bind; /* internal control for affinity */
2201  kmp_int32 default_device; /* internal control for default device */
2202  struct kmp_internal_control *next;
2203 } kmp_internal_control_t;
2204 
2205 static inline void copy_icvs(kmp_internal_control_t *dst,
2206  kmp_internal_control_t *src) {
2207  *dst = *src;
2208 }
2209 
2210 /* Thread barrier needs volatile barrier fields */
2211 typedef struct KMP_ALIGN_CACHE kmp_bstate {
2212  // th_fixed_icvs is aligned by virtue of kmp_bstate being aligned (and all
2213  // uses of it). It is not explicitly aligned below, because we *don't* want
2214  // it to be padded -- instead, we fit b_go into the same cache line with
2215  // th_fixed_icvs, enabling NGO cache lines stores in the hierarchical barrier.
2216  kmp_internal_control_t th_fixed_icvs; // Initial ICVs for the thread
2217  // Tuck b_go into end of th_fixed_icvs cache line, so it can be stored with
2218  // same NGO store
2219  volatile kmp_uint64 b_go; // STATE => task should proceed (hierarchical)
2220  KMP_ALIGN_CACHE volatile kmp_uint64
2221  b_arrived; // STATE => task reached synch point.
2222  kmp_uint32 *skip_per_level;
2223  kmp_uint32 my_level;
2224  kmp_int32 parent_tid;
2225  kmp_int32 old_tid;
2226  kmp_uint32 depth;
2227  struct kmp_bstate *parent_bar;
2228  kmp_team_t *team;
2229  kmp_uint64 leaf_state;
2230  kmp_uint32 nproc;
2231  kmp_uint8 base_leaf_kids;
2232  kmp_uint8 leaf_kids;
2233  kmp_uint8 offset;
2234  kmp_uint8 wait_flag;
2235  kmp_uint8 use_oncore_barrier;
2236 #if USE_DEBUGGER
2237  // The following field is intended for the debugger solely. Only the worker
2238  // thread itself accesses this field: the worker increases it by 1 when it
2239  // arrives to a barrier.
2240  KMP_ALIGN_CACHE kmp_uint b_worker_arrived;
2241 #endif /* USE_DEBUGGER */
2242 } kmp_bstate_t;
2243 
2244 union KMP_ALIGN_CACHE kmp_barrier_union {
2245  double b_align; /* use worst case alignment */
2246  char b_pad[KMP_PAD(kmp_bstate_t, CACHE_LINE)];
2247  kmp_bstate_t bb;
2248 };
2249 
2250 typedef union kmp_barrier_union kmp_balign_t;
2251 
2252 /* Team barrier needs only non-volatile arrived counter */
2253 union KMP_ALIGN_CACHE kmp_barrier_team_union {
2254  double b_align; /* use worst case alignment */
2255  char b_pad[CACHE_LINE];
2256  struct {
2257  kmp_uint64 b_arrived; /* STATE => task reached synch point. */
2258 #if USE_DEBUGGER
2259  // The following two fields are indended for the debugger solely. Only
2260  // primary thread of the team accesses these fields: the first one is
2261  // increased by 1 when the primary thread arrives to a barrier, the second
2262  // one is increased by one when all the threads arrived.
2263  kmp_uint b_master_arrived;
2264  kmp_uint b_team_arrived;
2265 #endif
2266  };
2267 };
2268 
2269 typedef union kmp_barrier_team_union kmp_balign_team_t;
2270 
2271 /* Padding for Linux* OS pthreads condition variables and mutexes used to signal
2272  threads when a condition changes. This is to workaround an NPTL bug where
2273  padding was added to pthread_cond_t which caused the initialization routine
2274  to write outside of the structure if compiled on pre-NPTL threads. */
2275 #if KMP_OS_WINDOWS
2276 typedef struct kmp_win32_mutex {
2277  /* The Lock */
2278  CRITICAL_SECTION cs;
2279 } kmp_win32_mutex_t;
2280 
2281 typedef struct kmp_win32_cond {
2282  /* Count of the number of waiters. */
2283  int waiters_count_;
2284 
2285  /* Serialize access to <waiters_count_> */
2286  kmp_win32_mutex_t waiters_count_lock_;
2287 
2288  /* Number of threads to release via a <cond_broadcast> or a <cond_signal> */
2289  int release_count_;
2290 
2291  /* Keeps track of the current "generation" so that we don't allow */
2292  /* one thread to steal all the "releases" from the broadcast. */
2293  int wait_generation_count_;
2294 
2295  /* A manual-reset event that's used to block and release waiting threads. */
2296  HANDLE event_;
2297 } kmp_win32_cond_t;
2298 #endif
2299 
2300 #if KMP_OS_UNIX
2301 
2302 union KMP_ALIGN_CACHE kmp_cond_union {
2303  double c_align;
2304  char c_pad[CACHE_LINE];
2305  pthread_cond_t c_cond;
2306 };
2307 
2308 typedef union kmp_cond_union kmp_cond_align_t;
2309 
2310 union KMP_ALIGN_CACHE kmp_mutex_union {
2311  double m_align;
2312  char m_pad[CACHE_LINE];
2313  pthread_mutex_t m_mutex;
2314 };
2315 
2316 typedef union kmp_mutex_union kmp_mutex_align_t;
2317 
2318 #endif /* KMP_OS_UNIX */
2319 
2320 typedef struct kmp_desc_base {
2321  void *ds_stackbase;
2322  size_t ds_stacksize;
2323  int ds_stackgrow;
2324  kmp_thread_t ds_thread;
2325  volatile int ds_tid;
2326  int ds_gtid;
2327 #if KMP_OS_WINDOWS
2328  volatile int ds_alive;
2329  DWORD ds_thread_id;
2330 /* ds_thread keeps thread handle on Windows* OS. It is enough for RTL purposes.
2331  However, debugger support (libomp_db) cannot work with handles, because they
2332  uncomparable. For example, debugger requests info about thread with handle h.
2333  h is valid within debugger process, and meaningless within debugee process.
2334  Even if h is duped by call to DuplicateHandle(), so the result h' is valid
2335  within debugee process, but it is a *new* handle which does *not* equal to
2336  any other handle in debugee... The only way to compare handles is convert
2337  them to system-wide ids. GetThreadId() function is available only in
2338  Longhorn and Server 2003. :-( In contrast, GetCurrentThreadId() is available
2339  on all Windows* OS flavours (including Windows* 95). Thus, we have to get
2340  thread id by call to GetCurrentThreadId() from within the thread and save it
2341  to let libomp_db identify threads. */
2342 #endif /* KMP_OS_WINDOWS */
2343 } kmp_desc_base_t;
2344 
2345 typedef union KMP_ALIGN_CACHE kmp_desc {
2346  double ds_align; /* use worst case alignment */
2347  char ds_pad[KMP_PAD(kmp_desc_base_t, CACHE_LINE)];
2348  kmp_desc_base_t ds;
2349 } kmp_desc_t;
2350 
2351 typedef struct kmp_local {
2352  volatile int this_construct; /* count of single's encountered by thread */
2353  void *reduce_data;
2354 #if KMP_USE_BGET
2355  void *bget_data;
2356  void *bget_list;
2357 #if !USE_CMP_XCHG_FOR_BGET
2358 #ifdef USE_QUEUING_LOCK_FOR_BGET
2359  kmp_lock_t bget_lock; /* Lock for accessing bget free list */
2360 #else
2361  kmp_bootstrap_lock_t bget_lock; // Lock for accessing bget free list. Must be
2362 // bootstrap lock so we can use it at library
2363 // shutdown.
2364 #endif /* USE_LOCK_FOR_BGET */
2365 #endif /* ! USE_CMP_XCHG_FOR_BGET */
2366 #endif /* KMP_USE_BGET */
2367 
2368  PACKED_REDUCTION_METHOD_T
2369  packed_reduction_method; /* stored by __kmpc_reduce*(), used by
2370  __kmpc_end_reduce*() */
2371 
2372 } kmp_local_t;
2373 
2374 #define KMP_CHECK_UPDATE(a, b) \
2375  if ((a) != (b)) \
2376  (a) = (b)
2377 #define KMP_CHECK_UPDATE_SYNC(a, b) \
2378  if ((a) != (b)) \
2379  TCW_SYNC_PTR((a), (b))
2380 
2381 #define get__blocktime(xteam, xtid) \
2382  ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.blocktime)
2383 #define get__bt_set(xteam, xtid) \
2384  ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_set)
2385 #if KMP_USE_MONITOR
2386 #define get__bt_intervals(xteam, xtid) \
2387  ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_intervals)
2388 #endif
2389 
2390 #define get__dynamic_2(xteam, xtid) \
2391  ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.dynamic)
2392 #define get__nproc_2(xteam, xtid) \
2393  ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.nproc)
2394 #define get__sched_2(xteam, xtid) \
2395  ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.sched)
2396 
2397 #define set__blocktime_team(xteam, xtid, xval) \
2398  (((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.blocktime) = \
2399  (xval))
2400 
2401 #if KMP_USE_MONITOR
2402 #define set__bt_intervals_team(xteam, xtid, xval) \
2403  (((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_intervals) = \
2404  (xval))
2405 #endif
2406 
2407 #define set__bt_set_team(xteam, xtid, xval) \
2408  (((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_set) = (xval))
2409 
2410 #define set__dynamic(xthread, xval) \
2411  (((xthread)->th.th_current_task->td_icvs.dynamic) = (xval))
2412 #define get__dynamic(xthread) \
2413  (((xthread)->th.th_current_task->td_icvs.dynamic) ? (FTN_TRUE) : (FTN_FALSE))
2414 
2415 #define set__nproc(xthread, xval) \
2416  (((xthread)->th.th_current_task->td_icvs.nproc) = (xval))
2417 
2418 #define set__thread_limit(xthread, xval) \
2419  (((xthread)->th.th_current_task->td_icvs.thread_limit) = (xval))
2420 
2421 #define set__max_active_levels(xthread, xval) \
2422  (((xthread)->th.th_current_task->td_icvs.max_active_levels) = (xval))
2423 
2424 #define get__max_active_levels(xthread) \
2425  ((xthread)->th.th_current_task->td_icvs.max_active_levels)
2426 
2427 #define set__sched(xthread, xval) \
2428  (((xthread)->th.th_current_task->td_icvs.sched) = (xval))
2429 
2430 #define set__proc_bind(xthread, xval) \
2431  (((xthread)->th.th_current_task->td_icvs.proc_bind) = (xval))
2432 #define get__proc_bind(xthread) \
2433  ((xthread)->th.th_current_task->td_icvs.proc_bind)
2434 
2435 // OpenMP tasking data structures
2436 
2437 typedef enum kmp_tasking_mode {
2438  tskm_immediate_exec = 0,
2439  tskm_extra_barrier = 1,
2440  tskm_task_teams = 2,
2441  tskm_max = 2
2442 } kmp_tasking_mode_t;
2443 
2444 extern kmp_tasking_mode_t
2445  __kmp_tasking_mode; /* determines how/when to execute tasks */
2446 extern int __kmp_task_stealing_constraint;
2447 extern int __kmp_enable_task_throttling;
2448 extern kmp_int32 __kmp_default_device; // Set via OMP_DEFAULT_DEVICE if
2449 // specified, defaults to 0 otherwise
2450 // Set via OMP_MAX_TASK_PRIORITY if specified, defaults to 0 otherwise
2451 extern kmp_int32 __kmp_max_task_priority;
2452 // Set via KMP_TASKLOOP_MIN_TASKS if specified, defaults to 0 otherwise
2453 extern kmp_uint64 __kmp_taskloop_min_tasks;
2454 
2455 /* NOTE: kmp_taskdata_t and kmp_task_t structures allocated in single block with
2456  taskdata first */
2457 #define KMP_TASK_TO_TASKDATA(task) (((kmp_taskdata_t *)task) - 1)
2458 #define KMP_TASKDATA_TO_TASK(taskdata) (kmp_task_t *)(taskdata + 1)
2459 
2460 // The tt_found_tasks flag is a signal to all threads in the team that tasks
2461 // were spawned and queued since the previous barrier release.
2462 #define KMP_TASKING_ENABLED(task_team) \
2463  (TRUE == TCR_SYNC_4((task_team)->tt.tt_found_tasks))
2471 typedef kmp_int32 (*kmp_routine_entry_t)(kmp_int32, void *);
2472 
2473 typedef union kmp_cmplrdata {
2474  kmp_int32 priority;
2475  kmp_routine_entry_t
2476  destructors; /* pointer to function to invoke deconstructors of
2477  firstprivate C++ objects */
2478  /* future data */
2479 } kmp_cmplrdata_t;
2480 
2481 /* sizeof_kmp_task_t passed as arg to kmpc_omp_task call */
2484 typedef struct kmp_task { /* GEH: Shouldn't this be aligned somehow? */
2485  void *shareds;
2486  kmp_routine_entry_t
2487  routine;
2488  kmp_int32 part_id;
2489  kmp_cmplrdata_t
2490  data1; /* Two known optional additions: destructors and priority */
2491  kmp_cmplrdata_t data2; /* Process destructors first, priority second */
2492  /* future data */
2493  /* private vars */
2494 } kmp_task_t;
2495 
2500 typedef struct kmp_taskgroup {
2501  std::atomic<kmp_int32> count; // number of allocated and incomplete tasks
2502  std::atomic<kmp_int32>
2503  cancel_request; // request for cancellation of this taskgroup
2504  struct kmp_taskgroup *parent; // parent taskgroup
2505  // Block of data to perform task reduction
2506  void *reduce_data; // reduction related info
2507  kmp_int32 reduce_num_data; // number of data items to reduce
2508  uintptr_t *gomp_data; // gomp reduction data
2509 } kmp_taskgroup_t;
2510 
2511 // forward declarations
2512 typedef union kmp_depnode kmp_depnode_t;
2513 typedef struct kmp_depnode_list kmp_depnode_list_t;
2514 typedef struct kmp_dephash_entry kmp_dephash_entry_t;
2515 
2516 // macros for checking dep flag as an integer
2517 #define KMP_DEP_IN 0x1
2518 #define KMP_DEP_OUT 0x2
2519 #define KMP_DEP_INOUT 0x3
2520 #define KMP_DEP_MTX 0x4
2521 #define KMP_DEP_SET 0x8
2522 #define KMP_DEP_ALL 0x80
2523 // Compiler sends us this info. Note: some test cases contain an explicit copy
2524 // of this struct and should be in sync with any changes here.
2525 typedef struct kmp_depend_info {
2526  kmp_intptr_t base_addr;
2527  size_t len;
2528  union {
2529  kmp_uint8 flag; // flag as an unsigned char
2530  struct { // flag as a set of 8 bits
2531 #if defined(__BYTE_ORDER__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
2532  /* Same fields as in the #else branch, but in reverse order */
2533  unsigned all : 1;
2534  unsigned unused : 3;
2535  unsigned set : 1;
2536  unsigned mtx : 1;
2537  unsigned out : 1;
2538  unsigned in : 1;
2539 #else
2540  unsigned in : 1;
2541  unsigned out : 1;
2542  unsigned mtx : 1;
2543  unsigned set : 1;
2544  unsigned unused : 3;
2545  unsigned all : 1;
2546 #endif
2547  } flags;
2548  };
2549 } kmp_depend_info_t;
2550 
2551 // Internal structures to work with task dependencies:
2552 struct kmp_depnode_list {
2553  kmp_depnode_t *node;
2554  kmp_depnode_list_t *next;
2555 };
2556 
2557 // Max number of mutexinoutset dependencies per node
2558 #define MAX_MTX_DEPS 4
2559 
2560 typedef struct kmp_base_depnode {
2561  kmp_depnode_list_t *successors; /* used under lock */
2562  kmp_task_t *task; /* non-NULL if depnode is active, used under lock */
2563  kmp_lock_t *mtx_locks[MAX_MTX_DEPS]; /* lock mutexinoutset dependent tasks */
2564  kmp_int32 mtx_num_locks; /* number of locks in mtx_locks array */
2565  kmp_lock_t lock; /* guards shared fields: task, successors */
2566 #if KMP_SUPPORT_GRAPH_OUTPUT
2567  kmp_uint32 id;
2568 #endif
2569  std::atomic<kmp_int32> npredecessors;
2570  std::atomic<kmp_int32> nrefs;
2571 } kmp_base_depnode_t;
2572 
2573 union KMP_ALIGN_CACHE kmp_depnode {
2574  double dn_align; /* use worst case alignment */
2575  char dn_pad[KMP_PAD(kmp_base_depnode_t, CACHE_LINE)];
2576  kmp_base_depnode_t dn;
2577 };
2578 
2579 struct kmp_dephash_entry {
2580  kmp_intptr_t addr;
2581  kmp_depnode_t *last_out;
2582  kmp_depnode_list_t *last_set;
2583  kmp_depnode_list_t *prev_set;
2584  kmp_uint8 last_flag;
2585  kmp_lock_t *mtx_lock; /* is referenced by depnodes w/mutexinoutset dep */
2586  kmp_dephash_entry_t *next_in_bucket;
2587 };
2588 
2589 typedef struct kmp_dephash {
2590  kmp_dephash_entry_t **buckets;
2591  size_t size;
2592  kmp_depnode_t *last_all;
2593  size_t generation;
2594  kmp_uint32 nelements;
2595  kmp_uint32 nconflicts;
2596 } kmp_dephash_t;
2597 
2598 typedef struct kmp_task_affinity_info {
2599  kmp_intptr_t base_addr;
2600  size_t len;
2601  struct {
2602  bool flag1 : 1;
2603  bool flag2 : 1;
2604  kmp_int32 reserved : 30;
2605  } flags;
2606 } kmp_task_affinity_info_t;
2607 
2608 typedef enum kmp_event_type_t {
2609  KMP_EVENT_UNINITIALIZED = 0,
2610  KMP_EVENT_ALLOW_COMPLETION = 1
2611 } kmp_event_type_t;
2612 
2613 typedef struct {
2614  kmp_event_type_t type;
2615  kmp_tas_lock_t lock;
2616  union {
2617  kmp_task_t *task;
2618  } ed;
2619 } kmp_event_t;
2620 
2621 #if OMP_TASKGRAPH_EXPERIMENTAL
2622 // Initial number of allocated nodes while recording
2623 #define INIT_MAPSIZE 50
2624 
2625 typedef struct kmp_taskgraph_flags { /*This needs to be exactly 32 bits */
2626  unsigned nowait : 1;
2627  unsigned re_record : 1;
2628  unsigned reserved : 30;
2629 } kmp_taskgraph_flags_t;
2630 
2632 typedef struct kmp_node_info {
2633  kmp_task_t *task; // Pointer to the actual task
2634  kmp_int32 *successors; // Array of the succesors ids
2635  kmp_int32 nsuccessors; // Number of succesors of the node
2636  std::atomic<kmp_int32>
2637  npredecessors_counter; // Number of predessors on the fly
2638  kmp_int32 npredecessors; // Total number of predecessors
2639  kmp_int32 successors_size; // Number of allocated succesors ids
2640  kmp_taskdata_t *parent_task; // Parent implicit task
2641 } kmp_node_info_t;
2642 
2644 typedef enum kmp_tdg_status {
2645  KMP_TDG_NONE = 0,
2646  KMP_TDG_RECORDING = 1,
2647  KMP_TDG_READY = 2
2648 } kmp_tdg_status_t;
2649 
2651 typedef struct kmp_tdg_info {
2652  kmp_int32 tdg_id; // Unique idenfifier of the TDG
2653  kmp_taskgraph_flags_t tdg_flags; // Flags related to a TDG
2654  kmp_int32 map_size; // Number of allocated TDG nodes
2655  kmp_int32 num_roots; // Number of roots tasks int the TDG
2656  kmp_int32 *root_tasks; // Array of tasks identifiers that are roots
2657  kmp_node_info_t *record_map; // Array of TDG nodes
2658  kmp_tdg_status_t tdg_status =
2659  KMP_TDG_NONE; // Status of the TDG (recording, ready...)
2660  std::atomic<kmp_int32> num_tasks; // Number of TDG nodes
2661  kmp_bootstrap_lock_t
2662  graph_lock; // Protect graph attributes when updated via taskloop_recur
2663  // Taskloop reduction related
2664  void *rec_taskred_data; // Data to pass to __kmpc_task_reduction_init or
2665  // __kmpc_taskred_init
2666  kmp_int32 rec_num_taskred;
2667 } kmp_tdg_info_t;
2668 
2669 extern int __kmp_tdg_dot;
2670 extern kmp_int32 __kmp_max_tdgs;
2671 extern kmp_tdg_info_t **__kmp_global_tdgs;
2672 extern kmp_int32 __kmp_curr_tdg_idx;
2673 extern kmp_int32 __kmp_successors_size;
2674 extern std::atomic<kmp_int32> __kmp_tdg_task_id;
2675 extern kmp_int32 __kmp_num_tdg;
2676 #endif
2677 
2678 typedef struct kmp_tasking_flags { /* Total struct must be exactly 32 bits */
2679 #if defined(__BYTE_ORDER__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
2680  /* Same fields as in the #else branch, but in reverse order */
2681 #if OMP_TASKGRAPH_EXPERIMENTAL
2682  unsigned reserved31 : 4;
2683  unsigned onced : 1;
2684 #else
2685  unsigned reserved31 : 5;
2686 #endif
2687  unsigned hidden_helper : 1;
2688  unsigned target : 1;
2689  unsigned native : 1;
2690  unsigned freed : 1;
2691  unsigned complete : 1;
2692  unsigned executing : 1;
2693  unsigned started : 1;
2694  unsigned team_serial : 1;
2695  unsigned tasking_ser : 1;
2696  unsigned task_serial : 1;
2697  unsigned tasktype : 1;
2698  unsigned reserved : 7;
2699  unsigned transparent : 1;
2700  unsigned free_agent_eligible : 1;
2701  unsigned detachable : 1;
2702  unsigned priority_specified : 1;
2703  unsigned proxy : 1;
2704  unsigned destructors_thunk : 1;
2705  unsigned merged_if0 : 1;
2706  unsigned final : 1;
2707  unsigned tiedness : 1;
2708 #else
2709  /* Compiler flags */ /* Total compiler flags must be 16 bits */
2710  unsigned tiedness : 1; /* task is either tied (1) or untied (0) */
2711  unsigned final : 1; /* task is final(1) so execute immediately */
2712  unsigned merged_if0 : 1; /* no __kmpc_task_{begin/complete}_if0 calls in if0
2713  code path */
2714  unsigned destructors_thunk : 1; /* set if the compiler creates a thunk to
2715  invoke destructors from the runtime */
2716  unsigned proxy : 1; /* task is a proxy task (it will be executed outside the
2717  context of the RTL) */
2718  unsigned priority_specified : 1; /* set if the compiler provides priority
2719  setting for the task */
2720  unsigned detachable : 1; /* 1 == can detach */
2721  unsigned free_agent_eligible : 1; /* set if task can be executed by a
2722  free-agent thread */
2723  unsigned transparent : 1; /* transparent task support (compiler uses this) */
2724  unsigned reserved : 7; /* reserved for compiler use */
2725 
2726  /* Library flags */ /* Total library flags must be 16 bits */
2727  unsigned tasktype : 1; /* task is either explicit(1) or implicit (0) */
2728  unsigned task_serial : 1; // task is executed immediately (1) or deferred (0)
2729  unsigned tasking_ser : 1; // all tasks in team are either executed immediately
2730  // (1) or may be deferred (0)
2731  unsigned team_serial : 1; // entire team is serial (1) [1 thread] or parallel
2732  // (0) [>= 2 threads]
2733  /* If either team_serial or tasking_ser is set, task team may be NULL */
2734  /* Task State Flags: */
2735  unsigned started : 1; /* 1==started, 0==not started */
2736  unsigned executing : 1; /* 1==executing, 0==not executing */
2737  unsigned complete : 1; /* 1==complete, 0==not complete */
2738  unsigned freed : 1; /* 1==freed, 0==allocated */
2739  unsigned native : 1; /* 1==gcc-compiled task, 0==intel */
2740  unsigned target : 1;
2741  unsigned hidden_helper : 1; /* 1 == hidden helper task */
2742 #if OMP_TASKGRAPH_EXPERIMENTAL
2743  unsigned onced : 1; /* 1==ran once already, 0==never ran, record & replay purposes */
2744  unsigned reserved31 : 4; /* reserved for library use */
2745 #else
2746  unsigned reserved31 : 5; /* reserved for library use */
2747 #endif
2748 #endif
2749 } kmp_tasking_flags_t;
2750 
2751 typedef struct kmp_target_data {
2752  void *async_handle; // libomptarget async handle for task completion query
2753 } kmp_target_data_t;
2754 
2755 struct kmp_taskdata { /* aligned during dynamic allocation */
2756  kmp_int32 td_task_id; /* id, assigned by debugger */
2757  kmp_tasking_flags_t td_flags; /* task flags */
2758  kmp_team_t *td_team; /* team for this task */
2759  kmp_info_p *td_alloc_thread; /* thread that allocated data structures */
2760  /* Currently not used except for perhaps IDB */
2761  kmp_taskdata_t *td_parent; /* parent task */
2762  kmp_int32 td_level; /* task nesting level */
2763  std::atomic<kmp_int32> td_untied_count; // untied task active parts counter
2764  ident_t *td_ident; /* task identifier */
2765  // Taskwait data.
2766  ident_t *td_taskwait_ident;
2767  kmp_uint32 td_taskwait_counter;
2768  kmp_int32 td_taskwait_thread; /* gtid + 1 of thread encountered taskwait */
2769  KMP_ALIGN_CACHE kmp_internal_control_t
2770  td_icvs; /* Internal control variables for the task */
2771  KMP_ALIGN_CACHE std::atomic<kmp_int32>
2772  td_allocated_child_tasks; /* Child tasks (+ current task) not yet
2773  deallocated */
2774  std::atomic<kmp_int32>
2775  td_incomplete_child_tasks; /* Child tasks not yet complete */
2776  kmp_taskgroup_t
2777  *td_taskgroup; // Each task keeps pointer to its current taskgroup
2778  kmp_dephash_t
2779  *td_dephash; // Dependencies for children tasks are tracked from here
2780  kmp_depnode_t
2781  *td_depnode; // Pointer to graph node if this task has dependencies
2782  kmp_task_team_t *td_task_team;
2783  size_t td_size_alloc; // Size of task structure, including shareds etc.
2784 #if defined(KMP_GOMP_COMPAT)
2785  // 4 or 8 byte integers for the loop bounds in GOMP_taskloop
2786  kmp_int32 td_size_loop_bounds;
2787 #endif
2788  kmp_taskdata_t *td_last_tied; // keep tied task for task scheduling constraint
2789 #if defined(KMP_GOMP_COMPAT)
2790  // GOMP sends in a copy function for copy constructors
2791  void (*td_copy_func)(void *, void *);
2792 #endif
2793  kmp_event_t td_allow_completion_event;
2794 #if OMPT_SUPPORT
2795  ompt_task_info_t ompt_task_info;
2796 #endif
2797 #if OMP_TASKGRAPH_EXPERIMENTAL
2798  bool is_taskgraph = 0; // whether the task is within a TDG
2799  kmp_tdg_info_t *tdg; // used to associate task with a TDG
2800  kmp_int32 td_tdg_task_id; // local task id in its TDG
2801 #endif
2802  kmp_target_data_t td_target_data;
2803 }; // struct kmp_taskdata
2804 
2805 // Make sure padding above worked
2806 KMP_BUILD_ASSERT(sizeof(kmp_taskdata_t) % sizeof(void *) == 0);
2807 
2808 // Data for task team but per thread
2809 typedef struct kmp_base_thread_data {
2810  kmp_info_p *td_thr; // Pointer back to thread info
2811  // Used only in __kmp_execute_tasks_template, maybe not avail until task is
2812  // queued?
2813  kmp_bootstrap_lock_t td_deque_lock; // Lock for accessing deque
2814  kmp_taskdata_t *
2815  *td_deque; // Deque of tasks encountered by td_thr, dynamically allocated
2816  kmp_int32 td_deque_size; // Size of deck
2817  kmp_uint32 td_deque_head; // Head of deque (will wrap)
2818  kmp_uint32 td_deque_tail; // Tail of deque (will wrap)
2819  kmp_int32 td_deque_ntasks; // Number of tasks in deque
2820  // GEH: shouldn't this be volatile since used in while-spin?
2821  kmp_int32 td_deque_last_stolen; // Thread number of last successful steal
2822 } kmp_base_thread_data_t;
2823 
2824 #define TASK_DEQUE_BITS 8 // Used solely to define INITIAL_TASK_DEQUE_SIZE
2825 #define INITIAL_TASK_DEQUE_SIZE (1 << TASK_DEQUE_BITS)
2826 
2827 #define TASK_DEQUE_SIZE(td) ((td).td_deque_size)
2828 #define TASK_DEQUE_MASK(td) ((td).td_deque_size - 1)
2829 
2830 typedef union KMP_ALIGN_CACHE kmp_thread_data {
2831  kmp_base_thread_data_t td;
2832  double td_align; /* use worst case alignment */
2833  char td_pad[KMP_PAD(kmp_base_thread_data_t, CACHE_LINE)];
2834 } kmp_thread_data_t;
2835 
2836 typedef struct kmp_task_pri {
2837  kmp_thread_data_t td;
2838  kmp_int32 priority;
2839  kmp_task_pri *next;
2840 } kmp_task_pri_t;
2841 
2842 // Data for task teams which are used when tasking is enabled for the team
2843 typedef struct kmp_base_task_team {
2844  kmp_bootstrap_lock_t
2845  tt_threads_lock; /* Lock used to allocate per-thread part of task team */
2846  /* must be bootstrap lock since used at library shutdown*/
2847 
2848  // TODO: check performance vs kmp_tas_lock_t
2849  kmp_bootstrap_lock_t tt_task_pri_lock; /* Lock to access priority tasks */
2850  kmp_task_pri_t *tt_task_pri_list;
2851 
2852  kmp_task_team_t *tt_next; /* For linking the task team free list */
2853  kmp_thread_data_t
2854  *tt_threads_data; /* Array of per-thread structures for task team */
2855  /* Data survives task team deallocation */
2856  kmp_int32 tt_found_tasks; /* Have we found tasks and queued them while
2857  executing this team? */
2858  /* TRUE means tt_threads_data is set up and initialized */
2859  kmp_int32 tt_nproc; /* #threads in team */
2860  kmp_int32 tt_max_threads; // # entries allocated for threads_data array
2861  kmp_int32 tt_found_proxy_tasks; // found proxy tasks since last barrier
2862  kmp_int32 tt_untied_task_encountered;
2863  std::atomic<kmp_int32> tt_num_task_pri; // number of priority tasks enqueued
2864  // There is hidden helper thread encountered in this task team so that we must
2865  // wait when waiting on task team
2866  kmp_int32 tt_hidden_helper_task_encountered;
2867 
2868  KMP_ALIGN_CACHE
2869  std::atomic<kmp_int32> tt_unfinished_threads; /* #threads still active */
2870 
2871  KMP_ALIGN_CACHE
2872  volatile kmp_uint32
2873  tt_active; /* is the team still actively executing tasks */
2874 } kmp_base_task_team_t;
2875 
2876 union KMP_ALIGN_CACHE kmp_task_team {
2877  kmp_base_task_team_t tt;
2878  double tt_align; /* use worst case alignment */
2879  char tt_pad[KMP_PAD(kmp_base_task_team_t, CACHE_LINE)];
2880 };
2881 
2882 typedef struct kmp_task_team_list_t {
2883  kmp_task_team_t *task_team;
2884  kmp_task_team_list_t *next;
2885 } kmp_task_team_list_t;
2886 
2887 #if (USE_FAST_MEMORY == 3) || (USE_FAST_MEMORY == 5)
2888 // Free lists keep same-size free memory slots for fast memory allocation
2889 // routines
2890 typedef struct kmp_free_list {
2891  void *th_free_list_self; // Self-allocated tasks free list
2892  void *th_free_list_sync; // Self-allocated tasks stolen/returned by other
2893  // threads
2894  void *th_free_list_other; // Non-self free list (to be returned to owner's
2895  // sync list)
2896 } kmp_free_list_t;
2897 #endif
2898 // Hot teams array keeps hot teams and their sizes for given thread. Hot teams
2899 // are not put in teams pool, and they don't put threads in threads pool.
2900 typedef struct kmp_hot_team_ptr {
2901  kmp_team_p *hot_team; // pointer to hot_team of given nesting level
2902  kmp_int32 hot_team_nth; // number of threads allocated for the hot_team
2903 } kmp_hot_team_ptr_t;
2904 typedef struct kmp_teams_size {
2905  kmp_int32 nteams; // number of teams in a league
2906  kmp_int32 nth; // number of threads in each team of the league
2907 } kmp_teams_size_t;
2908 
2909 // This struct stores a thread that acts as a "root" for a contention
2910 // group. Contention groups are rooted at kmp_root threads, but also at
2911 // each primary thread of each team created in the teams construct.
2912 // This struct therefore also stores a thread_limit associated with
2913 // that contention group, and a counter to track the number of threads
2914 // active in that contention group. Each thread has a list of these: CG
2915 // root threads have an entry in their list in which cg_root refers to
2916 // the thread itself, whereas other workers in the CG will have a
2917 // single entry where cg_root is same as the entry containing their CG
2918 // root. When a thread encounters a teams construct, it will add a new
2919 // entry to the front of its list, because it now roots a new CG.
2920 typedef struct kmp_cg_root {
2921  kmp_info_p *cg_root; // "root" thread for a contention group
2922  // The CG root's limit comes from OMP_THREAD_LIMIT for root threads, or
2923  // thread_limit clause for teams primary threads
2924  kmp_int32 cg_thread_limit;
2925  kmp_int32 cg_nthreads; // Count of active threads in CG rooted at cg_root
2926  struct kmp_cg_root *up; // pointer to higher level CG root in list
2927 } kmp_cg_root_t;
2928 
2929 // OpenMP thread data structures
2930 
2931 typedef struct KMP_ALIGN_CACHE kmp_base_info {
2932  /* Start with the readonly data which is cache aligned and padded. This is
2933  written before the thread starts working by the primary thread. Uber
2934  masters may update themselves later. Usage does not consider serialized
2935  regions. */
2936  kmp_desc_t th_info;
2937  kmp_team_p *th_team; /* team we belong to */
2938  kmp_root_p *th_root; /* pointer to root of task hierarchy */
2939  kmp_info_p *th_next_pool; /* next available thread in the pool */
2940  kmp_disp_t *th_dispatch; /* thread's dispatch data */
2941  int th_in_pool; /* in thread pool (32 bits for TCR/TCW) */
2942 
2943  /* The following are cached from the team info structure */
2944  /* TODO use these in more places as determined to be needed via profiling */
2945  int th_team_nproc; /* number of threads in a team */
2946  kmp_info_p *th_team_master; /* the team's primary thread */
2947  int th_team_serialized; /* team is serialized */
2948  microtask_t th_teams_microtask; /* save entry address for teams construct */
2949  int th_teams_level; /* save initial level of teams construct */
2950 /* it is 0 on device but may be any on host */
2951 
2952 /* The blocktime info is copied from the team struct to the thread struct */
2953 /* at the start of a barrier, and the values stored in the team are used */
2954 /* at points in the code where the team struct is no longer guaranteed */
2955 /* to exist (from the POV of worker threads). */
2956 #if KMP_USE_MONITOR
2957  int th_team_bt_intervals;
2958  int th_team_bt_set;
2959 #else
2960  kmp_uint64 th_team_bt_intervals;
2961 #endif
2962 
2963 #if KMP_AFFINITY_SUPPORTED
2964  kmp_affin_mask_t *th_affin_mask; /* thread's current affinity mask */
2965  kmp_affinity_ids_t th_topology_ids; /* thread's current topology ids */
2966  kmp_affinity_attrs_t th_topology_attrs; /* thread's current topology attrs */
2967 #endif
2968  omp_allocator_handle_t th_def_allocator; /* default allocator */
2969  /* The data set by the primary thread at reinit, then R/W by the worker */
2970  KMP_ALIGN_CACHE int
2971  th_set_nproc; /* if > 0, then only use this request for the next fork */
2972  int *th_set_nested_nth;
2973  bool th_nt_strict; // num_threads clause has strict modifier
2974  ident_t *th_nt_loc; // loc for strict modifier
2975  int th_nt_sev; // error severity for strict modifier
2976  const char *th_nt_msg; // error message for strict modifier
2977  int th_set_nested_nth_sz;
2978  kmp_hot_team_ptr_t *th_hot_teams; /* array of hot teams */
2979  kmp_proc_bind_t
2980  th_set_proc_bind; /* if != proc_bind_default, use request for next fork */
2981  kmp_teams_size_t
2982  th_teams_size; /* number of teams/threads in teams construct */
2983 #if KMP_AFFINITY_SUPPORTED
2984  int th_current_place; /* place currently bound to */
2985  int th_new_place; /* place to bind to in par reg */
2986  int th_first_place; /* first place in partition */
2987  int th_last_place; /* last place in partition */
2988 #endif
2989  int th_prev_level; /* previous level for affinity format */
2990  int th_prev_num_threads; /* previous num_threads for affinity format */
2991 #if USE_ITT_BUILD
2992  kmp_uint64 th_bar_arrive_time; /* arrival to barrier timestamp */
2993  kmp_uint64 th_bar_min_time; /* minimum arrival time at the barrier */
2994  kmp_uint64 th_frame_time; /* frame timestamp */
2995 #endif /* USE_ITT_BUILD */
2996  kmp_local_t th_local;
2997  struct private_common *th_pri_head;
2998 
2999  /* Now the data only used by the worker (after initial allocation) */
3000  /* TODO the first serial team should actually be stored in the info_t
3001  structure. this will help reduce initial allocation overhead */
3002  KMP_ALIGN_CACHE kmp_team_p
3003  *th_serial_team; /*serialized team held in reserve*/
3004 
3005 #if OMPT_SUPPORT
3006  ompt_thread_info_t ompt_thread_info;
3007 #endif
3008 
3009  /* The following are also read by the primary thread during reinit */
3010  struct common_table *th_pri_common;
3011 
3012  volatile kmp_uint32 th_spin_here; /* thread-local location for spinning */
3013  /* while awaiting queuing lock acquire */
3014 
3015  volatile void *th_sleep_loc; // this points at a kmp_flag<T>
3016  flag_type th_sleep_loc_type; // enum type of flag stored in th_sleep_loc
3017 
3018  ident_t *th_ident;
3019  unsigned th_x; // Random number generator data
3020  unsigned th_a; // Random number generator data
3021 
3022  /* Tasking-related data for the thread */
3023  kmp_task_team_t *th_task_team; // Task team struct
3024  kmp_taskdata_t *th_current_task; // Innermost Task being executed
3025  kmp_uint8 th_task_state; // alternating 0/1 for task team identification
3026  kmp_uint32 th_reap_state; // Non-zero indicates thread is not
3027  // tasking, thus safe to reap
3028 
3029  /* More stuff for keeping track of active/sleeping threads (this part is
3030  written by the worker thread) */
3031  kmp_uint8 th_active_in_pool; // included in count of #active threads in pool
3032  int th_active; // ! sleeping; 32 bits for TCR/TCW
3033  std::atomic<kmp_uint32> th_used_in_team; // Flag indicating use in team
3034  // 0 = not used in team; 1 = used in team;
3035  // 2 = transitioning to not used in team; 3 = transitioning to used in team
3036  struct cons_header *th_cons; // used for consistency check
3037 #if KMP_USE_HIER_SCHED
3038  // used for hierarchical scheduling
3039  kmp_hier_private_bdata_t *th_hier_bar_data;
3040 #endif
3041 
3042  /* Add the syncronizing data which is cache aligned and padded. */
3043  KMP_ALIGN_CACHE kmp_balign_t th_bar[bs_last_barrier];
3044 
3045  KMP_ALIGN_CACHE volatile kmp_int32
3046  th_next_waiting; /* gtid+1 of next thread on lock wait queue, 0 if none */
3047 
3048 #if (USE_FAST_MEMORY == 3) || (USE_FAST_MEMORY == 5)
3049 #define NUM_LISTS 4
3050  kmp_free_list_t th_free_lists[NUM_LISTS]; // Free lists for fast memory
3051 // allocation routines
3052 #endif
3053 
3054 #if KMP_OS_WINDOWS
3055  kmp_win32_cond_t th_suspend_cv;
3056  kmp_win32_mutex_t th_suspend_mx;
3057  std::atomic<int> th_suspend_init;
3058 #endif
3059 #if KMP_OS_UNIX
3060  kmp_cond_align_t th_suspend_cv;
3061  kmp_mutex_align_t th_suspend_mx;
3062  std::atomic<int> th_suspend_init_count;
3063 #endif
3064 
3065 #if USE_ITT_BUILD
3066  kmp_itt_mark_t th_itt_mark_single;
3067 // alignment ???
3068 #endif /* USE_ITT_BUILD */
3069 #if KMP_STATS_ENABLED
3070  kmp_stats_list *th_stats;
3071 #endif
3072 #if KMP_OS_UNIX
3073  std::atomic<bool> th_blocking;
3074 #endif
3075  kmp_cg_root_t *th_cg_roots; // list of cg_roots associated with this thread
3076 } kmp_base_info_t;
3077 
3078 typedef union KMP_ALIGN_CACHE kmp_info {
3079  double th_align; /* use worst case alignment */
3080  char th_pad[KMP_PAD(kmp_base_info_t, CACHE_LINE)];
3081  kmp_base_info_t th;
3082 } kmp_info_t;
3083 
3084 // OpenMP thread team data structures
3085 
3086 typedef struct kmp_base_data {
3087  volatile kmp_uint32 t_value;
3088 } kmp_base_data_t;
3089 
3090 typedef union KMP_ALIGN_CACHE kmp_sleep_team {
3091  double dt_align; /* use worst case alignment */
3092  char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
3093  kmp_base_data_t dt;
3094 } kmp_sleep_team_t;
3095 
3096 typedef union KMP_ALIGN_CACHE kmp_ordered_team {
3097  double dt_align; /* use worst case alignment */
3098  char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
3099  kmp_base_data_t dt;
3100 } kmp_ordered_team_t;
3101 
3102 typedef int (*launch_t)(int gtid);
3103 
3104 /* Minimum number of ARGV entries to malloc if necessary */
3105 #define KMP_MIN_MALLOC_ARGV_ENTRIES 100
3106 
3107 // Set up how many argv pointers will fit in cache lines containing
3108 // t_inline_argv. Historically, we have supported at least 96 bytes. Using a
3109 // larger value for more space between the primary write/worker read section and
3110 // read/write by all section seems to buy more performance on EPCC PARALLEL.
3111 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
3112 #define KMP_INLINE_ARGV_BYTES \
3113  (4 * CACHE_LINE - \
3114  ((3 * KMP_PTR_SKIP + 2 * sizeof(int) + 2 * sizeof(kmp_int8) + \
3115  sizeof(kmp_int16) + sizeof(kmp_uint32)) % \
3116  CACHE_LINE))
3117 #else
3118 #define KMP_INLINE_ARGV_BYTES \
3119  (2 * CACHE_LINE - ((3 * KMP_PTR_SKIP + 2 * sizeof(int)) % CACHE_LINE))
3120 #endif
3121 #define KMP_INLINE_ARGV_ENTRIES (int)(KMP_INLINE_ARGV_BYTES / KMP_PTR_SKIP)
3122 
3123 typedef struct KMP_ALIGN_CACHE kmp_base_team {
3124  // Synchronization Data
3125  // ---------------------------------------------------------------------------
3126  KMP_ALIGN_CACHE kmp_ordered_team_t t_ordered;
3127  kmp_balign_team_t t_bar[bs_last_barrier];
3128  std::atomic<int> t_construct; // count of single directive encountered by team
3129  char pad[sizeof(kmp_lock_t)]; // padding to maintain performance on big iron
3130 
3131  // [0] - parallel / [1] - worksharing task reduction data shared by taskgroups
3132  std::atomic<void *> t_tg_reduce_data[2]; // to support task modifier
3133  std::atomic<int> t_tg_fini_counter[2]; // sync end of task reductions
3134 
3135  // Primary thread only
3136  // ---------------------------------------------------------------------------
3137  KMP_ALIGN_CACHE int t_master_tid; // tid of primary thread in parent team
3138  int t_master_this_cons; // "this_construct" single counter of primary thread
3139  // in parent team
3140  ident_t *t_ident; // if volatile, have to change too much other crud to
3141  // volatile too
3142  kmp_team_p *t_parent; // parent team
3143  kmp_team_p *t_next_pool; // next free team in the team pool
3144  kmp_disp_t *t_dispatch; // thread's dispatch data
3145  kmp_task_team_t *t_task_team[2]; // Task team struct; switch between 2
3146  kmp_proc_bind_t t_proc_bind; // bind type for par region
3147  int t_primary_task_state; // primary thread's task state saved
3148 #if USE_ITT_BUILD
3149  kmp_uint64 t_region_time; // region begin timestamp
3150 #endif /* USE_ITT_BUILD */
3151 
3152  // Primary thread write, workers read
3153  // --------------------------------------------------------------------------
3154  KMP_ALIGN_CACHE void **t_argv;
3155  int t_argc;
3156  int t_nproc; // number of threads in team
3157  microtask_t t_pkfn;
3158  launch_t t_invoke; // procedure to launch the microtask
3159 
3160 #if OMPT_SUPPORT
3161  ompt_team_info_t ompt_team_info;
3162  ompt_lw_taskteam_t *ompt_serialized_team_info;
3163 #endif
3164 
3165 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
3166  kmp_int8 t_fp_control_saved;
3167  kmp_int8 t_pad2b;
3168  kmp_int16 t_x87_fpu_control_word; // FP control regs
3169  kmp_uint32 t_mxcsr;
3170 #endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
3171 
3172  void *t_inline_argv[KMP_INLINE_ARGV_ENTRIES];
3173 
3174  KMP_ALIGN_CACHE kmp_info_t **t_threads;
3175  kmp_taskdata_t
3176  *t_implicit_task_taskdata; // Taskdata for the thread's implicit task
3177  int t_level; // nested parallel level
3178 
3179  KMP_ALIGN_CACHE int t_max_argc;
3180  int t_max_nproc; // max threads this team can handle (dynamically expandable)
3181  int t_serialized; // levels deep of serialized teams
3182  dispatch_shared_info_t *t_disp_buffer; // buffers for dispatch system
3183  int t_id; // team's id, assigned by debugger.
3184  int t_active_level; // nested active parallel level
3185  kmp_r_sched_t t_sched; // run-time schedule for the team
3186 #if KMP_AFFINITY_SUPPORTED
3187  int t_first_place; // first & last place in parent thread's partition.
3188  int t_last_place; // Restore these values to primary thread after par region.
3189 #endif // KMP_AFFINITY_SUPPORTED
3190  int t_display_affinity;
3191  int t_size_changed; // team size was changed?: 0: no, 1: yes, -1: changed via
3192  // omp_set_num_threads() call
3193  omp_allocator_handle_t t_def_allocator; /* default allocator */
3194 
3195 // Read/write by workers as well
3196 #if (KMP_ARCH_X86 || KMP_ARCH_X86_64)
3197  // Using CACHE_LINE=64 reduces memory footprint, but causes a big perf
3198  // regression of epcc 'parallel' and 'barrier' on fxe256lin01. This extra
3199  // padding serves to fix the performance of epcc 'parallel' and 'barrier' when
3200  // CACHE_LINE=64. TODO: investigate more and get rid if this padding.
3201  char dummy_padding[1024];
3202 #endif
3203  // Internal control stack for additional nested teams.
3204  KMP_ALIGN_CACHE kmp_internal_control_t *t_control_stack_top;
3205  // for SERIALIZED teams nested 2 or more levels deep
3206  // typed flag to store request state of cancellation
3207  std::atomic<kmp_int32> t_cancel_request;
3208  int t_master_active; // save on fork, restore on join
3209  void *t_copypriv_data; // team specific pointer to copyprivate data array
3210 #if KMP_OS_WINDOWS
3211  std::atomic<kmp_uint32> t_copyin_counter;
3212 #endif
3213 #if USE_ITT_BUILD
3214  void *t_stack_id; // team specific stack stitching id (for ittnotify)
3215 #endif /* USE_ITT_BUILD */
3216  distributedBarrier *b; // Distributed barrier data associated with team
3217  kmp_nested_nthreads_t *t_nested_nth;
3218 } kmp_base_team_t;
3219 
3220 // Assert that the list structure fits and aligns within
3221 // the double task team pointer
3222 KMP_BUILD_ASSERT(sizeof(kmp_task_team_t *[2]) == sizeof(kmp_task_team_list_t));
3223 KMP_BUILD_ASSERT(alignof(kmp_task_team_t *[2]) ==
3224  alignof(kmp_task_team_list_t));
3225 
3226 union KMP_ALIGN_CACHE kmp_team {
3227  kmp_base_team_t t;
3228  double t_align; /* use worst case alignment */
3229  char t_pad[KMP_PAD(kmp_base_team_t, CACHE_LINE)];
3230 };
3231 
3232 typedef union KMP_ALIGN_CACHE kmp_time_global {
3233  double dt_align; /* use worst case alignment */
3234  char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
3235  kmp_base_data_t dt;
3236 } kmp_time_global_t;
3237 
3238 typedef struct kmp_base_global {
3239  /* cache-aligned */
3240  kmp_time_global_t g_time;
3241 
3242  /* non cache-aligned */
3243  volatile int g_abort;
3244  volatile int g_done;
3245 
3246  int g_dynamic;
3247  enum dynamic_mode g_dynamic_mode;
3248 } kmp_base_global_t;
3249 
3250 typedef union KMP_ALIGN_CACHE kmp_global {
3251  kmp_base_global_t g;
3252  double g_align; /* use worst case alignment */
3253  char g_pad[KMP_PAD(kmp_base_global_t, CACHE_LINE)];
3254 } kmp_global_t;
3255 
3256 typedef struct kmp_base_root {
3257  // TODO: GEH - combine r_active with r_in_parallel then r_active ==
3258  // (r_in_parallel>= 0)
3259  // TODO: GEH - then replace r_active with t_active_levels if we can to reduce
3260  // the synch overhead or keeping r_active
3261  volatile int r_active; /* TRUE if some region in a nest has > 1 thread */
3262  // keeps a count of active parallel regions per root
3263  std::atomic<int> r_in_parallel;
3264  // GEH: This is misnamed, should be r_active_levels
3265  kmp_team_t *r_root_team;
3266  kmp_team_t *r_hot_team;
3267  kmp_info_t *r_uber_thread;
3268  kmp_lock_t r_begin_lock;
3269  volatile int r_begin;
3270  int r_blocktime; /* blocktime for this root and descendants */
3271 #if KMP_AFFINITY_SUPPORTED
3272  int r_affinity_assigned;
3273 #endif // KMP_AFFINITY_SUPPORTED
3274 } kmp_base_root_t;
3275 
3276 typedef union KMP_ALIGN_CACHE kmp_root {
3277  kmp_base_root_t r;
3278  double r_align; /* use worst case alignment */
3279  char r_pad[KMP_PAD(kmp_base_root_t, CACHE_LINE)];
3280 } kmp_root_t;
3281 
3282 struct fortran_inx_info {
3283  kmp_int32 data;
3284 };
3285 
3286 // This list type exists to hold old __kmp_threads arrays so that
3287 // old references to them may complete while reallocation takes place when
3288 // expanding the array. The items in this list are kept alive until library
3289 // shutdown.
3290 typedef struct kmp_old_threads_list_t {
3291  kmp_info_t **threads;
3292  struct kmp_old_threads_list_t *next;
3293 } kmp_old_threads_list_t;
3294 
3295 /* ------------------------------------------------------------------------ */
3296 
3297 extern int __kmp_settings;
3298 extern int __kmp_duplicate_library_ok;
3299 #if USE_ITT_BUILD
3300 extern int __kmp_forkjoin_frames;
3301 extern int __kmp_forkjoin_frames_mode;
3302 #endif
3303 extern PACKED_REDUCTION_METHOD_T __kmp_force_reduction_method;
3304 extern int __kmp_determ_red;
3305 
3306 #ifdef KMP_DEBUG
3307 extern int kmp_a_debug;
3308 extern int kmp_b_debug;
3309 extern int kmp_c_debug;
3310 extern int kmp_d_debug;
3311 extern int kmp_e_debug;
3312 extern int kmp_f_debug;
3313 #endif /* KMP_DEBUG */
3314 
3315 /* For debug information logging using rotating buffer */
3316 #define KMP_DEBUG_BUF_LINES_INIT 512
3317 #define KMP_DEBUG_BUF_LINES_MIN 1
3318 
3319 #define KMP_DEBUG_BUF_CHARS_INIT 128
3320 #define KMP_DEBUG_BUF_CHARS_MIN 2
3321 
3322 extern int
3323  __kmp_debug_buf; /* TRUE means use buffer, FALSE means print to stderr */
3324 extern int __kmp_debug_buf_lines; /* How many lines of debug stored in buffer */
3325 extern int
3326  __kmp_debug_buf_chars; /* How many characters allowed per line in buffer */
3327 extern int __kmp_debug_buf_atomic; /* TRUE means use atomic update of buffer
3328  entry pointer */
3329 
3330 extern char *__kmp_debug_buffer; /* Debug buffer itself */
3331 extern std::atomic<int> __kmp_debug_count; /* Counter for number of lines
3332  printed in buffer so far */
3333 extern int __kmp_debug_buf_warn_chars; /* Keep track of char increase
3334  recommended in warnings */
3335 /* end rotating debug buffer */
3336 
3337 #ifdef KMP_DEBUG
3338 extern int __kmp_par_range; /* +1 => only go par for constructs in range */
3339 
3340 #define KMP_PAR_RANGE_ROUTINE_LEN 1024
3341 extern char __kmp_par_range_routine[KMP_PAR_RANGE_ROUTINE_LEN];
3342 #define KMP_PAR_RANGE_FILENAME_LEN 1024
3343 extern char __kmp_par_range_filename[KMP_PAR_RANGE_FILENAME_LEN];
3344 extern int __kmp_par_range_lb;
3345 extern int __kmp_par_range_ub;
3346 #endif
3347 
3348 /* For printing out dynamic storage map for threads and teams */
3349 extern int
3350  __kmp_storage_map; /* True means print storage map for threads and teams */
3351 extern int __kmp_storage_map_verbose; /* True means storage map includes
3352  placement info */
3353 extern int __kmp_storage_map_verbose_specified;
3354 
3355 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
3356 extern kmp_cpuinfo_t __kmp_cpuinfo;
3357 static inline bool __kmp_is_hybrid_cpu() { return __kmp_cpuinfo.flags.hybrid; }
3358 #elif KMP_OS_DARWIN && KMP_ARCH_AARCH64
3359 static inline bool __kmp_is_hybrid_cpu() { return true; }
3360 #else
3361 static inline bool __kmp_is_hybrid_cpu() { return false; }
3362 #endif
3363 
3364 extern volatile int __kmp_init_serial;
3365 extern volatile int __kmp_init_gtid;
3366 extern volatile int __kmp_init_common;
3367 extern volatile int __kmp_need_register_serial;
3368 extern volatile int __kmp_init_middle;
3369 extern volatile int __kmp_init_parallel;
3370 #if KMP_USE_MONITOR
3371 extern volatile int __kmp_init_monitor;
3372 #endif
3373 extern volatile int __kmp_init_user_locks;
3374 extern volatile int __kmp_init_hidden_helper_threads;
3375 extern int __kmp_init_counter;
3376 extern int __kmp_root_counter;
3377 extern int __kmp_version;
3378 
3379 /* list of address of allocated caches for commons */
3380 extern kmp_cached_addr_t *__kmp_threadpriv_cache_list;
3381 
3382 /* Barrier algorithm types and options */
3383 extern kmp_uint32 __kmp_barrier_gather_bb_dflt;
3384 extern kmp_uint32 __kmp_barrier_release_bb_dflt;
3385 extern kmp_bar_pat_e __kmp_barrier_gather_pat_dflt;
3386 extern kmp_bar_pat_e __kmp_barrier_release_pat_dflt;
3387 extern kmp_uint32 __kmp_barrier_gather_branch_bits[bs_last_barrier];
3388 extern kmp_uint32 __kmp_barrier_release_branch_bits[bs_last_barrier];
3389 extern kmp_bar_pat_e __kmp_barrier_gather_pattern[bs_last_barrier];
3390 extern kmp_bar_pat_e __kmp_barrier_release_pattern[bs_last_barrier];
3391 extern char const *__kmp_barrier_branch_bit_env_name[bs_last_barrier];
3392 extern char const *__kmp_barrier_pattern_env_name[bs_last_barrier];
3393 extern char const *__kmp_barrier_type_name[bs_last_barrier];
3394 extern char const *__kmp_barrier_pattern_name[bp_last_bar];
3395 
3396 /* Global Locks */
3397 extern kmp_bootstrap_lock_t __kmp_initz_lock; /* control initialization */
3398 extern kmp_bootstrap_lock_t __kmp_forkjoin_lock; /* control fork/join access */
3399 extern kmp_bootstrap_lock_t __kmp_task_team_lock;
3400 extern kmp_bootstrap_lock_t
3401  __kmp_exit_lock; /* exit() is not always thread-safe */
3402 #if KMP_USE_MONITOR
3403 extern kmp_bootstrap_lock_t
3404  __kmp_monitor_lock; /* control monitor thread creation */
3405 #endif
3406 extern kmp_bootstrap_lock_t
3407  __kmp_tp_cached_lock; /* used for the hack to allow threadprivate cache and
3408  __kmp_threads expansion to co-exist */
3409 
3410 extern kmp_lock_t __kmp_global_lock; /* control OS/global access */
3411 
3412 extern enum library_type __kmp_library;
3413 
3414 extern enum sched_type __kmp_sched; /* default runtime scheduling */
3415 extern enum sched_type __kmp_static; /* default static scheduling method */
3416 extern enum sched_type __kmp_guided; /* default guided scheduling method */
3417 extern enum sched_type __kmp_auto; /* default auto scheduling method */
3418 extern int __kmp_chunk; /* default runtime chunk size */
3419 extern int __kmp_force_monotonic; /* whether monotonic scheduling forced */
3420 
3421 extern size_t __kmp_stksize; /* stack size per thread */
3422 #if KMP_USE_MONITOR
3423 extern size_t __kmp_monitor_stksize; /* stack size for monitor thread */
3424 #endif
3425 extern size_t __kmp_stkoffset; /* stack offset per thread */
3426 extern int __kmp_stkpadding; /* Should we pad root thread(s) stack */
3427 
3428 extern size_t
3429  __kmp_malloc_pool_incr; /* incremental size of pool for kmp_malloc() */
3430 extern int __kmp_env_stksize; /* was KMP_STACKSIZE specified? */
3431 extern int __kmp_env_blocktime; /* was KMP_BLOCKTIME specified? */
3432 extern int __kmp_env_checks; /* was KMP_CHECKS specified? */
3433 extern int __kmp_env_consistency_check; // was KMP_CONSISTENCY_CHECK specified?
3434 extern int __kmp_generate_warnings; /* should we issue warnings? */
3435 extern int __kmp_reserve_warn; /* have we issued reserve_threads warning? */
3436 
3437 #ifdef DEBUG_SUSPEND
3438 extern int __kmp_suspend_count; /* count inside __kmp_suspend_template() */
3439 #endif
3440 
3441 extern kmp_int32 __kmp_use_yield;
3442 extern kmp_int32 __kmp_use_yield_exp_set;
3443 extern kmp_uint32 __kmp_yield_init;
3444 extern kmp_uint32 __kmp_yield_next;
3445 extern kmp_uint64 __kmp_pause_init;
3446 
3447 /* ------------------------------------------------------------------------- */
3448 extern int __kmp_allThreadsSpecified;
3449 
3450 extern size_t __kmp_align_alloc;
3451 /* following data protected by initialization routines */
3452 extern int __kmp_xproc; /* number of processors in the system */
3453 extern int __kmp_avail_proc; /* number of processors available to the process */
3454 extern size_t __kmp_sys_min_stksize; /* system-defined minimum stack size */
3455 extern int __kmp_sys_max_nth; /* system-imposed maximum number of threads */
3456 // maximum total number of concurrently-existing threads on device
3457 extern int __kmp_max_nth;
3458 // maximum total number of concurrently-existing threads in a contention group
3459 extern int __kmp_cg_max_nth;
3460 extern int __kmp_task_max_nth; // max threads used in a task
3461 extern int __kmp_teams_max_nth; // max threads used in a teams construct
3462 extern int __kmp_threads_capacity; /* capacity of the arrays __kmp_threads and
3463  __kmp_root */
3464 extern int __kmp_dflt_team_nth; /* default number of threads in a parallel
3465  region a la OMP_NUM_THREADS */
3466 extern int __kmp_dflt_team_nth_ub; /* upper bound on "" determined at serial
3467  initialization */
3468 extern int __kmp_tp_capacity; /* capacity of __kmp_threads if threadprivate is
3469  used (fixed) */
3470 extern int __kmp_tp_cached; /* whether threadprivate cache has been created
3471  (__kmpc_threadprivate_cached()) */
3472 extern int __kmp_dflt_blocktime; /* number of microseconds to wait before
3473  blocking (env setting) */
3474 extern char __kmp_blocktime_units; /* 'm' or 'u' to note units specified */
3475 extern bool __kmp_wpolicy_passive; /* explicitly set passive wait policy */
3476 
3477 // Convert raw blocktime from ms to us if needed.
3478 static inline void __kmp_aux_convert_blocktime(int *bt) {
3479  if (__kmp_blocktime_units == 'm') {
3480  if (*bt > INT_MAX / 1000) {
3481  *bt = INT_MAX / 1000;
3482  KMP_INFORM(MaxValueUsing, "kmp_set_blocktime(ms)", bt);
3483  }
3484  *bt = *bt * 1000;
3485  }
3486 }
3487 
3488 #if KMP_USE_MONITOR
3489 extern int
3490  __kmp_monitor_wakeups; /* number of times monitor wakes up per second */
3491 extern int __kmp_bt_intervals; /* number of monitor timestamp intervals before
3492  blocking */
3493 #endif
3494 #ifdef KMP_ADJUST_BLOCKTIME
3495 extern int __kmp_zero_bt; /* whether blocktime has been forced to zero */
3496 #endif /* KMP_ADJUST_BLOCKTIME */
3497 #ifdef KMP_DFLT_NTH_CORES
3498 extern int __kmp_ncores; /* Total number of cores for threads placement */
3499 #endif
3500 /* Number of millisecs to delay on abort for Intel(R) VTune(TM) tools */
3501 extern int __kmp_abort_delay;
3502 
3503 extern int __kmp_need_register_atfork_specified;
3504 extern int __kmp_need_register_atfork; /* At initialization, call pthread_atfork
3505  to install fork handler */
3506 extern int __kmp_gtid_mode; /* Method of getting gtid, values:
3507  0 - not set, will be set at runtime
3508  1 - using stack search
3509  2 - dynamic TLS (pthread_getspecific(Linux* OS/OS
3510  X*) or TlsGetValue(Windows* OS))
3511  3 - static TLS (__declspec(thread) __kmp_gtid),
3512  Linux* OS .so only. */
3513 extern int
3514  __kmp_adjust_gtid_mode; /* If true, adjust method based on #threads */
3515 #ifdef KMP_TDATA_GTID
3516 extern KMP_THREAD_LOCAL int __kmp_gtid;
3517 #endif
3518 extern int __kmp_tls_gtid_min; /* #threads below which use sp search for gtid */
3519 extern int __kmp_foreign_tp; // If true, separate TP var for each foreign thread
3520 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
3521 extern int __kmp_inherit_fp_control; // copy fp creg(s) parent->workers at fork
3522 extern kmp_int16 __kmp_init_x87_fpu_control_word; // init thread's FP ctrl reg
3523 extern kmp_uint32 __kmp_init_mxcsr; /* init thread's mxscr */
3524 #endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
3525 
3526 // max_active_levels for nested parallelism enabled by default via
3527 // OMP_MAX_ACTIVE_LEVELS, OMP_NESTED, OMP_NUM_THREADS, and OMP_PROC_BIND
3528 extern int __kmp_dflt_max_active_levels;
3529 // Indicates whether value of __kmp_dflt_max_active_levels was already
3530 // explicitly set by OMP_MAX_ACTIVE_LEVELS or OMP_NESTED=false
3531 extern bool __kmp_dflt_max_active_levels_set;
3532 extern int __kmp_dispatch_num_buffers; /* max possible dynamic loops in
3533  concurrent execution per team */
3534 extern int __kmp_hot_teams_mode;
3535 extern int __kmp_hot_teams_max_level;
3536 
3537 #if KMP_MIC_SUPPORTED
3538 extern enum mic_type __kmp_mic_type;
3539 #endif
3540 
3541 #ifdef USE_LOAD_BALANCE
3542 extern double __kmp_load_balance_interval; // load balance algorithm interval
3543 #endif /* USE_LOAD_BALANCE */
3544 
3545 #if KMP_USE_ADAPTIVE_LOCKS
3546 
3547 // Parameters for the speculative lock backoff system.
3548 struct kmp_adaptive_backoff_params_t {
3549  // Number of soft retries before it counts as a hard retry.
3550  kmp_uint32 max_soft_retries;
3551  // Badness is a bit mask : 0,1,3,7,15,... on each hard failure we move one to
3552  // the right
3553  kmp_uint32 max_badness;
3554 };
3555 
3556 extern kmp_adaptive_backoff_params_t __kmp_adaptive_backoff_params;
3557 
3558 #if KMP_DEBUG_ADAPTIVE_LOCKS
3559 extern const char *__kmp_speculative_statsfile;
3560 #endif
3561 
3562 #endif // KMP_USE_ADAPTIVE_LOCKS
3563 
3564 extern int __kmp_display_env; /* TRUE or FALSE */
3565 extern int __kmp_display_env_verbose; /* TRUE if OMP_DISPLAY_ENV=VERBOSE */
3566 extern int __kmp_omp_cancellation; /* TRUE or FALSE */
3567 extern int __kmp_nteams;
3568 extern int __kmp_teams_thread_limit;
3569 
3570 /* ------------------------------------------------------------------------- */
3571 
3572 /* the following are protected by the fork/join lock */
3573 /* write: lock read: anytime */
3574 extern kmp_info_t **__kmp_threads; /* Descriptors for the threads */
3575 /* Holds old arrays of __kmp_threads until library shutdown */
3576 extern kmp_old_threads_list_t *__kmp_old_threads_list;
3577 /* read/write: lock */
3578 extern volatile kmp_team_t *__kmp_team_pool;
3579 extern volatile kmp_info_t *__kmp_thread_pool;
3580 extern kmp_info_t *__kmp_thread_pool_insert_pt;
3581 
3582 // total num threads reachable from some root thread including all root threads
3583 extern volatile int __kmp_nth;
3584 /* total number of threads reachable from some root thread including all root
3585  threads, and those in the thread pool */
3586 extern volatile int __kmp_all_nth;
3587 extern std::atomic<int> __kmp_thread_pool_active_nth;
3588 
3589 extern kmp_root_t **__kmp_root; /* root of thread hierarchy */
3590 /* end data protected by fork/join lock */
3591 /* ------------------------------------------------------------------------- */
3592 
3593 #define __kmp_get_gtid() __kmp_get_global_thread_id()
3594 #define __kmp_entry_gtid() __kmp_get_global_thread_id_reg()
3595 #define __kmp_get_tid() (__kmp_tid_from_gtid(__kmp_get_gtid()))
3596 #define __kmp_get_team() (__kmp_threads[(__kmp_get_gtid())]->th.th_team)
3597 #define __kmp_get_thread() (__kmp_thread_from_gtid(__kmp_get_gtid()))
3598 
3599 // AT: Which way is correct?
3600 // AT: 1. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team -> t.t_nproc;
3601 // AT: 2. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team_nproc;
3602 #define __kmp_get_team_num_threads(gtid) \
3603  (__kmp_threads[(gtid)]->th.th_team->t.t_nproc)
3604 
3605 static inline bool KMP_UBER_GTID(int gtid) {
3606  KMP_DEBUG_ASSERT(gtid >= KMP_GTID_MIN);
3607  KMP_DEBUG_ASSERT(gtid < __kmp_threads_capacity);
3608  return (gtid >= 0 && __kmp_root[gtid] && __kmp_threads[gtid] &&
3609  __kmp_threads[gtid] == __kmp_root[gtid]->r.r_uber_thread);
3610 }
3611 
3612 static inline int __kmp_tid_from_gtid(int gtid) {
3613  KMP_DEBUG_ASSERT(gtid >= 0);
3614  return __kmp_threads[gtid]->th.th_info.ds.ds_tid;
3615 }
3616 
3617 static inline int __kmp_gtid_from_tid(int tid, const kmp_team_t *team) {
3618  KMP_DEBUG_ASSERT(tid >= 0 && team);
3619  return team->t.t_threads[tid]->th.th_info.ds.ds_gtid;
3620 }
3621 
3622 static inline int __kmp_gtid_from_thread(const kmp_info_t *thr) {
3623  KMP_DEBUG_ASSERT(thr);
3624  return thr->th.th_info.ds.ds_gtid;
3625 }
3626 
3627 static inline kmp_info_t *__kmp_thread_from_gtid(int gtid) {
3628  KMP_DEBUG_ASSERT(gtid >= 0);
3629  return __kmp_threads[gtid];
3630 }
3631 
3632 static inline kmp_team_t *__kmp_team_from_gtid(int gtid) {
3633  KMP_DEBUG_ASSERT(gtid >= 0);
3634  return __kmp_threads[gtid]->th.th_team;
3635 }
3636 
3637 static inline void __kmp_assert_valid_gtid(kmp_int32 gtid) {
3638  if (UNLIKELY(gtid < 0 || gtid >= __kmp_threads_capacity))
3639  KMP_FATAL(ThreadIdentInvalid);
3640 }
3641 
3642 #if KMP_HAVE_MWAIT || KMP_HAVE_UMWAIT
3643 extern int __kmp_user_level_mwait; // TRUE or FALSE; from KMP_USER_LEVEL_MWAIT
3644 extern int __kmp_umwait_enabled; // Runtime check if user-level mwait enabled
3645 extern int __kmp_mwait_enabled; // Runtime check if ring3 mwait is enabled
3646 extern int __kmp_mwait_hints; // Hints to pass in to mwait
3647 #endif
3648 
3649 #if KMP_HAVE_UMWAIT
3650 extern int __kmp_waitpkg_enabled; // Runtime check if waitpkg exists
3651 extern int __kmp_tpause_state; // 0 (default), 1=C0.1, 2=C0.2; from KMP_TPAUSE
3652 extern int __kmp_tpause_hint; // 1=C0.1 (default), 0=C0.2; from KMP_TPAUSE
3653 extern int __kmp_tpause_enabled; // 0 (default), 1 (KMP_TPAUSE is non-zero)
3654 #endif
3655 
3656 /* ------------------------------------------------------------------------- */
3657 
3658 extern kmp_global_t __kmp_global; /* global status */
3659 
3660 extern kmp_info_t __kmp_monitor;
3661 // For Debugging Support Library
3662 extern std::atomic<kmp_int32> __kmp_team_counter;
3663 // For Debugging Support Library
3664 extern std::atomic<kmp_int32> __kmp_task_counter;
3665 
3666 #if USE_DEBUGGER
3667 #define _KMP_GEN_ID(counter) \
3668  (__kmp_debugging ? KMP_ATOMIC_INC(&counter) + 1 : ~0)
3669 #else
3670 #define _KMP_GEN_ID(counter) (~0)
3671 #endif /* USE_DEBUGGER */
3672 
3673 #define KMP_GEN_TASK_ID() _KMP_GEN_ID(__kmp_task_counter)
3674 #define KMP_GEN_TEAM_ID() _KMP_GEN_ID(__kmp_team_counter)
3675 
3676 /* ------------------------------------------------------------------------ */
3677 
3678 extern void __kmp_print_storage_map_gtid(int gtid, void *p1, void *p2,
3679  size_t size, char const *format, ...);
3680 
3681 extern void __kmp_serial_initialize(void);
3682 extern void __kmp_middle_initialize(void);
3683 extern void __kmp_parallel_initialize(void);
3684 
3685 extern void __kmp_internal_begin(void);
3686 extern void __kmp_internal_end_library(int gtid);
3687 extern void __kmp_internal_end_thread(int gtid);
3688 extern void __kmp_internal_end_atexit(void);
3689 extern void __kmp_internal_end_dtor(void);
3690 extern void __kmp_internal_end_dest(void *);
3691 
3692 extern int __kmp_register_root(int initial_thread);
3693 extern void __kmp_unregister_root(int gtid);
3694 extern void __kmp_unregister_library(void); // called by __kmp_internal_end()
3695 
3696 extern int __kmp_ignore_mppbeg(void);
3697 extern int __kmp_ignore_mppend(void);
3698 
3699 extern int __kmp_enter_single(int gtid, ident_t *id_ref, int push_ws);
3700 extern void __kmp_exit_single(int gtid);
3701 
3702 extern void __kmp_parallel_deo(int *gtid_ref, int *cid_ref, ident_t *loc_ref);
3703 extern void __kmp_parallel_dxo(int *gtid_ref, int *cid_ref, ident_t *loc_ref);
3704 
3705 #ifdef USE_LOAD_BALANCE
3706 extern int __kmp_get_load_balance(int);
3707 #endif
3708 
3709 extern int __kmp_get_global_thread_id(void);
3710 extern int __kmp_get_global_thread_id_reg(void);
3711 extern void __kmp_exit_thread(int exit_status);
3712 extern void __kmp_abort(char const *format, ...);
3713 extern void __kmp_abort_thread(void);
3714 KMP_NORETURN extern void __kmp_abort_process(void);
3715 extern void __kmp_warn(char const *format, ...);
3716 
3717 extern void __kmp_set_num_threads(int new_nth, int gtid);
3718 
3719 extern bool __kmp_detect_shm();
3720 extern bool __kmp_detect_tmp();
3721 
3722 // Returns current thread (pointer to kmp_info_t). Current thread *must* be
3723 // registered.
3724 static inline kmp_info_t *__kmp_entry_thread() {
3725  int gtid = __kmp_entry_gtid();
3726 
3727  return __kmp_threads[gtid];
3728 }
3729 
3730 extern void __kmp_set_max_active_levels(int gtid, int new_max_active_levels);
3731 extern int __kmp_get_max_active_levels(int gtid);
3732 extern int __kmp_get_ancestor_thread_num(int gtid, int level);
3733 extern int __kmp_get_team_size(int gtid, int level);
3734 extern void __kmp_set_schedule(int gtid, kmp_sched_t new_sched, int chunk);
3735 extern void __kmp_get_schedule(int gtid, kmp_sched_t *sched, int *chunk);
3736 
3737 extern unsigned short __kmp_get_random(kmp_info_t *thread);
3738 extern void __kmp_init_random(kmp_info_t *thread);
3739 
3740 extern kmp_r_sched_t __kmp_get_schedule_global(void);
3741 extern void __kmp_adjust_num_threads(int new_nproc);
3742 extern void __kmp_check_stksize(size_t *val);
3743 
3744 extern void *___kmp_allocate(size_t size KMP_SRC_LOC_DECL);
3745 extern void *___kmp_page_allocate(size_t size KMP_SRC_LOC_DECL);
3746 extern void ___kmp_free(void *ptr KMP_SRC_LOC_DECL);
3747 #define __kmp_allocate(size) ___kmp_allocate((size)KMP_SRC_LOC_CURR)
3748 #define __kmp_page_allocate(size) ___kmp_page_allocate((size)KMP_SRC_LOC_CURR)
3749 #define __kmp_free(ptr) ___kmp_free((ptr)KMP_SRC_LOC_CURR)
3750 
3751 #if USE_FAST_MEMORY
3752 extern void *___kmp_fast_allocate(kmp_info_t *this_thr,
3753  size_t size KMP_SRC_LOC_DECL);
3754 extern void ___kmp_fast_free(kmp_info_t *this_thr, void *ptr KMP_SRC_LOC_DECL);
3755 extern void __kmp_free_fast_memory(kmp_info_t *this_thr);
3756 extern void __kmp_initialize_fast_memory(kmp_info_t *this_thr);
3757 #define __kmp_fast_allocate(this_thr, size) \
3758  ___kmp_fast_allocate((this_thr), (size)KMP_SRC_LOC_CURR)
3759 #define __kmp_fast_free(this_thr, ptr) \
3760  ___kmp_fast_free((this_thr), (ptr)KMP_SRC_LOC_CURR)
3761 #endif
3762 
3763 extern void *___kmp_thread_malloc(kmp_info_t *th, size_t size KMP_SRC_LOC_DECL);
3764 extern void *___kmp_thread_calloc(kmp_info_t *th, size_t nelem,
3765  size_t elsize KMP_SRC_LOC_DECL);
3766 extern void *___kmp_thread_realloc(kmp_info_t *th, void *ptr,
3767  size_t size KMP_SRC_LOC_DECL);
3768 extern void ___kmp_thread_free(kmp_info_t *th, void *ptr KMP_SRC_LOC_DECL);
3769 #define __kmp_thread_malloc(th, size) \
3770  ___kmp_thread_malloc((th), (size)KMP_SRC_LOC_CURR)
3771 #define __kmp_thread_calloc(th, nelem, elsize) \
3772  ___kmp_thread_calloc((th), (nelem), (elsize)KMP_SRC_LOC_CURR)
3773 #define __kmp_thread_realloc(th, ptr, size) \
3774  ___kmp_thread_realloc((th), (ptr), (size)KMP_SRC_LOC_CURR)
3775 #define __kmp_thread_free(th, ptr) \
3776  ___kmp_thread_free((th), (ptr)KMP_SRC_LOC_CURR)
3777 
3778 extern void __kmp_push_num_threads(ident_t *loc, int gtid, int num_threads);
3779 extern void __kmp_push_num_threads_list(ident_t *loc, int gtid,
3780  kmp_uint32 list_length,
3781  int *num_threads_list);
3782 extern void __kmp_set_strict_num_threads(ident_t *loc, int gtid, int sev,
3783  const char *msg);
3784 
3785 extern void __kmp_push_proc_bind(ident_t *loc, int gtid,
3786  kmp_proc_bind_t proc_bind);
3787 extern void __kmp_push_num_teams(ident_t *loc, int gtid, int num_teams,
3788  int num_threads);
3789 extern void __kmp_push_num_teams_51(ident_t *loc, int gtid, int num_teams_lb,
3790  int num_teams_ub, int num_threads);
3791 
3792 extern void __kmp_yield();
3793 
3794 extern void __kmpc_dispatch_init_4(ident_t *loc, kmp_int32 gtid,
3795  enum sched_type schedule, kmp_int32 lb,
3796  kmp_int32 ub, kmp_int32 st, kmp_int32 chunk);
3797 extern void __kmpc_dispatch_init_4u(ident_t *loc, kmp_int32 gtid,
3798  enum sched_type schedule, kmp_uint32 lb,
3799  kmp_uint32 ub, kmp_int32 st,
3800  kmp_int32 chunk);
3801 extern void __kmpc_dispatch_init_8(ident_t *loc, kmp_int32 gtid,
3802  enum sched_type schedule, kmp_int64 lb,
3803  kmp_int64 ub, kmp_int64 st, kmp_int64 chunk);
3804 extern void __kmpc_dispatch_init_8u(ident_t *loc, kmp_int32 gtid,
3805  enum sched_type schedule, kmp_uint64 lb,
3806  kmp_uint64 ub, kmp_int64 st,
3807  kmp_int64 chunk);
3808 
3809 extern int __kmpc_dispatch_next_4(ident_t *loc, kmp_int32 gtid,
3810  kmp_int32 *p_last, kmp_int32 *p_lb,
3811  kmp_int32 *p_ub, kmp_int32 *p_st);
3812 extern int __kmpc_dispatch_next_4u(ident_t *loc, kmp_int32 gtid,
3813  kmp_int32 *p_last, kmp_uint32 *p_lb,
3814  kmp_uint32 *p_ub, kmp_int32 *p_st);
3815 extern int __kmpc_dispatch_next_8(ident_t *loc, kmp_int32 gtid,
3816  kmp_int32 *p_last, kmp_int64 *p_lb,
3817  kmp_int64 *p_ub, kmp_int64 *p_st);
3818 extern int __kmpc_dispatch_next_8u(ident_t *loc, kmp_int32 gtid,
3819  kmp_int32 *p_last, kmp_uint64 *p_lb,
3820  kmp_uint64 *p_ub, kmp_int64 *p_st);
3821 
3822 extern void __kmpc_dispatch_fini_4(ident_t *loc, kmp_int32 gtid);
3823 extern void __kmpc_dispatch_fini_8(ident_t *loc, kmp_int32 gtid);
3824 extern void __kmpc_dispatch_fini_4u(ident_t *loc, kmp_int32 gtid);
3825 extern void __kmpc_dispatch_fini_8u(ident_t *loc, kmp_int32 gtid);
3826 
3827 extern void __kmpc_dispatch_deinit(ident_t *loc, kmp_int32 gtid);
3828 
3829 #ifdef KMP_GOMP_COMPAT
3830 
3831 extern void __kmp_aux_dispatch_init_4(ident_t *loc, kmp_int32 gtid,
3832  enum sched_type schedule, kmp_int32 lb,
3833  kmp_int32 ub, kmp_int32 st,
3834  kmp_int32 chunk, int push_ws);
3835 extern void __kmp_aux_dispatch_init_4u(ident_t *loc, kmp_int32 gtid,
3836  enum sched_type schedule, kmp_uint32 lb,
3837  kmp_uint32 ub, kmp_int32 st,
3838  kmp_int32 chunk, int push_ws);
3839 extern void __kmp_aux_dispatch_init_8(ident_t *loc, kmp_int32 gtid,
3840  enum sched_type schedule, kmp_int64 lb,
3841  kmp_int64 ub, kmp_int64 st,
3842  kmp_int64 chunk, int push_ws);
3843 extern void __kmp_aux_dispatch_init_8u(ident_t *loc, kmp_int32 gtid,
3844  enum sched_type schedule, kmp_uint64 lb,
3845  kmp_uint64 ub, kmp_int64 st,
3846  kmp_int64 chunk, int push_ws);
3847 extern void __kmp_aux_dispatch_fini_chunk_4(ident_t *loc, kmp_int32 gtid);
3848 extern void __kmp_aux_dispatch_fini_chunk_8(ident_t *loc, kmp_int32 gtid);
3849 extern void __kmp_aux_dispatch_fini_chunk_4u(ident_t *loc, kmp_int32 gtid);
3850 extern void __kmp_aux_dispatch_fini_chunk_8u(ident_t *loc, kmp_int32 gtid);
3851 
3852 #endif /* KMP_GOMP_COMPAT */
3853 
3854 extern kmp_uint32 __kmp_eq_4(kmp_uint32 value, kmp_uint32 checker);
3855 extern kmp_uint32 __kmp_neq_4(kmp_uint32 value, kmp_uint32 checker);
3856 extern kmp_uint32 __kmp_lt_4(kmp_uint32 value, kmp_uint32 checker);
3857 extern kmp_uint32 __kmp_ge_4(kmp_uint32 value, kmp_uint32 checker);
3858 extern kmp_uint32 __kmp_le_4(kmp_uint32 value, kmp_uint32 checker);
3859 extern kmp_uint32 __kmp_wait_4(kmp_uint32 volatile *spinner, kmp_uint32 checker,
3860  kmp_uint32 (*pred)(kmp_uint32, kmp_uint32),
3861  void *obj);
3862 extern void __kmp_wait_4_ptr(void *spinner, kmp_uint32 checker,
3863  kmp_uint32 (*pred)(void *, kmp_uint32), void *obj);
3864 
3865 extern void __kmp_wait_64(kmp_info_t *this_thr, kmp_flag_64<> *flag,
3866  int final_spin
3867 #if USE_ITT_BUILD
3868  ,
3869  void *itt_sync_obj
3870 #endif
3871 );
3872 extern void __kmp_release_64(kmp_flag_64<> *flag);
3873 
3874 extern void __kmp_infinite_loop(void);
3875 
3876 extern void __kmp_cleanup(void);
3877 
3878 #if KMP_HANDLE_SIGNALS
3879 extern int __kmp_handle_signals;
3880 extern void __kmp_install_signals(int parallel_init);
3881 extern void __kmp_remove_signals(void);
3882 #endif
3883 
3884 extern void __kmp_clear_system_time(void);
3885 extern void __kmp_read_system_time(double *delta);
3886 
3887 extern void __kmp_check_stack_overlap(kmp_info_t *thr);
3888 
3889 extern void __kmp_expand_host_name(char *buffer, size_t size);
3890 extern void __kmp_expand_file_name(char *result, size_t rlen, char *pattern);
3891 
3892 #if KMP_ARCH_X86 || KMP_ARCH_X86_64 || \
3893  (KMP_OS_WINDOWS && (KMP_ARCH_AARCH64 || KMP_ARCH_ARM || KMP_ARCH_ARM64EC))
3894 extern void
3895 __kmp_initialize_system_tick(void); /* Initialize timer tick value */
3896 #endif
3897 
3898 extern void
3899 __kmp_runtime_initialize(void); /* machine specific initialization */
3900 extern void __kmp_runtime_destroy(void);
3901 
3902 #if KMP_AFFINITY_SUPPORTED
3903 extern char *__kmp_affinity_print_mask(char *buf, int buf_len,
3904  kmp_affin_mask_t *mask);
3905 extern kmp_str_buf_t *__kmp_affinity_str_buf_mask(kmp_str_buf_t *buf,
3906  kmp_affin_mask_t *mask);
3907 extern void __kmp_affinity_initialize(kmp_affinity_t &affinity);
3908 extern void __kmp_affinity_uninitialize(void);
3909 extern void __kmp_affinity_set_init_mask(
3910  int gtid, int isa_root); /* set affinity according to KMP_AFFINITY */
3911 void __kmp_affinity_bind_init_mask(int gtid);
3912 extern void __kmp_affinity_bind_place(int gtid);
3913 extern void __kmp_affinity_determine_capable(const char *env_var);
3914 extern int __kmp_aux_set_affinity(void **mask);
3915 extern int __kmp_aux_get_affinity(void **mask);
3916 extern int __kmp_aux_get_affinity_max_proc();
3917 extern int __kmp_aux_set_affinity_mask_proc(int proc, void **mask);
3918 extern int __kmp_aux_unset_affinity_mask_proc(int proc, void **mask);
3919 extern int __kmp_aux_get_affinity_mask_proc(int proc, void **mask);
3920 extern void __kmp_balanced_affinity(kmp_info_t *th, int team_size);
3921 #if KMP_WEIGHTED_ITERATIONS_SUPPORTED
3922 extern int __kmp_get_first_osid_with_ecore(void);
3923 #endif
3924 #if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_DRAGONFLY || \
3925  KMP_OS_AIX
3926 extern int kmp_set_thread_affinity_mask_initial(void);
3927 #endif
3928 static inline void __kmp_assign_root_init_mask() {
3929  int gtid = __kmp_entry_gtid();
3930  kmp_root_t *r = __kmp_threads[gtid]->th.th_root;
3931  if (r->r.r_uber_thread == __kmp_threads[gtid] && !r->r.r_affinity_assigned) {
3932  __kmp_affinity_set_init_mask(gtid, /*isa_root=*/TRUE);
3933  __kmp_affinity_bind_init_mask(gtid);
3934  r->r.r_affinity_assigned = TRUE;
3935  }
3936 }
3937 static inline void __kmp_reset_root_init_mask(int gtid) {
3938  if (!KMP_AFFINITY_CAPABLE())
3939  return;
3940  kmp_info_t *th = __kmp_threads[gtid];
3941  kmp_root_t *r = th->th.th_root;
3942  if (r->r.r_uber_thread == th && r->r.r_affinity_assigned) {
3943  __kmp_set_system_affinity(__kmp_affin_origMask, FALSE);
3944  KMP_CPU_COPY(th->th.th_affin_mask, __kmp_affin_origMask);
3945  r->r.r_affinity_assigned = FALSE;
3946  }
3947 }
3948 #else /* KMP_AFFINITY_SUPPORTED */
3949 #define __kmp_assign_root_init_mask() /* Nothing */
3950 static inline void __kmp_reset_root_init_mask(int gtid) {}
3951 #endif /* KMP_AFFINITY_SUPPORTED */
3952 // No need for KMP_AFFINITY_SUPPORTED guard as only one field in the
3953 // format string is for affinity, so platforms that do not support
3954 // affinity can still use the other fields, e.g., %n for num_threads
3955 extern size_t __kmp_aux_capture_affinity(int gtid, const char *format,
3956  kmp_str_buf_t *buffer);
3957 extern void __kmp_aux_display_affinity(int gtid, const char *format);
3958 
3959 extern void __kmp_cleanup_hierarchy();
3960 extern void __kmp_get_hierarchy(kmp_uint32 nproc, kmp_bstate_t *thr_bar);
3961 
3962 #if KMP_USE_FUTEX
3963 
3964 extern int __kmp_futex_determine_capable(void);
3965 
3966 #endif // KMP_USE_FUTEX
3967 
3968 extern void __kmp_gtid_set_specific(int gtid);
3969 extern int __kmp_gtid_get_specific(void);
3970 
3971 extern double __kmp_read_cpu_time(void);
3972 
3973 extern int __kmp_read_system_info(struct kmp_sys_info *info);
3974 
3975 #if KMP_USE_MONITOR
3976 extern void __kmp_create_monitor(kmp_info_t *th);
3977 #endif
3978 
3979 extern void *__kmp_launch_thread(kmp_info_t *thr);
3980 
3981 extern void __kmp_create_worker(int gtid, kmp_info_t *th, size_t stack_size);
3982 
3983 #if KMP_OS_WINDOWS
3984 extern int __kmp_still_running(kmp_info_t *th);
3985 extern int __kmp_is_thread_alive(kmp_info_t *th, DWORD *exit_val);
3986 extern void __kmp_free_handle(kmp_thread_t tHandle);
3987 #endif
3988 
3989 #if KMP_USE_MONITOR
3990 extern void __kmp_reap_monitor(kmp_info_t *th);
3991 #endif
3992 extern void __kmp_reap_worker(kmp_info_t *th);
3993 extern void __kmp_terminate_thread(int gtid);
3994 
3995 extern int __kmp_try_suspend_mx(kmp_info_t *th);
3996 extern void __kmp_lock_suspend_mx(kmp_info_t *th);
3997 extern void __kmp_unlock_suspend_mx(kmp_info_t *th);
3998 
3999 extern void __kmp_elapsed(double *);
4000 extern void __kmp_elapsed_tick(double *);
4001 
4002 extern void __kmp_enable(int old_state);
4003 extern void __kmp_disable(int *old_state);
4004 
4005 extern void __kmp_thread_sleep(int millis);
4006 
4007 extern void __kmp_common_initialize(void);
4008 extern void __kmp_common_destroy(void);
4009 extern void __kmp_common_destroy_gtid(int gtid);
4010 
4011 #if KMP_OS_UNIX
4012 extern void __kmp_register_atfork(void);
4013 #endif
4014 extern void __kmp_suspend_initialize(void);
4015 extern void __kmp_suspend_initialize_thread(kmp_info_t *th);
4016 extern void __kmp_suspend_uninitialize_thread(kmp_info_t *th);
4017 
4018 extern kmp_info_t *__kmp_allocate_thread(kmp_root_t *root, kmp_team_t *team,
4019  int tid);
4020 extern kmp_team_t *__kmp_allocate_team(kmp_root_t *root, int new_nproc,
4021  int max_nproc,
4022 #if OMPT_SUPPORT
4023  ompt_data_t ompt_parallel_data,
4024 #endif
4025  kmp_proc_bind_t proc_bind,
4026  kmp_internal_control_t *new_icvs,
4027  int argc, kmp_info_t *thr);
4028 extern void __kmp_free_thread(kmp_info_t *);
4029 extern void __kmp_free_team(kmp_root_t *, kmp_team_t *, kmp_info_t *);
4030 extern kmp_team_t *__kmp_reap_team(kmp_team_t *);
4031 
4032 /* ------------------------------------------------------------------------ */
4033 
4034 extern void __kmp_initialize_bget(kmp_info_t *th);
4035 extern void __kmp_finalize_bget(kmp_info_t *th);
4036 
4037 KMP_EXPORT void *kmpc_malloc(size_t size);
4038 KMP_EXPORT void *kmpc_aligned_malloc(size_t size, size_t alignment);
4039 KMP_EXPORT void *kmpc_calloc(size_t nelem, size_t elsize);
4040 KMP_EXPORT void *kmpc_realloc(void *ptr, size_t size);
4041 KMP_EXPORT void kmpc_free(void *ptr);
4042 
4043 /* declarations for internal use */
4044 
4045 extern int __kmp_barrier(enum barrier_type bt, int gtid, int is_split,
4046  size_t reduce_size, void *reduce_data,
4047  void (*reduce)(void *, void *));
4048 extern void __kmp_end_split_barrier(enum barrier_type bt, int gtid);
4049 extern int __kmp_barrier_gomp_cancel(int gtid);
4050 
4055 enum fork_context_e {
4056  fork_context_gnu,
4058  fork_context_intel,
4059  fork_context_last
4060 };
4061 extern int __kmp_fork_call(ident_t *loc, int gtid,
4062  enum fork_context_e fork_context, kmp_int32 argc,
4063  microtask_t microtask, launch_t invoker,
4064  kmp_va_list ap);
4065 
4066 extern void __kmp_join_call(ident_t *loc, int gtid
4067 #if OMPT_SUPPORT
4068  ,
4069  enum fork_context_e fork_context
4070 #endif
4071  ,
4072  int exit_teams = 0);
4073 
4074 extern void __kmp_serialized_parallel(ident_t *id, kmp_int32 gtid);
4075 extern void __kmp_internal_fork(ident_t *id, int gtid, kmp_team_t *team);
4076 extern void __kmp_internal_join(ident_t *id, int gtid, kmp_team_t *team);
4077 extern int __kmp_invoke_task_func(int gtid);
4078 extern void __kmp_run_before_invoked_task(int gtid, int tid,
4079  kmp_info_t *this_thr,
4080  kmp_team_t *team);
4081 extern void __kmp_run_after_invoked_task(int gtid, int tid,
4082  kmp_info_t *this_thr,
4083  kmp_team_t *team);
4084 
4085 // should never have been exported
4086 KMP_EXPORT int __kmpc_invoke_task_func(int gtid);
4087 extern int __kmp_invoke_teams_master(int gtid);
4088 extern void __kmp_teams_master(int gtid);
4089 extern int __kmp_aux_get_team_num();
4090 extern int __kmp_aux_get_num_teams();
4091 extern void __kmp_save_internal_controls(kmp_info_t *thread);
4092 extern void __kmp_user_set_library(enum library_type arg);
4093 extern void __kmp_aux_set_library(enum library_type arg);
4094 extern void __kmp_aux_set_stacksize(size_t arg);
4095 extern void __kmp_aux_set_blocktime(int arg, kmp_info_t *thread, int tid);
4096 extern void __kmp_aux_set_defaults(char const *str, size_t len);
4097 
4098 /* Functions called from __kmp_aux_env_initialize() in kmp_settings.cpp */
4099 void kmpc_set_blocktime(int arg);
4100 void ompc_set_nested(int flag);
4101 void ompc_set_dynamic(int flag);
4102 void ompc_set_num_threads(int arg);
4103 
4104 extern void __kmp_push_current_task_to_thread(kmp_info_t *this_thr,
4105  kmp_team_t *team, int tid);
4106 extern void __kmp_pop_current_task_from_thread(kmp_info_t *this_thr);
4107 extern kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
4108  kmp_tasking_flags_t *flags,
4109  size_t sizeof_kmp_task_t,
4110  size_t sizeof_shareds,
4111  kmp_routine_entry_t task_entry);
4112 extern void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
4113  kmp_team_t *team, int tid,
4114  int set_curr_task);
4115 extern void __kmp_finish_implicit_task(kmp_info_t *this_thr);
4116 extern void __kmp_free_implicit_task(kmp_info_t *this_thr);
4117 
4118 extern kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref,
4119  int gtid,
4120  kmp_task_t *task);
4121 extern void __kmp_fulfill_event(kmp_event_t *event);
4122 
4123 extern void __kmp_free_task_team(kmp_info_t *thread,
4124  kmp_task_team_t *task_team);
4125 extern void __kmp_reap_task_teams(void);
4126 extern void __kmp_push_task_team_node(kmp_info_t *thread, kmp_team_t *team);
4127 extern void __kmp_pop_task_team_node(kmp_info_t *thread, kmp_team_t *team);
4128 extern void __kmp_wait_to_unref_task_teams(void);
4129 extern void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team);
4130 extern void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team);
4131 extern void __kmp_task_team_wait(kmp_info_t *this_thr, kmp_team_t *team
4132 #if USE_ITT_BUILD
4133  ,
4134  void *itt_sync_obj
4135 #endif /* USE_ITT_BUILD */
4136  ,
4137  int wait = 1);
4138 extern void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread,
4139  int gtid);
4140 #if KMP_DEBUG
4141 #define KMP_DEBUG_ASSERT_TASKTEAM_INVARIANT(team, thr) \
4142  KMP_DEBUG_ASSERT( \
4143  __kmp_tasking_mode != tskm_task_teams || team->t.t_nproc == 1 || \
4144  thr->th.th_task_team == team->t.t_task_team[thr->th.th_task_state])
4145 #else
4146 #define KMP_DEBUG_ASSERT_TASKTEAM_INVARIANT(team, thr) /* Nothing */
4147 #endif
4148 
4149 extern int __kmp_is_address_mapped(void *addr);
4150 extern kmp_uint64 __kmp_hardware_timestamp(void);
4151 
4152 #if KMP_OS_UNIX
4153 extern int __kmp_read_from_file(char const *path, char const *format, ...);
4154 #endif
4155 
4156 /* ------------------------------------------------------------------------ */
4157 //
4158 // Assembly routines that have no compiler intrinsic replacement
4159 //
4160 
4161 extern int __kmp_invoke_microtask(microtask_t pkfn, int gtid, int npr, int argc,
4162  void *argv[]
4163 #if OMPT_SUPPORT
4164  ,
4165  void **exit_frame_ptr
4166 #endif
4167 );
4168 
4169 /* ------------------------------------------------------------------------ */
4170 
4171 KMP_EXPORT void __kmpc_begin(ident_t *, kmp_int32 flags);
4172 KMP_EXPORT void __kmpc_end(ident_t *);
4173 
4174 KMP_EXPORT void __kmpc_threadprivate_register_vec(ident_t *, void *data,
4175  kmpc_ctor_vec ctor,
4176  kmpc_cctor_vec cctor,
4177  kmpc_dtor_vec dtor,
4178  size_t vector_length);
4179 KMP_EXPORT void __kmpc_threadprivate_register(ident_t *, void *data,
4180  kmpc_ctor ctor, kmpc_cctor cctor,
4181  kmpc_dtor dtor);
4182 KMP_EXPORT void *__kmpc_threadprivate(ident_t *, kmp_int32 global_tid,
4183  void *data, size_t size);
4184 
4185 KMP_EXPORT kmp_int32 __kmpc_global_thread_num(ident_t *);
4186 KMP_EXPORT kmp_int32 __kmpc_global_num_threads(ident_t *);
4187 KMP_EXPORT kmp_int32 __kmpc_bound_thread_num(ident_t *);
4188 KMP_EXPORT kmp_int32 __kmpc_bound_num_threads(ident_t *);
4189 
4190 KMP_EXPORT kmp_int32 __kmpc_ok_to_fork(ident_t *);
4191 KMP_EXPORT void __kmpc_fork_call(ident_t *, kmp_int32 nargs,
4192  kmpc_micro microtask, ...);
4193 KMP_EXPORT void __kmpc_fork_call_if(ident_t *loc, kmp_int32 nargs,
4194  kmpc_micro microtask, kmp_int32 cond,
4195  void *args);
4196 
4197 KMP_EXPORT void __kmpc_serialized_parallel(ident_t *, kmp_int32 global_tid);
4198 KMP_EXPORT void __kmpc_end_serialized_parallel(ident_t *, kmp_int32 global_tid);
4199 
4200 KMP_EXPORT void __kmpc_flush(ident_t *);
4201 KMP_EXPORT void __kmpc_barrier(ident_t *, kmp_int32 global_tid);
4202 KMP_EXPORT kmp_int32 __kmpc_master(ident_t *, kmp_int32 global_tid);
4203 KMP_EXPORT void __kmpc_end_master(ident_t *, kmp_int32 global_tid);
4204 KMP_EXPORT kmp_int32 __kmpc_masked(ident_t *, kmp_int32 global_tid,
4205  kmp_int32 filter);
4206 KMP_EXPORT void __kmpc_end_masked(ident_t *, kmp_int32 global_tid);
4207 KMP_EXPORT void __kmpc_ordered(ident_t *, kmp_int32 global_tid);
4208 KMP_EXPORT void __kmpc_end_ordered(ident_t *, kmp_int32 global_tid);
4209 KMP_EXPORT void __kmpc_critical(ident_t *, kmp_int32 global_tid,
4210  kmp_critical_name *);
4211 KMP_EXPORT void __kmpc_end_critical(ident_t *, kmp_int32 global_tid,
4212  kmp_critical_name *);
4213 KMP_EXPORT void __kmpc_critical_with_hint(ident_t *, kmp_int32 global_tid,
4214  kmp_critical_name *, uint32_t hint);
4215 
4216 KMP_EXPORT kmp_int32 __kmpc_barrier_master(ident_t *, kmp_int32 global_tid);
4217 KMP_EXPORT void __kmpc_end_barrier_master(ident_t *, kmp_int32 global_tid);
4218 
4219 KMP_EXPORT kmp_int32 __kmpc_barrier_master_nowait(ident_t *,
4220  kmp_int32 global_tid);
4221 
4222 KMP_EXPORT kmp_int32 __kmpc_single(ident_t *, kmp_int32 global_tid);
4223 KMP_EXPORT void __kmpc_end_single(ident_t *, kmp_int32 global_tid);
4224 
4225 KMP_EXPORT kmp_int32 __kmpc_sections_init(ident_t *loc, kmp_int32 global_tid);
4226 KMP_EXPORT kmp_int32 __kmpc_next_section(ident_t *loc, kmp_int32 global_tid,
4227  kmp_int32 numberOfSections);
4228 KMP_EXPORT void __kmpc_end_sections(ident_t *loc, kmp_int32 global_tid);
4229 
4230 KMP_EXPORT void KMPC_FOR_STATIC_INIT(ident_t *loc, kmp_int32 global_tid,
4231  kmp_int32 schedtype, kmp_int32 *plastiter,
4232  kmp_int *plower, kmp_int *pupper,
4233  kmp_int *pstride, kmp_int incr,
4234  kmp_int chunk);
4235 
4236 KMP_EXPORT void __kmpc_for_static_fini(ident_t *loc, kmp_int32 global_tid);
4237 
4238 KMP_EXPORT void __kmpc_copyprivate(ident_t *loc, kmp_int32 global_tid,
4239  size_t cpy_size, void *cpy_data,
4240  void (*cpy_func)(void *, void *),
4241  kmp_int32 didit);
4242 
4243 KMP_EXPORT void *__kmpc_copyprivate_light(ident_t *loc, kmp_int32 gtid,
4244  void *cpy_data);
4245 
4246 extern void KMPC_SET_NUM_THREADS(int arg);
4247 extern void KMPC_SET_DYNAMIC(int flag);
4248 extern void KMPC_SET_NESTED(int flag);
4249 
4250 /* OMP 3.0 tasking interface routines */
4251 KMP_EXPORT kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
4252  kmp_task_t *new_task);
4253 KMP_EXPORT kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
4254  kmp_int32 flags,
4255  size_t sizeof_kmp_task_t,
4256  size_t sizeof_shareds,
4257  kmp_routine_entry_t task_entry);
4258 KMP_EXPORT kmp_task_t *__kmpc_omp_target_task_alloc(
4259  ident_t *loc_ref, kmp_int32 gtid, kmp_int32 flags, size_t sizeof_kmp_task_t,
4260  size_t sizeof_shareds, kmp_routine_entry_t task_entry, kmp_int64 device_id);
4261 KMP_EXPORT void __kmpc_omp_task_begin_if0(ident_t *loc_ref, kmp_int32 gtid,
4262  kmp_task_t *task);
4263 KMP_EXPORT void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
4264  kmp_task_t *task);
4265 KMP_EXPORT kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
4266  kmp_task_t *new_task);
4267 KMP_EXPORT kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid);
4268 KMP_EXPORT kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid,
4269  int end_part);
4270 
4271 #if TASK_UNUSED
4272 void __kmpc_omp_task_begin(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task);
4273 void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
4274  kmp_task_t *task);
4275 #endif // TASK_UNUSED
4276 
4277 /* ------------------------------------------------------------------------ */
4278 
4279 KMP_EXPORT void __kmpc_taskgroup(ident_t *loc, int gtid);
4280 KMP_EXPORT void __kmpc_end_taskgroup(ident_t *loc, int gtid);
4281 
4282 KMP_EXPORT kmp_int32 __kmpc_omp_task_with_deps(
4283  ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 ndeps,
4284  kmp_depend_info_t *dep_list, kmp_int32 ndeps_noalias,
4285  kmp_depend_info_t *noalias_dep_list);
4286 
4287 KMP_EXPORT kmp_base_depnode_t *__kmpc_task_get_depnode(kmp_task_t *task);
4288 
4289 KMP_EXPORT kmp_depnode_list_t *__kmpc_task_get_successors(kmp_task_t *task);
4290 
4291 KMP_EXPORT void __kmpc_omp_wait_deps(ident_t *loc_ref, kmp_int32 gtid,
4292  kmp_int32 ndeps,
4293  kmp_depend_info_t *dep_list,
4294  kmp_int32 ndeps_noalias,
4295  kmp_depend_info_t *noalias_dep_list);
4296 /* __kmpc_omp_taskwait_deps_51 : Function for OpenMP 5.1 nowait clause.
4297  * Placeholder for taskwait with nowait clause.*/
4298 KMP_EXPORT void __kmpc_omp_taskwait_deps_51(ident_t *loc_ref, kmp_int32 gtid,
4299  kmp_int32 ndeps,
4300  kmp_depend_info_t *dep_list,
4301  kmp_int32 ndeps_noalias,
4302  kmp_depend_info_t *noalias_dep_list,
4303  kmp_int32 has_no_wait);
4304 
4305 extern kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
4306  bool serialize_immediate);
4307 
4308 KMP_EXPORT kmp_int32 __kmpc_cancel(ident_t *loc_ref, kmp_int32 gtid,
4309  kmp_int32 cncl_kind);
4310 KMP_EXPORT kmp_int32 __kmpc_cancellationpoint(ident_t *loc_ref, kmp_int32 gtid,
4311  kmp_int32 cncl_kind);
4312 KMP_EXPORT kmp_int32 __kmpc_cancel_barrier(ident_t *loc_ref, kmp_int32 gtid);
4313 KMP_EXPORT int __kmp_get_cancellation_status(int cancel_kind);
4314 
4315 KMP_EXPORT void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask);
4316 KMP_EXPORT void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask);
4317 KMP_EXPORT void __kmpc_taskloop(ident_t *loc, kmp_int32 gtid, kmp_task_t *task,
4318  kmp_int32 if_val, kmp_uint64 *lb,
4319  kmp_uint64 *ub, kmp_int64 st, kmp_int32 nogroup,
4320  kmp_int32 sched, kmp_uint64 grainsize,
4321  void *task_dup);
4322 KMP_EXPORT void __kmpc_taskloop_5(ident_t *loc, kmp_int32 gtid,
4323  kmp_task_t *task, kmp_int32 if_val,
4324  kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4325  kmp_int32 nogroup, kmp_int32 sched,
4326  kmp_uint64 grainsize, kmp_int32 modifier,
4327  void *task_dup);
4328 KMP_EXPORT void *__kmpc_task_reduction_init(int gtid, int num_data, void *data);
4329 KMP_EXPORT void *__kmpc_taskred_init(int gtid, int num_data, void *data);
4330 KMP_EXPORT void *__kmpc_task_reduction_get_th_data(int gtid, void *tg, void *d);
4331 KMP_EXPORT void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid,
4332  int is_ws, int num,
4333  void *data);
4334 KMP_EXPORT void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws,
4335  int num, void *data);
4336 KMP_EXPORT void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid,
4337  int is_ws);
4338 KMP_EXPORT kmp_int32 __kmpc_omp_reg_task_with_affinity(
4339  ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 naffins,
4340  kmp_task_affinity_info_t *affin_list);
4341 KMP_EXPORT void __kmp_set_num_teams(int num_teams);
4342 KMP_EXPORT int __kmp_get_max_teams(void);
4343 KMP_EXPORT void __kmp_set_teams_thread_limit(int limit);
4344 KMP_EXPORT int __kmp_get_teams_thread_limit(void);
4345 
4346 /* Interface target task integration */
4347 KMP_EXPORT void **__kmpc_omp_get_target_async_handle_ptr(kmp_int32 gtid);
4348 KMP_EXPORT bool __kmpc_omp_has_task_team(kmp_int32 gtid);
4349 
4350 /* Lock interface routines (fast versions with gtid passed in) */
4351 KMP_EXPORT void __kmpc_init_lock(ident_t *loc, kmp_int32 gtid,
4352  void **user_lock);
4353 KMP_EXPORT void __kmpc_init_nest_lock(ident_t *loc, kmp_int32 gtid,
4354  void **user_lock);
4355 KMP_EXPORT void __kmpc_destroy_lock(ident_t *loc, kmp_int32 gtid,
4356  void **user_lock);
4357 KMP_EXPORT void __kmpc_destroy_nest_lock(ident_t *loc, kmp_int32 gtid,
4358  void **user_lock);
4359 KMP_EXPORT void __kmpc_set_lock(ident_t *loc, kmp_int32 gtid, void **user_lock);
4360 KMP_EXPORT void __kmpc_set_nest_lock(ident_t *loc, kmp_int32 gtid,
4361  void **user_lock);
4362 KMP_EXPORT void __kmpc_unset_lock(ident_t *loc, kmp_int32 gtid,
4363  void **user_lock);
4364 KMP_EXPORT void __kmpc_unset_nest_lock(ident_t *loc, kmp_int32 gtid,
4365  void **user_lock);
4366 KMP_EXPORT int __kmpc_test_lock(ident_t *loc, kmp_int32 gtid, void **user_lock);
4367 KMP_EXPORT int __kmpc_test_nest_lock(ident_t *loc, kmp_int32 gtid,
4368  void **user_lock);
4369 
4370 KMP_EXPORT void __kmpc_init_lock_with_hint(ident_t *loc, kmp_int32 gtid,
4371  void **user_lock, uintptr_t hint);
4372 KMP_EXPORT void __kmpc_init_nest_lock_with_hint(ident_t *loc, kmp_int32 gtid,
4373  void **user_lock,
4374  uintptr_t hint);
4375 
4376 #if OMP_TASKGRAPH_EXPERIMENTAL
4377 // Taskgraph's Record & Replay mechanism
4378 // __kmp_tdg_is_recording: check whether a given TDG is recording
4379 // status: the tdg's current status
4380 static inline bool __kmp_tdg_is_recording(kmp_tdg_status_t status) {
4381  return status == KMP_TDG_RECORDING;
4382 }
4383 
4384 KMP_EXPORT kmp_int32 __kmpc_start_record_task(ident_t *loc, kmp_int32 gtid,
4385  kmp_int32 input_flags,
4386  kmp_int32 tdg_id);
4387 KMP_EXPORT void __kmpc_end_record_task(ident_t *loc, kmp_int32 gtid,
4388  kmp_int32 input_flags, kmp_int32 tdg_id);
4389 #endif
4390 /* Interface to fast scalable reduce methods routines */
4391 
4392 KMP_EXPORT kmp_int32 __kmpc_reduce_nowait(
4393  ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
4394  void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
4395  kmp_critical_name *lck);
4396 KMP_EXPORT void __kmpc_end_reduce_nowait(ident_t *loc, kmp_int32 global_tid,
4397  kmp_critical_name *lck);
4398 KMP_EXPORT kmp_int32 __kmpc_reduce(
4399  ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
4400  void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
4401  kmp_critical_name *lck);
4402 KMP_EXPORT void __kmpc_end_reduce(ident_t *loc, kmp_int32 global_tid,
4403  kmp_critical_name *lck);
4404 
4405 /* Internal fast reduction routines */
4406 
4407 extern PACKED_REDUCTION_METHOD_T __kmp_determine_reduction_method(
4408  ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
4409  void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
4410  kmp_critical_name *lck);
4411 
4412 // this function is for testing set/get/determine reduce method
4413 KMP_EXPORT kmp_int32 __kmp_get_reduce_method(void);
4414 
4415 KMP_EXPORT kmp_uint64 __kmpc_get_taskid();
4416 KMP_EXPORT kmp_uint64 __kmpc_get_parent_taskid();
4417 
4418 // C++ port
4419 // missing 'extern "C"' declarations
4420 
4421 KMP_EXPORT kmp_int32 __kmpc_in_parallel(ident_t *loc);
4422 KMP_EXPORT void __kmpc_pop_num_threads(ident_t *loc, kmp_int32 global_tid);
4423 KMP_EXPORT void __kmpc_push_num_threads(ident_t *loc, kmp_int32 global_tid,
4424  kmp_int32 num_threads);
4425 KMP_EXPORT void __kmpc_push_num_threads_strict(ident_t *loc,
4426  kmp_int32 global_tid,
4427  kmp_int32 num_threads,
4428  int severity,
4429  const char *message);
4430 
4431 KMP_EXPORT void __kmpc_push_num_threads_list(ident_t *loc, kmp_int32 global_tid,
4432  kmp_uint32 list_length,
4433  kmp_int32 *num_threads_list);
4434 KMP_EXPORT void __kmpc_push_num_threads_list_strict(
4435  ident_t *loc, kmp_int32 global_tid, kmp_uint32 list_length,
4436  kmp_int32 *num_threads_list, int severity, const char *message);
4437 
4438 KMP_EXPORT void __kmpc_push_proc_bind(ident_t *loc, kmp_int32 global_tid,
4439  int proc_bind);
4440 KMP_EXPORT void __kmpc_push_num_teams(ident_t *loc, kmp_int32 global_tid,
4441  kmp_int32 num_teams,
4442  kmp_int32 num_threads);
4443 KMP_EXPORT void __kmpc_set_thread_limit(ident_t *loc, kmp_int32 global_tid,
4444  kmp_int32 thread_limit);
4445 /* Function for OpenMP 5.1 num_teams clause */
4446 KMP_EXPORT void __kmpc_push_num_teams_51(ident_t *loc, kmp_int32 global_tid,
4447  kmp_int32 num_teams_lb,
4448  kmp_int32 num_teams_ub,
4449  kmp_int32 num_threads);
4450 KMP_EXPORT void __kmpc_fork_teams(ident_t *loc, kmp_int32 argc,
4451  kmpc_micro microtask, ...);
4452 struct kmp_dim { // loop bounds info casted to kmp_int64
4453  kmp_int64 lo; // lower
4454  kmp_int64 up; // upper
4455  kmp_int64 st; // stride
4456 };
4457 KMP_EXPORT void __kmpc_doacross_init(ident_t *loc, kmp_int32 gtid,
4458  kmp_int32 num_dims,
4459  const struct kmp_dim *dims);
4460 KMP_EXPORT void __kmpc_doacross_wait(ident_t *loc, kmp_int32 gtid,
4461  const kmp_int64 *vec);
4462 KMP_EXPORT void __kmpc_doacross_post(ident_t *loc, kmp_int32 gtid,
4463  const kmp_int64 *vec);
4464 KMP_EXPORT void __kmpc_doacross_fini(ident_t *loc, kmp_int32 gtid);
4465 
4466 KMP_EXPORT void *__kmpc_threadprivate_cached(ident_t *loc, kmp_int32 global_tid,
4467  void *data, size_t size,
4468  void ***cache);
4469 
4470 // The routines below are not exported.
4471 // Consider making them 'static' in corresponding source files.
4472 void kmp_threadprivate_insert_private_data(int gtid, void *pc_addr,
4473  void *data_addr, size_t pc_size);
4474 struct private_common *kmp_threadprivate_insert(int gtid, void *pc_addr,
4475  void *data_addr,
4476  size_t pc_size);
4477 void __kmp_threadprivate_resize_cache(int newCapacity);
4478 void __kmp_cleanup_threadprivate_caches();
4479 
4480 // ompc_, kmpc_ entries moved from omp.h.
4481 #if KMP_OS_WINDOWS
4482 #define KMPC_CONVENTION __cdecl
4483 #else
4484 #define KMPC_CONVENTION
4485 #endif
4486 
4487 #ifndef __OMP_H
4488 typedef enum omp_sched_t {
4489  omp_sched_static = 1,
4490  omp_sched_dynamic = 2,
4491  omp_sched_guided = 3,
4492  omp_sched_auto = 4
4493 } omp_sched_t;
4494 typedef void *kmp_affinity_mask_t;
4495 #endif
4496 
4497 KMP_EXPORT void KMPC_CONVENTION ompc_set_max_active_levels(int);
4498 KMP_EXPORT void KMPC_CONVENTION ompc_set_schedule(omp_sched_t, int);
4499 KMP_EXPORT int KMPC_CONVENTION ompc_get_ancestor_thread_num(int);
4500 KMP_EXPORT int KMPC_CONVENTION ompc_get_team_size(int);
4501 KMP_EXPORT int KMPC_CONVENTION
4502 kmpc_set_affinity_mask_proc(int, kmp_affinity_mask_t *);
4503 KMP_EXPORT int KMPC_CONVENTION
4504 kmpc_unset_affinity_mask_proc(int, kmp_affinity_mask_t *);
4505 KMP_EXPORT int KMPC_CONVENTION
4506 kmpc_get_affinity_mask_proc(int, kmp_affinity_mask_t *);
4507 
4508 KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize(int);
4509 KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize_s(size_t);
4510 KMP_EXPORT void KMPC_CONVENTION kmpc_set_library(int);
4511 KMP_EXPORT void KMPC_CONVENTION kmpc_set_defaults(char const *);
4512 KMP_EXPORT void KMPC_CONVENTION kmpc_set_disp_num_buffers(int);
4513 void KMP_EXPAND_NAME(ompc_set_affinity_format)(char const *format);
4514 size_t KMP_EXPAND_NAME(ompc_get_affinity_format)(char *buffer, size_t size);
4515 void KMP_EXPAND_NAME(ompc_display_affinity)(char const *format);
4516 size_t KMP_EXPAND_NAME(ompc_capture_affinity)(char *buffer, size_t buf_size,
4517  char const *format);
4518 
4519 enum kmp_target_offload_kind {
4520  tgt_disabled = 0,
4521  tgt_default = 1,
4522  tgt_mandatory = 2
4523 };
4524 typedef enum kmp_target_offload_kind kmp_target_offload_kind_t;
4525 // Set via OMP_TARGET_OFFLOAD if specified, defaults to tgt_default otherwise
4526 extern kmp_target_offload_kind_t __kmp_target_offload;
4527 extern int __kmpc_get_target_offload();
4528 
4529 // Constants used in libomptarget
4530 #define KMP_DEVICE_DEFAULT -1 // This is libomptarget's default device.
4531 #define KMP_DEVICE_ALL -11 // This is libomptarget's "all devices".
4532 
4533 // OMP Pause Resource
4534 
4535 // The following enum is used both to set the status in __kmp_pause_status, and
4536 // as the internal equivalent of the externally-visible omp_pause_resource_t.
4537 typedef enum kmp_pause_status_t {
4538  kmp_not_paused = 0, // status is not paused, or, requesting resume
4539  kmp_soft_paused = 1, // status is soft-paused, or, requesting soft pause
4540  kmp_hard_paused = 2, // status is hard-paused, or, requesting hard pause
4541  kmp_stop_tool_paused = 3 // requesting stop_tool pause
4542 } kmp_pause_status_t;
4543 
4544 // This stores the pause state of the runtime
4545 extern kmp_pause_status_t __kmp_pause_status;
4546 extern int __kmpc_pause_resource(kmp_pause_status_t level);
4547 extern int __kmp_pause_resource(kmp_pause_status_t level);
4548 // Soft resume sets __kmp_pause_status, and wakes up all threads.
4549 extern void __kmp_resume_if_soft_paused();
4550 // Hard resume simply resets the status to not paused. Library will appear to
4551 // be uninitialized after hard pause. Let OMP constructs trigger required
4552 // initializations.
4553 static inline void __kmp_resume_if_hard_paused() {
4554  if (__kmp_pause_status == kmp_hard_paused) {
4555  __kmp_pause_status = kmp_not_paused;
4556  }
4557 }
4558 
4559 extern void __kmp_omp_display_env(int verbose);
4560 
4561 // 1: it is initializing hidden helper team
4562 extern volatile int __kmp_init_hidden_helper;
4563 // 1: the hidden helper team is done
4564 extern volatile int __kmp_hidden_helper_team_done;
4565 // 1: enable hidden helper task
4566 extern kmp_int32 __kmp_enable_hidden_helper;
4567 // Main thread of hidden helper team
4568 extern kmp_info_t *__kmp_hidden_helper_main_thread;
4569 // Descriptors for the hidden helper threads
4570 extern kmp_info_t **__kmp_hidden_helper_threads;
4571 // Number of hidden helper threads
4572 extern kmp_int32 __kmp_hidden_helper_threads_num;
4573 // Number of hidden helper tasks that have not been executed yet
4574 extern std::atomic<kmp_int32> __kmp_unexecuted_hidden_helper_tasks;
4575 
4576 extern void __kmp_hidden_helper_initialize();
4577 extern void __kmp_hidden_helper_threads_initz_routine();
4578 extern void __kmp_do_initialize_hidden_helper_threads();
4579 extern void __kmp_hidden_helper_threads_initz_wait();
4580 extern void __kmp_hidden_helper_initz_release();
4581 extern void __kmp_hidden_helper_threads_deinitz_wait();
4582 extern void __kmp_hidden_helper_threads_deinitz_release();
4583 extern void __kmp_hidden_helper_main_thread_wait();
4584 extern void __kmp_hidden_helper_worker_thread_wait();
4585 extern void __kmp_hidden_helper_worker_thread_signal();
4586 extern void __kmp_hidden_helper_main_thread_release();
4587 
4588 // Check whether a given thread is a hidden helper thread
4589 #define KMP_HIDDEN_HELPER_THREAD(gtid) \
4590  ((gtid) >= 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4591 
4592 #define KMP_HIDDEN_HELPER_WORKER_THREAD(gtid) \
4593  ((gtid) > 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4594 
4595 #define KMP_HIDDEN_HELPER_MAIN_THREAD(gtid) \
4596  ((gtid) == 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4597 
4598 #define KMP_HIDDEN_HELPER_TEAM(team) \
4599  (team->t.t_threads[0] == __kmp_hidden_helper_main_thread)
4600 
4601 // Map a gtid to a hidden helper thread. The first hidden helper thread, a.k.a
4602 // main thread, is skipped.
4603 #define KMP_GTID_TO_SHADOW_GTID(gtid) \
4604  ((gtid) % (__kmp_hidden_helper_threads_num - 1) + 2)
4605 
4606 // Return the adjusted gtid value by subtracting from gtid the number
4607 // of hidden helper threads. This adjusted value is the gtid the thread would
4608 // have received if there were no hidden helper threads.
4609 static inline int __kmp_adjust_gtid_for_hidden_helpers(int gtid) {
4610  int adjusted_gtid = gtid;
4611  if (__kmp_hidden_helper_threads_num > 0 && gtid > 0 &&
4612  gtid - __kmp_hidden_helper_threads_num >= 0) {
4613  adjusted_gtid -= __kmp_hidden_helper_threads_num;
4614  }
4615  return adjusted_gtid;
4616 }
4617 
4618 #if ENABLE_LIBOMPTARGET
4619 // Pointers to callbacks registered by the offload library to be notified of
4620 // task progress.
4621 extern void (*kmp_target_sync_cb)(ident_t *loc_ref, int gtid,
4622  void *current_task, void *event);
4623 #endif // ENABLE_LIBOMPTARGET
4624 
4625 // Support for error directive
4626 typedef enum kmp_severity_t {
4627  severity_warning = 1,
4628  severity_fatal = 2
4629 } kmp_severity_t;
4630 extern void __kmpc_error(ident_t *loc, int severity, const char *message);
4631 
4632 // Support for scope directive
4633 KMP_EXPORT void __kmpc_scope(ident_t *loc, kmp_int32 gtid, void *reserved);
4634 KMP_EXPORT void __kmpc_end_scope(ident_t *loc, kmp_int32 gtid, void *reserved);
4635 
4636 #ifdef __cplusplus
4637 }
4638 #endif
4639 
4640 template <bool C, bool S>
4641 extern void __kmp_suspend_32(int th_gtid, kmp_flag_32<C, S> *flag);
4642 template <bool C, bool S>
4643 extern void __kmp_suspend_64(int th_gtid, kmp_flag_64<C, S> *flag);
4644 template <bool C, bool S>
4645 extern void __kmp_atomic_suspend_64(int th_gtid,
4646  kmp_atomic_flag_64<C, S> *flag);
4647 extern void __kmp_suspend_oncore(int th_gtid, kmp_flag_oncore *flag);
4648 #if KMP_HAVE_MWAIT || KMP_HAVE_UMWAIT
4649 template <bool C, bool S>
4650 extern void __kmp_mwait_32(int th_gtid, kmp_flag_32<C, S> *flag);
4651 template <bool C, bool S>
4652 extern void __kmp_mwait_64(int th_gtid, kmp_flag_64<C, S> *flag);
4653 template <bool C, bool S>
4654 extern void __kmp_atomic_mwait_64(int th_gtid, kmp_atomic_flag_64<C, S> *flag);
4655 extern void __kmp_mwait_oncore(int th_gtid, kmp_flag_oncore *flag);
4656 #endif
4657 template <bool C, bool S>
4658 extern void __kmp_resume_32(int target_gtid, kmp_flag_32<C, S> *flag);
4659 template <bool C, bool S>
4660 extern void __kmp_resume_64(int target_gtid, kmp_flag_64<C, S> *flag);
4661 template <bool C, bool S>
4662 extern void __kmp_atomic_resume_64(int target_gtid,
4663  kmp_atomic_flag_64<C, S> *flag);
4664 extern void __kmp_resume_oncore(int target_gtid, kmp_flag_oncore *flag);
4665 
4666 template <bool C, bool S>
4667 int __kmp_execute_tasks_32(kmp_info_t *thread, kmp_int32 gtid,
4668  kmp_flag_32<C, S> *flag, int final_spin,
4669  int *thread_finished,
4670 #if USE_ITT_BUILD
4671  void *itt_sync_obj,
4672 #endif /* USE_ITT_BUILD */
4673  kmp_int32 is_constrained);
4674 template <bool C, bool S>
4675 int __kmp_execute_tasks_64(kmp_info_t *thread, kmp_int32 gtid,
4676  kmp_flag_64<C, S> *flag, int final_spin,
4677  int *thread_finished,
4678 #if USE_ITT_BUILD
4679  void *itt_sync_obj,
4680 #endif /* USE_ITT_BUILD */
4681  kmp_int32 is_constrained);
4682 template <bool C, bool S>
4683 int __kmp_atomic_execute_tasks_64(kmp_info_t *thread, kmp_int32 gtid,
4684  kmp_atomic_flag_64<C, S> *flag,
4685  int final_spin, int *thread_finished,
4686 #if USE_ITT_BUILD
4687  void *itt_sync_obj,
4688 #endif /* USE_ITT_BUILD */
4689  kmp_int32 is_constrained);
4690 int __kmp_execute_tasks_oncore(kmp_info_t *thread, kmp_int32 gtid,
4691  kmp_flag_oncore *flag, int final_spin,
4692  int *thread_finished,
4693 #if USE_ITT_BUILD
4694  void *itt_sync_obj,
4695 #endif /* USE_ITT_BUILD */
4696  kmp_int32 is_constrained);
4697 
4698 extern int __kmp_nesting_mode;
4699 extern int __kmp_nesting_mode_nlevels;
4700 extern int *__kmp_nesting_nth_level;
4701 extern void __kmp_init_nesting_mode();
4702 extern void __kmp_set_nesting_mode_threads();
4703 
4711  FILE *f;
4712 
4713  void close() {
4714  if (f && f != stdout && f != stderr) {
4715  fclose(f);
4716  f = nullptr;
4717  }
4718  }
4719 
4720 public:
4721  kmp_safe_raii_file_t() : f(nullptr) {}
4722  kmp_safe_raii_file_t(const char *filename, const char *mode,
4723  const char *env_var = nullptr)
4724  : f(nullptr) {
4725  open(filename, mode, env_var);
4726  }
4727  kmp_safe_raii_file_t(const kmp_safe_raii_file_t &other) = delete;
4728  kmp_safe_raii_file_t &operator=(const kmp_safe_raii_file_t &other) = delete;
4729  ~kmp_safe_raii_file_t() { close(); }
4730 
4734  void open(const char *filename, const char *mode,
4735  const char *env_var = nullptr) {
4736  KMP_ASSERT(!f);
4737  f = fopen(filename, mode);
4738  if (!f) {
4739  int code = errno;
4740  if (env_var) {
4741  __kmp_fatal(KMP_MSG(CantOpenFileForReading, filename), KMP_ERR(code),
4742  KMP_HNT(CheckEnvVar, env_var, filename), __kmp_msg_null);
4743  } else {
4744  __kmp_fatal(KMP_MSG(CantOpenFileForReading, filename), KMP_ERR(code),
4745  __kmp_msg_null);
4746  }
4747  }
4748  }
4751  int try_open(const char *filename, const char *mode) {
4752  KMP_ASSERT(!f);
4753  f = fopen(filename, mode);
4754  if (!f)
4755  return errno;
4756  return 0;
4757  }
4760  void set_stdout() {
4761  KMP_ASSERT(!f);
4762  f = stdout;
4763  }
4766  void set_stderr() {
4767  KMP_ASSERT(!f);
4768  f = stderr;
4769  }
4770  operator bool() { return bool(f); }
4771  operator FILE *() { return f; }
4772 };
4773 
4774 template <typename SourceType, typename TargetType,
4775  bool isSourceSmaller = (sizeof(SourceType) < sizeof(TargetType)),
4776  bool isSourceEqual = (sizeof(SourceType) == sizeof(TargetType)),
4777  bool isSourceSigned = std::is_signed<SourceType>::value,
4778  bool isTargetSigned = std::is_signed<TargetType>::value>
4779 struct kmp_convert {};
4780 
4781 // Both types are signed; Source smaller
4782 template <typename SourceType, typename TargetType>
4783 struct kmp_convert<SourceType, TargetType, true, false, true, true> {
4784  static TargetType to(SourceType src) { return (TargetType)src; }
4785 };
4786 // Source equal
4787 template <typename SourceType, typename TargetType>
4788 struct kmp_convert<SourceType, TargetType, false, true, true, true> {
4789  static TargetType to(SourceType src) { return src; }
4790 };
4791 // Source bigger
4792 template <typename SourceType, typename TargetType>
4793 struct kmp_convert<SourceType, TargetType, false, false, true, true> {
4794  static TargetType to(SourceType src) {
4795  KMP_ASSERT(src <= static_cast<SourceType>(
4796  (std::numeric_limits<TargetType>::max)()));
4797  KMP_ASSERT(src >= static_cast<SourceType>(
4798  (std::numeric_limits<TargetType>::min)()));
4799  return (TargetType)src;
4800  }
4801 };
4802 
4803 // Source signed, Target unsigned
4804 // Source smaller
4805 template <typename SourceType, typename TargetType>
4806 struct kmp_convert<SourceType, TargetType, true, false, true, false> {
4807  static TargetType to(SourceType src) {
4808  KMP_ASSERT(src >= 0);
4809  return (TargetType)src;
4810  }
4811 };
4812 // Source equal
4813 template <typename SourceType, typename TargetType>
4814 struct kmp_convert<SourceType, TargetType, false, true, true, false> {
4815  static TargetType to(SourceType src) {
4816  KMP_ASSERT(src >= 0);
4817  return (TargetType)src;
4818  }
4819 };
4820 // Source bigger
4821 template <typename SourceType, typename TargetType>
4822 struct kmp_convert<SourceType, TargetType, false, false, true, false> {
4823  static TargetType to(SourceType src) {
4824  KMP_ASSERT(src >= 0);
4825  KMP_ASSERT(src <= static_cast<SourceType>(
4826  (std::numeric_limits<TargetType>::max)()));
4827  return (TargetType)src;
4828  }
4829 };
4830 
4831 // Source unsigned, Target signed
4832 // Source smaller
4833 template <typename SourceType, typename TargetType>
4834 struct kmp_convert<SourceType, TargetType, true, false, false, true> {
4835  static TargetType to(SourceType src) { return (TargetType)src; }
4836 };
4837 // Source equal
4838 template <typename SourceType, typename TargetType>
4839 struct kmp_convert<SourceType, TargetType, false, true, false, true> {
4840  static TargetType to(SourceType src) {
4841  KMP_ASSERT(src <= static_cast<SourceType>(
4842  (std::numeric_limits<TargetType>::max)()));
4843  return (TargetType)src;
4844  }
4845 };
4846 // Source bigger
4847 template <typename SourceType, typename TargetType>
4848 struct kmp_convert<SourceType, TargetType, false, false, false, true> {
4849  static TargetType to(SourceType src) {
4850  KMP_ASSERT(src <= static_cast<SourceType>(
4851  (std::numeric_limits<TargetType>::max)()));
4852  return (TargetType)src;
4853  }
4854 };
4855 
4856 // Source unsigned, Target unsigned
4857 // Source smaller
4858 template <typename SourceType, typename TargetType>
4859 struct kmp_convert<SourceType, TargetType, true, false, false, false> {
4860  static TargetType to(SourceType src) { return (TargetType)src; }
4861 };
4862 // Source equal
4863 template <typename SourceType, typename TargetType>
4864 struct kmp_convert<SourceType, TargetType, false, true, false, false> {
4865  static TargetType to(SourceType src) { return src; }
4866 };
4867 // Source bigger
4868 template <typename SourceType, typename TargetType>
4869 struct kmp_convert<SourceType, TargetType, false, false, false, false> {
4870  static TargetType to(SourceType src) {
4871  KMP_ASSERT(src <= static_cast<SourceType>(
4872  (std::numeric_limits<TargetType>::max)()));
4873  return (TargetType)src;
4874  }
4875 };
4876 
4877 template <typename T1, typename T2>
4878 static inline void __kmp_type_convert(T1 src, T2 *dest) {
4879  *dest = kmp_convert<T1, T2>::to(src);
4880 }
4881 
4882 #endif /* KMP_H */
void set_stdout()
Definition: kmp.h:4760
void set_stderr()
Definition: kmp.h:4766
int try_open(const char *filename, const char *mode)
Definition: kmp.h:4751
void open(const char *filename, const char *mode, const char *env_var=nullptr)
Definition: kmp.h:4734
struct ident ident_t
@ KMP_IDENT_KMPC
Definition: kmp.h:179
@ KMP_IDENT_IMB
Definition: kmp.h:177
@ KMP_IDENT_WORK_LOOP
Definition: kmp.h:197
@ KMP_IDENT_BARRIER_IMPL
Definition: kmp.h:188
@ KMP_IDENT_WORK_SECTIONS
Definition: kmp.h:199
@ KMP_IDENT_AUTOPAR
Definition: kmp.h:182
@ KMP_IDENT_ATOMIC_HINT_MASK
Definition: kmp.h:206
@ KMP_IDENT_WORK_DISTRIBUTE
Definition: kmp.h:201
@ KMP_IDENT_BARRIER_EXPL
Definition: kmp.h:186
@ KMP_IDENT_ATOMIC_REDUCE
Definition: kmp.h:184
KMP_EXPORT kmp_int32 __kmpc_ok_to_fork(ident_t *)
KMP_EXPORT void __kmpc_fork_teams(ident_t *loc, kmp_int32 argc, kmpc_micro microtask,...)
KMP_EXPORT void __kmpc_fork_call_if(ident_t *loc, kmp_int32 nargs, kmpc_micro microtask, kmp_int32 cond, void *args)
KMP_EXPORT void __kmpc_push_num_threads(ident_t *loc, kmp_int32 global_tid, kmp_int32 num_threads)
KMP_EXPORT void __kmpc_set_thread_limit(ident_t *loc, kmp_int32 global_tid, kmp_int32 thread_limit)
KMP_EXPORT void __kmpc_serialized_parallel(ident_t *, kmp_int32 global_tid)
KMP_EXPORT void __kmpc_push_num_threads_list(ident_t *loc, kmp_int32 global_tid, kmp_uint32 list_length, kmp_int32 *num_threads_list)
KMP_EXPORT void __kmpc_push_num_teams(ident_t *loc, kmp_int32 global_tid, kmp_int32 num_teams, kmp_int32 num_threads)
KMP_EXPORT void __kmpc_fork_call(ident_t *, kmp_int32 nargs, kmpc_micro microtask,...)
KMP_EXPORT void __kmpc_end_serialized_parallel(ident_t *, kmp_int32 global_tid)
void(* kmpc_micro)(kmp_int32 *global_tid, kmp_int32 *bound_tid,...)
Definition: kmp.h:1764
KMP_EXPORT void __kmpc_push_num_teams_51(ident_t *loc, kmp_int32 global_tid, kmp_int32 num_teams_lb, kmp_int32 num_teams_ub, kmp_int32 num_threads)
KMP_EXPORT void __kmpc_begin(ident_t *, kmp_int32 flags)
KMP_EXPORT void __kmpc_end(ident_t *)
KMP_EXPORT void __kmpc_end_reduce(ident_t *loc, kmp_int32 global_tid, kmp_critical_name *lck)
KMP_EXPORT void __kmpc_end_barrier_master(ident_t *, kmp_int32 global_tid)
KMP_EXPORT kmp_int32 __kmpc_barrier_master_nowait(ident_t *, kmp_int32 global_tid)
KMP_EXPORT void __kmpc_end_reduce_nowait(ident_t *loc, kmp_int32 global_tid, kmp_critical_name *lck)
KMP_EXPORT kmp_int32 __kmpc_reduce(ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size, void *reduce_data, void(*reduce_func)(void *lhs_data, void *rhs_data), kmp_critical_name *lck)
KMP_EXPORT void __kmpc_barrier(ident_t *, kmp_int32 global_tid)
KMP_EXPORT void __kmpc_flush(ident_t *)
KMP_EXPORT kmp_int32 __kmpc_barrier_master(ident_t *, kmp_int32 global_tid)
KMP_EXPORT kmp_int32 __kmpc_reduce_nowait(ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size, void *reduce_data, void(*reduce_func)(void *lhs_data, void *rhs_data), kmp_critical_name *lck)
void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val, kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup, int sched, kmp_uint64 grainsize, void *task_dup)
KMP_EXPORT void * __kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num, void *data)
KMP_EXPORT void * __kmpc_taskred_init(int gtid, int num_data, void *data)
KMP_EXPORT void * __kmpc_task_reduction_init(int gtid, int num_data, void *data)
KMP_EXPORT bool __kmpc_omp_has_task_team(kmp_int32 gtid)
KMP_EXPORT void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask)
KMP_EXPORT void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid, int is_ws)
KMP_EXPORT kmp_int32 __kmpc_omp_task_with_deps(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 ndeps, kmp_depend_info_t *dep_list, kmp_int32 ndeps_noalias, kmp_depend_info_t *noalias_dep_list)
KMP_EXPORT kmp_int32 __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 naffins, kmp_task_affinity_info_t *affin_list)
KMP_EXPORT void * __kmpc_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws, int num, void *data)
void __kmpc_taskloop_5(ident_t *loc, int gtid, kmp_task_t *task, int if_val, kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup, int sched, kmp_uint64 grainsize, int modifier, void *task_dup)
KMP_EXPORT void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask)
KMP_EXPORT void __kmpc_omp_wait_deps(ident_t *loc_ref, kmp_int32 gtid, kmp_int32 ndeps, kmp_depend_info_t *dep_list, kmp_int32 ndeps_noalias, kmp_depend_info_t *noalias_dep_list)
KMP_EXPORT void * __kmpc_task_reduction_get_th_data(int gtid, void *tg, void *d)
KMP_EXPORT void ** __kmpc_omp_get_target_async_handle_ptr(kmp_int32 gtid)
void(* kmpc_dtor)(void *)
Definition: kmp.h:1788
KMP_EXPORT void __kmpc_threadprivate_register(ident_t *, void *data, kmpc_ctor ctor, kmpc_cctor cctor, kmpc_dtor dtor)
KMP_EXPORT void __kmpc_copyprivate(ident_t *loc, kmp_int32 global_tid, size_t cpy_size, void *cpy_data, void(*cpy_func)(void *, void *), kmp_int32 didit)
void *(* kmpc_ctor)(void *)
Definition: kmp.h:1782
void *(* kmpc_ctor_vec)(void *, size_t)
Definition: kmp.h:1805
void *(* kmpc_cctor)(void *, void *)
Definition: kmp.h:1795
KMP_EXPORT void * __kmpc_threadprivate_cached(ident_t *loc, kmp_int32 global_tid, void *data, size_t size, void ***cache)
void *(* kmpc_cctor_vec)(void *, void *, size_t)
Definition: kmp.h:1817
void(* kmpc_dtor_vec)(void *, size_t)
Definition: kmp.h:1811
KMP_EXPORT void __kmpc_threadprivate_register_vec(ident_t *, void *data, kmpc_ctor_vec ctor, kmpc_cctor_vec cctor, kmpc_dtor_vec dtor, size_t vector_length)
KMP_EXPORT void * __kmpc_copyprivate_light(ident_t *loc, kmp_int32 gtid, void *cpy_data)
KMP_EXPORT kmp_int32 __kmpc_global_num_threads(ident_t *)
KMP_EXPORT kmp_int32 __kmpc_global_thread_num(ident_t *)
KMP_EXPORT kmp_int32 __kmpc_in_parallel(ident_t *loc)
KMP_EXPORT kmp_int32 __kmpc_bound_thread_num(ident_t *)
KMP_EXPORT kmp_int32 __kmpc_bound_num_threads(ident_t *)
KMP_EXPORT void __kmpc_end_ordered(ident_t *, kmp_int32 global_tid)
KMP_EXPORT void __kmpc_end_critical(ident_t *, kmp_int32 global_tid, kmp_critical_name *)
KMP_EXPORT void __kmpc_for_static_fini(ident_t *loc, kmp_int32 global_tid)
int __kmpc_dispatch_next_4(ident_t *loc, kmp_int32 gtid, kmp_int32 *p_last, kmp_int32 *p_lb, kmp_int32 *p_ub, kmp_int32 *p_st)
sched_type
Definition: kmp.h:340
KMP_EXPORT void __kmpc_end_masked(ident_t *, kmp_int32 global_tid)
void __kmpc_dispatch_fini_4(ident_t *loc, kmp_int32 gtid)
void __kmpc_dispatch_deinit(ident_t *loc, kmp_int32 gtid)
KMP_EXPORT kmp_int32 __kmpc_master(ident_t *, kmp_int32 global_tid)
KMP_EXPORT void __kmpc_critical_with_hint(ident_t *, kmp_int32 global_tid, kmp_critical_name *, uint32_t hint)
KMP_EXPORT kmp_int32 __kmpc_single(ident_t *, kmp_int32 global_tid)
KMP_EXPORT kmp_int32 __kmpc_next_section(ident_t *loc, kmp_int32 global_tid, kmp_int32 numberOfSections)
void __kmpc_doacross_init(ident_t *loc, int gtid, int num_dims, const struct kmp_dim *dims)
int __kmpc_dispatch_next_4u(ident_t *loc, kmp_int32 gtid, kmp_int32 *p_last, kmp_uint32 *p_lb, kmp_uint32 *p_ub, kmp_int32 *p_st)
KMP_EXPORT void __kmpc_end_master(ident_t *, kmp_int32 global_tid)
KMP_EXPORT void __kmpc_end_sections(ident_t *loc, kmp_int32 global_tid)
KMP_EXPORT void __kmpc_end_single(ident_t *, kmp_int32 global_tid)
int __kmpc_dispatch_next_8u(ident_t *loc, kmp_int32 gtid, kmp_int32 *p_last, kmp_uint64 *p_lb, kmp_uint64 *p_ub, kmp_int64 *p_st)
void __kmpc_dispatch_fini_8(ident_t *loc, kmp_int32 gtid)
KMP_EXPORT kmp_int32 __kmpc_sections_init(ident_t *loc, kmp_int32 global_tid)
int __kmpc_dispatch_next_8(ident_t *loc, kmp_int32 gtid, kmp_int32 *p_last, kmp_int64 *p_lb, kmp_int64 *p_ub, kmp_int64 *p_st)
void __kmpc_dispatch_fini_8u(ident_t *loc, kmp_int32 gtid)
KMP_EXPORT void __kmpc_ordered(ident_t *, kmp_int32 global_tid)
KMP_EXPORT kmp_int32 __kmpc_masked(ident_t *, kmp_int32 global_tid, kmp_int32 filter)
void __kmpc_dispatch_init_4(ident_t *loc, kmp_int32 gtid, enum sched_type schedule, kmp_int32 lb, kmp_int32 ub, kmp_int32 st, kmp_int32 chunk)
void __kmpc_dispatch_init_4u(ident_t *loc, kmp_int32 gtid, enum sched_type schedule, kmp_uint32 lb, kmp_uint32 ub, kmp_int32 st, kmp_int32 chunk)
void __kmpc_dispatch_init_8u(ident_t *loc, kmp_int32 gtid, enum sched_type schedule, kmp_uint64 lb, kmp_uint64 ub, kmp_int64 st, kmp_int64 chunk)
void __kmpc_dispatch_fini_4u(ident_t *loc, kmp_int32 gtid)
void __kmpc_dispatch_init_8(ident_t *loc, kmp_int32 gtid, enum sched_type schedule, kmp_int64 lb, kmp_int64 ub, kmp_int64 st, kmp_int64 chunk)
KMP_EXPORT void __kmpc_critical(ident_t *, kmp_int32 global_tid, kmp_critical_name *)
@ kmp_nm_guided_chunked
Definition: kmp.h:391
@ kmp_sch_runtime_simd
Definition: kmp.h:362
@ kmp_nm_ord_auto
Definition: kmp.h:410
@ kmp_sch_auto
Definition: kmp.h:347
@ kmp_nm_auto
Definition: kmp.h:393
@ kmp_distribute_static_chunked
Definition: kmp.h:378
@ kmp_sch_static
Definition: kmp.h:343
@ kmp_sch_guided_simd
Definition: kmp.h:361
@ kmp_sch_modifier_monotonic
Definition: kmp.h:428
@ kmp_sch_default
Definition: kmp.h:448
@ kmp_sch_modifier_nonmonotonic
Definition: kmp.h:430
@ kmp_nm_ord_static
Definition: kmp.h:406
@ kmp_distribute_static
Definition: kmp.h:379
@ kmp_sch_guided_chunked
Definition: kmp.h:345
@ kmp_nm_static
Definition: kmp.h:389
@ kmp_sch_lower
Definition: kmp.h:341
@ kmp_nm_upper
Definition: kmp.h:412
@ kmp_ord_lower
Definition: kmp.h:367
@ kmp_ord_static
Definition: kmp.h:369
@ kmp_sch_upper
Definition: kmp.h:365
@ kmp_ord_upper
Definition: kmp.h:375
@ kmp_nm_lower
Definition: kmp.h:385
@ kmp_ord_auto
Definition: kmp.h:373
Definition: kmp.h:217
kmp_int32 reserved_1
Definition: kmp.h:218
char const * psource
Definition: kmp.h:227
kmp_int32 reserved_2
Definition: kmp.h:221
kmp_int32 reserved_3
Definition: kmp.h:226
kmp_int32 flags
Definition: kmp.h:219
Memory allocator information is shared with offload runtime.
Definition: kmp.h:1104
Memory space informaition is shared with offload runtime.
Definition: kmp.h:1096