xref: /freebsd/contrib/llvm-project/openmp/runtime/src/kmp.h (revision fcaf7f8644a9988098ac6be2165bce3ea4786e91)
10b57cec5SDimitry Andric /*! \file */
20b57cec5SDimitry Andric /*
30b57cec5SDimitry Andric  * kmp.h -- KPTS runtime header file.
40b57cec5SDimitry Andric  */
50b57cec5SDimitry Andric 
60b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
70b57cec5SDimitry Andric //
80b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
90b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
100b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
110b57cec5SDimitry Andric //
120b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric #ifndef KMP_H
150b57cec5SDimitry Andric #define KMP_H
160b57cec5SDimitry Andric 
170b57cec5SDimitry Andric #include "kmp_config.h"
180b57cec5SDimitry Andric 
190b57cec5SDimitry Andric /* #define BUILD_PARALLEL_ORDERED 1 */
200b57cec5SDimitry Andric 
210b57cec5SDimitry Andric /* This fix replaces gettimeofday with clock_gettime for better scalability on
220b57cec5SDimitry Andric    the Altix.  Requires user code to be linked with -lrt. */
230b57cec5SDimitry Andric //#define FIX_SGI_CLOCK
240b57cec5SDimitry Andric 
250b57cec5SDimitry Andric /* Defines for OpenMP 3.0 tasking and auto scheduling */
260b57cec5SDimitry Andric 
270b57cec5SDimitry Andric #ifndef KMP_STATIC_STEAL_ENABLED
280b57cec5SDimitry Andric #define KMP_STATIC_STEAL_ENABLED 1
290b57cec5SDimitry Andric #endif
300b57cec5SDimitry Andric 
310b57cec5SDimitry Andric #define TASK_CURRENT_NOT_QUEUED 0
320b57cec5SDimitry Andric #define TASK_CURRENT_QUEUED 1
330b57cec5SDimitry Andric 
340b57cec5SDimitry Andric #ifdef BUILD_TIED_TASK_STACK
350b57cec5SDimitry Andric #define TASK_STACK_EMPTY 0 // entries when the stack is empty
360b57cec5SDimitry Andric #define TASK_STACK_BLOCK_BITS 5 // Used in TASK_STACK_SIZE and TASK_STACK_MASK
370b57cec5SDimitry Andric // Number of entries in each task stack array
380b57cec5SDimitry Andric #define TASK_STACK_BLOCK_SIZE (1 << TASK_STACK_BLOCK_BITS)
390b57cec5SDimitry Andric // Mask for determining index into stack block
400b57cec5SDimitry Andric #define TASK_STACK_INDEX_MASK (TASK_STACK_BLOCK_SIZE - 1)
410b57cec5SDimitry Andric #endif // BUILD_TIED_TASK_STACK
420b57cec5SDimitry Andric 
430b57cec5SDimitry Andric #define TASK_NOT_PUSHED 1
440b57cec5SDimitry Andric #define TASK_SUCCESSFULLY_PUSHED 0
450b57cec5SDimitry Andric #define TASK_TIED 1
460b57cec5SDimitry Andric #define TASK_UNTIED 0
470b57cec5SDimitry Andric #define TASK_EXPLICIT 1
480b57cec5SDimitry Andric #define TASK_IMPLICIT 0
490b57cec5SDimitry Andric #define TASK_PROXY 1
500b57cec5SDimitry Andric #define TASK_FULL 0
510b57cec5SDimitry Andric #define TASK_DETACHABLE 1
520b57cec5SDimitry Andric #define TASK_UNDETACHABLE 0
530b57cec5SDimitry Andric 
540b57cec5SDimitry Andric #define KMP_CANCEL_THREADS
550b57cec5SDimitry Andric #define KMP_THREAD_ATTR
560b57cec5SDimitry Andric 
570b57cec5SDimitry Andric // Android does not have pthread_cancel.  Undefine KMP_CANCEL_THREADS if being
580b57cec5SDimitry Andric // built on Android
590b57cec5SDimitry Andric #if defined(__ANDROID__)
600b57cec5SDimitry Andric #undef KMP_CANCEL_THREADS
610b57cec5SDimitry Andric #endif
620b57cec5SDimitry Andric 
630b57cec5SDimitry Andric #include <signal.h>
640b57cec5SDimitry Andric #include <stdarg.h>
650b57cec5SDimitry Andric #include <stddef.h>
660b57cec5SDimitry Andric #include <stdio.h>
670b57cec5SDimitry Andric #include <stdlib.h>
680b57cec5SDimitry Andric #include <string.h>
69e8d8bef9SDimitry Andric #include <limits>
70e8d8bef9SDimitry Andric #include <type_traits>
710b57cec5SDimitry Andric /* include <ctype.h> don't use; problems with /MD on Windows* OS NT due to bad
720b57cec5SDimitry Andric    Microsoft library. Some macros provided below to replace these functions  */
730b57cec5SDimitry Andric #ifndef __ABSOFT_WIN
740b57cec5SDimitry Andric #include <sys/types.h>
750b57cec5SDimitry Andric #endif
760b57cec5SDimitry Andric #include <limits.h>
770b57cec5SDimitry Andric #include <time.h>
780b57cec5SDimitry Andric 
790b57cec5SDimitry Andric #include <errno.h>
800b57cec5SDimitry Andric 
810b57cec5SDimitry Andric #include "kmp_os.h"
820b57cec5SDimitry Andric 
830b57cec5SDimitry Andric #include "kmp_safe_c_api.h"
840b57cec5SDimitry Andric 
850b57cec5SDimitry Andric #if KMP_STATS_ENABLED
860b57cec5SDimitry Andric class kmp_stats_list;
870b57cec5SDimitry Andric #endif
880b57cec5SDimitry Andric 
890b57cec5SDimitry Andric #if KMP_USE_HIER_SCHED
900b57cec5SDimitry Andric // Only include hierarchical scheduling if affinity is supported
910b57cec5SDimitry Andric #undef KMP_USE_HIER_SCHED
920b57cec5SDimitry Andric #define KMP_USE_HIER_SCHED KMP_AFFINITY_SUPPORTED
930b57cec5SDimitry Andric #endif
940b57cec5SDimitry Andric 
950b57cec5SDimitry Andric #if KMP_USE_HWLOC && KMP_AFFINITY_SUPPORTED
960b57cec5SDimitry Andric #include "hwloc.h"
970b57cec5SDimitry Andric #ifndef HWLOC_OBJ_NUMANODE
980b57cec5SDimitry Andric #define HWLOC_OBJ_NUMANODE HWLOC_OBJ_NODE
990b57cec5SDimitry Andric #endif
1000b57cec5SDimitry Andric #ifndef HWLOC_OBJ_PACKAGE
1010b57cec5SDimitry Andric #define HWLOC_OBJ_PACKAGE HWLOC_OBJ_SOCKET
1020b57cec5SDimitry Andric #endif
1030b57cec5SDimitry Andric #endif
1040b57cec5SDimitry Andric 
1050b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
1060b57cec5SDimitry Andric #include <xmmintrin.h>
1070b57cec5SDimitry Andric #endif
1080b57cec5SDimitry Andric 
10981ad6265SDimitry Andric // The below has to be defined before including "kmp_barrier.h".
11081ad6265SDimitry Andric #define KMP_INTERNAL_MALLOC(sz) malloc(sz)
11181ad6265SDimitry Andric #define KMP_INTERNAL_FREE(p) free(p)
11281ad6265SDimitry Andric #define KMP_INTERNAL_REALLOC(p, sz) realloc((p), (sz))
11381ad6265SDimitry Andric #define KMP_INTERNAL_CALLOC(n, sz) calloc((n), (sz))
11481ad6265SDimitry Andric 
1150b57cec5SDimitry Andric #include "kmp_debug.h"
1160b57cec5SDimitry Andric #include "kmp_lock.h"
1170b57cec5SDimitry Andric #include "kmp_version.h"
118349cc55cSDimitry Andric #include "kmp_barrier.h"
1190b57cec5SDimitry Andric #if USE_DEBUGGER
1200b57cec5SDimitry Andric #include "kmp_debugger.h"
1210b57cec5SDimitry Andric #endif
1220b57cec5SDimitry Andric #include "kmp_i18n.h"
1230b57cec5SDimitry Andric 
1240b57cec5SDimitry Andric #define KMP_HANDLE_SIGNALS (KMP_OS_UNIX || KMP_OS_WINDOWS)
1250b57cec5SDimitry Andric 
1260b57cec5SDimitry Andric #include "kmp_wrapper_malloc.h"
1270b57cec5SDimitry Andric #if KMP_OS_UNIX
1280b57cec5SDimitry Andric #include <unistd.h>
1290b57cec5SDimitry Andric #if !defined NSIG && defined _NSIG
1300b57cec5SDimitry Andric #define NSIG _NSIG
1310b57cec5SDimitry Andric #endif
1320b57cec5SDimitry Andric #endif
1330b57cec5SDimitry Andric 
1340b57cec5SDimitry Andric #if KMP_OS_LINUX
1350b57cec5SDimitry Andric #pragma weak clock_gettime
1360b57cec5SDimitry Andric #endif
1370b57cec5SDimitry Andric 
1380b57cec5SDimitry Andric #if OMPT_SUPPORT
1390b57cec5SDimitry Andric #include "ompt-internal.h"
1400b57cec5SDimitry Andric #endif
1410b57cec5SDimitry Andric 
142fe6060f1SDimitry Andric #if OMPD_SUPPORT
143fe6060f1SDimitry Andric #include "ompd-specific.h"
144fe6060f1SDimitry Andric #endif
145fe6060f1SDimitry Andric 
146e8d8bef9SDimitry Andric #ifndef UNLIKELY
147e8d8bef9SDimitry Andric #define UNLIKELY(x) (x)
148e8d8bef9SDimitry Andric #endif
149e8d8bef9SDimitry Andric 
1500b57cec5SDimitry Andric // Affinity format function
1510b57cec5SDimitry Andric #include "kmp_str.h"
1520b57cec5SDimitry Andric 
1530b57cec5SDimitry Andric // 0 - no fast memory allocation, alignment: 8-byte on x86, 16-byte on x64.
1540b57cec5SDimitry Andric // 3 - fast allocation using sync, non-sync free lists of any size, non-self
1550b57cec5SDimitry Andric // free lists of limited size.
1560b57cec5SDimitry Andric #ifndef USE_FAST_MEMORY
1570b57cec5SDimitry Andric #define USE_FAST_MEMORY 3
1580b57cec5SDimitry Andric #endif
1590b57cec5SDimitry Andric 
1600b57cec5SDimitry Andric #ifndef KMP_NESTED_HOT_TEAMS
1610b57cec5SDimitry Andric #define KMP_NESTED_HOT_TEAMS 0
1620b57cec5SDimitry Andric #define USE_NESTED_HOT_ARG(x)
1630b57cec5SDimitry Andric #else
1640b57cec5SDimitry Andric #if KMP_NESTED_HOT_TEAMS
1650b57cec5SDimitry Andric #define USE_NESTED_HOT_ARG(x) , x
1660b57cec5SDimitry Andric #else
1670b57cec5SDimitry Andric #define USE_NESTED_HOT_ARG(x)
1680b57cec5SDimitry Andric #endif
1690b57cec5SDimitry Andric #endif
1700b57cec5SDimitry Andric 
1710b57cec5SDimitry Andric // Assume using BGET compare_exchange instruction instead of lock by default.
1720b57cec5SDimitry Andric #ifndef USE_CMP_XCHG_FOR_BGET
1730b57cec5SDimitry Andric #define USE_CMP_XCHG_FOR_BGET 1
1740b57cec5SDimitry Andric #endif
1750b57cec5SDimitry Andric 
1760b57cec5SDimitry Andric // Test to see if queuing lock is better than bootstrap lock for bget
1770b57cec5SDimitry Andric // #ifndef USE_QUEUING_LOCK_FOR_BGET
1780b57cec5SDimitry Andric // #define USE_QUEUING_LOCK_FOR_BGET
1790b57cec5SDimitry Andric // #endif
1800b57cec5SDimitry Andric 
1810b57cec5SDimitry Andric #define KMP_NSEC_PER_SEC 1000000000L
1820b57cec5SDimitry Andric #define KMP_USEC_PER_SEC 1000000L
1830b57cec5SDimitry Andric 
1840b57cec5SDimitry Andric /*!
1850b57cec5SDimitry Andric @ingroup BASIC_TYPES
1860b57cec5SDimitry Andric @{
1870b57cec5SDimitry Andric */
1880b57cec5SDimitry Andric 
1890b57cec5SDimitry Andric /*!
1900b57cec5SDimitry Andric Values for bit flags used in the ident_t to describe the fields.
1910b57cec5SDimitry Andric */
1920b57cec5SDimitry Andric enum {
1930b57cec5SDimitry Andric   /*! Use trampoline for internal microtasks */
1940b57cec5SDimitry Andric   KMP_IDENT_IMB = 0x01,
1950b57cec5SDimitry Andric   /*! Use c-style ident structure */
1960b57cec5SDimitry Andric   KMP_IDENT_KMPC = 0x02,
1970b57cec5SDimitry Andric   /* 0x04 is no longer used */
1980b57cec5SDimitry Andric   /*! Entry point generated by auto-parallelization */
1990b57cec5SDimitry Andric   KMP_IDENT_AUTOPAR = 0x08,
2000b57cec5SDimitry Andric   /*! Compiler generates atomic reduction option for kmpc_reduce* */
2010b57cec5SDimitry Andric   KMP_IDENT_ATOMIC_REDUCE = 0x10,
2020b57cec5SDimitry Andric   /*! To mark a 'barrier' directive in user code */
2030b57cec5SDimitry Andric   KMP_IDENT_BARRIER_EXPL = 0x20,
2040b57cec5SDimitry Andric   /*! To Mark implicit barriers. */
2050b57cec5SDimitry Andric   KMP_IDENT_BARRIER_IMPL = 0x0040,
2060b57cec5SDimitry Andric   KMP_IDENT_BARRIER_IMPL_MASK = 0x01C0,
2070b57cec5SDimitry Andric   KMP_IDENT_BARRIER_IMPL_FOR = 0x0040,
2080b57cec5SDimitry Andric   KMP_IDENT_BARRIER_IMPL_SECTIONS = 0x00C0,
2090b57cec5SDimitry Andric 
2100b57cec5SDimitry Andric   KMP_IDENT_BARRIER_IMPL_SINGLE = 0x0140,
2110b57cec5SDimitry Andric   KMP_IDENT_BARRIER_IMPL_WORKSHARE = 0x01C0,
2120b57cec5SDimitry Andric 
2130b57cec5SDimitry Andric   /*! To mark a static loop in OMPT callbacks */
2140b57cec5SDimitry Andric   KMP_IDENT_WORK_LOOP = 0x200,
2150b57cec5SDimitry Andric   /*! To mark a sections directive in OMPT callbacks */
2160b57cec5SDimitry Andric   KMP_IDENT_WORK_SECTIONS = 0x400,
217480093f4SDimitry Andric   /*! To mark a distribute construct in OMPT callbacks */
2180b57cec5SDimitry Andric   KMP_IDENT_WORK_DISTRIBUTE = 0x800,
2190b57cec5SDimitry Andric   /*! Atomic hint; bottom four bits as omp_sync_hint_t. Top four reserved and
2200b57cec5SDimitry Andric       not currently used. If one day we need more bits, then we can use
2210b57cec5SDimitry Andric       an invalid combination of hints to mean that another, larger field
2220b57cec5SDimitry Andric       should be used in a different flag. */
2230b57cec5SDimitry Andric   KMP_IDENT_ATOMIC_HINT_MASK = 0xFF0000,
2240b57cec5SDimitry Andric   KMP_IDENT_ATOMIC_HINT_UNCONTENDED = 0x010000,
2250b57cec5SDimitry Andric   KMP_IDENT_ATOMIC_HINT_CONTENDED = 0x020000,
2260b57cec5SDimitry Andric   KMP_IDENT_ATOMIC_HINT_NONSPECULATIVE = 0x040000,
2270b57cec5SDimitry Andric   KMP_IDENT_ATOMIC_HINT_SPECULATIVE = 0x080000,
228e8d8bef9SDimitry Andric   KMP_IDENT_OPENMP_SPEC_VERSION_MASK = 0xFF000000
2290b57cec5SDimitry Andric };
2300b57cec5SDimitry Andric 
2310b57cec5SDimitry Andric /*!
2320b57cec5SDimitry Andric  * The ident structure that describes a source location.
2330b57cec5SDimitry Andric  */
2340b57cec5SDimitry Andric typedef struct ident {
2350b57cec5SDimitry Andric   kmp_int32 reserved_1; /**<  might be used in Fortran; see above  */
2360b57cec5SDimitry Andric   kmp_int32 flags; /**<  also f.flags; KMP_IDENT_xxx flags; KMP_IDENT_KMPC
2370b57cec5SDimitry Andric                       identifies this union member  */
2380b57cec5SDimitry Andric   kmp_int32 reserved_2; /**<  not really used in Fortran any more; see above */
2390b57cec5SDimitry Andric #if USE_ITT_BUILD
2400b57cec5SDimitry Andric /*  but currently used for storing region-specific ITT */
2410b57cec5SDimitry Andric /*  contextual information. */
2420b57cec5SDimitry Andric #endif /* USE_ITT_BUILD */
2430b57cec5SDimitry Andric   kmp_int32 reserved_3; /**< source[4] in Fortran, do not use for C++  */
2440b57cec5SDimitry Andric   char const *psource; /**< String describing the source location.
2450b57cec5SDimitry Andric                        The string is composed of semi-colon separated fields
2460b57cec5SDimitry Andric                        which describe the source file, the function and a pair
2470b57cec5SDimitry Andric                        of line numbers that delimit the construct. */
248e8d8bef9SDimitry Andric   // Returns the OpenMP version in form major*10+minor (e.g., 50 for 5.0)
249e8d8bef9SDimitry Andric   kmp_int32 get_openmp_version() {
250e8d8bef9SDimitry Andric     return (((flags & KMP_IDENT_OPENMP_SPEC_VERSION_MASK) >> 24) & 0xFF);
251e8d8bef9SDimitry Andric   }
2520b57cec5SDimitry Andric } ident_t;
2530b57cec5SDimitry Andric /*!
2540b57cec5SDimitry Andric @}
2550b57cec5SDimitry Andric */
2560b57cec5SDimitry Andric 
2570b57cec5SDimitry Andric // Some forward declarations.
2580b57cec5SDimitry Andric typedef union kmp_team kmp_team_t;
2590b57cec5SDimitry Andric typedef struct kmp_taskdata kmp_taskdata_t;
2600b57cec5SDimitry Andric typedef union kmp_task_team kmp_task_team_t;
2610b57cec5SDimitry Andric typedef union kmp_team kmp_team_p;
2620b57cec5SDimitry Andric typedef union kmp_info kmp_info_p;
2630b57cec5SDimitry Andric typedef union kmp_root kmp_root_p;
2640b57cec5SDimitry Andric 
265e8d8bef9SDimitry Andric template <bool C = false, bool S = true> class kmp_flag_32;
266e8d8bef9SDimitry Andric template <bool C = false, bool S = true> class kmp_flag_64;
267349cc55cSDimitry Andric template <bool C = false, bool S = true> class kmp_atomic_flag_64;
268e8d8bef9SDimitry Andric class kmp_flag_oncore;
269e8d8bef9SDimitry Andric 
2700b57cec5SDimitry Andric #ifdef __cplusplus
2710b57cec5SDimitry Andric extern "C" {
2720b57cec5SDimitry Andric #endif
2730b57cec5SDimitry Andric 
2740b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
2750b57cec5SDimitry Andric 
2760b57cec5SDimitry Andric /* Pack two 32-bit signed integers into a 64-bit signed integer */
2770b57cec5SDimitry Andric /* ToDo: Fix word ordering for big-endian machines. */
2780b57cec5SDimitry Andric #define KMP_PACK_64(HIGH_32, LOW_32)                                           \
2790b57cec5SDimitry Andric   ((kmp_int64)((((kmp_uint64)(HIGH_32)) << 32) | (kmp_uint64)(LOW_32)))
2800b57cec5SDimitry Andric 
2810b57cec5SDimitry Andric // Generic string manipulation macros. Assume that _x is of type char *
2820b57cec5SDimitry Andric #define SKIP_WS(_x)                                                            \
2830b57cec5SDimitry Andric   {                                                                            \
2840b57cec5SDimitry Andric     while (*(_x) == ' ' || *(_x) == '\t')                                      \
2850b57cec5SDimitry Andric       (_x)++;                                                                  \
2860b57cec5SDimitry Andric   }
2870b57cec5SDimitry Andric #define SKIP_DIGITS(_x)                                                        \
2880b57cec5SDimitry Andric   {                                                                            \
2890b57cec5SDimitry Andric     while (*(_x) >= '0' && *(_x) <= '9')                                       \
2900b57cec5SDimitry Andric       (_x)++;                                                                  \
2910b57cec5SDimitry Andric   }
2920b57cec5SDimitry Andric #define SKIP_TOKEN(_x)                                                         \
2930b57cec5SDimitry Andric   {                                                                            \
2940b57cec5SDimitry Andric     while ((*(_x) >= '0' && *(_x) <= '9') || (*(_x) >= 'a' && *(_x) <= 'z') || \
2950b57cec5SDimitry Andric            (*(_x) >= 'A' && *(_x) <= 'Z') || *(_x) == '_')                     \
2960b57cec5SDimitry Andric       (_x)++;                                                                  \
2970b57cec5SDimitry Andric   }
2980b57cec5SDimitry Andric #define SKIP_TO(_x, _c)                                                        \
2990b57cec5SDimitry Andric   {                                                                            \
3000b57cec5SDimitry Andric     while (*(_x) != '\0' && *(_x) != (_c))                                     \
3010b57cec5SDimitry Andric       (_x)++;                                                                  \
3020b57cec5SDimitry Andric   }
3030b57cec5SDimitry Andric 
3040b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
3050b57cec5SDimitry Andric 
3060b57cec5SDimitry Andric #define KMP_MAX(x, y) ((x) > (y) ? (x) : (y))
3070b57cec5SDimitry Andric #define KMP_MIN(x, y) ((x) < (y) ? (x) : (y))
3080b57cec5SDimitry Andric 
3090b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
3100b57cec5SDimitry Andric /* Enumeration types */
3110b57cec5SDimitry Andric 
3120b57cec5SDimitry Andric enum kmp_state_timer {
3130b57cec5SDimitry Andric   ts_stop,
3140b57cec5SDimitry Andric   ts_start,
3150b57cec5SDimitry Andric   ts_pause,
3160b57cec5SDimitry Andric 
3170b57cec5SDimitry Andric   ts_last_state
3180b57cec5SDimitry Andric };
3190b57cec5SDimitry Andric 
3200b57cec5SDimitry Andric enum dynamic_mode {
3210b57cec5SDimitry Andric   dynamic_default,
3220b57cec5SDimitry Andric #ifdef USE_LOAD_BALANCE
3230b57cec5SDimitry Andric   dynamic_load_balance,
3240b57cec5SDimitry Andric #endif /* USE_LOAD_BALANCE */
3250b57cec5SDimitry Andric   dynamic_random,
3260b57cec5SDimitry Andric   dynamic_thread_limit,
3270b57cec5SDimitry Andric   dynamic_max
3280b57cec5SDimitry Andric };
3290b57cec5SDimitry Andric 
3300b57cec5SDimitry Andric /* external schedule constants, duplicate enum omp_sched in omp.h in order to
3310b57cec5SDimitry Andric  * not include it here */
3320b57cec5SDimitry Andric #ifndef KMP_SCHED_TYPE_DEFINED
3330b57cec5SDimitry Andric #define KMP_SCHED_TYPE_DEFINED
3340b57cec5SDimitry Andric typedef enum kmp_sched {
3350b57cec5SDimitry Andric   kmp_sched_lower = 0, // lower and upper bounds are for routine parameter check
3360b57cec5SDimitry Andric   // Note: need to adjust __kmp_sch_map global array in case enum is changed
3370b57cec5SDimitry Andric   kmp_sched_static = 1, // mapped to kmp_sch_static_chunked           (33)
3380b57cec5SDimitry Andric   kmp_sched_dynamic = 2, // mapped to kmp_sch_dynamic_chunked          (35)
3390b57cec5SDimitry Andric   kmp_sched_guided = 3, // mapped to kmp_sch_guided_chunked           (36)
3400b57cec5SDimitry Andric   kmp_sched_auto = 4, // mapped to kmp_sch_auto                     (38)
3410b57cec5SDimitry Andric   kmp_sched_upper_std = 5, // upper bound for standard schedules
3420b57cec5SDimitry Andric   kmp_sched_lower_ext = 100, // lower bound of Intel extension schedules
3430b57cec5SDimitry Andric   kmp_sched_trapezoidal = 101, // mapped to kmp_sch_trapezoidal (39)
3440b57cec5SDimitry Andric #if KMP_STATIC_STEAL_ENABLED
3450b57cec5SDimitry Andric   kmp_sched_static_steal = 102, // mapped to kmp_sch_static_steal (44)
3460b57cec5SDimitry Andric #endif
3470b57cec5SDimitry Andric   kmp_sched_upper,
3480b57cec5SDimitry Andric   kmp_sched_default = kmp_sched_static, // default scheduling
3490b57cec5SDimitry Andric   kmp_sched_monotonic = 0x80000000
3500b57cec5SDimitry Andric } kmp_sched_t;
3510b57cec5SDimitry Andric #endif
3520b57cec5SDimitry Andric 
3530b57cec5SDimitry Andric /*!
3540b57cec5SDimitry Andric  @ingroup WORK_SHARING
3550b57cec5SDimitry Andric  * Describes the loop schedule to be used for a parallel for loop.
3560b57cec5SDimitry Andric  */
3570b57cec5SDimitry Andric enum sched_type : kmp_int32 {
3580b57cec5SDimitry Andric   kmp_sch_lower = 32, /**< lower bound for unordered values */
3590b57cec5SDimitry Andric   kmp_sch_static_chunked = 33,
3600b57cec5SDimitry Andric   kmp_sch_static = 34, /**< static unspecialized */
3610b57cec5SDimitry Andric   kmp_sch_dynamic_chunked = 35,
3620b57cec5SDimitry Andric   kmp_sch_guided_chunked = 36, /**< guided unspecialized */
3630b57cec5SDimitry Andric   kmp_sch_runtime = 37,
3640b57cec5SDimitry Andric   kmp_sch_auto = 38, /**< auto */
3650b57cec5SDimitry Andric   kmp_sch_trapezoidal = 39,
3660b57cec5SDimitry Andric 
3670b57cec5SDimitry Andric   /* accessible only through KMP_SCHEDULE environment variable */
3680b57cec5SDimitry Andric   kmp_sch_static_greedy = 40,
3690b57cec5SDimitry Andric   kmp_sch_static_balanced = 41,
3700b57cec5SDimitry Andric   /* accessible only through KMP_SCHEDULE environment variable */
3710b57cec5SDimitry Andric   kmp_sch_guided_iterative_chunked = 42,
3720b57cec5SDimitry Andric   kmp_sch_guided_analytical_chunked = 43,
3730b57cec5SDimitry Andric   /* accessible only through KMP_SCHEDULE environment variable */
3740b57cec5SDimitry Andric   kmp_sch_static_steal = 44,
3750b57cec5SDimitry Andric 
3760b57cec5SDimitry Andric   /* static with chunk adjustment (e.g., simd) */
3770b57cec5SDimitry Andric   kmp_sch_static_balanced_chunked = 45,
3780b57cec5SDimitry Andric   kmp_sch_guided_simd = 46, /**< guided with chunk adjustment */
3790b57cec5SDimitry Andric   kmp_sch_runtime_simd = 47, /**< runtime with chunk adjustment */
3800b57cec5SDimitry Andric 
3810b57cec5SDimitry Andric   /* accessible only through KMP_SCHEDULE environment variable */
3820b57cec5SDimitry Andric   kmp_sch_upper, /**< upper bound for unordered values */
3830b57cec5SDimitry Andric 
3840b57cec5SDimitry Andric   kmp_ord_lower = 64, /**< lower bound for ordered values, must be power of 2 */
3850b57cec5SDimitry Andric   kmp_ord_static_chunked = 65,
3860b57cec5SDimitry Andric   kmp_ord_static = 66, /**< ordered static unspecialized */
3870b57cec5SDimitry Andric   kmp_ord_dynamic_chunked = 67,
3880b57cec5SDimitry Andric   kmp_ord_guided_chunked = 68,
3890b57cec5SDimitry Andric   kmp_ord_runtime = 69,
3900b57cec5SDimitry Andric   kmp_ord_auto = 70, /**< ordered auto */
3910b57cec5SDimitry Andric   kmp_ord_trapezoidal = 71,
3920b57cec5SDimitry Andric   kmp_ord_upper, /**< upper bound for ordered values */
3930b57cec5SDimitry Andric 
3940b57cec5SDimitry Andric   /* Schedules for Distribute construct */
3950b57cec5SDimitry Andric   kmp_distribute_static_chunked = 91, /**< distribute static chunked */
3960b57cec5SDimitry Andric   kmp_distribute_static = 92, /**< distribute static unspecialized */
3970b57cec5SDimitry Andric 
3980b57cec5SDimitry Andric   /* For the "nomerge" versions, kmp_dispatch_next*() will always return a
3990b57cec5SDimitry Andric      single iteration/chunk, even if the loop is serialized. For the schedule
4000b57cec5SDimitry Andric      types listed above, the entire iteration vector is returned if the loop is
4010b57cec5SDimitry Andric      serialized. This doesn't work for gcc/gcomp sections. */
4020b57cec5SDimitry Andric   kmp_nm_lower = 160, /**< lower bound for nomerge values */
4030b57cec5SDimitry Andric 
4040b57cec5SDimitry Andric   kmp_nm_static_chunked =
4050b57cec5SDimitry Andric       (kmp_sch_static_chunked - kmp_sch_lower + kmp_nm_lower),
4060b57cec5SDimitry Andric   kmp_nm_static = 162, /**< static unspecialized */
4070b57cec5SDimitry Andric   kmp_nm_dynamic_chunked = 163,
4080b57cec5SDimitry Andric   kmp_nm_guided_chunked = 164, /**< guided unspecialized */
4090b57cec5SDimitry Andric   kmp_nm_runtime = 165,
4100b57cec5SDimitry Andric   kmp_nm_auto = 166, /**< auto */
4110b57cec5SDimitry Andric   kmp_nm_trapezoidal = 167,
4120b57cec5SDimitry Andric 
4130b57cec5SDimitry Andric   /* accessible only through KMP_SCHEDULE environment variable */
4140b57cec5SDimitry Andric   kmp_nm_static_greedy = 168,
4150b57cec5SDimitry Andric   kmp_nm_static_balanced = 169,
4160b57cec5SDimitry Andric   /* accessible only through KMP_SCHEDULE environment variable */
4170b57cec5SDimitry Andric   kmp_nm_guided_iterative_chunked = 170,
4180b57cec5SDimitry Andric   kmp_nm_guided_analytical_chunked = 171,
4190b57cec5SDimitry Andric   kmp_nm_static_steal =
4200b57cec5SDimitry Andric       172, /* accessible only through OMP_SCHEDULE environment variable */
4210b57cec5SDimitry Andric 
4220b57cec5SDimitry Andric   kmp_nm_ord_static_chunked = 193,
4230b57cec5SDimitry Andric   kmp_nm_ord_static = 194, /**< ordered static unspecialized */
4240b57cec5SDimitry Andric   kmp_nm_ord_dynamic_chunked = 195,
4250b57cec5SDimitry Andric   kmp_nm_ord_guided_chunked = 196,
4260b57cec5SDimitry Andric   kmp_nm_ord_runtime = 197,
4270b57cec5SDimitry Andric   kmp_nm_ord_auto = 198, /**< auto */
4280b57cec5SDimitry Andric   kmp_nm_ord_trapezoidal = 199,
4290b57cec5SDimitry Andric   kmp_nm_upper, /**< upper bound for nomerge values */
4300b57cec5SDimitry Andric 
4310b57cec5SDimitry Andric   /* Support for OpenMP 4.5 monotonic and nonmonotonic schedule modifiers. Since
4320b57cec5SDimitry Andric      we need to distinguish the three possible cases (no modifier, monotonic
4330b57cec5SDimitry Andric      modifier, nonmonotonic modifier), we need separate bits for each modifier.
4340b57cec5SDimitry Andric      The absence of monotonic does not imply nonmonotonic, especially since 4.5
4350b57cec5SDimitry Andric      says that the behaviour of the "no modifier" case is implementation defined
4360b57cec5SDimitry Andric      in 4.5, but will become "nonmonotonic" in 5.0.
4370b57cec5SDimitry Andric 
4380b57cec5SDimitry Andric      Since we're passing a full 32 bit value, we can use a couple of high bits
4390b57cec5SDimitry Andric      for these flags; out of paranoia we avoid the sign bit.
4400b57cec5SDimitry Andric 
4410b57cec5SDimitry Andric      These modifiers can be or-ed into non-static schedules by the compiler to
4420b57cec5SDimitry Andric      pass the additional information. They will be stripped early in the
4430b57cec5SDimitry Andric      processing in __kmp_dispatch_init when setting up schedules, so most of the
4440b57cec5SDimitry Andric      code won't ever see schedules with these bits set.  */
4450b57cec5SDimitry Andric   kmp_sch_modifier_monotonic =
4460b57cec5SDimitry Andric       (1 << 29), /**< Set if the monotonic schedule modifier was present */
4470b57cec5SDimitry Andric   kmp_sch_modifier_nonmonotonic =
4480b57cec5SDimitry Andric       (1 << 30), /**< Set if the nonmonotonic schedule modifier was present */
4490b57cec5SDimitry Andric 
4500b57cec5SDimitry Andric #define SCHEDULE_WITHOUT_MODIFIERS(s)                                          \
4510b57cec5SDimitry Andric   (enum sched_type)(                                                           \
4520b57cec5SDimitry Andric       (s) & ~(kmp_sch_modifier_nonmonotonic | kmp_sch_modifier_monotonic))
4530b57cec5SDimitry Andric #define SCHEDULE_HAS_MONOTONIC(s) (((s)&kmp_sch_modifier_monotonic) != 0)
4540b57cec5SDimitry Andric #define SCHEDULE_HAS_NONMONOTONIC(s) (((s)&kmp_sch_modifier_nonmonotonic) != 0)
4550b57cec5SDimitry Andric #define SCHEDULE_HAS_NO_MODIFIERS(s)                                           \
4560b57cec5SDimitry Andric   (((s) & (kmp_sch_modifier_nonmonotonic | kmp_sch_modifier_monotonic)) == 0)
4570b57cec5SDimitry Andric #define SCHEDULE_GET_MODIFIERS(s)                                              \
4580b57cec5SDimitry Andric   ((enum sched_type)(                                                          \
4590b57cec5SDimitry Andric       (s) & (kmp_sch_modifier_nonmonotonic | kmp_sch_modifier_monotonic)))
4600b57cec5SDimitry Andric #define SCHEDULE_SET_MODIFIERS(s, m)                                           \
4610b57cec5SDimitry Andric   (s = (enum sched_type)((kmp_int32)s | (kmp_int32)m))
4620b57cec5SDimitry Andric #define SCHEDULE_NONMONOTONIC 0
4630b57cec5SDimitry Andric #define SCHEDULE_MONOTONIC 1
4640b57cec5SDimitry Andric 
4650b57cec5SDimitry Andric   kmp_sch_default = kmp_sch_static /**< default scheduling algorithm */
4660b57cec5SDimitry Andric };
4670b57cec5SDimitry Andric 
4680b57cec5SDimitry Andric // Apply modifiers on internal kind to standard kind
4690b57cec5SDimitry Andric static inline void
4700b57cec5SDimitry Andric __kmp_sched_apply_mods_stdkind(kmp_sched_t *kind,
4710b57cec5SDimitry Andric                                enum sched_type internal_kind) {
4720b57cec5SDimitry Andric   if (SCHEDULE_HAS_MONOTONIC(internal_kind)) {
4730b57cec5SDimitry Andric     *kind = (kmp_sched_t)((int)*kind | (int)kmp_sched_monotonic);
4740b57cec5SDimitry Andric   }
4750b57cec5SDimitry Andric }
4760b57cec5SDimitry Andric 
4770b57cec5SDimitry Andric // Apply modifiers on standard kind to internal kind
4780b57cec5SDimitry Andric static inline void
4790b57cec5SDimitry Andric __kmp_sched_apply_mods_intkind(kmp_sched_t kind,
4800b57cec5SDimitry Andric                                enum sched_type *internal_kind) {
4810b57cec5SDimitry Andric   if ((int)kind & (int)kmp_sched_monotonic) {
4820b57cec5SDimitry Andric     *internal_kind = (enum sched_type)((int)*internal_kind |
4830b57cec5SDimitry Andric                                        (int)kmp_sch_modifier_monotonic);
4840b57cec5SDimitry Andric   }
4850b57cec5SDimitry Andric }
4860b57cec5SDimitry Andric 
4870b57cec5SDimitry Andric // Get standard schedule without modifiers
4880b57cec5SDimitry Andric static inline kmp_sched_t __kmp_sched_without_mods(kmp_sched_t kind) {
4890b57cec5SDimitry Andric   return (kmp_sched_t)((int)kind & ~((int)kmp_sched_monotonic));
4900b57cec5SDimitry Andric }
4910b57cec5SDimitry Andric 
4920b57cec5SDimitry Andric /* Type to keep runtime schedule set via OMP_SCHEDULE or omp_set_schedule() */
4930b57cec5SDimitry Andric typedef union kmp_r_sched {
4940b57cec5SDimitry Andric   struct {
4950b57cec5SDimitry Andric     enum sched_type r_sched_type;
4960b57cec5SDimitry Andric     int chunk;
4970b57cec5SDimitry Andric   };
4980b57cec5SDimitry Andric   kmp_int64 sched;
4990b57cec5SDimitry Andric } kmp_r_sched_t;
5000b57cec5SDimitry Andric 
5010b57cec5SDimitry Andric extern enum sched_type __kmp_sch_map[]; // map OMP 3.0 schedule types with our
5020b57cec5SDimitry Andric // internal schedule types
5030b57cec5SDimitry Andric 
5040b57cec5SDimitry Andric enum library_type {
5050b57cec5SDimitry Andric   library_none,
5060b57cec5SDimitry Andric   library_serial,
5070b57cec5SDimitry Andric   library_turnaround,
5080b57cec5SDimitry Andric   library_throughput
5090b57cec5SDimitry Andric };
5100b57cec5SDimitry Andric 
5110b57cec5SDimitry Andric #if KMP_OS_LINUX
5120b57cec5SDimitry Andric enum clock_function_type {
5130b57cec5SDimitry Andric   clock_function_gettimeofday,
5140b57cec5SDimitry Andric   clock_function_clock_gettime
5150b57cec5SDimitry Andric };
5160b57cec5SDimitry Andric #endif /* KMP_OS_LINUX */
5170b57cec5SDimitry Andric 
5180b57cec5SDimitry Andric #if KMP_MIC_SUPPORTED
5190b57cec5SDimitry Andric enum mic_type { non_mic, mic1, mic2, mic3, dummy };
5200b57cec5SDimitry Andric #endif
5210b57cec5SDimitry Andric 
5220b57cec5SDimitry Andric /* -- fast reduction stuff ------------------------------------------------ */
5230b57cec5SDimitry Andric 
5240b57cec5SDimitry Andric #undef KMP_FAST_REDUCTION_BARRIER
5250b57cec5SDimitry Andric #define KMP_FAST_REDUCTION_BARRIER 1
5260b57cec5SDimitry Andric 
5270b57cec5SDimitry Andric #undef KMP_FAST_REDUCTION_CORE_DUO
5280b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
5290b57cec5SDimitry Andric #define KMP_FAST_REDUCTION_CORE_DUO 1
5300b57cec5SDimitry Andric #endif
5310b57cec5SDimitry Andric 
5320b57cec5SDimitry Andric enum _reduction_method {
5330b57cec5SDimitry Andric   reduction_method_not_defined = 0,
5340b57cec5SDimitry Andric   critical_reduce_block = (1 << 8),
5350b57cec5SDimitry Andric   atomic_reduce_block = (2 << 8),
5360b57cec5SDimitry Andric   tree_reduce_block = (3 << 8),
5370b57cec5SDimitry Andric   empty_reduce_block = (4 << 8)
5380b57cec5SDimitry Andric };
5390b57cec5SDimitry Andric 
5400b57cec5SDimitry Andric // Description of the packed_reduction_method variable:
5410b57cec5SDimitry Andric // The packed_reduction_method variable consists of two enum types variables
5420b57cec5SDimitry Andric // that are packed together into 0-th byte and 1-st byte:
5430b57cec5SDimitry Andric // 0: (packed_reduction_method & 0x000000FF) is a 'enum barrier_type' value of
5440b57cec5SDimitry Andric // barrier that will be used in fast reduction: bs_plain_barrier or
5450b57cec5SDimitry Andric // bs_reduction_barrier
5460b57cec5SDimitry Andric // 1: (packed_reduction_method & 0x0000FF00) is a reduction method that will
5470b57cec5SDimitry Andric // be used in fast reduction;
5480b57cec5SDimitry Andric // Reduction method is of 'enum _reduction_method' type and it's defined the way
5490b57cec5SDimitry Andric // so that the bits of 0-th byte are empty, so no need to execute a shift
5500b57cec5SDimitry Andric // instruction while packing/unpacking
5510b57cec5SDimitry Andric 
5520b57cec5SDimitry Andric #if KMP_FAST_REDUCTION_BARRIER
5530b57cec5SDimitry Andric #define PACK_REDUCTION_METHOD_AND_BARRIER(reduction_method, barrier_type)      \
5540b57cec5SDimitry Andric   ((reduction_method) | (barrier_type))
5550b57cec5SDimitry Andric 
5560b57cec5SDimitry Andric #define UNPACK_REDUCTION_METHOD(packed_reduction_method)                       \
5570b57cec5SDimitry Andric   ((enum _reduction_method)((packed_reduction_method) & (0x0000FF00)))
5580b57cec5SDimitry Andric 
5590b57cec5SDimitry Andric #define UNPACK_REDUCTION_BARRIER(packed_reduction_method)                      \
5600b57cec5SDimitry Andric   ((enum barrier_type)((packed_reduction_method) & (0x000000FF)))
5610b57cec5SDimitry Andric #else
5620b57cec5SDimitry Andric #define PACK_REDUCTION_METHOD_AND_BARRIER(reduction_method, barrier_type)      \
5630b57cec5SDimitry Andric   (reduction_method)
5640b57cec5SDimitry Andric 
5650b57cec5SDimitry Andric #define UNPACK_REDUCTION_METHOD(packed_reduction_method)                       \
5660b57cec5SDimitry Andric   (packed_reduction_method)
5670b57cec5SDimitry Andric 
5680b57cec5SDimitry Andric #define UNPACK_REDUCTION_BARRIER(packed_reduction_method) (bs_plain_barrier)
5690b57cec5SDimitry Andric #endif
5700b57cec5SDimitry Andric 
5710b57cec5SDimitry Andric #define TEST_REDUCTION_METHOD(packed_reduction_method, which_reduction_block)  \
5720b57cec5SDimitry Andric   ((UNPACK_REDUCTION_METHOD(packed_reduction_method)) ==                       \
5730b57cec5SDimitry Andric    (which_reduction_block))
5740b57cec5SDimitry Andric 
5750b57cec5SDimitry Andric #if KMP_FAST_REDUCTION_BARRIER
5760b57cec5SDimitry Andric #define TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER                               \
5770b57cec5SDimitry Andric   (PACK_REDUCTION_METHOD_AND_BARRIER(tree_reduce_block, bs_reduction_barrier))
5780b57cec5SDimitry Andric 
5790b57cec5SDimitry Andric #define TREE_REDUCE_BLOCK_WITH_PLAIN_BARRIER                                   \
5800b57cec5SDimitry Andric   (PACK_REDUCTION_METHOD_AND_BARRIER(tree_reduce_block, bs_plain_barrier))
5810b57cec5SDimitry Andric #endif
5820b57cec5SDimitry Andric 
5830b57cec5SDimitry Andric typedef int PACKED_REDUCTION_METHOD_T;
5840b57cec5SDimitry Andric 
5850b57cec5SDimitry Andric /* -- end of fast reduction stuff ----------------------------------------- */
5860b57cec5SDimitry Andric 
5870b57cec5SDimitry Andric #if KMP_OS_WINDOWS
5880b57cec5SDimitry Andric #define USE_CBLKDATA
5890b57cec5SDimitry Andric #if KMP_MSVC_COMPAT
5900b57cec5SDimitry Andric #pragma warning(push)
5910b57cec5SDimitry Andric #pragma warning(disable : 271 310)
5920b57cec5SDimitry Andric #endif
5930b57cec5SDimitry Andric #include <windows.h>
5940b57cec5SDimitry Andric #if KMP_MSVC_COMPAT
5950b57cec5SDimitry Andric #pragma warning(pop)
5960b57cec5SDimitry Andric #endif
5970b57cec5SDimitry Andric #endif
5980b57cec5SDimitry Andric 
5990b57cec5SDimitry Andric #if KMP_OS_UNIX
6000b57cec5SDimitry Andric #include <dlfcn.h>
6010b57cec5SDimitry Andric #include <pthread.h>
6020b57cec5SDimitry Andric #endif
6030b57cec5SDimitry Andric 
604fe6060f1SDimitry Andric enum kmp_hw_t : int {
605fe6060f1SDimitry Andric   KMP_HW_UNKNOWN = -1,
606fe6060f1SDimitry Andric   KMP_HW_SOCKET = 0,
607fe6060f1SDimitry Andric   KMP_HW_PROC_GROUP,
608fe6060f1SDimitry Andric   KMP_HW_NUMA,
609fe6060f1SDimitry Andric   KMP_HW_DIE,
610fe6060f1SDimitry Andric   KMP_HW_LLC,
611fe6060f1SDimitry Andric   KMP_HW_L3,
612fe6060f1SDimitry Andric   KMP_HW_TILE,
613fe6060f1SDimitry Andric   KMP_HW_MODULE,
614fe6060f1SDimitry Andric   KMP_HW_L2,
615fe6060f1SDimitry Andric   KMP_HW_L1,
616fe6060f1SDimitry Andric   KMP_HW_CORE,
617fe6060f1SDimitry Andric   KMP_HW_THREAD,
618fe6060f1SDimitry Andric   KMP_HW_LAST
619fe6060f1SDimitry Andric };
620fe6060f1SDimitry Andric 
6210eae32dcSDimitry Andric typedef enum kmp_hw_core_type_t {
6220eae32dcSDimitry Andric   KMP_HW_CORE_TYPE_UNKNOWN = 0x0,
6230eae32dcSDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
6240eae32dcSDimitry Andric   KMP_HW_CORE_TYPE_ATOM = 0x20,
6250eae32dcSDimitry Andric   KMP_HW_CORE_TYPE_CORE = 0x40,
6260eae32dcSDimitry Andric   KMP_HW_MAX_NUM_CORE_TYPES = 3,
6270eae32dcSDimitry Andric #else
6280eae32dcSDimitry Andric   KMP_HW_MAX_NUM_CORE_TYPES = 1,
6290eae32dcSDimitry Andric #endif
6300eae32dcSDimitry Andric } kmp_hw_core_type_t;
6310eae32dcSDimitry Andric 
6320eae32dcSDimitry Andric #define KMP_HW_MAX_NUM_CORE_EFFS 8
6330eae32dcSDimitry Andric 
634fe6060f1SDimitry Andric #define KMP_DEBUG_ASSERT_VALID_HW_TYPE(type)                                   \
635fe6060f1SDimitry Andric   KMP_DEBUG_ASSERT(type >= (kmp_hw_t)0 && type < KMP_HW_LAST)
636fe6060f1SDimitry Andric #define KMP_ASSERT_VALID_HW_TYPE(type)                                         \
637fe6060f1SDimitry Andric   KMP_ASSERT(type >= (kmp_hw_t)0 && type < KMP_HW_LAST)
638fe6060f1SDimitry Andric 
639fe6060f1SDimitry Andric #define KMP_FOREACH_HW_TYPE(type)                                              \
640fe6060f1SDimitry Andric   for (kmp_hw_t type = (kmp_hw_t)0; type < KMP_HW_LAST;                        \
641fe6060f1SDimitry Andric        type = (kmp_hw_t)((int)type + 1))
642fe6060f1SDimitry Andric 
643fe6060f1SDimitry Andric const char *__kmp_hw_get_keyword(kmp_hw_t type, bool plural = false);
644fe6060f1SDimitry Andric const char *__kmp_hw_get_catalog_string(kmp_hw_t type, bool plural = false);
6450eae32dcSDimitry Andric const char *__kmp_hw_get_core_type_string(kmp_hw_core_type_t type);
646fe6060f1SDimitry Andric 
6470b57cec5SDimitry Andric /* Only Linux* OS and Windows* OS support thread affinity. */
6480b57cec5SDimitry Andric #if KMP_AFFINITY_SUPPORTED
6490b57cec5SDimitry Andric 
6500b57cec5SDimitry Andric // GROUP_AFFINITY is already defined for _MSC_VER>=1600 (VS2010 and later).
6510b57cec5SDimitry Andric #if KMP_OS_WINDOWS
6520b57cec5SDimitry Andric #if _MSC_VER < 1600 && KMP_MSVC_COMPAT
6530b57cec5SDimitry Andric typedef struct GROUP_AFFINITY {
6540b57cec5SDimitry Andric   KAFFINITY Mask;
6550b57cec5SDimitry Andric   WORD Group;
6560b57cec5SDimitry Andric   WORD Reserved[3];
6570b57cec5SDimitry Andric } GROUP_AFFINITY;
6580b57cec5SDimitry Andric #endif /* _MSC_VER < 1600 */
6590b57cec5SDimitry Andric #if KMP_GROUP_AFFINITY
6600b57cec5SDimitry Andric extern int __kmp_num_proc_groups;
6610b57cec5SDimitry Andric #else
6620b57cec5SDimitry Andric static const int __kmp_num_proc_groups = 1;
6630b57cec5SDimitry Andric #endif /* KMP_GROUP_AFFINITY */
6640b57cec5SDimitry Andric typedef DWORD (*kmp_GetActiveProcessorCount_t)(WORD);
6650b57cec5SDimitry Andric extern kmp_GetActiveProcessorCount_t __kmp_GetActiveProcessorCount;
6660b57cec5SDimitry Andric 
6670b57cec5SDimitry Andric typedef WORD (*kmp_GetActiveProcessorGroupCount_t)(void);
6680b57cec5SDimitry Andric extern kmp_GetActiveProcessorGroupCount_t __kmp_GetActiveProcessorGroupCount;
6690b57cec5SDimitry Andric 
6700b57cec5SDimitry Andric typedef BOOL (*kmp_GetThreadGroupAffinity_t)(HANDLE, GROUP_AFFINITY *);
6710b57cec5SDimitry Andric extern kmp_GetThreadGroupAffinity_t __kmp_GetThreadGroupAffinity;
6720b57cec5SDimitry Andric 
6730b57cec5SDimitry Andric typedef BOOL (*kmp_SetThreadGroupAffinity_t)(HANDLE, const GROUP_AFFINITY *,
6740b57cec5SDimitry Andric                                              GROUP_AFFINITY *);
6750b57cec5SDimitry Andric extern kmp_SetThreadGroupAffinity_t __kmp_SetThreadGroupAffinity;
6760b57cec5SDimitry Andric #endif /* KMP_OS_WINDOWS */
6770b57cec5SDimitry Andric 
6780b57cec5SDimitry Andric #if KMP_USE_HWLOC
6790b57cec5SDimitry Andric extern hwloc_topology_t __kmp_hwloc_topology;
6800b57cec5SDimitry Andric extern int __kmp_hwloc_error;
6810b57cec5SDimitry Andric #endif
6820b57cec5SDimitry Andric 
6830b57cec5SDimitry Andric extern size_t __kmp_affin_mask_size;
6840b57cec5SDimitry Andric #define KMP_AFFINITY_CAPABLE() (__kmp_affin_mask_size > 0)
6850b57cec5SDimitry Andric #define KMP_AFFINITY_DISABLE() (__kmp_affin_mask_size = 0)
6860b57cec5SDimitry Andric #define KMP_AFFINITY_ENABLE(mask_size) (__kmp_affin_mask_size = mask_size)
6870b57cec5SDimitry Andric #define KMP_CPU_SET_ITERATE(i, mask)                                           \
6880b57cec5SDimitry Andric   for (i = (mask)->begin(); (int)i != (mask)->end(); i = (mask)->next(i))
6890b57cec5SDimitry Andric #define KMP_CPU_SET(i, mask) (mask)->set(i)
6900b57cec5SDimitry Andric #define KMP_CPU_ISSET(i, mask) (mask)->is_set(i)
6910b57cec5SDimitry Andric #define KMP_CPU_CLR(i, mask) (mask)->clear(i)
6920b57cec5SDimitry Andric #define KMP_CPU_ZERO(mask) (mask)->zero()
6930b57cec5SDimitry Andric #define KMP_CPU_COPY(dest, src) (dest)->copy(src)
6940b57cec5SDimitry Andric #define KMP_CPU_AND(dest, src) (dest)->bitwise_and(src)
6950b57cec5SDimitry Andric #define KMP_CPU_COMPLEMENT(max_bit_number, mask) (mask)->bitwise_not()
6960b57cec5SDimitry Andric #define KMP_CPU_UNION(dest, src) (dest)->bitwise_or(src)
6970b57cec5SDimitry Andric #define KMP_CPU_ALLOC(ptr) (ptr = __kmp_affinity_dispatch->allocate_mask())
6980b57cec5SDimitry Andric #define KMP_CPU_FREE(ptr) __kmp_affinity_dispatch->deallocate_mask(ptr)
6990b57cec5SDimitry Andric #define KMP_CPU_ALLOC_ON_STACK(ptr) KMP_CPU_ALLOC(ptr)
7000b57cec5SDimitry Andric #define KMP_CPU_FREE_FROM_STACK(ptr) KMP_CPU_FREE(ptr)
7010b57cec5SDimitry Andric #define KMP_CPU_INTERNAL_ALLOC(ptr) KMP_CPU_ALLOC(ptr)
7020b57cec5SDimitry Andric #define KMP_CPU_INTERNAL_FREE(ptr) KMP_CPU_FREE(ptr)
7030b57cec5SDimitry Andric #define KMP_CPU_INDEX(arr, i) __kmp_affinity_dispatch->index_mask_array(arr, i)
7040b57cec5SDimitry Andric #define KMP_CPU_ALLOC_ARRAY(arr, n)                                            \
7050b57cec5SDimitry Andric   (arr = __kmp_affinity_dispatch->allocate_mask_array(n))
7060b57cec5SDimitry Andric #define KMP_CPU_FREE_ARRAY(arr, n)                                             \
7070b57cec5SDimitry Andric   __kmp_affinity_dispatch->deallocate_mask_array(arr)
7080b57cec5SDimitry Andric #define KMP_CPU_INTERNAL_ALLOC_ARRAY(arr, n) KMP_CPU_ALLOC_ARRAY(arr, n)
7090b57cec5SDimitry Andric #define KMP_CPU_INTERNAL_FREE_ARRAY(arr, n) KMP_CPU_FREE_ARRAY(arr, n)
7100b57cec5SDimitry Andric #define __kmp_get_system_affinity(mask, abort_bool)                            \
7110b57cec5SDimitry Andric   (mask)->get_system_affinity(abort_bool)
7120b57cec5SDimitry Andric #define __kmp_set_system_affinity(mask, abort_bool)                            \
7130b57cec5SDimitry Andric   (mask)->set_system_affinity(abort_bool)
7140b57cec5SDimitry Andric #define __kmp_get_proc_group(mask) (mask)->get_proc_group()
7150b57cec5SDimitry Andric 
7160b57cec5SDimitry Andric class KMPAffinity {
7170b57cec5SDimitry Andric public:
7180b57cec5SDimitry Andric   class Mask {
7190b57cec5SDimitry Andric   public:
7200b57cec5SDimitry Andric     void *operator new(size_t n);
7210b57cec5SDimitry Andric     void operator delete(void *p);
7220b57cec5SDimitry Andric     void *operator new[](size_t n);
7230b57cec5SDimitry Andric     void operator delete[](void *p);
7240b57cec5SDimitry Andric     virtual ~Mask() {}
7250b57cec5SDimitry Andric     // Set bit i to 1
7260b57cec5SDimitry Andric     virtual void set(int i) {}
7270b57cec5SDimitry Andric     // Return bit i
7280b57cec5SDimitry Andric     virtual bool is_set(int i) const { return false; }
7290b57cec5SDimitry Andric     // Set bit i to 0
7300b57cec5SDimitry Andric     virtual void clear(int i) {}
7310b57cec5SDimitry Andric     // Zero out entire mask
7320b57cec5SDimitry Andric     virtual void zero() {}
7330b57cec5SDimitry Andric     // Copy src into this mask
7340b57cec5SDimitry Andric     virtual void copy(const Mask *src) {}
7350b57cec5SDimitry Andric     // this &= rhs
7360b57cec5SDimitry Andric     virtual void bitwise_and(const Mask *rhs) {}
7370b57cec5SDimitry Andric     // this |= rhs
7380b57cec5SDimitry Andric     virtual void bitwise_or(const Mask *rhs) {}
7390b57cec5SDimitry Andric     // this = ~this
7400b57cec5SDimitry Andric     virtual void bitwise_not() {}
7410b57cec5SDimitry Andric     // API for iterating over an affinity mask
7420b57cec5SDimitry Andric     // for (int i = mask->begin(); i != mask->end(); i = mask->next(i))
7430b57cec5SDimitry Andric     virtual int begin() const { return 0; }
7440b57cec5SDimitry Andric     virtual int end() const { return 0; }
7450b57cec5SDimitry Andric     virtual int next(int previous) const { return 0; }
746e8d8bef9SDimitry Andric #if KMP_OS_WINDOWS
747e8d8bef9SDimitry Andric     virtual int set_process_affinity(bool abort_on_error) const { return -1; }
748e8d8bef9SDimitry Andric #endif
7490b57cec5SDimitry Andric     // Set the system's affinity to this affinity mask's value
7500b57cec5SDimitry Andric     virtual int set_system_affinity(bool abort_on_error) const { return -1; }
7510b57cec5SDimitry Andric     // Set this affinity mask to the current system affinity
7520b57cec5SDimitry Andric     virtual int get_system_affinity(bool abort_on_error) { return -1; }
7530b57cec5SDimitry Andric     // Only 1 DWORD in the mask should have any procs set.
7540b57cec5SDimitry Andric     // Return the appropriate index, or -1 for an invalid mask.
7550b57cec5SDimitry Andric     virtual int get_proc_group() const { return -1; }
7560b57cec5SDimitry Andric   };
7570b57cec5SDimitry Andric   void *operator new(size_t n);
7580b57cec5SDimitry Andric   void operator delete(void *p);
7590b57cec5SDimitry Andric   // Need virtual destructor
7600b57cec5SDimitry Andric   virtual ~KMPAffinity() = default;
7610b57cec5SDimitry Andric   // Determine if affinity is capable
7620b57cec5SDimitry Andric   virtual void determine_capable(const char *env_var) {}
7630b57cec5SDimitry Andric   // Bind the current thread to os proc
7640b57cec5SDimitry Andric   virtual void bind_thread(int proc) {}
7650b57cec5SDimitry Andric   // Factory functions to allocate/deallocate a mask
7660b57cec5SDimitry Andric   virtual Mask *allocate_mask() { return nullptr; }
7670b57cec5SDimitry Andric   virtual void deallocate_mask(Mask *m) {}
7680b57cec5SDimitry Andric   virtual Mask *allocate_mask_array(int num) { return nullptr; }
7690b57cec5SDimitry Andric   virtual void deallocate_mask_array(Mask *m) {}
7700b57cec5SDimitry Andric   virtual Mask *index_mask_array(Mask *m, int index) { return nullptr; }
7710b57cec5SDimitry Andric   static void pick_api();
7720b57cec5SDimitry Andric   static void destroy_api();
7730b57cec5SDimitry Andric   enum api_type {
7740b57cec5SDimitry Andric     NATIVE_OS
7750b57cec5SDimitry Andric #if KMP_USE_HWLOC
7760b57cec5SDimitry Andric     ,
7770b57cec5SDimitry Andric     HWLOC
7780b57cec5SDimitry Andric #endif
7790b57cec5SDimitry Andric   };
7800b57cec5SDimitry Andric   virtual api_type get_api_type() const {
7810b57cec5SDimitry Andric     KMP_ASSERT(0);
7820b57cec5SDimitry Andric     return NATIVE_OS;
7830b57cec5SDimitry Andric   }
7840b57cec5SDimitry Andric 
7850b57cec5SDimitry Andric private:
7860b57cec5SDimitry Andric   static bool picked_api;
7870b57cec5SDimitry Andric };
7880b57cec5SDimitry Andric 
7890b57cec5SDimitry Andric typedef KMPAffinity::Mask kmp_affin_mask_t;
7900b57cec5SDimitry Andric extern KMPAffinity *__kmp_affinity_dispatch;
7910b57cec5SDimitry Andric 
7920b57cec5SDimitry Andric // Declare local char buffers with this size for printing debug and info
7930b57cec5SDimitry Andric // messages, using __kmp_affinity_print_mask().
7940b57cec5SDimitry Andric #define KMP_AFFIN_MASK_PRINT_LEN 1024
7950b57cec5SDimitry Andric 
7960b57cec5SDimitry Andric enum affinity_type {
7970b57cec5SDimitry Andric   affinity_none = 0,
7980b57cec5SDimitry Andric   affinity_physical,
7990b57cec5SDimitry Andric   affinity_logical,
8000b57cec5SDimitry Andric   affinity_compact,
8010b57cec5SDimitry Andric   affinity_scatter,
8020b57cec5SDimitry Andric   affinity_explicit,
8030b57cec5SDimitry Andric   affinity_balanced,
8040b57cec5SDimitry Andric   affinity_disabled, // not used outsize the env var parser
8050b57cec5SDimitry Andric   affinity_default
8060b57cec5SDimitry Andric };
8070b57cec5SDimitry Andric 
8080b57cec5SDimitry Andric enum affinity_top_method {
8090b57cec5SDimitry Andric   affinity_top_method_all = 0, // try all (supported) methods, in order
8100b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
8110b57cec5SDimitry Andric   affinity_top_method_apicid,
8120b57cec5SDimitry Andric   affinity_top_method_x2apicid,
813fe6060f1SDimitry Andric   affinity_top_method_x2apicid_1f,
8140b57cec5SDimitry Andric #endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
8150b57cec5SDimitry Andric   affinity_top_method_cpuinfo, // KMP_CPUINFO_FILE is usable on Windows* OS, too
8160b57cec5SDimitry Andric #if KMP_GROUP_AFFINITY
8170b57cec5SDimitry Andric   affinity_top_method_group,
8180b57cec5SDimitry Andric #endif /* KMP_GROUP_AFFINITY */
8190b57cec5SDimitry Andric   affinity_top_method_flat,
8200b57cec5SDimitry Andric #if KMP_USE_HWLOC
8210b57cec5SDimitry Andric   affinity_top_method_hwloc,
8220b57cec5SDimitry Andric #endif
8230b57cec5SDimitry Andric   affinity_top_method_default
8240b57cec5SDimitry Andric };
8250b57cec5SDimitry Andric 
8260b57cec5SDimitry Andric #define affinity_respect_mask_default (-1)
8270b57cec5SDimitry Andric 
8280b57cec5SDimitry Andric extern enum affinity_type __kmp_affinity_type; /* Affinity type */
829fe6060f1SDimitry Andric extern kmp_hw_t __kmp_affinity_gran; /* Affinity granularity */
8300b57cec5SDimitry Andric extern int __kmp_affinity_gran_levels; /* corresponding int value */
8310b57cec5SDimitry Andric extern int __kmp_affinity_dups; /* Affinity duplicate masks */
8320b57cec5SDimitry Andric extern enum affinity_top_method __kmp_affinity_top_method;
8330b57cec5SDimitry Andric extern int __kmp_affinity_compact; /* Affinity 'compact' value */
8340b57cec5SDimitry Andric extern int __kmp_affinity_offset; /* Affinity offset value  */
8350b57cec5SDimitry Andric extern int __kmp_affinity_verbose; /* Was verbose specified for KMP_AFFINITY? */
8360b57cec5SDimitry Andric extern int __kmp_affinity_warnings; /* KMP_AFFINITY warnings enabled ? */
8370b57cec5SDimitry Andric extern int __kmp_affinity_respect_mask; // Respect process' init affinity mask?
8380b57cec5SDimitry Andric extern char *__kmp_affinity_proclist; /* proc ID list */
8390b57cec5SDimitry Andric extern kmp_affin_mask_t *__kmp_affinity_masks;
8400b57cec5SDimitry Andric extern unsigned __kmp_affinity_num_masks;
8410b57cec5SDimitry Andric extern void __kmp_affinity_bind_thread(int which);
8420b57cec5SDimitry Andric 
8430b57cec5SDimitry Andric extern kmp_affin_mask_t *__kmp_affin_fullMask;
844*fcaf7f86SDimitry Andric extern kmp_affin_mask_t *__kmp_affin_origMask;
8450b57cec5SDimitry Andric extern char *__kmp_cpuinfo_file;
846*fcaf7f86SDimitry Andric extern bool __kmp_affin_reset;
8470b57cec5SDimitry Andric 
8480b57cec5SDimitry Andric #endif /* KMP_AFFINITY_SUPPORTED */
8490b57cec5SDimitry Andric 
8500b57cec5SDimitry Andric // This needs to be kept in sync with the values in omp.h !!!
8510b57cec5SDimitry Andric typedef enum kmp_proc_bind_t {
8520b57cec5SDimitry Andric   proc_bind_false = 0,
8530b57cec5SDimitry Andric   proc_bind_true,
854fe6060f1SDimitry Andric   proc_bind_primary,
8550b57cec5SDimitry Andric   proc_bind_close,
8560b57cec5SDimitry Andric   proc_bind_spread,
8570b57cec5SDimitry Andric   proc_bind_intel, // use KMP_AFFINITY interface
8580b57cec5SDimitry Andric   proc_bind_default
8590b57cec5SDimitry Andric } kmp_proc_bind_t;
8600b57cec5SDimitry Andric 
8610b57cec5SDimitry Andric typedef struct kmp_nested_proc_bind_t {
8620b57cec5SDimitry Andric   kmp_proc_bind_t *bind_types;
8630b57cec5SDimitry Andric   int size;
8640b57cec5SDimitry Andric   int used;
8650b57cec5SDimitry Andric } kmp_nested_proc_bind_t;
8660b57cec5SDimitry Andric 
8670b57cec5SDimitry Andric extern kmp_nested_proc_bind_t __kmp_nested_proc_bind;
868349cc55cSDimitry Andric extern kmp_proc_bind_t __kmp_teams_proc_bind;
8690b57cec5SDimitry Andric 
8700b57cec5SDimitry Andric extern int __kmp_display_affinity;
8710b57cec5SDimitry Andric extern char *__kmp_affinity_format;
8720b57cec5SDimitry Andric static const size_t KMP_AFFINITY_FORMAT_SIZE = 512;
873fe6060f1SDimitry Andric #if OMPT_SUPPORT
874fe6060f1SDimitry Andric extern int __kmp_tool;
875fe6060f1SDimitry Andric extern char *__kmp_tool_libraries;
876fe6060f1SDimitry Andric #endif // OMPT_SUPPORT
8770b57cec5SDimitry Andric 
8780b57cec5SDimitry Andric #if KMP_AFFINITY_SUPPORTED
8790b57cec5SDimitry Andric #define KMP_PLACE_ALL (-1)
8800b57cec5SDimitry Andric #define KMP_PLACE_UNDEFINED (-2)
8810b57cec5SDimitry Andric // Is KMP_AFFINITY is being used instead of OMP_PROC_BIND/OMP_PLACES?
8820b57cec5SDimitry Andric #define KMP_AFFINITY_NON_PROC_BIND                                             \
8830b57cec5SDimitry Andric   ((__kmp_nested_proc_bind.bind_types[0] == proc_bind_false ||                 \
8840b57cec5SDimitry Andric     __kmp_nested_proc_bind.bind_types[0] == proc_bind_intel) &&                \
8850b57cec5SDimitry Andric    (__kmp_affinity_num_masks > 0 || __kmp_affinity_type == affinity_balanced))
8860b57cec5SDimitry Andric #endif /* KMP_AFFINITY_SUPPORTED */
8870b57cec5SDimitry Andric 
8880b57cec5SDimitry Andric extern int __kmp_affinity_num_places;
8890b57cec5SDimitry Andric 
8900b57cec5SDimitry Andric typedef enum kmp_cancel_kind_t {
8910b57cec5SDimitry Andric   cancel_noreq = 0,
8920b57cec5SDimitry Andric   cancel_parallel = 1,
8930b57cec5SDimitry Andric   cancel_loop = 2,
8940b57cec5SDimitry Andric   cancel_sections = 3,
8950b57cec5SDimitry Andric   cancel_taskgroup = 4
8960b57cec5SDimitry Andric } kmp_cancel_kind_t;
8970b57cec5SDimitry Andric 
8980b57cec5SDimitry Andric // KMP_HW_SUBSET support:
8990b57cec5SDimitry Andric typedef struct kmp_hws_item {
9000b57cec5SDimitry Andric   int num;
9010b57cec5SDimitry Andric   int offset;
9020b57cec5SDimitry Andric } kmp_hws_item_t;
9030b57cec5SDimitry Andric 
9040b57cec5SDimitry Andric extern kmp_hws_item_t __kmp_hws_socket;
905fe6060f1SDimitry Andric extern kmp_hws_item_t __kmp_hws_die;
9060b57cec5SDimitry Andric extern kmp_hws_item_t __kmp_hws_node;
9070b57cec5SDimitry Andric extern kmp_hws_item_t __kmp_hws_tile;
9080b57cec5SDimitry Andric extern kmp_hws_item_t __kmp_hws_core;
9090b57cec5SDimitry Andric extern kmp_hws_item_t __kmp_hws_proc;
9100b57cec5SDimitry Andric extern int __kmp_hws_requested;
9110b57cec5SDimitry Andric extern int __kmp_hws_abs_flag; // absolute or per-item number requested
9120b57cec5SDimitry Andric 
9130b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
9140b57cec5SDimitry Andric 
9150b57cec5SDimitry Andric #define KMP_PAD(type, sz)                                                      \
9160b57cec5SDimitry Andric   (sizeof(type) + (sz - ((sizeof(type) - 1) % (sz)) - 1))
9170b57cec5SDimitry Andric 
9180b57cec5SDimitry Andric // We need to avoid using -1 as a GTID as +1 is added to the gtid
9190b57cec5SDimitry Andric // when storing it in a lock, and the value 0 is reserved.
9200b57cec5SDimitry Andric #define KMP_GTID_DNE (-2) /* Does not exist */
9210b57cec5SDimitry Andric #define KMP_GTID_SHUTDOWN (-3) /* Library is shutting down */
9220b57cec5SDimitry Andric #define KMP_GTID_MONITOR (-4) /* Monitor thread ID */
9230b57cec5SDimitry Andric #define KMP_GTID_UNKNOWN (-5) /* Is not known */
9240b57cec5SDimitry Andric #define KMP_GTID_MIN (-6) /* Minimal gtid for low bound check in DEBUG */
9250b57cec5SDimitry Andric 
9260b57cec5SDimitry Andric /* OpenMP 5.0 Memory Management support */
9270b57cec5SDimitry Andric 
9280b57cec5SDimitry Andric #ifndef __OMP_H
929480093f4SDimitry Andric // Duplicate type definitions from omp.h
9300b57cec5SDimitry Andric typedef uintptr_t omp_uintptr_t;
9310b57cec5SDimitry Andric 
9320b57cec5SDimitry Andric typedef enum {
933e8d8bef9SDimitry Andric   omp_atk_sync_hint = 1,
9345ffd83dbSDimitry Andric   omp_atk_alignment = 2,
9355ffd83dbSDimitry Andric   omp_atk_access = 3,
9365ffd83dbSDimitry Andric   omp_atk_pool_size = 4,
9375ffd83dbSDimitry Andric   omp_atk_fallback = 5,
9385ffd83dbSDimitry Andric   omp_atk_fb_data = 6,
9395ffd83dbSDimitry Andric   omp_atk_pinned = 7,
9405ffd83dbSDimitry Andric   omp_atk_partition = 8
9410b57cec5SDimitry Andric } omp_alloctrait_key_t;
9420b57cec5SDimitry Andric 
9430b57cec5SDimitry Andric typedef enum {
9445ffd83dbSDimitry Andric   omp_atv_false = 0,
9455ffd83dbSDimitry Andric   omp_atv_true = 1,
9465ffd83dbSDimitry Andric   omp_atv_contended = 3,
9475ffd83dbSDimitry Andric   omp_atv_uncontended = 4,
948e8d8bef9SDimitry Andric   omp_atv_serialized = 5,
949e8d8bef9SDimitry Andric   omp_atv_sequential = omp_atv_serialized, // (deprecated)
9505ffd83dbSDimitry Andric   omp_atv_private = 6,
9515ffd83dbSDimitry Andric   omp_atv_all = 7,
9525ffd83dbSDimitry Andric   omp_atv_thread = 8,
9535ffd83dbSDimitry Andric   omp_atv_pteam = 9,
9545ffd83dbSDimitry Andric   omp_atv_cgroup = 10,
9555ffd83dbSDimitry Andric   omp_atv_default_mem_fb = 11,
9565ffd83dbSDimitry Andric   omp_atv_null_fb = 12,
9575ffd83dbSDimitry Andric   omp_atv_abort_fb = 13,
9585ffd83dbSDimitry Andric   omp_atv_allocator_fb = 14,
9595ffd83dbSDimitry Andric   omp_atv_environment = 15,
9605ffd83dbSDimitry Andric   omp_atv_nearest = 16,
9615ffd83dbSDimitry Andric   omp_atv_blocked = 17,
9625ffd83dbSDimitry Andric   omp_atv_interleaved = 18
9630b57cec5SDimitry Andric } omp_alloctrait_value_t;
964e8d8bef9SDimitry Andric #define omp_atv_default ((omp_uintptr_t)-1)
9650b57cec5SDimitry Andric 
9660b57cec5SDimitry Andric typedef void *omp_memspace_handle_t;
9670b57cec5SDimitry Andric extern omp_memspace_handle_t const omp_default_mem_space;
9680b57cec5SDimitry Andric extern omp_memspace_handle_t const omp_large_cap_mem_space;
9690b57cec5SDimitry Andric extern omp_memspace_handle_t const omp_const_mem_space;
9700b57cec5SDimitry Andric extern omp_memspace_handle_t const omp_high_bw_mem_space;
9710b57cec5SDimitry Andric extern omp_memspace_handle_t const omp_low_lat_mem_space;
972fe6060f1SDimitry Andric extern omp_memspace_handle_t const llvm_omp_target_host_mem_space;
973fe6060f1SDimitry Andric extern omp_memspace_handle_t const llvm_omp_target_shared_mem_space;
974fe6060f1SDimitry Andric extern omp_memspace_handle_t const llvm_omp_target_device_mem_space;
9750b57cec5SDimitry Andric 
9760b57cec5SDimitry Andric typedef struct {
9770b57cec5SDimitry Andric   omp_alloctrait_key_t key;
9780b57cec5SDimitry Andric   omp_uintptr_t value;
9790b57cec5SDimitry Andric } omp_alloctrait_t;
9800b57cec5SDimitry Andric 
9810b57cec5SDimitry Andric typedef void *omp_allocator_handle_t;
9820b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_null_allocator;
9830b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_default_mem_alloc;
9840b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_large_cap_mem_alloc;
9850b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_const_mem_alloc;
9860b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_high_bw_mem_alloc;
9870b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_low_lat_mem_alloc;
9880b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_cgroup_mem_alloc;
9890b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_pteam_mem_alloc;
9900b57cec5SDimitry Andric extern omp_allocator_handle_t const omp_thread_mem_alloc;
991fe6060f1SDimitry Andric extern omp_allocator_handle_t const llvm_omp_target_host_mem_alloc;
992fe6060f1SDimitry Andric extern omp_allocator_handle_t const llvm_omp_target_shared_mem_alloc;
993fe6060f1SDimitry Andric extern omp_allocator_handle_t const llvm_omp_target_device_mem_alloc;
9940b57cec5SDimitry Andric extern omp_allocator_handle_t const kmp_max_mem_alloc;
9950b57cec5SDimitry Andric extern omp_allocator_handle_t __kmp_def_allocator;
9960b57cec5SDimitry Andric 
997480093f4SDimitry Andric // end of duplicate type definitions from omp.h
9980b57cec5SDimitry Andric #endif
9990b57cec5SDimitry Andric 
10000b57cec5SDimitry Andric extern int __kmp_memkind_available;
10010b57cec5SDimitry Andric 
10020b57cec5SDimitry Andric typedef omp_memspace_handle_t kmp_memspace_t; // placeholder
10030b57cec5SDimitry Andric 
10040b57cec5SDimitry Andric typedef struct kmp_allocator_t {
10050b57cec5SDimitry Andric   omp_memspace_handle_t memspace;
10060b57cec5SDimitry Andric   void **memkind; // pointer to memkind
1007349cc55cSDimitry Andric   size_t alignment;
10080b57cec5SDimitry Andric   omp_alloctrait_value_t fb;
10090b57cec5SDimitry Andric   kmp_allocator_t *fb_data;
10100b57cec5SDimitry Andric   kmp_uint64 pool_size;
10110b57cec5SDimitry Andric   kmp_uint64 pool_used;
10120b57cec5SDimitry Andric } kmp_allocator_t;
10130b57cec5SDimitry Andric 
10140b57cec5SDimitry Andric extern omp_allocator_handle_t __kmpc_init_allocator(int gtid,
10150b57cec5SDimitry Andric                                                     omp_memspace_handle_t,
10160b57cec5SDimitry Andric                                                     int ntraits,
10170b57cec5SDimitry Andric                                                     omp_alloctrait_t traits[]);
10180b57cec5SDimitry Andric extern void __kmpc_destroy_allocator(int gtid, omp_allocator_handle_t al);
10190b57cec5SDimitry Andric extern void __kmpc_set_default_allocator(int gtid, omp_allocator_handle_t al);
10200b57cec5SDimitry Andric extern omp_allocator_handle_t __kmpc_get_default_allocator(int gtid);
1021349cc55cSDimitry Andric // external interfaces, may be used by compiler
10220b57cec5SDimitry Andric extern void *__kmpc_alloc(int gtid, size_t sz, omp_allocator_handle_t al);
1023349cc55cSDimitry Andric extern void *__kmpc_aligned_alloc(int gtid, size_t align, size_t sz,
1024349cc55cSDimitry Andric                                   omp_allocator_handle_t al);
1025e8d8bef9SDimitry Andric extern void *__kmpc_calloc(int gtid, size_t nmemb, size_t sz,
1026e8d8bef9SDimitry Andric                            omp_allocator_handle_t al);
1027e8d8bef9SDimitry Andric extern void *__kmpc_realloc(int gtid, void *ptr, size_t sz,
1028e8d8bef9SDimitry Andric                             omp_allocator_handle_t al,
1029e8d8bef9SDimitry Andric                             omp_allocator_handle_t free_al);
10300b57cec5SDimitry Andric extern void __kmpc_free(int gtid, void *ptr, omp_allocator_handle_t al);
1031349cc55cSDimitry Andric // internal interfaces, contain real implementation
1032349cc55cSDimitry Andric extern void *__kmp_alloc(int gtid, size_t align, size_t sz,
1033349cc55cSDimitry Andric                          omp_allocator_handle_t al);
1034349cc55cSDimitry Andric extern void *__kmp_calloc(int gtid, size_t align, size_t nmemb, size_t sz,
1035349cc55cSDimitry Andric                           omp_allocator_handle_t al);
1036349cc55cSDimitry Andric extern void *__kmp_realloc(int gtid, void *ptr, size_t sz,
1037349cc55cSDimitry Andric                            omp_allocator_handle_t al,
1038349cc55cSDimitry Andric                            omp_allocator_handle_t free_al);
1039349cc55cSDimitry Andric extern void ___kmpc_free(int gtid, void *ptr, omp_allocator_handle_t al);
10400b57cec5SDimitry Andric 
10410b57cec5SDimitry Andric extern void __kmp_init_memkind();
10420b57cec5SDimitry Andric extern void __kmp_fini_memkind();
1043fe6060f1SDimitry Andric extern void __kmp_init_target_mem();
10440b57cec5SDimitry Andric 
10450b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
10460b57cec5SDimitry Andric 
10470b57cec5SDimitry Andric #define KMP_UINT64_MAX                                                         \
10480b57cec5SDimitry Andric   (~((kmp_uint64)1 << ((sizeof(kmp_uint64) * (1 << 3)) - 1)))
10490b57cec5SDimitry Andric 
10500b57cec5SDimitry Andric #define KMP_MIN_NTH 1
10510b57cec5SDimitry Andric 
10520b57cec5SDimitry Andric #ifndef KMP_MAX_NTH
10530b57cec5SDimitry Andric #if defined(PTHREAD_THREADS_MAX) && PTHREAD_THREADS_MAX < INT_MAX
10540b57cec5SDimitry Andric #define KMP_MAX_NTH PTHREAD_THREADS_MAX
10550b57cec5SDimitry Andric #else
10560b57cec5SDimitry Andric #define KMP_MAX_NTH INT_MAX
10570b57cec5SDimitry Andric #endif
10580b57cec5SDimitry Andric #endif /* KMP_MAX_NTH */
10590b57cec5SDimitry Andric 
10600b57cec5SDimitry Andric #ifdef PTHREAD_STACK_MIN
10610b57cec5SDimitry Andric #define KMP_MIN_STKSIZE PTHREAD_STACK_MIN
10620b57cec5SDimitry Andric #else
10630b57cec5SDimitry Andric #define KMP_MIN_STKSIZE ((size_t)(32 * 1024))
10640b57cec5SDimitry Andric #endif
10650b57cec5SDimitry Andric 
10660b57cec5SDimitry Andric #define KMP_MAX_STKSIZE (~((size_t)1 << ((sizeof(size_t) * (1 << 3)) - 1)))
10670b57cec5SDimitry Andric 
10680b57cec5SDimitry Andric #if KMP_ARCH_X86
10690b57cec5SDimitry Andric #define KMP_DEFAULT_STKSIZE ((size_t)(2 * 1024 * 1024))
10700b57cec5SDimitry Andric #elif KMP_ARCH_X86_64
10710b57cec5SDimitry Andric #define KMP_DEFAULT_STKSIZE ((size_t)(4 * 1024 * 1024))
10720b57cec5SDimitry Andric #define KMP_BACKUP_STKSIZE ((size_t)(2 * 1024 * 1024))
10730b57cec5SDimitry Andric #else
10740b57cec5SDimitry Andric #define KMP_DEFAULT_STKSIZE ((size_t)(1024 * 1024))
10750b57cec5SDimitry Andric #endif
10760b57cec5SDimitry Andric 
10770b57cec5SDimitry Andric #define KMP_DEFAULT_MALLOC_POOL_INCR ((size_t)(1024 * 1024))
10780b57cec5SDimitry Andric #define KMP_MIN_MALLOC_POOL_INCR ((size_t)(4 * 1024))
10790b57cec5SDimitry Andric #define KMP_MAX_MALLOC_POOL_INCR                                               \
10800b57cec5SDimitry Andric   (~((size_t)1 << ((sizeof(size_t) * (1 << 3)) - 1)))
10810b57cec5SDimitry Andric 
10820b57cec5SDimitry Andric #define KMP_MIN_STKOFFSET (0)
10830b57cec5SDimitry Andric #define KMP_MAX_STKOFFSET KMP_MAX_STKSIZE
10840b57cec5SDimitry Andric #if KMP_OS_DARWIN
10850b57cec5SDimitry Andric #define KMP_DEFAULT_STKOFFSET KMP_MIN_STKOFFSET
10860b57cec5SDimitry Andric #else
10870b57cec5SDimitry Andric #define KMP_DEFAULT_STKOFFSET CACHE_LINE
10880b57cec5SDimitry Andric #endif
10890b57cec5SDimitry Andric 
10900b57cec5SDimitry Andric #define KMP_MIN_STKPADDING (0)
10910b57cec5SDimitry Andric #define KMP_MAX_STKPADDING (2 * 1024 * 1024)
10920b57cec5SDimitry Andric 
10930b57cec5SDimitry Andric #define KMP_BLOCKTIME_MULTIPLIER                                               \
10940b57cec5SDimitry Andric   (1000) /* number of blocktime units per second */
10950b57cec5SDimitry Andric #define KMP_MIN_BLOCKTIME (0)
10960b57cec5SDimitry Andric #define KMP_MAX_BLOCKTIME                                                      \
10970b57cec5SDimitry Andric   (INT_MAX) /* Must be this for "infinite" setting the work */
1098349cc55cSDimitry Andric 
1099349cc55cSDimitry Andric /* __kmp_blocktime is in milliseconds */
1100349cc55cSDimitry Andric #define KMP_DEFAULT_BLOCKTIME (__kmp_is_hybrid_cpu() ? (0) : (200))
11010b57cec5SDimitry Andric 
11020b57cec5SDimitry Andric #if KMP_USE_MONITOR
11030b57cec5SDimitry Andric #define KMP_DEFAULT_MONITOR_STKSIZE ((size_t)(64 * 1024))
11040b57cec5SDimitry Andric #define KMP_MIN_MONITOR_WAKEUPS (1) // min times monitor wakes up per second
11050b57cec5SDimitry Andric #define KMP_MAX_MONITOR_WAKEUPS (1000) // max times monitor can wake up per sec
11060b57cec5SDimitry Andric 
11070b57cec5SDimitry Andric /* Calculate new number of monitor wakeups for a specific block time based on
11080b57cec5SDimitry Andric    previous monitor_wakeups. Only allow increasing number of wakeups */
11090b57cec5SDimitry Andric #define KMP_WAKEUPS_FROM_BLOCKTIME(blocktime, monitor_wakeups)                 \
1110fe6060f1SDimitry Andric   (((blocktime) == KMP_MAX_BLOCKTIME)   ? (monitor_wakeups)                    \
1111fe6060f1SDimitry Andric    : ((blocktime) == KMP_MIN_BLOCKTIME) ? KMP_MAX_MONITOR_WAKEUPS              \
11120b57cec5SDimitry Andric    : ((monitor_wakeups) > (KMP_BLOCKTIME_MULTIPLIER / (blocktime)))            \
11130b57cec5SDimitry Andric        ? (monitor_wakeups)                                                     \
11140b57cec5SDimitry Andric        : (KMP_BLOCKTIME_MULTIPLIER) / (blocktime))
11150b57cec5SDimitry Andric 
11160b57cec5SDimitry Andric /* Calculate number of intervals for a specific block time based on
11170b57cec5SDimitry Andric    monitor_wakeups */
11180b57cec5SDimitry Andric #define KMP_INTERVALS_FROM_BLOCKTIME(blocktime, monitor_wakeups)               \
11190b57cec5SDimitry Andric   (((blocktime) + (KMP_BLOCKTIME_MULTIPLIER / (monitor_wakeups)) - 1) /        \
11200b57cec5SDimitry Andric    (KMP_BLOCKTIME_MULTIPLIER / (monitor_wakeups)))
11210b57cec5SDimitry Andric #else
11220b57cec5SDimitry Andric #define KMP_BLOCKTIME(team, tid)                                               \
11230b57cec5SDimitry Andric   (get__bt_set(team, tid) ? get__blocktime(team, tid) : __kmp_dflt_blocktime)
11240b57cec5SDimitry Andric #if KMP_OS_UNIX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
11250b57cec5SDimitry Andric // HW TSC is used to reduce overhead (clock tick instead of nanosecond).
11260b57cec5SDimitry Andric extern kmp_uint64 __kmp_ticks_per_msec;
112781ad6265SDimitry Andric #if KMP_COMPILER_ICC || KMP_COMPILER_ICX
11280b57cec5SDimitry Andric #define KMP_NOW() ((kmp_uint64)_rdtsc())
11290b57cec5SDimitry Andric #else
11300b57cec5SDimitry Andric #define KMP_NOW() __kmp_hardware_timestamp()
11310b57cec5SDimitry Andric #endif
11320b57cec5SDimitry Andric #define KMP_NOW_MSEC() (KMP_NOW() / __kmp_ticks_per_msec)
11330b57cec5SDimitry Andric #define KMP_BLOCKTIME_INTERVAL(team, tid)                                      \
11340b57cec5SDimitry Andric   (KMP_BLOCKTIME(team, tid) * __kmp_ticks_per_msec)
11350b57cec5SDimitry Andric #define KMP_BLOCKING(goal, count) ((goal) > KMP_NOW())
11360b57cec5SDimitry Andric #else
11370b57cec5SDimitry Andric // System time is retrieved sporadically while blocking.
11380b57cec5SDimitry Andric extern kmp_uint64 __kmp_now_nsec();
11390b57cec5SDimitry Andric #define KMP_NOW() __kmp_now_nsec()
11400b57cec5SDimitry Andric #define KMP_NOW_MSEC() (KMP_NOW() / KMP_USEC_PER_SEC)
11410b57cec5SDimitry Andric #define KMP_BLOCKTIME_INTERVAL(team, tid)                                      \
11420b57cec5SDimitry Andric   (KMP_BLOCKTIME(team, tid) * KMP_USEC_PER_SEC)
11430b57cec5SDimitry Andric #define KMP_BLOCKING(goal, count) ((count) % 1000 != 0 || (goal) > KMP_NOW())
11440b57cec5SDimitry Andric #endif
11450b57cec5SDimitry Andric #endif // KMP_USE_MONITOR
11460b57cec5SDimitry Andric 
11470b57cec5SDimitry Andric #define KMP_MIN_STATSCOLS 40
11480b57cec5SDimitry Andric #define KMP_MAX_STATSCOLS 4096
11490b57cec5SDimitry Andric #define KMP_DEFAULT_STATSCOLS 80
11500b57cec5SDimitry Andric 
11510b57cec5SDimitry Andric #define KMP_MIN_INTERVAL 0
11520b57cec5SDimitry Andric #define KMP_MAX_INTERVAL (INT_MAX - 1)
11530b57cec5SDimitry Andric #define KMP_DEFAULT_INTERVAL 0
11540b57cec5SDimitry Andric 
11550b57cec5SDimitry Andric #define KMP_MIN_CHUNK 1
11560b57cec5SDimitry Andric #define KMP_MAX_CHUNK (INT_MAX - 1)
11570b57cec5SDimitry Andric #define KMP_DEFAULT_CHUNK 1
11580b57cec5SDimitry Andric 
1159fe6060f1SDimitry Andric #define KMP_MIN_DISP_NUM_BUFF 1
11600b57cec5SDimitry Andric #define KMP_DFLT_DISP_NUM_BUFF 7
1161fe6060f1SDimitry Andric #define KMP_MAX_DISP_NUM_BUFF 4096
1162fe6060f1SDimitry Andric 
11630b57cec5SDimitry Andric #define KMP_MAX_ORDERED 8
11640b57cec5SDimitry Andric 
11650b57cec5SDimitry Andric #define KMP_MAX_FIELDS 32
11660b57cec5SDimitry Andric 
11670b57cec5SDimitry Andric #define KMP_MAX_BRANCH_BITS 31
11680b57cec5SDimitry Andric 
11690b57cec5SDimitry Andric #define KMP_MAX_ACTIVE_LEVELS_LIMIT INT_MAX
11700b57cec5SDimitry Andric 
11710b57cec5SDimitry Andric #define KMP_MAX_DEFAULT_DEVICE_LIMIT INT_MAX
11720b57cec5SDimitry Andric 
11730b57cec5SDimitry Andric #define KMP_MAX_TASK_PRIORITY_LIMIT INT_MAX
11740b57cec5SDimitry Andric 
11750b57cec5SDimitry Andric /* Minimum number of threads before switch to TLS gtid (experimentally
11760b57cec5SDimitry Andric    determined) */
11770b57cec5SDimitry Andric /* josh TODO: what about OS X* tuning? */
11780b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
11790b57cec5SDimitry Andric #define KMP_TLS_GTID_MIN 5
11800b57cec5SDimitry Andric #else
11810b57cec5SDimitry Andric #define KMP_TLS_GTID_MIN INT_MAX
11820b57cec5SDimitry Andric #endif
11830b57cec5SDimitry Andric 
1184e8d8bef9SDimitry Andric #define KMP_MASTER_TID(tid) (0 == (tid))
1185e8d8bef9SDimitry Andric #define KMP_WORKER_TID(tid) (0 != (tid))
11860b57cec5SDimitry Andric 
1187e8d8bef9SDimitry Andric #define KMP_MASTER_GTID(gtid) (0 == __kmp_tid_from_gtid((gtid)))
1188e8d8bef9SDimitry Andric #define KMP_WORKER_GTID(gtid) (0 != __kmp_tid_from_gtid((gtid)))
1189e8d8bef9SDimitry Andric #define KMP_INITIAL_GTID(gtid) (0 == (gtid))
11900b57cec5SDimitry Andric 
11910b57cec5SDimitry Andric #ifndef TRUE
11920b57cec5SDimitry Andric #define FALSE 0
11930b57cec5SDimitry Andric #define TRUE (!FALSE)
11940b57cec5SDimitry Andric #endif
11950b57cec5SDimitry Andric 
11960b57cec5SDimitry Andric /* NOTE: all of the following constants must be even */
11970b57cec5SDimitry Andric 
11980b57cec5SDimitry Andric #if KMP_OS_WINDOWS
11990b57cec5SDimitry Andric #define KMP_INIT_WAIT 64U /* initial number of spin-tests   */
12000b57cec5SDimitry Andric #define KMP_NEXT_WAIT 32U /* susequent number of spin-tests */
12010b57cec5SDimitry Andric #elif KMP_OS_LINUX
12020b57cec5SDimitry Andric #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
12030b57cec5SDimitry Andric #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
12040b57cec5SDimitry Andric #elif KMP_OS_DARWIN
12050b57cec5SDimitry Andric /* TODO: tune for KMP_OS_DARWIN */
12060b57cec5SDimitry Andric #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
12070b57cec5SDimitry Andric #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
12080b57cec5SDimitry Andric #elif KMP_OS_DRAGONFLY
12090b57cec5SDimitry Andric /* TODO: tune for KMP_OS_DRAGONFLY */
12100b57cec5SDimitry Andric #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
12110b57cec5SDimitry Andric #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
12120b57cec5SDimitry Andric #elif KMP_OS_FREEBSD
12130b57cec5SDimitry Andric /* TODO: tune for KMP_OS_FREEBSD */
12140b57cec5SDimitry Andric #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
12150b57cec5SDimitry Andric #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
12160b57cec5SDimitry Andric #elif KMP_OS_NETBSD
12170b57cec5SDimitry Andric /* TODO: tune for KMP_OS_NETBSD */
12180b57cec5SDimitry Andric #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
12190b57cec5SDimitry Andric #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
12200b57cec5SDimitry Andric #elif KMP_OS_HURD
12210b57cec5SDimitry Andric /* TODO: tune for KMP_OS_HURD */
12220b57cec5SDimitry Andric #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
12230b57cec5SDimitry Andric #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
12240b57cec5SDimitry Andric #elif KMP_OS_OPENBSD
12250b57cec5SDimitry Andric /* TODO: tune for KMP_OS_OPENBSD */
12260b57cec5SDimitry Andric #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
12270b57cec5SDimitry Andric #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
12280b57cec5SDimitry Andric #endif
12290b57cec5SDimitry Andric 
12300b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
12310b57cec5SDimitry Andric typedef struct kmp_cpuid {
12320b57cec5SDimitry Andric   kmp_uint32 eax;
12330b57cec5SDimitry Andric   kmp_uint32 ebx;
12340b57cec5SDimitry Andric   kmp_uint32 ecx;
12350b57cec5SDimitry Andric   kmp_uint32 edx;
12360b57cec5SDimitry Andric } kmp_cpuid_t;
12370b57cec5SDimitry Andric 
1238349cc55cSDimitry Andric typedef struct kmp_cpuinfo_flags_t {
1239349cc55cSDimitry Andric   unsigned sse2 : 1; // 0 if SSE2 instructions are not supported, 1 otherwise.
1240349cc55cSDimitry Andric   unsigned rtm : 1; // 0 if RTM instructions are not supported, 1 otherwise.
1241349cc55cSDimitry Andric   unsigned hybrid : 1;
1242349cc55cSDimitry Andric   unsigned reserved : 29; // Ensure size of 32 bits
1243349cc55cSDimitry Andric } kmp_cpuinfo_flags_t;
1244349cc55cSDimitry Andric 
12450b57cec5SDimitry Andric typedef struct kmp_cpuinfo {
12460b57cec5SDimitry Andric   int initialized; // If 0, other fields are not initialized.
12470b57cec5SDimitry Andric   int signature; // CPUID(1).EAX
12480b57cec5SDimitry Andric   int family; // CPUID(1).EAX[27:20]+CPUID(1).EAX[11:8] (Extended Family+Family)
12490b57cec5SDimitry Andric   int model; // ( CPUID(1).EAX[19:16] << 4 ) + CPUID(1).EAX[7:4] ( ( Extended
12500b57cec5SDimitry Andric   // Model << 4 ) + Model)
12510b57cec5SDimitry Andric   int stepping; // CPUID(1).EAX[3:0] ( Stepping )
1252349cc55cSDimitry Andric   kmp_cpuinfo_flags_t flags;
12530b57cec5SDimitry Andric   int apic_id;
12540b57cec5SDimitry Andric   int physical_id;
12550b57cec5SDimitry Andric   int logical_id;
12560b57cec5SDimitry Andric   kmp_uint64 frequency; // Nominal CPU frequency in Hz.
12570b57cec5SDimitry Andric   char name[3 * sizeof(kmp_cpuid_t)]; // CPUID(0x80000002,0x80000003,0x80000004)
12580b57cec5SDimitry Andric } kmp_cpuinfo_t;
12590b57cec5SDimitry Andric 
12600b57cec5SDimitry Andric extern void __kmp_query_cpuid(kmp_cpuinfo_t *p);
12610b57cec5SDimitry Andric 
12620b57cec5SDimitry Andric #if KMP_OS_UNIX
12630b57cec5SDimitry Andric // subleaf is only needed for cache and topology discovery and can be set to
12640b57cec5SDimitry Andric // zero in most cases
12650b57cec5SDimitry Andric static inline void __kmp_x86_cpuid(int leaf, int subleaf, struct kmp_cpuid *p) {
12660b57cec5SDimitry Andric   __asm__ __volatile__("cpuid"
12670b57cec5SDimitry Andric                        : "=a"(p->eax), "=b"(p->ebx), "=c"(p->ecx), "=d"(p->edx)
12680b57cec5SDimitry Andric                        : "a"(leaf), "c"(subleaf));
12690b57cec5SDimitry Andric }
12700b57cec5SDimitry Andric // Load p into FPU control word
12710b57cec5SDimitry Andric static inline void __kmp_load_x87_fpu_control_word(const kmp_int16 *p) {
12720b57cec5SDimitry Andric   __asm__ __volatile__("fldcw %0" : : "m"(*p));
12730b57cec5SDimitry Andric }
12740b57cec5SDimitry Andric // Store FPU control word into p
12750b57cec5SDimitry Andric static inline void __kmp_store_x87_fpu_control_word(kmp_int16 *p) {
12760b57cec5SDimitry Andric   __asm__ __volatile__("fstcw %0" : "=m"(*p));
12770b57cec5SDimitry Andric }
12780b57cec5SDimitry Andric static inline void __kmp_clear_x87_fpu_status_word() {
12790b57cec5SDimitry Andric #if KMP_MIC
12800b57cec5SDimitry Andric   // 32-bit protected mode x87 FPU state
12810b57cec5SDimitry Andric   struct x87_fpu_state {
12820b57cec5SDimitry Andric     unsigned cw;
12830b57cec5SDimitry Andric     unsigned sw;
12840b57cec5SDimitry Andric     unsigned tw;
12850b57cec5SDimitry Andric     unsigned fip;
12860b57cec5SDimitry Andric     unsigned fips;
12870b57cec5SDimitry Andric     unsigned fdp;
12880b57cec5SDimitry Andric     unsigned fds;
12890b57cec5SDimitry Andric   };
12900b57cec5SDimitry Andric   struct x87_fpu_state fpu_state = {0, 0, 0, 0, 0, 0, 0};
12910b57cec5SDimitry Andric   __asm__ __volatile__("fstenv %0\n\t" // store FP env
12920b57cec5SDimitry Andric                        "andw $0x7f00, %1\n\t" // clear 0-7,15 bits of FP SW
12930b57cec5SDimitry Andric                        "fldenv %0\n\t" // load FP env back
12940b57cec5SDimitry Andric                        : "+m"(fpu_state), "+m"(fpu_state.sw));
12950b57cec5SDimitry Andric #else
12960b57cec5SDimitry Andric   __asm__ __volatile__("fnclex");
12970b57cec5SDimitry Andric #endif // KMP_MIC
12980b57cec5SDimitry Andric }
12990b57cec5SDimitry Andric #if __SSE__
13000b57cec5SDimitry Andric static inline void __kmp_load_mxcsr(const kmp_uint32 *p) { _mm_setcsr(*p); }
13010b57cec5SDimitry Andric static inline void __kmp_store_mxcsr(kmp_uint32 *p) { *p = _mm_getcsr(); }
13020b57cec5SDimitry Andric #else
13030b57cec5SDimitry Andric static inline void __kmp_load_mxcsr(const kmp_uint32 *p) {}
13040b57cec5SDimitry Andric static inline void __kmp_store_mxcsr(kmp_uint32 *p) { *p = 0; }
13050b57cec5SDimitry Andric #endif
13060b57cec5SDimitry Andric #else
13070b57cec5SDimitry Andric // Windows still has these as external functions in assembly file
13080b57cec5SDimitry Andric extern void __kmp_x86_cpuid(int mode, int mode2, struct kmp_cpuid *p);
13090b57cec5SDimitry Andric extern void __kmp_load_x87_fpu_control_word(const kmp_int16 *p);
13100b57cec5SDimitry Andric extern void __kmp_store_x87_fpu_control_word(kmp_int16 *p);
13110b57cec5SDimitry Andric extern void __kmp_clear_x87_fpu_status_word();
13120b57cec5SDimitry Andric static inline void __kmp_load_mxcsr(const kmp_uint32 *p) { _mm_setcsr(*p); }
13130b57cec5SDimitry Andric static inline void __kmp_store_mxcsr(kmp_uint32 *p) { *p = _mm_getcsr(); }
13140b57cec5SDimitry Andric #endif // KMP_OS_UNIX
13150b57cec5SDimitry Andric 
13160b57cec5SDimitry Andric #define KMP_X86_MXCSR_MASK 0xffffffc0 /* ignore status flags (6 lsb) */
13170b57cec5SDimitry Andric 
1318e8d8bef9SDimitry Andric // User-level Monitor/Mwait
1319e8d8bef9SDimitry Andric #if KMP_HAVE_UMWAIT
1320e8d8bef9SDimitry Andric // We always try for UMWAIT first
1321e8d8bef9SDimitry Andric #if KMP_HAVE_WAITPKG_INTRINSICS
1322e8d8bef9SDimitry Andric #if KMP_HAVE_IMMINTRIN_H
1323e8d8bef9SDimitry Andric #include <immintrin.h>
1324e8d8bef9SDimitry Andric #elif KMP_HAVE_INTRIN_H
1325e8d8bef9SDimitry Andric #include <intrin.h>
1326e8d8bef9SDimitry Andric #endif
1327e8d8bef9SDimitry Andric #endif // KMP_HAVE_WAITPKG_INTRINSICS
132804eeddc0SDimitry Andric 
1329e8d8bef9SDimitry Andric KMP_ATTRIBUTE_TARGET_WAITPKG
1330fe6060f1SDimitry Andric static inline int __kmp_tpause(uint32_t hint, uint64_t counter) {
1331e8d8bef9SDimitry Andric #if !KMP_HAVE_WAITPKG_INTRINSICS
1332e8d8bef9SDimitry Andric   uint32_t timeHi = uint32_t(counter >> 32);
1333e8d8bef9SDimitry Andric   uint32_t timeLo = uint32_t(counter & 0xffffffff);
1334e8d8bef9SDimitry Andric   char flag;
1335e8d8bef9SDimitry Andric   __asm__ volatile("#tpause\n.byte 0x66, 0x0F, 0xAE, 0xF1\n"
1336e8d8bef9SDimitry Andric                    "setb   %0"
133781ad6265SDimitry Andric                    // The "=q" restraint means any register accessible as rl
133881ad6265SDimitry Andric                    //   in 32-bit mode: a, b, c, and d;
133981ad6265SDimitry Andric                    //   in 64-bit mode: any integer register
134081ad6265SDimitry Andric                    : "=q"(flag)
1341e8d8bef9SDimitry Andric                    : "a"(timeLo), "d"(timeHi), "c"(hint)
1342e8d8bef9SDimitry Andric                    :);
1343e8d8bef9SDimitry Andric   return flag;
1344e8d8bef9SDimitry Andric #else
1345e8d8bef9SDimitry Andric   return _tpause(hint, counter);
1346e8d8bef9SDimitry Andric #endif
1347e8d8bef9SDimitry Andric }
1348e8d8bef9SDimitry Andric KMP_ATTRIBUTE_TARGET_WAITPKG
1349fe6060f1SDimitry Andric static inline void __kmp_umonitor(void *cacheline) {
1350e8d8bef9SDimitry Andric #if !KMP_HAVE_WAITPKG_INTRINSICS
1351e8d8bef9SDimitry Andric   __asm__ volatile("# umonitor\n.byte 0xF3, 0x0F, 0xAE, 0x01 "
1352e8d8bef9SDimitry Andric                    :
1353e8d8bef9SDimitry Andric                    : "a"(cacheline)
1354e8d8bef9SDimitry Andric                    :);
1355e8d8bef9SDimitry Andric #else
1356e8d8bef9SDimitry Andric   _umonitor(cacheline);
1357e8d8bef9SDimitry Andric #endif
1358e8d8bef9SDimitry Andric }
1359e8d8bef9SDimitry Andric KMP_ATTRIBUTE_TARGET_WAITPKG
1360fe6060f1SDimitry Andric static inline int __kmp_umwait(uint32_t hint, uint64_t counter) {
1361e8d8bef9SDimitry Andric #if !KMP_HAVE_WAITPKG_INTRINSICS
1362e8d8bef9SDimitry Andric   uint32_t timeHi = uint32_t(counter >> 32);
1363e8d8bef9SDimitry Andric   uint32_t timeLo = uint32_t(counter & 0xffffffff);
1364e8d8bef9SDimitry Andric   char flag;
1365e8d8bef9SDimitry Andric   __asm__ volatile("#umwait\n.byte 0xF2, 0x0F, 0xAE, 0xF1\n"
1366e8d8bef9SDimitry Andric                    "setb   %0"
136781ad6265SDimitry Andric                    // The "=q" restraint means any register accessible as rl
136881ad6265SDimitry Andric                    //   in 32-bit mode: a, b, c, and d;
136981ad6265SDimitry Andric                    //   in 64-bit mode: any integer register
137081ad6265SDimitry Andric                    : "=q"(flag)
1371e8d8bef9SDimitry Andric                    : "a"(timeLo), "d"(timeHi), "c"(hint)
1372e8d8bef9SDimitry Andric                    :);
1373e8d8bef9SDimitry Andric   return flag;
1374e8d8bef9SDimitry Andric #else
1375e8d8bef9SDimitry Andric   return _umwait(hint, counter);
1376e8d8bef9SDimitry Andric #endif
1377e8d8bef9SDimitry Andric }
1378e8d8bef9SDimitry Andric #elif KMP_HAVE_MWAIT
1379e8d8bef9SDimitry Andric #if KMP_OS_UNIX
1380e8d8bef9SDimitry Andric #include <pmmintrin.h>
1381e8d8bef9SDimitry Andric #else
1382e8d8bef9SDimitry Andric #include <intrin.h>
1383e8d8bef9SDimitry Andric #endif
1384e8d8bef9SDimitry Andric #if KMP_OS_UNIX
1385e8d8bef9SDimitry Andric __attribute__((target("sse3")))
1386e8d8bef9SDimitry Andric #endif
1387e8d8bef9SDimitry Andric static inline void
1388e8d8bef9SDimitry Andric __kmp_mm_monitor(void *cacheline, unsigned extensions, unsigned hints) {
1389e8d8bef9SDimitry Andric   _mm_monitor(cacheline, extensions, hints);
1390e8d8bef9SDimitry Andric }
1391e8d8bef9SDimitry Andric #if KMP_OS_UNIX
1392e8d8bef9SDimitry Andric __attribute__((target("sse3")))
1393e8d8bef9SDimitry Andric #endif
1394e8d8bef9SDimitry Andric static inline void
1395e8d8bef9SDimitry Andric __kmp_mm_mwait(unsigned extensions, unsigned hints) {
1396e8d8bef9SDimitry Andric   _mm_mwait(extensions, hints);
1397e8d8bef9SDimitry Andric }
1398e8d8bef9SDimitry Andric #endif // KMP_HAVE_UMWAIT
1399e8d8bef9SDimitry Andric 
140004eeddc0SDimitry Andric #if KMP_ARCH_X86
140104eeddc0SDimitry Andric extern void __kmp_x86_pause(void);
140204eeddc0SDimitry Andric #elif KMP_MIC
140304eeddc0SDimitry Andric // Performance testing on KNC (C0QS-7120 P/A/X/D, 61-core, 16 GB Memory) showed
140404eeddc0SDimitry Andric // regression after removal of extra PAUSE from spin loops. Changing
140504eeddc0SDimitry Andric // the delay from 100 to 300 showed even better performance than double PAUSE
140604eeddc0SDimitry Andric // on Spec OMP2001 and LCPC tasking tests, no regressions on EPCC.
140704eeddc0SDimitry Andric static inline void __kmp_x86_pause(void) { _mm_delay_32(300); }
140804eeddc0SDimitry Andric #else
140904eeddc0SDimitry Andric static inline void __kmp_x86_pause(void) { _mm_pause(); }
141004eeddc0SDimitry Andric #endif
141104eeddc0SDimitry Andric #define KMP_CPU_PAUSE() __kmp_x86_pause()
141204eeddc0SDimitry Andric #elif KMP_ARCH_PPC64
141304eeddc0SDimitry Andric #define KMP_PPC64_PRI_LOW() __asm__ volatile("or 1, 1, 1")
141404eeddc0SDimitry Andric #define KMP_PPC64_PRI_MED() __asm__ volatile("or 2, 2, 2")
141504eeddc0SDimitry Andric #define KMP_PPC64_PRI_LOC_MB() __asm__ volatile("" : : : "memory")
141604eeddc0SDimitry Andric #define KMP_CPU_PAUSE()                                                        \
141704eeddc0SDimitry Andric   do {                                                                         \
141804eeddc0SDimitry Andric     KMP_PPC64_PRI_LOW();                                                       \
141904eeddc0SDimitry Andric     KMP_PPC64_PRI_MED();                                                       \
142004eeddc0SDimitry Andric     KMP_PPC64_PRI_LOC_MB();                                                    \
142104eeddc0SDimitry Andric   } while (0)
142204eeddc0SDimitry Andric #else
142304eeddc0SDimitry Andric #define KMP_CPU_PAUSE() /* nothing to do */
142404eeddc0SDimitry Andric #endif
142504eeddc0SDimitry Andric 
142604eeddc0SDimitry Andric #define KMP_INIT_YIELD(count)                                                  \
142704eeddc0SDimitry Andric   { (count) = __kmp_yield_init; }
142804eeddc0SDimitry Andric 
142904eeddc0SDimitry Andric #define KMP_INIT_BACKOFF(time)                                                 \
143004eeddc0SDimitry Andric   { (time) = __kmp_pause_init; }
143104eeddc0SDimitry Andric 
143204eeddc0SDimitry Andric #define KMP_OVERSUBSCRIBED                                                     \
143304eeddc0SDimitry Andric   (TCR_4(__kmp_nth) > (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc))
143404eeddc0SDimitry Andric 
143504eeddc0SDimitry Andric #define KMP_TRY_YIELD                                                          \
143604eeddc0SDimitry Andric   ((__kmp_use_yield == 1) || (__kmp_use_yield == 2 && (KMP_OVERSUBSCRIBED)))
143704eeddc0SDimitry Andric 
143804eeddc0SDimitry Andric #define KMP_TRY_YIELD_OVERSUB                                                  \
143904eeddc0SDimitry Andric   ((__kmp_use_yield == 1 || __kmp_use_yield == 2) && (KMP_OVERSUBSCRIBED))
144004eeddc0SDimitry Andric 
144104eeddc0SDimitry Andric #define KMP_YIELD(cond)                                                        \
144204eeddc0SDimitry Andric   {                                                                            \
144304eeddc0SDimitry Andric     KMP_CPU_PAUSE();                                                           \
144404eeddc0SDimitry Andric     if ((cond) && (KMP_TRY_YIELD))                                             \
144504eeddc0SDimitry Andric       __kmp_yield();                                                           \
144604eeddc0SDimitry Andric   }
144704eeddc0SDimitry Andric 
144804eeddc0SDimitry Andric #define KMP_YIELD_OVERSUB()                                                    \
144904eeddc0SDimitry Andric   {                                                                            \
145004eeddc0SDimitry Andric     KMP_CPU_PAUSE();                                                           \
145104eeddc0SDimitry Andric     if ((KMP_TRY_YIELD_OVERSUB))                                               \
145204eeddc0SDimitry Andric       __kmp_yield();                                                           \
145304eeddc0SDimitry Andric   }
145404eeddc0SDimitry Andric 
145504eeddc0SDimitry Andric // Note the decrement of 2 in the following Macros. With KMP_LIBRARY=turnaround,
145604eeddc0SDimitry Andric // there should be no yielding since initial value from KMP_INIT_YIELD() is odd.
145704eeddc0SDimitry Andric #define KMP_YIELD_SPIN(count)                                                  \
145804eeddc0SDimitry Andric   {                                                                            \
145904eeddc0SDimitry Andric     KMP_CPU_PAUSE();                                                           \
146004eeddc0SDimitry Andric     if (KMP_TRY_YIELD) {                                                       \
146104eeddc0SDimitry Andric       (count) -= 2;                                                            \
146204eeddc0SDimitry Andric       if (!(count)) {                                                          \
146304eeddc0SDimitry Andric         __kmp_yield();                                                         \
146404eeddc0SDimitry Andric         (count) = __kmp_yield_next;                                            \
146504eeddc0SDimitry Andric       }                                                                        \
146604eeddc0SDimitry Andric     }                                                                          \
146704eeddc0SDimitry Andric   }
146804eeddc0SDimitry Andric 
146904eeddc0SDimitry Andric // If TPAUSE is available & enabled, use it. If oversubscribed, use the slower
147004eeddc0SDimitry Andric // (C0.2) state, which improves performance of other SMT threads on the same
147104eeddc0SDimitry Andric // core, otherwise, use the fast (C0.1) default state, or whatever the user has
147204eeddc0SDimitry Andric // requested. Uses a timed TPAUSE, and exponential backoff. If TPAUSE isn't
147304eeddc0SDimitry Andric // available, fall back to the regular CPU pause and yield combination.
147404eeddc0SDimitry Andric #if KMP_HAVE_UMWAIT
147504eeddc0SDimitry Andric #define KMP_YIELD_OVERSUB_ELSE_SPIN(count, time)                               \
147604eeddc0SDimitry Andric   {                                                                            \
147704eeddc0SDimitry Andric     if (__kmp_tpause_enabled) {                                                \
147804eeddc0SDimitry Andric       if (KMP_OVERSUBSCRIBED) {                                                \
147904eeddc0SDimitry Andric         __kmp_tpause(0, (time));                                               \
148004eeddc0SDimitry Andric       } else {                                                                 \
148104eeddc0SDimitry Andric         __kmp_tpause(__kmp_tpause_hint, (time));                               \
148204eeddc0SDimitry Andric       }                                                                        \
148304eeddc0SDimitry Andric       (time) *= 2;                                                             \
148404eeddc0SDimitry Andric     } else {                                                                   \
148504eeddc0SDimitry Andric       KMP_CPU_PAUSE();                                                         \
148604eeddc0SDimitry Andric       if ((KMP_TRY_YIELD_OVERSUB)) {                                           \
148704eeddc0SDimitry Andric         __kmp_yield();                                                         \
148804eeddc0SDimitry Andric       } else if (__kmp_use_yield == 1) {                                       \
148904eeddc0SDimitry Andric         (count) -= 2;                                                          \
149004eeddc0SDimitry Andric         if (!(count)) {                                                        \
149104eeddc0SDimitry Andric           __kmp_yield();                                                       \
149204eeddc0SDimitry Andric           (count) = __kmp_yield_next;                                          \
149304eeddc0SDimitry Andric         }                                                                      \
149404eeddc0SDimitry Andric       }                                                                        \
149504eeddc0SDimitry Andric     }                                                                          \
149604eeddc0SDimitry Andric   }
149704eeddc0SDimitry Andric #else
149804eeddc0SDimitry Andric #define KMP_YIELD_OVERSUB_ELSE_SPIN(count, time)                               \
149904eeddc0SDimitry Andric   {                                                                            \
150004eeddc0SDimitry Andric     KMP_CPU_PAUSE();                                                           \
150104eeddc0SDimitry Andric     if ((KMP_TRY_YIELD_OVERSUB))                                               \
150204eeddc0SDimitry Andric       __kmp_yield();                                                           \
150304eeddc0SDimitry Andric     else if (__kmp_use_yield == 1) {                                           \
150404eeddc0SDimitry Andric       (count) -= 2;                                                            \
150504eeddc0SDimitry Andric       if (!(count)) {                                                          \
150604eeddc0SDimitry Andric         __kmp_yield();                                                         \
150704eeddc0SDimitry Andric         (count) = __kmp_yield_next;                                            \
150804eeddc0SDimitry Andric       }                                                                        \
150904eeddc0SDimitry Andric     }                                                                          \
151004eeddc0SDimitry Andric   }
151104eeddc0SDimitry Andric #endif // KMP_HAVE_UMWAIT
151204eeddc0SDimitry Andric 
15130b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
15140b57cec5SDimitry Andric /* Support datatypes for the orphaned construct nesting checks.             */
15150b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
15160b57cec5SDimitry Andric 
1517349cc55cSDimitry Andric /* When adding to this enum, add its corresponding string in cons_text_c[]
1518349cc55cSDimitry Andric  * array in kmp_error.cpp */
15190b57cec5SDimitry Andric enum cons_type {
15200b57cec5SDimitry Andric   ct_none,
15210b57cec5SDimitry Andric   ct_parallel,
15220b57cec5SDimitry Andric   ct_pdo,
15230b57cec5SDimitry Andric   ct_pdo_ordered,
15240b57cec5SDimitry Andric   ct_psections,
15250b57cec5SDimitry Andric   ct_psingle,
15260b57cec5SDimitry Andric   ct_critical,
15270b57cec5SDimitry Andric   ct_ordered_in_parallel,
15280b57cec5SDimitry Andric   ct_ordered_in_pdo,
15290b57cec5SDimitry Andric   ct_master,
15300b57cec5SDimitry Andric   ct_reduce,
1531fe6060f1SDimitry Andric   ct_barrier,
1532fe6060f1SDimitry Andric   ct_masked
15330b57cec5SDimitry Andric };
15340b57cec5SDimitry Andric 
15350b57cec5SDimitry Andric #define IS_CONS_TYPE_ORDERED(ct) ((ct) == ct_pdo_ordered)
15360b57cec5SDimitry Andric 
15370b57cec5SDimitry Andric struct cons_data {
15380b57cec5SDimitry Andric   ident_t const *ident;
15390b57cec5SDimitry Andric   enum cons_type type;
15400b57cec5SDimitry Andric   int prev;
15410b57cec5SDimitry Andric   kmp_user_lock_p
15420b57cec5SDimitry Andric       name; /* address exclusively for critical section name comparison */
15430b57cec5SDimitry Andric };
15440b57cec5SDimitry Andric 
15450b57cec5SDimitry Andric struct cons_header {
15460b57cec5SDimitry Andric   int p_top, w_top, s_top;
15470b57cec5SDimitry Andric   int stack_size, stack_top;
15480b57cec5SDimitry Andric   struct cons_data *stack_data;
15490b57cec5SDimitry Andric };
15500b57cec5SDimitry Andric 
15510b57cec5SDimitry Andric struct kmp_region_info {
15520b57cec5SDimitry Andric   char *text;
15530b57cec5SDimitry Andric   int offset[KMP_MAX_FIELDS];
15540b57cec5SDimitry Andric   int length[KMP_MAX_FIELDS];
15550b57cec5SDimitry Andric };
15560b57cec5SDimitry Andric 
15570b57cec5SDimitry Andric /* ---------------------------------------------------------------------- */
15580b57cec5SDimitry Andric /* ---------------------------------------------------------------------- */
15590b57cec5SDimitry Andric 
15600b57cec5SDimitry Andric #if KMP_OS_WINDOWS
15610b57cec5SDimitry Andric typedef HANDLE kmp_thread_t;
15620b57cec5SDimitry Andric typedef DWORD kmp_key_t;
15630b57cec5SDimitry Andric #endif /* KMP_OS_WINDOWS */
15640b57cec5SDimitry Andric 
15650b57cec5SDimitry Andric #if KMP_OS_UNIX
15660b57cec5SDimitry Andric typedef pthread_t kmp_thread_t;
15670b57cec5SDimitry Andric typedef pthread_key_t kmp_key_t;
15680b57cec5SDimitry Andric #endif
15690b57cec5SDimitry Andric 
15700b57cec5SDimitry Andric extern kmp_key_t __kmp_gtid_threadprivate_key;
15710b57cec5SDimitry Andric 
15720b57cec5SDimitry Andric typedef struct kmp_sys_info {
15730b57cec5SDimitry Andric   long maxrss; /* the maximum resident set size utilized (in kilobytes)     */
15740b57cec5SDimitry Andric   long minflt; /* the number of page faults serviced without any I/O        */
15750b57cec5SDimitry Andric   long majflt; /* the number of page faults serviced that required I/O      */
15760b57cec5SDimitry Andric   long nswap; /* the number of times a process was "swapped" out of memory */
15770b57cec5SDimitry Andric   long inblock; /* the number of times the file system had to perform input  */
15780b57cec5SDimitry Andric   long oublock; /* the number of times the file system had to perform output */
15790b57cec5SDimitry Andric   long nvcsw; /* the number of times a context switch was voluntarily      */
15800b57cec5SDimitry Andric   long nivcsw; /* the number of times a context switch was forced           */
15810b57cec5SDimitry Andric } kmp_sys_info_t;
15820b57cec5SDimitry Andric 
15830b57cec5SDimitry Andric #if USE_ITT_BUILD
15840b57cec5SDimitry Andric // We cannot include "kmp_itt.h" due to circular dependency. Declare the only
15850b57cec5SDimitry Andric // required type here. Later we will check the type meets requirements.
15860b57cec5SDimitry Andric typedef int kmp_itt_mark_t;
15870b57cec5SDimitry Andric #define KMP_ITT_DEBUG 0
15880b57cec5SDimitry Andric #endif /* USE_ITT_BUILD */
15890b57cec5SDimitry Andric 
15900b57cec5SDimitry Andric typedef kmp_int32 kmp_critical_name[8];
15910b57cec5SDimitry Andric 
15920b57cec5SDimitry Andric /*!
15930b57cec5SDimitry Andric @ingroup PARALLEL
15940b57cec5SDimitry Andric The type for a microtask which gets passed to @ref __kmpc_fork_call().
15950b57cec5SDimitry Andric The arguments to the outlined function are
15960b57cec5SDimitry Andric @param global_tid the global thread identity of the thread executing the
15970b57cec5SDimitry Andric function.
1598480093f4SDimitry Andric @param bound_tid  the local identity of the thread executing the function
15990b57cec5SDimitry Andric @param ... pointers to shared variables accessed by the function.
16000b57cec5SDimitry Andric */
16010b57cec5SDimitry Andric typedef void (*kmpc_micro)(kmp_int32 *global_tid, kmp_int32 *bound_tid, ...);
16020b57cec5SDimitry Andric typedef void (*kmpc_micro_bound)(kmp_int32 *bound_tid, kmp_int32 *bound_nth,
16030b57cec5SDimitry Andric                                  ...);
16040b57cec5SDimitry Andric 
16050b57cec5SDimitry Andric /*!
16060b57cec5SDimitry Andric @ingroup THREADPRIVATE
16070b57cec5SDimitry Andric @{
16080b57cec5SDimitry Andric */
16090b57cec5SDimitry Andric /* ---------------------------------------------------------------------------
16100b57cec5SDimitry Andric  */
16110b57cec5SDimitry Andric /* Threadprivate initialization/finalization function declarations */
16120b57cec5SDimitry Andric 
16130b57cec5SDimitry Andric /*  for non-array objects:  __kmpc_threadprivate_register()  */
16140b57cec5SDimitry Andric 
16150b57cec5SDimitry Andric /*!
16160b57cec5SDimitry Andric  Pointer to the constructor function.
16170b57cec5SDimitry Andric  The first argument is the <tt>this</tt> pointer
16180b57cec5SDimitry Andric */
16190b57cec5SDimitry Andric typedef void *(*kmpc_ctor)(void *);
16200b57cec5SDimitry Andric 
16210b57cec5SDimitry Andric /*!
16220b57cec5SDimitry Andric  Pointer to the destructor function.
16230b57cec5SDimitry Andric  The first argument is the <tt>this</tt> pointer
16240b57cec5SDimitry Andric */
16250b57cec5SDimitry Andric typedef void (*kmpc_dtor)(
16260b57cec5SDimitry Andric     void * /*, size_t */); /* 2nd arg: magic number for KCC unused by Intel
16270b57cec5SDimitry Andric                               compiler */
16280b57cec5SDimitry Andric /*!
16290b57cec5SDimitry Andric  Pointer to an alternate constructor.
16300b57cec5SDimitry Andric  The first argument is the <tt>this</tt> pointer.
16310b57cec5SDimitry Andric */
16320b57cec5SDimitry Andric typedef void *(*kmpc_cctor)(void *, void *);
16330b57cec5SDimitry Andric 
16340b57cec5SDimitry Andric /* for array objects: __kmpc_threadprivate_register_vec() */
16350b57cec5SDimitry Andric /* First arg: "this" pointer */
16360b57cec5SDimitry Andric /* Last arg: number of array elements */
16370b57cec5SDimitry Andric /*!
16380b57cec5SDimitry Andric  Array constructor.
16390b57cec5SDimitry Andric  First argument is the <tt>this</tt> pointer
16400b57cec5SDimitry Andric  Second argument the number of array elements.
16410b57cec5SDimitry Andric */
16420b57cec5SDimitry Andric typedef void *(*kmpc_ctor_vec)(void *, size_t);
16430b57cec5SDimitry Andric /*!
16440b57cec5SDimitry Andric  Pointer to the array destructor function.
16450b57cec5SDimitry Andric  The first argument is the <tt>this</tt> pointer
16460b57cec5SDimitry Andric  Second argument the number of array elements.
16470b57cec5SDimitry Andric */
16480b57cec5SDimitry Andric typedef void (*kmpc_dtor_vec)(void *, size_t);
16490b57cec5SDimitry Andric /*!
16500b57cec5SDimitry Andric  Array constructor.
16510b57cec5SDimitry Andric  First argument is the <tt>this</tt> pointer
16520b57cec5SDimitry Andric  Third argument the number of array elements.
16530b57cec5SDimitry Andric */
16540b57cec5SDimitry Andric typedef void *(*kmpc_cctor_vec)(void *, void *,
16550b57cec5SDimitry Andric                                 size_t); /* function unused by compiler */
16560b57cec5SDimitry Andric 
16570b57cec5SDimitry Andric /*!
16580b57cec5SDimitry Andric @}
16590b57cec5SDimitry Andric */
16600b57cec5SDimitry Andric 
16610b57cec5SDimitry Andric /* keeps tracked of threadprivate cache allocations for cleanup later */
16620b57cec5SDimitry Andric typedef struct kmp_cached_addr {
16630b57cec5SDimitry Andric   void **addr; /* address of allocated cache */
16640b57cec5SDimitry Andric   void ***compiler_cache; /* pointer to compiler's cache */
16650b57cec5SDimitry Andric   void *data; /* pointer to global data */
16660b57cec5SDimitry Andric   struct kmp_cached_addr *next; /* pointer to next cached address */
16670b57cec5SDimitry Andric } kmp_cached_addr_t;
16680b57cec5SDimitry Andric 
16690b57cec5SDimitry Andric struct private_data {
16700b57cec5SDimitry Andric   struct private_data *next; /* The next descriptor in the list      */
16710b57cec5SDimitry Andric   void *data; /* The data buffer for this descriptor  */
16720b57cec5SDimitry Andric   int more; /* The repeat count for this descriptor */
16730b57cec5SDimitry Andric   size_t size; /* The data size for this descriptor    */
16740b57cec5SDimitry Andric };
16750b57cec5SDimitry Andric 
16760b57cec5SDimitry Andric struct private_common {
16770b57cec5SDimitry Andric   struct private_common *next;
16780b57cec5SDimitry Andric   struct private_common *link;
16790b57cec5SDimitry Andric   void *gbl_addr;
1680fe6060f1SDimitry Andric   void *par_addr; /* par_addr == gbl_addr for PRIMARY thread */
16810b57cec5SDimitry Andric   size_t cmn_size;
16820b57cec5SDimitry Andric };
16830b57cec5SDimitry Andric 
16840b57cec5SDimitry Andric struct shared_common {
16850b57cec5SDimitry Andric   struct shared_common *next;
16860b57cec5SDimitry Andric   struct private_data *pod_init;
16870b57cec5SDimitry Andric   void *obj_init;
16880b57cec5SDimitry Andric   void *gbl_addr;
16890b57cec5SDimitry Andric   union {
16900b57cec5SDimitry Andric     kmpc_ctor ctor;
16910b57cec5SDimitry Andric     kmpc_ctor_vec ctorv;
16920b57cec5SDimitry Andric   } ct;
16930b57cec5SDimitry Andric   union {
16940b57cec5SDimitry Andric     kmpc_cctor cctor;
16950b57cec5SDimitry Andric     kmpc_cctor_vec cctorv;
16960b57cec5SDimitry Andric   } cct;
16970b57cec5SDimitry Andric   union {
16980b57cec5SDimitry Andric     kmpc_dtor dtor;
16990b57cec5SDimitry Andric     kmpc_dtor_vec dtorv;
17000b57cec5SDimitry Andric   } dt;
17010b57cec5SDimitry Andric   size_t vec_len;
17020b57cec5SDimitry Andric   int is_vec;
17030b57cec5SDimitry Andric   size_t cmn_size;
17040b57cec5SDimitry Andric };
17050b57cec5SDimitry Andric 
17060b57cec5SDimitry Andric #define KMP_HASH_TABLE_LOG2 9 /* log2 of the hash table size */
17070b57cec5SDimitry Andric #define KMP_HASH_TABLE_SIZE                                                    \
17080b57cec5SDimitry Andric   (1 << KMP_HASH_TABLE_LOG2) /* size of the hash table */
17090b57cec5SDimitry Andric #define KMP_HASH_SHIFT 3 /* throw away this many low bits from the address */
17100b57cec5SDimitry Andric #define KMP_HASH(x)                                                            \
17110b57cec5SDimitry Andric   ((((kmp_uintptr_t)x) >> KMP_HASH_SHIFT) & (KMP_HASH_TABLE_SIZE - 1))
17120b57cec5SDimitry Andric 
17130b57cec5SDimitry Andric struct common_table {
17140b57cec5SDimitry Andric   struct private_common *data[KMP_HASH_TABLE_SIZE];
17150b57cec5SDimitry Andric };
17160b57cec5SDimitry Andric 
17170b57cec5SDimitry Andric struct shared_table {
17180b57cec5SDimitry Andric   struct shared_common *data[KMP_HASH_TABLE_SIZE];
17190b57cec5SDimitry Andric };
17200b57cec5SDimitry Andric 
17210b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
17220b57cec5SDimitry Andric 
17230b57cec5SDimitry Andric #if KMP_USE_HIER_SCHED
17240b57cec5SDimitry Andric // Shared barrier data that exists inside a single unit of the scheduling
17250b57cec5SDimitry Andric // hierarchy
17260b57cec5SDimitry Andric typedef struct kmp_hier_private_bdata_t {
17270b57cec5SDimitry Andric   kmp_int32 num_active;
17280b57cec5SDimitry Andric   kmp_uint64 index;
17290b57cec5SDimitry Andric   kmp_uint64 wait_val[2];
17300b57cec5SDimitry Andric } kmp_hier_private_bdata_t;
17310b57cec5SDimitry Andric #endif
17320b57cec5SDimitry Andric 
17330b57cec5SDimitry Andric typedef struct kmp_sched_flags {
17340b57cec5SDimitry Andric   unsigned ordered : 1;
17350b57cec5SDimitry Andric   unsigned nomerge : 1;
17360b57cec5SDimitry Andric   unsigned contains_last : 1;
17370b57cec5SDimitry Andric #if KMP_USE_HIER_SCHED
17380b57cec5SDimitry Andric   unsigned use_hier : 1;
17390b57cec5SDimitry Andric   unsigned unused : 28;
17400b57cec5SDimitry Andric #else
17410b57cec5SDimitry Andric   unsigned unused : 29;
17420b57cec5SDimitry Andric #endif
17430b57cec5SDimitry Andric } kmp_sched_flags_t;
17440b57cec5SDimitry Andric 
17450b57cec5SDimitry Andric KMP_BUILD_ASSERT(sizeof(kmp_sched_flags_t) == 4);
17460b57cec5SDimitry Andric 
17470b57cec5SDimitry Andric #if KMP_STATIC_STEAL_ENABLED
17480b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE dispatch_private_info32 {
17490b57cec5SDimitry Andric   kmp_int32 count;
17500b57cec5SDimitry Andric   kmp_int32 ub;
17510b57cec5SDimitry Andric   /* Adding KMP_ALIGN_CACHE here doesn't help / can hurt performance */
17520b57cec5SDimitry Andric   kmp_int32 lb;
17530b57cec5SDimitry Andric   kmp_int32 st;
17540b57cec5SDimitry Andric   kmp_int32 tc;
1755fe6060f1SDimitry Andric   kmp_lock_t *steal_lock; // lock used for chunk stealing
1756fe6060f1SDimitry Andric   // KMP_ALIGN(32) ensures (if the KMP_ALIGN macro is turned on)
17570b57cec5SDimitry Andric   //    a) parm3 is properly aligned and
1758fe6060f1SDimitry Andric   //    b) all parm1-4 are on the same cache line.
17590b57cec5SDimitry Andric   // Because of parm1-4 are used together, performance seems to be better
1760fe6060f1SDimitry Andric   // if they are on the same cache line (not measured though).
17610b57cec5SDimitry Andric 
17620b57cec5SDimitry Andric   struct KMP_ALIGN(32) { // AC: changed 16 to 32 in order to simplify template
17630b57cec5SDimitry Andric     kmp_int32 parm1; //     structures in kmp_dispatch.cpp. This should
17640b57cec5SDimitry Andric     kmp_int32 parm2; //     make no real change at least while padding is off.
17650b57cec5SDimitry Andric     kmp_int32 parm3;
17660b57cec5SDimitry Andric     kmp_int32 parm4;
17670b57cec5SDimitry Andric   };
17680b57cec5SDimitry Andric 
17690b57cec5SDimitry Andric   kmp_uint32 ordered_lower;
17700b57cec5SDimitry Andric   kmp_uint32 ordered_upper;
17710b57cec5SDimitry Andric #if KMP_OS_WINDOWS
17720b57cec5SDimitry Andric   kmp_int32 last_upper;
17730b57cec5SDimitry Andric #endif /* KMP_OS_WINDOWS */
17740b57cec5SDimitry Andric } dispatch_private_info32_t;
17750b57cec5SDimitry Andric 
17760b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE dispatch_private_info64 {
17770b57cec5SDimitry Andric   kmp_int64 count; // current chunk number for static & static-steal scheduling
17780b57cec5SDimitry Andric   kmp_int64 ub; /* upper-bound */
17790b57cec5SDimitry Andric   /* Adding KMP_ALIGN_CACHE here doesn't help / can hurt performance */
17800b57cec5SDimitry Andric   kmp_int64 lb; /* lower-bound */
17810b57cec5SDimitry Andric   kmp_int64 st; /* stride */
17820b57cec5SDimitry Andric   kmp_int64 tc; /* trip count (number of iterations) */
1783fe6060f1SDimitry Andric   kmp_lock_t *steal_lock; // lock used for chunk stealing
17840b57cec5SDimitry Andric   /* parm[1-4] are used in different ways by different scheduling algorithms */
17850b57cec5SDimitry Andric 
17860b57cec5SDimitry Andric   // KMP_ALIGN( 32 ) ensures ( if the KMP_ALIGN macro is turned on )
17870b57cec5SDimitry Andric   //    a) parm3 is properly aligned and
17880b57cec5SDimitry Andric   //    b) all parm1-4 are in the same cache line.
17890b57cec5SDimitry Andric   // Because of parm1-4 are used together, performance seems to be better
17900b57cec5SDimitry Andric   // if they are in the same line (not measured though).
17910b57cec5SDimitry Andric 
17920b57cec5SDimitry Andric   struct KMP_ALIGN(32) {
17930b57cec5SDimitry Andric     kmp_int64 parm1;
17940b57cec5SDimitry Andric     kmp_int64 parm2;
17950b57cec5SDimitry Andric     kmp_int64 parm3;
17960b57cec5SDimitry Andric     kmp_int64 parm4;
17970b57cec5SDimitry Andric   };
17980b57cec5SDimitry Andric 
17990b57cec5SDimitry Andric   kmp_uint64 ordered_lower;
18000b57cec5SDimitry Andric   kmp_uint64 ordered_upper;
18010b57cec5SDimitry Andric #if KMP_OS_WINDOWS
18020b57cec5SDimitry Andric   kmp_int64 last_upper;
18030b57cec5SDimitry Andric #endif /* KMP_OS_WINDOWS */
18040b57cec5SDimitry Andric } dispatch_private_info64_t;
18050b57cec5SDimitry Andric #else /* KMP_STATIC_STEAL_ENABLED */
18060b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE dispatch_private_info32 {
18070b57cec5SDimitry Andric   kmp_int32 lb;
18080b57cec5SDimitry Andric   kmp_int32 ub;
18090b57cec5SDimitry Andric   kmp_int32 st;
18100b57cec5SDimitry Andric   kmp_int32 tc;
18110b57cec5SDimitry Andric 
18120b57cec5SDimitry Andric   kmp_int32 parm1;
18130b57cec5SDimitry Andric   kmp_int32 parm2;
18140b57cec5SDimitry Andric   kmp_int32 parm3;
18150b57cec5SDimitry Andric   kmp_int32 parm4;
18160b57cec5SDimitry Andric 
18170b57cec5SDimitry Andric   kmp_int32 count;
18180b57cec5SDimitry Andric 
18190b57cec5SDimitry Andric   kmp_uint32 ordered_lower;
18200b57cec5SDimitry Andric   kmp_uint32 ordered_upper;
18210b57cec5SDimitry Andric #if KMP_OS_WINDOWS
18220b57cec5SDimitry Andric   kmp_int32 last_upper;
18230b57cec5SDimitry Andric #endif /* KMP_OS_WINDOWS */
18240b57cec5SDimitry Andric } dispatch_private_info32_t;
18250b57cec5SDimitry Andric 
18260b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE dispatch_private_info64 {
18270b57cec5SDimitry Andric   kmp_int64 lb; /* lower-bound */
18280b57cec5SDimitry Andric   kmp_int64 ub; /* upper-bound */
18290b57cec5SDimitry Andric   kmp_int64 st; /* stride */
18300b57cec5SDimitry Andric   kmp_int64 tc; /* trip count (number of iterations) */
18310b57cec5SDimitry Andric 
18320b57cec5SDimitry Andric   /* parm[1-4] are used in different ways by different scheduling algorithms */
18330b57cec5SDimitry Andric   kmp_int64 parm1;
18340b57cec5SDimitry Andric   kmp_int64 parm2;
18350b57cec5SDimitry Andric   kmp_int64 parm3;
18360b57cec5SDimitry Andric   kmp_int64 parm4;
18370b57cec5SDimitry Andric 
18380b57cec5SDimitry Andric   kmp_int64 count; /* current chunk number for static scheduling */
18390b57cec5SDimitry Andric 
18400b57cec5SDimitry Andric   kmp_uint64 ordered_lower;
18410b57cec5SDimitry Andric   kmp_uint64 ordered_upper;
18420b57cec5SDimitry Andric #if KMP_OS_WINDOWS
18430b57cec5SDimitry Andric   kmp_int64 last_upper;
18440b57cec5SDimitry Andric #endif /* KMP_OS_WINDOWS */
18450b57cec5SDimitry Andric } dispatch_private_info64_t;
18460b57cec5SDimitry Andric #endif /* KMP_STATIC_STEAL_ENABLED */
18470b57cec5SDimitry Andric 
18480b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE dispatch_private_info {
18490b57cec5SDimitry Andric   union private_info {
18500b57cec5SDimitry Andric     dispatch_private_info32_t p32;
18510b57cec5SDimitry Andric     dispatch_private_info64_t p64;
18520b57cec5SDimitry Andric   } u;
18530b57cec5SDimitry Andric   enum sched_type schedule; /* scheduling algorithm */
18540b57cec5SDimitry Andric   kmp_sched_flags_t flags; /* flags (e.g., ordered, nomerge, etc.) */
1855fe6060f1SDimitry Andric   std::atomic<kmp_uint32> steal_flag; // static_steal only, state of a buffer
18560b57cec5SDimitry Andric   kmp_int32 ordered_bumped;
18570b57cec5SDimitry Andric   // Stack of buffers for nest of serial regions
18580b57cec5SDimitry Andric   struct dispatch_private_info *next;
18590b57cec5SDimitry Andric   kmp_int32 type_size; /* the size of types in private_info */
18600b57cec5SDimitry Andric #if KMP_USE_HIER_SCHED
18610b57cec5SDimitry Andric   kmp_int32 hier_id;
18620b57cec5SDimitry Andric   void *parent; /* hierarchical scheduling parent pointer */
18630b57cec5SDimitry Andric #endif
18640b57cec5SDimitry Andric   enum cons_type pushed_ws;
18650b57cec5SDimitry Andric } dispatch_private_info_t;
18660b57cec5SDimitry Andric 
18670b57cec5SDimitry Andric typedef struct dispatch_shared_info32 {
18680b57cec5SDimitry Andric   /* chunk index under dynamic, number of idle threads under static-steal;
18690b57cec5SDimitry Andric      iteration index otherwise */
18700b57cec5SDimitry Andric   volatile kmp_uint32 iteration;
1871fe6060f1SDimitry Andric   volatile kmp_int32 num_done;
18720b57cec5SDimitry Andric   volatile kmp_uint32 ordered_iteration;
18730b57cec5SDimitry Andric   // Dummy to retain the structure size after making ordered_iteration scalar
18740b57cec5SDimitry Andric   kmp_int32 ordered_dummy[KMP_MAX_ORDERED - 1];
18750b57cec5SDimitry Andric } dispatch_shared_info32_t;
18760b57cec5SDimitry Andric 
18770b57cec5SDimitry Andric typedef struct dispatch_shared_info64 {
18780b57cec5SDimitry Andric   /* chunk index under dynamic, number of idle threads under static-steal;
18790b57cec5SDimitry Andric      iteration index otherwise */
18800b57cec5SDimitry Andric   volatile kmp_uint64 iteration;
1881fe6060f1SDimitry Andric   volatile kmp_int64 num_done;
18820b57cec5SDimitry Andric   volatile kmp_uint64 ordered_iteration;
18830b57cec5SDimitry Andric   // Dummy to retain the structure size after making ordered_iteration scalar
18840b57cec5SDimitry Andric   kmp_int64 ordered_dummy[KMP_MAX_ORDERED - 3];
18850b57cec5SDimitry Andric } dispatch_shared_info64_t;
18860b57cec5SDimitry Andric 
18870b57cec5SDimitry Andric typedef struct dispatch_shared_info {
18880b57cec5SDimitry Andric   union shared_info {
18890b57cec5SDimitry Andric     dispatch_shared_info32_t s32;
18900b57cec5SDimitry Andric     dispatch_shared_info64_t s64;
18910b57cec5SDimitry Andric   } u;
18920b57cec5SDimitry Andric   volatile kmp_uint32 buffer_index;
18930b57cec5SDimitry Andric   volatile kmp_int32 doacross_buf_idx; // teamwise index
18940b57cec5SDimitry Andric   volatile kmp_uint32 *doacross_flags; // shared array of iteration flags (0/1)
18950b57cec5SDimitry Andric   kmp_int32 doacross_num_done; // count finished threads
18960b57cec5SDimitry Andric #if KMP_USE_HIER_SCHED
18970b57cec5SDimitry Andric   void *hier;
18980b57cec5SDimitry Andric #endif
18990b57cec5SDimitry Andric #if KMP_USE_HWLOC
19000b57cec5SDimitry Andric   // When linking with libhwloc, the ORDERED EPCC test slows down on big
19010b57cec5SDimitry Andric   // machines (> 48 cores). Performance analysis showed that a cache thrash
19020b57cec5SDimitry Andric   // was occurring and this padding helps alleviate the problem.
19030b57cec5SDimitry Andric   char padding[64];
19040b57cec5SDimitry Andric #endif
19050b57cec5SDimitry Andric } dispatch_shared_info_t;
19060b57cec5SDimitry Andric 
19070b57cec5SDimitry Andric typedef struct kmp_disp {
19080b57cec5SDimitry Andric   /* Vector for ORDERED SECTION */
19090b57cec5SDimitry Andric   void (*th_deo_fcn)(int *gtid, int *cid, ident_t *);
19100b57cec5SDimitry Andric   /* Vector for END ORDERED SECTION */
19110b57cec5SDimitry Andric   void (*th_dxo_fcn)(int *gtid, int *cid, ident_t *);
19120b57cec5SDimitry Andric 
19130b57cec5SDimitry Andric   dispatch_shared_info_t *th_dispatch_sh_current;
19140b57cec5SDimitry Andric   dispatch_private_info_t *th_dispatch_pr_current;
19150b57cec5SDimitry Andric 
19160b57cec5SDimitry Andric   dispatch_private_info_t *th_disp_buffer;
1917fe6060f1SDimitry Andric   kmp_uint32 th_disp_index;
19180b57cec5SDimitry Andric   kmp_int32 th_doacross_buf_idx; // thread's doacross buffer index
19190b57cec5SDimitry Andric   volatile kmp_uint32 *th_doacross_flags; // pointer to shared array of flags
19200b57cec5SDimitry Andric   kmp_int64 *th_doacross_info; // info on loop bounds
19210b57cec5SDimitry Andric #if KMP_USE_INTERNODE_ALIGNMENT
19220b57cec5SDimitry Andric   char more_padding[INTERNODE_CACHE_LINE];
19230b57cec5SDimitry Andric #endif
19240b57cec5SDimitry Andric } kmp_disp_t;
19250b57cec5SDimitry Andric 
19260b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
19270b57cec5SDimitry Andric /* Barrier stuff */
19280b57cec5SDimitry Andric 
19290b57cec5SDimitry Andric /* constants for barrier state update */
19300b57cec5SDimitry Andric #define KMP_INIT_BARRIER_STATE 0 /* should probably start from zero */
19310b57cec5SDimitry Andric #define KMP_BARRIER_SLEEP_BIT 0 /* bit used for suspend/sleep part of state */
19320b57cec5SDimitry Andric #define KMP_BARRIER_UNUSED_BIT 1 // bit that must never be set for valid state
19330b57cec5SDimitry Andric #define KMP_BARRIER_BUMP_BIT 2 /* lsb used for bump of go/arrived state */
19340b57cec5SDimitry Andric 
19350b57cec5SDimitry Andric #define KMP_BARRIER_SLEEP_STATE (1 << KMP_BARRIER_SLEEP_BIT)
19360b57cec5SDimitry Andric #define KMP_BARRIER_UNUSED_STATE (1 << KMP_BARRIER_UNUSED_BIT)
19370b57cec5SDimitry Andric #define KMP_BARRIER_STATE_BUMP (1 << KMP_BARRIER_BUMP_BIT)
19380b57cec5SDimitry Andric 
19390b57cec5SDimitry Andric #if (KMP_BARRIER_SLEEP_BIT >= KMP_BARRIER_BUMP_BIT)
19400b57cec5SDimitry Andric #error "Barrier sleep bit must be smaller than barrier bump bit"
19410b57cec5SDimitry Andric #endif
19420b57cec5SDimitry Andric #if (KMP_BARRIER_UNUSED_BIT >= KMP_BARRIER_BUMP_BIT)
19430b57cec5SDimitry Andric #error "Barrier unused bit must be smaller than barrier bump bit"
19440b57cec5SDimitry Andric #endif
19450b57cec5SDimitry Andric 
19460b57cec5SDimitry Andric // Constants for release barrier wait state: currently, hierarchical only
19470b57cec5SDimitry Andric #define KMP_BARRIER_NOT_WAITING 0 // Normal state; worker not in wait_sleep
19480b57cec5SDimitry Andric #define KMP_BARRIER_OWN_FLAG                                                   \
19490b57cec5SDimitry Andric   1 // Normal state; worker waiting on own b_go flag in release
19500b57cec5SDimitry Andric #define KMP_BARRIER_PARENT_FLAG                                                \
19510b57cec5SDimitry Andric   2 // Special state; worker waiting on parent's b_go flag in release
19520b57cec5SDimitry Andric #define KMP_BARRIER_SWITCH_TO_OWN_FLAG                                         \
19530b57cec5SDimitry Andric   3 // Special state; tells worker to shift from parent to own b_go
19540b57cec5SDimitry Andric #define KMP_BARRIER_SWITCHING                                                  \
19550b57cec5SDimitry Andric   4 // Special state; worker resets appropriate flag on wake-up
19560b57cec5SDimitry Andric 
19570b57cec5SDimitry Andric #define KMP_NOT_SAFE_TO_REAP                                                   \
19580b57cec5SDimitry Andric   0 // Thread th_reap_state: not safe to reap (tasking)
19590b57cec5SDimitry Andric #define KMP_SAFE_TO_REAP 1 // Thread th_reap_state: safe to reap (not tasking)
19600b57cec5SDimitry Andric 
1961349cc55cSDimitry Andric // The flag_type describes the storage used for the flag.
1962349cc55cSDimitry Andric enum flag_type {
1963349cc55cSDimitry Andric   flag32, /**< atomic 32 bit flags */
1964349cc55cSDimitry Andric   flag64, /**< 64 bit flags */
1965349cc55cSDimitry Andric   atomic_flag64, /**< atomic 64 bit flags */
1966349cc55cSDimitry Andric   flag_oncore, /**< special 64-bit flag for on-core barrier (hierarchical) */
1967349cc55cSDimitry Andric   flag_unset
1968349cc55cSDimitry Andric };
1969349cc55cSDimitry Andric 
19700b57cec5SDimitry Andric enum barrier_type {
19710b57cec5SDimitry Andric   bs_plain_barrier = 0, /* 0, All non-fork/join barriers (except reduction
19720b57cec5SDimitry Andric                            barriers if enabled) */
19730b57cec5SDimitry Andric   bs_forkjoin_barrier, /* 1, All fork/join (parallel region) barriers */
19740b57cec5SDimitry Andric #if KMP_FAST_REDUCTION_BARRIER
19750b57cec5SDimitry Andric   bs_reduction_barrier, /* 2, All barriers that are used in reduction */
19760b57cec5SDimitry Andric #endif // KMP_FAST_REDUCTION_BARRIER
19770b57cec5SDimitry Andric   bs_last_barrier /* Just a placeholder to mark the end */
19780b57cec5SDimitry Andric };
19790b57cec5SDimitry Andric 
19800b57cec5SDimitry Andric // to work with reduction barriers just like with plain barriers
19810b57cec5SDimitry Andric #if !KMP_FAST_REDUCTION_BARRIER
19820b57cec5SDimitry Andric #define bs_reduction_barrier bs_plain_barrier
19830b57cec5SDimitry Andric #endif // KMP_FAST_REDUCTION_BARRIER
19840b57cec5SDimitry Andric 
19850b57cec5SDimitry Andric typedef enum kmp_bar_pat { /* Barrier communication patterns */
19860b57cec5SDimitry Andric                            bp_linear_bar =
19870b57cec5SDimitry Andric                                0, /* Single level (degenerate) tree */
19880b57cec5SDimitry Andric                            bp_tree_bar =
19890b57cec5SDimitry Andric                                1, /* Balanced tree with branching factor 2^n */
1990fe6060f1SDimitry Andric                            bp_hyper_bar = 2, /* Hypercube-embedded tree with min
1991fe6060f1SDimitry Andric                                                 branching factor 2^n */
19920b57cec5SDimitry Andric                            bp_hierarchical_bar = 3, /* Machine hierarchy tree */
1993349cc55cSDimitry Andric                            bp_dist_bar = 4, /* Distributed barrier */
19940b57cec5SDimitry Andric                            bp_last_bar /* Placeholder to mark the end */
19950b57cec5SDimitry Andric } kmp_bar_pat_e;
19960b57cec5SDimitry Andric 
19970b57cec5SDimitry Andric #define KMP_BARRIER_ICV_PUSH 1
19980b57cec5SDimitry Andric 
19990b57cec5SDimitry Andric /* Record for holding the values of the internal controls stack records */
20000b57cec5SDimitry Andric typedef struct kmp_internal_control {
20010b57cec5SDimitry Andric   int serial_nesting_level; /* corresponds to the value of the
20020b57cec5SDimitry Andric                                th_team_serialized field */
20030b57cec5SDimitry Andric   kmp_int8 dynamic; /* internal control for dynamic adjustment of threads (per
20040b57cec5SDimitry Andric                        thread) */
20050b57cec5SDimitry Andric   kmp_int8
20060b57cec5SDimitry Andric       bt_set; /* internal control for whether blocktime is explicitly set */
20070b57cec5SDimitry Andric   int blocktime; /* internal control for blocktime */
20080b57cec5SDimitry Andric #if KMP_USE_MONITOR
20090b57cec5SDimitry Andric   int bt_intervals; /* internal control for blocktime intervals */
20100b57cec5SDimitry Andric #endif
20110b57cec5SDimitry Andric   int nproc; /* internal control for #threads for next parallel region (per
20120b57cec5SDimitry Andric                 thread) */
20130b57cec5SDimitry Andric   int thread_limit; /* internal control for thread-limit-var */
20140b57cec5SDimitry Andric   int max_active_levels; /* internal control for max_active_levels */
20150b57cec5SDimitry Andric   kmp_r_sched_t
20160b57cec5SDimitry Andric       sched; /* internal control for runtime schedule {sched,chunk} pair */
20170b57cec5SDimitry Andric   kmp_proc_bind_t proc_bind; /* internal control for affinity  */
20180b57cec5SDimitry Andric   kmp_int32 default_device; /* internal control for default device */
20190b57cec5SDimitry Andric   struct kmp_internal_control *next;
20200b57cec5SDimitry Andric } kmp_internal_control_t;
20210b57cec5SDimitry Andric 
20220b57cec5SDimitry Andric static inline void copy_icvs(kmp_internal_control_t *dst,
20230b57cec5SDimitry Andric                              kmp_internal_control_t *src) {
20240b57cec5SDimitry Andric   *dst = *src;
20250b57cec5SDimitry Andric }
20260b57cec5SDimitry Andric 
20270b57cec5SDimitry Andric /* Thread barrier needs volatile barrier fields */
20280b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE kmp_bstate {
20290b57cec5SDimitry Andric   // th_fixed_icvs is aligned by virtue of kmp_bstate being aligned (and all
20300b57cec5SDimitry Andric   // uses of it). It is not explicitly aligned below, because we *don't* want
20310b57cec5SDimitry Andric   // it to be padded -- instead, we fit b_go into the same cache line with
20320b57cec5SDimitry Andric   // th_fixed_icvs, enabling NGO cache lines stores in the hierarchical barrier.
20330b57cec5SDimitry Andric   kmp_internal_control_t th_fixed_icvs; // Initial ICVs for the thread
20340b57cec5SDimitry Andric   // Tuck b_go into end of th_fixed_icvs cache line, so it can be stored with
20350b57cec5SDimitry Andric   // same NGO store
20360b57cec5SDimitry Andric   volatile kmp_uint64 b_go; // STATE => task should proceed (hierarchical)
20370b57cec5SDimitry Andric   KMP_ALIGN_CACHE volatile kmp_uint64
20380b57cec5SDimitry Andric       b_arrived; // STATE => task reached synch point.
20390b57cec5SDimitry Andric   kmp_uint32 *skip_per_level;
20400b57cec5SDimitry Andric   kmp_uint32 my_level;
20410b57cec5SDimitry Andric   kmp_int32 parent_tid;
20420b57cec5SDimitry Andric   kmp_int32 old_tid;
20430b57cec5SDimitry Andric   kmp_uint32 depth;
20440b57cec5SDimitry Andric   struct kmp_bstate *parent_bar;
20450b57cec5SDimitry Andric   kmp_team_t *team;
20460b57cec5SDimitry Andric   kmp_uint64 leaf_state;
20470b57cec5SDimitry Andric   kmp_uint32 nproc;
20480b57cec5SDimitry Andric   kmp_uint8 base_leaf_kids;
20490b57cec5SDimitry Andric   kmp_uint8 leaf_kids;
20500b57cec5SDimitry Andric   kmp_uint8 offset;
20510b57cec5SDimitry Andric   kmp_uint8 wait_flag;
20520b57cec5SDimitry Andric   kmp_uint8 use_oncore_barrier;
20530b57cec5SDimitry Andric #if USE_DEBUGGER
20540b57cec5SDimitry Andric   // The following field is intended for the debugger solely. Only the worker
20550b57cec5SDimitry Andric   // thread itself accesses this field: the worker increases it by 1 when it
20560b57cec5SDimitry Andric   // arrives to a barrier.
20570b57cec5SDimitry Andric   KMP_ALIGN_CACHE kmp_uint b_worker_arrived;
20580b57cec5SDimitry Andric #endif /* USE_DEBUGGER */
20590b57cec5SDimitry Andric } kmp_bstate_t;
20600b57cec5SDimitry Andric 
20610b57cec5SDimitry Andric union KMP_ALIGN_CACHE kmp_barrier_union {
20620b57cec5SDimitry Andric   double b_align; /* use worst case alignment */
20630b57cec5SDimitry Andric   char b_pad[KMP_PAD(kmp_bstate_t, CACHE_LINE)];
20640b57cec5SDimitry Andric   kmp_bstate_t bb;
20650b57cec5SDimitry Andric };
20660b57cec5SDimitry Andric 
20670b57cec5SDimitry Andric typedef union kmp_barrier_union kmp_balign_t;
20680b57cec5SDimitry Andric 
20690b57cec5SDimitry Andric /* Team barrier needs only non-volatile arrived counter */
20700b57cec5SDimitry Andric union KMP_ALIGN_CACHE kmp_barrier_team_union {
20710b57cec5SDimitry Andric   double b_align; /* use worst case alignment */
20720b57cec5SDimitry Andric   char b_pad[CACHE_LINE];
20730b57cec5SDimitry Andric   struct {
20740b57cec5SDimitry Andric     kmp_uint64 b_arrived; /* STATE => task reached synch point. */
20750b57cec5SDimitry Andric #if USE_DEBUGGER
20760b57cec5SDimitry Andric     // The following two fields are indended for the debugger solely. Only
2077fe6060f1SDimitry Andric     // primary thread of the team accesses these fields: the first one is
2078fe6060f1SDimitry Andric     // increased by 1 when the primary thread arrives to a barrier, the second
2079fe6060f1SDimitry Andric     // one is increased by one when all the threads arrived.
20800b57cec5SDimitry Andric     kmp_uint b_master_arrived;
20810b57cec5SDimitry Andric     kmp_uint b_team_arrived;
20820b57cec5SDimitry Andric #endif
20830b57cec5SDimitry Andric   };
20840b57cec5SDimitry Andric };
20850b57cec5SDimitry Andric 
20860b57cec5SDimitry Andric typedef union kmp_barrier_team_union kmp_balign_team_t;
20870b57cec5SDimitry Andric 
20880b57cec5SDimitry Andric /* Padding for Linux* OS pthreads condition variables and mutexes used to signal
20890b57cec5SDimitry Andric    threads when a condition changes.  This is to workaround an NPTL bug where
20900b57cec5SDimitry Andric    padding was added to pthread_cond_t which caused the initialization routine
20910b57cec5SDimitry Andric    to write outside of the structure if compiled on pre-NPTL threads.  */
20920b57cec5SDimitry Andric #if KMP_OS_WINDOWS
20930b57cec5SDimitry Andric typedef struct kmp_win32_mutex {
20940b57cec5SDimitry Andric   /* The Lock */
20950b57cec5SDimitry Andric   CRITICAL_SECTION cs;
20960b57cec5SDimitry Andric } kmp_win32_mutex_t;
20970b57cec5SDimitry Andric 
20980b57cec5SDimitry Andric typedef struct kmp_win32_cond {
20990b57cec5SDimitry Andric   /* Count of the number of waiters. */
21000b57cec5SDimitry Andric   int waiters_count_;
21010b57cec5SDimitry Andric 
21020b57cec5SDimitry Andric   /* Serialize access to <waiters_count_> */
21030b57cec5SDimitry Andric   kmp_win32_mutex_t waiters_count_lock_;
21040b57cec5SDimitry Andric 
21050b57cec5SDimitry Andric   /* Number of threads to release via a <cond_broadcast> or a <cond_signal> */
21060b57cec5SDimitry Andric   int release_count_;
21070b57cec5SDimitry Andric 
21080b57cec5SDimitry Andric   /* Keeps track of the current "generation" so that we don't allow */
21090b57cec5SDimitry Andric   /* one thread to steal all the "releases" from the broadcast. */
21100b57cec5SDimitry Andric   int wait_generation_count_;
21110b57cec5SDimitry Andric 
21120b57cec5SDimitry Andric   /* A manual-reset event that's used to block and release waiting threads. */
21130b57cec5SDimitry Andric   HANDLE event_;
21140b57cec5SDimitry Andric } kmp_win32_cond_t;
21150b57cec5SDimitry Andric #endif
21160b57cec5SDimitry Andric 
21170b57cec5SDimitry Andric #if KMP_OS_UNIX
21180b57cec5SDimitry Andric 
21190b57cec5SDimitry Andric union KMP_ALIGN_CACHE kmp_cond_union {
21200b57cec5SDimitry Andric   double c_align;
21210b57cec5SDimitry Andric   char c_pad[CACHE_LINE];
21220b57cec5SDimitry Andric   pthread_cond_t c_cond;
21230b57cec5SDimitry Andric };
21240b57cec5SDimitry Andric 
21250b57cec5SDimitry Andric typedef union kmp_cond_union kmp_cond_align_t;
21260b57cec5SDimitry Andric 
21270b57cec5SDimitry Andric union KMP_ALIGN_CACHE kmp_mutex_union {
21280b57cec5SDimitry Andric   double m_align;
21290b57cec5SDimitry Andric   char m_pad[CACHE_LINE];
21300b57cec5SDimitry Andric   pthread_mutex_t m_mutex;
21310b57cec5SDimitry Andric };
21320b57cec5SDimitry Andric 
21330b57cec5SDimitry Andric typedef union kmp_mutex_union kmp_mutex_align_t;
21340b57cec5SDimitry Andric 
21350b57cec5SDimitry Andric #endif /* KMP_OS_UNIX */
21360b57cec5SDimitry Andric 
21370b57cec5SDimitry Andric typedef struct kmp_desc_base {
21380b57cec5SDimitry Andric   void *ds_stackbase;
21390b57cec5SDimitry Andric   size_t ds_stacksize;
21400b57cec5SDimitry Andric   int ds_stackgrow;
21410b57cec5SDimitry Andric   kmp_thread_t ds_thread;
21420b57cec5SDimitry Andric   volatile int ds_tid;
21430b57cec5SDimitry Andric   int ds_gtid;
21440b57cec5SDimitry Andric #if KMP_OS_WINDOWS
21450b57cec5SDimitry Andric   volatile int ds_alive;
21460b57cec5SDimitry Andric   DWORD ds_thread_id;
21470b57cec5SDimitry Andric /* ds_thread keeps thread handle on Windows* OS. It is enough for RTL purposes.
21480b57cec5SDimitry Andric    However, debugger support (libomp_db) cannot work with handles, because they
21490b57cec5SDimitry Andric    uncomparable. For example, debugger requests info about thread with handle h.
21500b57cec5SDimitry Andric    h is valid within debugger process, and meaningless within debugee process.
21510b57cec5SDimitry Andric    Even if h is duped by call to DuplicateHandle(), so the result h' is valid
21520b57cec5SDimitry Andric    within debugee process, but it is a *new* handle which does *not* equal to
21530b57cec5SDimitry Andric    any other handle in debugee... The only way to compare handles is convert
21540b57cec5SDimitry Andric    them to system-wide ids. GetThreadId() function is available only in
21550b57cec5SDimitry Andric    Longhorn and Server 2003. :-( In contrast, GetCurrentThreadId() is available
21560b57cec5SDimitry Andric    on all Windows* OS flavours (including Windows* 95). Thus, we have to get
21570b57cec5SDimitry Andric    thread id by call to GetCurrentThreadId() from within the thread and save it
21580b57cec5SDimitry Andric    to let libomp_db identify threads.  */
21590b57cec5SDimitry Andric #endif /* KMP_OS_WINDOWS */
21600b57cec5SDimitry Andric } kmp_desc_base_t;
21610b57cec5SDimitry Andric 
21620b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_desc {
21630b57cec5SDimitry Andric   double ds_align; /* use worst case alignment */
21640b57cec5SDimitry Andric   char ds_pad[KMP_PAD(kmp_desc_base_t, CACHE_LINE)];
21650b57cec5SDimitry Andric   kmp_desc_base_t ds;
21660b57cec5SDimitry Andric } kmp_desc_t;
21670b57cec5SDimitry Andric 
21680b57cec5SDimitry Andric typedef struct kmp_local {
21690b57cec5SDimitry Andric   volatile int this_construct; /* count of single's encountered by thread */
21700b57cec5SDimitry Andric   void *reduce_data;
21710b57cec5SDimitry Andric #if KMP_USE_BGET
21720b57cec5SDimitry Andric   void *bget_data;
21730b57cec5SDimitry Andric   void *bget_list;
21740b57cec5SDimitry Andric #if !USE_CMP_XCHG_FOR_BGET
21750b57cec5SDimitry Andric #ifdef USE_QUEUING_LOCK_FOR_BGET
21760b57cec5SDimitry Andric   kmp_lock_t bget_lock; /* Lock for accessing bget free list */
21770b57cec5SDimitry Andric #else
21780b57cec5SDimitry Andric   kmp_bootstrap_lock_t bget_lock; // Lock for accessing bget free list. Must be
21790b57cec5SDimitry Andric // bootstrap lock so we can use it at library
21800b57cec5SDimitry Andric // shutdown.
21810b57cec5SDimitry Andric #endif /* USE_LOCK_FOR_BGET */
21820b57cec5SDimitry Andric #endif /* ! USE_CMP_XCHG_FOR_BGET */
21830b57cec5SDimitry Andric #endif /* KMP_USE_BGET */
21840b57cec5SDimitry Andric 
21850b57cec5SDimitry Andric   PACKED_REDUCTION_METHOD_T
21860b57cec5SDimitry Andric   packed_reduction_method; /* stored by __kmpc_reduce*(), used by
21870b57cec5SDimitry Andric                               __kmpc_end_reduce*() */
21880b57cec5SDimitry Andric 
21890b57cec5SDimitry Andric } kmp_local_t;
21900b57cec5SDimitry Andric 
21910b57cec5SDimitry Andric #define KMP_CHECK_UPDATE(a, b)                                                 \
21920b57cec5SDimitry Andric   if ((a) != (b))                                                              \
21930b57cec5SDimitry Andric   (a) = (b)
21940b57cec5SDimitry Andric #define KMP_CHECK_UPDATE_SYNC(a, b)                                            \
21950b57cec5SDimitry Andric   if ((a) != (b))                                                              \
21960b57cec5SDimitry Andric   TCW_SYNC_PTR((a), (b))
21970b57cec5SDimitry Andric 
21980b57cec5SDimitry Andric #define get__blocktime(xteam, xtid)                                            \
21990b57cec5SDimitry Andric   ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.blocktime)
22000b57cec5SDimitry Andric #define get__bt_set(xteam, xtid)                                               \
22010b57cec5SDimitry Andric   ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_set)
22020b57cec5SDimitry Andric #if KMP_USE_MONITOR
22030b57cec5SDimitry Andric #define get__bt_intervals(xteam, xtid)                                         \
22040b57cec5SDimitry Andric   ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_intervals)
22050b57cec5SDimitry Andric #endif
22060b57cec5SDimitry Andric 
22070b57cec5SDimitry Andric #define get__dynamic_2(xteam, xtid)                                            \
22080b57cec5SDimitry Andric   ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.dynamic)
22090b57cec5SDimitry Andric #define get__nproc_2(xteam, xtid)                                              \
22100b57cec5SDimitry Andric   ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.nproc)
22110b57cec5SDimitry Andric #define get__sched_2(xteam, xtid)                                              \
22120b57cec5SDimitry Andric   ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.sched)
22130b57cec5SDimitry Andric 
22140b57cec5SDimitry Andric #define set__blocktime_team(xteam, xtid, xval)                                 \
22150b57cec5SDimitry Andric   (((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.blocktime) =     \
22160b57cec5SDimitry Andric        (xval))
22170b57cec5SDimitry Andric 
22180b57cec5SDimitry Andric #if KMP_USE_MONITOR
22190b57cec5SDimitry Andric #define set__bt_intervals_team(xteam, xtid, xval)                              \
22200b57cec5SDimitry Andric   (((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_intervals) =  \
22210b57cec5SDimitry Andric        (xval))
22220b57cec5SDimitry Andric #endif
22230b57cec5SDimitry Andric 
22240b57cec5SDimitry Andric #define set__bt_set_team(xteam, xtid, xval)                                    \
22250b57cec5SDimitry Andric   (((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_set) = (xval))
22260b57cec5SDimitry Andric 
22270b57cec5SDimitry Andric #define set__dynamic(xthread, xval)                                            \
22280b57cec5SDimitry Andric   (((xthread)->th.th_current_task->td_icvs.dynamic) = (xval))
22290b57cec5SDimitry Andric #define get__dynamic(xthread)                                                  \
22300b57cec5SDimitry Andric   (((xthread)->th.th_current_task->td_icvs.dynamic) ? (FTN_TRUE) : (FTN_FALSE))
22310b57cec5SDimitry Andric 
22320b57cec5SDimitry Andric #define set__nproc(xthread, xval)                                              \
22330b57cec5SDimitry Andric   (((xthread)->th.th_current_task->td_icvs.nproc) = (xval))
22340b57cec5SDimitry Andric 
22350b57cec5SDimitry Andric #define set__thread_limit(xthread, xval)                                       \
22360b57cec5SDimitry Andric   (((xthread)->th.th_current_task->td_icvs.thread_limit) = (xval))
22370b57cec5SDimitry Andric 
22380b57cec5SDimitry Andric #define set__max_active_levels(xthread, xval)                                  \
22390b57cec5SDimitry Andric   (((xthread)->th.th_current_task->td_icvs.max_active_levels) = (xval))
22400b57cec5SDimitry Andric 
22410b57cec5SDimitry Andric #define get__max_active_levels(xthread)                                        \
22420b57cec5SDimitry Andric   ((xthread)->th.th_current_task->td_icvs.max_active_levels)
22430b57cec5SDimitry Andric 
22440b57cec5SDimitry Andric #define set__sched(xthread, xval)                                              \
22450b57cec5SDimitry Andric   (((xthread)->th.th_current_task->td_icvs.sched) = (xval))
22460b57cec5SDimitry Andric 
22470b57cec5SDimitry Andric #define set__proc_bind(xthread, xval)                                          \
22480b57cec5SDimitry Andric   (((xthread)->th.th_current_task->td_icvs.proc_bind) = (xval))
22490b57cec5SDimitry Andric #define get__proc_bind(xthread)                                                \
22500b57cec5SDimitry Andric   ((xthread)->th.th_current_task->td_icvs.proc_bind)
22510b57cec5SDimitry Andric 
22520b57cec5SDimitry Andric // OpenMP tasking data structures
22530b57cec5SDimitry Andric 
22540b57cec5SDimitry Andric typedef enum kmp_tasking_mode {
22550b57cec5SDimitry Andric   tskm_immediate_exec = 0,
22560b57cec5SDimitry Andric   tskm_extra_barrier = 1,
22570b57cec5SDimitry Andric   tskm_task_teams = 2,
22580b57cec5SDimitry Andric   tskm_max = 2
22590b57cec5SDimitry Andric } kmp_tasking_mode_t;
22600b57cec5SDimitry Andric 
22610b57cec5SDimitry Andric extern kmp_tasking_mode_t
22620b57cec5SDimitry Andric     __kmp_tasking_mode; /* determines how/when to execute tasks */
22630b57cec5SDimitry Andric extern int __kmp_task_stealing_constraint;
22640b57cec5SDimitry Andric extern int __kmp_enable_task_throttling;
22650b57cec5SDimitry Andric extern kmp_int32 __kmp_default_device; // Set via OMP_DEFAULT_DEVICE if
22660b57cec5SDimitry Andric // specified, defaults to 0 otherwise
22670b57cec5SDimitry Andric // Set via OMP_MAX_TASK_PRIORITY if specified, defaults to 0 otherwise
22680b57cec5SDimitry Andric extern kmp_int32 __kmp_max_task_priority;
22690b57cec5SDimitry Andric // Set via KMP_TASKLOOP_MIN_TASKS if specified, defaults to 0 otherwise
22700b57cec5SDimitry Andric extern kmp_uint64 __kmp_taskloop_min_tasks;
22710b57cec5SDimitry Andric 
22720b57cec5SDimitry Andric /* NOTE: kmp_taskdata_t and kmp_task_t structures allocated in single block with
22730b57cec5SDimitry Andric    taskdata first */
22740b57cec5SDimitry Andric #define KMP_TASK_TO_TASKDATA(task) (((kmp_taskdata_t *)task) - 1)
22750b57cec5SDimitry Andric #define KMP_TASKDATA_TO_TASK(taskdata) (kmp_task_t *)(taskdata + 1)
22760b57cec5SDimitry Andric 
22770b57cec5SDimitry Andric // The tt_found_tasks flag is a signal to all threads in the team that tasks
22780b57cec5SDimitry Andric // were spawned and queued since the previous barrier release.
22790b57cec5SDimitry Andric #define KMP_TASKING_ENABLED(task_team)                                         \
2280e8d8bef9SDimitry Andric   (TRUE == TCR_SYNC_4((task_team)->tt.tt_found_tasks))
22810b57cec5SDimitry Andric /*!
22820b57cec5SDimitry Andric @ingroup BASIC_TYPES
22830b57cec5SDimitry Andric @{
22840b57cec5SDimitry Andric */
22850b57cec5SDimitry Andric 
22860b57cec5SDimitry Andric /*!
22870b57cec5SDimitry Andric  */
22880b57cec5SDimitry Andric typedef kmp_int32 (*kmp_routine_entry_t)(kmp_int32, void *);
22890b57cec5SDimitry Andric 
22900b57cec5SDimitry Andric typedef union kmp_cmplrdata {
22910b57cec5SDimitry Andric   kmp_int32 priority; /**< priority specified by user for the task */
22920b57cec5SDimitry Andric   kmp_routine_entry_t
22930b57cec5SDimitry Andric       destructors; /* pointer to function to invoke deconstructors of
22940b57cec5SDimitry Andric                       firstprivate C++ objects */
22950b57cec5SDimitry Andric   /* future data */
22960b57cec5SDimitry Andric } kmp_cmplrdata_t;
22970b57cec5SDimitry Andric 
22980b57cec5SDimitry Andric /*  sizeof_kmp_task_t passed as arg to kmpc_omp_task call  */
22990b57cec5SDimitry Andric /*!
23000b57cec5SDimitry Andric  */
23010b57cec5SDimitry Andric typedef struct kmp_task { /* GEH: Shouldn't this be aligned somehow? */
23020b57cec5SDimitry Andric   void *shareds; /**< pointer to block of pointers to shared vars   */
23030b57cec5SDimitry Andric   kmp_routine_entry_t
23040b57cec5SDimitry Andric       routine; /**< pointer to routine to call for executing task */
23050b57cec5SDimitry Andric   kmp_int32 part_id; /**< part id for the task                          */
23060b57cec5SDimitry Andric   kmp_cmplrdata_t
23070b57cec5SDimitry Andric       data1; /* Two known optional additions: destructors and priority */
23080b57cec5SDimitry Andric   kmp_cmplrdata_t data2; /* Process destructors first, priority second */
23090b57cec5SDimitry Andric   /* future data */
23100b57cec5SDimitry Andric   /*  private vars  */
23110b57cec5SDimitry Andric } kmp_task_t;
23120b57cec5SDimitry Andric 
23130b57cec5SDimitry Andric /*!
23140b57cec5SDimitry Andric @}
23150b57cec5SDimitry Andric */
23160b57cec5SDimitry Andric 
23170b57cec5SDimitry Andric typedef struct kmp_taskgroup {
23180b57cec5SDimitry Andric   std::atomic<kmp_int32> count; // number of allocated and incomplete tasks
23190b57cec5SDimitry Andric   std::atomic<kmp_int32>
23200b57cec5SDimitry Andric       cancel_request; // request for cancellation of this taskgroup
23210b57cec5SDimitry Andric   struct kmp_taskgroup *parent; // parent taskgroup
23220b57cec5SDimitry Andric   // Block of data to perform task reduction
23230b57cec5SDimitry Andric   void *reduce_data; // reduction related info
23240b57cec5SDimitry Andric   kmp_int32 reduce_num_data; // number of data items to reduce
2325fe6060f1SDimitry Andric   uintptr_t *gomp_data; // gomp reduction data
23260b57cec5SDimitry Andric } kmp_taskgroup_t;
23270b57cec5SDimitry Andric 
23280b57cec5SDimitry Andric // forward declarations
23290b57cec5SDimitry Andric typedef union kmp_depnode kmp_depnode_t;
23300b57cec5SDimitry Andric typedef struct kmp_depnode_list kmp_depnode_list_t;
23310b57cec5SDimitry Andric typedef struct kmp_dephash_entry kmp_dephash_entry_t;
23320b57cec5SDimitry Andric 
2333349cc55cSDimitry Andric // macros for checking dep flag as an integer
2334fe6060f1SDimitry Andric #define KMP_DEP_IN 0x1
2335fe6060f1SDimitry Andric #define KMP_DEP_OUT 0x2
2336fe6060f1SDimitry Andric #define KMP_DEP_INOUT 0x3
2337fe6060f1SDimitry Andric #define KMP_DEP_MTX 0x4
2338fe6060f1SDimitry Andric #define KMP_DEP_SET 0x8
2339349cc55cSDimitry Andric #define KMP_DEP_ALL 0x80
23400b57cec5SDimitry Andric // Compiler sends us this info:
23410b57cec5SDimitry Andric typedef struct kmp_depend_info {
23420b57cec5SDimitry Andric   kmp_intptr_t base_addr;
23430b57cec5SDimitry Andric   size_t len;
2344fe6060f1SDimitry Andric   union {
2345349cc55cSDimitry Andric     kmp_uint8 flag; // flag as an unsigned char
2346349cc55cSDimitry Andric     struct { // flag as a set of 8 bits
2347fe6060f1SDimitry Andric       unsigned in : 1;
2348fe6060f1SDimitry Andric       unsigned out : 1;
2349fe6060f1SDimitry Andric       unsigned mtx : 1;
2350fe6060f1SDimitry Andric       unsigned set : 1;
2351349cc55cSDimitry Andric       unsigned unused : 3;
2352349cc55cSDimitry Andric       unsigned all : 1;
23530b57cec5SDimitry Andric     } flags;
2354fe6060f1SDimitry Andric   };
23550b57cec5SDimitry Andric } kmp_depend_info_t;
23560b57cec5SDimitry Andric 
23570b57cec5SDimitry Andric // Internal structures to work with task dependencies:
23580b57cec5SDimitry Andric struct kmp_depnode_list {
23590b57cec5SDimitry Andric   kmp_depnode_t *node;
23600b57cec5SDimitry Andric   kmp_depnode_list_t *next;
23610b57cec5SDimitry Andric };
23620b57cec5SDimitry Andric 
23630b57cec5SDimitry Andric // Max number of mutexinoutset dependencies per node
23640b57cec5SDimitry Andric #define MAX_MTX_DEPS 4
23650b57cec5SDimitry Andric 
23660b57cec5SDimitry Andric typedef struct kmp_base_depnode {
23670b57cec5SDimitry Andric   kmp_depnode_list_t *successors; /* used under lock */
23680b57cec5SDimitry Andric   kmp_task_t *task; /* non-NULL if depnode is active, used under lock */
23690b57cec5SDimitry Andric   kmp_lock_t *mtx_locks[MAX_MTX_DEPS]; /* lock mutexinoutset dependent tasks */
23700b57cec5SDimitry Andric   kmp_int32 mtx_num_locks; /* number of locks in mtx_locks array */
23710b57cec5SDimitry Andric   kmp_lock_t lock; /* guards shared fields: task, successors */
23720b57cec5SDimitry Andric #if KMP_SUPPORT_GRAPH_OUTPUT
23730b57cec5SDimitry Andric   kmp_uint32 id;
23740b57cec5SDimitry Andric #endif
23750b57cec5SDimitry Andric   std::atomic<kmp_int32> npredecessors;
23760b57cec5SDimitry Andric   std::atomic<kmp_int32> nrefs;
23770b57cec5SDimitry Andric } kmp_base_depnode_t;
23780b57cec5SDimitry Andric 
23790b57cec5SDimitry Andric union KMP_ALIGN_CACHE kmp_depnode {
23800b57cec5SDimitry Andric   double dn_align; /* use worst case alignment */
23810b57cec5SDimitry Andric   char dn_pad[KMP_PAD(kmp_base_depnode_t, CACHE_LINE)];
23820b57cec5SDimitry Andric   kmp_base_depnode_t dn;
23830b57cec5SDimitry Andric };
23840b57cec5SDimitry Andric 
23850b57cec5SDimitry Andric struct kmp_dephash_entry {
23860b57cec5SDimitry Andric   kmp_intptr_t addr;
23870b57cec5SDimitry Andric   kmp_depnode_t *last_out;
2388fe6060f1SDimitry Andric   kmp_depnode_list_t *last_set;
2389fe6060f1SDimitry Andric   kmp_depnode_list_t *prev_set;
2390fe6060f1SDimitry Andric   kmp_uint8 last_flag;
23910b57cec5SDimitry Andric   kmp_lock_t *mtx_lock; /* is referenced by depnodes w/mutexinoutset dep */
23920b57cec5SDimitry Andric   kmp_dephash_entry_t *next_in_bucket;
23930b57cec5SDimitry Andric };
23940b57cec5SDimitry Andric 
23950b57cec5SDimitry Andric typedef struct kmp_dephash {
23960b57cec5SDimitry Andric   kmp_dephash_entry_t **buckets;
23970b57cec5SDimitry Andric   size_t size;
2398349cc55cSDimitry Andric   kmp_depnode_t *last_all;
2399489b1cf2SDimitry Andric   size_t generation;
24000b57cec5SDimitry Andric   kmp_uint32 nelements;
24010b57cec5SDimitry Andric   kmp_uint32 nconflicts;
24020b57cec5SDimitry Andric } kmp_dephash_t;
24030b57cec5SDimitry Andric 
24040b57cec5SDimitry Andric typedef struct kmp_task_affinity_info {
24050b57cec5SDimitry Andric   kmp_intptr_t base_addr;
24060b57cec5SDimitry Andric   size_t len;
24070b57cec5SDimitry Andric   struct {
24080b57cec5SDimitry Andric     bool flag1 : 1;
24090b57cec5SDimitry Andric     bool flag2 : 1;
24100b57cec5SDimitry Andric     kmp_int32 reserved : 30;
24110b57cec5SDimitry Andric   } flags;
24120b57cec5SDimitry Andric } kmp_task_affinity_info_t;
24130b57cec5SDimitry Andric 
24140b57cec5SDimitry Andric typedef enum kmp_event_type_t {
24150b57cec5SDimitry Andric   KMP_EVENT_UNINITIALIZED = 0,
24160b57cec5SDimitry Andric   KMP_EVENT_ALLOW_COMPLETION = 1
24170b57cec5SDimitry Andric } kmp_event_type_t;
24180b57cec5SDimitry Andric 
24190b57cec5SDimitry Andric typedef struct {
24200b57cec5SDimitry Andric   kmp_event_type_t type;
24210b57cec5SDimitry Andric   kmp_tas_lock_t lock;
24220b57cec5SDimitry Andric   union {
24230b57cec5SDimitry Andric     kmp_task_t *task;
24240b57cec5SDimitry Andric   } ed;
24250b57cec5SDimitry Andric } kmp_event_t;
24260b57cec5SDimitry Andric 
24270b57cec5SDimitry Andric #ifdef BUILD_TIED_TASK_STACK
24280b57cec5SDimitry Andric 
24290b57cec5SDimitry Andric /* Tied Task stack definitions */
24300b57cec5SDimitry Andric typedef struct kmp_stack_block {
24310b57cec5SDimitry Andric   kmp_taskdata_t *sb_block[TASK_STACK_BLOCK_SIZE];
24320b57cec5SDimitry Andric   struct kmp_stack_block *sb_next;
24330b57cec5SDimitry Andric   struct kmp_stack_block *sb_prev;
24340b57cec5SDimitry Andric } kmp_stack_block_t;
24350b57cec5SDimitry Andric 
24360b57cec5SDimitry Andric typedef struct kmp_task_stack {
24370b57cec5SDimitry Andric   kmp_stack_block_t ts_first_block; // first block of stack entries
24380b57cec5SDimitry Andric   kmp_taskdata_t **ts_top; // pointer to the top of stack
24390b57cec5SDimitry Andric   kmp_int32 ts_entries; // number of entries on the stack
24400b57cec5SDimitry Andric } kmp_task_stack_t;
24410b57cec5SDimitry Andric 
24420b57cec5SDimitry Andric #endif // BUILD_TIED_TASK_STACK
24430b57cec5SDimitry Andric 
24440b57cec5SDimitry Andric typedef struct kmp_tasking_flags { /* Total struct must be exactly 32 bits */
24450b57cec5SDimitry Andric   /* Compiler flags */ /* Total compiler flags must be 16 bits */
24460b57cec5SDimitry Andric   unsigned tiedness : 1; /* task is either tied (1) or untied (0) */
24470b57cec5SDimitry Andric   unsigned final : 1; /* task is final(1) so execute immediately */
24480b57cec5SDimitry Andric   unsigned merged_if0 : 1; /* no __kmpc_task_{begin/complete}_if0 calls in if0
24490b57cec5SDimitry Andric                               code path */
24500b57cec5SDimitry Andric   unsigned destructors_thunk : 1; /* set if the compiler creates a thunk to
24510b57cec5SDimitry Andric                                      invoke destructors from the runtime */
24520b57cec5SDimitry Andric   unsigned proxy : 1; /* task is a proxy task (it will be executed outside the
24530b57cec5SDimitry Andric                          context of the RTL) */
24540b57cec5SDimitry Andric   unsigned priority_specified : 1; /* set if the compiler provides priority
24550b57cec5SDimitry Andric                                       setting for the task */
24560b57cec5SDimitry Andric   unsigned detachable : 1; /* 1 == can detach */
2457e8d8bef9SDimitry Andric   unsigned hidden_helper : 1; /* 1 == hidden helper task */
2458e8d8bef9SDimitry Andric   unsigned reserved : 8; /* reserved for compiler use */
24590b57cec5SDimitry Andric 
24600b57cec5SDimitry Andric   /* Library flags */ /* Total library flags must be 16 bits */
24610b57cec5SDimitry Andric   unsigned tasktype : 1; /* task is either explicit(1) or implicit (0) */
24620b57cec5SDimitry Andric   unsigned task_serial : 1; // task is executed immediately (1) or deferred (0)
24630b57cec5SDimitry Andric   unsigned tasking_ser : 1; // all tasks in team are either executed immediately
24640b57cec5SDimitry Andric   // (1) or may be deferred (0)
24650b57cec5SDimitry Andric   unsigned team_serial : 1; // entire team is serial (1) [1 thread] or parallel
24660b57cec5SDimitry Andric   // (0) [>= 2 threads]
24670b57cec5SDimitry Andric   /* If either team_serial or tasking_ser is set, task team may be NULL */
24680b57cec5SDimitry Andric   /* Task State Flags: */
24690b57cec5SDimitry Andric   unsigned started : 1; /* 1==started, 0==not started     */
24700b57cec5SDimitry Andric   unsigned executing : 1; /* 1==executing, 0==not executing */
24710b57cec5SDimitry Andric   unsigned complete : 1; /* 1==complete, 0==not complete   */
2472480093f4SDimitry Andric   unsigned freed : 1; /* 1==freed, 0==allocated        */
24730b57cec5SDimitry Andric   unsigned native : 1; /* 1==gcc-compiled task, 0==intel */
24740b57cec5SDimitry Andric   unsigned reserved31 : 7; /* reserved for library use */
24750b57cec5SDimitry Andric 
24760b57cec5SDimitry Andric } kmp_tasking_flags_t;
24770b57cec5SDimitry Andric 
24780b57cec5SDimitry Andric struct kmp_taskdata { /* aligned during dynamic allocation       */
24790b57cec5SDimitry Andric   kmp_int32 td_task_id; /* id, assigned by debugger                */
24800b57cec5SDimitry Andric   kmp_tasking_flags_t td_flags; /* task flags                              */
24810b57cec5SDimitry Andric   kmp_team_t *td_team; /* team for this task                      */
24820b57cec5SDimitry Andric   kmp_info_p *td_alloc_thread; /* thread that allocated data structures   */
24830b57cec5SDimitry Andric   /* Currently not used except for perhaps IDB */
24840b57cec5SDimitry Andric   kmp_taskdata_t *td_parent; /* parent task                             */
24850b57cec5SDimitry Andric   kmp_int32 td_level; /* task nesting level                      */
24860b57cec5SDimitry Andric   std::atomic<kmp_int32> td_untied_count; // untied task active parts counter
24870b57cec5SDimitry Andric   ident_t *td_ident; /* task identifier                         */
24880b57cec5SDimitry Andric   // Taskwait data.
24890b57cec5SDimitry Andric   ident_t *td_taskwait_ident;
24900b57cec5SDimitry Andric   kmp_uint32 td_taskwait_counter;
24910b57cec5SDimitry Andric   kmp_int32 td_taskwait_thread; /* gtid + 1 of thread encountered taskwait */
24920b57cec5SDimitry Andric   KMP_ALIGN_CACHE kmp_internal_control_t
24930b57cec5SDimitry Andric       td_icvs; /* Internal control variables for the task */
24940b57cec5SDimitry Andric   KMP_ALIGN_CACHE std::atomic<kmp_int32>
24950b57cec5SDimitry Andric       td_allocated_child_tasks; /* Child tasks (+ current task) not yet
24960b57cec5SDimitry Andric                                    deallocated */
24970b57cec5SDimitry Andric   std::atomic<kmp_int32>
24980b57cec5SDimitry Andric       td_incomplete_child_tasks; /* Child tasks not yet complete */
24990b57cec5SDimitry Andric   kmp_taskgroup_t
25000b57cec5SDimitry Andric       *td_taskgroup; // Each task keeps pointer to its current taskgroup
25010b57cec5SDimitry Andric   kmp_dephash_t
25020b57cec5SDimitry Andric       *td_dephash; // Dependencies for children tasks are tracked from here
25030b57cec5SDimitry Andric   kmp_depnode_t
25040b57cec5SDimitry Andric       *td_depnode; // Pointer to graph node if this task has dependencies
25050b57cec5SDimitry Andric   kmp_task_team_t *td_task_team;
2506e8d8bef9SDimitry Andric   size_t td_size_alloc; // Size of task structure, including shareds etc.
25070b57cec5SDimitry Andric #if defined(KMP_GOMP_COMPAT)
25080b57cec5SDimitry Andric   // 4 or 8 byte integers for the loop bounds in GOMP_taskloop
25090b57cec5SDimitry Andric   kmp_int32 td_size_loop_bounds;
25100b57cec5SDimitry Andric #endif
25110b57cec5SDimitry Andric   kmp_taskdata_t *td_last_tied; // keep tied task for task scheduling constraint
25120b57cec5SDimitry Andric #if defined(KMP_GOMP_COMPAT)
25130b57cec5SDimitry Andric   // GOMP sends in a copy function for copy constructors
25140b57cec5SDimitry Andric   void (*td_copy_func)(void *, void *);
25150b57cec5SDimitry Andric #endif
25160b57cec5SDimitry Andric   kmp_event_t td_allow_completion_event;
25170b57cec5SDimitry Andric #if OMPT_SUPPORT
25180b57cec5SDimitry Andric   ompt_task_info_t ompt_task_info;
25190b57cec5SDimitry Andric #endif
25200b57cec5SDimitry Andric }; // struct kmp_taskdata
25210b57cec5SDimitry Andric 
25220b57cec5SDimitry Andric // Make sure padding above worked
25230b57cec5SDimitry Andric KMP_BUILD_ASSERT(sizeof(kmp_taskdata_t) % sizeof(void *) == 0);
25240b57cec5SDimitry Andric 
25250b57cec5SDimitry Andric // Data for task team but per thread
25260b57cec5SDimitry Andric typedef struct kmp_base_thread_data {
25270b57cec5SDimitry Andric   kmp_info_p *td_thr; // Pointer back to thread info
25280b57cec5SDimitry Andric   // Used only in __kmp_execute_tasks_template, maybe not avail until task is
25290b57cec5SDimitry Andric   // queued?
25300b57cec5SDimitry Andric   kmp_bootstrap_lock_t td_deque_lock; // Lock for accessing deque
25310b57cec5SDimitry Andric   kmp_taskdata_t *
25320b57cec5SDimitry Andric       *td_deque; // Deque of tasks encountered by td_thr, dynamically allocated
25330b57cec5SDimitry Andric   kmp_int32 td_deque_size; // Size of deck
25340b57cec5SDimitry Andric   kmp_uint32 td_deque_head; // Head of deque (will wrap)
25350b57cec5SDimitry Andric   kmp_uint32 td_deque_tail; // Tail of deque (will wrap)
25360b57cec5SDimitry Andric   kmp_int32 td_deque_ntasks; // Number of tasks in deque
25370b57cec5SDimitry Andric   // GEH: shouldn't this be volatile since used in while-spin?
25380b57cec5SDimitry Andric   kmp_int32 td_deque_last_stolen; // Thread number of last successful steal
25390b57cec5SDimitry Andric #ifdef BUILD_TIED_TASK_STACK
25400b57cec5SDimitry Andric   kmp_task_stack_t td_susp_tied_tasks; // Stack of suspended tied tasks for task
25410b57cec5SDimitry Andric // scheduling constraint
25420b57cec5SDimitry Andric #endif // BUILD_TIED_TASK_STACK
25430b57cec5SDimitry Andric } kmp_base_thread_data_t;
25440b57cec5SDimitry Andric 
25450b57cec5SDimitry Andric #define TASK_DEQUE_BITS 8 // Used solely to define INITIAL_TASK_DEQUE_SIZE
25460b57cec5SDimitry Andric #define INITIAL_TASK_DEQUE_SIZE (1 << TASK_DEQUE_BITS)
25470b57cec5SDimitry Andric 
25480b57cec5SDimitry Andric #define TASK_DEQUE_SIZE(td) ((td).td_deque_size)
25490b57cec5SDimitry Andric #define TASK_DEQUE_MASK(td) ((td).td_deque_size - 1)
25500b57cec5SDimitry Andric 
25510b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_thread_data {
25520b57cec5SDimitry Andric   kmp_base_thread_data_t td;
25530b57cec5SDimitry Andric   double td_align; /* use worst case alignment */
25540b57cec5SDimitry Andric   char td_pad[KMP_PAD(kmp_base_thread_data_t, CACHE_LINE)];
25550b57cec5SDimitry Andric } kmp_thread_data_t;
25560b57cec5SDimitry Andric 
255781ad6265SDimitry Andric typedef struct kmp_task_pri {
255881ad6265SDimitry Andric   kmp_thread_data_t td;
255981ad6265SDimitry Andric   kmp_int32 priority;
256081ad6265SDimitry Andric   kmp_task_pri *next;
256181ad6265SDimitry Andric } kmp_task_pri_t;
256281ad6265SDimitry Andric 
25630b57cec5SDimitry Andric // Data for task teams which are used when tasking is enabled for the team
25640b57cec5SDimitry Andric typedef struct kmp_base_task_team {
25650b57cec5SDimitry Andric   kmp_bootstrap_lock_t
25660b57cec5SDimitry Andric       tt_threads_lock; /* Lock used to allocate per-thread part of task team */
25670b57cec5SDimitry Andric   /* must be bootstrap lock since used at library shutdown*/
256881ad6265SDimitry Andric 
256981ad6265SDimitry Andric   // TODO: check performance vs kmp_tas_lock_t
257081ad6265SDimitry Andric   kmp_bootstrap_lock_t tt_task_pri_lock; /* Lock to access priority tasks */
257181ad6265SDimitry Andric   kmp_task_pri_t *tt_task_pri_list;
257281ad6265SDimitry Andric 
25730b57cec5SDimitry Andric   kmp_task_team_t *tt_next; /* For linking the task team free list */
25740b57cec5SDimitry Andric   kmp_thread_data_t
25750b57cec5SDimitry Andric       *tt_threads_data; /* Array of per-thread structures for task team */
25760b57cec5SDimitry Andric   /* Data survives task team deallocation */
25770b57cec5SDimitry Andric   kmp_int32 tt_found_tasks; /* Have we found tasks and queued them while
25780b57cec5SDimitry Andric                                executing this team? */
25790b57cec5SDimitry Andric   /* TRUE means tt_threads_data is set up and initialized */
25800b57cec5SDimitry Andric   kmp_int32 tt_nproc; /* #threads in team           */
25810b57cec5SDimitry Andric   kmp_int32 tt_max_threads; // # entries allocated for threads_data array
25820b57cec5SDimitry Andric   kmp_int32 tt_found_proxy_tasks; // found proxy tasks since last barrier
25830b57cec5SDimitry Andric   kmp_int32 tt_untied_task_encountered;
258481ad6265SDimitry Andric   std::atomic<kmp_int32> tt_num_task_pri; // number of priority tasks enqueued
2585e8d8bef9SDimitry Andric   // There is hidden helper thread encountered in this task team so that we must
2586e8d8bef9SDimitry Andric   // wait when waiting on task team
2587e8d8bef9SDimitry Andric   kmp_int32 tt_hidden_helper_task_encountered;
25880b57cec5SDimitry Andric 
25890b57cec5SDimitry Andric   KMP_ALIGN_CACHE
25900b57cec5SDimitry Andric   std::atomic<kmp_int32> tt_unfinished_threads; /* #threads still active */
25910b57cec5SDimitry Andric 
25920b57cec5SDimitry Andric   KMP_ALIGN_CACHE
25930b57cec5SDimitry Andric   volatile kmp_uint32
25940b57cec5SDimitry Andric       tt_active; /* is the team still actively executing tasks */
25950b57cec5SDimitry Andric } kmp_base_task_team_t;
25960b57cec5SDimitry Andric 
25970b57cec5SDimitry Andric union KMP_ALIGN_CACHE kmp_task_team {
25980b57cec5SDimitry Andric   kmp_base_task_team_t tt;
25990b57cec5SDimitry Andric   double tt_align; /* use worst case alignment */
26000b57cec5SDimitry Andric   char tt_pad[KMP_PAD(kmp_base_task_team_t, CACHE_LINE)];
26010b57cec5SDimitry Andric };
26020b57cec5SDimitry Andric 
26030b57cec5SDimitry Andric #if (USE_FAST_MEMORY == 3) || (USE_FAST_MEMORY == 5)
26040b57cec5SDimitry Andric // Free lists keep same-size free memory slots for fast memory allocation
26050b57cec5SDimitry Andric // routines
26060b57cec5SDimitry Andric typedef struct kmp_free_list {
26070b57cec5SDimitry Andric   void *th_free_list_self; // Self-allocated tasks free list
26080b57cec5SDimitry Andric   void *th_free_list_sync; // Self-allocated tasks stolen/returned by other
26090b57cec5SDimitry Andric   // threads
26100b57cec5SDimitry Andric   void *th_free_list_other; // Non-self free list (to be returned to owner's
26110b57cec5SDimitry Andric   // sync list)
26120b57cec5SDimitry Andric } kmp_free_list_t;
26130b57cec5SDimitry Andric #endif
26140b57cec5SDimitry Andric #if KMP_NESTED_HOT_TEAMS
26150b57cec5SDimitry Andric // Hot teams array keeps hot teams and their sizes for given thread. Hot teams
26160b57cec5SDimitry Andric // are not put in teams pool, and they don't put threads in threads pool.
26170b57cec5SDimitry Andric typedef struct kmp_hot_team_ptr {
26180b57cec5SDimitry Andric   kmp_team_p *hot_team; // pointer to hot_team of given nesting level
26190b57cec5SDimitry Andric   kmp_int32 hot_team_nth; // number of threads allocated for the hot_team
26200b57cec5SDimitry Andric } kmp_hot_team_ptr_t;
26210b57cec5SDimitry Andric #endif
26220b57cec5SDimitry Andric typedef struct kmp_teams_size {
26230b57cec5SDimitry Andric   kmp_int32 nteams; // number of teams in a league
26240b57cec5SDimitry Andric   kmp_int32 nth; // number of threads in each team of the league
26250b57cec5SDimitry Andric } kmp_teams_size_t;
26260b57cec5SDimitry Andric 
26270b57cec5SDimitry Andric // This struct stores a thread that acts as a "root" for a contention
26280b57cec5SDimitry Andric // group. Contention groups are rooted at kmp_root threads, but also at
2629fe6060f1SDimitry Andric // each primary thread of each team created in the teams construct.
26300b57cec5SDimitry Andric // This struct therefore also stores a thread_limit associated with
26310b57cec5SDimitry Andric // that contention group, and a counter to track the number of threads
26320b57cec5SDimitry Andric // active in that contention group. Each thread has a list of these: CG
26330b57cec5SDimitry Andric // root threads have an entry in their list in which cg_root refers to
26340b57cec5SDimitry Andric // the thread itself, whereas other workers in the CG will have a
26350b57cec5SDimitry Andric // single entry where cg_root is same as the entry containing their CG
26360b57cec5SDimitry Andric // root. When a thread encounters a teams construct, it will add a new
26370b57cec5SDimitry Andric // entry to the front of its list, because it now roots a new CG.
26380b57cec5SDimitry Andric typedef struct kmp_cg_root {
26390b57cec5SDimitry Andric   kmp_info_p *cg_root; // "root" thread for a contention group
26400b57cec5SDimitry Andric   // The CG root's limit comes from OMP_THREAD_LIMIT for root threads, or
2641fe6060f1SDimitry Andric   // thread_limit clause for teams primary threads
26420b57cec5SDimitry Andric   kmp_int32 cg_thread_limit;
26430b57cec5SDimitry Andric   kmp_int32 cg_nthreads; // Count of active threads in CG rooted at cg_root
26440b57cec5SDimitry Andric   struct kmp_cg_root *up; // pointer to higher level CG root in list
26450b57cec5SDimitry Andric } kmp_cg_root_t;
26460b57cec5SDimitry Andric 
26470b57cec5SDimitry Andric // OpenMP thread data structures
26480b57cec5SDimitry Andric 
26490b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE kmp_base_info {
26500b57cec5SDimitry Andric   /* Start with the readonly data which is cache aligned and padded. This is
2651fe6060f1SDimitry Andric      written before the thread starts working by the primary thread. Uber
2652fe6060f1SDimitry Andric      masters may update themselves later. Usage does not consider serialized
2653fe6060f1SDimitry Andric      regions.  */
26540b57cec5SDimitry Andric   kmp_desc_t th_info;
26550b57cec5SDimitry Andric   kmp_team_p *th_team; /* team we belong to */
26560b57cec5SDimitry Andric   kmp_root_p *th_root; /* pointer to root of task hierarchy */
26570b57cec5SDimitry Andric   kmp_info_p *th_next_pool; /* next available thread in the pool */
26580b57cec5SDimitry Andric   kmp_disp_t *th_dispatch; /* thread's dispatch data */
26590b57cec5SDimitry Andric   int th_in_pool; /* in thread pool (32 bits for TCR/TCW) */
26600b57cec5SDimitry Andric 
26610b57cec5SDimitry Andric   /* The following are cached from the team info structure */
26620b57cec5SDimitry Andric   /* TODO use these in more places as determined to be needed via profiling */
26630b57cec5SDimitry Andric   int th_team_nproc; /* number of threads in a team */
2664fe6060f1SDimitry Andric   kmp_info_p *th_team_master; /* the team's primary thread */
26650b57cec5SDimitry Andric   int th_team_serialized; /* team is serialized */
26660b57cec5SDimitry Andric   microtask_t th_teams_microtask; /* save entry address for teams construct */
26670b57cec5SDimitry Andric   int th_teams_level; /* save initial level of teams construct */
26680b57cec5SDimitry Andric /* it is 0 on device but may be any on host */
26690b57cec5SDimitry Andric 
26705ffd83dbSDimitry Andric /* The blocktime info is copied from the team struct to the thread struct */
26710b57cec5SDimitry Andric /* at the start of a barrier, and the values stored in the team are used  */
26720b57cec5SDimitry Andric /* at points in the code where the team struct is no longer guaranteed    */
26730b57cec5SDimitry Andric /* to exist (from the POV of worker threads).                             */
26740b57cec5SDimitry Andric #if KMP_USE_MONITOR
26750b57cec5SDimitry Andric   int th_team_bt_intervals;
26760b57cec5SDimitry Andric   int th_team_bt_set;
26770b57cec5SDimitry Andric #else
26780b57cec5SDimitry Andric   kmp_uint64 th_team_bt_intervals;
26790b57cec5SDimitry Andric #endif
26800b57cec5SDimitry Andric 
26810b57cec5SDimitry Andric #if KMP_AFFINITY_SUPPORTED
26820b57cec5SDimitry Andric   kmp_affin_mask_t *th_affin_mask; /* thread's current affinity mask */
26830b57cec5SDimitry Andric #endif
26840b57cec5SDimitry Andric   omp_allocator_handle_t th_def_allocator; /* default allocator */
2685fe6060f1SDimitry Andric   /* The data set by the primary thread at reinit, then R/W by the worker */
26860b57cec5SDimitry Andric   KMP_ALIGN_CACHE int
26870b57cec5SDimitry Andric       th_set_nproc; /* if > 0, then only use this request for the next fork */
26880b57cec5SDimitry Andric #if KMP_NESTED_HOT_TEAMS
26890b57cec5SDimitry Andric   kmp_hot_team_ptr_t *th_hot_teams; /* array of hot teams */
26900b57cec5SDimitry Andric #endif
26910b57cec5SDimitry Andric   kmp_proc_bind_t
26920b57cec5SDimitry Andric       th_set_proc_bind; /* if != proc_bind_default, use request for next fork */
26930b57cec5SDimitry Andric   kmp_teams_size_t
26940b57cec5SDimitry Andric       th_teams_size; /* number of teams/threads in teams construct */
26950b57cec5SDimitry Andric #if KMP_AFFINITY_SUPPORTED
26960b57cec5SDimitry Andric   int th_current_place; /* place currently bound to */
26970b57cec5SDimitry Andric   int th_new_place; /* place to bind to in par reg */
26980b57cec5SDimitry Andric   int th_first_place; /* first place in partition */
26990b57cec5SDimitry Andric   int th_last_place; /* last place in partition */
27000b57cec5SDimitry Andric #endif
27010b57cec5SDimitry Andric   int th_prev_level; /* previous level for affinity format */
27020b57cec5SDimitry Andric   int th_prev_num_threads; /* previous num_threads for affinity format */
27030b57cec5SDimitry Andric #if USE_ITT_BUILD
27040b57cec5SDimitry Andric   kmp_uint64 th_bar_arrive_time; /* arrival to barrier timestamp */
27050b57cec5SDimitry Andric   kmp_uint64 th_bar_min_time; /* minimum arrival time at the barrier */
27060b57cec5SDimitry Andric   kmp_uint64 th_frame_time; /* frame timestamp */
27070b57cec5SDimitry Andric #endif /* USE_ITT_BUILD */
27080b57cec5SDimitry Andric   kmp_local_t th_local;
27090b57cec5SDimitry Andric   struct private_common *th_pri_head;
27100b57cec5SDimitry Andric 
27110b57cec5SDimitry Andric   /* Now the data only used by the worker (after initial allocation) */
27120b57cec5SDimitry Andric   /* TODO the first serial team should actually be stored in the info_t
27130b57cec5SDimitry Andric      structure.  this will help reduce initial allocation overhead */
27140b57cec5SDimitry Andric   KMP_ALIGN_CACHE kmp_team_p
27150b57cec5SDimitry Andric       *th_serial_team; /*serialized team held in reserve*/
27160b57cec5SDimitry Andric 
27170b57cec5SDimitry Andric #if OMPT_SUPPORT
27180b57cec5SDimitry Andric   ompt_thread_info_t ompt_thread_info;
27190b57cec5SDimitry Andric #endif
27200b57cec5SDimitry Andric 
2721fe6060f1SDimitry Andric   /* The following are also read by the primary thread during reinit */
27220b57cec5SDimitry Andric   struct common_table *th_pri_common;
27230b57cec5SDimitry Andric 
27240b57cec5SDimitry Andric   volatile kmp_uint32 th_spin_here; /* thread-local location for spinning */
27250b57cec5SDimitry Andric   /* while awaiting queuing lock acquire */
27260b57cec5SDimitry Andric 
27270b57cec5SDimitry Andric   volatile void *th_sleep_loc; // this points at a kmp_flag<T>
2728349cc55cSDimitry Andric   flag_type th_sleep_loc_type; // enum type of flag stored in th_sleep_loc
27290b57cec5SDimitry Andric 
27300b57cec5SDimitry Andric   ident_t *th_ident;
27310b57cec5SDimitry Andric   unsigned th_x; // Random number generator data
27320b57cec5SDimitry Andric   unsigned th_a; // Random number generator data
27330b57cec5SDimitry Andric 
27340b57cec5SDimitry Andric   /* Tasking-related data for the thread */
27350b57cec5SDimitry Andric   kmp_task_team_t *th_task_team; // Task team struct
27360b57cec5SDimitry Andric   kmp_taskdata_t *th_current_task; // Innermost Task being executed
27370b57cec5SDimitry Andric   kmp_uint8 th_task_state; // alternating 0/1 for task team identification
27380b57cec5SDimitry Andric   kmp_uint8 *th_task_state_memo_stack; // Stack holding memos of th_task_state
27390b57cec5SDimitry Andric   // at nested levels
27400b57cec5SDimitry Andric   kmp_uint32 th_task_state_top; // Top element of th_task_state_memo_stack
27410b57cec5SDimitry Andric   kmp_uint32 th_task_state_stack_sz; // Size of th_task_state_memo_stack
27420b57cec5SDimitry Andric   kmp_uint32 th_reap_state; // Non-zero indicates thread is not
27430b57cec5SDimitry Andric   // tasking, thus safe to reap
27440b57cec5SDimitry Andric 
27450b57cec5SDimitry Andric   /* More stuff for keeping track of active/sleeping threads (this part is
27460b57cec5SDimitry Andric      written by the worker thread) */
27470b57cec5SDimitry Andric   kmp_uint8 th_active_in_pool; // included in count of #active threads in pool
27480b57cec5SDimitry Andric   int th_active; // ! sleeping; 32 bits for TCR/TCW
2749349cc55cSDimitry Andric   std::atomic<kmp_uint32> th_used_in_team; // Flag indicating use in team
2750349cc55cSDimitry Andric   // 0 = not used in team; 1 = used in team;
2751349cc55cSDimitry Andric   // 2 = transitioning to not used in team; 3 = transitioning to used in team
27520b57cec5SDimitry Andric   struct cons_header *th_cons; // used for consistency check
27530b57cec5SDimitry Andric #if KMP_USE_HIER_SCHED
27540b57cec5SDimitry Andric   // used for hierarchical scheduling
27550b57cec5SDimitry Andric   kmp_hier_private_bdata_t *th_hier_bar_data;
27560b57cec5SDimitry Andric #endif
27570b57cec5SDimitry Andric 
27580b57cec5SDimitry Andric   /* Add the syncronizing data which is cache aligned and padded. */
27590b57cec5SDimitry Andric   KMP_ALIGN_CACHE kmp_balign_t th_bar[bs_last_barrier];
27600b57cec5SDimitry Andric 
27610b57cec5SDimitry Andric   KMP_ALIGN_CACHE volatile kmp_int32
27620b57cec5SDimitry Andric       th_next_waiting; /* gtid+1 of next thread on lock wait queue, 0 if none */
27630b57cec5SDimitry Andric 
27640b57cec5SDimitry Andric #if (USE_FAST_MEMORY == 3) || (USE_FAST_MEMORY == 5)
27650b57cec5SDimitry Andric #define NUM_LISTS 4
27660b57cec5SDimitry Andric   kmp_free_list_t th_free_lists[NUM_LISTS]; // Free lists for fast memory
27670b57cec5SDimitry Andric // allocation routines
27680b57cec5SDimitry Andric #endif
27690b57cec5SDimitry Andric 
27700b57cec5SDimitry Andric #if KMP_OS_WINDOWS
27710b57cec5SDimitry Andric   kmp_win32_cond_t th_suspend_cv;
27720b57cec5SDimitry Andric   kmp_win32_mutex_t th_suspend_mx;
27730b57cec5SDimitry Andric   std::atomic<int> th_suspend_init;
27740b57cec5SDimitry Andric #endif
27750b57cec5SDimitry Andric #if KMP_OS_UNIX
27760b57cec5SDimitry Andric   kmp_cond_align_t th_suspend_cv;
27770b57cec5SDimitry Andric   kmp_mutex_align_t th_suspend_mx;
27780b57cec5SDimitry Andric   std::atomic<int> th_suspend_init_count;
27790b57cec5SDimitry Andric #endif
27800b57cec5SDimitry Andric 
27810b57cec5SDimitry Andric #if USE_ITT_BUILD
27820b57cec5SDimitry Andric   kmp_itt_mark_t th_itt_mark_single;
27830b57cec5SDimitry Andric // alignment ???
27840b57cec5SDimitry Andric #endif /* USE_ITT_BUILD */
27850b57cec5SDimitry Andric #if KMP_STATS_ENABLED
27860b57cec5SDimitry Andric   kmp_stats_list *th_stats;
27870b57cec5SDimitry Andric #endif
27880b57cec5SDimitry Andric #if KMP_OS_UNIX
27890b57cec5SDimitry Andric   std::atomic<bool> th_blocking;
27900b57cec5SDimitry Andric #endif
27910b57cec5SDimitry Andric   kmp_cg_root_t *th_cg_roots; // list of cg_roots associated with this thread
27920b57cec5SDimitry Andric } kmp_base_info_t;
27930b57cec5SDimitry Andric 
27940b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_info {
27950b57cec5SDimitry Andric   double th_align; /* use worst case alignment */
27960b57cec5SDimitry Andric   char th_pad[KMP_PAD(kmp_base_info_t, CACHE_LINE)];
27970b57cec5SDimitry Andric   kmp_base_info_t th;
27980b57cec5SDimitry Andric } kmp_info_t;
27990b57cec5SDimitry Andric 
28000b57cec5SDimitry Andric // OpenMP thread team data structures
28010b57cec5SDimitry Andric 
2802fe6060f1SDimitry Andric typedef struct kmp_base_data {
2803fe6060f1SDimitry Andric   volatile kmp_uint32 t_value;
2804fe6060f1SDimitry Andric } kmp_base_data_t;
28050b57cec5SDimitry Andric 
28060b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_sleep_team {
28070b57cec5SDimitry Andric   double dt_align; /* use worst case alignment */
28080b57cec5SDimitry Andric   char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
28090b57cec5SDimitry Andric   kmp_base_data_t dt;
28100b57cec5SDimitry Andric } kmp_sleep_team_t;
28110b57cec5SDimitry Andric 
28120b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_ordered_team {
28130b57cec5SDimitry Andric   double dt_align; /* use worst case alignment */
28140b57cec5SDimitry Andric   char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
28150b57cec5SDimitry Andric   kmp_base_data_t dt;
28160b57cec5SDimitry Andric } kmp_ordered_team_t;
28170b57cec5SDimitry Andric 
28180b57cec5SDimitry Andric typedef int (*launch_t)(int gtid);
28190b57cec5SDimitry Andric 
28200b57cec5SDimitry Andric /* Minimum number of ARGV entries to malloc if necessary */
28210b57cec5SDimitry Andric #define KMP_MIN_MALLOC_ARGV_ENTRIES 100
28220b57cec5SDimitry Andric 
28230b57cec5SDimitry Andric // Set up how many argv pointers will fit in cache lines containing
28240b57cec5SDimitry Andric // t_inline_argv. Historically, we have supported at least 96 bytes. Using a
2825fe6060f1SDimitry Andric // larger value for more space between the primary write/worker read section and
28260b57cec5SDimitry Andric // read/write by all section seems to buy more performance on EPCC PARALLEL.
28270b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
28280b57cec5SDimitry Andric #define KMP_INLINE_ARGV_BYTES                                                  \
28290b57cec5SDimitry Andric   (4 * CACHE_LINE -                                                            \
28300b57cec5SDimitry Andric    ((3 * KMP_PTR_SKIP + 2 * sizeof(int) + 2 * sizeof(kmp_int8) +               \
28310b57cec5SDimitry Andric      sizeof(kmp_int16) + sizeof(kmp_uint32)) %                                 \
28320b57cec5SDimitry Andric     CACHE_LINE))
28330b57cec5SDimitry Andric #else
28340b57cec5SDimitry Andric #define KMP_INLINE_ARGV_BYTES                                                  \
28350b57cec5SDimitry Andric   (2 * CACHE_LINE - ((3 * KMP_PTR_SKIP + 2 * sizeof(int)) % CACHE_LINE))
28360b57cec5SDimitry Andric #endif
28370b57cec5SDimitry Andric #define KMP_INLINE_ARGV_ENTRIES (int)(KMP_INLINE_ARGV_BYTES / KMP_PTR_SKIP)
28380b57cec5SDimitry Andric 
28390b57cec5SDimitry Andric typedef struct KMP_ALIGN_CACHE kmp_base_team {
28400b57cec5SDimitry Andric   // Synchronization Data
28410b57cec5SDimitry Andric   // ---------------------------------------------------------------------------
28420b57cec5SDimitry Andric   KMP_ALIGN_CACHE kmp_ordered_team_t t_ordered;
28430b57cec5SDimitry Andric   kmp_balign_team_t t_bar[bs_last_barrier];
28440b57cec5SDimitry Andric   std::atomic<int> t_construct; // count of single directive encountered by team
28450b57cec5SDimitry Andric   char pad[sizeof(kmp_lock_t)]; // padding to maintain performance on big iron
28460b57cec5SDimitry Andric 
28470b57cec5SDimitry Andric   // [0] - parallel / [1] - worksharing task reduction data shared by taskgroups
28480b57cec5SDimitry Andric   std::atomic<void *> t_tg_reduce_data[2]; // to support task modifier
28490b57cec5SDimitry Andric   std::atomic<int> t_tg_fini_counter[2]; // sync end of task reductions
28500b57cec5SDimitry Andric 
2851fe6060f1SDimitry Andric   // Primary thread only
28520b57cec5SDimitry Andric   // ---------------------------------------------------------------------------
2853fe6060f1SDimitry Andric   KMP_ALIGN_CACHE int t_master_tid; // tid of primary thread in parent team
2854fe6060f1SDimitry Andric   int t_master_this_cons; // "this_construct" single counter of primary thread
2855fe6060f1SDimitry Andric   // in parent team
28560b57cec5SDimitry Andric   ident_t *t_ident; // if volatile, have to change too much other crud to
28570b57cec5SDimitry Andric   // volatile too
28580b57cec5SDimitry Andric   kmp_team_p *t_parent; // parent team
28590b57cec5SDimitry Andric   kmp_team_p *t_next_pool; // next free team in the team pool
28600b57cec5SDimitry Andric   kmp_disp_t *t_dispatch; // thread's dispatch data
28610b57cec5SDimitry Andric   kmp_task_team_t *t_task_team[2]; // Task team struct; switch between 2
28620b57cec5SDimitry Andric   kmp_proc_bind_t t_proc_bind; // bind type for par region
28630b57cec5SDimitry Andric #if USE_ITT_BUILD
28640b57cec5SDimitry Andric   kmp_uint64 t_region_time; // region begin timestamp
28650b57cec5SDimitry Andric #endif /* USE_ITT_BUILD */
28660b57cec5SDimitry Andric 
2867fe6060f1SDimitry Andric   // Primary thread write, workers read
28680b57cec5SDimitry Andric   // --------------------------------------------------------------------------
28690b57cec5SDimitry Andric   KMP_ALIGN_CACHE void **t_argv;
28700b57cec5SDimitry Andric   int t_argc;
28710b57cec5SDimitry Andric   int t_nproc; // number of threads in team
28720b57cec5SDimitry Andric   microtask_t t_pkfn;
28730b57cec5SDimitry Andric   launch_t t_invoke; // procedure to launch the microtask
28740b57cec5SDimitry Andric 
28750b57cec5SDimitry Andric #if OMPT_SUPPORT
28760b57cec5SDimitry Andric   ompt_team_info_t ompt_team_info;
28770b57cec5SDimitry Andric   ompt_lw_taskteam_t *ompt_serialized_team_info;
28780b57cec5SDimitry Andric #endif
28790b57cec5SDimitry Andric 
28800b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
28810b57cec5SDimitry Andric   kmp_int8 t_fp_control_saved;
28820b57cec5SDimitry Andric   kmp_int8 t_pad2b;
28830b57cec5SDimitry Andric   kmp_int16 t_x87_fpu_control_word; // FP control regs
28840b57cec5SDimitry Andric   kmp_uint32 t_mxcsr;
28850b57cec5SDimitry Andric #endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
28860b57cec5SDimitry Andric 
28870b57cec5SDimitry Andric   void *t_inline_argv[KMP_INLINE_ARGV_ENTRIES];
28880b57cec5SDimitry Andric 
28890b57cec5SDimitry Andric   KMP_ALIGN_CACHE kmp_info_t **t_threads;
28900b57cec5SDimitry Andric   kmp_taskdata_t
28910b57cec5SDimitry Andric       *t_implicit_task_taskdata; // Taskdata for the thread's implicit task
28920b57cec5SDimitry Andric   int t_level; // nested parallel level
28930b57cec5SDimitry Andric 
28940b57cec5SDimitry Andric   KMP_ALIGN_CACHE int t_max_argc;
2895480093f4SDimitry Andric   int t_max_nproc; // max threads this team can handle (dynamically expandable)
28960b57cec5SDimitry Andric   int t_serialized; // levels deep of serialized teams
28970b57cec5SDimitry Andric   dispatch_shared_info_t *t_disp_buffer; // buffers for dispatch system
28980b57cec5SDimitry Andric   int t_id; // team's id, assigned by debugger.
28990b57cec5SDimitry Andric   int t_active_level; // nested active parallel level
29000b57cec5SDimitry Andric   kmp_r_sched_t t_sched; // run-time schedule for the team
29010b57cec5SDimitry Andric #if KMP_AFFINITY_SUPPORTED
29020b57cec5SDimitry Andric   int t_first_place; // first & last place in parent thread's partition.
2903fe6060f1SDimitry Andric   int t_last_place; // Restore these values to primary thread after par region.
29040b57cec5SDimitry Andric #endif // KMP_AFFINITY_SUPPORTED
29050b57cec5SDimitry Andric   int t_display_affinity;
29060b57cec5SDimitry Andric   int t_size_changed; // team size was changed?: 0: no, 1: yes, -1: changed via
29070b57cec5SDimitry Andric   // omp_set_num_threads() call
29080b57cec5SDimitry Andric   omp_allocator_handle_t t_def_allocator; /* default allocator */
29090b57cec5SDimitry Andric 
29100b57cec5SDimitry Andric // Read/write by workers as well
29110b57cec5SDimitry Andric #if (KMP_ARCH_X86 || KMP_ARCH_X86_64)
29120b57cec5SDimitry Andric   // Using CACHE_LINE=64 reduces memory footprint, but causes a big perf
29130b57cec5SDimitry Andric   // regression of epcc 'parallel' and 'barrier' on fxe256lin01. This extra
29140b57cec5SDimitry Andric   // padding serves to fix the performance of epcc 'parallel' and 'barrier' when
29150b57cec5SDimitry Andric   // CACHE_LINE=64. TODO: investigate more and get rid if this padding.
29160b57cec5SDimitry Andric   char dummy_padding[1024];
29170b57cec5SDimitry Andric #endif
29180b57cec5SDimitry Andric   // Internal control stack for additional nested teams.
29190b57cec5SDimitry Andric   KMP_ALIGN_CACHE kmp_internal_control_t *t_control_stack_top;
29200b57cec5SDimitry Andric   // for SERIALIZED teams nested 2 or more levels deep
29210b57cec5SDimitry Andric   // typed flag to store request state of cancellation
29220b57cec5SDimitry Andric   std::atomic<kmp_int32> t_cancel_request;
29230b57cec5SDimitry Andric   int t_master_active; // save on fork, restore on join
29240b57cec5SDimitry Andric   void *t_copypriv_data; // team specific pointer to copyprivate data array
29250b57cec5SDimitry Andric #if KMP_OS_WINDOWS
29260b57cec5SDimitry Andric   std::atomic<kmp_uint32> t_copyin_counter;
29270b57cec5SDimitry Andric #endif
29280b57cec5SDimitry Andric #if USE_ITT_BUILD
29290b57cec5SDimitry Andric   void *t_stack_id; // team specific stack stitching id (for ittnotify)
29300b57cec5SDimitry Andric #endif /* USE_ITT_BUILD */
2931349cc55cSDimitry Andric   distributedBarrier *b; // Distributed barrier data associated with team
29320b57cec5SDimitry Andric } kmp_base_team_t;
29330b57cec5SDimitry Andric 
29340b57cec5SDimitry Andric union KMP_ALIGN_CACHE kmp_team {
29350b57cec5SDimitry Andric   kmp_base_team_t t;
29360b57cec5SDimitry Andric   double t_align; /* use worst case alignment */
29370b57cec5SDimitry Andric   char t_pad[KMP_PAD(kmp_base_team_t, CACHE_LINE)];
29380b57cec5SDimitry Andric };
29390b57cec5SDimitry Andric 
29400b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_time_global {
29410b57cec5SDimitry Andric   double dt_align; /* use worst case alignment */
29420b57cec5SDimitry Andric   char dt_pad[KMP_PAD(kmp_base_data_t, CACHE_LINE)];
29430b57cec5SDimitry Andric   kmp_base_data_t dt;
29440b57cec5SDimitry Andric } kmp_time_global_t;
29450b57cec5SDimitry Andric 
29460b57cec5SDimitry Andric typedef struct kmp_base_global {
29470b57cec5SDimitry Andric   /* cache-aligned */
29480b57cec5SDimitry Andric   kmp_time_global_t g_time;
29490b57cec5SDimitry Andric 
29500b57cec5SDimitry Andric   /* non cache-aligned */
29510b57cec5SDimitry Andric   volatile int g_abort;
29520b57cec5SDimitry Andric   volatile int g_done;
29530b57cec5SDimitry Andric 
29540b57cec5SDimitry Andric   int g_dynamic;
29550b57cec5SDimitry Andric   enum dynamic_mode g_dynamic_mode;
29560b57cec5SDimitry Andric } kmp_base_global_t;
29570b57cec5SDimitry Andric 
29580b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_global {
29590b57cec5SDimitry Andric   kmp_base_global_t g;
29600b57cec5SDimitry Andric   double g_align; /* use worst case alignment */
29610b57cec5SDimitry Andric   char g_pad[KMP_PAD(kmp_base_global_t, CACHE_LINE)];
29620b57cec5SDimitry Andric } kmp_global_t;
29630b57cec5SDimitry Andric 
29640b57cec5SDimitry Andric typedef struct kmp_base_root {
29650b57cec5SDimitry Andric   // TODO: GEH - combine r_active with r_in_parallel then r_active ==
29660b57cec5SDimitry Andric   // (r_in_parallel>= 0)
29670b57cec5SDimitry Andric   // TODO: GEH - then replace r_active with t_active_levels if we can to reduce
29680b57cec5SDimitry Andric   // the synch overhead or keeping r_active
29690b57cec5SDimitry Andric   volatile int r_active; /* TRUE if some region in a nest has > 1 thread */
29700b57cec5SDimitry Andric   // keeps a count of active parallel regions per root
29710b57cec5SDimitry Andric   std::atomic<int> r_in_parallel;
29720b57cec5SDimitry Andric   // GEH: This is misnamed, should be r_active_levels
29730b57cec5SDimitry Andric   kmp_team_t *r_root_team;
29740b57cec5SDimitry Andric   kmp_team_t *r_hot_team;
29750b57cec5SDimitry Andric   kmp_info_t *r_uber_thread;
29760b57cec5SDimitry Andric   kmp_lock_t r_begin_lock;
29770b57cec5SDimitry Andric   volatile int r_begin;
29780b57cec5SDimitry Andric   int r_blocktime; /* blocktime for this root and descendants */
2979fe6060f1SDimitry Andric #if KMP_AFFINITY_SUPPORTED
2980fe6060f1SDimitry Andric   int r_affinity_assigned;
2981fe6060f1SDimitry Andric #endif // KMP_AFFINITY_SUPPORTED
29820b57cec5SDimitry Andric } kmp_base_root_t;
29830b57cec5SDimitry Andric 
29840b57cec5SDimitry Andric typedef union KMP_ALIGN_CACHE kmp_root {
29850b57cec5SDimitry Andric   kmp_base_root_t r;
29860b57cec5SDimitry Andric   double r_align; /* use worst case alignment */
29870b57cec5SDimitry Andric   char r_pad[KMP_PAD(kmp_base_root_t, CACHE_LINE)];
29880b57cec5SDimitry Andric } kmp_root_t;
29890b57cec5SDimitry Andric 
29900b57cec5SDimitry Andric struct fortran_inx_info {
29910b57cec5SDimitry Andric   kmp_int32 data;
29920b57cec5SDimitry Andric };
29930b57cec5SDimitry Andric 
299481ad6265SDimitry Andric // This list type exists to hold old __kmp_threads arrays so that
299581ad6265SDimitry Andric // old references to them may complete while reallocation takes place when
299681ad6265SDimitry Andric // expanding the array. The items in this list are kept alive until library
299781ad6265SDimitry Andric // shutdown.
299881ad6265SDimitry Andric typedef struct kmp_old_threads_list_t {
299981ad6265SDimitry Andric   kmp_info_t **threads;
300081ad6265SDimitry Andric   struct kmp_old_threads_list_t *next;
300181ad6265SDimitry Andric } kmp_old_threads_list_t;
300281ad6265SDimitry Andric 
30030b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
30040b57cec5SDimitry Andric 
30050b57cec5SDimitry Andric extern int __kmp_settings;
30060b57cec5SDimitry Andric extern int __kmp_duplicate_library_ok;
30070b57cec5SDimitry Andric #if USE_ITT_BUILD
30080b57cec5SDimitry Andric extern int __kmp_forkjoin_frames;
30090b57cec5SDimitry Andric extern int __kmp_forkjoin_frames_mode;
30100b57cec5SDimitry Andric #endif
30110b57cec5SDimitry Andric extern PACKED_REDUCTION_METHOD_T __kmp_force_reduction_method;
30120b57cec5SDimitry Andric extern int __kmp_determ_red;
30130b57cec5SDimitry Andric 
30140b57cec5SDimitry Andric #ifdef KMP_DEBUG
30150b57cec5SDimitry Andric extern int kmp_a_debug;
30160b57cec5SDimitry Andric extern int kmp_b_debug;
30170b57cec5SDimitry Andric extern int kmp_c_debug;
30180b57cec5SDimitry Andric extern int kmp_d_debug;
30190b57cec5SDimitry Andric extern int kmp_e_debug;
30200b57cec5SDimitry Andric extern int kmp_f_debug;
30210b57cec5SDimitry Andric #endif /* KMP_DEBUG */
30220b57cec5SDimitry Andric 
30230b57cec5SDimitry Andric /* For debug information logging using rotating buffer */
30240b57cec5SDimitry Andric #define KMP_DEBUG_BUF_LINES_INIT 512
30250b57cec5SDimitry Andric #define KMP_DEBUG_BUF_LINES_MIN 1
30260b57cec5SDimitry Andric 
30270b57cec5SDimitry Andric #define KMP_DEBUG_BUF_CHARS_INIT 128
30280b57cec5SDimitry Andric #define KMP_DEBUG_BUF_CHARS_MIN 2
30290b57cec5SDimitry Andric 
30300b57cec5SDimitry Andric extern int
30310b57cec5SDimitry Andric     __kmp_debug_buf; /* TRUE means use buffer, FALSE means print to stderr */
30320b57cec5SDimitry Andric extern int __kmp_debug_buf_lines; /* How many lines of debug stored in buffer */
30330b57cec5SDimitry Andric extern int
30340b57cec5SDimitry Andric     __kmp_debug_buf_chars; /* How many characters allowed per line in buffer */
30350b57cec5SDimitry Andric extern int __kmp_debug_buf_atomic; /* TRUE means use atomic update of buffer
30360b57cec5SDimitry Andric                                       entry pointer */
30370b57cec5SDimitry Andric 
30380b57cec5SDimitry Andric extern char *__kmp_debug_buffer; /* Debug buffer itself */
30390b57cec5SDimitry Andric extern std::atomic<int> __kmp_debug_count; /* Counter for number of lines
30400b57cec5SDimitry Andric                                               printed in buffer so far */
30410b57cec5SDimitry Andric extern int __kmp_debug_buf_warn_chars; /* Keep track of char increase
30420b57cec5SDimitry Andric                                           recommended in warnings */
30430b57cec5SDimitry Andric /* end rotating debug buffer */
30440b57cec5SDimitry Andric 
30450b57cec5SDimitry Andric #ifdef KMP_DEBUG
30460b57cec5SDimitry Andric extern int __kmp_par_range; /* +1 => only go par for constructs in range */
30470b57cec5SDimitry Andric 
30480b57cec5SDimitry Andric #define KMP_PAR_RANGE_ROUTINE_LEN 1024
30490b57cec5SDimitry Andric extern char __kmp_par_range_routine[KMP_PAR_RANGE_ROUTINE_LEN];
30500b57cec5SDimitry Andric #define KMP_PAR_RANGE_FILENAME_LEN 1024
30510b57cec5SDimitry Andric extern char __kmp_par_range_filename[KMP_PAR_RANGE_FILENAME_LEN];
30520b57cec5SDimitry Andric extern int __kmp_par_range_lb;
30530b57cec5SDimitry Andric extern int __kmp_par_range_ub;
30540b57cec5SDimitry Andric #endif
30550b57cec5SDimitry Andric 
30560b57cec5SDimitry Andric /* For printing out dynamic storage map for threads and teams */
30570b57cec5SDimitry Andric extern int
30580b57cec5SDimitry Andric     __kmp_storage_map; /* True means print storage map for threads and teams */
30590b57cec5SDimitry Andric extern int __kmp_storage_map_verbose; /* True means storage map includes
30600b57cec5SDimitry Andric                                          placement info */
30610b57cec5SDimitry Andric extern int __kmp_storage_map_verbose_specified;
30620b57cec5SDimitry Andric 
30630b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
30640b57cec5SDimitry Andric extern kmp_cpuinfo_t __kmp_cpuinfo;
3065349cc55cSDimitry Andric static inline bool __kmp_is_hybrid_cpu() { return __kmp_cpuinfo.flags.hybrid; }
306681ad6265SDimitry Andric #elif KMP_OS_DARWIN && KMP_ARCH_AARCH64
306781ad6265SDimitry Andric static inline bool __kmp_is_hybrid_cpu() { return true; }
3068349cc55cSDimitry Andric #else
3069349cc55cSDimitry Andric static inline bool __kmp_is_hybrid_cpu() { return false; }
30700b57cec5SDimitry Andric #endif
30710b57cec5SDimitry Andric 
30720b57cec5SDimitry Andric extern volatile int __kmp_init_serial;
30730b57cec5SDimitry Andric extern volatile int __kmp_init_gtid;
30740b57cec5SDimitry Andric extern volatile int __kmp_init_common;
3075*fcaf7f86SDimitry Andric extern volatile int __kmp_need_register_serial;
30760b57cec5SDimitry Andric extern volatile int __kmp_init_middle;
30770b57cec5SDimitry Andric extern volatile int __kmp_init_parallel;
30780b57cec5SDimitry Andric #if KMP_USE_MONITOR
30790b57cec5SDimitry Andric extern volatile int __kmp_init_monitor;
30800b57cec5SDimitry Andric #endif
30810b57cec5SDimitry Andric extern volatile int __kmp_init_user_locks;
3082e8d8bef9SDimitry Andric extern volatile int __kmp_init_hidden_helper_threads;
30830b57cec5SDimitry Andric extern int __kmp_init_counter;
30840b57cec5SDimitry Andric extern int __kmp_root_counter;
30850b57cec5SDimitry Andric extern int __kmp_version;
30860b57cec5SDimitry Andric 
30870b57cec5SDimitry Andric /* list of address of allocated caches for commons */
30880b57cec5SDimitry Andric extern kmp_cached_addr_t *__kmp_threadpriv_cache_list;
30890b57cec5SDimitry Andric 
30900b57cec5SDimitry Andric /* Barrier algorithm types and options */
30910b57cec5SDimitry Andric extern kmp_uint32 __kmp_barrier_gather_bb_dflt;
30920b57cec5SDimitry Andric extern kmp_uint32 __kmp_barrier_release_bb_dflt;
30930b57cec5SDimitry Andric extern kmp_bar_pat_e __kmp_barrier_gather_pat_dflt;
30940b57cec5SDimitry Andric extern kmp_bar_pat_e __kmp_barrier_release_pat_dflt;
30950b57cec5SDimitry Andric extern kmp_uint32 __kmp_barrier_gather_branch_bits[bs_last_barrier];
30960b57cec5SDimitry Andric extern kmp_uint32 __kmp_barrier_release_branch_bits[bs_last_barrier];
30970b57cec5SDimitry Andric extern kmp_bar_pat_e __kmp_barrier_gather_pattern[bs_last_barrier];
30980b57cec5SDimitry Andric extern kmp_bar_pat_e __kmp_barrier_release_pattern[bs_last_barrier];
30990b57cec5SDimitry Andric extern char const *__kmp_barrier_branch_bit_env_name[bs_last_barrier];
31000b57cec5SDimitry Andric extern char const *__kmp_barrier_pattern_env_name[bs_last_barrier];
31010b57cec5SDimitry Andric extern char const *__kmp_barrier_type_name[bs_last_barrier];
31020b57cec5SDimitry Andric extern char const *__kmp_barrier_pattern_name[bp_last_bar];
31030b57cec5SDimitry Andric 
31040b57cec5SDimitry Andric /* Global Locks */
31050b57cec5SDimitry Andric extern kmp_bootstrap_lock_t __kmp_initz_lock; /* control initialization */
31060b57cec5SDimitry Andric extern kmp_bootstrap_lock_t __kmp_forkjoin_lock; /* control fork/join access */
31070b57cec5SDimitry Andric extern kmp_bootstrap_lock_t __kmp_task_team_lock;
31080b57cec5SDimitry Andric extern kmp_bootstrap_lock_t
31090b57cec5SDimitry Andric     __kmp_exit_lock; /* exit() is not always thread-safe */
31100b57cec5SDimitry Andric #if KMP_USE_MONITOR
31110b57cec5SDimitry Andric extern kmp_bootstrap_lock_t
31120b57cec5SDimitry Andric     __kmp_monitor_lock; /* control monitor thread creation */
31130b57cec5SDimitry Andric #endif
31140b57cec5SDimitry Andric extern kmp_bootstrap_lock_t
31150b57cec5SDimitry Andric     __kmp_tp_cached_lock; /* used for the hack to allow threadprivate cache and
31160b57cec5SDimitry Andric                              __kmp_threads expansion to co-exist */
31170b57cec5SDimitry Andric 
31180b57cec5SDimitry Andric extern kmp_lock_t __kmp_global_lock; /* control OS/global access  */
31190b57cec5SDimitry Andric extern kmp_queuing_lock_t __kmp_dispatch_lock; /* control dispatch access  */
31200b57cec5SDimitry Andric extern kmp_lock_t __kmp_debug_lock; /* control I/O access for KMP_DEBUG */
31210b57cec5SDimitry Andric 
31220b57cec5SDimitry Andric extern enum library_type __kmp_library;
31230b57cec5SDimitry Andric 
31240b57cec5SDimitry Andric extern enum sched_type __kmp_sched; /* default runtime scheduling */
31250b57cec5SDimitry Andric extern enum sched_type __kmp_static; /* default static scheduling method */
31260b57cec5SDimitry Andric extern enum sched_type __kmp_guided; /* default guided scheduling method */
31270b57cec5SDimitry Andric extern enum sched_type __kmp_auto; /* default auto scheduling method */
31280b57cec5SDimitry Andric extern int __kmp_chunk; /* default runtime chunk size */
3129fe6060f1SDimitry Andric extern int __kmp_force_monotonic; /* whether monotonic scheduling forced */
31300b57cec5SDimitry Andric 
31310b57cec5SDimitry Andric extern size_t __kmp_stksize; /* stack size per thread         */
31320b57cec5SDimitry Andric #if KMP_USE_MONITOR
31330b57cec5SDimitry Andric extern size_t __kmp_monitor_stksize; /* stack size for monitor thread */
31340b57cec5SDimitry Andric #endif
31350b57cec5SDimitry Andric extern size_t __kmp_stkoffset; /* stack offset per thread       */
31360b57cec5SDimitry Andric extern int __kmp_stkpadding; /* Should we pad root thread(s) stack */
31370b57cec5SDimitry Andric 
31380b57cec5SDimitry Andric extern size_t
31390b57cec5SDimitry Andric     __kmp_malloc_pool_incr; /* incremental size of pool for kmp_malloc() */
31400b57cec5SDimitry Andric extern int __kmp_env_stksize; /* was KMP_STACKSIZE specified? */
31410b57cec5SDimitry Andric extern int __kmp_env_blocktime; /* was KMP_BLOCKTIME specified? */
31420b57cec5SDimitry Andric extern int __kmp_env_checks; /* was KMP_CHECKS specified?    */
31430b57cec5SDimitry Andric extern int __kmp_env_consistency_check; // was KMP_CONSISTENCY_CHECK specified?
31440b57cec5SDimitry Andric extern int __kmp_generate_warnings; /* should we issue warnings? */
31450b57cec5SDimitry Andric extern int __kmp_reserve_warn; /* have we issued reserve_threads warning? */
31460b57cec5SDimitry Andric 
31470b57cec5SDimitry Andric #ifdef DEBUG_SUSPEND
31480b57cec5SDimitry Andric extern int __kmp_suspend_count; /* count inside __kmp_suspend_template() */
31490b57cec5SDimitry Andric #endif
31500b57cec5SDimitry Andric 
31510b57cec5SDimitry Andric extern kmp_int32 __kmp_use_yield;
31520b57cec5SDimitry Andric extern kmp_int32 __kmp_use_yield_exp_set;
31530b57cec5SDimitry Andric extern kmp_uint32 __kmp_yield_init;
31540b57cec5SDimitry Andric extern kmp_uint32 __kmp_yield_next;
315504eeddc0SDimitry Andric extern kmp_uint64 __kmp_pause_init;
31560b57cec5SDimitry Andric 
31570b57cec5SDimitry Andric /* ------------------------------------------------------------------------- */
31580b57cec5SDimitry Andric extern int __kmp_allThreadsSpecified;
31590b57cec5SDimitry Andric 
31600b57cec5SDimitry Andric extern size_t __kmp_align_alloc;
31610b57cec5SDimitry Andric /* following data protected by initialization routines */
31620b57cec5SDimitry Andric extern int __kmp_xproc; /* number of processors in the system */
31630b57cec5SDimitry Andric extern int __kmp_avail_proc; /* number of processors available to the process */
31640b57cec5SDimitry Andric extern size_t __kmp_sys_min_stksize; /* system-defined minimum stack size */
31650b57cec5SDimitry Andric extern int __kmp_sys_max_nth; /* system-imposed maximum number of threads */
31660b57cec5SDimitry Andric // maximum total number of concurrently-existing threads on device
31670b57cec5SDimitry Andric extern int __kmp_max_nth;
31680b57cec5SDimitry Andric // maximum total number of concurrently-existing threads in a contention group
31690b57cec5SDimitry Andric extern int __kmp_cg_max_nth;
31700b57cec5SDimitry Andric extern int __kmp_teams_max_nth; // max threads used in a teams construct
31710b57cec5SDimitry Andric extern int __kmp_threads_capacity; /* capacity of the arrays __kmp_threads and
31720b57cec5SDimitry Andric                                       __kmp_root */
31730b57cec5SDimitry Andric extern int __kmp_dflt_team_nth; /* default number of threads in a parallel
31740b57cec5SDimitry Andric                                    region a la OMP_NUM_THREADS */
31750b57cec5SDimitry Andric extern int __kmp_dflt_team_nth_ub; /* upper bound on "" determined at serial
31760b57cec5SDimitry Andric                                       initialization */
31770b57cec5SDimitry Andric extern int __kmp_tp_capacity; /* capacity of __kmp_threads if threadprivate is
31780b57cec5SDimitry Andric                                  used (fixed) */
31790b57cec5SDimitry Andric extern int __kmp_tp_cached; /* whether threadprivate cache has been created
31800b57cec5SDimitry Andric                                (__kmpc_threadprivate_cached()) */
31810b57cec5SDimitry Andric extern int __kmp_dflt_blocktime; /* number of milliseconds to wait before
31820b57cec5SDimitry Andric                                     blocking (env setting) */
318381ad6265SDimitry Andric extern bool __kmp_wpolicy_passive; /* explicitly set passive wait policy */
31840b57cec5SDimitry Andric #if KMP_USE_MONITOR
31850b57cec5SDimitry Andric extern int
31860b57cec5SDimitry Andric     __kmp_monitor_wakeups; /* number of times monitor wakes up per second */
31870b57cec5SDimitry Andric extern int __kmp_bt_intervals; /* number of monitor timestamp intervals before
31880b57cec5SDimitry Andric                                   blocking */
31890b57cec5SDimitry Andric #endif
31900b57cec5SDimitry Andric #ifdef KMP_ADJUST_BLOCKTIME
31910b57cec5SDimitry Andric extern int __kmp_zero_bt; /* whether blocktime has been forced to zero */
31920b57cec5SDimitry Andric #endif /* KMP_ADJUST_BLOCKTIME */
31930b57cec5SDimitry Andric #ifdef KMP_DFLT_NTH_CORES
31940b57cec5SDimitry Andric extern int __kmp_ncores; /* Total number of cores for threads placement */
31950b57cec5SDimitry Andric #endif
31960b57cec5SDimitry Andric /* Number of millisecs to delay on abort for Intel(R) VTune(TM) tools */
31970b57cec5SDimitry Andric extern int __kmp_abort_delay;
31980b57cec5SDimitry Andric 
31990b57cec5SDimitry Andric extern int __kmp_need_register_atfork_specified;
3200fe6060f1SDimitry Andric extern int __kmp_need_register_atfork; /* At initialization, call pthread_atfork
3201fe6060f1SDimitry Andric                                           to install fork handler */
32020b57cec5SDimitry Andric extern int __kmp_gtid_mode; /* Method of getting gtid, values:
32030b57cec5SDimitry Andric                                0 - not set, will be set at runtime
32040b57cec5SDimitry Andric                                1 - using stack search
32050b57cec5SDimitry Andric                                2 - dynamic TLS (pthread_getspecific(Linux* OS/OS
32060b57cec5SDimitry Andric                                    X*) or TlsGetValue(Windows* OS))
32070b57cec5SDimitry Andric                                3 - static TLS (__declspec(thread) __kmp_gtid),
32080b57cec5SDimitry Andric                                    Linux* OS .so only.  */
32090b57cec5SDimitry Andric extern int
32100b57cec5SDimitry Andric     __kmp_adjust_gtid_mode; /* If true, adjust method based on #threads */
32110b57cec5SDimitry Andric #ifdef KMP_TDATA_GTID
32120b57cec5SDimitry Andric extern KMP_THREAD_LOCAL int __kmp_gtid;
32130b57cec5SDimitry Andric #endif
32140b57cec5SDimitry Andric extern int __kmp_tls_gtid_min; /* #threads below which use sp search for gtid */
32150b57cec5SDimitry Andric extern int __kmp_foreign_tp; // If true, separate TP var for each foreign thread
32160b57cec5SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64
32170b57cec5SDimitry Andric extern int __kmp_inherit_fp_control; // copy fp creg(s) parent->workers at fork
32180b57cec5SDimitry Andric extern kmp_int16 __kmp_init_x87_fpu_control_word; // init thread's FP ctrl reg
32190b57cec5SDimitry Andric extern kmp_uint32 __kmp_init_mxcsr; /* init thread's mxscr */
32200b57cec5SDimitry Andric #endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
32210b57cec5SDimitry Andric 
32220b57cec5SDimitry Andric // max_active_levels for nested parallelism enabled by default via
32230b57cec5SDimitry Andric // OMP_MAX_ACTIVE_LEVELS, OMP_NESTED, OMP_NUM_THREADS, and OMP_PROC_BIND
32240b57cec5SDimitry Andric extern int __kmp_dflt_max_active_levels;
32250b57cec5SDimitry Andric // Indicates whether value of __kmp_dflt_max_active_levels was already
32260b57cec5SDimitry Andric // explicitly set by OMP_MAX_ACTIVE_LEVELS or OMP_NESTED=false
32270b57cec5SDimitry Andric extern bool __kmp_dflt_max_active_levels_set;
32280b57cec5SDimitry Andric extern int __kmp_dispatch_num_buffers; /* max possible dynamic loops in
32290b57cec5SDimitry Andric                                           concurrent execution per team */
32300b57cec5SDimitry Andric #if KMP_NESTED_HOT_TEAMS
32310b57cec5SDimitry Andric extern int __kmp_hot_teams_mode;
32320b57cec5SDimitry Andric extern int __kmp_hot_teams_max_level;
32330b57cec5SDimitry Andric #endif
32340b57cec5SDimitry Andric 
32350b57cec5SDimitry Andric #if KMP_OS_LINUX
32360b57cec5SDimitry Andric extern enum clock_function_type __kmp_clock_function;
32370b57cec5SDimitry Andric extern int __kmp_clock_function_param;
32380b57cec5SDimitry Andric #endif /* KMP_OS_LINUX */
32390b57cec5SDimitry Andric 
32400b57cec5SDimitry Andric #if KMP_MIC_SUPPORTED
32410b57cec5SDimitry Andric extern enum mic_type __kmp_mic_type;
32420b57cec5SDimitry Andric #endif
32430b57cec5SDimitry Andric 
32440b57cec5SDimitry Andric #ifdef USE_LOAD_BALANCE
32450b57cec5SDimitry Andric extern double __kmp_load_balance_interval; // load balance algorithm interval
32460b57cec5SDimitry Andric #endif /* USE_LOAD_BALANCE */
32470b57cec5SDimitry Andric 
32480b57cec5SDimitry Andric // OpenMP 3.1 - Nested num threads array
32490b57cec5SDimitry Andric typedef struct kmp_nested_nthreads_t {
32500b57cec5SDimitry Andric   int *nth;
32510b57cec5SDimitry Andric   int size;
32520b57cec5SDimitry Andric   int used;
32530b57cec5SDimitry Andric } kmp_nested_nthreads_t;
32540b57cec5SDimitry Andric 
32550b57cec5SDimitry Andric extern kmp_nested_nthreads_t __kmp_nested_nth;
32560b57cec5SDimitry Andric 
32570b57cec5SDimitry Andric #if KMP_USE_ADAPTIVE_LOCKS
32580b57cec5SDimitry Andric 
32590b57cec5SDimitry Andric // Parameters for the speculative lock backoff system.
32600b57cec5SDimitry Andric struct kmp_adaptive_backoff_params_t {
32610b57cec5SDimitry Andric   // Number of soft retries before it counts as a hard retry.
32620b57cec5SDimitry Andric   kmp_uint32 max_soft_retries;
32630b57cec5SDimitry Andric   // Badness is a bit mask : 0,1,3,7,15,... on each hard failure we move one to
32640b57cec5SDimitry Andric   // the right
32650b57cec5SDimitry Andric   kmp_uint32 max_badness;
32660b57cec5SDimitry Andric };
32670b57cec5SDimitry Andric 
32680b57cec5SDimitry Andric extern kmp_adaptive_backoff_params_t __kmp_adaptive_backoff_params;
32690b57cec5SDimitry Andric 
32700b57cec5SDimitry Andric #if KMP_DEBUG_ADAPTIVE_LOCKS
32710b57cec5SDimitry Andric extern const char *__kmp_speculative_statsfile;
32720b57cec5SDimitry Andric #endif
32730b57cec5SDimitry Andric 
32740b57cec5SDimitry Andric #endif // KMP_USE_ADAPTIVE_LOCKS
32750b57cec5SDimitry Andric 
32760b57cec5SDimitry Andric extern int __kmp_display_env; /* TRUE or FALSE */
32770b57cec5SDimitry Andric extern int __kmp_display_env_verbose; /* TRUE if OMP_DISPLAY_ENV=VERBOSE */
32780b57cec5SDimitry Andric extern int __kmp_omp_cancellation; /* TRUE or FALSE */
3279fe6060f1SDimitry Andric extern int __kmp_nteams;
3280fe6060f1SDimitry Andric extern int __kmp_teams_thread_limit;
32810b57cec5SDimitry Andric 
32820b57cec5SDimitry Andric /* ------------------------------------------------------------------------- */
32830b57cec5SDimitry Andric 
32840b57cec5SDimitry Andric /* the following are protected by the fork/join lock */
32850b57cec5SDimitry Andric /* write: lock  read: anytime */
32860b57cec5SDimitry Andric extern kmp_info_t **__kmp_threads; /* Descriptors for the threads */
328781ad6265SDimitry Andric /* Holds old arrays of __kmp_threads until library shutdown */
328881ad6265SDimitry Andric extern kmp_old_threads_list_t *__kmp_old_threads_list;
32890b57cec5SDimitry Andric /* read/write: lock */
32900b57cec5SDimitry Andric extern volatile kmp_team_t *__kmp_team_pool;
32910b57cec5SDimitry Andric extern volatile kmp_info_t *__kmp_thread_pool;
32920b57cec5SDimitry Andric extern kmp_info_t *__kmp_thread_pool_insert_pt;
32930b57cec5SDimitry Andric 
32940b57cec5SDimitry Andric // total num threads reachable from some root thread including all root threads
32950b57cec5SDimitry Andric extern volatile int __kmp_nth;
32960b57cec5SDimitry Andric /* total number of threads reachable from some root thread including all root
32970b57cec5SDimitry Andric    threads, and those in the thread pool */
32980b57cec5SDimitry Andric extern volatile int __kmp_all_nth;
32990b57cec5SDimitry Andric extern std::atomic<int> __kmp_thread_pool_active_nth;
33000b57cec5SDimitry Andric 
33010b57cec5SDimitry Andric extern kmp_root_t **__kmp_root; /* root of thread hierarchy */
33020b57cec5SDimitry Andric /* end data protected by fork/join lock */
33030b57cec5SDimitry Andric /* ------------------------------------------------------------------------- */
33040b57cec5SDimitry Andric 
33050b57cec5SDimitry Andric #define __kmp_get_gtid() __kmp_get_global_thread_id()
33060b57cec5SDimitry Andric #define __kmp_entry_gtid() __kmp_get_global_thread_id_reg()
33070b57cec5SDimitry Andric #define __kmp_get_tid() (__kmp_tid_from_gtid(__kmp_get_gtid()))
33080b57cec5SDimitry Andric #define __kmp_get_team() (__kmp_threads[(__kmp_get_gtid())]->th.th_team)
33090b57cec5SDimitry Andric #define __kmp_get_thread() (__kmp_thread_from_gtid(__kmp_get_gtid()))
33100b57cec5SDimitry Andric 
33110b57cec5SDimitry Andric // AT: Which way is correct?
33120b57cec5SDimitry Andric // AT: 1. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team -> t.t_nproc;
33130b57cec5SDimitry Andric // AT: 2. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team_nproc;
33140b57cec5SDimitry Andric #define __kmp_get_team_num_threads(gtid)                                       \
33150b57cec5SDimitry Andric   (__kmp_threads[(gtid)]->th.th_team->t.t_nproc)
33160b57cec5SDimitry Andric 
33170b57cec5SDimitry Andric static inline bool KMP_UBER_GTID(int gtid) {
33180b57cec5SDimitry Andric   KMP_DEBUG_ASSERT(gtid >= KMP_GTID_MIN);
33190b57cec5SDimitry Andric   KMP_DEBUG_ASSERT(gtid < __kmp_threads_capacity);
33200b57cec5SDimitry Andric   return (gtid >= 0 && __kmp_root[gtid] && __kmp_threads[gtid] &&
33210b57cec5SDimitry Andric           __kmp_threads[gtid] == __kmp_root[gtid]->r.r_uber_thread);
33220b57cec5SDimitry Andric }
33230b57cec5SDimitry Andric 
33240b57cec5SDimitry Andric static inline int __kmp_tid_from_gtid(int gtid) {
33250b57cec5SDimitry Andric   KMP_DEBUG_ASSERT(gtid >= 0);
33260b57cec5SDimitry Andric   return __kmp_threads[gtid]->th.th_info.ds.ds_tid;
33270b57cec5SDimitry Andric }
33280b57cec5SDimitry Andric 
33290b57cec5SDimitry Andric static inline int __kmp_gtid_from_tid(int tid, const kmp_team_t *team) {
33300b57cec5SDimitry Andric   KMP_DEBUG_ASSERT(tid >= 0 && team);
33310b57cec5SDimitry Andric   return team->t.t_threads[tid]->th.th_info.ds.ds_gtid;
33320b57cec5SDimitry Andric }
33330b57cec5SDimitry Andric 
33340b57cec5SDimitry Andric static inline int __kmp_gtid_from_thread(const kmp_info_t *thr) {
33350b57cec5SDimitry Andric   KMP_DEBUG_ASSERT(thr);
33360b57cec5SDimitry Andric   return thr->th.th_info.ds.ds_gtid;
33370b57cec5SDimitry Andric }
33380b57cec5SDimitry Andric 
33390b57cec5SDimitry Andric static inline kmp_info_t *__kmp_thread_from_gtid(int gtid) {
33400b57cec5SDimitry Andric   KMP_DEBUG_ASSERT(gtid >= 0);
33410b57cec5SDimitry Andric   return __kmp_threads[gtid];
33420b57cec5SDimitry Andric }
33430b57cec5SDimitry Andric 
33440b57cec5SDimitry Andric static inline kmp_team_t *__kmp_team_from_gtid(int gtid) {
33450b57cec5SDimitry Andric   KMP_DEBUG_ASSERT(gtid >= 0);
33460b57cec5SDimitry Andric   return __kmp_threads[gtid]->th.th_team;
33470b57cec5SDimitry Andric }
33480b57cec5SDimitry Andric 
3349e8d8bef9SDimitry Andric static inline void __kmp_assert_valid_gtid(kmp_int32 gtid) {
3350e8d8bef9SDimitry Andric   if (UNLIKELY(gtid < 0 || gtid >= __kmp_threads_capacity))
3351e8d8bef9SDimitry Andric     KMP_FATAL(ThreadIdentInvalid);
3352e8d8bef9SDimitry Andric }
3353e8d8bef9SDimitry Andric 
3354e8d8bef9SDimitry Andric #if KMP_HAVE_MWAIT || KMP_HAVE_UMWAIT
3355e8d8bef9SDimitry Andric extern int __kmp_user_level_mwait; // TRUE or FALSE; from KMP_USER_LEVEL_MWAIT
3356e8d8bef9SDimitry Andric extern int __kmp_umwait_enabled; // Runtime check if user-level mwait enabled
3357e8d8bef9SDimitry Andric extern int __kmp_mwait_enabled; // Runtime check if ring3 mwait is enabled
3358e8d8bef9SDimitry Andric extern int __kmp_mwait_hints; // Hints to pass in to mwait
3359e8d8bef9SDimitry Andric #endif
3360e8d8bef9SDimitry Andric 
336104eeddc0SDimitry Andric #if KMP_HAVE_UMWAIT
336204eeddc0SDimitry Andric extern int __kmp_waitpkg_enabled; // Runtime check if waitpkg exists
336304eeddc0SDimitry Andric extern int __kmp_tpause_state; // 0 (default), 1=C0.1, 2=C0.2; from KMP_TPAUSE
336404eeddc0SDimitry Andric extern int __kmp_tpause_hint; // 1=C0.1 (default), 0=C0.2; from KMP_TPAUSE
336504eeddc0SDimitry Andric extern int __kmp_tpause_enabled; // 0 (default), 1 (KMP_TPAUSE is non-zero)
336604eeddc0SDimitry Andric #endif
336704eeddc0SDimitry Andric 
33680b57cec5SDimitry Andric /* ------------------------------------------------------------------------- */
33690b57cec5SDimitry Andric 
33700b57cec5SDimitry Andric extern kmp_global_t __kmp_global; /* global status */
33710b57cec5SDimitry Andric 
33720b57cec5SDimitry Andric extern kmp_info_t __kmp_monitor;
33730b57cec5SDimitry Andric // For Debugging Support Library
33740b57cec5SDimitry Andric extern std::atomic<kmp_int32> __kmp_team_counter;
33750b57cec5SDimitry Andric // For Debugging Support Library
33760b57cec5SDimitry Andric extern std::atomic<kmp_int32> __kmp_task_counter;
33770b57cec5SDimitry Andric 
33780b57cec5SDimitry Andric #if USE_DEBUGGER
33790b57cec5SDimitry Andric #define _KMP_GEN_ID(counter)                                                   \
33800b57cec5SDimitry Andric   (__kmp_debugging ? KMP_ATOMIC_INC(&counter) + 1 : ~0)
33810b57cec5SDimitry Andric #else
33820b57cec5SDimitry Andric #define _KMP_GEN_ID(counter) (~0)
33830b57cec5SDimitry Andric #endif /* USE_DEBUGGER */
33840b57cec5SDimitry Andric 
33850b57cec5SDimitry Andric #define KMP_GEN_TASK_ID() _KMP_GEN_ID(__kmp_task_counter)
33860b57cec5SDimitry Andric #define KMP_GEN_TEAM_ID() _KMP_GEN_ID(__kmp_team_counter)
33870b57cec5SDimitry Andric 
33880b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
33890b57cec5SDimitry Andric 
33900b57cec5SDimitry Andric extern void __kmp_print_storage_map_gtid(int gtid, void *p1, void *p2,
33910b57cec5SDimitry Andric                                          size_t size, char const *format, ...);
33920b57cec5SDimitry Andric 
33930b57cec5SDimitry Andric extern void __kmp_serial_initialize(void);
33940b57cec5SDimitry Andric extern void __kmp_middle_initialize(void);
33950b57cec5SDimitry Andric extern void __kmp_parallel_initialize(void);
33960b57cec5SDimitry Andric 
33970b57cec5SDimitry Andric extern void __kmp_internal_begin(void);
33980b57cec5SDimitry Andric extern void __kmp_internal_end_library(int gtid);
33990b57cec5SDimitry Andric extern void __kmp_internal_end_thread(int gtid);
34000b57cec5SDimitry Andric extern void __kmp_internal_end_atexit(void);
34010b57cec5SDimitry Andric extern void __kmp_internal_end_dtor(void);
34020b57cec5SDimitry Andric extern void __kmp_internal_end_dest(void *);
34030b57cec5SDimitry Andric 
34040b57cec5SDimitry Andric extern int __kmp_register_root(int initial_thread);
34050b57cec5SDimitry Andric extern void __kmp_unregister_root(int gtid);
3406e8d8bef9SDimitry Andric extern void __kmp_unregister_library(void); // called by __kmp_internal_end()
34070b57cec5SDimitry Andric 
34080b57cec5SDimitry Andric extern int __kmp_ignore_mppbeg(void);
34090b57cec5SDimitry Andric extern int __kmp_ignore_mppend(void);
34100b57cec5SDimitry Andric 
34110b57cec5SDimitry Andric extern int __kmp_enter_single(int gtid, ident_t *id_ref, int push_ws);
34120b57cec5SDimitry Andric extern void __kmp_exit_single(int gtid);
34130b57cec5SDimitry Andric 
34140b57cec5SDimitry Andric extern void __kmp_parallel_deo(int *gtid_ref, int *cid_ref, ident_t *loc_ref);
34150b57cec5SDimitry Andric extern void __kmp_parallel_dxo(int *gtid_ref, int *cid_ref, ident_t *loc_ref);
34160b57cec5SDimitry Andric 
34170b57cec5SDimitry Andric #ifdef USE_LOAD_BALANCE
34180b57cec5SDimitry Andric extern int __kmp_get_load_balance(int);
34190b57cec5SDimitry Andric #endif
34200b57cec5SDimitry Andric 
34210b57cec5SDimitry Andric extern int __kmp_get_global_thread_id(void);
34220b57cec5SDimitry Andric extern int __kmp_get_global_thread_id_reg(void);
34230b57cec5SDimitry Andric extern void __kmp_exit_thread(int exit_status);
34240b57cec5SDimitry Andric extern void __kmp_abort(char const *format, ...);
34250b57cec5SDimitry Andric extern void __kmp_abort_thread(void);
34260b57cec5SDimitry Andric KMP_NORETURN extern void __kmp_abort_process(void);
34270b57cec5SDimitry Andric extern void __kmp_warn(char const *format, ...);
34280b57cec5SDimitry Andric 
34290b57cec5SDimitry Andric extern void __kmp_set_num_threads(int new_nth, int gtid);
34300b57cec5SDimitry Andric 
34310b57cec5SDimitry Andric // Returns current thread (pointer to kmp_info_t). Current thread *must* be
34320b57cec5SDimitry Andric // registered.
34330b57cec5SDimitry Andric static inline kmp_info_t *__kmp_entry_thread() {
34340b57cec5SDimitry Andric   int gtid = __kmp_entry_gtid();
34350b57cec5SDimitry Andric 
34360b57cec5SDimitry Andric   return __kmp_threads[gtid];
34370b57cec5SDimitry Andric }
34380b57cec5SDimitry Andric 
34390b57cec5SDimitry Andric extern void __kmp_set_max_active_levels(int gtid, int new_max_active_levels);
34400b57cec5SDimitry Andric extern int __kmp_get_max_active_levels(int gtid);
34410b57cec5SDimitry Andric extern int __kmp_get_ancestor_thread_num(int gtid, int level);
34420b57cec5SDimitry Andric extern int __kmp_get_team_size(int gtid, int level);
34430b57cec5SDimitry Andric extern void __kmp_set_schedule(int gtid, kmp_sched_t new_sched, int chunk);
34440b57cec5SDimitry Andric extern void __kmp_get_schedule(int gtid, kmp_sched_t *sched, int *chunk);
34450b57cec5SDimitry Andric 
34460b57cec5SDimitry Andric extern unsigned short __kmp_get_random(kmp_info_t *thread);
34470b57cec5SDimitry Andric extern void __kmp_init_random(kmp_info_t *thread);
34480b57cec5SDimitry Andric 
34490b57cec5SDimitry Andric extern kmp_r_sched_t __kmp_get_schedule_global(void);
34500b57cec5SDimitry Andric extern void __kmp_adjust_num_threads(int new_nproc);
34510b57cec5SDimitry Andric extern void __kmp_check_stksize(size_t *val);
34520b57cec5SDimitry Andric 
34530b57cec5SDimitry Andric extern void *___kmp_allocate(size_t size KMP_SRC_LOC_DECL);
34540b57cec5SDimitry Andric extern void *___kmp_page_allocate(size_t size KMP_SRC_LOC_DECL);
34550b57cec5SDimitry Andric extern void ___kmp_free(void *ptr KMP_SRC_LOC_DECL);
34560b57cec5SDimitry Andric #define __kmp_allocate(size) ___kmp_allocate((size)KMP_SRC_LOC_CURR)
34570b57cec5SDimitry Andric #define __kmp_page_allocate(size) ___kmp_page_allocate((size)KMP_SRC_LOC_CURR)
34580b57cec5SDimitry Andric #define __kmp_free(ptr) ___kmp_free((ptr)KMP_SRC_LOC_CURR)
34590b57cec5SDimitry Andric 
34600b57cec5SDimitry Andric #if USE_FAST_MEMORY
34610b57cec5SDimitry Andric extern void *___kmp_fast_allocate(kmp_info_t *this_thr,
34620b57cec5SDimitry Andric                                   size_t size KMP_SRC_LOC_DECL);
34630b57cec5SDimitry Andric extern void ___kmp_fast_free(kmp_info_t *this_thr, void *ptr KMP_SRC_LOC_DECL);
34640b57cec5SDimitry Andric extern void __kmp_free_fast_memory(kmp_info_t *this_thr);
34650b57cec5SDimitry Andric extern void __kmp_initialize_fast_memory(kmp_info_t *this_thr);
34660b57cec5SDimitry Andric #define __kmp_fast_allocate(this_thr, size)                                    \
34670b57cec5SDimitry Andric   ___kmp_fast_allocate((this_thr), (size)KMP_SRC_LOC_CURR)
34680b57cec5SDimitry Andric #define __kmp_fast_free(this_thr, ptr)                                         \
34690b57cec5SDimitry Andric   ___kmp_fast_free((this_thr), (ptr)KMP_SRC_LOC_CURR)
34700b57cec5SDimitry Andric #endif
34710b57cec5SDimitry Andric 
34720b57cec5SDimitry Andric extern void *___kmp_thread_malloc(kmp_info_t *th, size_t size KMP_SRC_LOC_DECL);
34730b57cec5SDimitry Andric extern void *___kmp_thread_calloc(kmp_info_t *th, size_t nelem,
34740b57cec5SDimitry Andric                                   size_t elsize KMP_SRC_LOC_DECL);
34750b57cec5SDimitry Andric extern void *___kmp_thread_realloc(kmp_info_t *th, void *ptr,
34760b57cec5SDimitry Andric                                    size_t size KMP_SRC_LOC_DECL);
34770b57cec5SDimitry Andric extern void ___kmp_thread_free(kmp_info_t *th, void *ptr KMP_SRC_LOC_DECL);
34780b57cec5SDimitry Andric #define __kmp_thread_malloc(th, size)                                          \
34790b57cec5SDimitry Andric   ___kmp_thread_malloc((th), (size)KMP_SRC_LOC_CURR)
34800b57cec5SDimitry Andric #define __kmp_thread_calloc(th, nelem, elsize)                                 \
34810b57cec5SDimitry Andric   ___kmp_thread_calloc((th), (nelem), (elsize)KMP_SRC_LOC_CURR)
34820b57cec5SDimitry Andric #define __kmp_thread_realloc(th, ptr, size)                                    \
34830b57cec5SDimitry Andric   ___kmp_thread_realloc((th), (ptr), (size)KMP_SRC_LOC_CURR)
34840b57cec5SDimitry Andric #define __kmp_thread_free(th, ptr)                                             \
34850b57cec5SDimitry Andric   ___kmp_thread_free((th), (ptr)KMP_SRC_LOC_CURR)
34860b57cec5SDimitry Andric 
34870b57cec5SDimitry Andric extern void __kmp_push_num_threads(ident_t *loc, int gtid, int num_threads);
34880b57cec5SDimitry Andric 
34890b57cec5SDimitry Andric extern void __kmp_push_proc_bind(ident_t *loc, int gtid,
34900b57cec5SDimitry Andric                                  kmp_proc_bind_t proc_bind);
34910b57cec5SDimitry Andric extern void __kmp_push_num_teams(ident_t *loc, int gtid, int num_teams,
34920b57cec5SDimitry Andric                                  int num_threads);
3493fe6060f1SDimitry Andric extern void __kmp_push_num_teams_51(ident_t *loc, int gtid, int num_teams_lb,
3494fe6060f1SDimitry Andric                                     int num_teams_ub, int num_threads);
34950b57cec5SDimitry Andric 
34960b57cec5SDimitry Andric extern void __kmp_yield();
34970b57cec5SDimitry Andric 
34980b57cec5SDimitry Andric extern void __kmpc_dispatch_init_4(ident_t *loc, kmp_int32 gtid,
34990b57cec5SDimitry Andric                                    enum sched_type schedule, kmp_int32 lb,
35000b57cec5SDimitry Andric                                    kmp_int32 ub, kmp_int32 st, kmp_int32 chunk);
35010b57cec5SDimitry Andric extern void __kmpc_dispatch_init_4u(ident_t *loc, kmp_int32 gtid,
35020b57cec5SDimitry Andric                                     enum sched_type schedule, kmp_uint32 lb,
35030b57cec5SDimitry Andric                                     kmp_uint32 ub, kmp_int32 st,
35040b57cec5SDimitry Andric                                     kmp_int32 chunk);
35050b57cec5SDimitry Andric extern void __kmpc_dispatch_init_8(ident_t *loc, kmp_int32 gtid,
35060b57cec5SDimitry Andric                                    enum sched_type schedule, kmp_int64 lb,
35070b57cec5SDimitry Andric                                    kmp_int64 ub, kmp_int64 st, kmp_int64 chunk);
35080b57cec5SDimitry Andric extern void __kmpc_dispatch_init_8u(ident_t *loc, kmp_int32 gtid,
35090b57cec5SDimitry Andric                                     enum sched_type schedule, kmp_uint64 lb,
35100b57cec5SDimitry Andric                                     kmp_uint64 ub, kmp_int64 st,
35110b57cec5SDimitry Andric                                     kmp_int64 chunk);
35120b57cec5SDimitry Andric 
35130b57cec5SDimitry Andric extern int __kmpc_dispatch_next_4(ident_t *loc, kmp_int32 gtid,
35140b57cec5SDimitry Andric                                   kmp_int32 *p_last, kmp_int32 *p_lb,
35150b57cec5SDimitry Andric                                   kmp_int32 *p_ub, kmp_int32 *p_st);
35160b57cec5SDimitry Andric extern int __kmpc_dispatch_next_4u(ident_t *loc, kmp_int32 gtid,
35170b57cec5SDimitry Andric                                    kmp_int32 *p_last, kmp_uint32 *p_lb,
35180b57cec5SDimitry Andric                                    kmp_uint32 *p_ub, kmp_int32 *p_st);
35190b57cec5SDimitry Andric extern int __kmpc_dispatch_next_8(ident_t *loc, kmp_int32 gtid,
35200b57cec5SDimitry Andric                                   kmp_int32 *p_last, kmp_int64 *p_lb,
35210b57cec5SDimitry Andric                                   kmp_int64 *p_ub, kmp_int64 *p_st);
35220b57cec5SDimitry Andric extern int __kmpc_dispatch_next_8u(ident_t *loc, kmp_int32 gtid,
35230b57cec5SDimitry Andric                                    kmp_int32 *p_last, kmp_uint64 *p_lb,
35240b57cec5SDimitry Andric                                    kmp_uint64 *p_ub, kmp_int64 *p_st);
35250b57cec5SDimitry Andric 
35260b57cec5SDimitry Andric extern void __kmpc_dispatch_fini_4(ident_t *loc, kmp_int32 gtid);
35270b57cec5SDimitry Andric extern void __kmpc_dispatch_fini_8(ident_t *loc, kmp_int32 gtid);
35280b57cec5SDimitry Andric extern void __kmpc_dispatch_fini_4u(ident_t *loc, kmp_int32 gtid);
35290b57cec5SDimitry Andric extern void __kmpc_dispatch_fini_8u(ident_t *loc, kmp_int32 gtid);
35300b57cec5SDimitry Andric 
35310b57cec5SDimitry Andric #ifdef KMP_GOMP_COMPAT
35320b57cec5SDimitry Andric 
35330b57cec5SDimitry Andric extern void __kmp_aux_dispatch_init_4(ident_t *loc, kmp_int32 gtid,
35340b57cec5SDimitry Andric                                       enum sched_type schedule, kmp_int32 lb,
35350b57cec5SDimitry Andric                                       kmp_int32 ub, kmp_int32 st,
35360b57cec5SDimitry Andric                                       kmp_int32 chunk, int push_ws);
35370b57cec5SDimitry Andric extern void __kmp_aux_dispatch_init_4u(ident_t *loc, kmp_int32 gtid,
35380b57cec5SDimitry Andric                                        enum sched_type schedule, kmp_uint32 lb,
35390b57cec5SDimitry Andric                                        kmp_uint32 ub, kmp_int32 st,
35400b57cec5SDimitry Andric                                        kmp_int32 chunk, int push_ws);
35410b57cec5SDimitry Andric extern void __kmp_aux_dispatch_init_8(ident_t *loc, kmp_int32 gtid,
35420b57cec5SDimitry Andric                                       enum sched_type schedule, kmp_int64 lb,
35430b57cec5SDimitry Andric                                       kmp_int64 ub, kmp_int64 st,
35440b57cec5SDimitry Andric                                       kmp_int64 chunk, int push_ws);
35450b57cec5SDimitry Andric extern void __kmp_aux_dispatch_init_8u(ident_t *loc, kmp_int32 gtid,
35460b57cec5SDimitry Andric                                        enum sched_type schedule, kmp_uint64 lb,
35470b57cec5SDimitry Andric                                        kmp_uint64 ub, kmp_int64 st,
35480b57cec5SDimitry Andric                                        kmp_int64 chunk, int push_ws);
35490b57cec5SDimitry Andric extern void __kmp_aux_dispatch_fini_chunk_4(ident_t *loc, kmp_int32 gtid);
35500b57cec5SDimitry Andric extern void __kmp_aux_dispatch_fini_chunk_8(ident_t *loc, kmp_int32 gtid);
35510b57cec5SDimitry Andric extern void __kmp_aux_dispatch_fini_chunk_4u(ident_t *loc, kmp_int32 gtid);
35520b57cec5SDimitry Andric extern void __kmp_aux_dispatch_fini_chunk_8u(ident_t *loc, kmp_int32 gtid);
35530b57cec5SDimitry Andric 
35540b57cec5SDimitry Andric #endif /* KMP_GOMP_COMPAT */
35550b57cec5SDimitry Andric 
35560b57cec5SDimitry Andric extern kmp_uint32 __kmp_eq_4(kmp_uint32 value, kmp_uint32 checker);
35570b57cec5SDimitry Andric extern kmp_uint32 __kmp_neq_4(kmp_uint32 value, kmp_uint32 checker);
35580b57cec5SDimitry Andric extern kmp_uint32 __kmp_lt_4(kmp_uint32 value, kmp_uint32 checker);
35590b57cec5SDimitry Andric extern kmp_uint32 __kmp_ge_4(kmp_uint32 value, kmp_uint32 checker);
35600b57cec5SDimitry Andric extern kmp_uint32 __kmp_le_4(kmp_uint32 value, kmp_uint32 checker);
35610b57cec5SDimitry Andric extern kmp_uint32 __kmp_wait_4(kmp_uint32 volatile *spinner, kmp_uint32 checker,
35620b57cec5SDimitry Andric                                kmp_uint32 (*pred)(kmp_uint32, kmp_uint32),
35630b57cec5SDimitry Andric                                void *obj);
35640b57cec5SDimitry Andric extern void __kmp_wait_4_ptr(void *spinner, kmp_uint32 checker,
35650b57cec5SDimitry Andric                              kmp_uint32 (*pred)(void *, kmp_uint32), void *obj);
35660b57cec5SDimitry Andric 
3567e8d8bef9SDimitry Andric extern void __kmp_wait_64(kmp_info_t *this_thr, kmp_flag_64<> *flag,
35680b57cec5SDimitry Andric                           int final_spin
35690b57cec5SDimitry Andric #if USE_ITT_BUILD
35700b57cec5SDimitry Andric                           ,
35710b57cec5SDimitry Andric                           void *itt_sync_obj
35720b57cec5SDimitry Andric #endif
35730b57cec5SDimitry Andric );
3574e8d8bef9SDimitry Andric extern void __kmp_release_64(kmp_flag_64<> *flag);
35750b57cec5SDimitry Andric 
35760b57cec5SDimitry Andric extern void __kmp_infinite_loop(void);
35770b57cec5SDimitry Andric 
35780b57cec5SDimitry Andric extern void __kmp_cleanup(void);
35790b57cec5SDimitry Andric 
35800b57cec5SDimitry Andric #if KMP_HANDLE_SIGNALS
35810b57cec5SDimitry Andric extern int __kmp_handle_signals;
35820b57cec5SDimitry Andric extern void __kmp_install_signals(int parallel_init);
35830b57cec5SDimitry Andric extern void __kmp_remove_signals(void);
35840b57cec5SDimitry Andric #endif
35850b57cec5SDimitry Andric 
35860b57cec5SDimitry Andric extern void __kmp_clear_system_time(void);
35870b57cec5SDimitry Andric extern void __kmp_read_system_time(double *delta);
35880b57cec5SDimitry Andric 
35890b57cec5SDimitry Andric extern void __kmp_check_stack_overlap(kmp_info_t *thr);
35900b57cec5SDimitry Andric 
35910b57cec5SDimitry Andric extern void __kmp_expand_host_name(char *buffer, size_t size);
35920b57cec5SDimitry Andric extern void __kmp_expand_file_name(char *result, size_t rlen, char *pattern);
35930b57cec5SDimitry Andric 
3594fe6060f1SDimitry Andric #if KMP_ARCH_X86 || KMP_ARCH_X86_64 || (KMP_OS_WINDOWS && KMP_ARCH_AARCH64)
35950b57cec5SDimitry Andric extern void
35960b57cec5SDimitry Andric __kmp_initialize_system_tick(void); /* Initialize timer tick value */
35970b57cec5SDimitry Andric #endif
35980b57cec5SDimitry Andric 
35990b57cec5SDimitry Andric extern void
36000b57cec5SDimitry Andric __kmp_runtime_initialize(void); /* machine specific initialization */
36010b57cec5SDimitry Andric extern void __kmp_runtime_destroy(void);
36020b57cec5SDimitry Andric 
36030b57cec5SDimitry Andric #if KMP_AFFINITY_SUPPORTED
36040b57cec5SDimitry Andric extern char *__kmp_affinity_print_mask(char *buf, int buf_len,
36050b57cec5SDimitry Andric                                        kmp_affin_mask_t *mask);
36060b57cec5SDimitry Andric extern kmp_str_buf_t *__kmp_affinity_str_buf_mask(kmp_str_buf_t *buf,
36070b57cec5SDimitry Andric                                                   kmp_affin_mask_t *mask);
36080b57cec5SDimitry Andric extern void __kmp_affinity_initialize(void);
36090b57cec5SDimitry Andric extern void __kmp_affinity_uninitialize(void);
36100b57cec5SDimitry Andric extern void __kmp_affinity_set_init_mask(
36110b57cec5SDimitry Andric     int gtid, int isa_root); /* set affinity according to KMP_AFFINITY */
36120b57cec5SDimitry Andric extern void __kmp_affinity_set_place(int gtid);
36130b57cec5SDimitry Andric extern void __kmp_affinity_determine_capable(const char *env_var);
36140b57cec5SDimitry Andric extern int __kmp_aux_set_affinity(void **mask);
36150b57cec5SDimitry Andric extern int __kmp_aux_get_affinity(void **mask);
36160b57cec5SDimitry Andric extern int __kmp_aux_get_affinity_max_proc();
36170b57cec5SDimitry Andric extern int __kmp_aux_set_affinity_mask_proc(int proc, void **mask);
36180b57cec5SDimitry Andric extern int __kmp_aux_unset_affinity_mask_proc(int proc, void **mask);
36190b57cec5SDimitry Andric extern int __kmp_aux_get_affinity_mask_proc(int proc, void **mask);
36200b57cec5SDimitry Andric extern void __kmp_balanced_affinity(kmp_info_t *th, int team_size);
3621489b1cf2SDimitry Andric #if KMP_OS_LINUX || KMP_OS_FREEBSD
36220b57cec5SDimitry Andric extern int kmp_set_thread_affinity_mask_initial(void);
36230b57cec5SDimitry Andric #endif
3624fe6060f1SDimitry Andric static inline void __kmp_assign_root_init_mask() {
3625fe6060f1SDimitry Andric   int gtid = __kmp_entry_gtid();
3626fe6060f1SDimitry Andric   kmp_root_t *r = __kmp_threads[gtid]->th.th_root;
3627fe6060f1SDimitry Andric   if (r->r.r_uber_thread == __kmp_threads[gtid] && !r->r.r_affinity_assigned) {
3628fe6060f1SDimitry Andric     __kmp_affinity_set_init_mask(gtid, TRUE);
3629fe6060f1SDimitry Andric     r->r.r_affinity_assigned = TRUE;
3630fe6060f1SDimitry Andric   }
3631fe6060f1SDimitry Andric }
3632*fcaf7f86SDimitry Andric static inline void __kmp_reset_root_init_mask(int gtid) {
3633*fcaf7f86SDimitry Andric   kmp_info_t *th = __kmp_threads[gtid];
3634*fcaf7f86SDimitry Andric   kmp_root_t *r = th->th.th_root;
3635*fcaf7f86SDimitry Andric   if (r->r.r_uber_thread == th && r->r.r_affinity_assigned) {
3636*fcaf7f86SDimitry Andric     __kmp_set_system_affinity(__kmp_affin_origMask, FALSE);
3637*fcaf7f86SDimitry Andric     KMP_CPU_COPY(th->th.th_affin_mask, __kmp_affin_origMask);
3638*fcaf7f86SDimitry Andric     r->r.r_affinity_assigned = FALSE;
3639*fcaf7f86SDimitry Andric   }
3640*fcaf7f86SDimitry Andric }
3641fe6060f1SDimitry Andric #else /* KMP_AFFINITY_SUPPORTED */
3642fe6060f1SDimitry Andric #define __kmp_assign_root_init_mask() /* Nothing */
3643*fcaf7f86SDimitry Andric static inline void __kmp_reset_root_init_mask(int gtid) {}
36440b57cec5SDimitry Andric #endif /* KMP_AFFINITY_SUPPORTED */
36450b57cec5SDimitry Andric // No need for KMP_AFFINITY_SUPPORTED guard as only one field in the
36460b57cec5SDimitry Andric // format string is for affinity, so platforms that do not support
36470b57cec5SDimitry Andric // affinity can still use the other fields, e.g., %n for num_threads
36480b57cec5SDimitry Andric extern size_t __kmp_aux_capture_affinity(int gtid, const char *format,
36490b57cec5SDimitry Andric                                          kmp_str_buf_t *buffer);
36500b57cec5SDimitry Andric extern void __kmp_aux_display_affinity(int gtid, const char *format);
36510b57cec5SDimitry Andric 
36520b57cec5SDimitry Andric extern void __kmp_cleanup_hierarchy();
36530b57cec5SDimitry Andric extern void __kmp_get_hierarchy(kmp_uint32 nproc, kmp_bstate_t *thr_bar);
36540b57cec5SDimitry Andric 
36550b57cec5SDimitry Andric #if KMP_USE_FUTEX
36560b57cec5SDimitry Andric 
36570b57cec5SDimitry Andric extern int __kmp_futex_determine_capable(void);
36580b57cec5SDimitry Andric 
36590b57cec5SDimitry Andric #endif // KMP_USE_FUTEX
36600b57cec5SDimitry Andric 
36610b57cec5SDimitry Andric extern void __kmp_gtid_set_specific(int gtid);
36620b57cec5SDimitry Andric extern int __kmp_gtid_get_specific(void);
36630b57cec5SDimitry Andric 
36640b57cec5SDimitry Andric extern double __kmp_read_cpu_time(void);
36650b57cec5SDimitry Andric 
36660b57cec5SDimitry Andric extern int __kmp_read_system_info(struct kmp_sys_info *info);
36670b57cec5SDimitry Andric 
36680b57cec5SDimitry Andric #if KMP_USE_MONITOR
36690b57cec5SDimitry Andric extern void __kmp_create_monitor(kmp_info_t *th);
36700b57cec5SDimitry Andric #endif
36710b57cec5SDimitry Andric 
36720b57cec5SDimitry Andric extern void *__kmp_launch_thread(kmp_info_t *thr);
36730b57cec5SDimitry Andric 
36740b57cec5SDimitry Andric extern void __kmp_create_worker(int gtid, kmp_info_t *th, size_t stack_size);
36750b57cec5SDimitry Andric 
36760b57cec5SDimitry Andric #if KMP_OS_WINDOWS
36770b57cec5SDimitry Andric extern int __kmp_still_running(kmp_info_t *th);
36780b57cec5SDimitry Andric extern int __kmp_is_thread_alive(kmp_info_t *th, DWORD *exit_val);
36790b57cec5SDimitry Andric extern void __kmp_free_handle(kmp_thread_t tHandle);
36800b57cec5SDimitry Andric #endif
36810b57cec5SDimitry Andric 
36820b57cec5SDimitry Andric #if KMP_USE_MONITOR
36830b57cec5SDimitry Andric extern void __kmp_reap_monitor(kmp_info_t *th);
36840b57cec5SDimitry Andric #endif
36850b57cec5SDimitry Andric extern void __kmp_reap_worker(kmp_info_t *th);
36860b57cec5SDimitry Andric extern void __kmp_terminate_thread(int gtid);
36870b57cec5SDimitry Andric 
36880b57cec5SDimitry Andric extern int __kmp_try_suspend_mx(kmp_info_t *th);
36890b57cec5SDimitry Andric extern void __kmp_lock_suspend_mx(kmp_info_t *th);
36900b57cec5SDimitry Andric extern void __kmp_unlock_suspend_mx(kmp_info_t *th);
36910b57cec5SDimitry Andric 
36920b57cec5SDimitry Andric extern void __kmp_elapsed(double *);
36930b57cec5SDimitry Andric extern void __kmp_elapsed_tick(double *);
36940b57cec5SDimitry Andric 
36950b57cec5SDimitry Andric extern void __kmp_enable(int old_state);
36960b57cec5SDimitry Andric extern void __kmp_disable(int *old_state);
36970b57cec5SDimitry Andric 
36980b57cec5SDimitry Andric extern void __kmp_thread_sleep(int millis);
36990b57cec5SDimitry Andric 
37000b57cec5SDimitry Andric extern void __kmp_common_initialize(void);
37010b57cec5SDimitry Andric extern void __kmp_common_destroy(void);
37020b57cec5SDimitry Andric extern void __kmp_common_destroy_gtid(int gtid);
37030b57cec5SDimitry Andric 
37040b57cec5SDimitry Andric #if KMP_OS_UNIX
37050b57cec5SDimitry Andric extern void __kmp_register_atfork(void);
37060b57cec5SDimitry Andric #endif
37070b57cec5SDimitry Andric extern void __kmp_suspend_initialize(void);
37080b57cec5SDimitry Andric extern void __kmp_suspend_initialize_thread(kmp_info_t *th);
37090b57cec5SDimitry Andric extern void __kmp_suspend_uninitialize_thread(kmp_info_t *th);
37100b57cec5SDimitry Andric 
37110b57cec5SDimitry Andric extern kmp_info_t *__kmp_allocate_thread(kmp_root_t *root, kmp_team_t *team,
37120b57cec5SDimitry Andric                                          int tid);
37130b57cec5SDimitry Andric extern kmp_team_t *
37140b57cec5SDimitry Andric __kmp_allocate_team(kmp_root_t *root, int new_nproc, int max_nproc,
37150b57cec5SDimitry Andric #if OMPT_SUPPORT
37160b57cec5SDimitry Andric                     ompt_data_t ompt_parallel_data,
37170b57cec5SDimitry Andric #endif
37180b57cec5SDimitry Andric                     kmp_proc_bind_t proc_bind, kmp_internal_control_t *new_icvs,
37190b57cec5SDimitry Andric                     int argc USE_NESTED_HOT_ARG(kmp_info_t *thr));
37200b57cec5SDimitry Andric extern void __kmp_free_thread(kmp_info_t *);
37210b57cec5SDimitry Andric extern void __kmp_free_team(kmp_root_t *,
37220b57cec5SDimitry Andric                             kmp_team_t *USE_NESTED_HOT_ARG(kmp_info_t *));
37230b57cec5SDimitry Andric extern kmp_team_t *__kmp_reap_team(kmp_team_t *);
37240b57cec5SDimitry Andric 
37250b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
37260b57cec5SDimitry Andric 
37270b57cec5SDimitry Andric extern void __kmp_initialize_bget(kmp_info_t *th);
37280b57cec5SDimitry Andric extern void __kmp_finalize_bget(kmp_info_t *th);
37290b57cec5SDimitry Andric 
37300b57cec5SDimitry Andric KMP_EXPORT void *kmpc_malloc(size_t size);
37310b57cec5SDimitry Andric KMP_EXPORT void *kmpc_aligned_malloc(size_t size, size_t alignment);
37320b57cec5SDimitry Andric KMP_EXPORT void *kmpc_calloc(size_t nelem, size_t elsize);
37330b57cec5SDimitry Andric KMP_EXPORT void *kmpc_realloc(void *ptr, size_t size);
37340b57cec5SDimitry Andric KMP_EXPORT void kmpc_free(void *ptr);
37350b57cec5SDimitry Andric 
37360b57cec5SDimitry Andric /* declarations for internal use */
37370b57cec5SDimitry Andric 
37380b57cec5SDimitry Andric extern int __kmp_barrier(enum barrier_type bt, int gtid, int is_split,
37390b57cec5SDimitry Andric                          size_t reduce_size, void *reduce_data,
37400b57cec5SDimitry Andric                          void (*reduce)(void *, void *));
37410b57cec5SDimitry Andric extern void __kmp_end_split_barrier(enum barrier_type bt, int gtid);
37420b57cec5SDimitry Andric extern int __kmp_barrier_gomp_cancel(int gtid);
37430b57cec5SDimitry Andric 
37440b57cec5SDimitry Andric /*!
37450b57cec5SDimitry Andric  * Tell the fork call which compiler generated the fork call, and therefore how
37460b57cec5SDimitry Andric  * to deal with the call.
37470b57cec5SDimitry Andric  */
37480b57cec5SDimitry Andric enum fork_context_e {
37490b57cec5SDimitry Andric   fork_context_gnu, /**< Called from GNU generated code, so must not invoke the
37500b57cec5SDimitry Andric                        microtask internally. */
37510b57cec5SDimitry Andric   fork_context_intel, /**< Called from Intel generated code.  */
37520b57cec5SDimitry Andric   fork_context_last
37530b57cec5SDimitry Andric };
37540b57cec5SDimitry Andric extern int __kmp_fork_call(ident_t *loc, int gtid,
37550b57cec5SDimitry Andric                            enum fork_context_e fork_context, kmp_int32 argc,
37560b57cec5SDimitry Andric                            microtask_t microtask, launch_t invoker,
375716794618SDimitry Andric                            kmp_va_list ap);
37580b57cec5SDimitry Andric 
37590b57cec5SDimitry Andric extern void __kmp_join_call(ident_t *loc, int gtid
37600b57cec5SDimitry Andric #if OMPT_SUPPORT
37610b57cec5SDimitry Andric                             ,
37620b57cec5SDimitry Andric                             enum fork_context_e fork_context
37630b57cec5SDimitry Andric #endif
37640b57cec5SDimitry Andric                             ,
37650b57cec5SDimitry Andric                             int exit_teams = 0);
37660b57cec5SDimitry Andric 
37670b57cec5SDimitry Andric extern void __kmp_serialized_parallel(ident_t *id, kmp_int32 gtid);
37680b57cec5SDimitry Andric extern void __kmp_internal_fork(ident_t *id, int gtid, kmp_team_t *team);
37690b57cec5SDimitry Andric extern void __kmp_internal_join(ident_t *id, int gtid, kmp_team_t *team);
37700b57cec5SDimitry Andric extern int __kmp_invoke_task_func(int gtid);
37710b57cec5SDimitry Andric extern void __kmp_run_before_invoked_task(int gtid, int tid,
37720b57cec5SDimitry Andric                                           kmp_info_t *this_thr,
37730b57cec5SDimitry Andric                                           kmp_team_t *team);
37740b57cec5SDimitry Andric extern void __kmp_run_after_invoked_task(int gtid, int tid,
37750b57cec5SDimitry Andric                                          kmp_info_t *this_thr,
37760b57cec5SDimitry Andric                                          kmp_team_t *team);
37770b57cec5SDimitry Andric 
37780b57cec5SDimitry Andric // should never have been exported
37790b57cec5SDimitry Andric KMP_EXPORT int __kmpc_invoke_task_func(int gtid);
37800b57cec5SDimitry Andric extern int __kmp_invoke_teams_master(int gtid);
37810b57cec5SDimitry Andric extern void __kmp_teams_master(int gtid);
37820b57cec5SDimitry Andric extern int __kmp_aux_get_team_num();
37830b57cec5SDimitry Andric extern int __kmp_aux_get_num_teams();
37840b57cec5SDimitry Andric extern void __kmp_save_internal_controls(kmp_info_t *thread);
37850b57cec5SDimitry Andric extern void __kmp_user_set_library(enum library_type arg);
37860b57cec5SDimitry Andric extern void __kmp_aux_set_library(enum library_type arg);
37870b57cec5SDimitry Andric extern void __kmp_aux_set_stacksize(size_t arg);
37880b57cec5SDimitry Andric extern void __kmp_aux_set_blocktime(int arg, kmp_info_t *thread, int tid);
3789e8d8bef9SDimitry Andric extern void __kmp_aux_set_defaults(char const *str, size_t len);
37900b57cec5SDimitry Andric 
37910b57cec5SDimitry Andric /* Functions called from __kmp_aux_env_initialize() in kmp_settings.cpp */
37920b57cec5SDimitry Andric void kmpc_set_blocktime(int arg);
37930b57cec5SDimitry Andric void ompc_set_nested(int flag);
37940b57cec5SDimitry Andric void ompc_set_dynamic(int flag);
37950b57cec5SDimitry Andric void ompc_set_num_threads(int arg);
37960b57cec5SDimitry Andric 
37970b57cec5SDimitry Andric extern void __kmp_push_current_task_to_thread(kmp_info_t *this_thr,
37980b57cec5SDimitry Andric                                               kmp_team_t *team, int tid);
37990b57cec5SDimitry Andric extern void __kmp_pop_current_task_from_thread(kmp_info_t *this_thr);
38000b57cec5SDimitry Andric extern kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
38010b57cec5SDimitry Andric                                     kmp_tasking_flags_t *flags,
38020b57cec5SDimitry Andric                                     size_t sizeof_kmp_task_t,
38030b57cec5SDimitry Andric                                     size_t sizeof_shareds,
38040b57cec5SDimitry Andric                                     kmp_routine_entry_t task_entry);
38050b57cec5SDimitry Andric extern void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
38060b57cec5SDimitry Andric                                      kmp_team_t *team, int tid,
38070b57cec5SDimitry Andric                                      int set_curr_task);
38080b57cec5SDimitry Andric extern void __kmp_finish_implicit_task(kmp_info_t *this_thr);
38090b57cec5SDimitry Andric extern void __kmp_free_implicit_task(kmp_info_t *this_thr);
38100b57cec5SDimitry Andric 
38110b57cec5SDimitry Andric extern kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref,
38120b57cec5SDimitry Andric                                                        int gtid,
38130b57cec5SDimitry Andric                                                        kmp_task_t *task);
38140b57cec5SDimitry Andric extern void __kmp_fulfill_event(kmp_event_t *event);
38150b57cec5SDimitry Andric 
38160b57cec5SDimitry Andric extern void __kmp_free_task_team(kmp_info_t *thread,
38170b57cec5SDimitry Andric                                  kmp_task_team_t *task_team);
38180b57cec5SDimitry Andric extern void __kmp_reap_task_teams(void);
38190b57cec5SDimitry Andric extern void __kmp_wait_to_unref_task_teams(void);
38200b57cec5SDimitry Andric extern void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team,
38210b57cec5SDimitry Andric                                   int always);
38220b57cec5SDimitry Andric extern void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team);
38230b57cec5SDimitry Andric extern void __kmp_task_team_wait(kmp_info_t *this_thr, kmp_team_t *team
38240b57cec5SDimitry Andric #if USE_ITT_BUILD
38250b57cec5SDimitry Andric                                  ,
38260b57cec5SDimitry Andric                                  void *itt_sync_obj
38270b57cec5SDimitry Andric #endif /* USE_ITT_BUILD */
38280b57cec5SDimitry Andric                                  ,
38290b57cec5SDimitry Andric                                  int wait = 1);
38300b57cec5SDimitry Andric extern void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread,
38310b57cec5SDimitry Andric                                   int gtid);
38320b57cec5SDimitry Andric 
38330b57cec5SDimitry Andric extern int __kmp_is_address_mapped(void *addr);
38340b57cec5SDimitry Andric extern kmp_uint64 __kmp_hardware_timestamp(void);
38350b57cec5SDimitry Andric 
38360b57cec5SDimitry Andric #if KMP_OS_UNIX
38370b57cec5SDimitry Andric extern int __kmp_read_from_file(char const *path, char const *format, ...);
38380b57cec5SDimitry Andric #endif
38390b57cec5SDimitry Andric 
38400b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
38410b57cec5SDimitry Andric //
38420b57cec5SDimitry Andric // Assembly routines that have no compiler intrinsic replacement
38430b57cec5SDimitry Andric //
38440b57cec5SDimitry Andric 
38450b57cec5SDimitry Andric extern int __kmp_invoke_microtask(microtask_t pkfn, int gtid, int npr, int argc,
38460b57cec5SDimitry Andric                                   void *argv[]
38470b57cec5SDimitry Andric #if OMPT_SUPPORT
38480b57cec5SDimitry Andric                                   ,
38490b57cec5SDimitry Andric                                   void **exit_frame_ptr
38500b57cec5SDimitry Andric #endif
38510b57cec5SDimitry Andric );
38520b57cec5SDimitry Andric 
38530b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
38540b57cec5SDimitry Andric 
38550b57cec5SDimitry Andric KMP_EXPORT void __kmpc_begin(ident_t *, kmp_int32 flags);
38560b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end(ident_t *);
38570b57cec5SDimitry Andric 
38580b57cec5SDimitry Andric KMP_EXPORT void __kmpc_threadprivate_register_vec(ident_t *, void *data,
38590b57cec5SDimitry Andric                                                   kmpc_ctor_vec ctor,
38600b57cec5SDimitry Andric                                                   kmpc_cctor_vec cctor,
38610b57cec5SDimitry Andric                                                   kmpc_dtor_vec dtor,
38620b57cec5SDimitry Andric                                                   size_t vector_length);
38630b57cec5SDimitry Andric KMP_EXPORT void __kmpc_threadprivate_register(ident_t *, void *data,
38640b57cec5SDimitry Andric                                               kmpc_ctor ctor, kmpc_cctor cctor,
38650b57cec5SDimitry Andric                                               kmpc_dtor dtor);
38660b57cec5SDimitry Andric KMP_EXPORT void *__kmpc_threadprivate(ident_t *, kmp_int32 global_tid,
38670b57cec5SDimitry Andric                                       void *data, size_t size);
38680b57cec5SDimitry Andric 
38690b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_global_thread_num(ident_t *);
38700b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_global_num_threads(ident_t *);
38710b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_bound_thread_num(ident_t *);
38720b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_bound_num_threads(ident_t *);
38730b57cec5SDimitry Andric 
38740b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_ok_to_fork(ident_t *);
38750b57cec5SDimitry Andric KMP_EXPORT void __kmpc_fork_call(ident_t *, kmp_int32 nargs,
38760b57cec5SDimitry Andric                                  kmpc_micro microtask, ...);
38770b57cec5SDimitry Andric 
38780b57cec5SDimitry Andric KMP_EXPORT void __kmpc_serialized_parallel(ident_t *, kmp_int32 global_tid);
38790b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_serialized_parallel(ident_t *, kmp_int32 global_tid);
38800b57cec5SDimitry Andric 
38810b57cec5SDimitry Andric KMP_EXPORT void __kmpc_flush(ident_t *);
38820b57cec5SDimitry Andric KMP_EXPORT void __kmpc_barrier(ident_t *, kmp_int32 global_tid);
38830b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_master(ident_t *, kmp_int32 global_tid);
38840b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_master(ident_t *, kmp_int32 global_tid);
3885fe6060f1SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_masked(ident_t *, kmp_int32 global_tid,
3886fe6060f1SDimitry Andric                                    kmp_int32 filter);
3887fe6060f1SDimitry Andric KMP_EXPORT void __kmpc_end_masked(ident_t *, kmp_int32 global_tid);
38880b57cec5SDimitry Andric KMP_EXPORT void __kmpc_ordered(ident_t *, kmp_int32 global_tid);
38890b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_ordered(ident_t *, kmp_int32 global_tid);
38900b57cec5SDimitry Andric KMP_EXPORT void __kmpc_critical(ident_t *, kmp_int32 global_tid,
38910b57cec5SDimitry Andric                                 kmp_critical_name *);
38920b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_critical(ident_t *, kmp_int32 global_tid,
38930b57cec5SDimitry Andric                                     kmp_critical_name *);
38940b57cec5SDimitry Andric KMP_EXPORT void __kmpc_critical_with_hint(ident_t *, kmp_int32 global_tid,
38950b57cec5SDimitry Andric                                           kmp_critical_name *, uint32_t hint);
38960b57cec5SDimitry Andric 
38970b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_barrier_master(ident_t *, kmp_int32 global_tid);
38980b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_barrier_master(ident_t *, kmp_int32 global_tid);
38990b57cec5SDimitry Andric 
39000b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_barrier_master_nowait(ident_t *,
39010b57cec5SDimitry Andric                                                   kmp_int32 global_tid);
39020b57cec5SDimitry Andric 
39030b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_single(ident_t *, kmp_int32 global_tid);
39040b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_single(ident_t *, kmp_int32 global_tid);
39050b57cec5SDimitry Andric 
3906753f127fSDimitry Andric KMP_EXPORT kmp_int32 __kmpc_sections_init(ident_t *loc, kmp_int32 global_tid);
3907753f127fSDimitry Andric KMP_EXPORT kmp_int32 __kmpc_next_section(ident_t *loc, kmp_int32 global_tid,
3908753f127fSDimitry Andric                                          kmp_int32 numberOfSections);
3909753f127fSDimitry Andric KMP_EXPORT void __kmpc_end_sections(ident_t *loc, kmp_int32 global_tid);
3910753f127fSDimitry Andric 
39110b57cec5SDimitry Andric KMP_EXPORT void KMPC_FOR_STATIC_INIT(ident_t *loc, kmp_int32 global_tid,
39120b57cec5SDimitry Andric                                      kmp_int32 schedtype, kmp_int32 *plastiter,
39130b57cec5SDimitry Andric                                      kmp_int *plower, kmp_int *pupper,
39140b57cec5SDimitry Andric                                      kmp_int *pstride, kmp_int incr,
39150b57cec5SDimitry Andric                                      kmp_int chunk);
39160b57cec5SDimitry Andric 
39170b57cec5SDimitry Andric KMP_EXPORT void __kmpc_for_static_fini(ident_t *loc, kmp_int32 global_tid);
39180b57cec5SDimitry Andric 
39190b57cec5SDimitry Andric KMP_EXPORT void __kmpc_copyprivate(ident_t *loc, kmp_int32 global_tid,
39200b57cec5SDimitry Andric                                    size_t cpy_size, void *cpy_data,
39210b57cec5SDimitry Andric                                    void (*cpy_func)(void *, void *),
39220b57cec5SDimitry Andric                                    kmp_int32 didit);
39230b57cec5SDimitry Andric 
3924753f127fSDimitry Andric KMP_EXPORT void *__kmpc_copyprivate_light(ident_t *loc, kmp_int32 gtid,
3925753f127fSDimitry Andric                                           void *cpy_data);
3926753f127fSDimitry Andric 
39270b57cec5SDimitry Andric extern void KMPC_SET_NUM_THREADS(int arg);
39280b57cec5SDimitry Andric extern void KMPC_SET_DYNAMIC(int flag);
39290b57cec5SDimitry Andric extern void KMPC_SET_NESTED(int flag);
39300b57cec5SDimitry Andric 
39310b57cec5SDimitry Andric /* OMP 3.0 tasking interface routines */
39320b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
39330b57cec5SDimitry Andric                                      kmp_task_t *new_task);
39340b57cec5SDimitry Andric KMP_EXPORT kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
39350b57cec5SDimitry Andric                                              kmp_int32 flags,
39360b57cec5SDimitry Andric                                              size_t sizeof_kmp_task_t,
39370b57cec5SDimitry Andric                                              size_t sizeof_shareds,
39380b57cec5SDimitry Andric                                              kmp_routine_entry_t task_entry);
3939fe6060f1SDimitry Andric KMP_EXPORT kmp_task_t *__kmpc_omp_target_task_alloc(
3940fe6060f1SDimitry Andric     ident_t *loc_ref, kmp_int32 gtid, kmp_int32 flags, size_t sizeof_kmp_task_t,
3941fe6060f1SDimitry Andric     size_t sizeof_shareds, kmp_routine_entry_t task_entry, kmp_int64 device_id);
39420b57cec5SDimitry Andric KMP_EXPORT void __kmpc_omp_task_begin_if0(ident_t *loc_ref, kmp_int32 gtid,
39430b57cec5SDimitry Andric                                           kmp_task_t *task);
39440b57cec5SDimitry Andric KMP_EXPORT void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
39450b57cec5SDimitry Andric                                              kmp_task_t *task);
39460b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
39470b57cec5SDimitry Andric                                            kmp_task_t *new_task);
39480b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid);
39490b57cec5SDimitry Andric 
39500b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid,
39510b57cec5SDimitry Andric                                           int end_part);
39520b57cec5SDimitry Andric 
39530b57cec5SDimitry Andric #if TASK_UNUSED
39540b57cec5SDimitry Andric void __kmpc_omp_task_begin(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task);
39550b57cec5SDimitry Andric void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
39560b57cec5SDimitry Andric                               kmp_task_t *task);
39570b57cec5SDimitry Andric #endif // TASK_UNUSED
39580b57cec5SDimitry Andric 
39590b57cec5SDimitry Andric /* ------------------------------------------------------------------------ */
39600b57cec5SDimitry Andric 
39610b57cec5SDimitry Andric KMP_EXPORT void __kmpc_taskgroup(ident_t *loc, int gtid);
39620b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_taskgroup(ident_t *loc, int gtid);
39630b57cec5SDimitry Andric 
39640b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_omp_task_with_deps(
39650b57cec5SDimitry Andric     ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 ndeps,
39660b57cec5SDimitry Andric     kmp_depend_info_t *dep_list, kmp_int32 ndeps_noalias,
39670b57cec5SDimitry Andric     kmp_depend_info_t *noalias_dep_list);
39680b57cec5SDimitry Andric KMP_EXPORT void __kmpc_omp_wait_deps(ident_t *loc_ref, kmp_int32 gtid,
39690b57cec5SDimitry Andric                                      kmp_int32 ndeps,
39700b57cec5SDimitry Andric                                      kmp_depend_info_t *dep_list,
39710b57cec5SDimitry Andric                                      kmp_int32 ndeps_noalias,
39720b57cec5SDimitry Andric                                      kmp_depend_info_t *noalias_dep_list);
39730b57cec5SDimitry Andric extern kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
39740b57cec5SDimitry Andric                                 bool serialize_immediate);
39750b57cec5SDimitry Andric 
39760b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_cancel(ident_t *loc_ref, kmp_int32 gtid,
39770b57cec5SDimitry Andric                                    kmp_int32 cncl_kind);
39780b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_cancellationpoint(ident_t *loc_ref, kmp_int32 gtid,
39790b57cec5SDimitry Andric                                               kmp_int32 cncl_kind);
39800b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_cancel_barrier(ident_t *loc_ref, kmp_int32 gtid);
39810b57cec5SDimitry Andric KMP_EXPORT int __kmp_get_cancellation_status(int cancel_kind);
39820b57cec5SDimitry Andric 
39830b57cec5SDimitry Andric KMP_EXPORT void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask);
39840b57cec5SDimitry Andric KMP_EXPORT void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask);
39850b57cec5SDimitry Andric KMP_EXPORT void __kmpc_taskloop(ident_t *loc, kmp_int32 gtid, kmp_task_t *task,
39860b57cec5SDimitry Andric                                 kmp_int32 if_val, kmp_uint64 *lb,
39870b57cec5SDimitry Andric                                 kmp_uint64 *ub, kmp_int64 st, kmp_int32 nogroup,
39880b57cec5SDimitry Andric                                 kmp_int32 sched, kmp_uint64 grainsize,
39890b57cec5SDimitry Andric                                 void *task_dup);
3990e8d8bef9SDimitry Andric KMP_EXPORT void __kmpc_taskloop_5(ident_t *loc, kmp_int32 gtid,
3991e8d8bef9SDimitry Andric                                   kmp_task_t *task, kmp_int32 if_val,
3992e8d8bef9SDimitry Andric                                   kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
3993e8d8bef9SDimitry Andric                                   kmp_int32 nogroup, kmp_int32 sched,
3994e8d8bef9SDimitry Andric                                   kmp_uint64 grainsize, kmp_int32 modifier,
3995e8d8bef9SDimitry Andric                                   void *task_dup);
39960b57cec5SDimitry Andric KMP_EXPORT void *__kmpc_task_reduction_init(int gtid, int num_data, void *data);
39970b57cec5SDimitry Andric KMP_EXPORT void *__kmpc_taskred_init(int gtid, int num_data, void *data);
39980b57cec5SDimitry Andric KMP_EXPORT void *__kmpc_task_reduction_get_th_data(int gtid, void *tg, void *d);
39990b57cec5SDimitry Andric KMP_EXPORT void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid,
40000b57cec5SDimitry Andric                                                      int is_ws, int num,
40010b57cec5SDimitry Andric                                                      void *data);
40020b57cec5SDimitry Andric KMP_EXPORT void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws,
40030b57cec5SDimitry Andric                                               int num, void *data);
40040b57cec5SDimitry Andric KMP_EXPORT void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid,
40050b57cec5SDimitry Andric                                                     int is_ws);
40060b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_omp_reg_task_with_affinity(
40070b57cec5SDimitry Andric     ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *new_task, kmp_int32 naffins,
40080b57cec5SDimitry Andric     kmp_task_affinity_info_t *affin_list);
4009fe6060f1SDimitry Andric KMP_EXPORT void __kmp_set_num_teams(int num_teams);
4010fe6060f1SDimitry Andric KMP_EXPORT int __kmp_get_max_teams(void);
4011fe6060f1SDimitry Andric KMP_EXPORT void __kmp_set_teams_thread_limit(int limit);
4012fe6060f1SDimitry Andric KMP_EXPORT int __kmp_get_teams_thread_limit(void);
40130b57cec5SDimitry Andric 
40140b57cec5SDimitry Andric /* Lock interface routines (fast versions with gtid passed in) */
40150b57cec5SDimitry Andric KMP_EXPORT void __kmpc_init_lock(ident_t *loc, kmp_int32 gtid,
40160b57cec5SDimitry Andric                                  void **user_lock);
40170b57cec5SDimitry Andric KMP_EXPORT void __kmpc_init_nest_lock(ident_t *loc, kmp_int32 gtid,
40180b57cec5SDimitry Andric                                       void **user_lock);
40190b57cec5SDimitry Andric KMP_EXPORT void __kmpc_destroy_lock(ident_t *loc, kmp_int32 gtid,
40200b57cec5SDimitry Andric                                     void **user_lock);
40210b57cec5SDimitry Andric KMP_EXPORT void __kmpc_destroy_nest_lock(ident_t *loc, kmp_int32 gtid,
40220b57cec5SDimitry Andric                                          void **user_lock);
40230b57cec5SDimitry Andric KMP_EXPORT void __kmpc_set_lock(ident_t *loc, kmp_int32 gtid, void **user_lock);
40240b57cec5SDimitry Andric KMP_EXPORT void __kmpc_set_nest_lock(ident_t *loc, kmp_int32 gtid,
40250b57cec5SDimitry Andric                                      void **user_lock);
40260b57cec5SDimitry Andric KMP_EXPORT void __kmpc_unset_lock(ident_t *loc, kmp_int32 gtid,
40270b57cec5SDimitry Andric                                   void **user_lock);
40280b57cec5SDimitry Andric KMP_EXPORT void __kmpc_unset_nest_lock(ident_t *loc, kmp_int32 gtid,
40290b57cec5SDimitry Andric                                        void **user_lock);
40300b57cec5SDimitry Andric KMP_EXPORT int __kmpc_test_lock(ident_t *loc, kmp_int32 gtid, void **user_lock);
40310b57cec5SDimitry Andric KMP_EXPORT int __kmpc_test_nest_lock(ident_t *loc, kmp_int32 gtid,
40320b57cec5SDimitry Andric                                      void **user_lock);
40330b57cec5SDimitry Andric 
40340b57cec5SDimitry Andric KMP_EXPORT void __kmpc_init_lock_with_hint(ident_t *loc, kmp_int32 gtid,
40350b57cec5SDimitry Andric                                            void **user_lock, uintptr_t hint);
40360b57cec5SDimitry Andric KMP_EXPORT void __kmpc_init_nest_lock_with_hint(ident_t *loc, kmp_int32 gtid,
40370b57cec5SDimitry Andric                                                 void **user_lock,
40380b57cec5SDimitry Andric                                                 uintptr_t hint);
40390b57cec5SDimitry Andric 
40400b57cec5SDimitry Andric /* Interface to fast scalable reduce methods routines */
40410b57cec5SDimitry Andric 
40420b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_reduce_nowait(
40430b57cec5SDimitry Andric     ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
40440b57cec5SDimitry Andric     void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
40450b57cec5SDimitry Andric     kmp_critical_name *lck);
40460b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_reduce_nowait(ident_t *loc, kmp_int32 global_tid,
40470b57cec5SDimitry Andric                                          kmp_critical_name *lck);
40480b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_reduce(
40490b57cec5SDimitry Andric     ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
40500b57cec5SDimitry Andric     void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
40510b57cec5SDimitry Andric     kmp_critical_name *lck);
40520b57cec5SDimitry Andric KMP_EXPORT void __kmpc_end_reduce(ident_t *loc, kmp_int32 global_tid,
40530b57cec5SDimitry Andric                                   kmp_critical_name *lck);
40540b57cec5SDimitry Andric 
40550b57cec5SDimitry Andric /* Internal fast reduction routines */
40560b57cec5SDimitry Andric 
40570b57cec5SDimitry Andric extern PACKED_REDUCTION_METHOD_T __kmp_determine_reduction_method(
40580b57cec5SDimitry Andric     ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
40590b57cec5SDimitry Andric     void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
40600b57cec5SDimitry Andric     kmp_critical_name *lck);
40610b57cec5SDimitry Andric 
40620b57cec5SDimitry Andric // this function is for testing set/get/determine reduce method
40630b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmp_get_reduce_method(void);
40640b57cec5SDimitry Andric 
40650b57cec5SDimitry Andric KMP_EXPORT kmp_uint64 __kmpc_get_taskid();
40660b57cec5SDimitry Andric KMP_EXPORT kmp_uint64 __kmpc_get_parent_taskid();
40670b57cec5SDimitry Andric 
40680b57cec5SDimitry Andric // C++ port
40690b57cec5SDimitry Andric // missing 'extern "C"' declarations
40700b57cec5SDimitry Andric 
40710b57cec5SDimitry Andric KMP_EXPORT kmp_int32 __kmpc_in_parallel(ident_t *loc);
40720b57cec5SDimitry Andric KMP_EXPORT void __kmpc_pop_num_threads(ident_t *loc, kmp_int32 global_tid);
40730b57cec5SDimitry Andric KMP_EXPORT void __kmpc_push_num_threads(ident_t *loc, kmp_int32 global_tid,
40740b57cec5SDimitry Andric                                         kmp_int32 num_threads);
40750b57cec5SDimitry Andric 
40760b57cec5SDimitry Andric KMP_EXPORT void __kmpc_push_proc_bind(ident_t *loc, kmp_int32 global_tid,
40770b57cec5SDimitry Andric                                       int proc_bind);
40780b57cec5SDimitry Andric KMP_EXPORT void __kmpc_push_num_teams(ident_t *loc, kmp_int32 global_tid,
40790b57cec5SDimitry Andric                                       kmp_int32 num_teams,
40800b57cec5SDimitry Andric                                       kmp_int32 num_threads);
4081fe6060f1SDimitry Andric /* Function for OpenMP 5.1 num_teams clause */
4082fe6060f1SDimitry Andric KMP_EXPORT void __kmpc_push_num_teams_51(ident_t *loc, kmp_int32 global_tid,
4083fe6060f1SDimitry Andric                                          kmp_int32 num_teams_lb,
4084fe6060f1SDimitry Andric                                          kmp_int32 num_teams_ub,
4085fe6060f1SDimitry Andric                                          kmp_int32 num_threads);
40860b57cec5SDimitry Andric KMP_EXPORT void __kmpc_fork_teams(ident_t *loc, kmp_int32 argc,
40870b57cec5SDimitry Andric                                   kmpc_micro microtask, ...);
40880b57cec5SDimitry Andric struct kmp_dim { // loop bounds info casted to kmp_int64
40890b57cec5SDimitry Andric   kmp_int64 lo; // lower
40900b57cec5SDimitry Andric   kmp_int64 up; // upper
40910b57cec5SDimitry Andric   kmp_int64 st; // stride
40920b57cec5SDimitry Andric };
40930b57cec5SDimitry Andric KMP_EXPORT void __kmpc_doacross_init(ident_t *loc, kmp_int32 gtid,
40940b57cec5SDimitry Andric                                      kmp_int32 num_dims,
40950b57cec5SDimitry Andric                                      const struct kmp_dim *dims);
40960b57cec5SDimitry Andric KMP_EXPORT void __kmpc_doacross_wait(ident_t *loc, kmp_int32 gtid,
40970b57cec5SDimitry Andric                                      const kmp_int64 *vec);
40980b57cec5SDimitry Andric KMP_EXPORT void __kmpc_doacross_post(ident_t *loc, kmp_int32 gtid,
40990b57cec5SDimitry Andric                                      const kmp_int64 *vec);
41000b57cec5SDimitry Andric KMP_EXPORT void __kmpc_doacross_fini(ident_t *loc, kmp_int32 gtid);
41010b57cec5SDimitry Andric 
41020b57cec5SDimitry Andric KMP_EXPORT void *__kmpc_threadprivate_cached(ident_t *loc, kmp_int32 global_tid,
41030b57cec5SDimitry Andric                                              void *data, size_t size,
41040b57cec5SDimitry Andric                                              void ***cache);
41050b57cec5SDimitry Andric 
41060b57cec5SDimitry Andric // Symbols for MS mutual detection.
41070b57cec5SDimitry Andric extern int _You_must_link_with_exactly_one_OpenMP_library;
41080b57cec5SDimitry Andric extern int _You_must_link_with_Intel_OpenMP_library;
41090b57cec5SDimitry Andric #if KMP_OS_WINDOWS && (KMP_VERSION_MAJOR > 4)
41100b57cec5SDimitry Andric extern int _You_must_link_with_Microsoft_OpenMP_library;
41110b57cec5SDimitry Andric #endif
41120b57cec5SDimitry Andric 
41130b57cec5SDimitry Andric // The routines below are not exported.
41140b57cec5SDimitry Andric // Consider making them 'static' in corresponding source files.
41150b57cec5SDimitry Andric void kmp_threadprivate_insert_private_data(int gtid, void *pc_addr,
41160b57cec5SDimitry Andric                                            void *data_addr, size_t pc_size);
41170b57cec5SDimitry Andric struct private_common *kmp_threadprivate_insert(int gtid, void *pc_addr,
41180b57cec5SDimitry Andric                                                 void *data_addr,
41190b57cec5SDimitry Andric                                                 size_t pc_size);
41200b57cec5SDimitry Andric void __kmp_threadprivate_resize_cache(int newCapacity);
41210b57cec5SDimitry Andric void __kmp_cleanup_threadprivate_caches();
41220b57cec5SDimitry Andric 
41230b57cec5SDimitry Andric // ompc_, kmpc_ entries moved from omp.h.
41240b57cec5SDimitry Andric #if KMP_OS_WINDOWS
41250b57cec5SDimitry Andric #define KMPC_CONVENTION __cdecl
41260b57cec5SDimitry Andric #else
41270b57cec5SDimitry Andric #define KMPC_CONVENTION
41280b57cec5SDimitry Andric #endif
41290b57cec5SDimitry Andric 
41300b57cec5SDimitry Andric #ifndef __OMP_H
41310b57cec5SDimitry Andric typedef enum omp_sched_t {
41320b57cec5SDimitry Andric   omp_sched_static = 1,
41330b57cec5SDimitry Andric   omp_sched_dynamic = 2,
41340b57cec5SDimitry Andric   omp_sched_guided = 3,
41350b57cec5SDimitry Andric   omp_sched_auto = 4
41360b57cec5SDimitry Andric } omp_sched_t;
41370b57cec5SDimitry Andric typedef void *kmp_affinity_mask_t;
41380b57cec5SDimitry Andric #endif
41390b57cec5SDimitry Andric 
41400b57cec5SDimitry Andric KMP_EXPORT void KMPC_CONVENTION ompc_set_max_active_levels(int);
41410b57cec5SDimitry Andric KMP_EXPORT void KMPC_CONVENTION ompc_set_schedule(omp_sched_t, int);
41420b57cec5SDimitry Andric KMP_EXPORT int KMPC_CONVENTION ompc_get_ancestor_thread_num(int);
41430b57cec5SDimitry Andric KMP_EXPORT int KMPC_CONVENTION ompc_get_team_size(int);
41440b57cec5SDimitry Andric KMP_EXPORT int KMPC_CONVENTION
41450b57cec5SDimitry Andric kmpc_set_affinity_mask_proc(int, kmp_affinity_mask_t *);
41460b57cec5SDimitry Andric KMP_EXPORT int KMPC_CONVENTION
41470b57cec5SDimitry Andric kmpc_unset_affinity_mask_proc(int, kmp_affinity_mask_t *);
41480b57cec5SDimitry Andric KMP_EXPORT int KMPC_CONVENTION
41490b57cec5SDimitry Andric kmpc_get_affinity_mask_proc(int, kmp_affinity_mask_t *);
41500b57cec5SDimitry Andric 
41510b57cec5SDimitry Andric KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize(int);
41520b57cec5SDimitry Andric KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize_s(size_t);
41530b57cec5SDimitry Andric KMP_EXPORT void KMPC_CONVENTION kmpc_set_library(int);
41540b57cec5SDimitry Andric KMP_EXPORT void KMPC_CONVENTION kmpc_set_defaults(char const *);
41550b57cec5SDimitry Andric KMP_EXPORT void KMPC_CONVENTION kmpc_set_disp_num_buffers(int);
4156fe6060f1SDimitry Andric void KMP_EXPAND_NAME(ompc_set_affinity_format)(char const *format);
4157fe6060f1SDimitry Andric size_t KMP_EXPAND_NAME(ompc_get_affinity_format)(char *buffer, size_t size);
4158fe6060f1SDimitry Andric void KMP_EXPAND_NAME(ompc_display_affinity)(char const *format);
4159fe6060f1SDimitry Andric size_t KMP_EXPAND_NAME(ompc_capture_affinity)(char *buffer, size_t buf_size,
4160fe6060f1SDimitry Andric                                               char const *format);
41610b57cec5SDimitry Andric 
41620b57cec5SDimitry Andric enum kmp_target_offload_kind {
41630b57cec5SDimitry Andric   tgt_disabled = 0,
41640b57cec5SDimitry Andric   tgt_default = 1,
41650b57cec5SDimitry Andric   tgt_mandatory = 2
41660b57cec5SDimitry Andric };
41670b57cec5SDimitry Andric typedef enum kmp_target_offload_kind kmp_target_offload_kind_t;
41680b57cec5SDimitry Andric // Set via OMP_TARGET_OFFLOAD if specified, defaults to tgt_default otherwise
41690b57cec5SDimitry Andric extern kmp_target_offload_kind_t __kmp_target_offload;
41700b57cec5SDimitry Andric extern int __kmpc_get_target_offload();
41710b57cec5SDimitry Andric 
41720b57cec5SDimitry Andric // Constants used in libomptarget
41730b57cec5SDimitry Andric #define KMP_DEVICE_DEFAULT -1 // This is libomptarget's default device.
41740b57cec5SDimitry Andric #define KMP_DEVICE_ALL -11 // This is libomptarget's "all devices".
41750b57cec5SDimitry Andric 
41760b57cec5SDimitry Andric // OMP Pause Resource
41770b57cec5SDimitry Andric 
41780b57cec5SDimitry Andric // The following enum is used both to set the status in __kmp_pause_status, and
41790b57cec5SDimitry Andric // as the internal equivalent of the externally-visible omp_pause_resource_t.
41800b57cec5SDimitry Andric typedef enum kmp_pause_status_t {
41810b57cec5SDimitry Andric   kmp_not_paused = 0, // status is not paused, or, requesting resume
41820b57cec5SDimitry Andric   kmp_soft_paused = 1, // status is soft-paused, or, requesting soft pause
41830b57cec5SDimitry Andric   kmp_hard_paused = 2 // status is hard-paused, or, requesting hard pause
41840b57cec5SDimitry Andric } kmp_pause_status_t;
41850b57cec5SDimitry Andric 
41860b57cec5SDimitry Andric // This stores the pause state of the runtime
41870b57cec5SDimitry Andric extern kmp_pause_status_t __kmp_pause_status;
41880b57cec5SDimitry Andric extern int __kmpc_pause_resource(kmp_pause_status_t level);
41890b57cec5SDimitry Andric extern int __kmp_pause_resource(kmp_pause_status_t level);
41900b57cec5SDimitry Andric // Soft resume sets __kmp_pause_status, and wakes up all threads.
41910b57cec5SDimitry Andric extern void __kmp_resume_if_soft_paused();
41920b57cec5SDimitry Andric // Hard resume simply resets the status to not paused. Library will appear to
41930b57cec5SDimitry Andric // be uninitialized after hard pause. Let OMP constructs trigger required
41940b57cec5SDimitry Andric // initializations.
41950b57cec5SDimitry Andric static inline void __kmp_resume_if_hard_paused() {
41960b57cec5SDimitry Andric   if (__kmp_pause_status == kmp_hard_paused) {
41970b57cec5SDimitry Andric     __kmp_pause_status = kmp_not_paused;
41980b57cec5SDimitry Andric   }
41990b57cec5SDimitry Andric }
42000b57cec5SDimitry Andric 
42015ffd83dbSDimitry Andric extern void __kmp_omp_display_env(int verbose);
42025ffd83dbSDimitry Andric 
4203e8d8bef9SDimitry Andric // 1: it is initializing hidden helper team
4204e8d8bef9SDimitry Andric extern volatile int __kmp_init_hidden_helper;
4205e8d8bef9SDimitry Andric // 1: the hidden helper team is done
4206e8d8bef9SDimitry Andric extern volatile int __kmp_hidden_helper_team_done;
4207e8d8bef9SDimitry Andric // 1: enable hidden helper task
4208e8d8bef9SDimitry Andric extern kmp_int32 __kmp_enable_hidden_helper;
4209e8d8bef9SDimitry Andric // Main thread of hidden helper team
4210e8d8bef9SDimitry Andric extern kmp_info_t *__kmp_hidden_helper_main_thread;
4211e8d8bef9SDimitry Andric // Descriptors for the hidden helper threads
4212e8d8bef9SDimitry Andric extern kmp_info_t **__kmp_hidden_helper_threads;
4213e8d8bef9SDimitry Andric // Number of hidden helper threads
4214e8d8bef9SDimitry Andric extern kmp_int32 __kmp_hidden_helper_threads_num;
4215e8d8bef9SDimitry Andric // Number of hidden helper tasks that have not been executed yet
4216e8d8bef9SDimitry Andric extern std::atomic<kmp_int32> __kmp_unexecuted_hidden_helper_tasks;
4217e8d8bef9SDimitry Andric 
4218e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_initialize();
4219e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_threads_initz_routine();
4220e8d8bef9SDimitry Andric extern void __kmp_do_initialize_hidden_helper_threads();
4221e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_threads_initz_wait();
4222e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_initz_release();
4223e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_threads_deinitz_wait();
4224e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_threads_deinitz_release();
4225e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_main_thread_wait();
4226e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_worker_thread_wait();
4227e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_worker_thread_signal();
4228e8d8bef9SDimitry Andric extern void __kmp_hidden_helper_main_thread_release();
4229e8d8bef9SDimitry Andric 
4230e8d8bef9SDimitry Andric // Check whether a given thread is a hidden helper thread
4231e8d8bef9SDimitry Andric #define KMP_HIDDEN_HELPER_THREAD(gtid)                                         \
4232e8d8bef9SDimitry Andric   ((gtid) >= 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4233e8d8bef9SDimitry Andric 
4234e8d8bef9SDimitry Andric #define KMP_HIDDEN_HELPER_WORKER_THREAD(gtid)                                  \
4235e8d8bef9SDimitry Andric   ((gtid) > 1 && (gtid) <= __kmp_hidden_helper_threads_num)
4236e8d8bef9SDimitry Andric 
4237fe6060f1SDimitry Andric #define KMP_HIDDEN_HELPER_TEAM(team)                                           \
4238fe6060f1SDimitry Andric   (team->t.t_threads[0] == __kmp_hidden_helper_main_thread)
4239fe6060f1SDimitry Andric 
4240e8d8bef9SDimitry Andric // Map a gtid to a hidden helper thread. The first hidden helper thread, a.k.a
4241e8d8bef9SDimitry Andric // main thread, is skipped.
4242e8d8bef9SDimitry Andric #define KMP_GTID_TO_SHADOW_GTID(gtid)                                          \
4243e8d8bef9SDimitry Andric   ((gtid) % (__kmp_hidden_helper_threads_num - 1) + 2)
4244e8d8bef9SDimitry Andric 
4245fe6060f1SDimitry Andric // Return the adjusted gtid value by subtracting from gtid the number
4246fe6060f1SDimitry Andric // of hidden helper threads. This adjusted value is the gtid the thread would
4247fe6060f1SDimitry Andric // have received if there were no hidden helper threads.
4248fe6060f1SDimitry Andric static inline int __kmp_adjust_gtid_for_hidden_helpers(int gtid) {
4249fe6060f1SDimitry Andric   int adjusted_gtid = gtid;
4250fe6060f1SDimitry Andric   if (__kmp_hidden_helper_threads_num > 0 && gtid > 0 &&
4251fe6060f1SDimitry Andric       gtid - __kmp_hidden_helper_threads_num >= 0) {
4252fe6060f1SDimitry Andric     adjusted_gtid -= __kmp_hidden_helper_threads_num;
4253fe6060f1SDimitry Andric   }
4254fe6060f1SDimitry Andric   return adjusted_gtid;
4255fe6060f1SDimitry Andric }
4256fe6060f1SDimitry Andric 
4257fe6060f1SDimitry Andric // Support for error directive
4258fe6060f1SDimitry Andric typedef enum kmp_severity_t {
4259fe6060f1SDimitry Andric   severity_warning = 1,
4260fe6060f1SDimitry Andric   severity_fatal = 2
4261fe6060f1SDimitry Andric } kmp_severity_t;
4262fe6060f1SDimitry Andric extern void __kmpc_error(ident_t *loc, int severity, const char *message);
4263fe6060f1SDimitry Andric 
4264349cc55cSDimitry Andric // Support for scope directive
4265349cc55cSDimitry Andric KMP_EXPORT void __kmpc_scope(ident_t *loc, kmp_int32 gtid, void *reserved);
4266349cc55cSDimitry Andric KMP_EXPORT void __kmpc_end_scope(ident_t *loc, kmp_int32 gtid, void *reserved);
4267349cc55cSDimitry Andric 
42680b57cec5SDimitry Andric #ifdef __cplusplus
42690b57cec5SDimitry Andric }
42700b57cec5SDimitry Andric #endif
42710b57cec5SDimitry Andric 
4272e8d8bef9SDimitry Andric template <bool C, bool S>
4273e8d8bef9SDimitry Andric extern void __kmp_suspend_32(int th_gtid, kmp_flag_32<C, S> *flag);
4274e8d8bef9SDimitry Andric template <bool C, bool S>
4275e8d8bef9SDimitry Andric extern void __kmp_suspend_64(int th_gtid, kmp_flag_64<C, S> *flag);
4276349cc55cSDimitry Andric template <bool C, bool S>
4277349cc55cSDimitry Andric extern void __kmp_atomic_suspend_64(int th_gtid,
4278349cc55cSDimitry Andric                                     kmp_atomic_flag_64<C, S> *flag);
4279e8d8bef9SDimitry Andric extern void __kmp_suspend_oncore(int th_gtid, kmp_flag_oncore *flag);
4280e8d8bef9SDimitry Andric #if KMP_HAVE_MWAIT || KMP_HAVE_UMWAIT
4281e8d8bef9SDimitry Andric template <bool C, bool S>
4282e8d8bef9SDimitry Andric extern void __kmp_mwait_32(int th_gtid, kmp_flag_32<C, S> *flag);
4283e8d8bef9SDimitry Andric template <bool C, bool S>
4284e8d8bef9SDimitry Andric extern void __kmp_mwait_64(int th_gtid, kmp_flag_64<C, S> *flag);
4285349cc55cSDimitry Andric template <bool C, bool S>
4286349cc55cSDimitry Andric extern void __kmp_atomic_mwait_64(int th_gtid, kmp_atomic_flag_64<C, S> *flag);
4287e8d8bef9SDimitry Andric extern void __kmp_mwait_oncore(int th_gtid, kmp_flag_oncore *flag);
4288e8d8bef9SDimitry Andric #endif
4289e8d8bef9SDimitry Andric template <bool C, bool S>
4290e8d8bef9SDimitry Andric extern void __kmp_resume_32(int target_gtid, kmp_flag_32<C, S> *flag);
4291e8d8bef9SDimitry Andric template <bool C, bool S>
4292e8d8bef9SDimitry Andric extern void __kmp_resume_64(int target_gtid, kmp_flag_64<C, S> *flag);
4293349cc55cSDimitry Andric template <bool C, bool S>
4294349cc55cSDimitry Andric extern void __kmp_atomic_resume_64(int target_gtid,
4295349cc55cSDimitry Andric                                    kmp_atomic_flag_64<C, S> *flag);
4296e8d8bef9SDimitry Andric extern void __kmp_resume_oncore(int target_gtid, kmp_flag_oncore *flag);
4297e8d8bef9SDimitry Andric 
4298e8d8bef9SDimitry Andric template <bool C, bool S>
4299e8d8bef9SDimitry Andric int __kmp_execute_tasks_32(kmp_info_t *thread, kmp_int32 gtid,
4300e8d8bef9SDimitry Andric                            kmp_flag_32<C, S> *flag, int final_spin,
4301e8d8bef9SDimitry Andric                            int *thread_finished,
4302e8d8bef9SDimitry Andric #if USE_ITT_BUILD
4303e8d8bef9SDimitry Andric                            void *itt_sync_obj,
4304e8d8bef9SDimitry Andric #endif /* USE_ITT_BUILD */
4305e8d8bef9SDimitry Andric                            kmp_int32 is_constrained);
4306e8d8bef9SDimitry Andric template <bool C, bool S>
4307e8d8bef9SDimitry Andric int __kmp_execute_tasks_64(kmp_info_t *thread, kmp_int32 gtid,
4308e8d8bef9SDimitry Andric                            kmp_flag_64<C, S> *flag, int final_spin,
4309e8d8bef9SDimitry Andric                            int *thread_finished,
4310e8d8bef9SDimitry Andric #if USE_ITT_BUILD
4311e8d8bef9SDimitry Andric                            void *itt_sync_obj,
4312e8d8bef9SDimitry Andric #endif /* USE_ITT_BUILD */
4313e8d8bef9SDimitry Andric                            kmp_int32 is_constrained);
4314349cc55cSDimitry Andric template <bool C, bool S>
4315349cc55cSDimitry Andric int __kmp_atomic_execute_tasks_64(kmp_info_t *thread, kmp_int32 gtid,
4316349cc55cSDimitry Andric                                   kmp_atomic_flag_64<C, S> *flag,
4317349cc55cSDimitry Andric                                   int final_spin, int *thread_finished,
4318349cc55cSDimitry Andric #if USE_ITT_BUILD
4319349cc55cSDimitry Andric                                   void *itt_sync_obj,
4320349cc55cSDimitry Andric #endif /* USE_ITT_BUILD */
4321349cc55cSDimitry Andric                                   kmp_int32 is_constrained);
4322e8d8bef9SDimitry Andric int __kmp_execute_tasks_oncore(kmp_info_t *thread, kmp_int32 gtid,
4323e8d8bef9SDimitry Andric                                kmp_flag_oncore *flag, int final_spin,
4324e8d8bef9SDimitry Andric                                int *thread_finished,
4325e8d8bef9SDimitry Andric #if USE_ITT_BUILD
4326e8d8bef9SDimitry Andric                                void *itt_sync_obj,
4327e8d8bef9SDimitry Andric #endif /* USE_ITT_BUILD */
4328e8d8bef9SDimitry Andric                                kmp_int32 is_constrained);
4329e8d8bef9SDimitry Andric 
4330fe6060f1SDimitry Andric extern int __kmp_nesting_mode;
4331fe6060f1SDimitry Andric extern int __kmp_nesting_mode_nlevels;
4332fe6060f1SDimitry Andric extern int *__kmp_nesting_nth_level;
4333fe6060f1SDimitry Andric extern void __kmp_init_nesting_mode();
4334fe6060f1SDimitry Andric extern void __kmp_set_nesting_mode_threads();
4335fe6060f1SDimitry Andric 
4336e8d8bef9SDimitry Andric /// This class safely opens and closes a C-style FILE* object using RAII
4337e8d8bef9SDimitry Andric /// semantics. There are also methods which allow using stdout or stderr as
4338e8d8bef9SDimitry Andric /// the underlying FILE* object. With the implicit conversion operator to
4339e8d8bef9SDimitry Andric /// FILE*, an object with this type can be used in any function which takes
4340e8d8bef9SDimitry Andric /// a FILE* object e.g., fprintf().
4341e8d8bef9SDimitry Andric /// No close method is needed at use sites.
4342e8d8bef9SDimitry Andric class kmp_safe_raii_file_t {
4343e8d8bef9SDimitry Andric   FILE *f;
4344e8d8bef9SDimitry Andric 
4345e8d8bef9SDimitry Andric   void close() {
4346e8d8bef9SDimitry Andric     if (f && f != stdout && f != stderr) {
4347e8d8bef9SDimitry Andric       fclose(f);
4348e8d8bef9SDimitry Andric       f = nullptr;
4349e8d8bef9SDimitry Andric     }
4350e8d8bef9SDimitry Andric   }
4351e8d8bef9SDimitry Andric 
4352e8d8bef9SDimitry Andric public:
4353e8d8bef9SDimitry Andric   kmp_safe_raii_file_t() : f(nullptr) {}
4354e8d8bef9SDimitry Andric   kmp_safe_raii_file_t(const char *filename, const char *mode,
4355e8d8bef9SDimitry Andric                        const char *env_var = nullptr)
4356e8d8bef9SDimitry Andric       : f(nullptr) {
4357e8d8bef9SDimitry Andric     open(filename, mode, env_var);
4358e8d8bef9SDimitry Andric   }
4359e8d8bef9SDimitry Andric   ~kmp_safe_raii_file_t() { close(); }
4360e8d8bef9SDimitry Andric 
4361e8d8bef9SDimitry Andric   /// Open filename using mode. This is automatically closed in the destructor.
4362e8d8bef9SDimitry Andric   /// The env_var parameter indicates the environment variable the filename
4363e8d8bef9SDimitry Andric   /// came from if != nullptr.
4364e8d8bef9SDimitry Andric   void open(const char *filename, const char *mode,
4365e8d8bef9SDimitry Andric             const char *env_var = nullptr) {
4366e8d8bef9SDimitry Andric     KMP_ASSERT(!f);
4367e8d8bef9SDimitry Andric     f = fopen(filename, mode);
4368e8d8bef9SDimitry Andric     if (!f) {
4369e8d8bef9SDimitry Andric       int code = errno;
4370e8d8bef9SDimitry Andric       if (env_var) {
4371e8d8bef9SDimitry Andric         __kmp_fatal(KMP_MSG(CantOpenFileForReading, filename), KMP_ERR(code),
4372e8d8bef9SDimitry Andric                     KMP_HNT(CheckEnvVar, env_var, filename), __kmp_msg_null);
4373e8d8bef9SDimitry Andric       } else {
4374e8d8bef9SDimitry Andric         __kmp_fatal(KMP_MSG(CantOpenFileForReading, filename), KMP_ERR(code),
4375e8d8bef9SDimitry Andric                     __kmp_msg_null);
4376e8d8bef9SDimitry Andric       }
4377e8d8bef9SDimitry Andric     }
4378e8d8bef9SDimitry Andric   }
4379349cc55cSDimitry Andric   /// Instead of erroring out, return non-zero when
4380349cc55cSDimitry Andric   /// unsuccessful fopen() for any reason
4381349cc55cSDimitry Andric   int try_open(const char *filename, const char *mode) {
4382349cc55cSDimitry Andric     KMP_ASSERT(!f);
4383349cc55cSDimitry Andric     f = fopen(filename, mode);
4384349cc55cSDimitry Andric     if (!f)
4385349cc55cSDimitry Andric       return errno;
4386349cc55cSDimitry Andric     return 0;
4387349cc55cSDimitry Andric   }
4388e8d8bef9SDimitry Andric   /// Set the FILE* object to stdout and output there
4389e8d8bef9SDimitry Andric   /// No open call should happen before this call.
4390e8d8bef9SDimitry Andric   void set_stdout() {
4391e8d8bef9SDimitry Andric     KMP_ASSERT(!f);
4392e8d8bef9SDimitry Andric     f = stdout;
4393e8d8bef9SDimitry Andric   }
4394e8d8bef9SDimitry Andric   /// Set the FILE* object to stderr and output there
4395e8d8bef9SDimitry Andric   /// No open call should happen before this call.
4396e8d8bef9SDimitry Andric   void set_stderr() {
4397e8d8bef9SDimitry Andric     KMP_ASSERT(!f);
4398e8d8bef9SDimitry Andric     f = stderr;
4399e8d8bef9SDimitry Andric   }
4400e8d8bef9SDimitry Andric   operator bool() { return bool(f); }
4401e8d8bef9SDimitry Andric   operator FILE *() { return f; }
4402e8d8bef9SDimitry Andric };
4403e8d8bef9SDimitry Andric 
4404e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType,
4405e8d8bef9SDimitry Andric           bool isSourceSmaller = (sizeof(SourceType) < sizeof(TargetType)),
4406e8d8bef9SDimitry Andric           bool isSourceEqual = (sizeof(SourceType) == sizeof(TargetType)),
4407e8d8bef9SDimitry Andric           bool isSourceSigned = std::is_signed<SourceType>::value,
4408e8d8bef9SDimitry Andric           bool isTargetSigned = std::is_signed<TargetType>::value>
4409e8d8bef9SDimitry Andric struct kmp_convert {};
4410e8d8bef9SDimitry Andric 
4411e8d8bef9SDimitry Andric // Both types are signed; Source smaller
4412e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4413e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, true, false, true, true> {
4414e8d8bef9SDimitry Andric   static TargetType to(SourceType src) { return (TargetType)src; }
4415e8d8bef9SDimitry Andric };
4416e8d8bef9SDimitry Andric // Source equal
4417e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4418e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, true, true, true> {
4419e8d8bef9SDimitry Andric   static TargetType to(SourceType src) { return src; }
4420e8d8bef9SDimitry Andric };
4421e8d8bef9SDimitry Andric // Source bigger
4422e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4423e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, false, true, true> {
4424e8d8bef9SDimitry Andric   static TargetType to(SourceType src) {
4425e8d8bef9SDimitry Andric     KMP_ASSERT(src <= static_cast<SourceType>(
4426e8d8bef9SDimitry Andric                           (std::numeric_limits<TargetType>::max)()));
4427e8d8bef9SDimitry Andric     KMP_ASSERT(src >= static_cast<SourceType>(
4428e8d8bef9SDimitry Andric                           (std::numeric_limits<TargetType>::min)()));
4429e8d8bef9SDimitry Andric     return (TargetType)src;
4430e8d8bef9SDimitry Andric   }
4431e8d8bef9SDimitry Andric };
4432e8d8bef9SDimitry Andric 
4433e8d8bef9SDimitry Andric // Source signed, Target unsigned
4434e8d8bef9SDimitry Andric // Source smaller
4435e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4436e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, true, false, true, false> {
4437e8d8bef9SDimitry Andric   static TargetType to(SourceType src) {
4438e8d8bef9SDimitry Andric     KMP_ASSERT(src >= 0);
4439e8d8bef9SDimitry Andric     return (TargetType)src;
4440e8d8bef9SDimitry Andric   }
4441e8d8bef9SDimitry Andric };
4442e8d8bef9SDimitry Andric // Source equal
4443e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4444e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, true, true, false> {
4445e8d8bef9SDimitry Andric   static TargetType to(SourceType src) {
4446e8d8bef9SDimitry Andric     KMP_ASSERT(src >= 0);
4447e8d8bef9SDimitry Andric     return (TargetType)src;
4448e8d8bef9SDimitry Andric   }
4449e8d8bef9SDimitry Andric };
4450e8d8bef9SDimitry Andric // Source bigger
4451e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4452e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, false, true, false> {
4453e8d8bef9SDimitry Andric   static TargetType to(SourceType src) {
4454e8d8bef9SDimitry Andric     KMP_ASSERT(src >= 0);
4455e8d8bef9SDimitry Andric     KMP_ASSERT(src <= static_cast<SourceType>(
4456e8d8bef9SDimitry Andric                           (std::numeric_limits<TargetType>::max)()));
4457e8d8bef9SDimitry Andric     return (TargetType)src;
4458e8d8bef9SDimitry Andric   }
4459e8d8bef9SDimitry Andric };
4460e8d8bef9SDimitry Andric 
4461e8d8bef9SDimitry Andric // Source unsigned, Target signed
4462e8d8bef9SDimitry Andric // Source smaller
4463e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4464e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, true, false, false, true> {
4465e8d8bef9SDimitry Andric   static TargetType to(SourceType src) { return (TargetType)src; }
4466e8d8bef9SDimitry Andric };
4467e8d8bef9SDimitry Andric // Source equal
4468e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4469e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, true, false, true> {
4470e8d8bef9SDimitry Andric   static TargetType to(SourceType src) {
4471e8d8bef9SDimitry Andric     KMP_ASSERT(src <= static_cast<SourceType>(
4472e8d8bef9SDimitry Andric                           (std::numeric_limits<TargetType>::max)()));
4473e8d8bef9SDimitry Andric     return (TargetType)src;
4474e8d8bef9SDimitry Andric   }
4475e8d8bef9SDimitry Andric };
4476e8d8bef9SDimitry Andric // Source bigger
4477e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4478e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, false, false, true> {
4479e8d8bef9SDimitry Andric   static TargetType to(SourceType src) {
4480e8d8bef9SDimitry Andric     KMP_ASSERT(src <= static_cast<SourceType>(
4481e8d8bef9SDimitry Andric                           (std::numeric_limits<TargetType>::max)()));
4482e8d8bef9SDimitry Andric     return (TargetType)src;
4483e8d8bef9SDimitry Andric   }
4484e8d8bef9SDimitry Andric };
4485e8d8bef9SDimitry Andric 
4486e8d8bef9SDimitry Andric // Source unsigned, Target unsigned
4487e8d8bef9SDimitry Andric // Source smaller
4488e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4489e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, true, false, false, false> {
4490e8d8bef9SDimitry Andric   static TargetType to(SourceType src) { return (TargetType)src; }
4491e8d8bef9SDimitry Andric };
4492e8d8bef9SDimitry Andric // Source equal
4493e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4494e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, true, false, false> {
4495e8d8bef9SDimitry Andric   static TargetType to(SourceType src) { return src; }
4496e8d8bef9SDimitry Andric };
4497e8d8bef9SDimitry Andric // Source bigger
4498e8d8bef9SDimitry Andric template <typename SourceType, typename TargetType>
4499e8d8bef9SDimitry Andric struct kmp_convert<SourceType, TargetType, false, false, false, false> {
4500e8d8bef9SDimitry Andric   static TargetType to(SourceType src) {
4501e8d8bef9SDimitry Andric     KMP_ASSERT(src <= static_cast<SourceType>(
4502e8d8bef9SDimitry Andric                           (std::numeric_limits<TargetType>::max)()));
4503e8d8bef9SDimitry Andric     return (TargetType)src;
4504e8d8bef9SDimitry Andric   }
4505e8d8bef9SDimitry Andric };
4506e8d8bef9SDimitry Andric 
4507e8d8bef9SDimitry Andric template <typename T1, typename T2>
4508e8d8bef9SDimitry Andric static inline void __kmp_type_convert(T1 src, T2 *dest) {
4509e8d8bef9SDimitry Andric   *dest = kmp_convert<T1, T2>::to(src);
4510e8d8bef9SDimitry Andric }
4511e8d8bef9SDimitry Andric 
45120b57cec5SDimitry Andric #endif /* KMP_H */
4513