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