blob: 140bdd8caef4ce5b0aef83fdb9e7ada0ccca22ac [file] [log] [blame]
Jim Cownie5e8470a2013-09-27 10:38:44 +00001/*! \file */
2/*
3 * kmp.h -- KPTS runtime header file.
Jim Cownie5e8470a2013-09-27 10:38:44 +00004 */
5
6
7//===----------------------------------------------------------------------===//
8//
9// The LLVM Compiler Infrastructure
10//
11// This file is dual licensed under the MIT and the University of Illinois Open
12// Source Licenses. See LICENSE.txt for details.
13//
14//===----------------------------------------------------------------------===//
15
16
17#ifndef KMP_H
18#define KMP_H
19
Jonathan Peytonc0225ca2015-08-28 18:42:10 +000020#include "kmp_config.h"
21
Jim Cownie5e8470a2013-09-27 10:38:44 +000022/* #define BUILD_PARALLEL_ORDERED 1 */
23
24/* This fix replaces gettimeofday with clock_gettime for better scalability on
25 the Altix. Requires user code to be linked with -lrt.
26*/
27//#define FIX_SGI_CLOCK
28
Jim Cownie5e8470a2013-09-27 10:38:44 +000029/* Defines for OpenMP 3.0 tasking and auto scheduling */
30
Jim Cownie5e8470a2013-09-27 10:38:44 +000031# ifndef KMP_STATIC_STEAL_ENABLED
32# define KMP_STATIC_STEAL_ENABLED 1
33# endif
34
35#define TASK_CURRENT_NOT_QUEUED 0
36#define TASK_CURRENT_QUEUED 1
37
38#define TASK_DEQUE_BITS 8 // Used solely to define TASK_DEQUE_SIZE and TASK_DEQUE_MASK.
39#define TASK_DEQUE_SIZE ( 1 << TASK_DEQUE_BITS )
40#define TASK_DEQUE_MASK ( TASK_DEQUE_SIZE - 1 )
41
42#ifdef BUILD_TIED_TASK_STACK
43#define TASK_STACK_EMPTY 0 // entries when the stack is empty
44
45#define TASK_STACK_BLOCK_BITS 5 // Used to define TASK_STACK_SIZE and TASK_STACK_MASK
46#define TASK_STACK_BLOCK_SIZE ( 1 << TASK_STACK_BLOCK_BITS ) // Number of entries in each task stack array
47#define TASK_STACK_INDEX_MASK ( TASK_STACK_BLOCK_SIZE - 1 ) // Mask for determining index into stack block
48#endif // BUILD_TIED_TASK_STACK
49
50#define TASK_NOT_PUSHED 1
51#define TASK_SUCCESSFULLY_PUSHED 0
52#define TASK_TIED 1
53#define TASK_UNTIED 0
54#define TASK_EXPLICIT 1
55#define TASK_IMPLICIT 0
Andrey Churbanov535b6fa2015-05-07 17:41:51 +000056#define TASK_PROXY 1
57#define TASK_FULL 0
Jim Cownie5e8470a2013-09-27 10:38:44 +000058
Jim Cownie5e8470a2013-09-27 10:38:44 +000059#define KMP_CANCEL_THREADS
60#define KMP_THREAD_ATTR
61
62#include <stdio.h>
63#include <stdlib.h>
64#include <stddef.h>
65#include <stdarg.h>
66#include <string.h>
67#include <signal.h>
68/* include <ctype.h> don't use; problems with /MD on Windows* OS NT due to bad Microsoft library */
69/* some macros provided below to replace some of these functions */
70#ifndef __ABSOFT_WIN
71#include <sys/types.h>
72#endif
73#include <limits.h>
74#include <time.h>
75
76#include <errno.h>
77
Jim Cownie5e8470a2013-09-27 10:38:44 +000078#include "kmp_os.h"
Jim Cownie181b4bb2013-12-23 17:28:57 +000079
Jonathan Peyton01dcf362015-11-30 20:02:59 +000080#include "kmp_safe_c_api.h"
81
Jim Cownie4cc4bb42014-10-07 16:25:50 +000082#if KMP_STATS_ENABLED
83class kmp_stats_list;
84#endif
85
Jonathan Peyton01dcf362015-11-30 20:02:59 +000086#if KMP_USE_HWLOC
87#include "hwloc.h"
88extern hwloc_topology_t __kmp_hwloc_topology;
89extern int __kmp_hwloc_error;
90#endif
91
Jim Cownie181b4bb2013-12-23 17:28:57 +000092#if KMP_ARCH_X86 || KMP_ARCH_X86_64
93#include <xmmintrin.h>
94#endif
95
Jim Cownie5e8470a2013-09-27 10:38:44 +000096#include "kmp_version.h"
97#include "kmp_debug.h"
98#include "kmp_lock.h"
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +000099#if USE_DEBUGGER
100#include "kmp_debugger.h"
101#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +0000102#include "kmp_i18n.h"
103
Joerg Sonnenberger64be2d22015-09-21 19:38:56 +0000104#define KMP_HANDLE_SIGNALS (KMP_OS_UNIX || KMP_OS_WINDOWS)
Jim Cownie5e8470a2013-09-27 10:38:44 +0000105
Jim Cownie5e8470a2013-09-27 10:38:44 +0000106#include "kmp_wrapper_malloc.h"
107#if KMP_OS_UNIX
108# include <unistd.h>
109# if !defined NSIG && defined _NSIG
110# define NSIG _NSIG
111# endif
112#endif
113
114#if KMP_OS_LINUX
115# pragma weak clock_gettime
116#endif
117
Andrey Churbanove5f44922015-04-29 16:22:07 +0000118#if OMPT_SUPPORT
119#include "ompt-internal.h"
120#endif
121
Jim Cownie5e8470a2013-09-27 10:38:44 +0000122/*Select data placement in NUMA memory */
123#define NO_FIRST_TOUCH 0
124#define FIRST_TOUCH 1 /* Exploit SGI's first touch page placement algo */
125
126/* If not specified on compile command line, assume no first touch */
127#ifndef BUILD_MEMORY
128#define BUILD_MEMORY NO_FIRST_TOUCH
129#endif
130
131// 0 - no fast memory allocation, alignment: 8-byte on x86, 16-byte on x64.
132// 3 - fast allocation using sync, non-sync free lists of any size, non-self free lists of limited size.
133#ifndef USE_FAST_MEMORY
134#define USE_FAST_MEMORY 3
135#endif
136
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000137#ifndef KMP_NESTED_HOT_TEAMS
138# define KMP_NESTED_HOT_TEAMS 0
139# define USE_NESTED_HOT_ARG(x)
140#else
141# if KMP_NESTED_HOT_TEAMS
142# if OMP_40_ENABLED
143# define USE_NESTED_HOT_ARG(x) ,x
144# else
145// Nested hot teams feature depends on omp 4.0, disable it for earlier versions
146# undef KMP_NESTED_HOT_TEAMS
147# define KMP_NESTED_HOT_TEAMS 0
148# define USE_NESTED_HOT_ARG(x)
149# endif
150# else
151# define USE_NESTED_HOT_ARG(x)
152# endif
153#endif
154
Jim Cownie5e8470a2013-09-27 10:38:44 +0000155// Assume using BGET compare_exchange instruction instead of lock by default.
156#ifndef USE_CMP_XCHG_FOR_BGET
157#define USE_CMP_XCHG_FOR_BGET 1
158#endif
159
160// Test to see if queuing lock is better than bootstrap lock for bget
161// #ifndef USE_QUEUING_LOCK_FOR_BGET
162// #define USE_QUEUING_LOCK_FOR_BGET
163// #endif
164
Jonathan Peyton1e7a1dd2015-06-04 17:29:13 +0000165#define KMP_NSEC_PER_SEC 1000000000L
166#define KMP_USEC_PER_SEC 1000000L
Jim Cownie5e8470a2013-09-27 10:38:44 +0000167
Jim Cownie5e8470a2013-09-27 10:38:44 +0000168/*!
169@ingroup BASIC_TYPES
170@{
171*/
172
173// FIXME DOXYGEN... need to group these flags somehow (Making them an anonymous enum would do it...)
174/*!
175Values for bit flags used in the ident_t to describe the fields.
176*/
177/*! Use trampoline for internal microtasks */
178#define KMP_IDENT_IMB 0x01
179/*! Use c-style ident structure */
180#define KMP_IDENT_KMPC 0x02
181/* 0x04 is no longer used */
182/*! Entry point generated by auto-parallelization */
183#define KMP_IDENT_AUTOPAR 0x08
184/*! Compiler generates atomic reduction option for kmpc_reduce* */
185#define KMP_IDENT_ATOMIC_REDUCE 0x10
186/*! To mark a 'barrier' directive in user code */
187#define KMP_IDENT_BARRIER_EXPL 0x20
188/*! To Mark implicit barriers. */
189#define KMP_IDENT_BARRIER_IMPL 0x0040
190#define KMP_IDENT_BARRIER_IMPL_MASK 0x01C0
191#define KMP_IDENT_BARRIER_IMPL_FOR 0x0040
192#define KMP_IDENT_BARRIER_IMPL_SECTIONS 0x00C0
193
194#define KMP_IDENT_BARRIER_IMPL_SINGLE 0x0140
195#define KMP_IDENT_BARRIER_IMPL_WORKSHARE 0x01C0
196
197/*!
198 * The ident structure that describes a source location.
199 */
200typedef struct ident {
201 kmp_int32 reserved_1; /**< might be used in Fortran; see above */
202 kmp_int32 flags; /**< also f.flags; KMP_IDENT_xxx flags; KMP_IDENT_KMPC identifies this union member */
203 kmp_int32 reserved_2; /**< not really used in Fortran any more; see above */
204#if USE_ITT_BUILD
205 /* but currently used for storing region-specific ITT */
206 /* contextual information. */
207#endif /* USE_ITT_BUILD */
208 kmp_int32 reserved_3; /**< source[4] in Fortran, do not use for C++ */
Jim Cownie181b4bb2013-12-23 17:28:57 +0000209 char const *psource; /**< String describing the source location.
Jim Cownie5e8470a2013-09-27 10:38:44 +0000210 The string is composed of semi-colon separated fields which describe the source file,
211 the function and a pair of line numbers that delimit the construct.
212 */
213} ident_t;
214/*!
215@}
216*/
217
218// Some forward declarations.
219
220typedef union kmp_team kmp_team_t;
221typedef struct kmp_taskdata kmp_taskdata_t;
222typedef union kmp_task_team kmp_task_team_t;
223typedef union kmp_team kmp_team_p;
224typedef union kmp_info kmp_info_p;
225typedef union kmp_root kmp_root_p;
226
Jim Cownie5e8470a2013-09-27 10:38:44 +0000227#ifdef __cplusplus
228extern "C" {
229#endif
230
231/* ------------------------------------------------------------------------ */
232/* ------------------------------------------------------------------------ */
233
234/* Pack two 32-bit signed integers into a 64-bit signed integer */
235/* ToDo: Fix word ordering for big-endian machines. */
236#define KMP_PACK_64(HIGH_32,LOW_32) \
237 ( (kmp_int64) ((((kmp_uint64)(HIGH_32))<<32) | (kmp_uint64)(LOW_32)) )
238
239
240/*
241 * Generic string manipulation macros.
242 * Assume that _x is of type char *
243 */
244#define SKIP_WS(_x) { while (*(_x) == ' ' || *(_x) == '\t') (_x)++; }
245#define SKIP_DIGITS(_x) { while (*(_x) >= '0' && *(_x) <= '9') (_x)++; }
246#define SKIP_TO(_x,_c) { while (*(_x) != '\0' && *(_x) != (_c)) (_x)++; }
247
248/* ------------------------------------------------------------------------ */
249/* ------------------------------------------------------------------------ */
250
Jim Cownie181b4bb2013-12-23 17:28:57 +0000251#define KMP_MAX( x, y ) ( (x) > (y) ? (x) : (y) )
252#define KMP_MIN( x, y ) ( (x) < (y) ? (x) : (y) )
253
254/* ------------------------------------------------------------------------ */
255/* ------------------------------------------------------------------------ */
256
257
Jim Cownie5e8470a2013-09-27 10:38:44 +0000258/* Enumeration types */
259
260enum kmp_state_timer {
261 ts_stop,
262 ts_start,
263 ts_pause,
264
265 ts_last_state
266};
267
268enum dynamic_mode {
269 dynamic_default,
270#ifdef USE_LOAD_BALANCE
271 dynamic_load_balance,
272#endif /* USE_LOAD_BALANCE */
273 dynamic_random,
274 dynamic_thread_limit,
275 dynamic_max
276};
277
278/* external schedule constants, duplicate enum omp_sched in omp.h in order to not include it here */
279#ifndef KMP_SCHED_TYPE_DEFINED
280#define KMP_SCHED_TYPE_DEFINED
281typedef enum kmp_sched {
282 kmp_sched_lower = 0, // lower and upper bounds are for routine parameter check
283 // Note: need to adjust __kmp_sch_map global array in case this enum is changed
284 kmp_sched_static = 1, // mapped to kmp_sch_static_chunked (33)
285 kmp_sched_dynamic = 2, // mapped to kmp_sch_dynamic_chunked (35)
286 kmp_sched_guided = 3, // mapped to kmp_sch_guided_chunked (36)
287 kmp_sched_auto = 4, // mapped to kmp_sch_auto (38)
288 kmp_sched_upper_std = 5, // upper bound for standard schedules
289 kmp_sched_lower_ext = 100, // lower bound of Intel extension schedules
290 kmp_sched_trapezoidal = 101, // mapped to kmp_sch_trapezoidal (39)
291// kmp_sched_static_steal = 102, // mapped to kmp_sch_static_steal (44)
292 kmp_sched_upper = 102,
293 kmp_sched_default = kmp_sched_static // default scheduling
294} kmp_sched_t;
295#endif
296
297/*!
298 @ingroup WORK_SHARING
299 * Describes the loop schedule to be used for a parallel for loop.
300 */
301enum sched_type {
302 kmp_sch_lower = 32, /**< lower bound for unordered values */
303 kmp_sch_static_chunked = 33,
304 kmp_sch_static = 34, /**< static unspecialized */
305 kmp_sch_dynamic_chunked = 35,
306 kmp_sch_guided_chunked = 36, /**< guided unspecialized */
307 kmp_sch_runtime = 37,
308 kmp_sch_auto = 38, /**< auto */
309 kmp_sch_trapezoidal = 39,
310
311 /* accessible only through KMP_SCHEDULE environment variable */
312 kmp_sch_static_greedy = 40,
313 kmp_sch_static_balanced = 41,
314 /* accessible only through KMP_SCHEDULE environment variable */
315 kmp_sch_guided_iterative_chunked = 42,
316 kmp_sch_guided_analytical_chunked = 43,
317
318 kmp_sch_static_steal = 44, /**< accessible only through KMP_SCHEDULE environment variable */
319
320 /* accessible only through KMP_SCHEDULE environment variable */
321 kmp_sch_upper = 45, /**< upper bound for unordered values */
322
323 kmp_ord_lower = 64, /**< lower bound for ordered values, must be power of 2 */
324 kmp_ord_static_chunked = 65,
325 kmp_ord_static = 66, /**< ordered static unspecialized */
326 kmp_ord_dynamic_chunked = 67,
327 kmp_ord_guided_chunked = 68,
328 kmp_ord_runtime = 69,
329 kmp_ord_auto = 70, /**< ordered auto */
330 kmp_ord_trapezoidal = 71,
331 kmp_ord_upper = 72, /**< upper bound for ordered values */
332
333#if OMP_40_ENABLED
334 /* Schedules for Distribute construct */
335 kmp_distribute_static_chunked = 91, /**< distribute static chunked */
336 kmp_distribute_static = 92, /**< distribute static unspecialized */
337#endif
338
339 /*
340 * For the "nomerge" versions, kmp_dispatch_next*() will always return
341 * a single iteration/chunk, even if the loop is serialized. For the
342 * schedule types listed above, the entire iteration vector is returned
343 * if the loop is serialized. This doesn't work for gcc/gcomp sections.
344 */
345 kmp_nm_lower = 160, /**< lower bound for nomerge values */
346
347 kmp_nm_static_chunked = (kmp_sch_static_chunked - kmp_sch_lower + kmp_nm_lower),
348 kmp_nm_static = 162, /**< static unspecialized */
349 kmp_nm_dynamic_chunked = 163,
350 kmp_nm_guided_chunked = 164, /**< guided unspecialized */
351 kmp_nm_runtime = 165,
352 kmp_nm_auto = 166, /**< auto */
353 kmp_nm_trapezoidal = 167,
354
355 /* accessible only through KMP_SCHEDULE environment variable */
356 kmp_nm_static_greedy = 168,
357 kmp_nm_static_balanced = 169,
358 /* accessible only through KMP_SCHEDULE environment variable */
359 kmp_nm_guided_iterative_chunked = 170,
360 kmp_nm_guided_analytical_chunked = 171,
361 kmp_nm_static_steal = 172, /* accessible only through OMP_SCHEDULE environment variable */
362
363 kmp_nm_ord_static_chunked = 193,
364 kmp_nm_ord_static = 194, /**< ordered static unspecialized */
365 kmp_nm_ord_dynamic_chunked = 195,
366 kmp_nm_ord_guided_chunked = 196,
367 kmp_nm_ord_runtime = 197,
368 kmp_nm_ord_auto = 198, /**< auto */
369 kmp_nm_ord_trapezoidal = 199,
370 kmp_nm_upper = 200, /**< upper bound for nomerge values */
371
Jonathan Peytonea0fe1d2016-02-25 17:55:50 +0000372#if OMP_41_ENABLED
373 /* Support for OpenMP 4.5 monotonic and nonmonotonic schedule modifiers.
374 * Since we need to distinguish the three possible cases (no modifier, monotonic modifier,
375 * nonmonotonic modifier), we need separate bits for each modifier.
376 * The absence of monotonic does not imply nonmonotonic, especially since 4.5 says
377 * that the behaviour of the "no modifier" case is implementation defined in 4.5,
378 * but will become "nonmonotonic" in 5.0.
379 *
380 * Since we're passing a full 32 bit value, we can use a couple of high bits for these
381 * flags; out of paranoia we avoid the sign bit.
382 *
383 * These modifiers can be or-ed into non-static schedules by the compiler to pass
384 * the additional information.
385 * They will be stripped early in the processing in __kmp_dispatch_init when setting up schedules, so
386 * most of the code won't ever see schedules with these bits set.
387 */
388 kmp_sch_modifier_monotonic = (1<<29), /**< Set if the monotonic schedule modifier was present */
389 kmp_sch_modifier_nonmonotonic = (1<<30), /**< Set if the nonmonotonic schedule modifier was present */
390
391# define SCHEDULE_WITHOUT_MODIFIERS(s) (enum sched_type)((s) & ~ (kmp_sch_modifier_nonmonotonic | kmp_sch_modifier_monotonic))
392# define SCHEDULE_HAS_MONOTONIC(s) (((s) & kmp_sch_modifier_monotonic) != 0)
393# define SCHEDULE_HAS_NONMONOTONIC(s) (((s) & kmp_sch_modifier_nonmonotonic) != 0)
394# define SCHEDULE_HAS_NO_MODIFIERS(s) (((s) & (kmp_sch_modifier_nonmonotonic | kmp_sch_modifier_monotonic)) == 0)
395#else
396 /* By doing this we hope to avoid multiple tests on OMP_41_ENABLED. Compilers can now eliminate tests on compile time
397 * constants and dead code that results from them, so we can leave code guarded by such an if in place.
398 */
399# define SCHEDULE_WITHOUT_MODIFIERS(s) (s)
400# define SCHEDULE_HAS_MONOTONIC(s) false
401# define SCHEDULE_HAS_NONMONOTONIC(s) false
402# define SCHEDULE_HAS_NO_MODIFIERS(s) true
403#endif
404
Jim Cownie5e8470a2013-09-27 10:38:44 +0000405 kmp_sch_default = kmp_sch_static /**< default scheduling algorithm */
406};
407
408/* Type to keep runtime schedule set via OMP_SCHEDULE or omp_set_schedule() */
409typedef struct kmp_r_sched {
410 enum sched_type r_sched_type;
411 int chunk;
412} kmp_r_sched_t;
413
414extern enum sched_type __kmp_sch_map[]; // map OMP 3.0 schedule types with our internal schedule types
415
416enum library_type {
417 library_none,
418 library_serial,
419 library_turnaround,
420 library_throughput
421};
422
423#if KMP_OS_LINUX
424enum clock_function_type {
425 clock_function_gettimeofday,
426 clock_function_clock_gettime
427};
428#endif /* KMP_OS_LINUX */
429
Andrey Churbanov613edeb2015-02-20 18:14:43 +0000430#if KMP_ARCH_X86_64 && (KMP_OS_LINUX || KMP_OS_WINDOWS)
431enum mic_type {
432 non_mic,
433 mic1,
434 mic2,
435 mic3,
436 dummy
437};
438#endif
439
Jim Cownie5e8470a2013-09-27 10:38:44 +0000440/* ------------------------------------------------------------------------ */
441/* -- fast reduction stuff ------------------------------------------------ */
442
443#undef KMP_FAST_REDUCTION_BARRIER
444#define KMP_FAST_REDUCTION_BARRIER 1
445
446#undef KMP_FAST_REDUCTION_CORE_DUO
447#if KMP_ARCH_X86 || KMP_ARCH_X86_64
448 #define KMP_FAST_REDUCTION_CORE_DUO 1
449#endif
450
451enum _reduction_method {
452 reduction_method_not_defined = 0,
453 critical_reduce_block = ( 1 << 8 ),
454 atomic_reduce_block = ( 2 << 8 ),
455 tree_reduce_block = ( 3 << 8 ),
456 empty_reduce_block = ( 4 << 8 )
457};
458
459// description of the packed_reduction_method variable
460// the packed_reduction_method variable consists of two enum types variables that are packed together into 0-th byte and 1-st byte:
461// 0: ( packed_reduction_method & 0x000000FF ) is a 'enum barrier_type' value of barrier that will be used in fast reduction: bs_plain_barrier or bs_reduction_barrier
462// 1: ( packed_reduction_method & 0x0000FF00 ) is a reduction method that will be used in fast reduction;
463// reduction method is of 'enum _reduction_method' type and it's defined the way so that the bits of 0-th byte are empty,
464// so no need to execute a shift instruction while packing/unpacking
465
466#if KMP_FAST_REDUCTION_BARRIER
467 #define PACK_REDUCTION_METHOD_AND_BARRIER(reduction_method,barrier_type) \
468 ( ( reduction_method ) | ( barrier_type ) )
469
470 #define UNPACK_REDUCTION_METHOD(packed_reduction_method) \
471 ( ( enum _reduction_method )( ( packed_reduction_method ) & ( 0x0000FF00 ) ) )
472
473 #define UNPACK_REDUCTION_BARRIER(packed_reduction_method) \
474 ( ( enum barrier_type )( ( packed_reduction_method ) & ( 0x000000FF ) ) )
475#else
476 #define PACK_REDUCTION_METHOD_AND_BARRIER(reduction_method,barrier_type) \
477 ( reduction_method )
478
479 #define UNPACK_REDUCTION_METHOD(packed_reduction_method) \
480 ( packed_reduction_method )
481
482 #define UNPACK_REDUCTION_BARRIER(packed_reduction_method) \
483 ( bs_plain_barrier )
484#endif
485
486#define TEST_REDUCTION_METHOD(packed_reduction_method,which_reduction_block) \
487 ( ( UNPACK_REDUCTION_METHOD( packed_reduction_method ) ) == ( which_reduction_block ) )
488
489#if KMP_FAST_REDUCTION_BARRIER
490 #define TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER \
491 ( PACK_REDUCTION_METHOD_AND_BARRIER( tree_reduce_block, bs_reduction_barrier ) )
492
493 #define TREE_REDUCE_BLOCK_WITH_PLAIN_BARRIER \
494 ( PACK_REDUCTION_METHOD_AND_BARRIER( tree_reduce_block, bs_plain_barrier ) )
495#endif
496
497typedef int PACKED_REDUCTION_METHOD_T;
498
499/* -- end of fast reduction stuff ----------------------------------------- */
500
501/* ------------------------------------------------------------------------ */
502/* ------------------------------------------------------------------------ */
503
504#if KMP_OS_WINDOWS
505# define USE_CBLKDATA
506# pragma warning( push )
507# pragma warning( disable: 271 310 )
508# include <windows.h>
509# pragma warning( pop )
510#endif
511
512#if KMP_OS_UNIX
513# include <pthread.h>
514# include <dlfcn.h>
515#endif
516
517/* ------------------------------------------------------------------------ */
518/* ------------------------------------------------------------------------ */
519
520/*
521 * Only Linux* OS and Windows* OS support thread affinity.
522 */
Alp Toker763b9392014-02-28 09:42:41 +0000523#if KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +0000524
525extern size_t __kmp_affin_mask_size;
526# define KMP_AFFINITY_CAPABLE() (__kmp_affin_mask_size > 0)
Andrey Churbanov1f037e42015-03-10 09:15:26 +0000527# define KMP_AFFINITY_DISABLE() (__kmp_affin_mask_size = 0)
528# define KMP_AFFINITY_ENABLE(mask_size) (__kmp_affin_mask_size = mask_size)
Jim Cownie5e8470a2013-09-27 10:38:44 +0000529# define KMP_CPU_SETSIZE (__kmp_affin_mask_size * CHAR_BIT)
530
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000531#if KMP_USE_HWLOC
532
533typedef hwloc_cpuset_t kmp_affin_mask_t;
534# define KMP_CPU_SET(i,mask) hwloc_bitmap_set((hwloc_cpuset_t)mask, (unsigned)i)
535# define KMP_CPU_ISSET(i,mask) hwloc_bitmap_isset((hwloc_cpuset_t)mask, (unsigned)i)
536# define KMP_CPU_CLR(i,mask) hwloc_bitmap_clr((hwloc_cpuset_t)mask, (unsigned)i)
537# define KMP_CPU_ZERO(mask) hwloc_bitmap_zero((hwloc_cpuset_t)mask)
538# define KMP_CPU_COPY(dest, src) hwloc_bitmap_copy((hwloc_cpuset_t)dest, (hwloc_cpuset_t)src)
539# define KMP_CPU_COMPLEMENT(max_bit_number, mask) \
540 { \
541 unsigned i; \
542 for(i=0;i<(unsigned)max_bit_number+1;i++) { \
543 if(hwloc_bitmap_isset((hwloc_cpuset_t)mask, i)) { \
544 hwloc_bitmap_clr((hwloc_cpuset_t)mask, i); \
545 } else { \
546 hwloc_bitmap_set((hwloc_cpuset_t)mask, i); \
547 } \
548 } \
549 } \
550
551# define KMP_CPU_UNION(dest, src) hwloc_bitmap_or((hwloc_cpuset_t)dest, (hwloc_cpuset_t)dest, (hwloc_cpuset_t)src)
552# define KMP_CPU_SET_ITERATE(i,mask) \
553 for(i = hwloc_bitmap_first((hwloc_cpuset_t)mask); (int)i != -1; i = hwloc_bitmap_next((hwloc_cpuset_t)mask, i))
554
555# define KMP_CPU_ALLOC(ptr) ptr = (kmp_affin_mask_t*)hwloc_bitmap_alloc()
556# define KMP_CPU_FREE(ptr) hwloc_bitmap_free((hwloc_bitmap_t)ptr);
557# define KMP_CPU_ALLOC_ON_STACK(ptr) KMP_CPU_ALLOC(ptr)
558# define KMP_CPU_FREE_FROM_STACK(ptr) KMP_CPU_FREE(ptr)
559# define KMP_CPU_INTERNAL_ALLOC(ptr) KMP_CPU_ALLOC(ptr)
560# define KMP_CPU_INTERNAL_FREE(ptr) KMP_CPU_FREE(ptr)
561
562//
563// The following macro should be used to index an array of masks.
564// The array should be declared as "kmp_affinity_t *" and allocated with
565// size "__kmp_affinity_mask_size * len". The macro takes care of the fact
566// that on Windows* OS, sizeof(kmp_affin_t) is really the size of the mask, but
567// on Linux* OS, sizeof(kmp_affin_t) is 1.
568//
569# define KMP_CPU_INDEX(array,i) ((kmp_affin_mask_t*)(array[i]))
570# define KMP_CPU_ALLOC_ARRAY(arr, n) { \
571 arr = (kmp_affin_mask_t *)__kmp_allocate(n*sizeof(kmp_affin_mask_t)); \
572 unsigned i; \
573 for(i=0;i<(unsigned)n;i++) { \
574 arr[i] = hwloc_bitmap_alloc(); \
575 } \
576 }
577# define KMP_CPU_FREE_ARRAY(arr, n) { \
578 unsigned i; \
579 for(i=0;i<(unsigned)n;i++) { \
580 hwloc_bitmap_free(arr[i]); \
581 } \
582 __kmp_free(arr); \
583 }
584# define KMP_CPU_INTERNAL_ALLOC_ARRAY(arr, n) { \
585 arr = (kmp_affin_mask_t *)KMP_INTERNAL_MALLOC(n*sizeof(kmp_affin_mask_t)); \
586 unsigned i; \
587 for(i=0;i<(unsigned)n;i++) { \
588 arr[i] = hwloc_bitmap_alloc(); \
589 } \
590 }
591# define KMP_CPU_INTERNAL_FREE_ARRAY(arr, n) { \
592 unsigned i; \
593 for(i=0;i<(unsigned)n;i++) { \
594 hwloc_bitmap_free(arr[i]); \
595 } \
596 KMP_INTERNAL_FREE(arr); \
597 }
598
599#else /* KMP_USE_HWLOC */
600# define KMP_CPU_SET_ITERATE(i,mask) \
601 for(i = 0; (size_t)i < KMP_CPU_SETSIZE; ++i)
602
Jim Cownie5e8470a2013-09-27 10:38:44 +0000603# if KMP_OS_LINUX
604//
Jim Cownie3051f972014-08-07 10:12:54 +0000605// On Linux* OS, the mask is actually a vector of length __kmp_affin_mask_size
Jim Cownie5e8470a2013-09-27 10:38:44 +0000606// (in bytes). It should be allocated on a word boundary.
607//
608// WARNING!!! We have made the base type of the affinity mask unsigned char,
609// in order to eliminate a lot of checks that the true system mask size is
610// really a multiple of 4 bytes (on Linux* OS).
611//
612// THESE MACROS WON'T WORK PROPERLY ON BIG ENDIAN MACHINES!!!
613//
614
615typedef unsigned char kmp_affin_mask_t;
616
617# define _KMP_CPU_SET(i,mask) (mask[i/CHAR_BIT] |= (((kmp_affin_mask_t)1) << (i % CHAR_BIT)))
618# define KMP_CPU_SET(i,mask) _KMP_CPU_SET((i), ((kmp_affin_mask_t *)(mask)))
619# define _KMP_CPU_ISSET(i,mask) (!!(mask[i/CHAR_BIT] & (((kmp_affin_mask_t)1) << (i % CHAR_BIT))))
620# define KMP_CPU_ISSET(i,mask) _KMP_CPU_ISSET((i), ((kmp_affin_mask_t *)(mask)))
621# define _KMP_CPU_CLR(i,mask) (mask[i/CHAR_BIT] &= ~(((kmp_affin_mask_t)1) << (i % CHAR_BIT)))
622# define KMP_CPU_CLR(i,mask) _KMP_CPU_CLR((i), ((kmp_affin_mask_t *)(mask)))
623
624# define KMP_CPU_ZERO(mask) \
625 { \
626 size_t __i; \
627 for (__i = 0; __i < __kmp_affin_mask_size; __i++) { \
628 ((kmp_affin_mask_t *)(mask))[__i] = 0; \
629 } \
630 }
631
632# define KMP_CPU_COPY(dest, src) \
633 { \
634 size_t __i; \
635 for (__i = 0; __i < __kmp_affin_mask_size; __i++) { \
636 ((kmp_affin_mask_t *)(dest))[__i] \
637 = ((kmp_affin_mask_t *)(src))[__i]; \
638 } \
639 }
640
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000641# define KMP_CPU_COMPLEMENT(max_bit_number, mask) \
Jim Cownie5e8470a2013-09-27 10:38:44 +0000642 { \
643 size_t __i; \
644 for (__i = 0; __i < __kmp_affin_mask_size; __i++) { \
645 ((kmp_affin_mask_t *)(mask))[__i] \
646 = ~((kmp_affin_mask_t *)(mask))[__i]; \
647 } \
648 }
649
650# define KMP_CPU_UNION(dest, src) \
651 { \
652 size_t __i; \
653 for (__i = 0; __i < __kmp_affin_mask_size; __i++) { \
654 ((kmp_affin_mask_t *)(dest))[__i] \
655 |= ((kmp_affin_mask_t *)(src))[__i]; \
656 } \
657 }
658
659# endif /* KMP_OS_LINUX */
660
661# if KMP_OS_WINDOWS
662//
663// On Windows* OS, the mask size is 4 bytes for IA-32 architecture, and on
664// Intel(R) 64 it is 8 bytes times the number of processor groups.
665//
666
Andrey Churbanov7daf9802015-01-27 16:52:57 +0000667# if KMP_GROUP_AFFINITY
Jim Cownie5e8470a2013-09-27 10:38:44 +0000668
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000669// GROUP_AFFINITY is already defined for _MSC_VER>=1600 (VS2010 and later).
670# if _MSC_VER < 1600
Jim Cownie5e8470a2013-09-27 10:38:44 +0000671typedef struct GROUP_AFFINITY {
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000672 KAFFINITY Mask;
673 WORD Group;
674 WORD Reserved[3];
Jim Cownie5e8470a2013-09-27 10:38:44 +0000675} GROUP_AFFINITY;
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000676# endif
Jim Cownie5e8470a2013-09-27 10:38:44 +0000677
678typedef DWORD_PTR kmp_affin_mask_t;
679
680extern int __kmp_num_proc_groups;
681
682# define _KMP_CPU_SET(i,mask) \
683 (mask[i/(CHAR_BIT * sizeof(kmp_affin_mask_t))] |= \
684 (((kmp_affin_mask_t)1) << (i % (CHAR_BIT * sizeof(kmp_affin_mask_t)))))
685
686# define KMP_CPU_SET(i,mask) \
687 _KMP_CPU_SET((i), ((kmp_affin_mask_t *)(mask)))
688
689# define _KMP_CPU_ISSET(i,mask) \
690 (!!(mask[i/(CHAR_BIT * sizeof(kmp_affin_mask_t))] & \
691 (((kmp_affin_mask_t)1) << (i % (CHAR_BIT * sizeof(kmp_affin_mask_t))))))
692
693# define KMP_CPU_ISSET(i,mask) \
694 _KMP_CPU_ISSET((i), ((kmp_affin_mask_t *)(mask)))
695
696# define _KMP_CPU_CLR(i,mask) \
697 (mask[i/(CHAR_BIT * sizeof(kmp_affin_mask_t))] &= \
698 ~(((kmp_affin_mask_t)1) << (i % (CHAR_BIT * sizeof(kmp_affin_mask_t)))))
699
700# define KMP_CPU_CLR(i,mask) \
701 _KMP_CPU_CLR((i), ((kmp_affin_mask_t *)(mask)))
702
703# define KMP_CPU_ZERO(mask) \
704 { \
705 int __i; \
706 for (__i = 0; __i < __kmp_num_proc_groups; __i++) { \
707 ((kmp_affin_mask_t *)(mask))[__i] = 0; \
708 } \
709 }
710
711# define KMP_CPU_COPY(dest, src) \
712 { \
713 int __i; \
714 for (__i = 0; __i < __kmp_num_proc_groups; __i++) { \
715 ((kmp_affin_mask_t *)(dest))[__i] \
716 = ((kmp_affin_mask_t *)(src))[__i]; \
717 } \
718 }
719
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000720# define KMP_CPU_COMPLEMENT(max_bit_number, mask) \
Jim Cownie5e8470a2013-09-27 10:38:44 +0000721 { \
722 int __i; \
723 for (__i = 0; __i < __kmp_num_proc_groups; __i++) { \
724 ((kmp_affin_mask_t *)(mask))[__i] \
725 = ~((kmp_affin_mask_t *)(mask))[__i]; \
726 } \
727 }
728
729# define KMP_CPU_UNION(dest, src) \
730 { \
731 int __i; \
732 for (__i = 0; __i < __kmp_num_proc_groups; __i++) { \
733 ((kmp_affin_mask_t *)(dest))[__i] \
734 |= ((kmp_affin_mask_t *)(src))[__i]; \
735 } \
736 }
737
738typedef DWORD (*kmp_GetActiveProcessorCount_t)(WORD);
739extern kmp_GetActiveProcessorCount_t __kmp_GetActiveProcessorCount;
740
741typedef WORD (*kmp_GetActiveProcessorGroupCount_t)(void);
742extern kmp_GetActiveProcessorGroupCount_t __kmp_GetActiveProcessorGroupCount;
743
744typedef BOOL (*kmp_GetThreadGroupAffinity_t)(HANDLE, GROUP_AFFINITY *);
745extern kmp_GetThreadGroupAffinity_t __kmp_GetThreadGroupAffinity;
746
747typedef BOOL (*kmp_SetThreadGroupAffinity_t)(HANDLE, const GROUP_AFFINITY *, GROUP_AFFINITY *);
748extern kmp_SetThreadGroupAffinity_t __kmp_SetThreadGroupAffinity;
749
750extern int __kmp_get_proc_group(kmp_affin_mask_t const *mask);
751
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000752# else /* KMP_GROUP_AFFINITY */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000753
754typedef DWORD kmp_affin_mask_t; /* for compatibility with older winbase.h */
755
756# define KMP_CPU_SET(i,mask) (*(mask) |= (((kmp_affin_mask_t)1) << (i)))
757# define KMP_CPU_ISSET(i,mask) (!!(*(mask) & (((kmp_affin_mask_t)1) << (i))))
758# define KMP_CPU_CLR(i,mask) (*(mask) &= ~(((kmp_affin_mask_t)1) << (i)))
759# define KMP_CPU_ZERO(mask) (*(mask) = 0)
760# define KMP_CPU_COPY(dest, src) (*(dest) = *(src))
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000761# define KMP_CPU_COMPLEMENT(max_bit_number, mask) (*(mask) = ~*(mask))
Jim Cownie5e8470a2013-09-27 10:38:44 +0000762# define KMP_CPU_UNION(dest, src) (*(dest) |= *(src))
763
Andrey Churbanov7daf9802015-01-27 16:52:57 +0000764# endif /* KMP_GROUP_AFFINITY */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000765
766# endif /* KMP_OS_WINDOWS */
767
768//
769// __kmp_allocate() will return memory allocated on a 4-bytes boundary.
770// after zeroing it - it takes care of those assumptions stated above.
771//
772# define KMP_CPU_ALLOC(ptr) \
773 (ptr = ((kmp_affin_mask_t *)__kmp_allocate(__kmp_affin_mask_size)))
774# define KMP_CPU_FREE(ptr) __kmp_free(ptr)
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000775# define KMP_CPU_ALLOC_ON_STACK(ptr) (ptr = ((kmp_affin_mask_t *)KMP_ALLOCA(__kmp_affin_mask_size)))
776# define KMP_CPU_FREE_FROM_STACK(ptr) /* Nothing */
777# define KMP_CPU_INTERNAL_ALLOC(ptr) (ptr = ((kmp_affin_mask_t *)KMP_INTERNAL_MALLOC(__kmp_affin_mask_size)))
778# define KMP_CPU_INTERNAL_FREE(ptr) KMP_INTERNAL_FREE(ptr)
Jim Cownie5e8470a2013-09-27 10:38:44 +0000779
780//
781// The following macro should be used to index an array of masks.
782// The array should be declared as "kmp_affinity_t *" and allocated with
783// size "__kmp_affinity_mask_size * len". The macro takes care of the fact
784// that on Windows* OS, sizeof(kmp_affin_t) is really the size of the mask, but
785// on Linux* OS, sizeof(kmp_affin_t) is 1.
786//
787# define KMP_CPU_INDEX(array,i) \
788 ((kmp_affin_mask_t *)(((char *)(array)) + (i) * __kmp_affin_mask_size))
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000789# define KMP_CPU_ALLOC_ARRAY(arr, n) arr = (kmp_affin_mask_t *)__kmp_allocate(n * __kmp_affin_mask_size)
790# define KMP_CPU_FREE_ARRAY(arr, n) __kmp_free(arr);
791# define KMP_CPU_INTERNAL_ALLOC_ARRAY(arr, n) arr = (kmp_affin_mask_t *)KMP_INTERNAL_MALLOC(n * __kmp_affin_mask_size)
792# define KMP_CPU_INTERNAL_FREE_ARRAY(arr, n) KMP_INTERNAL_FREE(arr);
793
794#endif /* KMP_USE_HWLOC */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000795
796//
797// Declare local char buffers with this size for printing debug and info
798// messages, using __kmp_affinity_print_mask().
799//
800#define KMP_AFFIN_MASK_PRINT_LEN 1024
801
802enum affinity_type {
803 affinity_none = 0,
804 affinity_physical,
805 affinity_logical,
806 affinity_compact,
807 affinity_scatter,
808 affinity_explicit,
Jim Cownie5e8470a2013-09-27 10:38:44 +0000809 affinity_balanced,
Jim Cownie5e8470a2013-09-27 10:38:44 +0000810 affinity_disabled, // not used outsize the env var parser
811 affinity_default
812};
813
814enum affinity_gran {
815 affinity_gran_fine = 0,
816 affinity_gran_thread,
817 affinity_gran_core,
818 affinity_gran_package,
819 affinity_gran_node,
Andrey Churbanov7daf9802015-01-27 16:52:57 +0000820#if KMP_GROUP_AFFINITY
Jim Cownie5e8470a2013-09-27 10:38:44 +0000821 //
822 // The "group" granularity isn't necesssarily coarser than all of the
823 // other levels, but we put it last in the enum.
824 //
825 affinity_gran_group,
Andrey Churbanov7daf9802015-01-27 16:52:57 +0000826#endif /* KMP_GROUP_AFFINITY */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000827 affinity_gran_default
828};
829
830enum affinity_top_method {
831 affinity_top_method_all = 0, // try all (supported) methods, in order
832#if KMP_ARCH_X86 || KMP_ARCH_X86_64
833 affinity_top_method_apicid,
834 affinity_top_method_x2apicid,
835#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
836 affinity_top_method_cpuinfo, // KMP_CPUINFO_FILE is usable on Windows* OS, too
Andrey Churbanov7daf9802015-01-27 16:52:57 +0000837#if KMP_GROUP_AFFINITY
Jim Cownie5e8470a2013-09-27 10:38:44 +0000838 affinity_top_method_group,
Andrey Churbanov7daf9802015-01-27 16:52:57 +0000839#endif /* KMP_GROUP_AFFINITY */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000840 affinity_top_method_flat,
Jonathan Peyton01dcf362015-11-30 20:02:59 +0000841#if KMP_USE_HWLOC
842 affinity_top_method_hwloc,
843#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +0000844 affinity_top_method_default
845};
846
847#define affinity_respect_mask_default (-1)
848
849extern enum affinity_type __kmp_affinity_type; /* Affinity type */
850extern enum affinity_gran __kmp_affinity_gran; /* Affinity granularity */
851extern int __kmp_affinity_gran_levels; /* corresponding int value */
852extern int __kmp_affinity_dups; /* Affinity duplicate masks */
853extern enum affinity_top_method __kmp_affinity_top_method;
854extern int __kmp_affinity_compact; /* Affinity 'compact' value */
855extern int __kmp_affinity_offset; /* Affinity offset value */
856extern int __kmp_affinity_verbose; /* Was verbose specified for KMP_AFFINITY? */
857extern int __kmp_affinity_warnings; /* KMP_AFFINITY warnings enabled ? */
858extern int __kmp_affinity_respect_mask; /* Respect process' initial affinity mask? */
859extern char * __kmp_affinity_proclist; /* proc ID list */
860extern kmp_affin_mask_t *__kmp_affinity_masks;
861extern unsigned __kmp_affinity_num_masks;
862extern int __kmp_get_system_affinity(kmp_affin_mask_t *mask, int abort_on_error);
863extern int __kmp_set_system_affinity(kmp_affin_mask_t const *mask, int abort_on_error);
864extern void __kmp_affinity_bind_thread(int which);
865
866# if KMP_OS_LINUX
867extern kmp_affin_mask_t *__kmp_affinity_get_fullMask();
868# endif /* KMP_OS_LINUX */
869extern char const * __kmp_cpuinfo_file;
870
Alp Toker763b9392014-02-28 09:42:41 +0000871#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000872
873#if OMP_40_ENABLED
874
875//
876// This needs to be kept in sync with the values in omp.h !!!
877//
878typedef enum kmp_proc_bind_t {
879 proc_bind_false = 0,
880 proc_bind_true,
881 proc_bind_master,
882 proc_bind_close,
883 proc_bind_spread,
Jim Cownie5e8470a2013-09-27 10:38:44 +0000884 proc_bind_intel, // use KMP_AFFINITY interface
885 proc_bind_default
886} kmp_proc_bind_t;
887
888typedef struct kmp_nested_proc_bind_t {
889 kmp_proc_bind_t *bind_types;
890 int size;
891 int used;
892} kmp_nested_proc_bind_t;
893
894extern kmp_nested_proc_bind_t __kmp_nested_proc_bind;
895
Andrey Churbanovcbda8682015-01-13 14:43:35 +0000896#endif /* OMP_40_ENABLED */
897
Alp Toker98758b02014-03-02 04:12:06 +0000898# if KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +0000899# define KMP_PLACE_ALL (-1)
900# define KMP_PLACE_UNDEFINED (-2)
Alp Toker98758b02014-03-02 04:12:06 +0000901# endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000902
903extern int __kmp_affinity_num_places;
904
Jim Cownie5e8470a2013-09-27 10:38:44 +0000905
Jim Cownie181b4bb2013-12-23 17:28:57 +0000906#if OMP_40_ENABLED
907typedef enum kmp_cancel_kind_t {
908 cancel_noreq = 0,
909 cancel_parallel = 1,
910 cancel_loop = 2,
911 cancel_sections = 3,
912 cancel_taskgroup = 4
913} kmp_cancel_kind_t;
914#endif // OMP_40_ENABLED
915
Jonathan Peytondd4aa9b2015-10-08 17:55:54 +0000916extern int __kmp_place_num_sockets;
917extern int __kmp_place_socket_offset;
Andrey Churbanov12875572015-03-10 09:00:36 +0000918extern int __kmp_place_num_cores;
Andrey Churbanov12875572015-03-10 09:00:36 +0000919extern int __kmp_place_core_offset;
Jonathan Peytondd4aa9b2015-10-08 17:55:54 +0000920extern int __kmp_place_num_threads_per_core;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000921
922/* ------------------------------------------------------------------------ */
923/* ------------------------------------------------------------------------ */
924
925#define KMP_PAD(type, sz) (sizeof(type) + (sz - ((sizeof(type) - 1) % (sz)) - 1))
926
927//
928// We need to avoid using -1 as a GTID as +1 is added to the gtid
929// when storing it in a lock, and the value 0 is reserved.
930//
931#define KMP_GTID_DNE (-2) /* Does not exist */
932#define KMP_GTID_SHUTDOWN (-3) /* Library is shutting down */
933#define KMP_GTID_MONITOR (-4) /* Monitor thread ID */
934#define KMP_GTID_UNKNOWN (-5) /* Is not known */
935#define KMP_GTID_MIN (-6) /* Minimal gtid for low bound check in DEBUG */
936
937#define __kmp_get_gtid() __kmp_get_global_thread_id()
938#define __kmp_entry_gtid() __kmp_get_global_thread_id_reg()
939
940#define __kmp_tid_from_gtid(gtid) ( KMP_DEBUG_ASSERT( (gtid) >= 0 ), \
Jim Cownie5e8470a2013-09-27 10:38:44 +0000941 __kmp_threads[ (gtid) ]->th.th_info.ds.ds_tid )
942
943#define __kmp_get_tid() ( __kmp_tid_from_gtid( __kmp_get_gtid() ) )
944#define __kmp_gtid_from_tid(tid,team) ( KMP_DEBUG_ASSERT( (tid) >= 0 && (team) != NULL ), \
945 team -> t.t_threads[ (tid) ] -> th.th_info .ds.ds_gtid )
946
947#define __kmp_get_team() ( __kmp_threads[ (__kmp_get_gtid()) ]-> th.th_team )
948#define __kmp_team_from_gtid(gtid) ( KMP_DEBUG_ASSERT( (gtid) >= 0 ), \
949 __kmp_threads[ (gtid) ]-> th.th_team )
950
951#define __kmp_thread_from_gtid(gtid) ( KMP_DEBUG_ASSERT( (gtid) >= 0 ), __kmp_threads[ (gtid) ] )
952#define __kmp_get_thread() ( __kmp_thread_from_gtid( __kmp_get_gtid() ) )
953
954 // Returns current thread (pointer to kmp_info_t). In contrast to __kmp_get_thread(), it works
955 // with registered and not-yet-registered threads.
956#define __kmp_gtid_from_thread(thr) ( KMP_DEBUG_ASSERT( (thr) != NULL ), \
957 (thr)->th.th_info.ds.ds_gtid )
958
959// AT: Which way is correct?
960// AT: 1. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team -> t.t_nproc;
961// AT: 2. nproc = __kmp_threads[ ( gtid ) ] -> th.th_team_nproc;
962#define __kmp_get_team_num_threads(gtid) ( __kmp_threads[ ( gtid ) ] -> th.th_team -> t.t_nproc )
963
964
965/* ------------------------------------------------------------------------ */
966/* ------------------------------------------------------------------------ */
967
968#define KMP_UINT64_MAX (~((kmp_uint64)1<<((sizeof(kmp_uint64)*(1<<3))-1)))
969
970#define KMP_MIN_NTH 1
971
972#ifndef KMP_MAX_NTH
Dimitry Andric9b8c3532015-10-19 17:32:04 +0000973# if defined(PTHREAD_THREADS_MAX) && PTHREAD_THREADS_MAX < INT_MAX
Jim Cownie5e8470a2013-09-27 10:38:44 +0000974# define KMP_MAX_NTH PTHREAD_THREADS_MAX
975# else
Dimitry Andric9b8c3532015-10-19 17:32:04 +0000976# define KMP_MAX_NTH INT_MAX
Jim Cownie5e8470a2013-09-27 10:38:44 +0000977# endif
978#endif /* KMP_MAX_NTH */
979
980#ifdef PTHREAD_STACK_MIN
981# define KMP_MIN_STKSIZE PTHREAD_STACK_MIN
982#else
983# define KMP_MIN_STKSIZE ((size_t)(32 * 1024))
984#endif
985
986#define KMP_MAX_STKSIZE (~((size_t)1<<((sizeof(size_t)*(1<<3))-1)))
987
988#if KMP_ARCH_X86
989# define KMP_DEFAULT_STKSIZE ((size_t)(2 * 1024 * 1024))
990#elif KMP_ARCH_X86_64
991# define KMP_DEFAULT_STKSIZE ((size_t)(4 * 1024 * 1024))
992# define KMP_BACKUP_STKSIZE ((size_t)(2 * 1024 * 1024))
993#else
994# define KMP_DEFAULT_STKSIZE ((size_t)(1024 * 1024))
995#endif
996
997#define KMP_DEFAULT_MONITOR_STKSIZE ((size_t)(64 * 1024))
998
999#define KMP_DEFAULT_MALLOC_POOL_INCR ((size_t) (1024 * 1024))
1000#define KMP_MIN_MALLOC_POOL_INCR ((size_t) (4 * 1024))
1001#define KMP_MAX_MALLOC_POOL_INCR (~((size_t)1<<((sizeof(size_t)*(1<<3))-1)))
1002
1003#define KMP_MIN_STKOFFSET (0)
1004#define KMP_MAX_STKOFFSET KMP_MAX_STKSIZE
Andrey Churbanova5547bc2015-02-20 17:57:58 +00001005#if KMP_OS_DARWIN
1006# define KMP_DEFAULT_STKOFFSET KMP_MIN_STKOFFSET
1007#else
1008# define KMP_DEFAULT_STKOFFSET CACHE_LINE
1009#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001010
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001011#define KMP_MIN_STKPADDING (0)
1012#define KMP_MAX_STKPADDING (2 * 1024 * 1024)
1013
Jim Cownie5e8470a2013-09-27 10:38:44 +00001014#define KMP_MIN_MONITOR_WAKEUPS (1) /* min number of times monitor wakes up per second */
1015#define KMP_MAX_MONITOR_WAKEUPS (1000) /* maximum number of times monitor can wake up per second */
1016#define KMP_BLOCKTIME_MULTIPLIER (1000) /* number of blocktime units per second */
1017#define KMP_MIN_BLOCKTIME (0)
1018#define KMP_MAX_BLOCKTIME (INT_MAX) /* Must be this for "infinite" setting the work */
1019#define KMP_DEFAULT_BLOCKTIME (200) /* __kmp_blocktime is in milliseconds */
1020/* Calculate new number of monitor wakeups for a specific block time based on previous monitor_wakeups */
1021/* Only allow increasing number of wakeups */
1022#define KMP_WAKEUPS_FROM_BLOCKTIME(blocktime, monitor_wakeups) \
1023 ( ((blocktime) == KMP_MAX_BLOCKTIME) ? (monitor_wakeups) : \
1024 ((blocktime) == KMP_MIN_BLOCKTIME) ? KMP_MAX_MONITOR_WAKEUPS : \
1025 ((monitor_wakeups) > (KMP_BLOCKTIME_MULTIPLIER / (blocktime))) ? (monitor_wakeups) : \
1026 (KMP_BLOCKTIME_MULTIPLIER) / (blocktime) )
1027
1028/* Calculate number of intervals for a specific block time based on monitor_wakeups */
1029#define KMP_INTERVALS_FROM_BLOCKTIME(blocktime, monitor_wakeups) \
1030 ( ( (blocktime) + (KMP_BLOCKTIME_MULTIPLIER / (monitor_wakeups)) - 1 ) / \
1031 (KMP_BLOCKTIME_MULTIPLIER / (monitor_wakeups)) )
1032
1033#define KMP_MIN_STATSCOLS 40
1034#define KMP_MAX_STATSCOLS 4096
1035#define KMP_DEFAULT_STATSCOLS 80
1036
1037#define KMP_MIN_INTERVAL 0
1038#define KMP_MAX_INTERVAL (INT_MAX-1)
1039#define KMP_DEFAULT_INTERVAL 0
1040
1041#define KMP_MIN_CHUNK 1
1042#define KMP_MAX_CHUNK (INT_MAX-1)
1043#define KMP_DEFAULT_CHUNK 1
1044
1045#define KMP_MIN_INIT_WAIT 1
1046#define KMP_MAX_INIT_WAIT (INT_MAX/2)
1047#define KMP_DEFAULT_INIT_WAIT 2048U
1048
1049#define KMP_MIN_NEXT_WAIT 1
1050#define KMP_MAX_NEXT_WAIT (INT_MAX/2)
1051#define KMP_DEFAULT_NEXT_WAIT 1024U
1052
1053// max possible dynamic loops in concurrent execution per team
1054#define KMP_MAX_DISP_BUF 7
1055#define KMP_MAX_ORDERED 8
1056
1057#define KMP_MAX_FIELDS 32
1058
1059#define KMP_MAX_BRANCH_BITS 31
1060
1061#define KMP_MAX_ACTIVE_LEVELS_LIMIT INT_MAX
1062
Jonathan Peyton28510722016-02-25 18:04:09 +00001063#define KMP_MAX_TASK_PRIORITY_LIMIT INT_MAX
1064
Jim Cownie5e8470a2013-09-27 10:38:44 +00001065/* Minimum number of threads before switch to TLS gtid (experimentally determined) */
1066/* josh TODO: what about OS X* tuning? */
1067#if KMP_ARCH_X86 || KMP_ARCH_X86_64
1068# define KMP_TLS_GTID_MIN 5
1069#else
1070# define KMP_TLS_GTID_MIN INT_MAX
1071#endif
1072
1073#define KMP_MASTER_TID(tid) ( (tid) == 0 )
1074#define KMP_WORKER_TID(tid) ( (tid) != 0 )
1075
1076#define KMP_MASTER_GTID(gtid) ( __kmp_tid_from_gtid((gtid)) == 0 )
1077#define KMP_WORKER_GTID(gtid) ( __kmp_tid_from_gtid((gtid)) != 0 )
1078#define KMP_UBER_GTID(gtid) \
1079 ( \
1080 KMP_DEBUG_ASSERT( (gtid) >= KMP_GTID_MIN ), \
1081 KMP_DEBUG_ASSERT( (gtid) < __kmp_threads_capacity ), \
1082 (gtid) >= 0 && __kmp_root[(gtid)] && __kmp_threads[(gtid)] && \
1083 (__kmp_threads[(gtid)] == __kmp_root[(gtid)]->r.r_uber_thread)\
1084 )
1085#define KMP_INITIAL_GTID(gtid) ( (gtid) == 0 )
1086
1087#ifndef TRUE
1088#define FALSE 0
1089#define TRUE (! FALSE)
1090#endif
1091
1092/* NOTE: all of the following constants must be even */
1093
1094#if KMP_OS_WINDOWS
1095# define KMP_INIT_WAIT 64U /* initial number of spin-tests */
1096# define KMP_NEXT_WAIT 32U /* susequent number of spin-tests */
Jim Cownie3051f972014-08-07 10:12:54 +00001097#elif KMP_OS_CNK
1098# define KMP_INIT_WAIT 16U /* initial number of spin-tests */
1099# define KMP_NEXT_WAIT 8U /* susequent number of spin-tests */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001100#elif KMP_OS_LINUX
1101# define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1102# define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001103#elif KMP_OS_DARWIN
1104/* TODO: tune for KMP_OS_DARWIN */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001105# define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1106# define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001107#elif KMP_OS_FREEBSD
1108/* TODO: tune for KMP_OS_FREEBSD */
1109# define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1110# define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
Joerg Sonnenberger1564f3c2015-09-21 20:02:45 +00001111#elif KMP_OS_NETBSD
1112/* TODO: tune for KMP_OS_NETBSD */
1113# define KMP_INIT_WAIT 1024U /* initial number of spin-tests */
1114# define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001115#endif
1116
1117#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Andrey Churbanov613edeb2015-02-20 18:14:43 +00001118typedef struct kmp_cpuid {
Jim Cownie5e8470a2013-09-27 10:38:44 +00001119 kmp_uint32 eax;
1120 kmp_uint32 ebx;
1121 kmp_uint32 ecx;
1122 kmp_uint32 edx;
Andrey Churbanov613edeb2015-02-20 18:14:43 +00001123} kmp_cpuid_t;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001124extern void __kmp_x86_cpuid( int mode, int mode2, struct kmp_cpuid *p );
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001125# if KMP_ARCH_X86
1126 extern void __kmp_x86_pause( void );
1127# elif KMP_MIC
Jonathan Peyton95c95c32016-02-18 19:38:25 +00001128 static void __kmp_x86_pause( void ) { _mm_delay_32( 100 ); }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001129# else
Jonathan Peyton95c95c32016-02-18 19:38:25 +00001130 static void __kmp_x86_pause( void ) { _mm_pause(); }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001131# endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001132# define KMP_CPU_PAUSE() __kmp_x86_pause()
Jim Cownie3051f972014-08-07 10:12:54 +00001133#elif KMP_ARCH_PPC64
1134# define KMP_PPC64_PRI_LOW() __asm__ volatile ("or 1, 1, 1")
1135# define KMP_PPC64_PRI_MED() __asm__ volatile ("or 2, 2, 2")
1136# define KMP_PPC64_PRI_LOC_MB() __asm__ volatile ("" : : : "memory")
1137# define KMP_CPU_PAUSE() do { KMP_PPC64_PRI_LOW(); KMP_PPC64_PRI_MED(); KMP_PPC64_PRI_LOC_MB(); } while (0)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001138#else
1139# define KMP_CPU_PAUSE() /* nothing to do */
1140#endif
1141
1142#define KMP_INIT_YIELD(count) { (count) = __kmp_yield_init; }
1143
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001144#define KMP_YIELD(cond) { KMP_CPU_PAUSE(); __kmp_yield( (cond) ); }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001145
1146// Note the decrement of 2 in the following Macros. With KMP_LIBRARY=turnaround,
1147// there should be no yielding since the starting value from KMP_INIT_YIELD() is odd.
1148
1149#define KMP_YIELD_WHEN(cond,count) { KMP_CPU_PAUSE(); (count) -= 2; \
1150 if (!(count)) { KMP_YIELD(cond); (count) = __kmp_yield_next; } }
1151#define KMP_YIELD_SPIN(count) { KMP_CPU_PAUSE(); (count) -=2; \
1152 if (!(count)) { KMP_YIELD(1); (count) = __kmp_yield_next; } }
1153
1154/* ------------------------------------------------------------------------ */
1155/* Support datatypes for the orphaned construct nesting checks. */
1156/* ------------------------------------------------------------------------ */
1157
1158enum cons_type {
1159 ct_none,
1160 ct_parallel,
1161 ct_pdo,
1162 ct_pdo_ordered,
1163 ct_psections,
1164 ct_psingle,
1165
1166 /* the following must be left in order and not split up */
1167 ct_taskq,
1168 ct_task, /* really task inside non-ordered taskq, considered a worksharing type */
1169 ct_task_ordered, /* really task inside ordered taskq, considered a worksharing type */
1170 /* the preceding must be left in order and not split up */
1171
1172 ct_critical,
1173 ct_ordered_in_parallel,
1174 ct_ordered_in_pdo,
1175 ct_ordered_in_taskq,
1176 ct_master,
1177 ct_reduce,
1178 ct_barrier
1179};
1180
1181/* test to see if we are in a taskq construct */
1182# define IS_CONS_TYPE_TASKQ( ct ) ( ((int)(ct)) >= ((int)ct_taskq) && ((int)(ct)) <= ((int)ct_task_ordered) )
1183# define IS_CONS_TYPE_ORDERED( ct ) ((ct) == ct_pdo_ordered || (ct) == ct_task_ordered)
1184
1185struct cons_data {
1186 ident_t const *ident;
1187 enum cons_type type;
1188 int prev;
1189 kmp_user_lock_p name; /* address exclusively for critical section name comparison */
1190};
1191
1192struct cons_header {
1193 int p_top, w_top, s_top;
1194 int stack_size, stack_top;
1195 struct cons_data *stack_data;
1196};
1197
1198struct kmp_region_info {
1199 char *text;
1200 int offset[KMP_MAX_FIELDS];
1201 int length[KMP_MAX_FIELDS];
1202};
1203
1204
1205/* ---------------------------------------------------------------------- */
1206/* ---------------------------------------------------------------------- */
1207
1208#if KMP_OS_WINDOWS
1209 typedef HANDLE kmp_thread_t;
1210 typedef DWORD kmp_key_t;
1211#endif /* KMP_OS_WINDOWS */
1212
1213#if KMP_OS_UNIX
1214 typedef pthread_t kmp_thread_t;
1215 typedef pthread_key_t kmp_key_t;
1216#endif
1217
1218extern kmp_key_t __kmp_gtid_threadprivate_key;
1219
1220typedef struct kmp_sys_info {
1221 long maxrss; /* the maximum resident set size utilized (in kilobytes) */
1222 long minflt; /* the number of page faults serviced without any I/O */
1223 long majflt; /* the number of page faults serviced that required I/O */
1224 long nswap; /* the number of times a process was "swapped" out of memory */
1225 long inblock; /* the number of times the file system had to perform input */
1226 long oublock; /* the number of times the file system had to perform output */
1227 long nvcsw; /* the number of times a context switch was voluntarily */
1228 long nivcsw; /* the number of times a context switch was forced */
1229} kmp_sys_info_t;
1230
1231typedef struct kmp_cpuinfo {
1232 int initialized; // If 0, other fields are not initialized.
1233 int signature; // CPUID(1).EAX
1234 int family; // CPUID(1).EAX[27:20] + CPUID(1).EAX[11:8] ( Extended Family + Family )
1235 int model; // ( CPUID(1).EAX[19:16] << 4 ) + CPUID(1).EAX[7:4] ( ( Extended Model << 4 ) + Model)
1236 int stepping; // CPUID(1).EAX[3:0] ( Stepping )
1237 int sse2; // 0 if SSE2 instructions are not supported, 1 otherwise.
1238 int rtm; // 0 if RTM instructions are not supported, 1 otherwise.
1239 int cpu_stackoffset;
1240 int apic_id;
1241 int physical_id;
1242 int logical_id;
1243 kmp_uint64 frequency; // Nominal CPU frequency in Hz.
1244} kmp_cpuinfo_t;
1245
1246
1247#ifdef BUILD_TV
1248
1249struct tv_threadprivate {
1250 /* Record type #1 */
1251 void *global_addr;
1252 void *thread_addr;
1253};
1254
1255struct tv_data {
1256 struct tv_data *next;
1257 void *type;
1258 union tv_union {
1259 struct tv_threadprivate tp;
1260 } u;
1261};
1262
1263extern kmp_key_t __kmp_tv_key;
1264
1265#endif /* BUILD_TV */
1266
1267/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001268
1269#if USE_ITT_BUILD
1270// We cannot include "kmp_itt.h" due to circular dependency. Declare the only required type here.
1271// Later we will check the type meets requirements.
1272typedef int kmp_itt_mark_t;
1273#define KMP_ITT_DEBUG 0
1274#endif /* USE_ITT_BUILD */
1275
1276/* ------------------------------------------------------------------------ */
1277
1278/*
1279 * Taskq data structures
1280 */
1281
1282#define HIGH_WATER_MARK(nslots) (((nslots) * 3) / 4)
1283#define __KMP_TASKQ_THUNKS_PER_TH 1 /* num thunks that each thread can simultaneously execute from a task queue */
1284
1285/* flags for taskq_global_flags, kmp_task_queue_t tq_flags, kmpc_thunk_t th_flags */
1286
1287#define TQF_IS_ORDERED 0x0001 /* __kmpc_taskq interface, taskq ordered */
1288#define TQF_IS_LASTPRIVATE 0x0002 /* __kmpc_taskq interface, taskq with lastprivate list */
1289#define TQF_IS_NOWAIT 0x0004 /* __kmpc_taskq interface, end taskq nowait */
1290#define TQF_HEURISTICS 0x0008 /* __kmpc_taskq interface, use heuristics to decide task queue size */
1291#define TQF_INTERFACE_RESERVED1 0x0010 /* __kmpc_taskq interface, reserved for future use */
1292#define TQF_INTERFACE_RESERVED2 0x0020 /* __kmpc_taskq interface, reserved for future use */
1293#define TQF_INTERFACE_RESERVED3 0x0040 /* __kmpc_taskq interface, reserved for future use */
1294#define TQF_INTERFACE_RESERVED4 0x0080 /* __kmpc_taskq interface, reserved for future use */
1295
1296#define TQF_INTERFACE_FLAGS 0x00ff /* all the __kmpc_taskq interface flags */
1297
1298#define TQF_IS_LAST_TASK 0x0100 /* internal/read by instrumentation; only used with TQF_IS_LASTPRIVATE */
1299#define TQF_TASKQ_TASK 0x0200 /* internal use only; this thunk->th_task is the taskq_task */
1300#define TQF_RELEASE_WORKERS 0x0400 /* internal use only; must release worker threads once ANY queued task exists (global) */
1301#define TQF_ALL_TASKS_QUEUED 0x0800 /* internal use only; notify workers that master has finished enqueuing tasks */
1302#define TQF_PARALLEL_CONTEXT 0x1000 /* internal use only: this queue encountered in a parallel context: not serialized */
1303#define TQF_DEALLOCATED 0x2000 /* internal use only; this queue is on the freelist and not in use */
1304
1305#define TQF_INTERNAL_FLAGS 0x3f00 /* all the internal use only flags */
1306
1307typedef struct KMP_ALIGN_CACHE kmpc_aligned_int32_t {
1308 kmp_int32 ai_data;
1309} kmpc_aligned_int32_t;
1310
1311typedef struct KMP_ALIGN_CACHE kmpc_aligned_queue_slot_t {
1312 struct kmpc_thunk_t *qs_thunk;
1313} kmpc_aligned_queue_slot_t;
1314
1315typedef struct kmpc_task_queue_t {
1316 /* task queue linkage fields for n-ary tree of queues (locked with global taskq_tree_lck) */
1317 kmp_lock_t tq_link_lck; /* lock for child link, child next/prev links and child ref counts */
1318 union {
1319 struct kmpc_task_queue_t *tq_parent; /* pointer to parent taskq, not locked */
1320 struct kmpc_task_queue_t *tq_next_free; /* for taskq internal freelists, locked with global taskq_freelist_lck */
1321 } tq;
1322 volatile struct kmpc_task_queue_t *tq_first_child; /* pointer to linked-list of children, locked by tq's tq_link_lck */
1323 struct kmpc_task_queue_t *tq_next_child; /* next child in linked-list, locked by parent tq's tq_link_lck */
1324 struct kmpc_task_queue_t *tq_prev_child; /* previous child in linked-list, locked by parent tq's tq_link_lck */
1325 volatile kmp_int32 tq_ref_count; /* reference count of threads with access to this task queue */
1326 /* (other than the thread executing the kmpc_end_taskq call) */
1327 /* locked by parent tq's tq_link_lck */
1328
1329 /* shared data for task queue */
1330 struct kmpc_aligned_shared_vars_t *tq_shareds; /* per-thread array of pointers to shared variable structures */
1331 /* only one array element exists for all but outermost taskq */
1332
1333 /* bookkeeping for ordered task queue */
1334 kmp_uint32 tq_tasknum_queuing; /* ordered task number assigned while queuing tasks */
1335 volatile kmp_uint32 tq_tasknum_serving; /* ordered number of next task to be served (executed) */
1336
1337 /* thunk storage management for task queue */
1338 kmp_lock_t tq_free_thunks_lck; /* lock for thunk freelist manipulation */
1339 struct kmpc_thunk_t *tq_free_thunks; /* thunk freelist, chained via th.th_next_free */
1340 struct kmpc_thunk_t *tq_thunk_space; /* space allocated for thunks for this task queue */
1341
1342 /* data fields for queue itself */
1343 kmp_lock_t tq_queue_lck; /* lock for [de]enqueue operations: tq_queue, tq_head, tq_tail, tq_nfull */
1344 kmpc_aligned_queue_slot_t *tq_queue; /* array of queue slots to hold thunks for tasks */
1345 volatile struct kmpc_thunk_t *tq_taskq_slot; /* special slot for taskq task thunk, occupied if not NULL */
1346 kmp_int32 tq_nslots; /* # of tq_thunk_space thunks alloc'd (not incl. tq_taskq_slot space) */
1347 kmp_int32 tq_head; /* enqueue puts next item in here (index into tq_queue array) */
1348 kmp_int32 tq_tail; /* dequeue takes next item out of here (index into tq_queue array) */
1349 volatile kmp_int32 tq_nfull; /* # of occupied entries in task queue right now */
1350 kmp_int32 tq_hiwat; /* high-water mark for tq_nfull and queue scheduling */
1351 volatile kmp_int32 tq_flags; /* TQF_xxx */
1352
Alp Toker8f2d3f02014-02-24 10:40:15 +00001353 /* bookkeeping for outstanding thunks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001354 struct kmpc_aligned_int32_t *tq_th_thunks; /* per-thread array for # of regular thunks currently being executed */
1355 kmp_int32 tq_nproc; /* number of thunks in the th_thunks array */
1356
1357 /* statistics library bookkeeping */
1358 ident_t *tq_loc; /* source location information for taskq directive */
1359} kmpc_task_queue_t;
1360
1361typedef void (*kmpc_task_t) (kmp_int32 global_tid, struct kmpc_thunk_t *thunk);
1362
1363/* sizeof_shareds passed as arg to __kmpc_taskq call */
1364typedef struct kmpc_shared_vars_t { /* aligned during dynamic allocation */
1365 kmpc_task_queue_t *sv_queue;
1366 /* (pointers to) shared vars */
1367} kmpc_shared_vars_t;
1368
1369typedef struct KMP_ALIGN_CACHE kmpc_aligned_shared_vars_t {
1370 volatile struct kmpc_shared_vars_t *ai_data;
1371} kmpc_aligned_shared_vars_t;
1372
1373/* sizeof_thunk passed as arg to kmpc_taskq call */
1374typedef struct kmpc_thunk_t { /* aligned during dynamic allocation */
1375 union { /* field used for internal freelists too */
1376 kmpc_shared_vars_t *th_shareds;
1377 struct kmpc_thunk_t *th_next_free; /* freelist of individual thunks within queue, head at tq_free_thunks */
1378 } th;
1379 kmpc_task_t th_task; /* taskq_task if flags & TQF_TASKQ_TASK */
1380 struct kmpc_thunk_t *th_encl_thunk; /* pointer to dynamically enclosing thunk on this thread's call stack */
1381 kmp_int32 th_flags; /* TQF_xxx (tq_flags interface plus possible internal flags) */
1382 kmp_int32 th_status;
1383 kmp_uint32 th_tasknum; /* task number assigned in order of queuing, used for ordered sections */
1384 /* private vars */
1385} kmpc_thunk_t;
1386
1387typedef struct KMP_ALIGN_CACHE kmp_taskq {
1388 int tq_curr_thunk_capacity;
1389
1390 kmpc_task_queue_t *tq_root;
1391 kmp_int32 tq_global_flags;
1392
1393 kmp_lock_t tq_freelist_lck;
1394 kmpc_task_queue_t *tq_freelist;
1395
1396 kmpc_thunk_t **tq_curr_thunk;
1397} kmp_taskq_t;
1398
1399/* END Taskq data structures */
1400/* --------------------------------------------------------------------------- */
1401
1402typedef kmp_int32 kmp_critical_name[8];
1403
1404/*!
1405@ingroup PARALLEL
1406The type for a microtask which gets passed to @ref __kmpc_fork_call().
1407The arguments to the outlined function are
1408@param global_tid the global thread identity of the thread executing the function.
1409@param bound_tid the local identitiy of the thread executing the function
1410@param ... pointers to shared variables accessed by the function.
1411*/
1412typedef void (*kmpc_micro) ( kmp_int32 * global_tid, kmp_int32 * bound_tid, ... );
1413typedef void (*kmpc_micro_bound) ( kmp_int32 * bound_tid, kmp_int32 * bound_nth, ... );
1414
1415/*!
1416@ingroup THREADPRIVATE
1417@{
1418*/
1419/* --------------------------------------------------------------------------- */
1420/* Threadprivate initialization/finalization function declarations */
1421
1422/* for non-array objects: __kmpc_threadprivate_register() */
1423
1424/*!
1425 Pointer to the constructor function.
1426 The first argument is the <tt>this</tt> pointer
1427*/
1428typedef void *(*kmpc_ctor) (void *);
1429
1430/*!
1431 Pointer to the destructor function.
1432 The first argument is the <tt>this</tt> pointer
1433*/
1434typedef void (*kmpc_dtor) (void * /*, size_t */); /* 2nd arg: magic number for KCC unused by Intel compiler */
1435/*!
1436 Pointer to an alternate constructor.
1437 The first argument is the <tt>this</tt> pointer.
1438*/
1439typedef void *(*kmpc_cctor) (void *, void *);
1440
1441/* for array objects: __kmpc_threadprivate_register_vec() */
1442 /* First arg: "this" pointer */
1443 /* Last arg: number of array elements */
1444/*!
1445 Array constructor.
1446 First argument is the <tt>this</tt> pointer
1447 Second argument the number of array elements.
1448*/
1449typedef void *(*kmpc_ctor_vec) (void *, size_t);
1450/*!
1451 Pointer to the array destructor function.
1452 The first argument is the <tt>this</tt> pointer
1453 Second argument the number of array elements.
1454*/
1455typedef void (*kmpc_dtor_vec) (void *, size_t);
1456/*!
1457 Array constructor.
1458 First argument is the <tt>this</tt> pointer
1459 Third argument the number of array elements.
1460*/
1461typedef void *(*kmpc_cctor_vec) (void *, void *, size_t); /* function unused by compiler */
1462
1463/*!
1464@}
1465*/
1466
1467
1468/* ------------------------------------------------------------------------ */
1469
1470/* keeps tracked of threadprivate cache allocations for cleanup later */
1471typedef struct kmp_cached_addr {
1472 void **addr; /* address of allocated cache */
1473 struct kmp_cached_addr *next; /* pointer to next cached address */
1474} kmp_cached_addr_t;
1475
1476struct private_data {
1477 struct private_data *next; /* The next descriptor in the list */
1478 void *data; /* The data buffer for this descriptor */
1479 int more; /* The repeat count for this descriptor */
1480 size_t size; /* The data size for this descriptor */
1481};
1482
1483struct private_common {
1484 struct private_common *next;
1485 struct private_common *link;
1486 void *gbl_addr;
1487 void *par_addr; /* par_addr == gbl_addr for MASTER thread */
1488 size_t cmn_size;
1489};
1490
1491struct shared_common
1492{
1493 struct shared_common *next;
1494 struct private_data *pod_init;
1495 void *obj_init;
1496 void *gbl_addr;
1497 union {
1498 kmpc_ctor ctor;
1499 kmpc_ctor_vec ctorv;
1500 } ct;
1501 union {
1502 kmpc_cctor cctor;
1503 kmpc_cctor_vec cctorv;
1504 } cct;
1505 union {
1506 kmpc_dtor dtor;
1507 kmpc_dtor_vec dtorv;
1508 } dt;
1509 size_t vec_len;
1510 int is_vec;
1511 size_t cmn_size;
1512};
1513
1514#define KMP_HASH_TABLE_LOG2 9 /* log2 of the hash table size */
1515#define KMP_HASH_TABLE_SIZE (1 << KMP_HASH_TABLE_LOG2) /* size of the hash table */
1516#define KMP_HASH_SHIFT 3 /* throw away this many low bits from the address */
1517#define KMP_HASH(x) ((((kmp_uintptr_t) x) >> KMP_HASH_SHIFT) & (KMP_HASH_TABLE_SIZE-1))
1518
1519struct common_table {
1520 struct private_common *data[ KMP_HASH_TABLE_SIZE ];
1521};
1522
1523struct shared_table {
1524 struct shared_common *data[ KMP_HASH_TABLE_SIZE ];
1525};
1526/* ------------------------------------------------------------------------ */
1527/* ------------------------------------------------------------------------ */
1528
1529#ifdef KMP_STATIC_STEAL_ENABLED
1530typedef struct KMP_ALIGN_CACHE dispatch_private_info32 {
1531 kmp_int32 count;
1532 kmp_int32 ub;
1533 /* Adding KMP_ALIGN_CACHE here doesn't help / can hurt performance */
1534 kmp_int32 lb;
1535 kmp_int32 st;
1536 kmp_int32 tc;
1537 kmp_int32 static_steal_counter; /* for static_steal only; maybe better to put after ub */
1538
1539 // KMP_ALIGN( 16 ) ensures ( if the KMP_ALIGN macro is turned on )
1540 // a) parm3 is properly aligned and
1541 // b) all parm1-4 are in the same cache line.
1542 // Because of parm1-4 are used together, performance seems to be better
1543 // if they are in the same line (not measured though).
1544
1545 struct KMP_ALIGN( 32 ) { // AC: changed 16 to 32 in order to simplify template
1546 kmp_int32 parm1; // structures in kmp_dispatch.cpp. This should
1547 kmp_int32 parm2; // make no real change at least while padding is off.
1548 kmp_int32 parm3;
1549 kmp_int32 parm4;
1550 };
1551
1552 kmp_uint32 ordered_lower;
1553 kmp_uint32 ordered_upper;
1554#if KMP_OS_WINDOWS
1555 // This var can be placed in the hole between 'tc' and 'parm1', instead of 'static_steal_counter'.
1556 // It would be nice to measure execution times.
1557 // Conditional if/endif can be removed at all.
1558 kmp_int32 last_upper;
1559#endif /* KMP_OS_WINDOWS */
1560} dispatch_private_info32_t;
1561
1562typedef struct KMP_ALIGN_CACHE dispatch_private_info64 {
1563 kmp_int64 count; /* current chunk number for static and static-steal scheduling*/
1564 kmp_int64 ub; /* upper-bound */
1565 /* Adding KMP_ALIGN_CACHE here doesn't help / can hurt performance */
1566 kmp_int64 lb; /* lower-bound */
1567 kmp_int64 st; /* stride */
1568 kmp_int64 tc; /* trip count (number of iterations) */
1569 kmp_int64 static_steal_counter; /* for static_steal only; maybe better to put after ub */
1570
1571 /* parm[1-4] are used in different ways by different scheduling algorithms */
1572
1573 // KMP_ALIGN( 32 ) ensures ( if the KMP_ALIGN macro is turned on )
1574 // a) parm3 is properly aligned and
1575 // b) all parm1-4 are in the same cache line.
1576 // Because of parm1-4 are used together, performance seems to be better
1577 // if they are in the same line (not measured though).
1578
1579 struct KMP_ALIGN( 32 ) {
1580 kmp_int64 parm1;
1581 kmp_int64 parm2;
1582 kmp_int64 parm3;
1583 kmp_int64 parm4;
1584 };
1585
1586 kmp_uint64 ordered_lower;
1587 kmp_uint64 ordered_upper;
1588#if KMP_OS_WINDOWS
1589 // This var can be placed in the hole between 'tc' and 'parm1', instead of 'static_steal_counter'.
1590 // It would be nice to measure execution times.
1591 // Conditional if/endif can be removed at all.
1592 kmp_int64 last_upper;
1593#endif /* KMP_OS_WINDOWS */
1594} dispatch_private_info64_t;
1595#else /* KMP_STATIC_STEAL_ENABLED */
1596typedef struct KMP_ALIGN_CACHE dispatch_private_info32 {
1597 kmp_int32 lb;
1598 kmp_int32 ub;
1599 kmp_int32 st;
1600 kmp_int32 tc;
1601
1602 kmp_int32 parm1;
1603 kmp_int32 parm2;
1604 kmp_int32 parm3;
1605 kmp_int32 parm4;
1606
1607 kmp_int32 count;
1608
1609 kmp_uint32 ordered_lower;
1610 kmp_uint32 ordered_upper;
1611#if KMP_OS_WINDOWS
1612 kmp_int32 last_upper;
1613#endif /* KMP_OS_WINDOWS */
1614} dispatch_private_info32_t;
1615
1616typedef struct KMP_ALIGN_CACHE dispatch_private_info64 {
1617 kmp_int64 lb; /* lower-bound */
1618 kmp_int64 ub; /* upper-bound */
1619 kmp_int64 st; /* stride */
1620 kmp_int64 tc; /* trip count (number of iterations) */
1621
1622 /* parm[1-4] are used in different ways by different scheduling algorithms */
1623 kmp_int64 parm1;
1624 kmp_int64 parm2;
1625 kmp_int64 parm3;
1626 kmp_int64 parm4;
1627
1628 kmp_int64 count; /* current chunk number for static scheduling */
1629
1630 kmp_uint64 ordered_lower;
1631 kmp_uint64 ordered_upper;
1632#if KMP_OS_WINDOWS
1633 kmp_int64 last_upper;
1634#endif /* KMP_OS_WINDOWS */
1635} dispatch_private_info64_t;
1636#endif /* KMP_STATIC_STEAL_ENABLED */
1637
1638typedef struct KMP_ALIGN_CACHE dispatch_private_info {
1639 union private_info {
1640 dispatch_private_info32_t p32;
1641 dispatch_private_info64_t p64;
1642 } u;
1643 enum sched_type schedule; /* scheduling algorithm */
1644 kmp_int32 ordered; /* ordered clause specified */
1645 kmp_int32 ordered_bumped;
1646 kmp_int32 ordered_dummy[KMP_MAX_ORDERED-3]; // to retain the structure size after making ordered_iteration scalar
1647 struct dispatch_private_info * next; /* stack of buffers for nest of serial regions */
1648 kmp_int32 nomerge; /* don't merge iters if serialized */
1649 kmp_int32 type_size; /* the size of types in private_info */
1650 enum cons_type pushed_ws;
1651} dispatch_private_info_t;
1652
1653typedef struct dispatch_shared_info32 {
1654 /* chunk index under dynamic, number of idle threads under static-steal;
1655 iteration index otherwise */
1656 volatile kmp_uint32 iteration;
1657 volatile kmp_uint32 num_done;
1658 volatile kmp_uint32 ordered_iteration;
1659 kmp_int32 ordered_dummy[KMP_MAX_ORDERED-1]; // to retain the structure size after making ordered_iteration scalar
1660} dispatch_shared_info32_t;
1661
1662typedef struct dispatch_shared_info64 {
1663 /* chunk index under dynamic, number of idle threads under static-steal;
1664 iteration index otherwise */
1665 volatile kmp_uint64 iteration;
1666 volatile kmp_uint64 num_done;
1667 volatile kmp_uint64 ordered_iteration;
Jonathan Peyton71909c52016-03-02 22:42:06 +00001668 kmp_int64 ordered_dummy[KMP_MAX_ORDERED-3]; // to retain the structure size after making ordered_iteration scalar
Jim Cownie5e8470a2013-09-27 10:38:44 +00001669} dispatch_shared_info64_t;
1670
1671typedef struct dispatch_shared_info {
1672 union shared_info {
1673 dispatch_shared_info32_t s32;
1674 dispatch_shared_info64_t s64;
1675 } u;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001676 volatile kmp_uint32 buffer_index;
Jonathan Peyton71909c52016-03-02 22:42:06 +00001677#if OMP_41_ENABLED
1678 volatile kmp_int32 doacross_buf_idx; // teamwise index
1679 volatile kmp_uint32 *doacross_flags; // shared array of iteration flags (0/1)
1680 kmp_int32 doacross_num_done; // count finished threads
1681#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001682} dispatch_shared_info_t;
1683
1684typedef struct kmp_disp {
1685 /* Vector for ORDERED SECTION */
1686 void (*th_deo_fcn)( int * gtid, int * cid, ident_t *);
1687 /* Vector for END ORDERED SECTION */
1688 void (*th_dxo_fcn)( int * gtid, int * cid, ident_t *);
1689
1690 dispatch_shared_info_t *th_dispatch_sh_current;
1691 dispatch_private_info_t *th_dispatch_pr_current;
1692
1693 dispatch_private_info_t *th_disp_buffer;
1694 kmp_int32 th_disp_index;
Jonathan Peyton71909c52016-03-02 22:42:06 +00001695#if OMP_41_ENABLED
1696 kmp_int32 th_doacross_buf_idx; // thread's doacross buffer index
1697 volatile kmp_uint32 *th_doacross_flags; // pointer to shared array of flags
1698 kmp_int64 *th_doacross_info; // info on loop bounds
1699#else
Jim Cownie5e8470a2013-09-27 10:38:44 +00001700 void* dummy_padding[2]; // make it 64 bytes on Intel(R) 64
Jonathan Peyton71909c52016-03-02 22:42:06 +00001701#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001702#if KMP_USE_INTERNODE_ALIGNMENT
1703 char more_padding[INTERNODE_CACHE_LINE];
1704#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001705} kmp_disp_t;
1706
1707/* ------------------------------------------------------------------------ */
1708/* ------------------------------------------------------------------------ */
1709
1710/* Barrier stuff */
1711
1712/* constants for barrier state update */
1713#define KMP_INIT_BARRIER_STATE 0 /* should probably start from zero */
1714#define KMP_BARRIER_SLEEP_BIT 0 /* bit used for suspend/sleep part of state */
1715#define KMP_BARRIER_UNUSED_BIT 1 /* bit that must never be set for valid state */
1716#define KMP_BARRIER_BUMP_BIT 2 /* lsb used for bump of go/arrived state */
1717
Jonathan Peyton703d4042016-01-04 20:51:48 +00001718#define KMP_BARRIER_SLEEP_STATE (1 << KMP_BARRIER_SLEEP_BIT)
1719#define KMP_BARRIER_UNUSED_STATE (1 << KMP_BARRIER_UNUSED_BIT)
1720#define KMP_BARRIER_STATE_BUMP (1 << KMP_BARRIER_BUMP_BIT)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001721
1722#if (KMP_BARRIER_SLEEP_BIT >= KMP_BARRIER_BUMP_BIT)
1723# error "Barrier sleep bit must be smaller than barrier bump bit"
1724#endif
1725#if (KMP_BARRIER_UNUSED_BIT >= KMP_BARRIER_BUMP_BIT)
1726# error "Barrier unused bit must be smaller than barrier bump bit"
1727#endif
1728
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001729// Constants for release barrier wait state: currently, hierarchical only
1730#define KMP_BARRIER_NOT_WAITING 0 // Normal state; worker not in wait_sleep
1731#define KMP_BARRIER_OWN_FLAG 1 // Normal state; worker waiting on own b_go flag in release
1732#define KMP_BARRIER_PARENT_FLAG 2 // Special state; worker waiting on parent's b_go flag in release
1733#define KMP_BARRIER_SWITCH_TO_OWN_FLAG 3 // Special state; tells worker to shift from parent to own b_go
1734#define KMP_BARRIER_SWITCHING 4 // Special state; worker resets appropriate flag on wake-up
Jim Cownie5e8470a2013-09-27 10:38:44 +00001735
1736enum barrier_type {
1737 bs_plain_barrier = 0, /* 0, All non-fork/join barriers (except reduction barriers if enabled) */
1738 bs_forkjoin_barrier, /* 1, All fork/join (parallel region) barriers */
1739 #if KMP_FAST_REDUCTION_BARRIER
1740 bs_reduction_barrier, /* 2, All barriers that are used in reduction */
1741 #endif // KMP_FAST_REDUCTION_BARRIER
1742 bs_last_barrier /* Just a placeholder to mark the end */
1743};
1744
1745// to work with reduction barriers just like with plain barriers
1746#if !KMP_FAST_REDUCTION_BARRIER
1747 #define bs_reduction_barrier bs_plain_barrier
1748#endif // KMP_FAST_REDUCTION_BARRIER
1749
1750typedef enum kmp_bar_pat { /* Barrier communication patterns */
1751 bp_linear_bar = 0, /* Single level (degenerate) tree */
1752 bp_tree_bar = 1, /* Balanced tree with branching factor 2^n */
1753 bp_hyper_bar = 2, /* Hypercube-embedded tree with min branching factor 2^n */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001754 bp_hierarchical_bar = 3, /* Machine hierarchy tree */
1755 bp_last_bar = 4 /* Placeholder to mark the end */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001756} kmp_bar_pat_e;
1757
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001758# define KMP_BARRIER_ICV_PUSH 1
1759
1760/* Record for holding the values of the internal controls stack records */
1761typedef struct kmp_internal_control {
1762 int serial_nesting_level; /* corresponds to the value of the th_team_serialized field */
1763 kmp_int8 nested; /* internal control for nested parallelism (per thread) */
1764 kmp_int8 dynamic; /* internal control for dynamic adjustment of threads (per thread) */
1765 kmp_int8 bt_set; /* internal control for whether blocktime is explicitly set */
1766 int blocktime; /* internal control for blocktime */
1767 int bt_intervals; /* internal control for blocktime intervals */
1768 int nproc; /* internal control for #threads for next parallel region (per thread) */
1769 int max_active_levels; /* internal control for max_active_levels */
1770 kmp_r_sched_t sched; /* internal control for runtime schedule {sched,chunk} pair */
1771#if OMP_40_ENABLED
1772 kmp_proc_bind_t proc_bind; /* internal control for affinity */
1773#endif // OMP_40_ENABLED
1774 struct kmp_internal_control *next;
1775} kmp_internal_control_t;
1776
1777static inline void
1778copy_icvs( kmp_internal_control_t *dst, kmp_internal_control_t *src ) {
1779 *dst = *src;
1780}
1781
Jim Cownie5e8470a2013-09-27 10:38:44 +00001782/* Thread barrier needs volatile barrier fields */
1783typedef struct KMP_ALIGN_CACHE kmp_bstate {
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001784 // th_fixed_icvs is aligned by virtue of kmp_bstate being aligned (and all uses of it).
1785 // It is not explicitly aligned below, because we *don't* want it to be padded -- instead,
1786 // we fit b_go into the same cache line with th_fixed_icvs, enabling NGO cache lines
1787 // stores in the hierarchical barrier.
1788 kmp_internal_control_t th_fixed_icvs; // Initial ICVs for the thread
1789 // Tuck b_go into end of th_fixed_icvs cache line, so it can be stored with same NGO store
1790 volatile kmp_uint64 b_go; // STATE => task should proceed (hierarchical)
1791 KMP_ALIGN_CACHE volatile kmp_uint64 b_arrived; // STATE => task reached synch point.
1792 kmp_uint32 *skip_per_level;
1793 kmp_uint32 my_level;
1794 kmp_int32 parent_tid;
Jonathan Peyton1e7a1dd2015-06-04 17:29:13 +00001795 kmp_int32 old_tid;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001796 kmp_uint32 depth;
1797 struct kmp_bstate *parent_bar;
1798 kmp_team_t *team;
1799 kmp_uint64 leaf_state;
1800 kmp_uint32 nproc;
1801 kmp_uint8 base_leaf_kids;
1802 kmp_uint8 leaf_kids;
1803 kmp_uint8 offset;
1804 kmp_uint8 wait_flag;
1805 kmp_uint8 use_oncore_barrier;
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001806#if USE_DEBUGGER
1807 // The following field is intended for the debugger solely. Only the worker thread itself accesses this
1808 // field: the worker increases it by 1 when it arrives to a barrier.
1809 KMP_ALIGN_CACHE kmp_uint b_worker_arrived;
1810#endif /* USE_DEBUGGER */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001811} kmp_bstate_t;
1812
1813union KMP_ALIGN_CACHE kmp_barrier_union {
1814 double b_align; /* use worst case alignment */
1815 char b_pad[ KMP_PAD(kmp_bstate_t, CACHE_LINE) ];
1816 kmp_bstate_t bb;
1817};
1818
1819typedef union kmp_barrier_union kmp_balign_t;
1820
1821/* Team barrier needs only non-volatile arrived counter */
1822union KMP_ALIGN_CACHE kmp_barrier_team_union {
1823 double b_align; /* use worst case alignment */
1824 char b_pad[ CACHE_LINE ];
1825 struct {
Jonathan Peytond26e2132015-09-10 18:44:30 +00001826 kmp_uint64 b_arrived; /* STATE => task reached synch point. */
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001827#if USE_DEBUGGER
1828 // The following two fields are indended for the debugger solely. Only master of the team accesses
1829 // these fields: the first one is increased by 1 when master arrives to a barrier, the
1830 // second one is increased by one when all the threads arrived.
1831 kmp_uint b_master_arrived;
1832 kmp_uint b_team_arrived;
1833#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001834 };
1835};
1836
1837typedef union kmp_barrier_team_union kmp_balign_team_t;
1838
1839/*
1840 * Padding for Linux* OS pthreads condition variables and mutexes used to signal
1841 * threads when a condition changes. This is to workaround an NPTL bug
1842 * where padding was added to pthread_cond_t which caused the initialization
1843 * routine to write outside of the structure if compiled on pre-NPTL threads.
1844 */
1845
1846#if KMP_OS_WINDOWS
1847typedef struct kmp_win32_mutex
1848{
1849 /* The Lock */
1850 CRITICAL_SECTION cs;
1851} kmp_win32_mutex_t;
1852
1853typedef struct kmp_win32_cond
1854{
1855 /* Count of the number of waiters. */
1856 int waiters_count_;
1857
1858 /* Serialize access to <waiters_count_> */
1859 kmp_win32_mutex_t waiters_count_lock_;
1860
1861 /* Number of threads to release via a <cond_broadcast> or a */
1862 /* <cond_signal> */
1863 int release_count_;
1864
1865 /* Keeps track of the current "generation" so that we don't allow */
1866 /* one thread to steal all the "releases" from the broadcast. */
1867 int wait_generation_count_;
1868
1869 /* A manual-reset event that's used to block and release waiting */
1870 /* threads. */
1871 HANDLE event_;
1872} kmp_win32_cond_t;
1873#endif
1874
1875#if KMP_OS_UNIX
1876
1877union KMP_ALIGN_CACHE kmp_cond_union {
1878 double c_align;
1879 char c_pad[ CACHE_LINE ];
1880 pthread_cond_t c_cond;
1881};
1882
1883typedef union kmp_cond_union kmp_cond_align_t;
1884
1885union KMP_ALIGN_CACHE kmp_mutex_union {
1886 double m_align;
1887 char m_pad[ CACHE_LINE ];
1888 pthread_mutex_t m_mutex;
1889};
1890
1891typedef union kmp_mutex_union kmp_mutex_align_t;
1892
1893#endif /* KMP_OS_UNIX */
1894
1895typedef struct kmp_desc_base {
1896 void *ds_stackbase;
1897 size_t ds_stacksize;
1898 int ds_stackgrow;
1899 kmp_thread_t ds_thread;
1900 volatile int ds_tid;
1901 int ds_gtid;
1902#if KMP_OS_WINDOWS
1903 volatile int ds_alive;
1904 DWORD ds_thread_id;
1905 /*
1906 ds_thread keeps thread handle on Windows* OS. It is enough for RTL purposes. However,
1907 debugger support (libomp_db) cannot work with handles, because they uncomparable. For
1908 example, debugger requests info about thread with handle h. h is valid within debugger
1909 process, and meaningless within debugee process. Even if h is duped by call to
1910 DuplicateHandle(), so the result h' is valid within debugee process, but it is a *new*
1911 handle which does *not* equal to any other handle in debugee... The only way to
1912 compare handles is convert them to system-wide ids. GetThreadId() function is
1913 available only in Longhorn and Server 2003. :-( In contrast, GetCurrentThreadId() is
1914 available on all Windows* OS flavours (including Windows* 95). Thus, we have to get thread id by
1915 call to GetCurrentThreadId() from within the thread and save it to let libomp_db
1916 identify threads.
1917 */
1918#endif /* KMP_OS_WINDOWS */
1919} kmp_desc_base_t;
1920
1921typedef union KMP_ALIGN_CACHE kmp_desc {
1922 double ds_align; /* use worst case alignment */
1923 char ds_pad[ KMP_PAD(kmp_desc_base_t, CACHE_LINE) ];
1924 kmp_desc_base_t ds;
1925} kmp_desc_t;
1926
1927
1928typedef struct kmp_local {
1929 volatile int this_construct; /* count of single's encountered by thread */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001930 void *reduce_data;
1931#if KMP_USE_BGET
1932 void *bget_data;
1933 void *bget_list;
1934#if ! USE_CMP_XCHG_FOR_BGET
1935#ifdef USE_QUEUING_LOCK_FOR_BGET
1936 kmp_lock_t bget_lock; /* Lock for accessing bget free list */
1937#else
1938 kmp_bootstrap_lock_t bget_lock; /* Lock for accessing bget free list */
1939 /* Must be bootstrap lock so we can use it at library shutdown */
1940#endif /* USE_LOCK_FOR_BGET */
1941#endif /* ! USE_CMP_XCHG_FOR_BGET */
1942#endif /* KMP_USE_BGET */
1943
1944#ifdef BUILD_TV
1945 struct tv_data *tv_data;
1946#endif
1947
1948 PACKED_REDUCTION_METHOD_T packed_reduction_method; /* stored by __kmpc_reduce*(), used by __kmpc_end_reduce*() */
1949
1950} kmp_local_t;
1951
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001952#define get__blocktime( xteam, xtid ) ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.blocktime)
1953#define get__bt_set( xteam, xtid ) ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_set)
1954#define get__bt_intervals( xteam, xtid ) ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_intervals)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001955
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001956#define get__nested_2(xteam,xtid) ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.nested)
1957#define get__dynamic_2(xteam,xtid) ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.dynamic)
1958#define get__nproc_2(xteam,xtid) ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.nproc)
1959#define get__sched_2(xteam,xtid) ((xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.sched)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001960
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001961#define set__blocktime_team( xteam, xtid, xval ) \
1962 ( ( (xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.blocktime ) = (xval) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001963
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001964#define set__bt_intervals_team( xteam, xtid, xval ) \
1965 ( ( (xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_intervals ) = (xval) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001966
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001967#define set__bt_set_team( xteam, xtid, xval ) \
1968 ( ( (xteam)->t.t_threads[(xtid)]->th.th_current_task->td_icvs.bt_set ) = (xval) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001969
1970
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001971#define set__nested( xthread, xval ) \
1972 ( ( (xthread)->th.th_current_task->td_icvs.nested ) = (xval) )
1973#define get__nested( xthread ) \
1974 ( ( (xthread)->th.th_current_task->td_icvs.nested ) ? (FTN_TRUE) : (FTN_FALSE) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001975
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001976#define set__dynamic( xthread, xval ) \
1977 ( ( (xthread)->th.th_current_task->td_icvs.dynamic ) = (xval) )
1978#define get__dynamic( xthread ) \
1979 ( ( (xthread)->th.th_current_task->td_icvs.dynamic ) ? (FTN_TRUE) : (FTN_FALSE) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001980
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001981#define set__nproc( xthread, xval ) \
1982 ( ( (xthread)->th.th_current_task->td_icvs.nproc ) = (xval) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001983
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001984#define set__max_active_levels( xthread, xval ) \
1985 ( ( (xthread)->th.th_current_task->td_icvs.max_active_levels ) = (xval) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001986
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001987#define set__sched( xthread, xval ) \
1988 ( ( (xthread)->th.th_current_task->td_icvs.sched ) = (xval) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001989
1990#if OMP_40_ENABLED
1991
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001992#define set__proc_bind( xthread, xval ) \
1993 ( ( (xthread)->th.th_current_task->td_icvs.proc_bind ) = (xval) )
1994#define get__proc_bind( xthread ) \
1995 ( (xthread)->th.th_current_task->td_icvs.proc_bind )
Jim Cownie5e8470a2013-09-27 10:38:44 +00001996
1997#endif /* OMP_40_ENABLED */
1998
Jim Cownie5e8470a2013-09-27 10:38:44 +00001999
Jim Cownie5e8470a2013-09-27 10:38:44 +00002000/* ------------------------------------------------------------------------ */
2001// OpenMP tasking data structures
2002//
2003
2004typedef enum kmp_tasking_mode {
2005 tskm_immediate_exec = 0,
2006 tskm_extra_barrier = 1,
2007 tskm_task_teams = 2,
2008 tskm_max = 2
2009} kmp_tasking_mode_t;
2010
2011extern kmp_tasking_mode_t __kmp_tasking_mode; /* determines how/when to execute tasks */
2012extern kmp_int32 __kmp_task_stealing_constraint;
Jonathan Peyton28510722016-02-25 18:04:09 +00002013#if OMP_41_ENABLED
2014 extern kmp_int32 __kmp_max_task_priority; // Set via OMP_MAX_TASK_PRIORITY if specified, defaults to 0 otherwise
2015#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002016
2017/* NOTE: kmp_taskdata_t and kmp_task_t structures allocated in single block with taskdata first */
2018#define KMP_TASK_TO_TASKDATA(task) (((kmp_taskdata_t *) task) - 1)
2019#define KMP_TASKDATA_TO_TASK(taskdata) (kmp_task_t *) (taskdata + 1)
2020
2021// The tt_found_tasks flag is a signal to all threads in the team that tasks were spawned and
2022// queued since the previous barrier release.
Andrey Churbanov6d224db2015-02-10 18:37:43 +00002023#define KMP_TASKING_ENABLED(task_team) \
2024 (TCR_SYNC_4((task_team)->tt.tt_found_tasks) == TRUE)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002025/*!
2026@ingroup BASIC_TYPES
2027@{
2028*/
2029
2030/*!
2031 */
2032typedef kmp_int32 (* kmp_routine_entry_t)( kmp_int32, void * );
2033
Jonathan Peyton28510722016-02-25 18:04:09 +00002034#if OMP_40_ENABLED || OMP_41_ENABLED
2035typedef union kmp_cmplrdata {
2036#if OMP_41_ENABLED
2037 kmp_int32 priority; /**< priority specified by user for the task */
2038#endif // OMP_41_ENABLED
2039#if OMP_40_ENABLED
2040 kmp_routine_entry_t destructors; /* pointer to function to invoke deconstructors of firstprivate C++ objects */
2041#endif // OMP_40_ENABLED
2042 /* future data */
2043} kmp_cmplrdata_t;
2044#endif
2045
Jim Cownie5e8470a2013-09-27 10:38:44 +00002046/* sizeof_kmp_task_t passed as arg to kmpc_omp_task call */
2047/*!
2048 */
2049typedef struct kmp_task { /* GEH: Shouldn't this be aligned somehow? */
2050 void * shareds; /**< pointer to block of pointers to shared vars */
2051 kmp_routine_entry_t routine; /**< pointer to routine to call for executing task */
2052 kmp_int32 part_id; /**< part id for the task */
Jonathan Peyton28510722016-02-25 18:04:09 +00002053#if OMP_40_ENABLED || OMP_41_ENABLED
2054 kmp_cmplrdata_t data1; /* Two known optional additions: destructors and priority */
2055 kmp_cmplrdata_t data2; /* Process destructors first, priority second */
2056 /* future data */
2057#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002058 /* private vars */
2059} kmp_task_t;
Jim Cownie181b4bb2013-12-23 17:28:57 +00002060
Jim Cownie5e8470a2013-09-27 10:38:44 +00002061/*!
2062@}
2063*/
2064
2065#if OMP_40_ENABLED
2066typedef struct kmp_taskgroup {
2067 kmp_uint32 count; // number of allocated and not yet complete tasks
Jim Cownie181b4bb2013-12-23 17:28:57 +00002068 kmp_int32 cancel_request; // request for cancellation of this taskgroup
Jim Cownie5e8470a2013-09-27 10:38:44 +00002069 struct kmp_taskgroup *parent; // parent taskgroup
2070} kmp_taskgroup_t;
2071
2072
2073// forward declarations
2074typedef union kmp_depnode kmp_depnode_t;
2075typedef struct kmp_depnode_list kmp_depnode_list_t;
2076typedef struct kmp_dephash_entry kmp_dephash_entry_t;
2077
2078typedef struct kmp_depend_info {
2079 kmp_intptr_t base_addr;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002080 size_t len;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002081 struct {
2082 bool in:1;
2083 bool out:1;
2084 } flags;
2085} kmp_depend_info_t;
2086
2087struct kmp_depnode_list {
2088 kmp_depnode_t * node;
2089 kmp_depnode_list_t * next;
2090};
2091
2092typedef struct kmp_base_depnode {
2093 kmp_depnode_list_t * successors;
2094 kmp_task_t * task;
2095
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002096 kmp_lock_t lock;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002097
2098#if KMP_SUPPORT_GRAPH_OUTPUT
2099 kmp_uint32 id;
2100#endif
2101
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002102 volatile kmp_int32 npredecessors;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002103 volatile kmp_int32 nrefs;
2104} kmp_base_depnode_t;
2105
2106union KMP_ALIGN_CACHE kmp_depnode {
2107 double dn_align; /* use worst case alignment */
2108 char dn_pad[ KMP_PAD(kmp_base_depnode_t, CACHE_LINE) ];
2109 kmp_base_depnode_t dn;
2110};
2111
2112struct kmp_dephash_entry {
2113 kmp_intptr_t addr;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002114 kmp_depnode_t * last_out;
2115 kmp_depnode_list_t * last_ins;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002116 kmp_dephash_entry_t * next_in_bucket;
2117};
2118
2119typedef struct kmp_dephash {
2120 kmp_dephash_entry_t ** buckets;
Jonathan Peyton7d454512016-01-28 23:10:44 +00002121 size_t size;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002122#ifdef KMP_DEBUG
2123 kmp_uint32 nelements;
2124 kmp_uint32 nconflicts;
2125#endif
2126} kmp_dephash_t;
2127
2128#endif
2129
2130#ifdef BUILD_TIED_TASK_STACK
2131
2132/* Tied Task stack definitions */
2133typedef struct kmp_stack_block {
2134 kmp_taskdata_t * sb_block[ TASK_STACK_BLOCK_SIZE ];
2135 struct kmp_stack_block * sb_next;
2136 struct kmp_stack_block * sb_prev;
2137} kmp_stack_block_t;
2138
2139typedef struct kmp_task_stack {
2140 kmp_stack_block_t ts_first_block; // first block of stack entries
2141 kmp_taskdata_t ** ts_top; // pointer to the top of stack
2142 kmp_int32 ts_entries; // number of entries on the stack
2143} kmp_task_stack_t;
2144
2145#endif // BUILD_TIED_TASK_STACK
2146
2147typedef struct kmp_tasking_flags { /* Total struct must be exactly 32 bits */
2148 /* Compiler flags */ /* Total compiler flags must be 16 bits */
2149 unsigned tiedness : 1; /* task is either tied (1) or untied (0) */
2150 unsigned final : 1; /* task is final(1) so execute immediately */
2151 unsigned merged_if0 : 1; /* no __kmpc_task_{begin/complete}_if0 calls in if0 code path */
Jim Cownie181b4bb2013-12-23 17:28:57 +00002152#if OMP_40_ENABLED
2153 unsigned destructors_thunk : 1; /* set if the compiler creates a thunk to invoke destructors from the runtime */
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00002154#if OMP_41_ENABLED
2155 unsigned proxy : 1; /* task is a proxy task (it will be executed outside the context of the RTL) */
Jonathan Peyton28510722016-02-25 18:04:09 +00002156 unsigned priority_specified :1; /* set if the compiler provides priority setting for the task */
2157 unsigned reserved : 10; /* reserved for compiler use */
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00002158#else
Jim Cownie181b4bb2013-12-23 17:28:57 +00002159 unsigned reserved : 12; /* reserved for compiler use */
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00002160#endif
Jim Cownie181b4bb2013-12-23 17:28:57 +00002161#else // OMP_40_ENABLED
2162 unsigned reserved : 13; /* reserved for compiler use */
2163#endif // OMP_40_ENABLED
Jim Cownie5e8470a2013-09-27 10:38:44 +00002164
2165 /* Library flags */ /* Total library flags must be 16 bits */
2166 unsigned tasktype : 1; /* task is either explicit(1) or implicit (0) */
2167 unsigned task_serial : 1; /* this task is executed immediately (1) or deferred (0) */
2168 unsigned tasking_ser : 1; /* all tasks in team are either executed immediately (1) or may be deferred (0) */
2169 unsigned team_serial : 1; /* entire team is serial (1) [1 thread] or parallel (0) [>= 2 threads] */
2170 /* If either team_serial or tasking_ser is set, task team may be NULL */
2171 /* Task State Flags: */
2172 unsigned started : 1; /* 1==started, 0==not started */
2173 unsigned executing : 1; /* 1==executing, 0==not executing */
2174 unsigned complete : 1; /* 1==complete, 0==not complete */
2175 unsigned freed : 1; /* 1==freed, 0==allocateed */
2176 unsigned native : 1; /* 1==gcc-compiled task, 0==intel */
2177 unsigned reserved31 : 7; /* reserved for library use */
2178
2179} kmp_tasking_flags_t;
2180
2181
2182struct kmp_taskdata { /* aligned during dynamic allocation */
2183 kmp_int32 td_task_id; /* id, assigned by debugger */
2184 kmp_tasking_flags_t td_flags; /* task flags */
2185 kmp_team_t * td_team; /* team for this task */
2186 kmp_info_p * td_alloc_thread; /* thread that allocated data structures */
2187 /* Currently not used except for perhaps IDB */
2188 kmp_taskdata_t * td_parent; /* parent task */
2189 kmp_int32 td_level; /* task nesting level */
2190 ident_t * td_ident; /* task identifier */
2191 // Taskwait data.
2192 ident_t * td_taskwait_ident;
2193 kmp_uint32 td_taskwait_counter;
2194 kmp_int32 td_taskwait_thread; /* gtid + 1 of thread encountered taskwait */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002195 KMP_ALIGN_CACHE kmp_internal_control_t td_icvs; /* Internal control variables for the task */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002196 volatile kmp_uint32 td_allocated_child_tasks; /* Child tasks (+ current task) not yet deallocated */
2197 volatile kmp_uint32 td_incomplete_child_tasks; /* Child tasks not yet complete */
2198#if OMP_40_ENABLED
2199 kmp_taskgroup_t * td_taskgroup; // Each task keeps pointer to its current taskgroup
2200 kmp_dephash_t * td_dephash; // Dependencies for children tasks are tracked from here
2201 kmp_depnode_t * td_depnode; // Pointer to graph node if this task has dependencies
2202#endif
Andrey Churbanove5f44922015-04-29 16:22:07 +00002203#if OMPT_SUPPORT
2204 ompt_task_info_t ompt_task_info;
2205#endif
Jonathan Peyton134f90d2016-02-11 23:07:30 +00002206#if OMP_41_ENABLED
2207 kmp_task_team_t * td_task_team;
2208#endif
Jim Cownie181b4bb2013-12-23 17:28:57 +00002209#if KMP_HAVE_QUAD
Jim Cownie5e8470a2013-09-27 10:38:44 +00002210 _Quad td_dummy; // Align structure 16-byte size since allocated just before kmp_task_t
Jim Cownie181b4bb2013-12-23 17:28:57 +00002211#else
2212 kmp_uint32 td_dummy[2];
2213#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002214}; // struct kmp_taskdata
2215
2216// Make sure padding above worked
2217KMP_BUILD_ASSERT( sizeof(kmp_taskdata_t) % sizeof(void *) == 0 );
2218
2219// Data for task team but per thread
2220typedef struct kmp_base_thread_data {
2221 kmp_info_p * td_thr; // Pointer back to thread info
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002222 // Used only in __kmp_execute_tasks_template, maybe not avail until task is queued?
Jim Cownie5e8470a2013-09-27 10:38:44 +00002223 kmp_bootstrap_lock_t td_deque_lock; // Lock for accessing deque
2224 kmp_taskdata_t ** td_deque; // Deque of tasks encountered by td_thr, dynamically allocated
2225 kmp_uint32 td_deque_head; // Head of deque (will wrap)
2226 kmp_uint32 td_deque_tail; // Tail of deque (will wrap)
2227 kmp_int32 td_deque_ntasks; // Number of tasks in deque
2228 // GEH: shouldn't this be volatile since used in while-spin?
2229 kmp_int32 td_deque_last_stolen; // Thread number of last successful steal
2230#ifdef BUILD_TIED_TASK_STACK
2231 kmp_task_stack_t td_susp_tied_tasks; // Stack of suspended tied tasks for task scheduling constraint
2232#endif // BUILD_TIED_TASK_STACK
2233} kmp_base_thread_data_t;
2234
2235typedef union KMP_ALIGN_CACHE kmp_thread_data {
2236 kmp_base_thread_data_t td;
2237 double td_align; /* use worst case alignment */
2238 char td_pad[ KMP_PAD(kmp_base_thread_data_t, CACHE_LINE) ];
2239} kmp_thread_data_t;
2240
2241
2242// Data for task teams which are used when tasking is enabled for the team
2243typedef struct kmp_base_task_team {
2244 kmp_bootstrap_lock_t tt_threads_lock; /* Lock used to allocate per-thread part of task team */
2245 /* must be bootstrap lock since used at library shutdown*/
2246 kmp_task_team_t * tt_next; /* For linking the task team free list */
2247 kmp_thread_data_t * tt_threads_data; /* Array of per-thread structures for task team */
2248 /* Data survives task team deallocation */
2249 kmp_int32 tt_found_tasks; /* Have we found tasks and queued them while executing this team? */
2250 /* TRUE means tt_threads_data is set up and initialized */
2251 kmp_int32 tt_nproc; /* #threads in team */
2252 kmp_int32 tt_max_threads; /* number of entries allocated for threads_data array */
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00002253#if OMP_41_ENABLED
2254 kmp_int32 tt_found_proxy_tasks; /* Have we found proxy tasks since last barrier */
2255#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002256
2257 KMP_ALIGN_CACHE
2258 volatile kmp_uint32 tt_unfinished_threads; /* #threads still active */
2259
2260 KMP_ALIGN_CACHE
2261 volatile kmp_uint32 tt_active; /* is the team still actively executing tasks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002262} kmp_base_task_team_t;
2263
2264union KMP_ALIGN_CACHE kmp_task_team {
2265 kmp_base_task_team_t tt;
2266 double tt_align; /* use worst case alignment */
2267 char tt_pad[ KMP_PAD(kmp_base_task_team_t, CACHE_LINE) ];
2268};
2269
Jim Cownie5e8470a2013-09-27 10:38:44 +00002270#if ( USE_FAST_MEMORY == 3 ) || ( USE_FAST_MEMORY == 5 )
2271// Free lists keep same-size free memory slots for fast memory allocation routines
2272typedef struct kmp_free_list {
2273 void *th_free_list_self; // Self-allocated tasks free list
2274 void *th_free_list_sync; // Self-allocated tasks stolen/returned by other threads
2275 void *th_free_list_other; // Non-self free list (to be returned to owner's sync list)
2276} kmp_free_list_t;
2277#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002278#if KMP_NESTED_HOT_TEAMS
2279// Hot teams array keeps hot teams and their sizes for given thread.
2280// Hot teams are not put in teams pool, and they don't put threads in threads pool.
2281typedef struct kmp_hot_team_ptr {
2282 kmp_team_p *hot_team; // pointer to hot_team of given nesting level
2283 kmp_int32 hot_team_nth; // number of threads allocated for the hot_team
2284} kmp_hot_team_ptr_t;
2285#endif
2286#if OMP_40_ENABLED
2287typedef struct kmp_teams_size {
2288 kmp_int32 nteams; // number of teams in a league
2289 kmp_int32 nth; // number of threads in each team of the league
2290} kmp_teams_size_t;
2291#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002292
2293/* ------------------------------------------------------------------------ */
2294// OpenMP thread data structures
2295//
2296
2297typedef struct KMP_ALIGN_CACHE kmp_base_info {
2298/*
2299 * Start with the readonly data which is cache aligned and padded.
2300 * this is written before the thread starts working by the master.
2301 * (uber masters may update themselves later)
2302 * (usage does not consider serialized regions)
2303 */
2304 kmp_desc_t th_info;
2305 kmp_team_p *th_team; /* team we belong to */
2306 kmp_root_p *th_root; /* pointer to root of task hierarchy */
2307 kmp_info_p *th_next_pool; /* next available thread in the pool */
2308 kmp_disp_t *th_dispatch; /* thread's dispatch data */
2309 int th_in_pool; /* in thread pool (32 bits for TCR/TCW) */
2310
2311 /* The following are cached from the team info structure */
2312 /* TODO use these in more places as determined to be needed via profiling */
2313 int th_team_nproc; /* number of threads in a team */
2314 kmp_info_p *th_team_master; /* the team's master thread */
2315 int th_team_serialized; /* team is serialized */
2316#if OMP_40_ENABLED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002317 microtask_t th_teams_microtask; /* save entry address for teams construct */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002318 int th_teams_level; /* save initial level of teams construct */
2319 /* it is 0 on device but may be any on host */
2320#endif
2321
2322 /* The blocktime info is copied from the team struct to the thread sruct */
2323 /* at the start of a barrier, and the values stored in the team are used */
2324 /* at points in the code where the team struct is no longer guaranteed */
2325 /* to exist (from the POV of worker threads). */
2326 int th_team_bt_intervals;
2327 int th_team_bt_set;
2328
2329
Alp Toker98758b02014-03-02 04:12:06 +00002330#if KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00002331 kmp_affin_mask_t *th_affin_mask; /* thread's current affinity mask */
2332#endif
2333
Jim Cownie5e8470a2013-09-27 10:38:44 +00002334/*
2335 * The data set by the master at reinit, then R/W by the worker
2336 */
2337 KMP_ALIGN_CACHE int th_set_nproc; /* if > 0, then only use this request for the next fork */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002338#if KMP_NESTED_HOT_TEAMS
2339 kmp_hot_team_ptr_t *th_hot_teams; /* array of hot teams */
2340#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002341#if OMP_40_ENABLED
Jim Cownie5e8470a2013-09-27 10:38:44 +00002342 kmp_proc_bind_t th_set_proc_bind; /* if != proc_bind_default, use request for next fork */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002343 kmp_teams_size_t th_teams_size; /* number of teams/threads in teams construct */
Alp Toker98758b02014-03-02 04:12:06 +00002344# if KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00002345 int th_current_place; /* place currently bound to */
2346 int th_new_place; /* place to bind to in par reg */
2347 int th_first_place; /* first place in partition */
2348 int th_last_place; /* last place in partition */
2349# endif
2350#endif
2351#if USE_ITT_BUILD
Jim Cownie181b4bb2013-12-23 17:28:57 +00002352 kmp_uint64 th_bar_arrive_time; /* arrival to barrier timestamp */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002353 kmp_uint64 th_bar_min_time; /* minimum arrival time at the barrier */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002354 kmp_uint64 th_frame_time; /* frame timestamp */
2355 kmp_uint64 th_frame_time_serialized; /* frame timestamp in serialized parallel */
2356#endif /* USE_ITT_BUILD */
2357 kmp_local_t th_local;
2358 struct private_common *th_pri_head;
2359
2360/*
2361 * Now the data only used by the worker (after initial allocation)
2362 */
2363 /* TODO the first serial team should actually be stored in the info_t
2364 * structure. this will help reduce initial allocation overhead */
2365 KMP_ALIGN_CACHE kmp_team_p *th_serial_team; /*serialized team held in reserve*/
Andrey Churbanove5f44922015-04-29 16:22:07 +00002366
2367#if OMPT_SUPPORT
2368 ompt_thread_info_t ompt_thread_info;
2369#endif
2370
Jim Cownie5e8470a2013-09-27 10:38:44 +00002371/* The following are also read by the master during reinit */
2372 struct common_table *th_pri_common;
2373
2374 volatile kmp_uint32 th_spin_here; /* thread-local location for spinning */
2375 /* while awaiting queuing lock acquire */
2376
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002377 volatile void *th_sleep_loc; // this points at a kmp_flag<T>
Jim Cownie5e8470a2013-09-27 10:38:44 +00002378
Jim Cownie5e8470a2013-09-27 10:38:44 +00002379 ident_t *th_ident;
2380 unsigned th_x; // Random number generator data
2381 unsigned th_a; // Random number generator data
2382
Jim Cownie5e8470a2013-09-27 10:38:44 +00002383/*
2384 * Tasking-related data for the thread
2385 */
2386 kmp_task_team_t * th_task_team; // Task team struct
2387 kmp_taskdata_t * th_current_task; // Innermost Task being executed
2388 kmp_uint8 th_task_state; // alternating 0/1 for task team identification
Andrey Churbanov6d224db2015-02-10 18:37:43 +00002389 kmp_uint8 * th_task_state_memo_stack; // Stack holding memos of th_task_state at nested levels
2390 kmp_uint32 th_task_state_top; // Top element of th_task_state_memo_stack
2391 kmp_uint32 th_task_state_stack_sz; // Size of th_task_state_memo_stack
Jim Cownie5e8470a2013-09-27 10:38:44 +00002392
2393 /*
2394 * More stuff for keeping track of active/sleeping threads
2395 * (this part is written by the worker thread)
2396 */
2397 kmp_uint8 th_active_in_pool; // included in count of
2398 // #active threads in pool
2399 int th_active; // ! sleeping
2400 // 32 bits for TCR/TCW
2401
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002402 struct cons_header * th_cons; // used for consistency check
Jim Cownie5e8470a2013-09-27 10:38:44 +00002403
2404/*
2405 * Add the syncronizing data which is cache aligned and padded.
2406 */
2407 KMP_ALIGN_CACHE kmp_balign_t th_bar[ bs_last_barrier ];
2408
2409 KMP_ALIGN_CACHE volatile kmp_int32 th_next_waiting; /* gtid+1 of next thread on lock wait queue, 0 if none */
2410
2411#if ( USE_FAST_MEMORY == 3 ) || ( USE_FAST_MEMORY == 5 )
2412 #define NUM_LISTS 4
2413 kmp_free_list_t th_free_lists[NUM_LISTS]; // Free lists for fast memory allocation routines
2414#endif
2415
2416#if KMP_OS_WINDOWS
2417 kmp_win32_cond_t th_suspend_cv;
2418 kmp_win32_mutex_t th_suspend_mx;
2419 int th_suspend_init;
2420#endif
2421#if KMP_OS_UNIX
2422 kmp_cond_align_t th_suspend_cv;
2423 kmp_mutex_align_t th_suspend_mx;
2424 int th_suspend_init_count;
2425#endif
2426
2427#if USE_ITT_BUILD
2428 kmp_itt_mark_t th_itt_mark_single;
2429 // alignment ???
2430#endif /* USE_ITT_BUILD */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002431#if KMP_STATS_ENABLED
2432 kmp_stats_list* th_stats;
2433#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002434} kmp_base_info_t;
2435
2436typedef union KMP_ALIGN_CACHE kmp_info {
2437 double th_align; /* use worst case alignment */
2438 char th_pad[ KMP_PAD(kmp_base_info_t, CACHE_LINE) ];
2439 kmp_base_info_t th;
2440} kmp_info_t;
2441
2442/* ------------------------------------------------------------------------ */
2443// OpenMP thread team data structures
2444//
2445typedef struct kmp_base_data {
2446 volatile kmp_uint32 t_value;
2447} kmp_base_data_t;
2448
2449typedef union KMP_ALIGN_CACHE kmp_sleep_team {
2450 double dt_align; /* use worst case alignment */
2451 char dt_pad[ KMP_PAD(kmp_base_data_t, CACHE_LINE) ];
2452 kmp_base_data_t dt;
2453} kmp_sleep_team_t;
2454
2455typedef union KMP_ALIGN_CACHE kmp_ordered_team {
2456 double dt_align; /* use worst case alignment */
2457 char dt_pad[ KMP_PAD(kmp_base_data_t, CACHE_LINE) ];
2458 kmp_base_data_t dt;
2459} kmp_ordered_team_t;
2460
2461typedef int (*launch_t)( int gtid );
2462
2463/* Minimum number of ARGV entries to malloc if necessary */
2464#define KMP_MIN_MALLOC_ARGV_ENTRIES 100
2465
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002466// Set up how many argv pointers will fit in cache lines containing t_inline_argv. Historically, we
2467// have supported at least 96 bytes. Using a larger value for more space between the master write/worker
2468// read section and read/write by all section seems to buy more performance on EPCC PARALLEL.
2469#if KMP_ARCH_X86 || KMP_ARCH_X86_64
2470# define KMP_INLINE_ARGV_BYTES ( 4 * CACHE_LINE - ( ( 3 * KMP_PTR_SKIP + 2 * sizeof(int) + 2 * sizeof(kmp_int8) + sizeof(kmp_int16) + sizeof(kmp_uint32) ) % CACHE_LINE ) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00002471#else
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002472# define KMP_INLINE_ARGV_BYTES ( 2 * CACHE_LINE - ( ( 3 * KMP_PTR_SKIP + 2 * sizeof(int) ) % CACHE_LINE ) )
Jim Cownie5e8470a2013-09-27 10:38:44 +00002473#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002474#define KMP_INLINE_ARGV_ENTRIES (int)( KMP_INLINE_ARGV_BYTES / KMP_PTR_SKIP )
Jim Cownie5e8470a2013-09-27 10:38:44 +00002475
2476typedef struct KMP_ALIGN_CACHE kmp_base_team {
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002477 // Synchronization Data ---------------------------------------------------------------------------------
2478 KMP_ALIGN_CACHE kmp_ordered_team_t t_ordered;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002479 kmp_balign_team_t t_bar[ bs_last_barrier ];
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002480 volatile int t_construct; // count of single directive encountered by team
2481 kmp_lock_t t_single_lock; // team specific lock
Jim Cownie5e8470a2013-09-27 10:38:44 +00002482
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002483 // Master only -----------------------------------------------------------------------------------------
2484 KMP_ALIGN_CACHE int t_master_tid; // tid of master in parent team
2485 int t_master_this_cons; // "this_construct" single counter of master in parent team
2486 ident_t *t_ident; // if volatile, have to change too much other crud to volatile too
2487 kmp_team_p *t_parent; // parent team
2488 kmp_team_p *t_next_pool; // next free team in the team pool
2489 kmp_disp_t *t_dispatch; // thread's dispatch data
Andrey Churbanov6d224db2015-02-10 18:37:43 +00002490 kmp_task_team_t *t_task_team[2]; // Task team struct; switch between 2
Jim Cownie5e8470a2013-09-27 10:38:44 +00002491#if OMP_40_ENABLED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002492 kmp_proc_bind_t t_proc_bind; // bind type for par region
Jim Cownie5e8470a2013-09-27 10:38:44 +00002493#endif // OMP_40_ENABLED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002494#if USE_ITT_BUILD
2495 kmp_uint64 t_region_time; // region begin timestamp
2496#endif /* USE_ITT_BUILD */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002497
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002498 // Master write, workers read --------------------------------------------------------------------------
2499 KMP_ALIGN_CACHE void **t_argv;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002500 int t_argc;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002501 int t_nproc; // number of threads in team
Jim Cownie5e8470a2013-09-27 10:38:44 +00002502 microtask_t t_pkfn;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002503 launch_t t_invoke; // procedure to launch the microtask
Andrey Churbanove5f44922015-04-29 16:22:07 +00002504
2505#if OMPT_SUPPORT
2506 ompt_team_info_t ompt_team_info;
2507 ompt_lw_taskteam_t *ompt_serialized_team_info;
2508#endif
2509
Jim Cownie5e8470a2013-09-27 10:38:44 +00002510#if KMP_ARCH_X86 || KMP_ARCH_X86_64
2511 kmp_int8 t_fp_control_saved;
2512 kmp_int8 t_pad2b;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002513 kmp_int16 t_x87_fpu_control_word; // FP control regs
Jim Cownie5e8470a2013-09-27 10:38:44 +00002514 kmp_uint32 t_mxcsr;
2515#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
2516
Jim Cownie5e8470a2013-09-27 10:38:44 +00002517 void *t_inline_argv[ KMP_INLINE_ARGV_ENTRIES ];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002518
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002519 KMP_ALIGN_CACHE kmp_info_t **t_threads;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002520 int t_max_argc;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002521 int t_max_nproc; // maximum threads this team can handle (dynamicly expandable)
2522 int t_serialized; // levels deep of serialized teams
2523 dispatch_shared_info_t *t_disp_buffer; // buffers for dispatch system
Jim Cownie5e8470a2013-09-27 10:38:44 +00002524 int t_id; // team's id, assigned by debugger.
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002525 int t_level; // nested parallel level
2526 int t_active_level; // nested active parallel level
2527 kmp_r_sched_t t_sched; // run-time schedule for the team
Alp Toker98758b02014-03-02 04:12:06 +00002528#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002529 int t_first_place; // first & last place in parent thread's partition.
2530 int t_last_place; // Restore these values to master after par region.
Alp Toker98758b02014-03-02 04:12:06 +00002531#endif // OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002532 int t_size_changed; // team size was changed?: 0: no, 1: yes, -1: changed via omp_set_num_threads() call
Jim Cownie5e8470a2013-09-27 10:38:44 +00002533
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002534 // Read/write by workers as well -----------------------------------------------------------------------
Jim Cownie5e8470a2013-09-27 10:38:44 +00002535#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002536 // Using CACHE_LINE=64 reduces memory footprint, but causes a big perf regression of epcc 'parallel'
2537 // and 'barrier' on fxe256lin01. This extra padding serves to fix the performance of epcc 'parallel'
2538 // and 'barrier' when CACHE_LINE=64. TODO: investigate more and get rid if this padding.
Jim Cownie5e8470a2013-09-27 10:38:44 +00002539 char dummy_padding[1024];
2540#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002541 KMP_ALIGN_CACHE kmp_taskdata_t *t_implicit_task_taskdata; // Taskdata for the thread's implicit task
2542 kmp_internal_control_t *t_control_stack_top; // internal control stack for additional nested teams.
2543 // for SERIALIZED teams nested 2 or more levels deep
Jim Cownie181b4bb2013-12-23 17:28:57 +00002544#if OMP_40_ENABLED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002545 kmp_int32 t_cancel_request; // typed flag to store request state of cancellation
Jim Cownie181b4bb2013-12-23 17:28:57 +00002546#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002547 int t_master_active; // save on fork, restore on join
2548 kmp_taskq_t t_taskq; // this team's task queue
2549 void *t_copypriv_data; // team specific pointer to copyprivate data array
Jim Cownie5e8470a2013-09-27 10:38:44 +00002550 kmp_uint32 t_copyin_counter;
2551#if USE_ITT_BUILD
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002552 void *t_stack_id; // team specific stack stitching id (for ittnotify)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002553#endif /* USE_ITT_BUILD */
2554} kmp_base_team_t;
2555
2556union KMP_ALIGN_CACHE kmp_team {
2557 kmp_base_team_t t;
2558 double t_align; /* use worst case alignment */
2559 char t_pad[ KMP_PAD(kmp_base_team_t, CACHE_LINE) ];
2560};
2561
2562
2563typedef union KMP_ALIGN_CACHE kmp_time_global {
2564 double dt_align; /* use worst case alignment */
2565 char dt_pad[ KMP_PAD(kmp_base_data_t, CACHE_LINE) ];
2566 kmp_base_data_t dt;
2567} kmp_time_global_t;
2568
2569typedef struct kmp_base_global {
2570 /* cache-aligned */
2571 kmp_time_global_t g_time;
2572
2573 /* non cache-aligned */
2574 volatile int g_abort;
2575 volatile int g_done;
2576
2577 int g_dynamic;
2578 enum dynamic_mode g_dynamic_mode;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002579} kmp_base_global_t;
2580
2581typedef union KMP_ALIGN_CACHE kmp_global {
2582 kmp_base_global_t g;
2583 double g_align; /* use worst case alignment */
2584 char g_pad[ KMP_PAD(kmp_base_global_t, CACHE_LINE) ];
2585} kmp_global_t;
2586
2587
2588typedef struct kmp_base_root {
2589 // TODO: GEH - combine r_active with r_in_parallel then r_active == (r_in_parallel>= 0)
2590 // TODO: GEH - then replace r_active with t_active_levels if we can to reduce the synch
2591 // overhead or keeping r_active
2592
2593 volatile int r_active; /* TRUE if some region in a nest has > 1 thread */
2594 // GEH: This is misnamed, should be r_in_parallel
2595 volatile int r_nested; // TODO: GEH - This is unused, just remove it entirely.
2596 int r_in_parallel; /* keeps a count of active parallel regions per root */
2597 // GEH: This is misnamed, should be r_active_levels
2598 kmp_team_t *r_root_team;
2599 kmp_team_t *r_hot_team;
2600 kmp_info_t *r_uber_thread;
2601 kmp_lock_t r_begin_lock;
2602 volatile int r_begin;
2603 int r_blocktime; /* blocktime for this root and descendants */
2604} kmp_base_root_t;
2605
2606typedef union KMP_ALIGN_CACHE kmp_root {
2607 kmp_base_root_t r;
2608 double r_align; /* use worst case alignment */
2609 char r_pad[ KMP_PAD(kmp_base_root_t, CACHE_LINE) ];
2610} kmp_root_t;
2611
2612struct fortran_inx_info {
2613 kmp_int32 data;
2614};
2615
2616/* ------------------------------------------------------------------------ */
2617
2618/* ------------------------------------------------------------------------ */
2619/* ------------------------------------------------------------------------ */
2620
2621extern int __kmp_settings;
2622extern int __kmp_duplicate_library_ok;
2623#if USE_ITT_BUILD
2624extern int __kmp_forkjoin_frames;
2625extern int __kmp_forkjoin_frames_mode;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002626#endif
2627extern PACKED_REDUCTION_METHOD_T __kmp_force_reduction_method;
2628extern int __kmp_determ_red;
2629
2630#ifdef KMP_DEBUG
2631extern int kmp_a_debug;
2632extern int kmp_b_debug;
2633extern int kmp_c_debug;
2634extern int kmp_d_debug;
2635extern int kmp_e_debug;
2636extern int kmp_f_debug;
2637#endif /* KMP_DEBUG */
2638
2639/* For debug information logging using rotating buffer */
2640#define KMP_DEBUG_BUF_LINES_INIT 512
2641#define KMP_DEBUG_BUF_LINES_MIN 1
2642
2643#define KMP_DEBUG_BUF_CHARS_INIT 128
2644#define KMP_DEBUG_BUF_CHARS_MIN 2
2645
2646extern int __kmp_debug_buf; /* TRUE means use buffer, FALSE means print to stderr */
2647extern int __kmp_debug_buf_lines; /* How many lines of debug stored in buffer */
2648extern int __kmp_debug_buf_chars; /* How many characters allowed per line in buffer */
2649extern int __kmp_debug_buf_atomic; /* TRUE means use atomic update of buffer entry pointer */
2650
2651extern char *__kmp_debug_buffer; /* Debug buffer itself */
2652extern int __kmp_debug_count; /* Counter for number of lines printed in buffer so far */
2653extern int __kmp_debug_buf_warn_chars; /* Keep track of char increase recommended in warnings */
2654/* end rotating debug buffer */
2655
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002656#ifdef KMP_DEBUG
Jim Cownie5e8470a2013-09-27 10:38:44 +00002657extern int __kmp_par_range; /* +1 => only go par for constructs in range */
2658
2659#define KMP_PAR_RANGE_ROUTINE_LEN 1024
2660extern char __kmp_par_range_routine[KMP_PAR_RANGE_ROUTINE_LEN];
2661#define KMP_PAR_RANGE_FILENAME_LEN 1024
2662extern char __kmp_par_range_filename[KMP_PAR_RANGE_FILENAME_LEN];
2663extern int __kmp_par_range_lb;
2664extern int __kmp_par_range_ub;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002665#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002666
2667/* For printing out dynamic storage map for threads and teams */
2668extern int __kmp_storage_map; /* True means print storage map for threads and teams */
2669extern int __kmp_storage_map_verbose; /* True means storage map includes placement info */
2670extern int __kmp_storage_map_verbose_specified;
2671
2672extern kmp_cpuinfo_t __kmp_cpuinfo;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002673
2674extern volatile int __kmp_init_serial;
2675extern volatile int __kmp_init_gtid;
2676extern volatile int __kmp_init_common;
2677extern volatile int __kmp_init_middle;
2678extern volatile int __kmp_init_parallel;
2679extern volatile int __kmp_init_monitor;
2680extern volatile int __kmp_init_user_locks;
2681extern int __kmp_init_counter;
2682extern int __kmp_root_counter;
2683extern int __kmp_version;
2684
2685/* list of address of allocated caches for commons */
2686extern kmp_cached_addr_t *__kmp_threadpriv_cache_list;
2687
2688/* Barrier algorithm types and options */
2689extern kmp_uint32 __kmp_barrier_gather_bb_dflt;
2690extern kmp_uint32 __kmp_barrier_release_bb_dflt;
2691extern kmp_bar_pat_e __kmp_barrier_gather_pat_dflt;
2692extern kmp_bar_pat_e __kmp_barrier_release_pat_dflt;
2693extern kmp_uint32 __kmp_barrier_gather_branch_bits [ bs_last_barrier ];
2694extern kmp_uint32 __kmp_barrier_release_branch_bits [ bs_last_barrier ];
2695extern kmp_bar_pat_e __kmp_barrier_gather_pattern [ bs_last_barrier ];
2696extern kmp_bar_pat_e __kmp_barrier_release_pattern [ bs_last_barrier ];
2697extern char const *__kmp_barrier_branch_bit_env_name [ bs_last_barrier ];
2698extern char const *__kmp_barrier_pattern_env_name [ bs_last_barrier ];
2699extern char const *__kmp_barrier_type_name [ bs_last_barrier ];
2700extern char const *__kmp_barrier_pattern_name [ bp_last_bar ];
2701
2702/* Global Locks */
2703extern kmp_bootstrap_lock_t __kmp_initz_lock; /* control initialization */
Jonathan Peyton021cad02015-06-02 22:21:37 +00002704extern kmp_bootstrap_lock_t __kmp_forkjoin_lock; /* control fork/join access */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002705extern kmp_bootstrap_lock_t __kmp_exit_lock; /* exit() is not always thread-safe */
2706extern kmp_bootstrap_lock_t __kmp_monitor_lock; /* control monitor thread creation */
2707extern kmp_bootstrap_lock_t __kmp_tp_cached_lock; /* used for the hack to allow threadprivate cache and __kmp_threads expansion to co-exist */
2708
2709extern kmp_lock_t __kmp_global_lock; /* control OS/global access */
2710extern kmp_queuing_lock_t __kmp_dispatch_lock; /* control dispatch access */
2711extern kmp_lock_t __kmp_debug_lock; /* control I/O access for KMP_DEBUG */
2712
2713/* used for yielding spin-waits */
2714extern unsigned int __kmp_init_wait; /* initial number of spin-tests */
2715extern unsigned int __kmp_next_wait; /* susequent number of spin-tests */
2716
2717extern enum library_type __kmp_library;
2718
2719extern enum sched_type __kmp_sched; /* default runtime scheduling */
2720extern enum sched_type __kmp_static; /* default static scheduling method */
2721extern enum sched_type __kmp_guided; /* default guided scheduling method */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002722extern enum sched_type __kmp_auto; /* default auto scheduling method */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002723extern int __kmp_chunk; /* default runtime chunk size */
2724
2725extern size_t __kmp_stksize; /* stack size per thread */
2726extern size_t __kmp_monitor_stksize;/* stack size for monitor thread */
2727extern size_t __kmp_stkoffset; /* stack offset per thread */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002728extern int __kmp_stkpadding; /* Should we pad root thread(s) stack */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002729
2730extern size_t __kmp_malloc_pool_incr; /* incremental size of pool for kmp_malloc() */
2731extern int __kmp_env_chunk; /* was KMP_CHUNK specified? */
2732extern int __kmp_env_stksize; /* was KMP_STACKSIZE specified? */
2733extern int __kmp_env_omp_stksize;/* was OMP_STACKSIZE specified? */
2734extern int __kmp_env_all_threads; /* was KMP_ALL_THREADS or KMP_MAX_THREADS specified? */
2735extern int __kmp_env_omp_all_threads;/* was OMP_THREAD_LIMIT specified? */
2736extern int __kmp_env_blocktime; /* was KMP_BLOCKTIME specified? */
2737extern int __kmp_env_checks; /* was KMP_CHECKS specified? */
2738extern int __kmp_env_consistency_check; /* was KMP_CONSISTENCY_CHECK specified? */
2739extern int __kmp_generate_warnings; /* should we issue warnings? */
2740extern int __kmp_reserve_warn; /* have we issued reserve_threads warning? */
2741
2742#ifdef DEBUG_SUSPEND
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002743extern int __kmp_suspend_count; /* count inside __kmp_suspend_template() */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002744#endif
2745
2746extern kmp_uint32 __kmp_yield_init;
2747extern kmp_uint32 __kmp_yield_next;
2748extern kmp_uint32 __kmp_yielding_on;
2749extern kmp_uint32 __kmp_yield_cycle;
2750extern kmp_int32 __kmp_yield_on_count;
2751extern kmp_int32 __kmp_yield_off_count;
2752
Jim Cownie5e8470a2013-09-27 10:38:44 +00002753/* ------------------------------------------------------------------------- */
2754extern int __kmp_allThreadsSpecified;
2755
2756extern size_t __kmp_align_alloc;
2757/* following data protected by initialization routines */
2758extern int __kmp_xproc; /* number of processors in the system */
2759extern int __kmp_avail_proc; /* number of processors available to the process */
2760extern size_t __kmp_sys_min_stksize; /* system-defined minimum stack size */
2761extern int __kmp_sys_max_nth; /* system-imposed maximum number of threads */
2762extern int __kmp_max_nth; /* maximum total number of concurrently-existing threads */
2763extern int __kmp_threads_capacity; /* capacity of the arrays __kmp_threads and __kmp_root */
2764extern int __kmp_dflt_team_nth; /* default number of threads in a parallel region a la OMP_NUM_THREADS */
2765extern int __kmp_dflt_team_nth_ub; /* upper bound on "" determined at serial initialization */
2766extern int __kmp_tp_capacity; /* capacity of __kmp_threads if threadprivate is used (fixed) */
2767extern int __kmp_tp_cached; /* whether threadprivate cache has been created (__kmpc_threadprivate_cached()) */
2768extern int __kmp_dflt_nested; /* nested parallelism enabled by default a la OMP_NESTED */
2769extern int __kmp_dflt_blocktime; /* number of milliseconds to wait before blocking (env setting) */
2770extern int __kmp_monitor_wakeups;/* number of times monitor wakes up per second */
2771extern int __kmp_bt_intervals; /* number of monitor timestamp intervals before blocking */
2772#ifdef KMP_ADJUST_BLOCKTIME
2773extern int __kmp_zero_bt; /* whether blocktime has been forced to zero */
2774#endif /* KMP_ADJUST_BLOCKTIME */
Andrey Churbanovf696c822015-01-27 16:55:43 +00002775#ifdef KMP_DFLT_NTH_CORES
Andrey Churbanov5cd50e32015-01-29 17:14:58 +00002776extern int __kmp_ncores; /* Total number of cores for threads placement */
Andrey Churbanovf696c822015-01-27 16:55:43 +00002777#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002778extern int __kmp_abort_delay; /* Number of millisecs to delay on abort for VTune */
2779
2780extern int __kmp_need_register_atfork_specified;
2781extern int __kmp_need_register_atfork;/* At initialization, call pthread_atfork to install fork handler */
2782extern int __kmp_gtid_mode; /* Method of getting gtid, values:
2783 0 - not set, will be set at runtime
2784 1 - using stack search
2785 2 - dynamic TLS (pthread_getspecific(Linux* OS/OS X*) or TlsGetValue(Windows* OS))
2786 3 - static TLS (__declspec(thread) __kmp_gtid), Linux* OS .so only.
2787 */
2788extern int __kmp_adjust_gtid_mode; /* If true, adjust method based on #threads */
2789#ifdef KMP_TDATA_GTID
2790#if KMP_OS_WINDOWS
2791extern __declspec(thread) int __kmp_gtid; /* This thread's gtid, if __kmp_gtid_mode == 3 */
2792#else
2793extern __thread int __kmp_gtid;
2794#endif /* KMP_OS_WINDOWS - workaround because Intel(R) Many Integrated Core compiler 20110316 doesn't accept __declspec */
2795#endif
2796extern int __kmp_tls_gtid_min; /* #threads below which use sp search for gtid */
2797extern int __kmp_foreign_tp; /* If true, separate TP var for each foreign thread */
2798#if KMP_ARCH_X86 || KMP_ARCH_X86_64
2799extern int __kmp_inherit_fp_control; /* copy fp creg(s) parent->workers at fork */
2800extern kmp_int16 __kmp_init_x87_fpu_control_word; /* init thread's FP control reg */
2801extern kmp_uint32 __kmp_init_mxcsr; /* init thread's mxscr */
2802#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
2803
Jim Cownie5e8470a2013-09-27 10:38:44 +00002804extern int __kmp_dflt_max_active_levels; /* max_active_levels for nested parallelism enabled by default a la OMP_MAX_ACTIVE_LEVELS */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002805#if KMP_NESTED_HOT_TEAMS
2806extern int __kmp_hot_teams_mode;
2807extern int __kmp_hot_teams_max_level;
2808#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002809
2810# if KMP_OS_LINUX
2811extern enum clock_function_type __kmp_clock_function;
2812extern int __kmp_clock_function_param;
2813# endif /* KMP_OS_LINUX */
2814
Andrey Churbanov613edeb2015-02-20 18:14:43 +00002815#if KMP_ARCH_X86_64 && (KMP_OS_LINUX || KMP_OS_WINDOWS)
2816extern enum mic_type __kmp_mic_type;
2817#endif
2818
Jim Cownie5e8470a2013-09-27 10:38:44 +00002819# ifdef USE_LOAD_BALANCE
2820extern double __kmp_load_balance_interval; /* Interval for the load balance algorithm */
2821# endif /* USE_LOAD_BALANCE */
2822
2823// OpenMP 3.1 - Nested num threads array
Jim Cownie181b4bb2013-12-23 17:28:57 +00002824typedef struct kmp_nested_nthreads_t {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002825 int * nth;
2826 int size;
2827 int used;
Jim Cownie181b4bb2013-12-23 17:28:57 +00002828} kmp_nested_nthreads_t;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002829
Jim Cownie181b4bb2013-12-23 17:28:57 +00002830extern kmp_nested_nthreads_t __kmp_nested_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002831
2832#if KMP_USE_ADAPTIVE_LOCKS
2833
2834// Parameters for the speculative lock backoff system.
2835struct kmp_adaptive_backoff_params_t {
2836 // Number of soft retries before it counts as a hard retry.
2837 kmp_uint32 max_soft_retries;
2838 // Badness is a bit mask : 0,1,3,7,15,... on each hard failure we move one to the right
2839 kmp_uint32 max_badness;
2840};
2841
2842extern kmp_adaptive_backoff_params_t __kmp_adaptive_backoff_params;
2843
2844#if KMP_DEBUG_ADAPTIVE_LOCKS
2845extern char * __kmp_speculative_statsfile;
2846#endif
2847
2848#endif // KMP_USE_ADAPTIVE_LOCKS
2849
2850#if OMP_40_ENABLED
2851extern int __kmp_display_env; /* TRUE or FALSE */
2852extern int __kmp_display_env_verbose; /* TRUE if OMP_DISPLAY_ENV=VERBOSE */
Jim Cownie181b4bb2013-12-23 17:28:57 +00002853extern int __kmp_omp_cancellation; /* TRUE or FALSE */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002854#endif
2855
2856/* ------------------------------------------------------------------------- */
2857
2858/* --------------------------------------------------------------------------- */
2859/* the following are protected by the fork/join lock */
2860/* write: lock read: anytime */
2861extern kmp_info_t **__kmp_threads; /* Descriptors for the threads */
2862/* read/write: lock */
2863extern volatile kmp_team_t * __kmp_team_pool;
2864extern volatile kmp_info_t * __kmp_thread_pool;
2865
2866/* total number of threads reachable from some root thread including all root threads*/
2867extern volatile int __kmp_nth;
2868/* total number of threads reachable from some root thread including all root threads,
2869 and those in the thread pool */
2870extern volatile int __kmp_all_nth;
2871extern int __kmp_thread_pool_nth;
2872extern volatile int __kmp_thread_pool_active_nth;
2873
2874extern kmp_root_t **__kmp_root; /* root of thread hierarchy */
2875/* end data protected by fork/join lock */
2876/* --------------------------------------------------------------------------- */
2877
2878extern kmp_global_t __kmp_global; /* global status */
2879
2880extern kmp_info_t __kmp_monitor;
2881extern volatile kmp_uint32 __kmp_team_counter; // Used by Debugging Support Library.
2882extern volatile kmp_uint32 __kmp_task_counter; // Used by Debugging Support Library.
2883
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00002884#if USE_DEBUGGER
2885
2886#define _KMP_GEN_ID( counter ) \
2887 ( \
2888 __kmp_debugging \
2889 ? \
2890 KMP_TEST_THEN_INC32( (volatile kmp_int32 *) & counter ) + 1 \
2891 : \
2892 ~ 0 \
2893 )
2894#else
Jim Cownie5e8470a2013-09-27 10:38:44 +00002895#define _KMP_GEN_ID( counter ) \
2896 ( \
2897 ~ 0 \
2898 )
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00002899#endif /* USE_DEBUGGER */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002900
2901#define KMP_GEN_TASK_ID() _KMP_GEN_ID( __kmp_task_counter )
2902#define KMP_GEN_TEAM_ID() _KMP_GEN_ID( __kmp_team_counter )
2903
2904/* ------------------------------------------------------------------------ */
2905/* ------------------------------------------------------------------------ */
2906
2907extern void __kmp_print_storage_map_gtid( int gtid, void *p1, void* p2, size_t size, char const *format, ... );
2908
2909extern void __kmp_serial_initialize( void );
2910extern void __kmp_middle_initialize( void );
2911extern void __kmp_parallel_initialize( void );
2912
2913extern void __kmp_internal_begin( void );
2914extern void __kmp_internal_end_library( int gtid );
2915extern void __kmp_internal_end_thread( int gtid );
2916extern void __kmp_internal_end_atexit( void );
2917extern void __kmp_internal_end_fini( void );
2918extern void __kmp_internal_end_dtor( void );
2919extern void __kmp_internal_end_dest( void* );
2920
2921extern int __kmp_register_root( int initial_thread );
2922extern void __kmp_unregister_root( int gtid );
2923
2924extern int __kmp_ignore_mppbeg( void );
2925extern int __kmp_ignore_mppend( void );
2926
2927extern int __kmp_enter_single( int gtid, ident_t *id_ref, int push_ws );
2928extern void __kmp_exit_single( int gtid );
2929
2930extern void __kmp_parallel_deo( int *gtid_ref, int *cid_ref, ident_t *loc_ref );
2931extern void __kmp_parallel_dxo( int *gtid_ref, int *cid_ref, ident_t *loc_ref );
2932
Jim Cownie5e8470a2013-09-27 10:38:44 +00002933#ifdef USE_LOAD_BALANCE
2934extern int __kmp_get_load_balance( int );
2935#endif
2936
2937#ifdef BUILD_TV
2938extern void __kmp_tv_threadprivate_store( kmp_info_t *th, void *global_addr, void *thread_addr );
2939#endif
2940
2941extern int __kmp_get_global_thread_id( void );
2942extern int __kmp_get_global_thread_id_reg( void );
2943extern void __kmp_exit_thread( int exit_status );
2944extern void __kmp_abort( char const * format, ... );
2945extern void __kmp_abort_thread( void );
2946extern void __kmp_abort_process( void );
2947extern void __kmp_warn( char const * format, ... );
2948
2949extern void __kmp_set_num_threads( int new_nth, int gtid );
2950
2951// Returns current thread (pointer to kmp_info_t). Current thread *must* be registered.
Jim Cownie181b4bb2013-12-23 17:28:57 +00002952static inline kmp_info_t * __kmp_entry_thread()
Jim Cownie5e8470a2013-09-27 10:38:44 +00002953{
2954 int gtid = __kmp_entry_gtid();
2955
2956 return __kmp_threads[gtid];
2957}
2958
Jim Cownie5e8470a2013-09-27 10:38:44 +00002959extern void __kmp_set_max_active_levels( int gtid, int new_max_active_levels );
2960extern int __kmp_get_max_active_levels( int gtid );
2961extern int __kmp_get_ancestor_thread_num( int gtid, int level );
2962extern int __kmp_get_team_size( int gtid, int level );
2963extern void __kmp_set_schedule( int gtid, kmp_sched_t new_sched, int chunk );
2964extern void __kmp_get_schedule( int gtid, kmp_sched_t * sched, int * chunk );
2965
Jim Cownie5e8470a2013-09-27 10:38:44 +00002966extern unsigned short __kmp_get_random( kmp_info_t * thread );
2967extern void __kmp_init_random( kmp_info_t * thread );
2968
2969extern kmp_r_sched_t __kmp_get_schedule_global( void );
2970extern void __kmp_adjust_num_threads( int new_nproc );
2971
2972extern void * ___kmp_allocate( size_t size KMP_SRC_LOC_DECL );
2973extern void * ___kmp_page_allocate( size_t size KMP_SRC_LOC_DECL );
2974extern void ___kmp_free( void * ptr KMP_SRC_LOC_DECL );
2975#define __kmp_allocate( size ) ___kmp_allocate( (size) KMP_SRC_LOC_CURR )
2976#define __kmp_page_allocate( size ) ___kmp_page_allocate( (size) KMP_SRC_LOC_CURR )
2977#define __kmp_free( ptr ) ___kmp_free( (ptr) KMP_SRC_LOC_CURR )
2978
2979#if USE_FAST_MEMORY
2980extern void * ___kmp_fast_allocate( kmp_info_t *this_thr, size_t size KMP_SRC_LOC_DECL );
2981extern void ___kmp_fast_free( kmp_info_t *this_thr, void *ptr KMP_SRC_LOC_DECL );
2982extern void __kmp_free_fast_memory( kmp_info_t *this_thr );
2983extern void __kmp_initialize_fast_memory( kmp_info_t *this_thr );
2984#define __kmp_fast_allocate( this_thr, size ) ___kmp_fast_allocate( (this_thr), (size) KMP_SRC_LOC_CURR )
2985#define __kmp_fast_free( this_thr, ptr ) ___kmp_fast_free( (this_thr), (ptr) KMP_SRC_LOC_CURR )
2986#endif
2987
2988extern void * ___kmp_thread_malloc( kmp_info_t *th, size_t size KMP_SRC_LOC_DECL );
2989extern void * ___kmp_thread_calloc( kmp_info_t *th, size_t nelem, size_t elsize KMP_SRC_LOC_DECL );
2990extern void * ___kmp_thread_realloc( kmp_info_t *th, void *ptr, size_t size KMP_SRC_LOC_DECL );
2991extern void ___kmp_thread_free( kmp_info_t *th, void *ptr KMP_SRC_LOC_DECL );
2992#define __kmp_thread_malloc( th, size ) ___kmp_thread_malloc( (th), (size) KMP_SRC_LOC_CURR )
2993#define __kmp_thread_calloc( th, nelem, elsize ) ___kmp_thread_calloc( (th), (nelem), (elsize) KMP_SRC_LOC_CURR )
2994#define __kmp_thread_realloc( th, ptr, size ) ___kmp_thread_realloc( (th), (ptr), (size) KMP_SRC_LOC_CURR )
2995#define __kmp_thread_free( th, ptr ) ___kmp_thread_free( (th), (ptr) KMP_SRC_LOC_CURR )
2996
2997#define KMP_INTERNAL_MALLOC(sz) malloc(sz)
2998#define KMP_INTERNAL_FREE(p) free(p)
2999#define KMP_INTERNAL_REALLOC(p,sz) realloc((p),(sz))
3000#define KMP_INTERNAL_CALLOC(n,sz) calloc((n),(sz))
3001
3002extern void __kmp_push_num_threads( ident_t *loc, int gtid, int num_threads );
3003
3004#if OMP_40_ENABLED
3005extern void __kmp_push_proc_bind( ident_t *loc, int gtid, kmp_proc_bind_t proc_bind );
3006extern void __kmp_push_num_teams( ident_t *loc, int gtid, int num_teams, int num_threads );
3007#endif
3008
3009extern void __kmp_yield( int cond );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003010
3011extern void __kmpc_dispatch_init_4( ident_t *loc, kmp_int32 gtid,
3012 enum sched_type schedule, kmp_int32 lb, kmp_int32 ub, kmp_int32 st,
3013 kmp_int32 chunk );
3014extern void __kmpc_dispatch_init_4u( ident_t *loc, kmp_int32 gtid,
3015 enum sched_type schedule, kmp_uint32 lb, kmp_uint32 ub, kmp_int32 st,
3016 kmp_int32 chunk );
3017extern void __kmpc_dispatch_init_8( ident_t *loc, kmp_int32 gtid,
3018 enum sched_type schedule, kmp_int64 lb, kmp_int64 ub, kmp_int64 st,
3019 kmp_int64 chunk );
3020extern void __kmpc_dispatch_init_8u( ident_t *loc, kmp_int32 gtid,
3021 enum sched_type schedule, kmp_uint64 lb, kmp_uint64 ub, kmp_int64 st,
3022 kmp_int64 chunk );
3023
3024extern int __kmpc_dispatch_next_4( ident_t *loc, kmp_int32 gtid,
3025 kmp_int32 *p_last, kmp_int32 *p_lb, kmp_int32 *p_ub, kmp_int32 *p_st );
3026extern int __kmpc_dispatch_next_4u( ident_t *loc, kmp_int32 gtid,
3027 kmp_int32 *p_last, kmp_uint32 *p_lb, kmp_uint32 *p_ub, kmp_int32 *p_st );
3028extern int __kmpc_dispatch_next_8( ident_t *loc, kmp_int32 gtid,
3029 kmp_int32 *p_last, kmp_int64 *p_lb, kmp_int64 *p_ub, kmp_int64 *p_st );
3030extern int __kmpc_dispatch_next_8u( ident_t *loc, kmp_int32 gtid,
3031 kmp_int32 *p_last, kmp_uint64 *p_lb, kmp_uint64 *p_ub, kmp_int64 *p_st );
3032
3033extern void __kmpc_dispatch_fini_4( ident_t *loc, kmp_int32 gtid );
3034extern void __kmpc_dispatch_fini_8( ident_t *loc, kmp_int32 gtid );
3035extern void __kmpc_dispatch_fini_4u( ident_t *loc, kmp_int32 gtid );
3036extern void __kmpc_dispatch_fini_8u( ident_t *loc, kmp_int32 gtid );
3037
3038
3039#ifdef KMP_GOMP_COMPAT
3040
3041extern void __kmp_aux_dispatch_init_4( ident_t *loc, kmp_int32 gtid,
3042 enum sched_type schedule, kmp_int32 lb, kmp_int32 ub, kmp_int32 st,
3043 kmp_int32 chunk, int push_ws );
3044extern void __kmp_aux_dispatch_init_4u( ident_t *loc, kmp_int32 gtid,
3045 enum sched_type schedule, kmp_uint32 lb, kmp_uint32 ub, kmp_int32 st,
3046 kmp_int32 chunk, int push_ws );
3047extern void __kmp_aux_dispatch_init_8( ident_t *loc, kmp_int32 gtid,
3048 enum sched_type schedule, kmp_int64 lb, kmp_int64 ub, kmp_int64 st,
3049 kmp_int64 chunk, int push_ws );
3050extern void __kmp_aux_dispatch_init_8u( ident_t *loc, kmp_int32 gtid,
3051 enum sched_type schedule, kmp_uint64 lb, kmp_uint64 ub, kmp_int64 st,
3052 kmp_int64 chunk, int push_ws );
3053extern void __kmp_aux_dispatch_fini_chunk_4( ident_t *loc, kmp_int32 gtid );
3054extern void __kmp_aux_dispatch_fini_chunk_8( ident_t *loc, kmp_int32 gtid );
3055extern void __kmp_aux_dispatch_fini_chunk_4u( ident_t *loc, kmp_int32 gtid );
3056extern void __kmp_aux_dispatch_fini_chunk_8u( ident_t *loc, kmp_int32 gtid );
3057
3058#endif /* KMP_GOMP_COMPAT */
3059
3060
3061extern kmp_uint32 __kmp_eq_4( kmp_uint32 value, kmp_uint32 checker );
3062extern kmp_uint32 __kmp_neq_4( kmp_uint32 value, kmp_uint32 checker );
3063extern kmp_uint32 __kmp_lt_4( kmp_uint32 value, kmp_uint32 checker );
3064extern kmp_uint32 __kmp_ge_4( kmp_uint32 value, kmp_uint32 checker );
3065extern kmp_uint32 __kmp_le_4( kmp_uint32 value, kmp_uint32 checker );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003066extern kmp_uint32 __kmp_wait_yield_4( kmp_uint32 volatile * spinner, kmp_uint32 checker, kmp_uint32 (*pred) (kmp_uint32, kmp_uint32), void * obj );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003067
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003068class kmp_flag_32;
3069class kmp_flag_64;
3070class kmp_flag_oncore;
3071extern void __kmp_wait_32(kmp_info_t *this_thr, kmp_flag_32 *flag, int final_spin
Jim Cownie5e8470a2013-09-27 10:38:44 +00003072#if USE_ITT_BUILD
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003073 , void * itt_sync_obj
3074#endif
3075 );
3076extern void __kmp_release_32(kmp_flag_32 *flag);
3077extern void __kmp_wait_64(kmp_info_t *this_thr, kmp_flag_64 *flag, int final_spin
3078#if USE_ITT_BUILD
3079 , void * itt_sync_obj
3080#endif
3081 );
3082extern void __kmp_release_64(kmp_flag_64 *flag);
3083extern void __kmp_wait_oncore(kmp_info_t *this_thr, kmp_flag_oncore *flag, int final_spin
3084#if USE_ITT_BUILD
3085 , void * itt_sync_obj
3086#endif
3087 );
3088extern void __kmp_release_oncore(kmp_flag_oncore *flag);
3089
Jim Cownie5e8470a2013-09-27 10:38:44 +00003090extern void __kmp_infinite_loop( void );
3091
3092extern void __kmp_cleanup( void );
3093
3094#if KMP_HANDLE_SIGNALS
3095 extern int __kmp_handle_signals;
3096 extern void __kmp_install_signals( int parallel_init );
3097 extern void __kmp_remove_signals( void );
3098#endif
3099
3100extern void __kmp_clear_system_time( void );
3101extern void __kmp_read_system_time( double *delta );
3102
3103extern void __kmp_check_stack_overlap( kmp_info_t *thr );
3104
3105extern void __kmp_expand_host_name( char *buffer, size_t size );
3106extern void __kmp_expand_file_name( char *result, size_t rlen, char *pattern );
3107
3108#if KMP_OS_WINDOWS
3109extern void __kmp_initialize_system_tick( void ); /* Initialize timer tick value */
3110#endif
3111
3112extern void __kmp_runtime_initialize( void ); /* machine specific initialization */
3113extern void __kmp_runtime_destroy( void );
3114
Alp Toker763b9392014-02-28 09:42:41 +00003115#if KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00003116extern char *__kmp_affinity_print_mask(char *buf, int buf_len, kmp_affin_mask_t *mask);
3117extern void __kmp_affinity_initialize(void);
3118extern void __kmp_affinity_uninitialize(void);
3119extern void __kmp_affinity_set_init_mask(int gtid, int isa_root); /* set affinity according to KMP_AFFINITY */
3120#if OMP_40_ENABLED
3121extern void __kmp_affinity_set_place(int gtid);
3122#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003123extern void __kmp_affinity_determine_capable( const char *env_var );
3124extern int __kmp_aux_set_affinity(void **mask);
3125extern int __kmp_aux_get_affinity(void **mask);
3126extern int __kmp_aux_set_affinity_mask_proc(int proc, void **mask);
3127extern int __kmp_aux_unset_affinity_mask_proc(int proc, void **mask);
3128extern int __kmp_aux_get_affinity_mask_proc(int proc, void **mask);
3129extern void __kmp_balanced_affinity( int tid, int team_size );
Alp Toker763b9392014-02-28 09:42:41 +00003130#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00003131
Jonathan Peyton17078362015-09-10 19:22:07 +00003132extern void __kmp_cleanup_hierarchy();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003133extern void __kmp_get_hierarchy(kmp_uint32 nproc, kmp_bstate_t *thr_bar);
3134
Andrey Churbanovcbda8682015-01-13 14:43:35 +00003135#if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
Jim Cownie5e8470a2013-09-27 10:38:44 +00003136
3137extern int __kmp_futex_determine_capable( void );
3138
Andrey Churbanovcbda8682015-01-13 14:43:35 +00003139#endif // KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
Jim Cownie5e8470a2013-09-27 10:38:44 +00003140
3141extern void __kmp_gtid_set_specific( int gtid );
3142extern int __kmp_gtid_get_specific( void );
3143
3144extern double __kmp_read_cpu_time( void );
3145
3146extern int __kmp_read_system_info( struct kmp_sys_info *info );
3147
3148extern void __kmp_create_monitor( kmp_info_t *th );
3149
3150extern void *__kmp_launch_thread( kmp_info_t *thr );
3151
3152extern void __kmp_create_worker( int gtid, kmp_info_t *th, size_t stack_size );
3153
3154#if KMP_OS_WINDOWS
3155extern int __kmp_still_running(kmp_info_t *th);
3156extern int __kmp_is_thread_alive( kmp_info_t * th, DWORD *exit_val );
3157extern void __kmp_free_handle( kmp_thread_t tHandle );
3158#endif
3159
3160extern void __kmp_reap_monitor( kmp_info_t *th );
3161extern void __kmp_reap_worker( kmp_info_t *th );
3162extern void __kmp_terminate_thread( int gtid );
3163
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003164extern void __kmp_suspend_32( int th_gtid, kmp_flag_32 *flag );
3165extern void __kmp_suspend_64( int th_gtid, kmp_flag_64 *flag );
3166extern void __kmp_suspend_oncore( int th_gtid, kmp_flag_oncore *flag );
3167extern void __kmp_resume_32( int target_gtid, kmp_flag_32 *flag );
3168extern void __kmp_resume_64( int target_gtid, kmp_flag_64 *flag );
3169extern void __kmp_resume_oncore( int target_gtid, kmp_flag_oncore *flag );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003170
3171extern void __kmp_elapsed( double * );
3172extern void __kmp_elapsed_tick( double * );
3173
3174extern void __kmp_enable( int old_state );
3175extern void __kmp_disable( int *old_state );
3176
3177extern void __kmp_thread_sleep( int millis );
3178
3179extern void __kmp_common_initialize( void );
3180extern void __kmp_common_destroy( void );
3181extern void __kmp_common_destroy_gtid( int gtid );
3182
3183#if KMP_OS_UNIX
3184extern void __kmp_register_atfork( void );
3185#endif
3186extern void __kmp_suspend_initialize( void );
3187extern void __kmp_suspend_uninitialize_thread( kmp_info_t *th );
3188
3189extern kmp_info_t * __kmp_allocate_thread( kmp_root_t *root,
3190 kmp_team_t *team, int tid);
3191#if OMP_40_ENABLED
3192extern kmp_team_t * __kmp_allocate_team( kmp_root_t *root, int new_nproc, int max_nproc,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003193#if OMPT_SUPPORT
3194 ompt_parallel_id_t ompt_parallel_id,
3195#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003196 kmp_proc_bind_t proc_bind,
3197 kmp_internal_control_t *new_icvs,
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003198 int argc USE_NESTED_HOT_ARG(kmp_info_t *thr) );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003199#else
3200extern kmp_team_t * __kmp_allocate_team( kmp_root_t *root, int new_nproc, int max_nproc,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003201#if OMPT_SUPPORT
3202 ompt_parallel_id_t ompt_parallel_id,
3203#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003204 kmp_internal_control_t *new_icvs,
3205 int argc USE_NESTED_HOT_ARG(kmp_info_t *thr) );
3206#endif // OMP_40_ENABLED
Jim Cownie5e8470a2013-09-27 10:38:44 +00003207extern void __kmp_free_thread( kmp_info_t * );
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003208extern void __kmp_free_team( kmp_root_t *, kmp_team_t * USE_NESTED_HOT_ARG(kmp_info_t *) );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003209extern kmp_team_t * __kmp_reap_team( kmp_team_t * );
3210
3211/* ------------------------------------------------------------------------ */
3212
3213extern void __kmp_initialize_bget( kmp_info_t *th );
3214extern void __kmp_finalize_bget( kmp_info_t *th );
3215
3216KMP_EXPORT void *kmpc_malloc( size_t size );
3217KMP_EXPORT void *kmpc_calloc( size_t nelem, size_t elsize );
3218KMP_EXPORT void *kmpc_realloc( void *ptr, size_t size );
3219KMP_EXPORT void kmpc_free( void *ptr );
3220
3221/* ------------------------------------------------------------------------ */
3222/* declarations for internal use */
3223
3224extern int __kmp_barrier( enum barrier_type bt, int gtid, int is_split,
3225 size_t reduce_size, void *reduce_data, void (*reduce)(void *, void *) );
3226extern void __kmp_end_split_barrier ( enum barrier_type bt, int gtid );
3227
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003228/*!
3229 * Tell the fork call which compiler generated the fork call, and therefore how to deal with the call.
3230 */
3231enum fork_context_e
3232{
3233 fork_context_gnu, /**< Called from GNU generated code, so must not invoke the microtask internally. */
3234 fork_context_intel, /**< Called from Intel generated code. */
3235 fork_context_last
3236};
3237extern int __kmp_fork_call( ident_t *loc, int gtid, enum fork_context_e fork_context,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003238 kmp_int32 argc,
3239#if OMPT_SUPPORT
3240 void *unwrapped_task,
3241#endif
3242 microtask_t microtask, launch_t invoker,
Jim Cownie5e8470a2013-09-27 10:38:44 +00003243/* TODO: revert workaround for Intel(R) 64 tracker #96 */
Andrey Churbanovcbda8682015-01-13 14:43:35 +00003244#if (KMP_ARCH_ARM || KMP_ARCH_X86_64 || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jim Cownie5e8470a2013-09-27 10:38:44 +00003245 va_list *ap
3246#else
3247 va_list ap
3248#endif
3249 );
3250
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00003251extern void __kmp_join_call( ident_t *loc, int gtid
3252#if OMPT_SUPPORT
3253 , enum fork_context_e fork_context
3254#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003255#if OMP_40_ENABLED
3256 , int exit_teams = 0
3257#endif
3258 );
3259
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003260extern void __kmp_serialized_parallel(ident_t *id, kmp_int32 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003261extern void __kmp_internal_fork( ident_t *id, int gtid, kmp_team_t *team );
3262extern void __kmp_internal_join( ident_t *id, int gtid, kmp_team_t *team );
3263extern int __kmp_invoke_task_func( int gtid );
3264extern void __kmp_run_before_invoked_task( int gtid, int tid, kmp_info_t *this_thr, kmp_team_t *team );
3265extern void __kmp_run_after_invoked_task( int gtid, int tid, kmp_info_t *this_thr, kmp_team_t *team );
3266
3267// should never have been exported
3268KMP_EXPORT int __kmpc_invoke_task_func( int gtid );
3269#if OMP_40_ENABLED
3270extern int __kmp_invoke_teams_master( int gtid );
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003271extern void __kmp_teams_master( int gtid );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003272#endif
3273extern void __kmp_save_internal_controls( kmp_info_t * thread );
3274extern void __kmp_user_set_library (enum library_type arg);
3275extern void __kmp_aux_set_library (enum library_type arg);
3276extern void __kmp_aux_set_stacksize( size_t arg);
3277extern void __kmp_aux_set_blocktime (int arg, kmp_info_t *thread, int tid);
3278extern void __kmp_aux_set_defaults( char const * str, int len );
3279
3280/* Functions below put here to call them from __kmp_aux_env_initialize() in kmp_settings.c */
3281void kmpc_set_blocktime (int arg);
3282void ompc_set_nested( int flag );
3283void ompc_set_dynamic( int flag );
3284void ompc_set_num_threads( int arg );
3285
Jim Cownie5e8470a2013-09-27 10:38:44 +00003286extern void __kmp_push_current_task_to_thread( kmp_info_t *this_thr,
3287 kmp_team_t *team, int tid );
3288extern void __kmp_pop_current_task_from_thread( kmp_info_t *this_thr );
3289extern kmp_task_t* __kmp_task_alloc( ident_t *loc_ref, kmp_int32 gtid,
3290 kmp_tasking_flags_t *flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
3291 kmp_routine_entry_t task_entry );
3292extern void __kmp_init_implicit_task( ident_t *loc_ref, kmp_info_t *this_thr,
3293 kmp_team_t *team, int tid, int set_curr_task );
3294
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003295int __kmp_execute_tasks_32(kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32 *flag, int final_spin,
3296 int *thread_finished,
Jim Cownie5e8470a2013-09-27 10:38:44 +00003297#if USE_ITT_BUILD
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003298 void * itt_sync_obj,
Jim Cownie5e8470a2013-09-27 10:38:44 +00003299#endif /* USE_ITT_BUILD */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003300 kmp_int32 is_constrained);
3301int __kmp_execute_tasks_64(kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64 *flag, int final_spin,
3302 int *thread_finished,
3303#if USE_ITT_BUILD
3304 void * itt_sync_obj,
3305#endif /* USE_ITT_BUILD */
3306 kmp_int32 is_constrained);
3307int __kmp_execute_tasks_oncore(kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
3308 int *thread_finished,
3309#if USE_ITT_BUILD
3310 void * itt_sync_obj,
3311#endif /* USE_ITT_BUILD */
3312 kmp_int32 is_constrained);
3313
Jonathan Peyton54127982015-11-04 21:37:48 +00003314extern void __kmp_free_task_team( kmp_info_t *thread, kmp_task_team_t *task_team );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003315extern void __kmp_reap_task_teams( void );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003316extern void __kmp_wait_to_unref_task_teams( void );
Jonathan Peyton54127982015-11-04 21:37:48 +00003317extern void __kmp_task_team_setup ( kmp_info_t *this_thr, kmp_team_t *team, int always );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003318extern void __kmp_task_team_sync ( kmp_info_t *this_thr, kmp_team_t *team );
3319extern void __kmp_task_team_wait ( kmp_info_t *this_thr, kmp_team_t *team
3320#if USE_ITT_BUILD
3321 , void * itt_sync_obj
3322#endif /* USE_ITT_BUILD */
Jonathan Peyton54127982015-11-04 21:37:48 +00003323 , int wait=1
Jim Cownie5e8470a2013-09-27 10:38:44 +00003324);
3325extern void __kmp_tasking_barrier( kmp_team_t *team, kmp_info_t *thread, int gtid );
3326
Jim Cownie5e8470a2013-09-27 10:38:44 +00003327extern int __kmp_is_address_mapped( void *addr );
3328extern kmp_uint64 __kmp_hardware_timestamp(void);
3329
Jim Cownie181b4bb2013-12-23 17:28:57 +00003330#if KMP_OS_UNIX
3331extern int __kmp_read_from_file( char const *path, char const *format, ... );
3332#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003333
3334/* ------------------------------------------------------------------------ */
3335//
3336// Assembly routines that have no compiler intrinsic replacement
3337//
3338
3339#if KMP_ARCH_X86 || KMP_ARCH_X86_64
3340
3341extern void __kmp_query_cpuid( kmp_cpuinfo_t *p );
3342
Jim Cownie181b4bb2013-12-23 17:28:57 +00003343#define __kmp_load_mxcsr(p) _mm_setcsr(*(p))
Jim Cownie5e8470a2013-09-27 10:38:44 +00003344static inline void __kmp_store_mxcsr( kmp_uint32 *p ) { *p = _mm_getcsr(); }
3345
3346extern void __kmp_load_x87_fpu_control_word( kmp_int16 *p );
3347extern void __kmp_store_x87_fpu_control_word( kmp_int16 *p );
3348extern void __kmp_clear_x87_fpu_status_word();
3349# define KMP_X86_MXCSR_MASK 0xffffffc0 /* ignore status flags (6 lsb) */
3350
3351#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
3352
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003353extern int __kmp_invoke_microtask( microtask_t pkfn, int gtid, int npr, int argc, void *argv[]
3354#if OMPT_SUPPORT
3355 , void **exit_frame_ptr
3356#endif
3357);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003358
3359
3360/* ------------------------------------------------------------------------ */
3361
3362KMP_EXPORT void __kmpc_begin ( ident_t *, kmp_int32 flags );
3363KMP_EXPORT void __kmpc_end ( ident_t * );
3364
3365KMP_EXPORT void __kmpc_threadprivate_register_vec ( ident_t *, void * data, kmpc_ctor_vec ctor,
3366 kmpc_cctor_vec cctor, kmpc_dtor_vec dtor, size_t vector_length );
3367KMP_EXPORT void __kmpc_threadprivate_register ( ident_t *, void * data, kmpc_ctor ctor, kmpc_cctor cctor, kmpc_dtor dtor );
3368KMP_EXPORT void * __kmpc_threadprivate ( ident_t *, kmp_int32 global_tid, void * data, size_t size );
3369
3370KMP_EXPORT kmp_int32 __kmpc_global_thread_num ( ident_t * );
3371KMP_EXPORT kmp_int32 __kmpc_global_num_threads ( ident_t * );
3372KMP_EXPORT kmp_int32 __kmpc_bound_thread_num ( ident_t * );
3373KMP_EXPORT kmp_int32 __kmpc_bound_num_threads ( ident_t * );
3374
3375KMP_EXPORT kmp_int32 __kmpc_ok_to_fork ( ident_t * );
3376KMP_EXPORT void __kmpc_fork_call ( ident_t *, kmp_int32 nargs, kmpc_micro microtask, ... );
3377
3378KMP_EXPORT void __kmpc_serialized_parallel ( ident_t *, kmp_int32 global_tid );
3379KMP_EXPORT void __kmpc_end_serialized_parallel ( ident_t *, kmp_int32 global_tid );
3380
Andrey Churbanov723a6b62015-02-20 18:09:27 +00003381KMP_EXPORT void __kmpc_flush ( ident_t *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003382KMP_EXPORT void __kmpc_barrier ( ident_t *, kmp_int32 global_tid );
3383KMP_EXPORT kmp_int32 __kmpc_master ( ident_t *, kmp_int32 global_tid );
3384KMP_EXPORT void __kmpc_end_master ( ident_t *, kmp_int32 global_tid );
3385KMP_EXPORT void __kmpc_ordered ( ident_t *, kmp_int32 global_tid );
3386KMP_EXPORT void __kmpc_end_ordered ( ident_t *, kmp_int32 global_tid );
3387KMP_EXPORT void __kmpc_critical ( ident_t *, kmp_int32 global_tid, kmp_critical_name * );
3388KMP_EXPORT void __kmpc_end_critical ( ident_t *, kmp_int32 global_tid, kmp_critical_name * );
3389
Jonathan Peytonb87b5812015-12-11 22:04:05 +00003390#if OMP_41_ENABLED
3391KMP_EXPORT void __kmpc_critical_with_hint ( ident_t *, kmp_int32 global_tid, kmp_critical_name *, uintptr_t hint );
3392#endif
3393
Jim Cownie5e8470a2013-09-27 10:38:44 +00003394KMP_EXPORT kmp_int32 __kmpc_barrier_master ( ident_t *, kmp_int32 global_tid );
3395KMP_EXPORT void __kmpc_end_barrier_master ( ident_t *, kmp_int32 global_tid );
3396
3397KMP_EXPORT kmp_int32 __kmpc_barrier_master_nowait ( ident_t *, kmp_int32 global_tid );
3398
3399KMP_EXPORT kmp_int32 __kmpc_single ( ident_t *, kmp_int32 global_tid );
3400KMP_EXPORT void __kmpc_end_single ( ident_t *, kmp_int32 global_tid );
3401
3402KMP_EXPORT void KMPC_FOR_STATIC_INIT ( ident_t *loc, kmp_int32 global_tid, kmp_int32 schedtype, kmp_int32 *plastiter,
3403 kmp_int *plower, kmp_int *pupper, kmp_int *pstride, kmp_int incr, kmp_int chunk );
3404
3405KMP_EXPORT void __kmpc_for_static_fini ( ident_t *loc, kmp_int32 global_tid );
3406
3407KMP_EXPORT void __kmpc_copyprivate( ident_t *loc, kmp_int32 global_tid, size_t cpy_size, void *cpy_data, void(*cpy_func)(void*,void*), kmp_int32 didit );
3408
3409extern void KMPC_SET_NUM_THREADS ( int arg );
3410extern void KMPC_SET_DYNAMIC ( int flag );
3411extern void KMPC_SET_NESTED ( int flag );
3412
3413/* --------------------------------------------------------------------------- */
3414
3415/*
3416 * Taskq interface routines
3417 */
3418
3419KMP_EXPORT kmpc_thunk_t * __kmpc_taskq (ident_t *loc, kmp_int32 global_tid, kmpc_task_t taskq_task, size_t sizeof_thunk,
3420 size_t sizeof_shareds, kmp_int32 flags, kmpc_shared_vars_t **shareds);
3421KMP_EXPORT void __kmpc_end_taskq (ident_t *loc, kmp_int32 global_tid, kmpc_thunk_t *thunk);
3422KMP_EXPORT kmp_int32 __kmpc_task (ident_t *loc, kmp_int32 global_tid, kmpc_thunk_t *thunk);
3423KMP_EXPORT void __kmpc_taskq_task (ident_t *loc, kmp_int32 global_tid, kmpc_thunk_t *thunk, kmp_int32 status);
3424KMP_EXPORT void __kmpc_end_taskq_task (ident_t *loc, kmp_int32 global_tid, kmpc_thunk_t *thunk);
3425KMP_EXPORT kmpc_thunk_t * __kmpc_task_buffer (ident_t *loc, kmp_int32 global_tid, kmpc_thunk_t *taskq_thunk, kmpc_task_t task);
3426
3427/* ------------------------------------------------------------------------ */
3428
Jim Cownie5e8470a2013-09-27 10:38:44 +00003429/*
3430 * OMP 3.0 tasking interface routines
3431 */
3432
3433KMP_EXPORT kmp_int32
3434__kmpc_omp_task( ident_t *loc_ref, kmp_int32 gtid, kmp_task_t * new_task );
3435KMP_EXPORT kmp_task_t*
3436__kmpc_omp_task_alloc( ident_t *loc_ref, kmp_int32 gtid, kmp_int32 flags,
3437 size_t sizeof_kmp_task_t, size_t sizeof_shareds,
3438 kmp_routine_entry_t task_entry );
3439KMP_EXPORT void
3440__kmpc_omp_task_begin_if0( ident_t *loc_ref, kmp_int32 gtid, kmp_task_t * task );
3441KMP_EXPORT void
3442__kmpc_omp_task_complete_if0( ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task );
3443KMP_EXPORT kmp_int32
3444__kmpc_omp_task_parts( ident_t *loc_ref, kmp_int32 gtid, kmp_task_t * new_task );
3445KMP_EXPORT kmp_int32
3446__kmpc_omp_taskwait( ident_t *loc_ref, kmp_int32 gtid );
3447
3448KMP_EXPORT kmp_int32
3449__kmpc_omp_taskyield( ident_t *loc_ref, kmp_int32 gtid, int end_part );
3450
3451#if TASK_UNUSED
3452void __kmpc_omp_task_begin( ident_t *loc_ref, kmp_int32 gtid, kmp_task_t * task );
3453void __kmpc_omp_task_complete( ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task );
3454#endif // TASK_UNUSED
3455
3456/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00003457
3458#if OMP_40_ENABLED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003459
Jim Cownie181b4bb2013-12-23 17:28:57 +00003460KMP_EXPORT void __kmpc_taskgroup( ident_t * loc, int gtid );
3461KMP_EXPORT void __kmpc_end_taskgroup( ident_t * loc, int gtid );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003462
3463KMP_EXPORT kmp_int32 __kmpc_omp_task_with_deps ( ident_t *loc_ref, kmp_int32 gtid, kmp_task_t * new_task,
3464 kmp_int32 ndeps, kmp_depend_info_t *dep_list,
3465 kmp_int32 ndeps_noalias, kmp_depend_info_t *noalias_dep_list );
3466KMP_EXPORT void __kmpc_omp_wait_deps ( ident_t *loc_ref, kmp_int32 gtid, kmp_int32 ndeps, kmp_depend_info_t *dep_list,
3467 kmp_int32 ndeps_noalias, kmp_depend_info_t *noalias_dep_list );
3468extern void __kmp_release_deps ( kmp_int32 gtid, kmp_taskdata_t *task );
3469
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003470extern kmp_int32 __kmp_omp_task( kmp_int32 gtid, kmp_task_t * new_task, bool serialize_immediate );
Jim Cownie5e8470a2013-09-27 10:38:44 +00003471
Jim Cownie181b4bb2013-12-23 17:28:57 +00003472KMP_EXPORT kmp_int32 __kmpc_cancel(ident_t* loc_ref, kmp_int32 gtid, kmp_int32 cncl_kind);
3473KMP_EXPORT kmp_int32 __kmpc_cancellationpoint(ident_t* loc_ref, kmp_int32 gtid, kmp_int32 cncl_kind);
3474KMP_EXPORT kmp_int32 __kmpc_cancel_barrier(ident_t* loc_ref, kmp_int32 gtid);
3475KMP_EXPORT int __kmp_get_cancellation_status(int cancel_kind);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003476
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00003477#if OMP_41_ENABLED
3478
3479KMP_EXPORT void __kmpc_proxy_task_completed( kmp_int32 gtid, kmp_task_t *ptask );
3480KMP_EXPORT void __kmpc_proxy_task_completed_ooo ( kmp_task_t *ptask );
3481
Jim Cownie181b4bb2013-12-23 17:28:57 +00003482#endif
3483
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00003484#endif
3485
3486
Jim Cownie5e8470a2013-09-27 10:38:44 +00003487/*
3488 * Lock interface routines (fast versions with gtid passed in)
3489 */
3490KMP_EXPORT void __kmpc_init_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3491KMP_EXPORT void __kmpc_init_nest_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3492KMP_EXPORT void __kmpc_destroy_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3493KMP_EXPORT void __kmpc_destroy_nest_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3494KMP_EXPORT void __kmpc_set_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3495KMP_EXPORT void __kmpc_set_nest_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3496KMP_EXPORT void __kmpc_unset_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3497KMP_EXPORT void __kmpc_unset_nest_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3498KMP_EXPORT int __kmpc_test_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3499KMP_EXPORT int __kmpc_test_nest_lock( ident_t *loc, kmp_int32 gtid, void **user_lock );
3500
Jonathan Peytonb87b5812015-12-11 22:04:05 +00003501#if OMP_41_ENABLED
3502KMP_EXPORT void __kmpc_init_lock_with_hint( ident_t *loc, kmp_int32 gtid, void **user_lock, uintptr_t hint );
3503KMP_EXPORT void __kmpc_init_nest_lock_with_hint( ident_t *loc, kmp_int32 gtid, void **user_lock, uintptr_t hint );
3504#endif
3505
Jim Cownie5e8470a2013-09-27 10:38:44 +00003506/* ------------------------------------------------------------------------ */
3507
3508/*
3509 * Interface to fast scalable reduce methods routines
3510 */
3511
3512KMP_EXPORT kmp_int32 __kmpc_reduce_nowait( ident_t *loc, kmp_int32 global_tid,
3513 kmp_int32 num_vars, size_t reduce_size,
3514 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
3515 kmp_critical_name *lck );
3516KMP_EXPORT void __kmpc_end_reduce_nowait( ident_t *loc, kmp_int32 global_tid, kmp_critical_name *lck );
3517KMP_EXPORT kmp_int32 __kmpc_reduce( ident_t *loc, kmp_int32 global_tid,
3518 kmp_int32 num_vars, size_t reduce_size,
3519 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
3520 kmp_critical_name *lck );
3521KMP_EXPORT void __kmpc_end_reduce( ident_t *loc, kmp_int32 global_tid, kmp_critical_name *lck );
3522
3523/*
3524 * internal fast reduction routines
3525 */
3526
3527extern PACKED_REDUCTION_METHOD_T
3528__kmp_determine_reduction_method( ident_t *loc, kmp_int32 global_tid,
3529 kmp_int32 num_vars, size_t reduce_size,
3530 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
3531 kmp_critical_name *lck );
3532
3533// this function is for testing set/get/determine reduce method
3534KMP_EXPORT kmp_int32 __kmp_get_reduce_method( void );
3535
3536KMP_EXPORT kmp_uint64 __kmpc_get_taskid();
3537KMP_EXPORT kmp_uint64 __kmpc_get_parent_taskid();
3538
Jonathan Peytondd4aa9b2015-10-08 17:55:54 +00003539// this function exported for testing of KMP_PLACE_THREADS functionality
3540KMP_EXPORT void __kmpc_place_threads(int,int,int,int,int);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003541
3542/* ------------------------------------------------------------------------ */
3543/* ------------------------------------------------------------------------ */
3544
3545// C++ port
3546// missing 'extern "C"' declarations
3547
3548KMP_EXPORT kmp_int32 __kmpc_in_parallel( ident_t *loc );
3549KMP_EXPORT void __kmpc_pop_num_threads( ident_t *loc, kmp_int32 global_tid );
3550KMP_EXPORT void __kmpc_push_num_threads( ident_t *loc, kmp_int32 global_tid, kmp_int32 num_threads );
3551
3552#if OMP_40_ENABLED
3553KMP_EXPORT void __kmpc_push_proc_bind( ident_t *loc, kmp_int32 global_tid, int proc_bind );
3554KMP_EXPORT void __kmpc_push_num_teams( ident_t *loc, kmp_int32 global_tid, kmp_int32 num_teams, kmp_int32 num_threads );
3555KMP_EXPORT void __kmpc_fork_teams(ident_t *loc, kmp_int32 argc, kmpc_micro microtask, ...);
Jonathan Peyton71909c52016-03-02 22:42:06 +00003556#endif
3557#if OMP_41_ENABLED
3558struct kmp_dim { // loop bounds info casted to kmp_int64
3559 kmp_int64 lo; // lower
3560 kmp_int64 up; // upper
3561 kmp_int64 st; // stride
3562};
3563KMP_EXPORT void __kmpc_doacross_init(ident_t *loc, kmp_int32 gtid, kmp_int32 num_dims, struct kmp_dim * dims);
3564KMP_EXPORT void __kmpc_doacross_wait(ident_t *loc, kmp_int32 gtid, kmp_int64 *vec);
3565KMP_EXPORT void __kmpc_doacross_post(ident_t *loc, kmp_int32 gtid, kmp_int64 *vec);
3566KMP_EXPORT void __kmpc_doacross_fini(ident_t *loc, kmp_int32 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003567#endif
3568
3569KMP_EXPORT void*
3570__kmpc_threadprivate_cached( ident_t * loc, kmp_int32 global_tid,
3571 void * data, size_t size, void *** cache );
3572
3573// Symbols for MS mutual detection.
3574extern int _You_must_link_with_exactly_one_OpenMP_library;
3575extern int _You_must_link_with_Intel_OpenMP_library;
3576#if KMP_OS_WINDOWS && ( KMP_VERSION_MAJOR > 4 )
3577 extern int _You_must_link_with_Microsoft_OpenMP_library;
3578#endif
3579
3580
3581// The routines below are not exported.
3582// Consider making them 'static' in corresponding source files.
3583void
3584kmp_threadprivate_insert_private_data( int gtid, void *pc_addr, void *data_addr, size_t pc_size );
3585struct private_common *
3586kmp_threadprivate_insert( int gtid, void *pc_addr, void *data_addr, size_t pc_size );
3587
Jim Cownie181b4bb2013-12-23 17:28:57 +00003588//
3589// ompc_, kmpc_ entries moved from omp.h.
3590//
3591#if KMP_OS_WINDOWS
3592# define KMPC_CONVENTION __cdecl
3593#else
3594# define KMPC_CONVENTION
3595#endif
3596
Jim Cownie181b4bb2013-12-23 17:28:57 +00003597#ifndef __OMP_H
3598typedef enum omp_sched_t {
3599 omp_sched_static = 1,
3600 omp_sched_dynamic = 2,
3601 omp_sched_guided = 3,
3602 omp_sched_auto = 4
3603} omp_sched_t;
3604typedef void * kmp_affinity_mask_t;
3605#endif
3606
3607KMP_EXPORT void KMPC_CONVENTION ompc_set_max_active_levels(int);
3608KMP_EXPORT void KMPC_CONVENTION ompc_set_schedule(omp_sched_t, int);
3609KMP_EXPORT int KMPC_CONVENTION ompc_get_ancestor_thread_num(int);
3610KMP_EXPORT int KMPC_CONVENTION ompc_get_team_size(int);
3611KMP_EXPORT int KMPC_CONVENTION kmpc_set_affinity_mask_proc(int, kmp_affinity_mask_t *);
3612KMP_EXPORT int KMPC_CONVENTION kmpc_unset_affinity_mask_proc(int, kmp_affinity_mask_t *);
3613KMP_EXPORT int KMPC_CONVENTION kmpc_get_affinity_mask_proc(int, kmp_affinity_mask_t *);
3614
Jim Cownie181b4bb2013-12-23 17:28:57 +00003615KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize(int);
3616KMP_EXPORT void KMPC_CONVENTION kmpc_set_stacksize_s(size_t);
3617KMP_EXPORT void KMPC_CONVENTION kmpc_set_library(int);
3618KMP_EXPORT void KMPC_CONVENTION kmpc_set_defaults(char const *);
3619
Jim Cownie5e8470a2013-09-27 10:38:44 +00003620#ifdef __cplusplus
3621}
3622#endif
3623
3624#endif /* KMP_H */
3625