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
75class 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
175enum {
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
217typedef 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.
241typedef union kmp_team kmp_team_t;
242typedef struct kmp_taskdata kmp_taskdata_t;
243typedef union kmp_task_team kmp_task_team_t;
244typedef union kmp_team kmp_team_p;
245typedef union kmp_info kmp_info_p;
246typedef union kmp_root kmp_root_p;
247
248template <bool C = false, bool S = true> class kmp_flag_32;
249template <bool C = false, bool S = true> class kmp_flag_64;
250template <bool C = false, bool S = true> class kmp_atomic_flag_64;
251class kmp_flag_oncore;
252
253#ifdef __cplusplus
254extern "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
295enum kmp_state_timer {
296 ts_stop,
297 ts_start,
298 ts_pause,
299
300 ts_last_state
301};
302
303enum 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
317typedef 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
340enum 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. */
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,
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
450
451// Apply modifiers on internal kind to standard kind
452static 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
461static 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
471static 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() */
476typedef 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
484extern enum sched_type __kmp_sch_map[]; // map OMP 3.0 schedule types with our
485// internal schedule types
486
487enum library_type {
488 library_none,
489 library_serial,
490 library_turnaround,
491 library_throughput
492};
493
494#if KMP_MIC_SUPPORTED
495enum mic_type { non_mic, mic1, mic2, mic3, dummy };
496#endif
497
498// OpenMP 3.1 - Nested num threads array
499typedef struct kmp_nested_nthreads_t {
500 int *nth;
501 int size;
502 int used;
503} kmp_nested_nthreads_t;
504
505extern 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
517enum _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
568typedef 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
591enum 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
608typedef 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
630const char *__kmp_hw_get_keyword(kmp_hw_t type, bool plural = false);
631const char *__kmp_hw_get_catalog_string(kmp_hw_t type, bool plural = false);
632const 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
640typedef 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
647extern int __kmp_num_proc_groups;
648#else
649static const int __kmp_num_proc_groups = 1;
650#endif /* KMP_GROUP_AFFINITY */
651typedef DWORD (*kmp_GetActiveProcessorCount_t)(WORD);
652extern kmp_GetActiveProcessorCount_t __kmp_GetActiveProcessorCount;
653
654typedef WORD (*kmp_GetActiveProcessorGroupCount_t)(void);
655extern kmp_GetActiveProcessorGroupCount_t __kmp_GetActiveProcessorGroupCount;
656
657typedef BOOL (*kmp_GetThreadGroupAffinity_t)(HANDLE, GROUP_AFFINITY *);
658extern kmp_GetThreadGroupAffinity_t __kmp_GetThreadGroupAffinity;
659
660typedef BOOL (*kmp_SetThreadGroupAffinity_t)(HANDLE, const GROUP_AFFINITY *,
661 GROUP_AFFINITY *);
662extern kmp_SetThreadGroupAffinity_t __kmp_SetThreadGroupAffinity;
663#endif /* KMP_OS_WINDOWS */
664
665#if KMP_HWLOC_ENABLED
666extern hwloc_topology_t __kmp_hwloc_topology;
667extern int __kmp_hwloc_error;
668#endif // KMP_HWLOC_ENABLED
669
670extern 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
705class KMPAffinity {
706public:
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
787private:
788 static bool picked_api;
789};
790
791typedef KMPAffinity::Mask kmp_affin_mask_t;
792extern KMPAffinity *__kmp_affinity_dispatch;
793
794#if !KMP_OS_AIX
795class kmp_affinity_raii_t {
796 kmp_affin_mask_t *mask;
797 bool restored;
798
799public:
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
825enum 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
837enum 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
857typedef 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;
869KMP_BUILD_ASSERT(sizeof(kmp_affinity_flags_t) == 4);
870
871typedef struct kmp_affinity_ids_t {
872 int os_id;
873 int ids[KMP_HW_LAST];
874} kmp_affinity_ids_t;
875
876typedef 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
885typedef 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
912extern enum affinity_top_method __kmp_affinity_top_method;
913extern kmp_affinity_t __kmp_affinity;
914extern kmp_affinity_t __kmp_hh_affinity;
915extern kmp_affinity_t *__kmp_affinities[2];
916
917extern void __kmp_affinity_bind_thread(int which);
918
919extern kmp_affin_mask_t *__kmp_affin_fullMask;
920extern kmp_affin_mask_t *__kmp_affin_origMask;
921extern char *__kmp_cpuinfo_file;
922
923#if KMP_WEIGHTED_ITERATIONS_SUPPORTED
924extern 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 !!!
930typedef 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
940typedef 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
946extern kmp_nested_proc_bind_t __kmp_nested_proc_bind;
947extern kmp_proc_bind_t __kmp_teams_proc_bind;
948
949extern int __kmp_display_affinity;
950extern char *__kmp_affinity_format;
951static const size_t KMP_AFFINITY_FORMAT_SIZE = 512;
952#if OMPT_SUPPORT
953extern int __kmp_tool;
954extern 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
967extern int __kmp_affinity_num_places;
968
969typedef 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:
978typedef struct kmp_hws_item {
979 int num;
980 int offset;
981} kmp_hws_item_t;
982
983extern kmp_hws_item_t __kmp_hws_socket;
984extern kmp_hws_item_t __kmp_hws_die;
985extern kmp_hws_item_t __kmp_hws_node;
986extern kmp_hws_item_t __kmp_hws_tile;
987extern kmp_hws_item_t __kmp_hws_core;
988extern kmp_hws_item_t __kmp_hws_proc;
989extern int __kmp_hws_requested;
990extern 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
1009typedef uintptr_t omp_uintptr_t;
1010
1011typedef 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
1028typedef 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
1055typedef void *omp_memspace_handle_t;
1056extern omp_memspace_handle_t const omp_null_mem_space;
1057extern omp_memspace_handle_t const omp_default_mem_space;
1058extern omp_memspace_handle_t const omp_large_cap_mem_space;
1059extern omp_memspace_handle_t const omp_const_mem_space;
1060extern omp_memspace_handle_t const omp_high_bw_mem_space;
1061extern omp_memspace_handle_t const omp_low_lat_mem_space;
1062extern omp_memspace_handle_t const omp_cgroup_mem_space;
1063extern omp_memspace_handle_t const llvm_omp_target_host_mem_space;
1064extern omp_memspace_handle_t const llvm_omp_target_shared_mem_space;
1065extern omp_memspace_handle_t const llvm_omp_target_device_mem_space;
1066extern omp_memspace_handle_t const kmp_max_mem_space;
1067
1068typedef struct {
1069 omp_alloctrait_key_t key;
1070 omp_uintptr_t value;
1071} omp_alloctrait_t;
1072
1073typedef void *omp_allocator_handle_t;
1074extern omp_allocator_handle_t const omp_null_allocator;
1075extern omp_allocator_handle_t const omp_default_mem_alloc;
1076extern omp_allocator_handle_t const omp_large_cap_mem_alloc;
1077extern omp_allocator_handle_t const omp_const_mem_alloc;
1078extern omp_allocator_handle_t const omp_high_bw_mem_alloc;
1079extern omp_allocator_handle_t const omp_low_lat_mem_alloc;
1080extern omp_allocator_handle_t const omp_cgroup_mem_alloc;
1081extern omp_allocator_handle_t const omp_pteam_mem_alloc;
1082extern omp_allocator_handle_t const omp_thread_mem_alloc;
1083extern omp_allocator_handle_t const llvm_omp_target_host_mem_alloc;
1084extern omp_allocator_handle_t const llvm_omp_target_shared_mem_alloc;
1085extern omp_allocator_handle_t const llvm_omp_target_device_mem_alloc;
1086extern omp_allocator_handle_t const kmp_max_mem_alloc;
1087extern omp_allocator_handle_t __kmp_def_allocator;
1088
1089// end of duplicate type definitions from omp.h
1090#endif
1091
1092extern int __kmp_memkind_available;
1093extern bool __kmp_hwloc_available;
1094
1096typedef 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
1102
1104typedef 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
1123
1124extern omp_allocator_handle_t __kmpc_init_allocator(int gtid,
1125 omp_memspace_handle_t,
1126 int ntraits,
1127 omp_alloctrait_t traits[]);
1128extern void __kmpc_destroy_allocator(int gtid, omp_allocator_handle_t al);
1129extern void __kmpc_set_default_allocator(int gtid, omp_allocator_handle_t al);
1130extern omp_allocator_handle_t __kmpc_get_default_allocator(int gtid);
1131// external interfaces, may be used by compiler
1132extern void *__kmpc_alloc(int gtid, size_t sz, omp_allocator_handle_t al);
1133extern void *__kmpc_aligned_alloc(int gtid, size_t align, size_t sz,
1134 omp_allocator_handle_t al);
1135extern void *__kmpc_calloc(int gtid, size_t nmemb, size_t sz,
1136 omp_allocator_handle_t al);
1137extern void *__kmpc_realloc(int gtid, void *ptr, size_t sz,
1138 omp_allocator_handle_t al,
1139 omp_allocator_handle_t free_al);
1140extern void __kmpc_free(int gtid, void *ptr, omp_allocator_handle_t al);
1141// internal interfaces, contain real implementation
1142extern void *__kmp_alloc(int gtid, size_t align, size_t sz,
1143 omp_allocator_handle_t al);
1144extern void *__kmp_calloc(int gtid, size_t align, size_t nmemb, size_t sz,
1145 omp_allocator_handle_t al);
1146extern void *__kmp_realloc(int gtid, void *ptr, size_t sz,
1147 omp_allocator_handle_t al,
1148 omp_allocator_handle_t free_al);
1149extern void ___kmpc_free(int gtid, void *ptr, omp_allocator_handle_t al);
1150
1151extern void __kmp_init_memkind();
1152extern void __kmp_fini_memkind();
1153extern void __kmp_init_target_mem();
1154extern void __kmp_fini_target_mem();
1155
1156// OpenMP 6.0 (TR11) Memory Management support
1157extern omp_memspace_handle_t __kmp_get_devices_memspace(int ndevs,
1158 const int *devs,
1159 omp_memspace_handle_t,
1160 int host);
1161extern omp_allocator_handle_t __kmp_get_devices_allocator(int ndevs,
1162 const int *devs,
1163 omp_memspace_handle_t,
1164 int host);
1165extern int __kmp_get_memspace_num_resources(omp_memspace_handle_t memspace);
1166extern 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
1173extern 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).
1275extern kmp_uint64 __kmp_ticks_per_msec;
1276extern 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.
1287extern 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
1395typedef struct kmp_cpuid {
1396 kmp_uint32 eax;
1397 kmp_uint32 ebx;
1398 kmp_uint32 ecx;
1399 kmp_uint32 edx;
1400} kmp_cpuid_t;
1401
1402typedef 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
1409typedef 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
1422extern 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
1427static 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
1433static 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
1437static inline void __kmp_store_x87_fpu_control_word(kmp_int16 *p) {
1438 __asm__ __volatile__("fstcw %0" : "=m"(*p));
1439}
1440static 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__
1462static inline void __kmp_load_mxcsr(const kmp_uint32 *p) { _mm_setcsr(*p); }
1463static inline void __kmp_store_mxcsr(kmp_uint32 *p) { *p = _mm_getcsr(); }
1464#else
1465static inline void __kmp_load_mxcsr(const kmp_uint32 *p) {}
1466static 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
1470extern void __kmp_x86_cpuid(int mode, int mode2, struct kmp_cpuid *p);
1471extern void __kmp_load_x87_fpu_control_word(const kmp_int16 *p);
1472extern void __kmp_store_x87_fpu_control_word(kmp_int16 *p);
1473extern void __kmp_clear_x87_fpu_status_word();
1474static inline void __kmp_load_mxcsr(const kmp_uint32 *p) { _mm_setcsr(*p); }
1475static 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
1491KMP_ATTRIBUTE_TARGET_WAITPKG
1492static 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}
1510KMP_ATTRIBUTE_TARGET_WAITPKG
1511static 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}
1521KMP_ATTRIBUTE_TARGET_WAITPKG
1522static 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
1549static 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
1556static 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
1563extern 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.
1569static inline void __kmp_x86_pause(void) { _mm_delay_32(300); }
1570#else
1571static 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 */
1682enum 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
1700struct 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
1708struct cons_header {
1709 int p_top, w_top, s_top;
1710 int stack_size, stack_top;
1711 struct cons_data *stack_data;
1712};
1713
1714struct 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
1724typedef HANDLE kmp_thread_t;
1725typedef DWORD kmp_key_t;
1726#endif /* KMP_OS_WINDOWS */
1727
1728#if KMP_OS_UNIX
1729typedef pthread_t kmp_thread_t;
1730typedef pthread_key_t kmp_key_t;
1731#endif
1732
1733extern kmp_key_t __kmp_gtid_threadprivate_key;
1734
1735typedef 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.
1749typedef int kmp_itt_mark_t;
1750#define KMP_ITT_DEBUG 0
1751#endif /* USE_ITT_BUILD */
1752
1753typedef kmp_int32 kmp_critical_name[8];
1754
1764typedef void (*kmpc_micro)(kmp_int32 *global_tid, kmp_int32 *bound_tid, ...);
1765typedef 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
1782typedef void *(*kmpc_ctor)(void *);
1783
1788typedef void (*kmpc_dtor)(
1789 void * /*, size_t */); /* 2nd arg: magic number for KCC unused by Intel
1790 compiler */
1795typedef 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 */
1805typedef void *(*kmpc_ctor_vec)(void *, size_t);
1811typedef void (*kmpc_dtor_vec)(void *, size_t);
1817typedef void *(*kmpc_cctor_vec)(void *, void *,
1818 size_t); /* function unused by compiler */
1819
1824/* keeps tracked of threadprivate cache allocations for cleanup later */
1825typedef 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
1832struct 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
1839struct 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
1847struct 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
1876struct common_table {
1877 struct private_common *data[KMP_HASH_TABLE_SIZE];
1878};
1879
1880struct 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
1889typedef 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
1896typedef 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
1905KMP_BUILD_ASSERT(sizeof(kmp_sched_flags_t) == 4);
1906
1907#if KMP_STATIC_STEAL_ENABLED
1908typedef 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
1944KMP_BUILD_ASSERT(sizeof(dispatch_private_info32_t) <= 128);
1945#endif
1946
1947typedef 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
1984KMP_BUILD_ASSERT(sizeof(dispatch_private_info64_t) <= 128);
1985#endif
1986
1987#else /* KMP_STATIC_STEAL_ENABLED */
1988typedef 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
2008typedef 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
2030typedef 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
2049typedef 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
2059typedef 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
2069typedef 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
2089typedef 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.
2144enum flag_type {
2145 flag32,
2146 flag64,
2147 atomic_flag64,
2148 flag_oncore,
2149 flag_unset
2150};
2151
2152enum 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
2167typedef 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 */
2182typedef 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
2205static 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 */
2211typedef 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
2244union 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
2250typedef union kmp_barrier_union kmp_balign_t;
2251
2252/* Team barrier needs only non-volatile arrived counter */
2253union 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
2269typedef 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
2276typedef struct kmp_win32_mutex {
2277 /* The Lock */
2278 CRITICAL_SECTION cs;
2279} kmp_win32_mutex_t;
2280
2281typedef 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
2302union KMP_ALIGN_CACHE kmp_cond_union {
2303 double c_align;
2304 char c_pad[CACHE_LINE];
2305 pthread_cond_t c_cond;
2306};
2307
2308typedef union kmp_cond_union kmp_cond_align_t;
2309
2310union KMP_ALIGN_CACHE kmp_mutex_union {
2311 double m_align;
2312 char m_pad[CACHE_LINE];
2313 pthread_mutex_t m_mutex;
2314};
2315
2316typedef union kmp_mutex_union kmp_mutex_align_t;
2317
2318#endif /* KMP_OS_UNIX */
2319
2320typedef 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
2345typedef 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
2351typedef 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
2437typedef 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
2444extern kmp_tasking_mode_t
2445 __kmp_tasking_mode; /* determines how/when to execute tasks */
2446extern int __kmp_task_stealing_constraint;
2447extern int __kmp_enable_task_throttling;
2448extern 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
2451extern kmp_int32 __kmp_max_task_priority;
2452// Set via KMP_TASKLOOP_MIN_TASKS if specified, defaults to 0 otherwise
2453extern 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))
2471typedef kmp_int32 (*kmp_routine_entry_t)(kmp_int32, void *);
2472
2473typedef 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 */
2484typedef 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
2500typedef 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
2512typedef union kmp_depnode kmp_depnode_t;
2513typedef struct kmp_depnode_list kmp_depnode_list_t;
2514typedef 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.
2525typedef 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:
2552struct 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
2560typedef 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
2573union 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
2579struct 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
2589typedef 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
2598typedef 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
2608typedef enum kmp_event_type_t {
2609 KMP_EVENT_UNINITIALIZED = 0,
2610 KMP_EVENT_ALLOW_COMPLETION = 1
2611} kmp_event_type_t;
2612
2613typedef 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
2624typedef enum kmp_tdg_status {
2625 KMP_TDG_NONE = 0,
2626 KMP_TDG_RECORDING = 1,
2627 KMP_TDG_READY = 2
2628} kmp_tdg_status_t;
2629
2630#endif
2631
2632typedef struct kmp_tasking_flags { /* Total struct must be exactly 32 bits */
2633#if defined(__BYTE_ORDER__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
2634 /* Same fields as in the #else branch, but in reverse order */
2635 unsigned reserved31 : 5;
2636 unsigned hidden_helper : 1;
2637 unsigned target : 1;
2638 unsigned native : 1;
2639 unsigned freed : 1;
2640 unsigned complete : 1;
2641 unsigned executing : 1;
2642 unsigned started : 1;
2643 unsigned team_serial : 1;
2644 unsigned tasking_ser : 1;
2645 unsigned task_serial : 1;
2646 unsigned tasktype : 1;
2647 unsigned reserved : 7;
2648 unsigned transparent : 1;
2649 unsigned free_agent_eligible : 1;
2650 unsigned detachable : 1;
2651 unsigned priority_specified : 1;
2652 unsigned proxy : 1;
2653 unsigned destructors_thunk : 1;
2654 unsigned merged_if0 : 1;
2655 unsigned final : 1;
2656 unsigned tiedness : 1;
2657#else
2658 /* Compiler flags */ /* Total compiler flags must be 16 bits */
2659 unsigned tiedness : 1; /* task is either tied (1) or untied (0) */
2660 unsigned final : 1; /* task is final(1) so execute immediately */
2661 unsigned merged_if0 : 1; /* no __kmpc_task_{begin/complete}_if0 calls in if0
2662 code path */
2663 unsigned destructors_thunk : 1; /* set if the compiler creates a thunk to
2664 invoke destructors from the runtime */
2665 unsigned proxy : 1; /* task is a proxy task (it will be executed outside the
2666 context of the RTL) */
2667 unsigned priority_specified : 1; /* set if the compiler provides priority
2668 setting for the task */
2669 unsigned detachable : 1; /* 1 == can detach */
2670 unsigned free_agent_eligible : 1; /* set if task can be executed by a
2671 free-agent thread */
2672 unsigned transparent : 1; /* transparent task support (compiler uses this) */
2673 unsigned reserved : 7; /* reserved for compiler use */
2674
2675 /* Library flags */ /* Total library flags must be 16 bits */
2676 unsigned tasktype : 1; /* task is either explicit(1) or implicit (0) */
2677 unsigned task_serial : 1; // task is executed immediately (1) or deferred (0)
2678 unsigned tasking_ser : 1; // all tasks in team are either executed immediately
2679 // (1) or may be deferred (0)
2680 unsigned team_serial : 1; // entire team is serial (1) [1 thread] or parallel
2681 // (0) [>= 2 threads]
2682 /* If either team_serial or tasking_ser is set, task team may be NULL */
2683 /* Task State Flags: */
2684 unsigned started : 1; /* 1==started, 0==not started */
2685 unsigned executing : 1; /* 1==executing, 0==not executing */
2686 unsigned complete : 1; /* 1==complete, 0==not complete */
2687 unsigned freed : 1; /* 1==freed, 0==allocated */
2688 unsigned native : 1; /* 1==gcc-compiled task, 0==intel */
2689 unsigned target : 1;
2690 unsigned hidden_helper : 1; /* 1 == hidden helper task */
2691 unsigned reserved31 : 5; /* reserved for library use */
2692#endif
2693} kmp_tasking_flags_t;
2694
2695typedef struct kmp_target_data {
2696 void *async_handle; // libomptarget async handle for task completion query
2697} kmp_target_data_t;
2698
2699struct kmp_taskdata { /* aligned during dynamic allocation */
2700 kmp_int32 td_task_id; /* id, assigned by debugger */
2701 kmp_tasking_flags_t td_flags; /* task flags */
2702 kmp_team_t *td_team; /* team for this task */
2703 kmp_info_p *td_alloc_thread; /* thread that allocated data structures */
2704 /* Currently not used except for perhaps IDB */
2705 kmp_taskdata_t *td_parent; /* parent task */
2706 kmp_int32 td_level; /* task nesting level */
2707 std::atomic<kmp_int32> td_untied_count; // untied task active parts counter
2708 ident_t *td_ident; /* task identifier */
2709 // Taskwait data.
2710 ident_t *td_taskwait_ident;
2711 kmp_uint32 td_taskwait_counter;
2712 kmp_int32 td_taskwait_thread; /* gtid + 1 of thread encountered taskwait */
2713 KMP_ALIGN_CACHE kmp_internal_control_t
2714 td_icvs; /* Internal control variables for the task */
2715 KMP_ALIGN_CACHE std::atomic<kmp_int32>
2716 td_allocated_child_tasks; /* Child tasks (+ current task) not yet
2717 deallocated */
2718 std::atomic<kmp_int32>
2719 td_incomplete_child_tasks; /* Child tasks not yet complete */
2720 kmp_taskgroup_t
2721 *td_taskgroup; // Each task keeps pointer to its current taskgroup
2722 kmp_dephash_t
2723 *td_dephash; // Dependencies for children tasks are tracked from here
2724 kmp_depnode_t
2725 *td_depnode; // Pointer to graph node if this task has dependencies
2726 kmp_task_team_t *td_task_team;
2727 size_t td_size_alloc; // Size of task structure, including shareds etc.
2728#if defined(KMP_GOMP_COMPAT)
2729 // 4 or 8 byte integers for the loop bounds in GOMP_taskloop
2730 kmp_int32 td_size_loop_bounds;
2731#endif
2732 kmp_taskdata_t *td_last_tied; // keep tied task for task scheduling constraint
2733#if defined(KMP_GOMP_COMPAT)
2734 // GOMP sends in a copy function for copy constructors
2735 void (*td_copy_func)(void *, void *);
2736#endif
2737 kmp_event_t td_allow_completion_event;
2738#if OMPT_SUPPORT
2739 ompt_task_info_t ompt_task_info;
2740#endif
2741#if OMP_TASKGRAPH_EXPERIMENTAL
2742#endif
2743 kmp_target_data_t td_target_data;
2744}; // struct kmp_taskdata
2745
2746// Make sure padding above worked
2747KMP_BUILD_ASSERT(sizeof(kmp_taskdata_t) % sizeof(void *) == 0);
2748
2749// Data for task team but per thread
2750typedef struct kmp_base_thread_data {
2751 kmp_info_p *td_thr; // Pointer back to thread info
2752 // Used only in __kmp_execute_tasks_template, maybe not avail until task is
2753 // queued?
2754 kmp_bootstrap_lock_t td_deque_lock; // Lock for accessing deque
2755 kmp_taskdata_t *
2756 *td_deque; // Deque of tasks encountered by td_thr, dynamically allocated
2757 kmp_int32 td_deque_size; // Size of deck
2758 kmp_uint32 td_deque_head; // Head of deque (will wrap)
2759 kmp_uint32 td_deque_tail; // Tail of deque (will wrap)
2760 kmp_int32 td_deque_ntasks; // Number of tasks in deque
2761 // GEH: shouldn't this be volatile since used in while-spin?
2762 kmp_int32 td_deque_last_stolen; // Thread number of last successful steal
2763} kmp_base_thread_data_t;
2764
2765#define TASK_DEQUE_BITS 8 // Used solely to define INITIAL_TASK_DEQUE_SIZE
2766#define INITIAL_TASK_DEQUE_SIZE (1 << TASK_DEQUE_BITS)
2767
2768#define TASK_DEQUE_SIZE(td) ((td).td_deque_size)
2769#define TASK_DEQUE_MASK(td) ((td).td_deque_size - 1)
2770
2771typedef union KMP_ALIGN_CACHE kmp_thread_data {
2772 kmp_base_thread_data_t td;
2773 double td_align; /* use worst case alignment */
2774 char td_pad[KMP_PAD(kmp_base_thread_data_t, CACHE_LINE)];
2775} kmp_thread_data_t;
2776
2777typedef struct kmp_task_pri {
2778 kmp_thread_data_t td;
2779 kmp_int32 priority;
2780 kmp_task_pri *next;
2781} kmp_task_pri_t;
2782
2783// Data for task teams which are used when tasking is enabled for the team
2784typedef struct kmp_base_task_team {
2785 kmp_bootstrap_lock_t
2786 tt_threads_lock; /* Lock used to allocate per-thread part of task team */
2787 /* must be bootstrap lock since used at library shutdown*/
2788
2789 // TODO: check performance vs kmp_tas_lock_t
2790 kmp_bootstrap_lock_t tt_task_pri_lock; /* Lock to access priority tasks */
2791 kmp_task_pri_t *tt_task_pri_list;
2792
2793 kmp_task_team_t *tt_next; /* For linking the task team free list */
2794 kmp_thread_data_t
2795 *tt_threads_data; /* Array of per-thread structures for task team */
2796 /* Data survives task team deallocation */
2797 kmp_int32 tt_found_tasks; /* Have we found tasks and queued them while
2798 executing this team? */
2799 /* TRUE means tt_threads_data is set up and initialized */
2800 kmp_int32 tt_nproc; /* #threads in team */
2801 kmp_int32 tt_max_threads; // # entries allocated for threads_data array
2802 kmp_int32 tt_found_proxy_tasks; // found proxy tasks since last barrier
2803 kmp_int32 tt_untied_task_encountered;
2804 std::atomic<kmp_int32> tt_num_task_pri; // number of priority tasks enqueued
2805 // There is hidden helper thread encountered in this task team so that we must
2806 // wait when waiting on task team
2807 kmp_int32 tt_hidden_helper_task_encountered;
2808
2809 KMP_ALIGN_CACHE
2810 std::atomic<kmp_int32> tt_unfinished_threads; /* #threads still active */
2811
2812 KMP_ALIGN_CACHE
2813 volatile kmp_uint32
2814 tt_active; /* is the team still actively executing tasks */
2815} kmp_base_task_team_t;
2816
2817union KMP_ALIGN_CACHE kmp_task_team {
2818 kmp_base_task_team_t tt;
2819 double tt_align; /* use worst case alignment */
2820 char tt_pad[KMP_PAD(kmp_base_task_team_t, CACHE_LINE)];
2821};
2822
2823typedef struct kmp_task_team_list_t {
2824 kmp_task_team_t *task_team;
2825 kmp_task_team_list_t *next;
2826} kmp_task_team_list_t;
2827
2828#if (USE_FAST_MEMORY == 3) || (USE_FAST_MEMORY == 5)
2829// Free lists keep same-size free memory slots for fast memory allocation
2830// routines
2831typedef struct kmp_free_list {
2832 void *th_free_list_self; // Self-allocated tasks free list
2833 void *th_free_list_sync; // Self-allocated tasks stolen/returned by other
2834 // threads
2835 void *th_free_list_other; // Non-self free list (to be returned to owner's
2836 // sync list)
2837} kmp_free_list_t;
2838#endif
2839// Hot teams array keeps hot teams and their sizes for given thread. Hot teams
2840// are not put in teams pool, and they don't put threads in threads pool.
2841typedef struct kmp_hot_team_ptr {
2842 kmp_team_p *hot_team; // pointer to hot_team of given nesting level
2843 kmp_int32 hot_team_nth; // number of threads allocated for the hot_team
2844} kmp_hot_team_ptr_t;
2845typedef struct kmp_teams_size {
2846 kmp_int32 nteams; // number of teams in a league
2847 kmp_int32 nth; // number of threads in each team of the league
2848} kmp_teams_size_t;
2849
2850// This struct stores a thread that acts as a "root" for a contention
2851// group. Contention groups are rooted at kmp_root threads, but also at
2852// each primary thread of each team created in the teams construct.
2853// This struct therefore also stores a thread_limit associated with
2854// that contention group, and a counter to track the number of threads
2855// active in that contention group. Each thread has a list of these: CG
2856// root threads have an entry in their list in which cg_root refers to
2857// the thread itself, whereas other workers in the CG will have a
2858// single entry where cg_root is same as the entry containing their CG
2859// root. When a thread encounters a teams construct, it will add a new
2860// entry to the front of its list, because it now roots a new CG.
2861typedef struct kmp_cg_root {
2862 kmp_info_p *cg_root; // "root" thread for a contention group
2863 // The CG root's limit comes from OMP_THREAD_LIMIT for root threads, or
2864 // thread_limit clause for teams primary threads
2865 kmp_int32 cg_thread_limit;
2866 kmp_int32 cg_nthreads; // Count of active threads in CG rooted at cg_root
2867 struct kmp_cg_root *up; // pointer to higher level CG root in list
2868} kmp_cg_root_t;
2869
2870// OpenMP thread data structures
2871
2872typedef struct KMP_ALIGN_CACHE kmp_base_info {
2873 /* Start with the readonly data which is cache aligned and padded. This is
2874 written before the thread starts working by the primary thread. Uber
2875 masters may update themselves later. Usage does not consider serialized
2876 regions. */
2877 kmp_desc_t th_info;
2878 kmp_team_p *th_team; /* team we belong to */
2879 kmp_root_p *th_root; /* pointer to root of task hierarchy */
2880 kmp_info_p *th_next_pool; /* next available thread in the pool */
2881 kmp_disp_t *th_dispatch; /* thread's dispatch data */
2882 int th_in_pool; /* in thread pool (32 bits for TCR/TCW) */
2883
2884 /* The following are cached from the team info structure */
2885 /* TODO use these in more places as determined to be needed via profiling */
2886 int th_team_nproc; /* number of threads in a team */
2887 kmp_info_p *th_team_master; /* the team's primary thread */
2888 int th_team_serialized; /* team is serialized */
2889 microtask_t th_teams_microtask; /* save entry address for teams construct */
2890 int th_teams_level; /* save initial level of teams construct */
2891/* it is 0 on device but may be any on host */
2892
2893/* The blocktime info is copied from the team struct to the thread struct */
2894/* at the start of a barrier, and the values stored in the team are used */
2895/* at points in the code where the team struct is no longer guaranteed */
2896/* to exist (from the POV of worker threads). */
2897#if KMP_USE_MONITOR
2898 int th_team_bt_intervals;
2899 int th_team_bt_set;
2900#else
2901 kmp_uint64 th_team_bt_intervals;
2902#endif
2903
2904#if KMP_AFFINITY_SUPPORTED
2905 kmp_affin_mask_t *th_affin_mask; /* thread's current affinity mask */
2906 kmp_affinity_ids_t th_topology_ids; /* thread's current topology ids */
2907 kmp_affinity_attrs_t th_topology_attrs; /* thread's current topology attrs */
2908#endif
2909 omp_allocator_handle_t th_def_allocator; /* default allocator */
2910 /* The data set by the primary thread at reinit, then R/W by the worker */
2911 KMP_ALIGN_CACHE int
2912 th_set_nproc; /* if > 0, then only use this request for the next fork */
2913 int *th_set_nested_nth;
2914 bool th_nt_strict; // num_threads clause has strict modifier
2915 ident_t *th_nt_loc; // loc for strict modifier
2916 int th_nt_sev; // error severity for strict modifier
2917 const char *th_nt_msg; // error message for strict modifier
2918 int th_set_nested_nth_sz;
2919 kmp_hot_team_ptr_t *th_hot_teams; /* array of hot teams */
2920 kmp_proc_bind_t
2921 th_set_proc_bind; /* if != proc_bind_default, use request for next fork */
2922 kmp_teams_size_t
2923 th_teams_size; /* number of teams/threads in teams construct */
2924#if KMP_AFFINITY_SUPPORTED
2925 int th_current_place; /* place currently bound to */
2926 int th_new_place; /* place to bind to in par reg */
2927 int th_first_place; /* first place in partition */
2928 int th_last_place; /* last place in partition */
2929#endif
2930 int th_prev_level; /* previous level for affinity format */
2931 int th_prev_num_threads; /* previous num_threads for affinity format */
2932#if USE_ITT_BUILD
2933 kmp_uint64 th_bar_arrive_time; /* arrival to barrier timestamp */
2934 kmp_uint64 th_bar_min_time; /* minimum arrival time at the barrier */
2935 kmp_uint64 th_frame_time; /* frame timestamp */
2936#endif /* USE_ITT_BUILD */
2937 kmp_local_t th_local;
2938 struct private_common *th_pri_head;
2939
2940 /* Now the data only used by the worker (after initial allocation) */
2941 /* TODO the first serial team should actually be stored in the info_t
2942 structure. this will help reduce initial allocation overhead */
2943 KMP_ALIGN_CACHE kmp_team_p
2944 *th_serial_team; /*serialized team held in reserve*/
2945
2946#if OMPT_SUPPORT
2947 ompt_thread_info_t ompt_thread_info;
2948#endif
2949
2950 /* The following are also read by the primary thread during reinit */
2951 struct common_table *th_pri_common;
2952
2953 volatile kmp_uint32 th_spin_here; /* thread-local location for spinning */
2954 /* while awaiting queuing lock acquire */
2955
2956 volatile void *th_sleep_loc; // this points at a kmp_flag<T>
2957 flag_type th_sleep_loc_type; // enum type of flag stored in th_sleep_loc
2958
2959 ident_t *th_ident;
2960 unsigned th_x; // Random number generator data
2961 unsigned th_a; // Random number generator data
2962
2963 /* Tasking-related data for the thread */
2964 kmp_task_team_t *th_task_team; // Task team struct
2965 kmp_taskdata_t *th_current_task; // Innermost Task being executed
2966 kmp_uint8 th_task_state; // alternating 0/1 for task team identification
2967 kmp_uint32 th_reap_state; // Non-zero indicates thread is not
2968 // tasking, thus safe to reap
2969
2970 /* More stuff for keeping track of active/sleeping threads (this part is
2971 written by the worker thread) */
2972 kmp_uint8 th_active_in_pool; // included in count of #active threads in pool
2973 int th_active; // ! sleeping; 32 bits for TCR/TCW
2974 std::atomic<kmp_uint32> th_used_in_team; // Flag indicating use in team
2975 // 0 = not used in team; 1 = used in team;
2976 // 2 = transitioning to not used in team; 3 = transitioning to used in team
2977 struct cons_header *th_cons; // used for consistency check
2978#if KMP_USE_HIER_SCHED
2979 // used for hierarchical scheduling
2980 kmp_hier_private_bdata_t *th_hier_bar_data;
2981#endif
2982
2983 /* Add the syncronizing data which is cache aligned and padded. */
2984 KMP_ALIGN_CACHE kmp_balign_t th_bar[bs_last_barrier];
2985
2986 KMP_ALIGN_CACHE volatile kmp_int32
2987 th_next_waiting; /* gtid+1 of next thread on lock wait queue, 0 if none */
2988
2989#if (USE_FAST_MEMORY == 3) || (USE_FAST_MEMORY == 5)
2990#define NUM_LISTS 4
2991 kmp_free_list_t th_free_lists[NUM_LISTS]; // Free lists for fast memory
2992// allocation routines
2993#endif
2994
2995#if KMP_OS_WINDOWS
2996 kmp_win32_cond_t th_suspend_cv;
2997 kmp_win32_mutex_t th_suspend_mx;
2998 std::atomic<int> th_suspend_init;
2999#endif
3000#if KMP_OS_UNIX
3001 kmp_cond_align_t th_suspend_cv;
3002 kmp_mutex_align_t th_suspend_mx;
3003 std::atomic<int> th_suspend_init_count;
3004#endif
3005
3006#if USE_ITT_BUILD
3007 kmp_itt_mark_t th_itt_mark_single;
3008// alignment ???
3009#endif /* USE_ITT_BUILD */
3010#if KMP_STATS_ENABLED
3011 kmp_stats_list *th_stats;
3012#endif
3013#if KMP_OS_UNIX
3014 std::atomic<bool> th_blocking;
3015#endif
3016 kmp_cg_root_t *th_cg_roots; // list of cg_roots associated with this thread
3017} kmp_base_info_t;
3018
3019typedef union KMP_ALIGN_CACHE kmp_info {
3020 double th_align; /* use worst case alignment */
3021 char th_pad[KMP_PAD(kmp_base_info_t, CACHE_LINE)];
3022 kmp_base_info_t th;
3023} kmp_info_t;
3024
3025// OpenMP thread team data structures
3026
3027typedef struct kmp_base_data {
3028 volatile kmp_uint32 t_value;
3029} kmp_base_data_t;
3030
3031typedef union KMP_ALIGN_CACHE kmp_sleep_team {
3032 double dt_align; /* use worst case alignment */
3033 char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
3034 kmp_base_data_t dt;
3035} kmp_sleep_team_t;
3036
3037typedef union KMP_ALIGN_CACHE kmp_ordered_team {
3038 double dt_align; /* use worst case alignment */
3039 char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
3040 kmp_base_data_t dt;
3041} kmp_ordered_team_t;
3042
3043typedef int (*launch_t)(int gtid);
3044
3045/* Minimum number of ARGV entries to malloc if necessary */
3046#define KMP_MIN_MALLOC_ARGV_ENTRIES 100
3047
3048// Set up how many argv pointers will fit in cache lines containing
3049// t_inline_argv. Historically, we have supported at least 96 bytes. Using a
3050// larger value for more space between the primary write/worker read section and
3051// read/write by all section seems to buy more performance on EPCC PARALLEL.
3052#if KMP_ARCH_X86 || KMP_ARCH_X86_64
3053#define KMP_INLINE_ARGV_BYTES \
3054 (4 * CACHE_LINE - \
3055 ((3 * KMP_PTR_SKIP + 2 * sizeof(int) + 2 * sizeof(kmp_int8) + \
3056 sizeof(kmp_int16) + sizeof(kmp_uint32)) % \
3057 CACHE_LINE))
3058#else
3059#define KMP_INLINE_ARGV_BYTES \
3060 (2 * CACHE_LINE - ((3 * KMP_PTR_SKIP + 2 * sizeof(int)) % CACHE_LINE))
3061#endif
3062#define KMP_INLINE_ARGV_ENTRIES (int)(KMP_INLINE_ARGV_BYTES / KMP_PTR_SKIP)
3063
3064typedef struct KMP_ALIGN_CACHE kmp_base_team {
3065 // Synchronization Data
3066 // ---------------------------------------------------------------------------
3067 KMP_ALIGN_CACHE kmp_ordered_team_t t_ordered;
3068 kmp_balign_team_t t_bar[bs_last_barrier];
3069 std::atomic<int> t_construct; // count of single directive encountered by team
3070 char pad[sizeof(kmp_lock_t)]; // padding to maintain performance on big iron
3071
3072 // [0] - parallel / [1] - worksharing task reduction data shared by taskgroups
3073 std::atomic<void *> t_tg_reduce_data[2]; // to support task modifier
3074 std::atomic<int> t_tg_fini_counter[2]; // sync end of task reductions
3075
3076 // Primary thread only
3077 // ---------------------------------------------------------------------------
3078 KMP_ALIGN_CACHE int t_master_tid; // tid of primary thread in parent team
3079 int t_master_this_cons; // "this_construct" single counter of primary thread
3080 // in parent team
3081 ident_t *t_ident; // if volatile, have to change too much other crud to
3082 // volatile too
3083 kmp_team_p *t_parent; // parent team
3084 kmp_team_p *t_next_pool; // next free team in the team pool
3085 kmp_disp_t *t_dispatch; // thread's dispatch data
3086 kmp_task_team_t *t_task_team[2]; // Task team struct; switch between 2
3087 kmp_proc_bind_t t_proc_bind; // bind type for par region
3088 int t_primary_task_state; // primary thread's task state saved
3089#if USE_ITT_BUILD
3090 kmp_uint64 t_region_time; // region begin timestamp
3091#endif /* USE_ITT_BUILD */
3092
3093 // Primary thread write, workers read
3094 // --------------------------------------------------------------------------
3095 KMP_ALIGN_CACHE void **t_argv;
3096 int t_argc;
3097 int t_nproc; // number of threads in team
3098 microtask_t t_pkfn;
3099 launch_t t_invoke; // procedure to launch the microtask
3100
3101#if OMPT_SUPPORT
3102 ompt_team_info_t ompt_team_info;
3103 ompt_lw_taskteam_t *ompt_serialized_team_info;
3104#endif
3105
3106#if KMP_ARCH_X86 || KMP_ARCH_X86_64
3107 kmp_int8 t_fp_control_saved;
3108 kmp_int8 t_pad2b;
3109 kmp_int16 t_x87_fpu_control_word; // FP control regs
3110 kmp_uint32 t_mxcsr;
3111#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
3112
3113 void *t_inline_argv[KMP_INLINE_ARGV_ENTRIES];
3114
3115 KMP_ALIGN_CACHE kmp_info_t **t_threads;
3116 kmp_taskdata_t
3117 *t_implicit_task_taskdata; // Taskdata for the thread's implicit task
3118 int t_level; // nested parallel level
3119
3120 KMP_ALIGN_CACHE int t_max_argc;
3121 int t_max_nproc; // max threads this team can handle (dynamically expandable)
3122 int t_serialized; // levels deep of serialized teams
3123 dispatch_shared_info_t *t_disp_buffer; // buffers for dispatch system
3124 int t_id; // team's id, assigned by debugger.
3125 int t_active_level; // nested active parallel level
3126 kmp_r_sched_t t_sched; // run-time schedule for the team
3127#if KMP_AFFINITY_SUPPORTED
3128 int t_first_place; // first & last place in parent thread's partition.
3129 int t_last_place; // Restore these values to primary thread after par region.
3130#endif // KMP_AFFINITY_SUPPORTED
3131 int t_display_affinity;
3132 int t_size_changed; // team size was changed?: 0: no, 1: yes, -1: changed via
3133 // omp_set_num_threads() call
3134 omp_allocator_handle_t t_def_allocator; /* default allocator */
3135
3136// Read/write by workers as well
3137#if (KMP_ARCH_X86 || KMP_ARCH_X86_64)
3138 // Using CACHE_LINE=64 reduces memory footprint, but causes a big perf
3139 // regression of epcc 'parallel' and 'barrier' on fxe256lin01. This extra
3140 // padding serves to fix the performance of epcc 'parallel' and 'barrier' when
3141 // CACHE_LINE=64. TODO: investigate more and get rid if this padding.
3142 char dummy_padding[1024];
3143#endif
3144 // Internal control stack for additional nested teams.
3145 KMP_ALIGN_CACHE kmp_internal_control_t *t_control_stack_top;
3146 // for SERIALIZED teams nested 2 or more levels deep
3147 // typed flag to store request state of cancellation
3148 std::atomic<kmp_int32> t_cancel_request;
3149 int t_master_active; // save on fork, restore on join
3150 void *t_copypriv_data; // team specific pointer to copyprivate data array
3151#if KMP_OS_WINDOWS
3152 std::atomic<kmp_uint32> t_copyin_counter;
3153#endif
3154#if USE_ITT_BUILD
3155 void *t_stack_id; // team specific stack stitching id (for ittnotify)
3156#endif /* USE_ITT_BUILD */
3157 distributedBarrier *b; // Distributed barrier data associated with team
3158 kmp_nested_nthreads_t *t_nested_nth;
3159} kmp_base_team_t;
3160
3161// Assert that the list structure fits and aligns within
3162// the double task team pointer
3163KMP_BUILD_ASSERT(sizeof(kmp_task_team_t *[2]) == sizeof(kmp_task_team_list_t));
3164KMP_BUILD_ASSERT(alignof(kmp_task_team_t *[2]) ==
3165 alignof(kmp_task_team_list_t));
3166
3167union KMP_ALIGN_CACHE kmp_team {
3168 kmp_base_team_t t;
3169 double t_align; /* use worst case alignment */
3170 char t_pad[KMP_PAD(kmp_base_team_t, CACHE_LINE)];
3171};
3172
3173typedef union KMP_ALIGN_CACHE kmp_time_global {
3174 double dt_align; /* use worst case alignment */
3175 char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
3176 kmp_base_data_t dt;
3177} kmp_time_global_t;
3178
3179typedef struct kmp_base_global {
3180 /* cache-aligned */
3181 kmp_time_global_t g_time;
3182
3183 /* non cache-aligned */
3184 volatile int g_abort;
3185 volatile int g_done;
3186
3187 int g_dynamic;
3188 enum dynamic_mode g_dynamic_mode;
3189} kmp_base_global_t;
3190
3191typedef union KMP_ALIGN_CACHE kmp_global {
3192 kmp_base_global_t g;
3193 double g_align; /* use worst case alignment */
3194 char g_pad[KMP_PAD(kmp_base_global_t, CACHE_LINE)];
3195} kmp_global_t;
3196
3197typedef struct kmp_base_root {
3198 // TODO: GEH - combine r_active with r_in_parallel then r_active ==
3199 // (r_in_parallel>= 0)
3200 // TODO: GEH - then replace r_active with t_active_levels if we can to reduce
3201 // the synch overhead or keeping r_active
3202 volatile int r_active; /* TRUE if some region in a nest has > 1 thread */
3203 // keeps a count of active parallel regions per root
3204 std::atomic<int> r_in_parallel;
3205 // GEH: This is misnamed, should be r_active_levels
3206 kmp_team_t *r_root_team;
3207 kmp_team_t *r_hot_team;
3208 kmp_info_t *r_uber_thread;
3209 kmp_lock_t r_begin_lock;
3210 volatile int r_begin;
3211 int r_blocktime; /* blocktime for this root and descendants */
3212#if KMP_AFFINITY_SUPPORTED
3213 int r_affinity_assigned;
3214#endif // KMP_AFFINITY_SUPPORTED
3215} kmp_base_root_t;
3216
3217typedef union KMP_ALIGN_CACHE kmp_root {
3218 kmp_base_root_t r;
3219 double r_align; /* use worst case alignment */
3220 char r_pad[KMP_PAD(kmp_base_root_t, CACHE_LINE)];
3221} kmp_root_t;
3222
3223struct fortran_inx_info {
3224 kmp_int32 data;
3225};
3226
3227// This list type exists to hold old __kmp_threads arrays so that
3228// old references to them may complete while reallocation takes place when
3229// expanding the array. The items in this list are kept alive until library
3230// shutdown.
3231typedef struct kmp_old_threads_list_t {
3232 kmp_info_t **threads;
3233 struct kmp_old_threads_list_t *next;
3234} kmp_old_threads_list_t;
3235
3236/* ------------------------------------------------------------------------ */
3237
3238extern int __kmp_settings;
3239extern int __kmp_duplicate_library_ok;
3240#if USE_ITT_BUILD
3241extern int __kmp_forkjoin_frames;
3242extern int __kmp_forkjoin_frames_mode;
3243#endif
3244extern PACKED_REDUCTION_METHOD_T __kmp_force_reduction_method;
3245extern int __kmp_determ_red;
3246
3247#ifdef KMP_DEBUG
3248extern int kmp_a_debug;
3249extern int kmp_b_debug;
3250extern int kmp_c_debug;
3251extern int kmp_d_debug;
3252extern int kmp_e_debug;
3253extern int kmp_f_debug;
3254#endif /* KMP_DEBUG */
3255
3256/* For debug information logging using rotating buffer */
3257#define KMP_DEBUG_BUF_LINES_INIT 512
3258#define KMP_DEBUG_BUF_LINES_MIN 1
3259
3260#define KMP_DEBUG_BUF_CHARS_INIT 128
3261#define KMP_DEBUG_BUF_CHARS_MIN 2
3262
3263extern int
3264 __kmp_debug_buf; /* TRUE means use buffer, FALSE means print to stderr */
3265extern int __kmp_debug_buf_lines; /* How many lines of debug stored in buffer */
3266extern int
3267 __kmp_debug_buf_chars; /* How many characters allowed per line in buffer */
3268extern int __kmp_debug_buf_atomic; /* TRUE means use atomic update of buffer
3269 entry pointer */
3270
3271extern char *__kmp_debug_buffer; /* Debug buffer itself */
3272extern std::atomic<int> __kmp_debug_count; /* Counter for number of lines
3273 printed in buffer so far */
3274extern int __kmp_debug_buf_warn_chars; /* Keep track of char increase
3275 recommended in warnings */
3276/* end rotating debug buffer */
3277
3278#ifdef KMP_DEBUG
3279extern int __kmp_par_range; /* +1 => only go par for constructs in range */
3280
3281#define KMP_PAR_RANGE_ROUTINE_LEN 1024
3282extern char __kmp_par_range_routine[KMP_PAR_RANGE_ROUTINE_LEN];
3283#define KMP_PAR_RANGE_FILENAME_LEN 1024
3284extern char __kmp_par_range_filename[KMP_PAR_RANGE_FILENAME_LEN];
3285extern int __kmp_par_range_lb;
3286extern int __kmp_par_range_ub;
3287#endif
3288
3289/* For printing out dynamic storage map for threads and teams */
3290extern int
3291 __kmp_storage_map; /* True means print storage map for threads and teams */
3292extern int __kmp_storage_map_verbose; /* True means storage map includes
3293 placement info */
3294extern int __kmp_storage_map_verbose_specified;
3295
3296#if KMP_ARCH_X86 || KMP_ARCH_X86_64
3297extern kmp_cpuinfo_t __kmp_cpuinfo;
3298static inline bool __kmp_is_hybrid_cpu() { return __kmp_cpuinfo.flags.hybrid; }
3299#elif KMP_OS_DARWIN && KMP_ARCH_AARCH64
3300static inline bool __kmp_is_hybrid_cpu() { return true; }
3301#else
3302static inline bool __kmp_is_hybrid_cpu() { return false; }
3303#endif
3304
3305extern volatile int __kmp_init_serial;
3306extern volatile int __kmp_init_gtid;
3307extern volatile int __kmp_init_common;
3308extern volatile int __kmp_need_register_serial;
3309extern volatile int __kmp_init_middle;
3310extern volatile int __kmp_init_parallel;
3311#if KMP_USE_MONITOR
3312extern volatile int __kmp_init_monitor;
3313#endif
3314extern volatile int __kmp_init_user_locks;
3315extern volatile int __kmp_init_hidden_helper_threads;
3316extern int __kmp_init_counter;
3317extern int __kmp_root_counter;
3318extern int __kmp_version;
3319
3320/* list of address of allocated caches for commons */
3321extern kmp_cached_addr_t *__kmp_threadpriv_cache_list;
3322
3323/* Barrier algorithm types and options */
3324extern kmp_uint32 __kmp_barrier_gather_bb_dflt;
3325extern kmp_uint32 __kmp_barrier_release_bb_dflt;
3326extern kmp_bar_pat_e __kmp_barrier_gather_pat_dflt;
3327extern kmp_bar_pat_e __kmp_barrier_release_pat_dflt;
3328extern kmp_uint32 __kmp_barrier_gather_branch_bits[bs_last_barrier];
3329extern kmp_uint32 __kmp_barrier_release_branch_bits[bs_last_barrier];
3330extern kmp_bar_pat_e __kmp_barrier_gather_pattern[bs_last_barrier];
3331extern kmp_bar_pat_e __kmp_barrier_release_pattern[bs_last_barrier];
3332extern char const *__kmp_barrier_branch_bit_env_name[bs_last_barrier];
3333extern char const *__kmp_barrier_pattern_env_name[bs_last_barrier];
3334extern char const *__kmp_barrier_type_name[bs_last_barrier];
3335extern char const *__kmp_barrier_pattern_name[bp_last_bar];
3336
3337/* Global Locks */
3338extern kmp_bootstrap_lock_t __kmp_initz_lock; /* control initialization */
3339extern kmp_bootstrap_lock_t __kmp_forkjoin_lock; /* control fork/join access */
3340extern kmp_bootstrap_lock_t __kmp_task_team_lock;
3341extern kmp_bootstrap_lock_t
3342 __kmp_exit_lock; /* exit() is not always thread-safe */
3343#if KMP_USE_MONITOR
3344extern kmp_bootstrap_lock_t
3345 __kmp_monitor_lock; /* control monitor thread creation */
3346#endif
3347extern kmp_bootstrap_lock_t
3348 __kmp_tp_cached_lock; /* used for the hack to allow threadprivate cache and
3349 __kmp_threads expansion to co-exist */
3350
3351extern kmp_lock_t __kmp_global_lock; /* control OS/global access */
3352
3353extern enum library_type __kmp_library;
3354
3355extern enum sched_type __kmp_sched; /* default runtime scheduling */
3356extern enum sched_type __kmp_static; /* default static scheduling method */
3357extern enum sched_type __kmp_guided; /* default guided scheduling method */
3358extern enum sched_type __kmp_auto; /* default auto scheduling method */
3359extern int __kmp_chunk; /* default runtime chunk size */
3360extern int __kmp_force_monotonic; /* whether monotonic scheduling forced */
3361
3362extern size_t __kmp_stksize; /* stack size per thread */
3363#if KMP_USE_MONITOR
3364extern size_t __kmp_monitor_stksize; /* stack size for monitor thread */
3365#endif
3366extern size_t __kmp_stkoffset; /* stack offset per thread */
3367extern int __kmp_stkpadding; /* Should we pad root thread(s) stack */
3368
3369extern size_t
3370 __kmp_malloc_pool_incr; /* incremental size of pool for kmp_malloc() */
3371extern int __kmp_env_stksize; /* was KMP_STACKSIZE specified? */
3372extern int __kmp_env_blocktime; /* was KMP_BLOCKTIME specified? */
3373extern int __kmp_env_checks; /* was KMP_CHECKS specified? */
3374extern int __kmp_env_consistency_check; // was KMP_CONSISTENCY_CHECK specified?
3375extern int __kmp_generate_warnings; /* should we issue warnings? */
3376extern int __kmp_reserve_warn; /* have we issued reserve_threads warning? */
3377
3378#ifdef DEBUG_SUSPEND
3379extern int __kmp_suspend_count; /* count inside __kmp_suspend_template() */
3380#endif
3381
3382extern kmp_int32 __kmp_use_yield;
3383extern kmp_int32 __kmp_use_yield_exp_set;
3384extern kmp_uint32 __kmp_yield_init;
3385extern kmp_uint32 __kmp_yield_next;
3386extern kmp_uint64 __kmp_pause_init;
3387
3388/* ------------------------------------------------------------------------- */
3389extern int __kmp_allThreadsSpecified;
3390
3391extern size_t __kmp_align_alloc;
3392/* following data protected by initialization routines */
3393extern int __kmp_xproc; /* number of processors in the system */
3394extern int __kmp_avail_proc; /* number of processors available to the process */
3395extern size_t __kmp_sys_min_stksize; /* system-defined minimum stack size */
3396extern int __kmp_sys_max_nth; /* system-imposed maximum number of threads */
3397// maximum total number of concurrently-existing threads on device
3398extern int __kmp_max_nth;
3399// maximum total number of concurrently-existing threads in a contention group
3400extern int __kmp_cg_max_nth;
3401extern int __kmp_task_max_nth; // max threads used in a task
3402extern int __kmp_teams_max_nth; // max threads used in a teams construct
3403extern int __kmp_threads_capacity; /* capacity of the arrays __kmp_threads and
3404 __kmp_root */
3405extern int __kmp_dflt_team_nth; /* default number of threads in a parallel
3406 region a la OMP_NUM_THREADS */
3407extern int __kmp_dflt_team_nth_ub; /* upper bound on "" determined at serial
3408 initialization */
3409extern int __kmp_tp_capacity; /* capacity of __kmp_threads if threadprivate is
3410 used (fixed) */
3411extern int __kmp_tp_cached; /* whether threadprivate cache has been created
3412 (__kmpc_threadprivate_cached()) */
3413extern int __kmp_dflt_blocktime; /* number of microseconds to wait before
3414 blocking (env setting) */
3415extern char __kmp_blocktime_units; /* 'm' or 'u' to note units specified */
3416extern bool __kmp_wpolicy_passive; /* explicitly set passive wait policy */
3417
3418// Convert raw blocktime from ms to us if needed.
3419static inline void __kmp_aux_convert_blocktime(int *bt) {
3420 if (__kmp_blocktime_units == 'm') {
3421 if (*bt > INT_MAX / 1000) {
3422 *bt = INT_MAX / 1000;
3423 KMP_INFORM(MaxValueUsing, "kmp_set_blocktime(ms)", bt);
3424 }
3425 *bt = *bt * 1000;
3426 }
3427}
3428
3429#if KMP_USE_MONITOR
3430extern int
3431 __kmp_monitor_wakeups; /* number of times monitor wakes up per second */
3432extern int __kmp_bt_intervals; /* number of monitor timestamp intervals before
3433 blocking */
3434#endif
3435#ifdef KMP_ADJUST_BLOCKTIME
3436extern int __kmp_zero_bt; /* whether blocktime has been forced to zero */
3437#endif /* KMP_ADJUST_BLOCKTIME */
3438#ifdef KMP_DFLT_NTH_CORES
3439extern int __kmp_ncores; /* Total number of cores for threads placement */
3440#endif
3441/* Number of millisecs to delay on abort for Intel(R) VTune(TM) tools */
3442extern int __kmp_abort_delay;
3443
3444extern int __kmp_need_register_atfork_specified;
3445extern int __kmp_need_register_atfork; /* At initialization, call pthread_atfork
3446 to install fork handler */
3447extern int __kmp_gtid_mode; /* Method of getting gtid, values:
3448 0 - not set, will be set at runtime
3449 1 - using stack search
3450 2 - dynamic TLS (pthread_getspecific(Linux* OS/OS
3451 X*) or TlsGetValue(Windows* OS))
3452 3 - static TLS (__declspec(thread) __kmp_gtid),
3453 Linux* OS .so only. */
3454extern int
3455 __kmp_adjust_gtid_mode; /* If true, adjust method based on #threads */
3456#ifdef KMP_TDATA_GTID
3457extern KMP_THREAD_LOCAL int __kmp_gtid;
3458#endif
3459extern int __kmp_tls_gtid_min; /* #threads below which use sp search for gtid */
3460extern int __kmp_foreign_tp; // If true, separate TP var for each foreign thread
3461#if KMP_ARCH_X86 || KMP_ARCH_X86_64
3462extern int __kmp_inherit_fp_control; // copy fp creg(s) parent->workers at fork
3463extern kmp_int16 __kmp_init_x87_fpu_control_word; // init thread's FP ctrl reg
3464extern kmp_uint32 __kmp_init_mxcsr; /* init thread's mxscr */
3465#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
3466
3467// max_active_levels for nested parallelism enabled by default via
3468// OMP_MAX_ACTIVE_LEVELS, OMP_NESTED, OMP_NUM_THREADS, and OMP_PROC_BIND
3469extern int __kmp_dflt_max_active_levels;
3470// Indicates whether value of __kmp_dflt_max_active_levels was already
3471// explicitly set by OMP_MAX_ACTIVE_LEVELS or OMP_NESTED=false
3472extern bool __kmp_dflt_max_active_levels_set;
3473extern int __kmp_dispatch_num_buffers; /* max possible dynamic loops in
3474 concurrent execution per team */
3475extern int __kmp_hot_teams_mode;
3476extern int __kmp_hot_teams_max_level;
3477
3478#if KMP_MIC_SUPPORTED
3479extern enum mic_type __kmp_mic_type;
3480#endif
3481
3482#ifdef USE_LOAD_BALANCE
3483extern double __kmp_load_balance_interval; // load balance algorithm interval
3484#endif /* USE_LOAD_BALANCE */
3485
3486#if KMP_USE_ADAPTIVE_LOCKS
3487
3488// Parameters for the speculative lock backoff system.
3489struct kmp_adaptive_backoff_params_t {
3490 // Number of soft retries before it counts as a hard retry.
3491 kmp_uint32 max_soft_retries;
3492 // Badness is a bit mask : 0,1,3,7,15,... on each hard failure we move one to
3493 // the right
3494 kmp_uint32 max_badness;
3495};
3496
3497extern kmp_adaptive_backoff_params_t __kmp_adaptive_backoff_params;
3498
3499#if KMP_DEBUG_ADAPTIVE_LOCKS
3500extern const char *__kmp_speculative_statsfile;
3501#endif
3502
3503#endif // KMP_USE_ADAPTIVE_LOCKS
3504
3505extern int __kmp_display_env; /* TRUE or FALSE */
3506extern int __kmp_display_env_verbose; /* TRUE if OMP_DISPLAY_ENV=VERBOSE */
3507extern int __kmp_omp_cancellation; /* TRUE or FALSE */
3508extern int __kmp_nteams;
3509extern int __kmp_teams_thread_limit;
3510
3511/* ------------------------------------------------------------------------- */
3512
3513/* the following are protected by the fork/join lock */
3514/* write: lock read: anytime */
3515extern kmp_info_t **__kmp_threads; /* Descriptors for the threads */
3516/* Holds old arrays of __kmp_threads until library shutdown */
3517extern kmp_old_threads_list_t *__kmp_old_threads_list;
3518/* read/write: lock */
3519extern volatile kmp_team_t *__kmp_team_pool;
3520extern volatile kmp_info_t *__kmp_thread_pool;
3521extern kmp_info_t *__kmp_thread_pool_insert_pt;
3522
3523// total num threads reachable from some root thread including all root threads
3524extern volatile int __kmp_nth;
3525/* total number of threads reachable from some root thread including all root
3526 threads, and those in the thread pool */
3527extern volatile int __kmp_all_nth;
3528extern std::atomic<int> __kmp_thread_pool_active_nth;
3529
3530extern kmp_root_t **__kmp_root; /* root of thread hierarchy */
3531/* end data protected by fork/join lock */
3532/* ------------------------------------------------------------------------- */
3533
3534#define __kmp_get_gtid() __kmp_get_global_thread_id()
3535#define __kmp_entry_gtid() __kmp_get_global_thread_id_reg()
3536#define __kmp_get_tid() (__kmp_tid_from_gtid(__kmp_get_gtid()))
3537#define __kmp_get_team() (__kmp_threads[(__kmp_get_gtid())]->th.th_team)
3538#define __kmp_get_thread() (__kmp_thread_from_gtid(__kmp_get_gtid()))
3539
3540// AT: Which way is correct?
3541// AT: 1. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team -> t.t_nproc;
3542// AT: 2. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team_nproc;
3543#define __kmp_get_team_num_threads(gtid) \
3544 (__kmp_threads[(gtid)]->th.th_team->t.t_nproc)
3545
3546static inline bool KMP_UBER_GTID(int gtid) {
3547 KMP_DEBUG_ASSERT(gtid >= KMP_GTID_MIN);
3548 KMP_DEBUG_ASSERT(gtid < __kmp_threads_capacity);
3549 return (gtid >= 0 && __kmp_root[gtid] && __kmp_threads[gtid] &&
3550 __kmp_threads[gtid] == __kmp_root[gtid]->r.r_uber_thread);
3551}
3552
3553static inline int __kmp_tid_from_gtid(int gtid) {
3554 KMP_DEBUG_ASSERT(gtid >= 0);
3555 return __kmp_threads[gtid]->th.th_info.ds.ds_tid;
3556}
3557
3558static inline int __kmp_gtid_from_tid(int tid, const kmp_team_t *team) {
3559 KMP_DEBUG_ASSERT(tid >= 0 && team);
3560 return team->t.t_threads[tid]->th.th_info.ds.ds_gtid;
3561}
3562
3563static inline int __kmp_gtid_from_thread(const kmp_info_t *thr) {
3564 KMP_DEBUG_ASSERT(thr);
3565 return thr->th.th_info.ds.ds_gtid;
3566}
3567
3568static inline kmp_info_t *__kmp_thread_from_gtid(int gtid) {
3569 KMP_DEBUG_ASSERT(gtid >= 0);
3570 return __kmp_threads[gtid];
3571}
3572
3573static inline kmp_team_t *__kmp_team_from_gtid(int gtid) {
3574 KMP_DEBUG_ASSERT(gtid >= 0);
3575 return __kmp_threads[gtid]->th.th_team;
3576}
3577
3578static inline void __kmp_assert_valid_gtid(kmp_int32 gtid) {
3579 if (UNLIKELY(gtid < 0 || gtid >= __kmp_threads_capacity))
3580 KMP_FATAL(ThreadIdentInvalid);
3581}
3582
3583#if KMP_HAVE_MWAIT || KMP_HAVE_UMWAIT
3584extern int __kmp_user_level_mwait; // TRUE or FALSE; from KMP_USER_LEVEL_MWAIT
3585extern int __kmp_umwait_enabled; // Runtime check if user-level mwait enabled
3586extern int __kmp_mwait_enabled; // Runtime check if ring3 mwait is enabled
3587extern int __kmp_mwait_hints; // Hints to pass in to mwait
3588#endif
3589
3590#if KMP_HAVE_UMWAIT
3591extern int __kmp_waitpkg_enabled; // Runtime check if waitpkg exists
3592extern int __kmp_tpause_state; // 0 (default), 1=C0.1, 2=C0.2; from KMP_TPAUSE
3593extern int __kmp_tpause_hint; // 1=C0.1 (default), 0=C0.2; from KMP_TPAUSE
3594extern int __kmp_tpause_enabled; // 0 (default), 1 (KMP_TPAUSE is non-zero)
3595#endif
3596
3597/* ------------------------------------------------------------------------- */
3598
3599extern kmp_global_t __kmp_global; /* global status */
3600
3601extern kmp_info_t __kmp_monitor;
3602// For Debugging Support Library
3603extern std::atomic<kmp_int32> __kmp_team_counter;
3604// For Debugging Support Library
3605extern std::atomic<kmp_int32> __kmp_task_counter;
3606
3607#if USE_DEBUGGER
3608#define _KMP_GEN_ID(counter) \
3609 (__kmp_debugging ? KMP_ATOMIC_INC(&counter) + 1 : ~0)
3610#else
3611#define _KMP_GEN_ID(counter) (~0)
3612#endif /* USE_DEBUGGER */
3613
3614#define KMP_GEN_TASK_ID() _KMP_GEN_ID(__kmp_task_counter)
3615#define KMP_GEN_TEAM_ID() _KMP_GEN_ID(__kmp_team_counter)
3616
3617/* ------------------------------------------------------------------------ */
3618
3619extern void __kmp_print_storage_map_gtid(int gtid, void *p1, void *p2,
3620 size_t size, char const *format, ...);
3621
3622extern void __kmp_serial_initialize(void);
3623extern void __kmp_middle_initialize(void);
3624extern void __kmp_parallel_initialize(void);
3625
3626extern void __kmp_internal_begin(void);
3627extern void __kmp_internal_end_library(int gtid);
3628extern void __kmp_internal_end_thread(int gtid);
3629extern void __kmp_internal_end_atexit(void);
3630extern void __kmp_internal_end_dtor(void);
3631extern void __kmp_internal_end_dest(void *);
3632
3633extern int __kmp_register_root(int initial_thread);
3634extern void __kmp_unregister_root(int gtid);
3635extern void __kmp_unregister_library(void); // called by __kmp_internal_end()
3636
3637extern int __kmp_ignore_mppbeg(void);
3638extern int __kmp_ignore_mppend(void);
3639
3640extern int __kmp_enter_single(int gtid, ident_t *id_ref, int push_ws);
3641extern void __kmp_exit_single(int gtid);
3642
3643extern void __kmp_parallel_deo(int *gtid_ref, int *cid_ref, ident_t *loc_ref);
3644extern void __kmp_parallel_dxo(int *gtid_ref, int *cid_ref, ident_t *loc_ref);
3645
3646#ifdef USE_LOAD_BALANCE
3647extern int __kmp_get_load_balance(int);
3648#endif
3649
3650extern int __kmp_get_global_thread_id(void);
3651extern int __kmp_get_global_thread_id_reg(void);
3652extern void __kmp_exit_thread(int exit_status);
3653extern void __kmp_abort(char const *format, ...);
3654extern void __kmp_abort_thread(void);
3655KMP_NORETURN extern void __kmp_abort_process(void);
3656extern void __kmp_warn(char const *format, ...);
3657
3658extern void __kmp_set_num_threads(int new_nth, int gtid);
3659
3660extern bool __kmp_detect_shm();
3661extern bool __kmp_detect_tmp();
3662
3663// Returns current thread (pointer to kmp_info_t). Current thread *must* be
3664// registered.
3665static inline kmp_info_t *__kmp_entry_thread() {
3666 int gtid = __kmp_entry_gtid();
3667
3668 return __kmp_threads[gtid];
3669}
3670
3671extern void __kmp_set_max_active_levels(int gtid, int new_max_active_levels);
3672extern int __kmp_get_max_active_levels(int gtid);
3673extern int __kmp_get_ancestor_thread_num(int gtid, int level);
3674extern int __kmp_get_team_size(int gtid, int level);
3675extern void __kmp_set_schedule(int gtid, kmp_sched_t new_sched, int chunk);
3676extern void __kmp_get_schedule(int gtid, kmp_sched_t *sched, int *chunk);
3677
3678extern unsigned short __kmp_get_random(kmp_info_t *thread);
3679extern void __kmp_init_random(kmp_info_t *thread);
3680
3681extern kmp_r_sched_t __kmp_get_schedule_global(void);
3682extern void __kmp_adjust_num_threads(int new_nproc);
3683extern void __kmp_check_stksize(size_t *val);
3684
3685extern void *___kmp_allocate(size_t size KMP_SRC_LOC_DECL);
3686extern void *___kmp_page_allocate(size_t size KMP_SRC_LOC_DECL);
3687extern void ___kmp_free(void *ptr KMP_SRC_LOC_DECL);
3688#define __kmp_allocate(size) ___kmp_allocate((size)KMP_SRC_LOC_CURR)
3689#define __kmp_page_allocate(size) ___kmp_page_allocate((size)KMP_SRC_LOC_CURR)
3690#define __kmp_free(ptr) ___kmp_free((ptr)KMP_SRC_LOC_CURR)
3691
3692#if USE_FAST_MEMORY
3693extern void *___kmp_fast_allocate(kmp_info_t *this_thr,
3694 size_t size KMP_SRC_LOC_DECL);
3695extern void ___kmp_fast_free(kmp_info_t *this_thr, void *ptr KMP_SRC_LOC_DECL);
3696extern void __kmp_free_fast_memory(kmp_info_t *this_thr);
3697extern void __kmp_initialize_fast_memory(kmp_info_t *this_thr);
3698#define __kmp_fast_allocate(this_thr, size) \
3699 ___kmp_fast_allocate((this_thr), (size)KMP_SRC_LOC_CURR)
3700#define __kmp_fast_free(this_thr, ptr) \
3701 ___kmp_fast_free((this_thr), (ptr)KMP_SRC_LOC_CURR)
3702#endif
3703
3704extern void *___kmp_thread_malloc(kmp_info_t *th, size_t size KMP_SRC_LOC_DECL);
3705extern void *___kmp_thread_calloc(kmp_info_t *th, size_t nelem,
3706 size_t elsize KMP_SRC_LOC_DECL);
3707extern void *___kmp_thread_realloc(kmp_info_t *th, void *ptr,
3708 size_t size KMP_SRC_LOC_DECL);
3709extern void ___kmp_thread_free(kmp_info_t *th, void *ptr KMP_SRC_LOC_DECL);
3710#define __kmp_thread_malloc(th, size) \
3711 ___kmp_thread_malloc((th), (size)KMP_SRC_LOC_CURR)
3712#define __kmp_thread_calloc(th, nelem, elsize) \
3713 ___kmp_thread_calloc((th), (nelem), (elsize)KMP_SRC_LOC_CURR)
3714#define __kmp_thread_realloc(th, ptr, size) \
3715 ___kmp_thread_realloc((th), (ptr), (size)KMP_SRC_LOC_CURR)
3716#define __kmp_thread_free(th, ptr) \
3717 ___kmp_thread_free((th), (ptr)KMP_SRC_LOC_CURR)
3718
3719extern void __kmp_push_num_threads(ident_t *loc, int gtid, int num_threads);
3720extern void __kmp_push_num_threads_list(ident_t *loc, int gtid,
3721 kmp_uint32 list_length,
3722 int *num_threads_list);
3723extern void __kmp_set_strict_num_threads(ident_t *loc, int gtid, int sev,
3724 const char *msg);
3725
3726extern void __kmp_push_proc_bind(ident_t *loc, int gtid,
3727 kmp_proc_bind_t proc_bind);
3728extern void __kmp_push_num_teams(ident_t *loc, int gtid, int num_teams,
3729 int num_threads);
3730extern void __kmp_push_num_teams_51(ident_t *loc, int gtid, int num_teams_lb,
3731 int num_teams_ub, int num_threads);
3732
3733extern void __kmp_yield();
3734
3735extern void __kmpc_dispatch_init_4(ident_t *loc, kmp_int32 gtid,
3736 enum sched_type schedule, kmp_int32 lb,
3737 kmp_int32 ub, kmp_int32 st, kmp_int32 chunk);
3738extern void __kmpc_dispatch_init_4u(ident_t *loc, kmp_int32 gtid,
3739 enum sched_type schedule, kmp_uint32 lb,
3740 kmp_uint32 ub, kmp_int32 st,
3741 kmp_int32 chunk);
3742extern void __kmpc_dispatch_init_8(ident_t *loc, kmp_int32 gtid,
3743 enum sched_type schedule, kmp_int64 lb,
3744 kmp_int64 ub, kmp_int64 st, kmp_int64 chunk);
3745extern void __kmpc_dispatch_init_8u(ident_t *loc, kmp_int32 gtid,
3746 enum sched_type schedule, kmp_uint64 lb,
3747 kmp_uint64 ub, kmp_int64 st,
3748 kmp_int64 chunk);
3749
3750extern int __kmpc_dispatch_next_4(ident_t *loc, kmp_int32 gtid,
3751 kmp_int32 *p_last, kmp_int32 *p_lb,
3752 kmp_int32 *p_ub, kmp_int32 *p_st);
3753extern int __kmpc_dispatch_next_4u(ident_t *loc, kmp_int32 gtid,
3754 kmp_int32 *p_last, kmp_uint32 *p_lb,
3755 kmp_uint32 *p_ub, kmp_int32 *p_st);
3756extern int __kmpc_dispatch_next_8(ident_t *loc, kmp_int32 gtid,
3757 kmp_int32 *p_last, kmp_int64 *p_lb,
3758 kmp_int64 *p_ub, kmp_int64 *p_st);
3759extern int __kmpc_dispatch_next_8u(ident_t *loc, kmp_int32 gtid,
3760 kmp_int32 *p_last, kmp_uint64 *p_lb,
3761 kmp_uint64 *p_ub, kmp_int64 *p_st);
3762
3763extern void __kmpc_dispatch_fini_4(ident_t *loc, kmp_int32 gtid);
3764extern void __kmpc_dispatch_fini_8(ident_t *loc, kmp_int32 gtid);
3765extern void __kmpc_dispatch_fini_4u(ident_t *loc, kmp_int32 gtid);
3766extern void __kmpc_dispatch_fini_8u(ident_t *loc, kmp_int32 gtid);
3767
3768extern void __kmpc_dispatch_deinit(ident_t *loc, kmp_int32 gtid);
3769
3770#ifdef KMP_GOMP_COMPAT
3771
3772extern void __kmp_aux_dispatch_init_4(ident_t *loc, kmp_int32 gtid,
3773 enum sched_type schedule, kmp_int32 lb,
3774 kmp_int32 ub, kmp_int32 st,
3775 kmp_int32 chunk, int push_ws);
3776extern void __kmp_aux_dispatch_init_4u(ident_t *loc, kmp_int32 gtid,
3777 enum sched_type schedule, kmp_uint32 lb,
3778 kmp_uint32 ub, kmp_int32 st,
3779 kmp_int32 chunk, int push_ws);
3780extern void __kmp_aux_dispatch_init_8(ident_t *loc, kmp_int32 gtid,
3781 enum sched_type schedule, kmp_int64 lb,
3782 kmp_int64 ub, kmp_int64 st,
3783 kmp_int64 chunk, int push_ws);
3784extern void __kmp_aux_dispatch_init_8u(ident_t *loc, kmp_int32 gtid,
3785 enum sched_type schedule, kmp_uint64 lb,
3786 kmp_uint64 ub, kmp_int64 st,
3787 kmp_int64 chunk, int push_ws);
3788extern void __kmp_aux_dispatch_fini_chunk_4(ident_t *loc, kmp_int32 gtid);
3789extern void __kmp_aux_dispatch_fini_chunk_8(ident_t *loc, kmp_int32 gtid);
3790extern void __kmp_aux_dispatch_fini_chunk_4u(ident_t *loc, kmp_int32 gtid);
3791extern void __kmp_aux_dispatch_fini_chunk_8u(ident_t *loc, kmp_int32 gtid);
3792
3793#endif /* KMP_GOMP_COMPAT */
3794
3795extern kmp_uint32 __kmp_eq_4(kmp_uint32 value, kmp_uint32 checker);
3796extern kmp_uint32 __kmp_neq_4(kmp_uint32 value, kmp_uint32 checker);
3797extern kmp_uint32 __kmp_lt_4(kmp_uint32 value, kmp_uint32 checker);
3798extern kmp_uint32 __kmp_ge_4(kmp_uint32 value, kmp_uint32 checker);
3799extern kmp_uint32 __kmp_le_4(kmp_uint32 value, kmp_uint32 checker);
3800extern kmp_uint32 __kmp_wait_4(kmp_uint32 volatile *spinner, kmp_uint32 checker,
3801 kmp_uint32 (*pred)(kmp_uint32, kmp_uint32),
3802 void *obj);
3803extern void __kmp_wait_4_ptr(void *spinner, kmp_uint32 checker,
3804 kmp_uint32 (*pred)(void *, kmp_uint32), void *obj);
3805
3806extern void __kmp_wait_64(kmp_info_t *this_thr, kmp_flag_64<> *flag,
3807 int final_spin
3808#if USE_ITT_BUILD
3809 ,
3810 void *itt_sync_obj
3811#endif
3812);
3813extern void __kmp_release_64(kmp_flag_64<> *flag);
3814
3815extern void __kmp_infinite_loop(void);
3816
3817extern void __kmp_cleanup(void);
3818
3819#if KMP_HANDLE_SIGNALS
3820extern int __kmp_handle_signals;
3821extern void __kmp_install_signals(int parallel_init);
3822extern void __kmp_remove_signals(void);
3823#endif
3824
3825extern void __kmp_clear_system_time(void);
3826extern void __kmp_read_system_time(double *delta);
3827
3828extern void __kmp_check_stack_overlap(kmp_info_t *thr);
3829
3830extern void __kmp_expand_host_name(char *buffer, size_t size);
3831extern void __kmp_expand_file_name(char *result, size_t rlen, char *pattern);
3832
3833#if KMP_ARCH_X86 || KMP_ARCH_X86_64 || \
3834 (KMP_OS_WINDOWS && (KMP_ARCH_AARCH64 || KMP_ARCH_ARM || KMP_ARCH_ARM64EC))
3835extern void
3836__kmp_initialize_system_tick(void); /* Initialize timer tick value */
3837#endif
3838
3839extern void
3840__kmp_runtime_initialize(void); /* machine specific initialization */
3841extern void __kmp_runtime_destroy(void);
3842
3843#if KMP_AFFINITY_SUPPORTED
3844extern char *__kmp_affinity_print_mask(char *buf, int buf_len,
3845 kmp_affin_mask_t *mask);
3846extern kmp_str_buf_t *__kmp_affinity_str_buf_mask(kmp_str_buf_t *buf,
3847 kmp_affin_mask_t *mask);
3848extern void __kmp_affinity_initialize(kmp_affinity_t &affinity);
3849extern void __kmp_affinity_uninitialize(void);
3850extern void __kmp_affinity_set_init_mask(
3851 int gtid, int isa_root); /* set affinity according to KMP_AFFINITY */
3852void __kmp_affinity_bind_init_mask(int gtid);
3853extern void __kmp_affinity_bind_place(int gtid);
3854extern void __kmp_affinity_determine_capable(const char *env_var);
3855extern int __kmp_aux_set_affinity(void **mask);
3856extern int __kmp_aux_get_affinity(void **mask);
3857extern int __kmp_aux_get_affinity_max_proc();
3858extern int __kmp_aux_set_affinity_mask_proc(int proc, void **mask);
3859extern int __kmp_aux_unset_affinity_mask_proc(int proc, void **mask);
3860extern int __kmp_aux_get_affinity_mask_proc(int proc, void **mask);
3861extern void __kmp_balanced_affinity(kmp_info_t *th, int team_size);
3862#if KMP_WEIGHTED_ITERATIONS_SUPPORTED
3863extern int __kmp_get_first_osid_with_ecore(void);
3864#endif
3865#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_DRAGONFLY || \
3866 KMP_OS_AIX
3867extern int kmp_set_thread_affinity_mask_initial(void);
3868#endif
3869static inline void __kmp_assign_root_init_mask() {
3870 int gtid = __kmp_entry_gtid();
3871 kmp_root_t *r = __kmp_threads[gtid]->th.th_root;
3872 if (r->r.r_uber_thread == __kmp_threads[gtid] && !r->r.r_affinity_assigned) {
3873 __kmp_affinity_set_init_mask(gtid, /*isa_root=*/TRUE);
3874 __kmp_affinity_bind_init_mask(gtid);
3875 r->r.r_affinity_assigned = TRUE;
3876 }
3877}
3878static inline void __kmp_reset_root_init_mask(int gtid) {
3879 if (!KMP_AFFINITY_CAPABLE())
3880 return;
3881 kmp_info_t *th = __kmp_threads[gtid];
3882 kmp_root_t *r = th->th.th_root;
3883 if (r->r.r_uber_thread == th && r->r.r_affinity_assigned) {
3884 __kmp_set_system_affinity(__kmp_affin_origMask, FALSE);
3885 KMP_CPU_COPY(th->th.th_affin_mask, __kmp_affin_origMask);
3886 r->r.r_affinity_assigned = FALSE;
3887 }
3888}
3889#else /* KMP_AFFINITY_SUPPORTED */
3890#define __kmp_assign_root_init_mask() /* Nothing */
3891static inline void __kmp_reset_root_init_mask(int gtid) {}
3892#endif /* KMP_AFFINITY_SUPPORTED */
3893// No need for KMP_AFFINITY_SUPPORTED guard as only one field in the
3894// format string is for affinity, so platforms that do not support
3895// affinity can still use the other fields, e.g., %n for num_threads
3896extern size_t __kmp_aux_capture_affinity(int gtid, const char *format,
3897 kmp_str_buf_t *buffer);
3898extern void __kmp_aux_display_affinity(int gtid, const char *format);
3899
3900extern void __kmp_cleanup_hierarchy();
3901extern void __kmp_get_hierarchy(kmp_uint32 nproc, kmp_bstate_t *thr_bar);
3902
3903#if KMP_USE_FUTEX
3904
3905extern int __kmp_futex_determine_capable(void);
3906
3907#endif // KMP_USE_FUTEX
3908
3909extern void __kmp_gtid_set_specific(int gtid);
3910extern int __kmp_gtid_get_specific(void);
3911
3912extern double __kmp_read_cpu_time(void);
3913
3914extern int __kmp_read_system_info(struct kmp_sys_info *info);
3915
3916#if KMP_USE_MONITOR
3917extern void __kmp_create_monitor(kmp_info_t *th);
3918#endif
3919
3920extern void *__kmp_launch_thread(kmp_info_t *thr);
3921
3922extern void __kmp_create_worker(int gtid, kmp_info_t *th, size_t stack_size);
3923
3924#if KMP_OS_WINDOWS
3925extern int __kmp_still_running(kmp_info_t *th);
3926extern int __kmp_is_thread_alive(kmp_info_t *th, DWORD *exit_val);
3927extern void __kmp_free_handle(kmp_thread_t tHandle);
3928#endif
3929
3930#if KMP_USE_MONITOR
3931extern void __kmp_reap_monitor(kmp_info_t *th);
3932#endif
3933extern void __kmp_reap_worker(kmp_info_t *th);
3934extern void __kmp_terminate_thread(int gtid);
3935
3936extern int __kmp_try_suspend_mx(kmp_info_t *th);
3937extern void __kmp_lock_suspend_mx(kmp_info_t *th);
3938extern void __kmp_unlock_suspend_mx(kmp_info_t *th);
3939
3940extern void __kmp_elapsed(double *);
3941extern void __kmp_elapsed_tick(double *);
3942
3943extern void __kmp_enable(int old_state);
3944extern void __kmp_disable(int *old_state);
3945
3946extern void __kmp_thread_sleep(int millis);
3947
3948extern void __kmp_common_initialize(void);
3949extern void __kmp_common_destroy(void);
3950extern void __kmp_common_destroy_gtid(int gtid);
3951
3952#if KMP_OS_UNIX
3953extern void __kmp_register_atfork(void);
3954#endif
3955extern void __kmp_suspend_initialize(void);
3956extern void __kmp_suspend_initialize_thread(kmp_info_t *th);
3957extern void __kmp_suspend_uninitialize_thread(kmp_info_t *th);
3958
3959extern kmp_info_t *__kmp_allocate_thread(kmp_root_t *root, kmp_team_t *team,
3960 int tid);
3961extern kmp_team_t *__kmp_allocate_team(kmp_root_t *root, int new_nproc,
3962 int max_nproc,
3963#if OMPT_SUPPORT
3964 ompt_data_t ompt_parallel_data,
3965#endif
3966 kmp_proc_bind_t proc_bind,
3967 kmp_internal_control_t *new_icvs,
3968 int argc, kmp_info_t *thr);
3969extern void __kmp_free_thread(kmp_info_t *);
3970extern void __kmp_free_team(kmp_root_t *, kmp_team_t *, kmp_info_t *);
3971extern kmp_team_t *__kmp_reap_team(kmp_team_t *);
3972
3973/* ------------------------------------------------------------------------ */
3974
3975extern void __kmp_initialize_bget(kmp_info_t *th);
3976extern void __kmp_finalize_bget(kmp_info_t *th);
3977
3978KMP_EXPORT void *kmpc_malloc(size_t size);
3979KMP_EXPORT void *kmpc_aligned_malloc(size_t size, size_t alignment);
3980KMP_EXPORT void *kmpc_calloc(size_t nelem, size_t elsize);
3981KMP_EXPORT void *kmpc_realloc(void *ptr, size_t size);
3982KMP_EXPORT void kmpc_free(void *ptr);
3983
3984/* declarations for internal use */
3985
3986extern int __kmp_barrier(enum barrier_type bt, int gtid, int is_split,
3987 size_t reduce_size, void *reduce_data,
3988 void (*reduce)(void *, void *));
3989extern void __kmp_end_split_barrier(enum barrier_type bt, int gtid);
3990extern int __kmp_barrier_gomp_cancel(int gtid);
3991
3996enum fork_context_e {
3997 fork_context_gnu,
3999 fork_context_intel,
4000 fork_context_last
4001};
4002extern int __kmp_fork_call(ident_t *loc, int gtid,
4003 enum fork_context_e fork_context, kmp_int32 argc,
4004 microtask_t microtask, launch_t invoker,
4005 kmp_va_list ap);
4006
4007extern void __kmp_join_call(ident_t *loc, int gtid
4008#if OMPT_SUPPORT
4009 ,
4010 enum fork_context_e fork_context
4011#endif
4012 ,
4013 int exit_teams = 0);
4014
4015extern void __kmp_serialized_parallel(ident_t *id, kmp_int32 gtid);
4016extern void __kmp_internal_fork(ident_t *id, int gtid, kmp_team_t *team);
4017extern void __kmp_internal_join(ident_t *id, int gtid, kmp_team_t *team);
4018extern int __kmp_invoke_task_func(int gtid);
4019extern void __kmp_run_before_invoked_task(int gtid, int tid,
4020 kmp_info_t *this_thr,
4021 kmp_team_t *team);
4022extern void __kmp_run_after_invoked_task(int gtid, int tid,
4023 kmp_info_t *this_thr,
4024 kmp_team_t *team);
4025
4026// should never have been exported
4027KMP_EXPORT int __kmpc_invoke_task_func(int gtid);
4028extern int __kmp_invoke_teams_master(int gtid);
4029extern void __kmp_teams_master(int gtid);
4030extern int __kmp_aux_get_team_num();
4031extern int __kmp_aux_get_num_teams();
4032extern void __kmp_save_internal_controls(kmp_info_t *thread);
4033extern void __kmp_user_set_library(enum library_type arg);
4034extern void __kmp_aux_set_library(enum library_type arg);
4035extern void __kmp_aux_set_stacksize(size_t arg);
4036extern void __kmp_aux_set_blocktime(int arg, kmp_info_t *thread, int tid);
4037extern void __kmp_aux_set_defaults(char const *str, size_t len);
4038
4039/* Functions called from __kmp_aux_env_initialize() in kmp_settings.cpp */
4040void kmpc_set_blocktime(int arg);
4041void ompc_set_nested(int flag);
4042void ompc_set_dynamic(int flag);
4043void ompc_set_num_threads(int arg);
4044void kmpc_set_num_threads_8(kmp_int64 arg);
4045
4046extern void __kmp_push_current_task_to_thread(kmp_info_t *this_thr,
4047 kmp_team_t *team, int tid);
4048extern void __kmp_pop_current_task_from_thread(kmp_info_t *this_thr);
4049extern kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
4050 kmp_tasking_flags_t *flags,
4051 size_t sizeof_kmp_task_t,
4052 size_t sizeof_shareds,
4053 kmp_routine_entry_t task_entry);
4054extern void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
4055 kmp_team_t *team, int tid,
4056 int set_curr_task);
4057extern void __kmp_finish_implicit_task(kmp_info_t *this_thr);
4058extern void __kmp_free_implicit_task(kmp_info_t *this_thr);
4059
4060extern kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref,
4061 int gtid,
4062 kmp_task_t *task);
4063extern void __kmp_fulfill_event(kmp_event_t *event);
4064
4065extern void __kmp_free_task_team(kmp_info_t *thread,
4066 kmp_task_team_t *task_team);
4067extern void __kmp_reap_task_teams(void);
4068extern void __kmp_push_task_team_node(kmp_info_t *thread, kmp_team_t *team);
4069extern void __kmp_pop_task_team_node(kmp_info_t *thread, kmp_team_t *team);
4070extern void __kmp_wait_to_unref_task_teams(void);
4071extern void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team);
4072extern void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team);
4073extern void __kmp_task_team_wait(kmp_info_t *this_thr, kmp_team_t *team
4074#if USE_ITT_BUILD
4075 ,
4076 void *itt_sync_obj
4077#endif /* USE_ITT_BUILD */
4078 ,
4079 int wait = 1);
4080extern void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread,
4081 int gtid);
4082#if KMP_DEBUG
4083#define KMP_DEBUG_ASSERT_TASKTEAM_INVARIANT(team, thr) \
4084 KMP_DEBUG_ASSERT( \
4085 __kmp_tasking_mode != tskm_task_teams || team->t.t_nproc == 1 || \
4086 thr->th.th_task_team == team->t.t_task_team[thr->th.th_task_state])
4087#else
4088#define KMP_DEBUG_ASSERT_TASKTEAM_INVARIANT(team, thr) /* Nothing */
4089#endif
4090
4091extern int __kmp_is_address_mapped(void *addr);
4092extern kmp_uint64 __kmp_hardware_timestamp(void);
4093
4094#if KMP_OS_UNIX
4095extern int __kmp_read_from_file(char const *path, char const *format, ...);
4096#endif
4097
4098/* ------------------------------------------------------------------------ */
4099//
4100// Assembly routines that have no compiler intrinsic replacement
4101//
4102
4103extern int __kmp_invoke_microtask(microtask_t pkfn, int gtid, int npr, int argc,
4104 void *argv[]
4105#if OMPT_SUPPORT
4106 ,
4107 void **exit_frame_ptr
4108#endif
4109);
4110
4111/* ------------------------------------------------------------------------ */
4112
4113KMP_EXPORT void __kmpc_begin(ident_t *, kmp_int32 flags);
4114KMP_EXPORT void __kmpc_end(ident_t *);
4115
4116KMP_EXPORT void __kmpc_threadprivate_register_vec(ident_t *, void *data,
4117 kmpc_ctor_vec ctor,
4118 kmpc_cctor_vec cctor,
4119 kmpc_dtor_vec dtor,
4120 size_t vector_length);
4121KMP_EXPORT void __kmpc_threadprivate_register(ident_t *, void *data,
4122 kmpc_ctor ctor, kmpc_cctor cctor,
4123 kmpc_dtor dtor);
4124KMP_EXPORT void *__kmpc_threadprivate(ident_t *, kmp_int32 global_tid,
4125 void *data, size_t size);
4126
4127KMP_EXPORT kmp_int32 __kmpc_global_thread_num(ident_t *);
4128KMP_EXPORT kmp_int32 __kmpc_global_num_threads(ident_t *);
4129KMP_EXPORT kmp_int32 __kmpc_bound_thread_num(ident_t *);
4130KMP_EXPORT kmp_int32 __kmpc_bound_num_threads(ident_t *);
4131
4132KMP_EXPORT kmp_int32 __kmpc_ok_to_fork(ident_t *);
4133KMP_EXPORT void __kmpc_fork_call(ident_t *, kmp_int32 nargs,
4134 kmpc_micro microtask, ...);
4135KMP_EXPORT void __kmpc_fork_call_if(ident_t *loc, kmp_int32 nargs,
4136 kmpc_micro microtask, kmp_int32 cond,
4137 void *args);
4138
4139KMP_EXPORT void __kmpc_serialized_parallel(ident_t *, kmp_int32 global_tid);
4140KMP_EXPORT void __kmpc_end_serialized_parallel(ident_t *, kmp_int32 global_tid);
4141
4142// Values of the order and scope arguments of __kmpc_flush_explicit. They are
4143// the compiler's __ATOMIC_* and __MEMORY_SCOPE_* values.
4144enum kmp_flush_order {
4145 kmp_flush_order_relaxed = 0,
4146 kmp_flush_order_consume = 1, // Completes the encoding; never emitted.
4147 kmp_flush_order_acquire = 2,
4148 kmp_flush_order_release = 3,
4149 kmp_flush_order_acq_rel = 4,
4150 kmp_flush_order_seq_cst = 5
4151};
4152enum kmp_flush_scope {
4153 kmp_flush_scope_all = 0, // memscope(all)
4154 kmp_flush_scope_device = 1, // memscope(device)
4155 kmp_flush_scope_cgroup = 2 // memscope(cgroup)
4156};
4157#ifdef __ATOMIC_SEQ_CST
4158static_assert(kmp_flush_order_relaxed == __ATOMIC_RELAXED &&
4159 kmp_flush_order_consume == __ATOMIC_CONSUME &&
4160 kmp_flush_order_acquire == __ATOMIC_ACQUIRE &&
4161 kmp_flush_order_release == __ATOMIC_RELEASE &&
4162 kmp_flush_order_acq_rel == __ATOMIC_ACQ_REL &&
4163 kmp_flush_order_seq_cst == __ATOMIC_SEQ_CST,
4164 "kmp_flush_order must match the __ATOMIC_* values");
4165#endif
4166#ifdef __MEMORY_SCOPE_SYSTEM
4167static_assert(kmp_flush_scope_all == __MEMORY_SCOPE_SYSTEM &&
4168 kmp_flush_scope_device == __MEMORY_SCOPE_DEVICE &&
4169 kmp_flush_scope_cgroup == __MEMORY_SCOPE_WRKGRP,
4170 "kmp_flush_scope must match the __MEMORY_SCOPE_* values");
4171#endif
4172
4173KMP_EXPORT void __kmpc_flush(ident_t *);
4174KMP_EXPORT void __kmpc_flush_explicit(ident_t *, kmp_int32 order,
4175 kmp_int32 scope);
4176KMP_EXPORT void __kmpc_barrier(ident_t *, kmp_int32 global_tid);
4177KMP_EXPORT kmp_int32 __kmpc_master(ident_t *, kmp_int32 global_tid);
4178KMP_EXPORT void __kmpc_end_master(ident_t *, kmp_int32 global_tid);
4179KMP_EXPORT kmp_int32 __kmpc_masked(ident_t *, kmp_int32 global_tid,
4180 kmp_int32 filter);
4181KMP_EXPORT void __kmpc_end_masked(ident_t *, kmp_int32 global_tid);
4182KMP_EXPORT void __kmpc_ordered(ident_t *, kmp_int32 global_tid);
4183KMP_EXPORT void __kmpc_end_ordered(ident_t *, kmp_int32 global_tid);
4184KMP_EXPORT void __kmpc_critical(ident_t *, kmp_int32 global_tid,
4185 kmp_critical_name *);
4186KMP_EXPORT void __kmpc_end_critical(ident_t *, kmp_int32 global_tid,
4187 kmp_critical_name *);
4188KMP_EXPORT void __kmpc_critical_with_hint(ident_t *, kmp_int32 global_tid,
4189 kmp_critical_name *, uint32_t hint);
4190
4191KMP_EXPORT kmp_int32 __kmpc_barrier_master(ident_t *, kmp_int32 global_tid);
4192KMP_EXPORT void __kmpc_end_barrier_master(ident_t *, kmp_int32 global_tid);
4193
4194KMP_EXPORT kmp_int32 __kmpc_barrier_master_nowait(ident_t *,
4195 kmp_int32 global_tid);
4196
4197KMP_EXPORT kmp_int32 __kmpc_single(ident_t *, kmp_int32 global_tid);
4198KMP_EXPORT void __kmpc_end_single(ident_t *, kmp_int32 global_tid);
4199
4200KMP_EXPORT kmp_int32 __kmpc_sections_init(ident_t *loc, kmp_int32 global_tid);
4201KMP_EXPORT kmp_int32 __kmpc_next_section(ident_t *loc, kmp_int32 global_tid,
4202 kmp_int32 numberOfSections);
4203KMP_EXPORT void __kmpc_end_sections(ident_t *loc, kmp_int32 global_tid);
4204
4205KMP_EXPORT void KMPC_FOR_STATIC_INIT(ident_t *loc, kmp_int32 global_tid,
4206 kmp_int32 schedtype, kmp_int32 *plastiter,
4207 kmp_int *plower, kmp_int *pupper,
4208 kmp_int *pstride, kmp_int incr,
4209 kmp_int chunk);
4210
4211KMP_EXPORT void __kmpc_for_static_fini(ident_t *loc, kmp_int32 global_tid);
4212
4213KMP_EXPORT void __kmpc_copyprivate(ident_t *loc, kmp_int32 global_tid,
4214 size_t cpy_size, void *cpy_data,
4215 void (*cpy_func)(void *, void *),
4216 kmp_int32 didit);
4217
4218KMP_EXPORT void *__kmpc_copyprivate_light(ident_t *loc, kmp_int32 gtid,
4219 void *cpy_data);
4220
4221extern void KMPC_SET_NUM_THREADS(int arg);
4222extern void KMPC_SET_DYNAMIC(int flag);
4223extern void KMPC_SET_NESTED(int flag);
4224
4225/* OMP 3.0 tasking interface routines */
4226KMP_EXPORT kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
4227 kmp_task_t *new_task);
4228KMP_EXPORT kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
4229 kmp_int32 flags,
4230 size_t sizeof_kmp_task_t,
4231 size_t sizeof_shareds,
4232 kmp_routine_entry_t task_entry);
4233KMP_EXPORT kmp_task_t *__kmpc_omp_target_task_alloc(
4234 ident_t *loc_ref, kmp_int32 gtid, kmp_int32 flags, size_t sizeof_kmp_task_t,
4235 size_t sizeof_shareds, kmp_routine_entry_t task_entry, kmp_int64 device_id);
4236KMP_EXPORT void __kmpc_omp_task_begin_if0(ident_t *loc_ref, kmp_int32 gtid,
4237 kmp_task_t *task);
4238KMP_EXPORT void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
4239 kmp_task_t *task);
4240KMP_EXPORT kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
4241 kmp_task_t *new_task);
4242KMP_EXPORT kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid);
4243KMP_EXPORT kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid,
4244 int end_part);
4245
4246#if TASK_UNUSED
4247void __kmpc_omp_task_begin(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task);
4248void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
4249 kmp_task_t *task);
4250#endif // TASK_UNUSED
4251
4252/* ------------------------------------------------------------------------ */
4253
4254KMP_EXPORT void __kmpc_taskgroup(ident_t *loc, int gtid);
4255KMP_EXPORT void __kmpc_end_taskgroup(ident_t *loc, int gtid);
4256
4257KMP_EXPORT kmp_int32 __kmpc_omp_task_with_deps(
4258 ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 ndeps,
4259 kmp_depend_info_t *dep_list, kmp_int32 ndeps_noalias,
4260 kmp_depend_info_t *noalias_dep_list);
4261
4262KMP_EXPORT kmp_base_depnode_t *__kmpc_task_get_depnode(kmp_task_t *task);
4263
4264KMP_EXPORT kmp_depnode_list_t *__kmpc_task_get_successors(kmp_task_t *task);
4265
4266KMP_EXPORT void __kmpc_omp_wait_deps(ident_t *loc_ref, kmp_int32 gtid,
4267 kmp_int32 ndeps,
4268 kmp_depend_info_t *dep_list,
4269 kmp_int32 ndeps_noalias,
4270 kmp_depend_info_t *noalias_dep_list);
4271/* __kmpc_omp_taskwait_deps_51 : Function for OpenMP 5.1 nowait clause.
4272 * Placeholder for taskwait with nowait clause.*/
4273KMP_EXPORT void __kmpc_omp_taskwait_deps_51(ident_t *loc_ref, kmp_int32 gtid,
4274 kmp_int32 ndeps,
4275 kmp_depend_info_t *dep_list,
4276 kmp_int32 ndeps_noalias,
4277 kmp_depend_info_t *noalias_dep_list,
4278 kmp_int32 has_no_wait);
4279
4280extern kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
4281 bool serialize_immediate);
4282
4283KMP_EXPORT kmp_int32 __kmpc_cancel(ident_t *loc_ref, kmp_int32 gtid,
4284 kmp_int32 cncl_kind);
4285KMP_EXPORT kmp_int32 __kmpc_cancellationpoint(ident_t *loc_ref, kmp_int32 gtid,
4286 kmp_int32 cncl_kind);
4287KMP_EXPORT kmp_int32 __kmpc_cancel_barrier(ident_t *loc_ref, kmp_int32 gtid);
4288KMP_EXPORT int __kmp_get_cancellation_status(int cancel_kind);
4289
4290KMP_EXPORT void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask);
4291KMP_EXPORT void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask);
4292KMP_EXPORT void __kmpc_taskloop(ident_t *loc, kmp_int32 gtid, kmp_task_t *task,
4293 kmp_int32 if_val, kmp_uint64 *lb,
4294 kmp_uint64 *ub, kmp_int64 st, kmp_int32 nogroup,
4295 kmp_int32 sched, kmp_uint64 grainsize,
4296 void *task_dup);
4297KMP_EXPORT void __kmpc_taskloop_5(ident_t *loc, kmp_int32 gtid,
4298 kmp_task_t *task, kmp_int32 if_val,
4299 kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4300 kmp_int32 nogroup, kmp_int32 sched,
4301 kmp_uint64 grainsize, kmp_int32 modifier,
4302 void *task_dup);
4303KMP_EXPORT void *__kmpc_task_reduction_init(int gtid, int num_data, void *data);
4304KMP_EXPORT void *__kmpc_taskred_init(int gtid, int num_data, void *data);
4305KMP_EXPORT void *__kmpc_task_reduction_get_th_data(int gtid, void *tg, void *d);
4306KMP_EXPORT void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid,
4307 int is_ws, int num,
4308 void *data);
4309KMP_EXPORT void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws,
4310 int num, void *data);
4311KMP_EXPORT void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid,
4312 int is_ws);
4313KMP_EXPORT kmp_int32 __kmpc_omp_reg_task_with_affinity(
4314 ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 naffins,
4315 kmp_task_affinity_info_t *affin_list);
4316KMP_EXPORT void __kmp_set_num_teams(int num_teams);
4317KMP_EXPORT int __kmp_get_max_teams(void);
4318KMP_EXPORT void __kmp_set_teams_thread_limit(int limit);
4319KMP_EXPORT int __kmp_get_teams_thread_limit(void);
4320
4321/* Interface target task integration */
4322KMP_EXPORT void **__kmpc_omp_get_target_async_handle_ptr(kmp_int32 gtid);
4323KMP_EXPORT bool __kmpc_omp_has_task_team(kmp_int32 gtid);
4324
4325/* Lock interface routines (fast versions with gtid passed in) */
4326KMP_EXPORT void __kmpc_init_lock(ident_t *loc, kmp_int32 gtid,
4327 void **user_lock);
4328KMP_EXPORT void __kmpc_init_nest_lock(ident_t *loc, kmp_int32 gtid,
4329 void **user_lock);
4330KMP_EXPORT void __kmpc_destroy_lock(ident_t *loc, kmp_int32 gtid,
4331 void **user_lock);
4332KMP_EXPORT void __kmpc_destroy_nest_lock(ident_t *loc, kmp_int32 gtid,
4333 void **user_lock);
4334KMP_EXPORT void __kmpc_set_lock(ident_t *loc, kmp_int32 gtid, void **user_lock);
4335KMP_EXPORT void __kmpc_set_nest_lock(ident_t *loc, kmp_int32 gtid,
4336 void **user_lock);
4337KMP_EXPORT void __kmpc_unset_lock(ident_t *loc, kmp_int32 gtid,
4338 void **user_lock);
4339KMP_EXPORT void __kmpc_unset_nest_lock(ident_t *loc, kmp_int32 gtid,
4340 void **user_lock);
4341KMP_EXPORT int __kmpc_test_lock(ident_t *loc, kmp_int32 gtid, void **user_lock);
4342KMP_EXPORT int __kmpc_test_nest_lock(ident_t *loc, kmp_int32 gtid,
4343 void **user_lock);
4344
4345KMP_EXPORT void __kmpc_init_lock_with_hint(ident_t *loc, kmp_int32 gtid,
4346 void **user_lock, uintptr_t hint);
4347KMP_EXPORT void __kmpc_init_nest_lock_with_hint(ident_t *loc, kmp_int32 gtid,
4348 void **user_lock,
4349 uintptr_t hint);
4350#if OMP_TASKGRAPH_EXPERIMENTAL
4351#endif
4352/* Interface to fast scalable reduce methods routines */
4353
4354KMP_EXPORT kmp_int32 __kmpc_reduce_nowait(
4355 ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
4356 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
4357 kmp_critical_name *lck);
4358KMP_EXPORT void __kmpc_end_reduce_nowait(ident_t *loc, kmp_int32 global_tid,
4359 kmp_critical_name *lck);
4360KMP_EXPORT kmp_int32 __kmpc_reduce(
4361 ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
4362 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
4363 kmp_critical_name *lck);
4364KMP_EXPORT void __kmpc_end_reduce(ident_t *loc, kmp_int32 global_tid,
4365 kmp_critical_name *lck);
4366
4367/* Internal fast reduction routines */
4368
4369extern PACKED_REDUCTION_METHOD_T __kmp_determine_reduction_method(
4370 ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
4371 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
4372 kmp_critical_name *lck);
4373
4374// this function is for testing set/get/determine reduce method
4375KMP_EXPORT kmp_int32 __kmp_get_reduce_method(void);
4376
4377KMP_EXPORT kmp_uint64 __kmpc_get_taskid();
4378KMP_EXPORT kmp_uint64 __kmpc_get_parent_taskid();
4379
4380// C++ port
4381// missing 'extern "C"' declarations
4382
4383KMP_EXPORT kmp_int32 __kmpc_in_parallel(ident_t *loc);
4384KMP_EXPORT void __kmpc_pop_num_threads(ident_t *loc, kmp_int32 global_tid);
4385KMP_EXPORT void __kmpc_push_num_threads(ident_t *loc, kmp_int32 global_tid,
4386 kmp_int32 num_threads);
4387KMP_EXPORT void __kmpc_push_num_threads_strict(ident_t *loc,
4388 kmp_int32 global_tid,
4389 kmp_int32 num_threads,
4390 int severity,
4391 const char *message);
4392
4393KMP_EXPORT void __kmpc_push_num_threads_list(ident_t *loc, kmp_int32 global_tid,
4394 kmp_uint32 list_length,
4395 kmp_int32 *num_threads_list);
4396KMP_EXPORT void __kmpc_push_num_threads_list_strict(
4397 ident_t *loc, kmp_int32 global_tid, kmp_uint32 list_length,
4398 kmp_int32 *num_threads_list, int severity, const char *message);
4399
4400KMP_EXPORT void __kmpc_push_proc_bind(ident_t *loc, kmp_int32 global_tid,
4401 int proc_bind);
4402KMP_EXPORT void __kmpc_push_num_teams(ident_t *loc, kmp_int32 global_tid,
4403 kmp_int32 num_teams,
4404 kmp_int32 num_threads);
4405KMP_EXPORT void __kmpc_set_thread_limit(ident_t *loc, kmp_int32 global_tid,
4406 kmp_int32 thread_limit);
4407/* Function for OpenMP 5.1 num_teams clause */
4408KMP_EXPORT void __kmpc_push_num_teams_51(ident_t *loc, kmp_int32 global_tid,
4409 kmp_int32 num_teams_lb,
4410 kmp_int32 num_teams_ub,
4411 kmp_int32 num_threads);
4412KMP_EXPORT void __kmpc_fork_teams(ident_t *loc, kmp_int32 argc,
4413 kmpc_micro microtask, ...);
4414struct kmp_dim { // loop bounds info casted to kmp_int64
4415 kmp_int64 lo; // lower
4416 kmp_int64 up; // upper
4417 kmp_int64 st; // stride
4418};
4419KMP_EXPORT void __kmpc_doacross_init(ident_t *loc, kmp_int32 gtid,
4420 kmp_int32 num_dims,
4421 const struct kmp_dim *dims);
4422KMP_EXPORT void __kmpc_doacross_wait(ident_t *loc, kmp_int32 gtid,
4423 const kmp_int64 *vec);
4424KMP_EXPORT void __kmpc_doacross_post(ident_t *loc, kmp_int32 gtid,
4425 const kmp_int64 *vec);
4426KMP_EXPORT void __kmpc_doacross_fini(ident_t *loc, kmp_int32 gtid);
4427
4428KMP_EXPORT void *__kmpc_threadprivate_cached(ident_t *loc, kmp_int32 global_tid,
4429 void *data, size_t size,
4430 void ***cache);
4431
4432// The routines below are not exported.
4433// Consider making them 'static' in corresponding source files.
4434void kmp_threadprivate_insert_private_data(int gtid, void *pc_addr,
4435 void *data_addr, size_t pc_size);
4436struct private_common *kmp_threadprivate_insert(int gtid, void *pc_addr,
4437 void *data_addr,
4438 size_t pc_size);
4439void __kmp_threadprivate_resize_cache(int newCapacity);
4440void __kmp_cleanup_threadprivate_caches();
4441
4442// ompc_, kmpc_ entries moved from omp.h.
4443#if KMP_OS_WINDOWS
4444#define KMPC_CONVENTION __cdecl
4445#else
4446#define KMPC_CONVENTION
4447#endif
4448
4449#ifndef __OMP_H
4450typedef enum omp_sched_t {
4451 omp_sched_static = 1,
4452 omp_sched_dynamic = 2,
4453 omp_sched_guided = 3,
4454 omp_sched_auto = 4
4455} omp_sched_t;
4456typedef void *kmp_affinity_mask_t;
4457#endif
4458
4459KMP_EXPORT void KMPC_CONVENTION ompc_set_max_active_levels(int);
4460KMP_EXPORT void KMPC_CONVENTION ompc_set_schedule(omp_sched_t, int);
4461KMP_EXPORT int KMPC_CONVENTION ompc_get_ancestor_thread_num(int);
4462KMP_EXPORT int KMPC_CONVENTION ompc_get_team_size(int);
4463KMP_EXPORT int KMPC_CONVENTION
4464kmpc_set_affinity_mask_proc(int, kmp_affinity_mask_t *);
4465KMP_EXPORT int KMPC_CONVENTION
4466kmpc_unset_affinity_mask_proc(int, kmp_affinity_mask_t *);
4467KMP_EXPORT int KMPC_CONVENTION
4468kmpc_get_affinity_mask_proc(int, kmp_affinity_mask_t *);
4469
4470KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize(int);
4471KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize_s(size_t);
4472KMP_EXPORT void KMPC_CONVENTION kmpc_set_library(int);
4473KMP_EXPORT void KMPC_CONVENTION kmpc_set_defaults(char const *);
4474KMP_EXPORT void KMPC_CONVENTION kmpc_set_disp_num_buffers(int);
4475void KMP_EXPAND_NAME(ompc_set_affinity_format)(char const *format);
4476size_t KMP_EXPAND_NAME(ompc_get_affinity_format)(char *buffer, size_t size);
4477void KMP_EXPAND_NAME(ompc_display_affinity)(char const *format);
4478size_t KMP_EXPAND_NAME(ompc_capture_affinity)(char *buffer, size_t buf_size,
4479 char const *format);
4480
4481enum kmp_target_offload_kind {
4482 tgt_disabled = 0,
4483 tgt_default = 1,
4484 tgt_mandatory = 2
4485};
4486typedef enum kmp_target_offload_kind kmp_target_offload_kind_t;
4487// Set via OMP_TARGET_OFFLOAD if specified, defaults to tgt_default otherwise
4488extern kmp_target_offload_kind_t __kmp_target_offload;
4489extern int __kmpc_get_target_offload();
4490
4491// Constants used in libomptarget
4492#define KMP_DEVICE_DEFAULT -1 // This is libomptarget's default device.
4493#define KMP_DEVICE_ALL -11 // This is libomptarget's "all devices".
4494
4495// OMP Pause Resource
4496
4497// The following enum is used both to set the status in __kmp_pause_status, and
4498// as the internal equivalent of the externally-visible omp_pause_resource_t.
4499typedef enum kmp_pause_status_t {
4500 kmp_not_paused = 0, // status is not paused, or, requesting resume
4501 kmp_soft_paused = 1, // status is soft-paused, or, requesting soft pause
4502 kmp_hard_paused = 2, // status is hard-paused, or, requesting hard pause
4503 kmp_stop_tool_paused = 3 // requesting stop_tool pause
4504} kmp_pause_status_t;
4505
4506// This stores the pause state of the runtime
4507extern kmp_pause_status_t __kmp_pause_status;
4508extern int __kmpc_pause_resource(kmp_pause_status_t level);
4509extern int __kmp_pause_resource(kmp_pause_status_t level);
4510// Soft resume sets __kmp_pause_status, and wakes up all threads.
4511extern void __kmp_resume_if_soft_paused();
4512// Hard resume simply resets the status to not paused. Library will appear to
4513// be uninitialized after hard pause. Let OMP constructs trigger required
4514// initializations.
4515static inline void __kmp_resume_if_hard_paused() {
4516 if (__kmp_pause_status == kmp_hard_paused) {
4517 __kmp_pause_status = kmp_not_paused;
4518 }
4519}
4520
4521extern void __kmp_omp_display_env(int verbose);
4522
4523// 1: it is initializing hidden helper team
4524extern volatile int __kmp_init_hidden_helper;
4525// 1: the hidden helper team is done
4526extern volatile int __kmp_hidden_helper_team_done;
4527// 1: enable hidden helper task
4528extern kmp_int32 __kmp_enable_hidden_helper;
4529// Main thread of hidden helper team
4530extern kmp_info_t *__kmp_hidden_helper_main_thread;
4531// Descriptors for the hidden helper threads
4532extern kmp_info_t **__kmp_hidden_helper_threads;
4533// Number of hidden helper threads
4534extern kmp_int32 __kmp_hidden_helper_threads_num;
4535// Number of hidden helper tasks that have not been executed yet
4536extern std::atomic<kmp_int32> __kmp_unexecuted_hidden_helper_tasks;
4537
4538extern void __kmp_hidden_helper_initialize();
4539extern void __kmp_hidden_helper_threads_initz_routine();
4540extern void __kmp_do_initialize_hidden_helper_threads();
4541extern void __kmp_hidden_helper_threads_initz_wait();
4542extern void __kmp_hidden_helper_initz_release();
4543extern void __kmp_hidden_helper_threads_deinitz_wait();
4544extern void __kmp_hidden_helper_threads_deinitz_release();
4545extern void __kmp_hidden_helper_main_thread_wait();
4546extern void __kmp_hidden_helper_worker_thread_wait();
4547extern void __kmp_hidden_helper_worker_thread_signal();
4548extern void __kmp_hidden_helper_main_thread_release();
4549
4550// Check whether a given thread is a hidden helper thread
4551#define KMP_HIDDEN_HELPER_THREAD(gtid) \
4552 ((gtid) >= 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4553
4554#define KMP_HIDDEN_HELPER_WORKER_THREAD(gtid) \
4555 ((gtid) > 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4556
4557#define KMP_HIDDEN_HELPER_MAIN_THREAD(gtid) \
4558 ((gtid) == 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4559
4560#define KMP_HIDDEN_HELPER_TEAM(team) \
4561 (team->t.t_threads[0] == __kmp_hidden_helper_main_thread)
4562
4563// Map a gtid to a hidden helper thread. The first hidden helper thread, a.k.a
4564// main thread, is skipped.
4565#define KMP_GTID_TO_SHADOW_GTID(gtid) \
4566 ((gtid) % (__kmp_hidden_helper_threads_num - 1) + 2)
4567
4568// Return the adjusted gtid value by subtracting from gtid the number
4569// of hidden helper threads. This adjusted value is the gtid the thread would
4570// have received if there were no hidden helper threads.
4571static inline int __kmp_adjust_gtid_for_hidden_helpers(int gtid) {
4572 int adjusted_gtid = gtid;
4573 if (__kmp_hidden_helper_threads_num > 0 && gtid > 0 &&
4574 gtid - __kmp_hidden_helper_threads_num >= 0) {
4575 adjusted_gtid -= __kmp_hidden_helper_threads_num;
4576 }
4577 return adjusted_gtid;
4578}
4579
4580#if ENABLE_LIBOMPTARGET
4581// Pointers to callbacks registered by the offload library to be notified of
4582// task progress.
4583extern void (*kmp_target_sync_cb)(ident_t *loc_ref, int gtid,
4584 void *current_task, void *event);
4585#endif // ENABLE_LIBOMPTARGET
4586
4587// Support for error directive
4588typedef enum kmp_severity_t {
4589 severity_warning = 1,
4590 severity_fatal = 2
4591} kmp_severity_t;
4592extern void __kmpc_error(ident_t *loc, int severity, const char *message);
4593
4594// Support for scope directive
4595KMP_EXPORT void __kmpc_scope(ident_t *loc, kmp_int32 gtid, void *reserved);
4596KMP_EXPORT void __kmpc_end_scope(ident_t *loc, kmp_int32 gtid, void *reserved);
4597
4598#ifdef __cplusplus
4599}
4600#endif
4601
4602template <bool C, bool S>
4603extern void __kmp_suspend_32(int th_gtid, kmp_flag_32<C, S> *flag);
4604template <bool C, bool S>
4605extern void __kmp_suspend_64(int th_gtid, kmp_flag_64<C, S> *flag);
4606template <bool C, bool S>
4607extern void __kmp_atomic_suspend_64(int th_gtid,
4608 kmp_atomic_flag_64<C, S> *flag);
4609extern void __kmp_suspend_oncore(int th_gtid, kmp_flag_oncore *flag);
4610#if KMP_HAVE_MWAIT || KMP_HAVE_UMWAIT
4611template <bool C, bool S>
4612extern void __kmp_mwait_32(int th_gtid, kmp_flag_32<C, S> *flag);
4613template <bool C, bool S>
4614extern void __kmp_mwait_64(int th_gtid, kmp_flag_64<C, S> *flag);
4615template <bool C, bool S>
4616extern void __kmp_atomic_mwait_64(int th_gtid, kmp_atomic_flag_64<C, S> *flag);
4617extern void __kmp_mwait_oncore(int th_gtid, kmp_flag_oncore *flag);
4618#endif
4619template <bool C, bool S>
4620extern void __kmp_resume_32(int target_gtid, kmp_flag_32<C, S> *flag);
4621template <bool C, bool S>
4622extern void __kmp_resume_64(int target_gtid, kmp_flag_64<C, S> *flag);
4623template <bool C, bool S>
4624extern void __kmp_atomic_resume_64(int target_gtid,
4625 kmp_atomic_flag_64<C, S> *flag);
4626extern void __kmp_resume_oncore(int target_gtid, kmp_flag_oncore *flag);
4627
4628template <bool C, bool S>
4629int __kmp_execute_tasks_32(kmp_info_t *thread, kmp_int32 gtid,
4630 kmp_flag_32<C, S> *flag, int final_spin,
4631 int *thread_finished,
4632#if USE_ITT_BUILD
4633 void *itt_sync_obj,
4634#endif /* USE_ITT_BUILD */
4635 kmp_int32 is_constrained);
4636template <bool C, bool S>
4637int __kmp_execute_tasks_64(kmp_info_t *thread, kmp_int32 gtid,
4638 kmp_flag_64<C, S> *flag, int final_spin,
4639 int *thread_finished,
4640#if USE_ITT_BUILD
4641 void *itt_sync_obj,
4642#endif /* USE_ITT_BUILD */
4643 kmp_int32 is_constrained);
4644template <bool C, bool S>
4645int __kmp_atomic_execute_tasks_64(kmp_info_t *thread, kmp_int32 gtid,
4646 kmp_atomic_flag_64<C, S> *flag,
4647 int final_spin, int *thread_finished,
4648#if USE_ITT_BUILD
4649 void *itt_sync_obj,
4650#endif /* USE_ITT_BUILD */
4651 kmp_int32 is_constrained);
4652int __kmp_execute_tasks_oncore(kmp_info_t *thread, kmp_int32 gtid,
4653 kmp_flag_oncore *flag, int final_spin,
4654 int *thread_finished,
4655#if USE_ITT_BUILD
4656 void *itt_sync_obj,
4657#endif /* USE_ITT_BUILD */
4658 kmp_int32 is_constrained);
4659
4660extern int __kmp_nesting_mode;
4661extern int __kmp_nesting_mode_nlevels;
4662extern int *__kmp_nesting_nth_level;
4663extern void __kmp_init_nesting_mode();
4664extern void __kmp_set_nesting_mode_threads();
4665
4673 FILE *f;
4674
4675 void close() {
4676 if (f && f != stdout && f != stderr) {
4677 fclose(f);
4678 f = nullptr;
4679 }
4680 }
4681
4682public:
4683 kmp_safe_raii_file_t() : f(nullptr) {}
4684 kmp_safe_raii_file_t(const char *filename, const char *mode,
4685 const char *env_var = nullptr)
4686 : f(nullptr) {
4687 open(filename, mode, env_var);
4688 }
4689 kmp_safe_raii_file_t(const kmp_safe_raii_file_t &other) = delete;
4690 kmp_safe_raii_file_t &operator=(const kmp_safe_raii_file_t &other) = delete;
4691 ~kmp_safe_raii_file_t() { close(); }
4692
4696 void open(const char *filename, const char *mode,
4697 const char *env_var = nullptr) {
4698 KMP_ASSERT(!f);
4699 f = fopen(filename, mode);
4700 if (!f) {
4701 int code = errno;
4702 if (env_var) {
4703 __kmp_fatal(KMP_MSG(CantOpenFileForReading, filename), KMP_ERR(code),
4704 KMP_HNT(CheckEnvVar, env_var, filename), __kmp_msg_null);
4705 } else {
4706 __kmp_fatal(KMP_MSG(CantOpenFileForReading, filename), KMP_ERR(code),
4707 __kmp_msg_null);
4708 }
4709 }
4710 }
4713 int try_open(const char *filename, const char *mode) {
4714 KMP_ASSERT(!f);
4715 f = fopen(filename, mode);
4716 if (!f)
4717 return errno;
4718 return 0;
4719 }
4722 void set_stdout() {
4723 KMP_ASSERT(!f);
4724 f = stdout;
4725 }
4728 void set_stderr() {
4729 KMP_ASSERT(!f);
4730 f = stderr;
4731 }
4732 operator bool() { return bool(f); }
4733 operator FILE *() { return f; }
4734};
4735
4736template <typename SourceType, typename TargetType,
4737 bool isSourceSmaller = (sizeof(SourceType) < sizeof(TargetType)),
4738 bool isSourceEqual = (sizeof(SourceType) == sizeof(TargetType)),
4739 bool isSourceSigned = std::is_signed<SourceType>::value,
4740 bool isTargetSigned = std::is_signed<TargetType>::value>
4741struct kmp_convert {};
4742
4743// Both types are signed; Source smaller
4744template <typename SourceType, typename TargetType>
4745struct kmp_convert<SourceType, TargetType, true, false, true, true> {
4746 static TargetType to(SourceType src) { return (TargetType)src; }
4747};
4748// Source equal
4749template <typename SourceType, typename TargetType>
4750struct kmp_convert<SourceType, TargetType, false, true, true, true> {
4751 static TargetType to(SourceType src) { return src; }
4752};
4753// Source bigger
4754template <typename SourceType, typename TargetType>
4755struct kmp_convert<SourceType, TargetType, false, false, true, true> {
4756 static TargetType to(SourceType src) {
4757 KMP_ASSERT(src <= static_cast<SourceType>(
4758 (std::numeric_limits<TargetType>::max)()));
4759 KMP_ASSERT(src >= static_cast<SourceType>(
4760 (std::numeric_limits<TargetType>::min)()));
4761 return (TargetType)src;
4762 }
4763};
4764
4765// Source signed, Target unsigned
4766// Source smaller
4767template <typename SourceType, typename TargetType>
4768struct kmp_convert<SourceType, TargetType, true, false, true, false> {
4769 static TargetType to(SourceType src) {
4770 KMP_ASSERT(src >= 0);
4771 return (TargetType)src;
4772 }
4773};
4774// Source equal
4775template <typename SourceType, typename TargetType>
4776struct kmp_convert<SourceType, TargetType, false, true, true, false> {
4777 static TargetType to(SourceType src) {
4778 KMP_ASSERT(src >= 0);
4779 return (TargetType)src;
4780 }
4781};
4782// Source bigger
4783template <typename SourceType, typename TargetType>
4784struct kmp_convert<SourceType, TargetType, false, false, true, false> {
4785 static TargetType to(SourceType src) {
4786 KMP_ASSERT(src >= 0);
4787 KMP_ASSERT(src <= static_cast<SourceType>(
4788 (std::numeric_limits<TargetType>::max)()));
4789 return (TargetType)src;
4790 }
4791};
4792
4793// Source unsigned, Target signed
4794// Source smaller
4795template <typename SourceType, typename TargetType>
4796struct kmp_convert<SourceType, TargetType, true, false, false, true> {
4797 static TargetType to(SourceType src) { return (TargetType)src; }
4798};
4799// Source equal
4800template <typename SourceType, typename TargetType>
4801struct kmp_convert<SourceType, TargetType, false, true, false, true> {
4802 static TargetType to(SourceType src) {
4803 KMP_ASSERT(src <= static_cast<SourceType>(
4804 (std::numeric_limits<TargetType>::max)()));
4805 return (TargetType)src;
4806 }
4807};
4808// Source bigger
4809template <typename SourceType, typename TargetType>
4810struct kmp_convert<SourceType, TargetType, false, false, false, true> {
4811 static TargetType to(SourceType src) {
4812 KMP_ASSERT(src <= static_cast<SourceType>(
4813 (std::numeric_limits<TargetType>::max)()));
4814 return (TargetType)src;
4815 }
4816};
4817
4818// Source unsigned, Target unsigned
4819// Source smaller
4820template <typename SourceType, typename TargetType>
4821struct kmp_convert<SourceType, TargetType, true, false, false, false> {
4822 static TargetType to(SourceType src) { return (TargetType)src; }
4823};
4824// Source equal
4825template <typename SourceType, typename TargetType>
4826struct kmp_convert<SourceType, TargetType, false, true, false, false> {
4827 static TargetType to(SourceType src) { return src; }
4828};
4829// Source bigger
4830template <typename SourceType, typename TargetType>
4831struct kmp_convert<SourceType, TargetType, false, false, false, false> {
4832 static TargetType to(SourceType src) {
4833 KMP_ASSERT(src <= static_cast<SourceType>(
4834 (std::numeric_limits<TargetType>::max)()));
4835 return (TargetType)src;
4836 }
4837};
4838
4839template <typename T1, typename T2>
4840static inline void __kmp_type_convert(T1 src, T2 *dest) {
4841 *dest = kmp_convert<T1, T2>::to(src);
4842}
4843
4844#endif /* KMP_H */
void set_stdout()
Definition: kmp.h:4722
void set_stderr()
Definition: kmp.h:4728
int try_open(const char *filename, const char *mode)
Definition: kmp.h:4713
void open(const char *filename, const char *mode, const char *env_var=nullptr)
Definition: kmp.h:4696
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_flush_explicit(ident_t *, kmp_int32 order, kmp_int32 scope)
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)
KMP_EXPORT void * __kmpc_task_reduction_get_th_data(int gtid, void *tg, void *d)
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_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws, int num, void *data)
KMP_EXPORT void * __kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num, 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)
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_task_reduction_init(int gtid, int num_data, void *data)
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_taskred_init(int gtid, int num_data, void *data)
KMP_EXPORT void ** __kmpc_omp_get_target_async_handle_ptr(kmp_int32 gtid)
void(* kmpc_dtor)(void *)
Definition: kmp.h:1788
void *(* kmpc_cctor)(void *, void *)
Definition: kmp.h:1795
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_cctor_vec)(void *, void *, size_t)
Definition: kmp.h:1817
void *(* kmpc_ctor)(void *)
Definition: kmp.h:1782
KMP_EXPORT void * __kmpc_copyprivate_light(ident_t *loc, kmp_int32 gtid, void *cpy_data)
void *(* kmpc_ctor_vec)(void *, size_t)
Definition: kmp.h:1805
KMP_EXPORT void * __kmpc_threadprivate_cached(ident_t *loc, kmp_int32 global_tid, void *data, size_t size, void ***cache)
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 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