blob: 44f54ad9c2f31dc1c0a0f454d63f54059d31ae95 [file] [log] [blame]
Jim Cownie5e8470a2013-09-27 10:38:44 +00001/*
Jonathan Peytonde4749b2016-12-14 23:01:24 +00002 * kmp_runtime.cpp -- KPTS runtime support library
Jim Cownie5e8470a2013-09-27 10:38:44 +00003 */
4
Jim Cownie5e8470a2013-09-27 10:38:44 +00005//===----------------------------------------------------------------------===//
6//
Chandler Carruth57b08b02019-01-19 10:56:40 +00007// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
8// See https://llvm.org/LICENSE.txt for license information.
9// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Jim Cownie5e8470a2013-09-27 10:38:44 +000010//
11//===----------------------------------------------------------------------===//
12
Jim Cownie5e8470a2013-09-27 10:38:44 +000013#include "kmp.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000014#include "kmp_affinity.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000015#include "kmp_atomic.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000016#include "kmp_environment.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000017#include "kmp_error.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000018#include "kmp_i18n.h"
19#include "kmp_io.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000020#include "kmp_itt.h"
21#include "kmp_settings.h"
Jim Cownie4cc4bb42014-10-07 16:25:50 +000022#include "kmp_stats.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000023#include "kmp_str.h"
Jim Cownie4cc4bb42014-10-07 16:25:50 +000024#include "kmp_wait_release.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000025#include "kmp_wrapper_getpid.h"
Jonathan Peytonf6399362018-07-09 17:51:13 +000026#include "kmp_dispatch.h"
27#if KMP_USE_HIER_SCHED
28#include "kmp_dispatch_hier.h"
29#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +000030
Andrey Churbanovd7d088f2015-04-29 16:42:24 +000031#if OMPT_SUPPORT
32#include "ompt-specific.h"
33#endif
34
Jim Cownie5e8470a2013-09-27 10:38:44 +000035/* these are temporary issues to be dealt with */
36#define KMP_USE_PRCTL 0
Jim Cownie5e8470a2013-09-27 10:38:44 +000037
Jim Cownie5e8470a2013-09-27 10:38:44 +000038#if KMP_OS_WINDOWS
39#include <process.h>
40#endif
41
Jonas Hahnfeld50fed042016-11-07 15:58:36 +000042#include "tsan_annotations.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000043
44#if defined(KMP_GOMP_COMPAT)
Jonathan Peyton30419822017-05-12 18:01:32 +000045char const __kmp_version_alt_comp[] =
46 KMP_VERSION_PREFIX "alternative compiler support: yes";
Jim Cownie5e8470a2013-09-27 10:38:44 +000047#endif /* defined(KMP_GOMP_COMPAT) */
48
49char const __kmp_version_omp_api[] = KMP_VERSION_PREFIX "API version: "
Jonathan Peytone844a542017-03-06 22:07:40 +000050#if OMP_50_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +000051 "5.0 (201611)";
Jonathan Peytone844a542017-03-06 22:07:40 +000052#elif OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +000053 "4.5 (201511)";
Jonathan Peyton74f3ffc2016-09-30 15:50:14 +000054#elif OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +000055 "4.0 (201307)";
Jim Cownie5e8470a2013-09-27 10:38:44 +000056#else
Jonathan Peyton30419822017-05-12 18:01:32 +000057 "3.1 (201107)";
Jim Cownie5e8470a2013-09-27 10:38:44 +000058#endif
59
60#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +000061char const __kmp_version_lock[] =
62 KMP_VERSION_PREFIX "lock type: run time selectable";
Jim Cownie5e8470a2013-09-27 10:38:44 +000063#endif /* KMP_DEBUG */
64
Jonathan Peyton30419822017-05-12 18:01:32 +000065#define KMP_MIN(x, y) ((x) < (y) ? (x) : (y))
Jim Cownie181b4bb2013-12-23 17:28:57 +000066
Jim Cownie5e8470a2013-09-27 10:38:44 +000067/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +000068
Jonathan Peyton37e2ef52018-07-09 17:36:22 +000069#if KMP_USE_MONITOR
Jim Cownie5e8470a2013-09-27 10:38:44 +000070kmp_info_t __kmp_monitor;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +000071#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +000072
Jim Cownie5e8470a2013-09-27 10:38:44 +000073/* Forward declarations */
74
Jonathan Peyton30419822017-05-12 18:01:32 +000075void __kmp_cleanup(void);
Jim Cownie5e8470a2013-09-27 10:38:44 +000076
Jonathan Peyton30419822017-05-12 18:01:32 +000077static void __kmp_initialize_info(kmp_info_t *, kmp_team_t *, int tid,
78 int gtid);
79static void __kmp_initialize_team(kmp_team_t *team, int new_nproc,
80 kmp_internal_control_t *new_icvs,
81 ident_t *loc);
Jonathan Peyton2321d572015-06-08 19:25:25 +000082#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +000083static void __kmp_partition_places(kmp_team_t *team,
84 int update_master_only = 0);
Jonathan Peyton2321d572015-06-08 19:25:25 +000085#endif
Jonathan Peyton30419822017-05-12 18:01:32 +000086static void __kmp_do_serial_initialize(void);
87void __kmp_fork_barrier(int gtid, int tid);
88void __kmp_join_barrier(int gtid);
89void __kmp_setup_icv_copy(kmp_team_t *team, int new_nproc,
90 kmp_internal_control_t *new_icvs, ident_t *loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +000091
Jim Cownie5e8470a2013-09-27 10:38:44 +000092#ifdef USE_LOAD_BALANCE
Jonathan Peyton30419822017-05-12 18:01:32 +000093static int __kmp_load_balance_nproc(kmp_root_t *root, int set_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +000094#endif
95
Jonathan Peyton1800ece2018-01-10 18:27:01 +000096static int __kmp_expand_threads(int nNeed);
Jonathan Peyton2321d572015-06-08 19:25:25 +000097#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +000098static int __kmp_unregister_root_other_thread(int gtid);
Jonathan Peyton2321d572015-06-08 19:25:25 +000099#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000100static void __kmp_unregister_library(void); // called by __kmp_internal_end()
101static void __kmp_reap_thread(kmp_info_t *thread, int is_root);
Jonathan Peytoneaa9e402018-01-10 18:21:48 +0000102kmp_info_t *__kmp_thread_pool_insert_pt = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000103
Jim Cownie5e8470a2013-09-27 10:38:44 +0000104/* Calculate the identifier of the current thread */
Jonathan Peyton30419822017-05-12 18:01:32 +0000105/* fast (and somewhat portable) way to get unique identifier of executing
106 thread. Returns KMP_GTID_DNE if we haven't been assigned a gtid. */
Jonathan Peyton30419822017-05-12 18:01:32 +0000107int __kmp_get_global_thread_id() {
108 int i;
109 kmp_info_t **other_threads;
110 size_t stack_data;
111 char *stack_addr;
112 size_t stack_size;
113 char *stack_base;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000114
Jonathan Peyton30419822017-05-12 18:01:32 +0000115 KA_TRACE(
116 1000,
117 ("*** __kmp_get_global_thread_id: entering, nproc=%d all_nproc=%d\n",
118 __kmp_nth, __kmp_all_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +0000119
Jonathan Peyton30419822017-05-12 18:01:32 +0000120 /* JPH - to handle the case where __kmpc_end(0) is called immediately prior to
121 a parallel region, made it return KMP_GTID_DNE to force serial_initialize
122 by caller. Had to handle KMP_GTID_DNE at all call-sites, or else guarantee
123 __kmp_init_gtid for this to work. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000124
Jonathan Peyton30419822017-05-12 18:01:32 +0000125 if (!TCR_4(__kmp_init_gtid))
126 return KMP_GTID_DNE;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000127
128#ifdef KMP_TDATA_GTID
Jonathan Peyton30419822017-05-12 18:01:32 +0000129 if (TCR_4(__kmp_gtid_mode) >= 3) {
130 KA_TRACE(1000, ("*** __kmp_get_global_thread_id: using TDATA\n"));
131 return __kmp_gtid;
132 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000133#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000134 if (TCR_4(__kmp_gtid_mode) >= 2) {
135 KA_TRACE(1000, ("*** __kmp_get_global_thread_id: using keyed TLS\n"));
136 return __kmp_gtid_get_specific();
137 }
138 KA_TRACE(1000, ("*** __kmp_get_global_thread_id: using internal alg.\n"));
139
140 stack_addr = (char *)&stack_data;
141 other_threads = __kmp_threads;
142
143 /* ATT: The code below is a source of potential bugs due to unsynchronized
144 access to __kmp_threads array. For example:
145 1. Current thread loads other_threads[i] to thr and checks it, it is
146 non-NULL.
147 2. Current thread is suspended by OS.
148 3. Another thread unregisters and finishes (debug versions of free()
149 may fill memory with something like 0xEF).
150 4. Current thread is resumed.
151 5. Current thread reads junk from *thr.
152 TODO: Fix it. --ln */
153
154 for (i = 0; i < __kmp_threads_capacity; i++) {
155
156 kmp_info_t *thr = (kmp_info_t *)TCR_SYNC_PTR(other_threads[i]);
157 if (!thr)
158 continue;
159
160 stack_size = (size_t)TCR_PTR(thr->th.th_info.ds.ds_stacksize);
161 stack_base = (char *)TCR_PTR(thr->th.th_info.ds.ds_stackbase);
162
163 /* stack grows down -- search through all of the active threads */
164
165 if (stack_addr <= stack_base) {
166 size_t stack_diff = stack_base - stack_addr;
167
168 if (stack_diff <= stack_size) {
169 /* The only way we can be closer than the allocated */
170 /* stack size is if we are running on this thread. */
171 KMP_DEBUG_ASSERT(__kmp_gtid_get_specific() == i);
172 return i;
173 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000174 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000175 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000176
Jonathan Peyton30419822017-05-12 18:01:32 +0000177 /* get specific to try and determine our gtid */
178 KA_TRACE(1000,
179 ("*** __kmp_get_global_thread_id: internal alg. failed to find "
180 "thread, using TLS\n"));
181 i = __kmp_gtid_get_specific();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000182
Jonathan Peyton30419822017-05-12 18:01:32 +0000183 /*fprintf( stderr, "=== %d\n", i ); */ /* GROO */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000184
Jonathan Peyton30419822017-05-12 18:01:32 +0000185 /* if we havn't been assigned a gtid, then return code */
186 if (i < 0)
Jim Cownie5e8470a2013-09-27 10:38:44 +0000187 return i;
Jonathan Peyton30419822017-05-12 18:01:32 +0000188
189 /* dynamically updated stack window for uber threads to avoid get_specific
190 call */
191 if (!TCR_4(other_threads[i]->th.th_info.ds.ds_stackgrow)) {
192 KMP_FATAL(StackOverflow, i);
193 }
194
195 stack_base = (char *)other_threads[i]->th.th_info.ds.ds_stackbase;
196 if (stack_addr > stack_base) {
197 TCW_PTR(other_threads[i]->th.th_info.ds.ds_stackbase, stack_addr);
198 TCW_PTR(other_threads[i]->th.th_info.ds.ds_stacksize,
199 other_threads[i]->th.th_info.ds.ds_stacksize + stack_addr -
200 stack_base);
201 } else {
202 TCW_PTR(other_threads[i]->th.th_info.ds.ds_stacksize,
203 stack_base - stack_addr);
204 }
205
206 /* Reprint stack bounds for ubermaster since they have been refined */
207 if (__kmp_storage_map) {
208 char *stack_end = (char *)other_threads[i]->th.th_info.ds.ds_stackbase;
209 char *stack_beg = stack_end - other_threads[i]->th.th_info.ds.ds_stacksize;
210 __kmp_print_storage_map_gtid(i, stack_beg, stack_end,
211 other_threads[i]->th.th_info.ds.ds_stacksize,
212 "th_%d stack (refinement)", i);
213 }
214 return i;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000215}
216
Jonathan Peyton30419822017-05-12 18:01:32 +0000217int __kmp_get_global_thread_id_reg() {
218 int gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000219
Jonathan Peyton30419822017-05-12 18:01:32 +0000220 if (!__kmp_init_serial) {
221 gtid = KMP_GTID_DNE;
222 } else
Jim Cownie5e8470a2013-09-27 10:38:44 +0000223#ifdef KMP_TDATA_GTID
Jonathan Peyton30419822017-05-12 18:01:32 +0000224 if (TCR_4(__kmp_gtid_mode) >= 3) {
225 KA_TRACE(1000, ("*** __kmp_get_global_thread_id_reg: using TDATA\n"));
226 gtid = __kmp_gtid;
227 } else
Jim Cownie5e8470a2013-09-27 10:38:44 +0000228#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000229 if (TCR_4(__kmp_gtid_mode) >= 2) {
230 KA_TRACE(1000, ("*** __kmp_get_global_thread_id_reg: using keyed TLS\n"));
231 gtid = __kmp_gtid_get_specific();
232 } else {
233 KA_TRACE(1000,
234 ("*** __kmp_get_global_thread_id_reg: using internal alg.\n"));
235 gtid = __kmp_get_global_thread_id();
236 }
237
238 /* we must be a new uber master sibling thread */
239 if (gtid == KMP_GTID_DNE) {
240 KA_TRACE(10,
241 ("__kmp_get_global_thread_id_reg: Encountered new root thread. "
242 "Registering a new gtid.\n"));
243 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
244 if (!__kmp_init_serial) {
245 __kmp_do_serial_initialize();
246 gtid = __kmp_gtid_get_specific();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000247 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +0000248 gtid = __kmp_register_root(FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000249 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000250 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
251 /*__kmp_printf( "+++ %d\n", gtid ); */ /* GROO */
252 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000253
Jonathan Peyton30419822017-05-12 18:01:32 +0000254 KMP_DEBUG_ASSERT(gtid >= 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000255
Jonathan Peyton30419822017-05-12 18:01:32 +0000256 return gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000257}
258
259/* caller must hold forkjoin_lock */
Jonathan Peyton30419822017-05-12 18:01:32 +0000260void __kmp_check_stack_overlap(kmp_info_t *th) {
261 int f;
262 char *stack_beg = NULL;
263 char *stack_end = NULL;
264 int gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000265
Jonathan Peyton30419822017-05-12 18:01:32 +0000266 KA_TRACE(10, ("__kmp_check_stack_overlap: called\n"));
267 if (__kmp_storage_map) {
268 stack_end = (char *)th->th.th_info.ds.ds_stackbase;
269 stack_beg = stack_end - th->th.th_info.ds.ds_stacksize;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000270
Jonathan Peyton30419822017-05-12 18:01:32 +0000271 gtid = __kmp_gtid_from_thread(th);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000272
Jonathan Peyton30419822017-05-12 18:01:32 +0000273 if (gtid == KMP_GTID_MONITOR) {
274 __kmp_print_storage_map_gtid(
275 gtid, stack_beg, stack_end, th->th.th_info.ds.ds_stacksize,
276 "th_%s stack (%s)", "mon",
277 (th->th.th_info.ds.ds_stackgrow) ? "initial" : "actual");
Jim Cownie5e8470a2013-09-27 10:38:44 +0000278 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +0000279 __kmp_print_storage_map_gtid(
280 gtid, stack_beg, stack_end, th->th.th_info.ds.ds_stacksize,
281 "th_%d stack (%s)", gtid,
282 (th->th.th_info.ds.ds_stackgrow) ? "initial" : "actual");
283 }
284 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000285
Jonathan Peyton30419822017-05-12 18:01:32 +0000286 /* No point in checking ubermaster threads since they use refinement and
287 * cannot overlap */
288 gtid = __kmp_gtid_from_thread(th);
289 if (__kmp_env_checks == TRUE && !KMP_UBER_GTID(gtid)) {
290 KA_TRACE(10,
291 ("__kmp_check_stack_overlap: performing extensive checking\n"));
292 if (stack_beg == NULL) {
293 stack_end = (char *)th->th.th_info.ds.ds_stackbase;
294 stack_beg = stack_end - th->th.th_info.ds.ds_stacksize;
295 }
296
297 for (f = 0; f < __kmp_threads_capacity; f++) {
298 kmp_info_t *f_th = (kmp_info_t *)TCR_SYNC_PTR(__kmp_threads[f]);
299
300 if (f_th && f_th != th) {
301 char *other_stack_end =
302 (char *)TCR_PTR(f_th->th.th_info.ds.ds_stackbase);
303 char *other_stack_beg =
304 other_stack_end - (size_t)TCR_PTR(f_th->th.th_info.ds.ds_stacksize);
305 if ((stack_beg > other_stack_beg && stack_beg < other_stack_end) ||
306 (stack_end > other_stack_beg && stack_end < other_stack_end)) {
307
308 /* Print the other stack values before the abort */
309 if (__kmp_storage_map)
310 __kmp_print_storage_map_gtid(
311 -1, other_stack_beg, other_stack_end,
312 (size_t)TCR_PTR(f_th->th.th_info.ds.ds_stacksize),
313 "th_%d stack (overlapped)", __kmp_gtid_from_thread(f_th));
314
Jonathan Peyton6a393f72017-09-05 15:43:58 +0000315 __kmp_fatal(KMP_MSG(StackOverlap), KMP_HNT(ChangeStackLimit),
316 __kmp_msg_null);
Jonathan Peyton30419822017-05-12 18:01:32 +0000317 }
318 }
319 }
320 }
321 KA_TRACE(10, ("__kmp_check_stack_overlap: returning\n"));
322}
323
324/* ------------------------------------------------------------------------ */
325
326void __kmp_infinite_loop(void) {
327 static int done = FALSE;
328
329 while (!done) {
Jonathan Peytone47d32f2019-02-28 19:11:29 +0000330 KMP_YIELD(TRUE);
Jonathan Peyton30419822017-05-12 18:01:32 +0000331 }
332}
333
334#define MAX_MESSAGE 512
335
336void __kmp_print_storage_map_gtid(int gtid, void *p1, void *p2, size_t size,
337 char const *format, ...) {
338 char buffer[MAX_MESSAGE];
339 va_list ap;
340
341 va_start(ap, format);
342 KMP_SNPRINTF(buffer, sizeof(buffer), "OMP storage map: %p %p%8lu %s\n", p1,
343 p2, (unsigned long)size, format);
344 __kmp_acquire_bootstrap_lock(&__kmp_stdio_lock);
345 __kmp_vprintf(kmp_err, buffer, ap);
346#if KMP_PRINT_DATA_PLACEMENT
347 int node;
348 if (gtid >= 0) {
349 if (p1 <= p2 && (char *)p2 - (char *)p1 == size) {
350 if (__kmp_storage_map_verbose) {
351 node = __kmp_get_host_node(p1);
352 if (node < 0) /* doesn't work, so don't try this next time */
353 __kmp_storage_map_verbose = FALSE;
354 else {
355 char *last;
356 int lastNode;
357 int localProc = __kmp_get_cpu_from_gtid(gtid);
358
359 const int page_size = KMP_GET_PAGE_SIZE();
360
361 p1 = (void *)((size_t)p1 & ~((size_t)page_size - 1));
362 p2 = (void *)(((size_t)p2 - 1) & ~((size_t)page_size - 1));
363 if (localProc >= 0)
364 __kmp_printf_no_lock(" GTID %d localNode %d\n", gtid,
365 localProc >> 1);
366 else
367 __kmp_printf_no_lock(" GTID %d\n", gtid);
368#if KMP_USE_PRCTL
369 /* The more elaborate format is disabled for now because of the prctl
370 * hanging bug. */
371 do {
372 last = p1;
373 lastNode = node;
374 /* This loop collates adjacent pages with the same host node. */
375 do {
376 (char *)p1 += page_size;
377 } while (p1 <= p2 && (node = __kmp_get_host_node(p1)) == lastNode);
378 __kmp_printf_no_lock(" %p-%p memNode %d\n", last, (char *)p1 - 1,
379 lastNode);
380 } while (p1 <= p2);
381#else
382 __kmp_printf_no_lock(" %p-%p memNode %d\n", p1,
383 (char *)p1 + (page_size - 1),
384 __kmp_get_host_node(p1));
385 if (p1 < p2) {
386 __kmp_printf_no_lock(" %p-%p memNode %d\n", p2,
387 (char *)p2 + (page_size - 1),
388 __kmp_get_host_node(p2));
389 }
390#endif
391 }
392 }
393 } else
394 __kmp_printf_no_lock(" %s\n", KMP_I18N_STR(StorageMapWarning));
395 }
396#endif /* KMP_PRINT_DATA_PLACEMENT */
397 __kmp_release_bootstrap_lock(&__kmp_stdio_lock);
398}
399
400void __kmp_warn(char const *format, ...) {
401 char buffer[MAX_MESSAGE];
402 va_list ap;
403
404 if (__kmp_generate_warnings == kmp_warnings_off) {
405 return;
406 }
407
408 va_start(ap, format);
409
410 KMP_SNPRINTF(buffer, sizeof(buffer), "OMP warning: %s\n", format);
411 __kmp_acquire_bootstrap_lock(&__kmp_stdio_lock);
412 __kmp_vprintf(kmp_err, buffer, ap);
413 __kmp_release_bootstrap_lock(&__kmp_stdio_lock);
414
415 va_end(ap);
416}
417
418void __kmp_abort_process() {
419 // Later threads may stall here, but that's ok because abort() will kill them.
420 __kmp_acquire_bootstrap_lock(&__kmp_exit_lock);
421
422 if (__kmp_debug_buf) {
423 __kmp_dump_debug_buffer();
Jonathan Peytonbd3a7632017-09-27 20:36:27 +0000424 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000425
426 if (KMP_OS_WINDOWS) {
427 // Let other threads know of abnormal termination and prevent deadlock
428 // if abort happened during library initialization or shutdown
429 __kmp_global.g.g_abort = SIGABRT;
430
431 /* On Windows* OS by default abort() causes pop-up error box, which stalls
432 nightly testing. Unfortunately, we cannot reliably suppress pop-up error
433 boxes. _set_abort_behavior() works well, but this function is not
434 available in VS7 (this is not problem for DLL, but it is a problem for
435 static OpenMP RTL). SetErrorMode (and so, timelimit utility) does not
436 help, at least in some versions of MS C RTL.
437
438 It seems following sequence is the only way to simulate abort() and
439 avoid pop-up error box. */
440 raise(SIGABRT);
441 _exit(3); // Just in case, if signal ignored, exit anyway.
442 } else {
443 abort();
Jonathan Peytonbd3a7632017-09-27 20:36:27 +0000444 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000445
446 __kmp_infinite_loop();
447 __kmp_release_bootstrap_lock(&__kmp_exit_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000448
449} // __kmp_abort_process
450
Jonathan Peyton30419822017-05-12 18:01:32 +0000451void __kmp_abort_thread(void) {
452 // TODO: Eliminate g_abort global variable and this function.
453 // In case of abort just call abort(), it will kill all the threads.
454 __kmp_infinite_loop();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000455} // __kmp_abort_thread
456
Jonathan Peyton30419822017-05-12 18:01:32 +0000457/* Print out the storage map for the major kmp_info_t thread data structures
458 that are allocated together. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000459
Jonathan Peyton30419822017-05-12 18:01:32 +0000460static void __kmp_print_thread_storage_map(kmp_info_t *thr, int gtid) {
461 __kmp_print_storage_map_gtid(gtid, thr, thr + 1, sizeof(kmp_info_t), "th_%d",
462 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000463
Jonathan Peyton30419822017-05-12 18:01:32 +0000464 __kmp_print_storage_map_gtid(gtid, &thr->th.th_info, &thr->th.th_team,
465 sizeof(kmp_desc_t), "th_%d.th_info", gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000466
Jonathan Peyton30419822017-05-12 18:01:32 +0000467 __kmp_print_storage_map_gtid(gtid, &thr->th.th_local, &thr->th.th_pri_head,
468 sizeof(kmp_local_t), "th_%d.th_local", gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000469
Jonathan Peyton30419822017-05-12 18:01:32 +0000470 __kmp_print_storage_map_gtid(
471 gtid, &thr->th.th_bar[0], &thr->th.th_bar[bs_last_barrier],
472 sizeof(kmp_balign_t) * bs_last_barrier, "th_%d.th_bar", gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000473
Jonathan Peyton30419822017-05-12 18:01:32 +0000474 __kmp_print_storage_map_gtid(gtid, &thr->th.th_bar[bs_plain_barrier],
475 &thr->th.th_bar[bs_plain_barrier + 1],
476 sizeof(kmp_balign_t), "th_%d.th_bar[plain]",
477 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000478
Jonathan Peyton30419822017-05-12 18:01:32 +0000479 __kmp_print_storage_map_gtid(gtid, &thr->th.th_bar[bs_forkjoin_barrier],
480 &thr->th.th_bar[bs_forkjoin_barrier + 1],
481 sizeof(kmp_balign_t), "th_%d.th_bar[forkjoin]",
482 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000483
Jonathan Peyton30419822017-05-12 18:01:32 +0000484#if KMP_FAST_REDUCTION_BARRIER
485 __kmp_print_storage_map_gtid(gtid, &thr->th.th_bar[bs_reduction_barrier],
486 &thr->th.th_bar[bs_reduction_barrier + 1],
487 sizeof(kmp_balign_t), "th_%d.th_bar[reduction]",
488 gtid);
489#endif // KMP_FAST_REDUCTION_BARRIER
Jim Cownie5e8470a2013-09-27 10:38:44 +0000490}
491
Jonathan Peyton30419822017-05-12 18:01:32 +0000492/* Print out the storage map for the major kmp_team_t team data structures
493 that are allocated together. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000494
Jonathan Peyton30419822017-05-12 18:01:32 +0000495static void __kmp_print_team_storage_map(const char *header, kmp_team_t *team,
496 int team_id, int num_thr) {
497 int num_disp_buff = team->t.t_max_nproc > 1 ? __kmp_dispatch_num_buffers : 2;
498 __kmp_print_storage_map_gtid(-1, team, team + 1, sizeof(kmp_team_t), "%s_%d",
499 header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000500
Jonathan Peyton30419822017-05-12 18:01:32 +0000501 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[0],
502 &team->t.t_bar[bs_last_barrier],
503 sizeof(kmp_balign_team_t) * bs_last_barrier,
504 "%s_%d.t_bar", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000505
Jonathan Peyton30419822017-05-12 18:01:32 +0000506 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[bs_plain_barrier],
507 &team->t.t_bar[bs_plain_barrier + 1],
508 sizeof(kmp_balign_team_t), "%s_%d.t_bar[plain]",
509 header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000510
Jonathan Peyton30419822017-05-12 18:01:32 +0000511 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[bs_forkjoin_barrier],
512 &team->t.t_bar[bs_forkjoin_barrier + 1],
513 sizeof(kmp_balign_team_t),
514 "%s_%d.t_bar[forkjoin]", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000515
Jonathan Peyton30419822017-05-12 18:01:32 +0000516#if KMP_FAST_REDUCTION_BARRIER
517 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[bs_reduction_barrier],
518 &team->t.t_bar[bs_reduction_barrier + 1],
519 sizeof(kmp_balign_team_t),
520 "%s_%d.t_bar[reduction]", header, team_id);
521#endif // KMP_FAST_REDUCTION_BARRIER
Jim Cownie5e8470a2013-09-27 10:38:44 +0000522
Jonathan Peyton30419822017-05-12 18:01:32 +0000523 __kmp_print_storage_map_gtid(
524 -1, &team->t.t_dispatch[0], &team->t.t_dispatch[num_thr],
525 sizeof(kmp_disp_t) * num_thr, "%s_%d.t_dispatch", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000526
Jonathan Peyton30419822017-05-12 18:01:32 +0000527 __kmp_print_storage_map_gtid(
528 -1, &team->t.t_threads[0], &team->t.t_threads[num_thr],
529 sizeof(kmp_info_t *) * num_thr, "%s_%d.t_threads", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000530
Jonathan Peyton30419822017-05-12 18:01:32 +0000531 __kmp_print_storage_map_gtid(-1, &team->t.t_disp_buffer[0],
532 &team->t.t_disp_buffer[num_disp_buff],
533 sizeof(dispatch_shared_info_t) * num_disp_buff,
534 "%s_%d.t_disp_buffer", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000535}
536
Jonathan Peyton92ca6182018-09-07 18:25:49 +0000537static void __kmp_init_allocator() {
538#if OMP_50_ENABLED
539 __kmp_init_memkind();
540#endif
541}
542static void __kmp_fini_allocator() {
543#if OMP_50_ENABLED
544 __kmp_fini_memkind();
545#endif
546}
Jim Cownie5e8470a2013-09-27 10:38:44 +0000547
548/* ------------------------------------------------------------------------ */
549
Jonathan Peyton8b3842f2018-10-05 17:59:39 +0000550#if KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +0000551#if KMP_OS_WINDOWS
Jim Cownie5e8470a2013-09-27 10:38:44 +0000552
Jonathan Peyton30419822017-05-12 18:01:32 +0000553static void __kmp_reset_lock(kmp_bootstrap_lock_t *lck) {
554 // TODO: Change to __kmp_break_bootstrap_lock().
555 __kmp_init_bootstrap_lock(lck); // make the lock released
Jim Cownie5e8470a2013-09-27 10:38:44 +0000556}
557
Jonathan Peyton30419822017-05-12 18:01:32 +0000558static void __kmp_reset_locks_on_process_detach(int gtid_req) {
559 int i;
560 int thread_count;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000561
Jonathan Peyton30419822017-05-12 18:01:32 +0000562 // PROCESS_DETACH is expected to be called by a thread that executes
563 // ProcessExit() or FreeLibrary(). OS terminates other threads (except the one
564 // calling ProcessExit or FreeLibrary). So, it might be safe to access the
565 // __kmp_threads[] without taking the forkjoin_lock. However, in fact, some
566 // threads can be still alive here, although being about to be terminated. The
567 // threads in the array with ds_thread==0 are most suspicious. Actually, it
568 // can be not safe to access the __kmp_threads[].
Jim Cownie5e8470a2013-09-27 10:38:44 +0000569
Jonathan Peyton30419822017-05-12 18:01:32 +0000570 // TODO: does it make sense to check __kmp_roots[] ?
Jim Cownie5e8470a2013-09-27 10:38:44 +0000571
Jonathan Peyton30419822017-05-12 18:01:32 +0000572 // Let's check that there are no other alive threads registered with the OMP
573 // lib.
574 while (1) {
575 thread_count = 0;
576 for (i = 0; i < __kmp_threads_capacity; ++i) {
577 if (!__kmp_threads)
578 continue;
579 kmp_info_t *th = __kmp_threads[i];
580 if (th == NULL)
581 continue;
582 int gtid = th->th.th_info.ds.ds_gtid;
583 if (gtid == gtid_req)
584 continue;
585 if (gtid < 0)
586 continue;
587 DWORD exit_val;
588 int alive = __kmp_is_thread_alive(th, &exit_val);
589 if (alive) {
590 ++thread_count;
591 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000592 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000593 if (thread_count == 0)
594 break; // success
595 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000596
Jonathan Peyton30419822017-05-12 18:01:32 +0000597 // Assume that I'm alone. Now it might be safe to check and reset locks.
598 // __kmp_forkjoin_lock and __kmp_stdio_lock are expected to be reset.
599 __kmp_reset_lock(&__kmp_forkjoin_lock);
600#ifdef KMP_DEBUG
601 __kmp_reset_lock(&__kmp_stdio_lock);
602#endif // KMP_DEBUG
Jim Cownie5e8470a2013-09-27 10:38:44 +0000603}
604
Jonathan Peyton30419822017-05-12 18:01:32 +0000605BOOL WINAPI DllMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID lpReserved) {
606 //__kmp_acquire_bootstrap_lock( &__kmp_initz_lock );
Jim Cownie5e8470a2013-09-27 10:38:44 +0000607
Jonathan Peyton30419822017-05-12 18:01:32 +0000608 switch (fdwReason) {
Jim Cownie5e8470a2013-09-27 10:38:44 +0000609
Jonathan Peyton30419822017-05-12 18:01:32 +0000610 case DLL_PROCESS_ATTACH:
611 KA_TRACE(10, ("DllMain: PROCESS_ATTACH\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +0000612
613 return TRUE;
Jonathan Peyton30419822017-05-12 18:01:32 +0000614
615 case DLL_PROCESS_DETACH:
616 KA_TRACE(10, ("DllMain: PROCESS_DETACH T#%d\n", __kmp_gtid_get_specific()));
617
618 if (lpReserved != NULL) {
619 // lpReserved is used for telling the difference:
620 // lpReserved == NULL when FreeLibrary() was called,
621 // lpReserved != NULL when the process terminates.
622 // When FreeLibrary() is called, worker threads remain alive. So they will
623 // release the forkjoin lock by themselves. When the process terminates,
624 // worker threads disappear triggering the problem of unreleased forkjoin
625 // lock as described below.
626
627 // A worker thread can take the forkjoin lock. The problem comes up if
628 // that worker thread becomes dead before it releases the forkjoin lock.
629 // The forkjoin lock remains taken, while the thread executing
630 // DllMain()->PROCESS_DETACH->__kmp_internal_end_library() below will try
631 // to take the forkjoin lock and will always fail, so that the application
632 // will never finish [normally]. This scenario is possible if
633 // __kmpc_end() has not been executed. It looks like it's not a corner
634 // case, but common cases:
635 // - the main function was compiled by an alternative compiler;
636 // - the main function was compiled by icl but without /Qopenmp
637 // (application with plugins);
638 // - application terminates by calling C exit(), Fortran CALL EXIT() or
639 // Fortran STOP.
640 // - alive foreign thread prevented __kmpc_end from doing cleanup.
641 //
642 // This is a hack to work around the problem.
643 // TODO: !!! figure out something better.
644 __kmp_reset_locks_on_process_detach(__kmp_gtid_get_specific());
645 }
646
647 __kmp_internal_end_library(__kmp_gtid_get_specific());
648
649 return TRUE;
650
651 case DLL_THREAD_ATTACH:
652 KA_TRACE(10, ("DllMain: THREAD_ATTACH\n"));
653
654 /* if we want to register new siblings all the time here call
655 * __kmp_get_gtid(); */
656 return TRUE;
657
658 case DLL_THREAD_DETACH:
659 KA_TRACE(10, ("DllMain: THREAD_DETACH T#%d\n", __kmp_gtid_get_specific()));
660
661 __kmp_internal_end_thread(__kmp_gtid_get_specific());
662 return TRUE;
663 }
664
665 return TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000666}
667
Jonathan Peyton30419822017-05-12 18:01:32 +0000668#endif /* KMP_OS_WINDOWS */
Jonathan Peyton99016992015-05-26 17:32:53 +0000669#endif /* KMP_DYNAMIC_LIB */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000670
Jonathan Peyton30419822017-05-12 18:01:32 +0000671/* __kmp_parallel_deo -- Wait until it's our turn. */
672void __kmp_parallel_deo(int *gtid_ref, int *cid_ref, ident_t *loc_ref) {
673 int gtid = *gtid_ref;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000674#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000675 kmp_team_t *team = __kmp_team_from_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000676#endif /* BUILD_PARALLEL_ORDERED */
677
Jonathan Peyton30419822017-05-12 18:01:32 +0000678 if (__kmp_env_consistency_check) {
679 if (__kmp_threads[gtid]->th.th_root->r.r_active)
Andrey Churbanov5c56fb52015-02-20 18:05:17 +0000680#if KMP_USE_DYNAMIC_LOCK
Jonathan Peyton30419822017-05-12 18:01:32 +0000681 __kmp_push_sync(gtid, ct_ordered_in_parallel, loc_ref, NULL, 0);
Andrey Churbanov5c56fb52015-02-20 18:05:17 +0000682#else
Jonathan Peyton30419822017-05-12 18:01:32 +0000683 __kmp_push_sync(gtid, ct_ordered_in_parallel, loc_ref, NULL);
Andrey Churbanov5c56fb52015-02-20 18:05:17 +0000684#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000685 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000686#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000687 if (!team->t.t_serialized) {
688 KMP_MB();
Jonathan Peytone47d32f2019-02-28 19:11:29 +0000689 KMP_WAIT(&team->t.t_ordered.dt.t_value, __kmp_tid_from_gtid(gtid), KMP_EQ,
690 NULL);
Jonathan Peyton30419822017-05-12 18:01:32 +0000691 KMP_MB();
692 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000693#endif /* BUILD_PARALLEL_ORDERED */
694}
695
Jonathan Peyton30419822017-05-12 18:01:32 +0000696/* __kmp_parallel_dxo -- Signal the next task. */
697void __kmp_parallel_dxo(int *gtid_ref, int *cid_ref, ident_t *loc_ref) {
698 int gtid = *gtid_ref;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000699#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000700 int tid = __kmp_tid_from_gtid(gtid);
701 kmp_team_t *team = __kmp_team_from_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000702#endif /* BUILD_PARALLEL_ORDERED */
703
Jonathan Peyton30419822017-05-12 18:01:32 +0000704 if (__kmp_env_consistency_check) {
705 if (__kmp_threads[gtid]->th.th_root->r.r_active)
706 __kmp_pop_sync(gtid, ct_ordered_in_parallel, loc_ref);
707 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000708#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000709 if (!team->t.t_serialized) {
710 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000711
Jonathan Peyton30419822017-05-12 18:01:32 +0000712 /* use the tid of the next thread in this team */
713 /* TODO replace with general release procedure */
714 team->t.t_ordered.dt.t_value = ((tid + 1) % team->t.t_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000715
Jonathan Peyton30419822017-05-12 18:01:32 +0000716 KMP_MB(); /* Flush all pending memory write invalidates. */
717 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000718#endif /* BUILD_PARALLEL_ORDERED */
719}
720
721/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000722/* The BARRIER for a SINGLE process section is always explicit */
723
Jonathan Peyton30419822017-05-12 18:01:32 +0000724int __kmp_enter_single(int gtid, ident_t *id_ref, int push_ws) {
725 int status;
726 kmp_info_t *th;
727 kmp_team_t *team;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000728
Jonathan Peyton30419822017-05-12 18:01:32 +0000729 if (!TCR_4(__kmp_init_parallel))
730 __kmp_parallel_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000731
Jonathan Peyton9b8bb322019-01-16 20:07:39 +0000732#if OMP_50_ENABLED
733 __kmp_resume_if_soft_paused();
734#endif
735
Jonathan Peyton30419822017-05-12 18:01:32 +0000736 th = __kmp_threads[gtid];
737 team = th->th.th_team;
738 status = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000739
Jonathan Peyton30419822017-05-12 18:01:32 +0000740 th->th.th_ident = id_ref;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000741
Jonathan Peyton30419822017-05-12 18:01:32 +0000742 if (team->t.t_serialized) {
743 status = 1;
744 } else {
745 kmp_int32 old_this = th->th.th_local.this_construct;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000746
Jonathan Peyton30419822017-05-12 18:01:32 +0000747 ++th->th.th_local.this_construct;
748 /* try to set team count to thread count--success means thread got the
749 single block */
750 /* TODO: Should this be acquire or release? */
751 if (team->t.t_construct == old_this) {
Jonathan Peyton37e2ef52018-07-09 17:36:22 +0000752 status = __kmp_atomic_compare_store_acq(&team->t.t_construct, old_this,
753 th->th.th_local.this_construct);
Jonathan Peyton30419822017-05-12 18:01:32 +0000754 }
Andrey Churbanov51aecb82015-05-06 19:22:36 +0000755#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +0000756 if (__itt_metadata_add_ptr && __kmp_forkjoin_frames_mode == 3 &&
757 KMP_MASTER_GTID(gtid) &&
Andrey Churbanov51aecb82015-05-06 19:22:36 +0000758#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +0000759 th->th.th_teams_microtask == NULL &&
Andrey Churbanov51aecb82015-05-06 19:22:36 +0000760#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000761 team->t.t_active_level ==
762 1) { // Only report metadata by master of active team at level 1
763 __kmp_itt_metadata_single(id_ref);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000764 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000765#endif /* USE_ITT_BUILD */
766 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000767
Jonathan Peyton30419822017-05-12 18:01:32 +0000768 if (__kmp_env_consistency_check) {
769 if (status && push_ws) {
770 __kmp_push_workshare(gtid, ct_psingle, id_ref);
771 } else {
772 __kmp_check_workshare(gtid, ct_psingle, id_ref);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000773 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000774 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000775#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +0000776 if (status) {
777 __kmp_itt_single_start(gtid);
778 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000779#endif /* USE_ITT_BUILD */
Jonathan Peyton30419822017-05-12 18:01:32 +0000780 return status;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000781}
782
Jonathan Peyton30419822017-05-12 18:01:32 +0000783void __kmp_exit_single(int gtid) {
Jim Cownie5e8470a2013-09-27 10:38:44 +0000784#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +0000785 __kmp_itt_single_end(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000786#endif /* USE_ITT_BUILD */
Jonathan Peyton30419822017-05-12 18:01:32 +0000787 if (__kmp_env_consistency_check)
788 __kmp_pop_workshare(gtid, ct_psingle, NULL);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000789}
790
Jonathan Peyton30419822017-05-12 18:01:32 +0000791/* determine if we can go parallel or must use a serialized parallel region and
Jim Cownie5e8470a2013-09-27 10:38:44 +0000792 * how many threads we can use
793 * set_nproc is the number of threads requested for the team
794 * returns 0 if we should serialize or only use one thread,
795 * otherwise the number of threads to use
Jonathan Peyton30419822017-05-12 18:01:32 +0000796 * The forkjoin lock is held by the caller. */
797static int __kmp_reserve_threads(kmp_root_t *root, kmp_team_t *parent_team,
798 int master_tid, int set_nthreads
Jim Cownie5e8470a2013-09-27 10:38:44 +0000799#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +0000800 ,
801 int enter_teams
Jim Cownie5e8470a2013-09-27 10:38:44 +0000802#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +0000803 ) {
804 int capacity;
805 int new_nthreads;
806 KMP_DEBUG_ASSERT(__kmp_init_serial);
807 KMP_DEBUG_ASSERT(root && parent_team);
Jonathan Peyton65ebfee2019-02-11 21:04:23 +0000808 kmp_info_t *this_thr = parent_team->t.t_threads[master_tid];
Jim Cownie5e8470a2013-09-27 10:38:44 +0000809
Jonathan Peyton30419822017-05-12 18:01:32 +0000810 // If dyn-var is set, dynamically adjust the number of desired threads,
811 // according to the method specified by dynamic_mode.
812 new_nthreads = set_nthreads;
813 if (!get__dynamic_2(parent_team, master_tid)) {
814 ;
815 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000816#ifdef USE_LOAD_BALANCE
Jonathan Peyton30419822017-05-12 18:01:32 +0000817 else if (__kmp_global.g.g_dynamic_mode == dynamic_load_balance) {
818 new_nthreads = __kmp_load_balance_nproc(root, set_nthreads);
819 if (new_nthreads == 1) {
820 KC_TRACE(10, ("__kmp_reserve_threads: T#%d load balance reduced "
821 "reservation to 1 thread\n",
822 master_tid));
823 return 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000824 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000825 if (new_nthreads < set_nthreads) {
826 KC_TRACE(10, ("__kmp_reserve_threads: T#%d load balance reduced "
827 "reservation to %d threads\n",
828 master_tid, new_nthreads));
829 }
830 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000831#endif /* USE_LOAD_BALANCE */
Jonathan Peyton30419822017-05-12 18:01:32 +0000832 else if (__kmp_global.g.g_dynamic_mode == dynamic_thread_limit) {
833 new_nthreads = __kmp_avail_proc - __kmp_nth +
834 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
835 if (new_nthreads <= 1) {
836 KC_TRACE(10, ("__kmp_reserve_threads: T#%d thread limit reduced "
837 "reservation to 1 thread\n",
838 master_tid));
839 return 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000840 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000841 if (new_nthreads < set_nthreads) {
842 KC_TRACE(10, ("__kmp_reserve_threads: T#%d thread limit reduced "
843 "reservation to %d threads\n",
844 master_tid, new_nthreads));
845 } else {
846 new_nthreads = set_nthreads;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000847 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000848 } else if (__kmp_global.g.g_dynamic_mode == dynamic_random) {
849 if (set_nthreads > 2) {
850 new_nthreads = __kmp_get_random(parent_team->t.t_threads[master_tid]);
851 new_nthreads = (new_nthreads % set_nthreads) + 1;
852 if (new_nthreads == 1) {
853 KC_TRACE(10, ("__kmp_reserve_threads: T#%d dynamic random reduced "
854 "reservation to 1 thread\n",
855 master_tid));
Jim Cownie5e8470a2013-09-27 10:38:44 +0000856 return 1;
Jonathan Peyton30419822017-05-12 18:01:32 +0000857 }
858 if (new_nthreads < set_nthreads) {
859 KC_TRACE(10, ("__kmp_reserve_threads: T#%d dynamic random reduced "
860 "reservation to %d threads\n",
861 master_tid, new_nthreads));
862 }
863 }
864 } else {
865 KMP_ASSERT(0);
866 }
867
Jonathan Peytonf4392462017-07-27 20:58:41 +0000868 // Respect KMP_ALL_THREADS/KMP_DEVICE_THREAD_LIMIT.
Jonathan Peyton30419822017-05-12 18:01:32 +0000869 if (__kmp_nth + new_nthreads -
870 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) >
871 __kmp_max_nth) {
872 int tl_nthreads = __kmp_max_nth - __kmp_nth +
873 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
874 if (tl_nthreads <= 0) {
875 tl_nthreads = 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000876 }
877
Jonathan Peyton30419822017-05-12 18:01:32 +0000878 // If dyn-var is false, emit a 1-time warning.
879 if (!get__dynamic_2(parent_team, master_tid) && (!__kmp_reserve_warn)) {
880 __kmp_reserve_warn = 1;
881 __kmp_msg(kmp_ms_warning,
882 KMP_MSG(CantFormThrTeam, set_nthreads, tl_nthreads),
883 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
884 }
885 if (tl_nthreads == 1) {
Jonathan Peytonf4392462017-07-27 20:58:41 +0000886 KC_TRACE(10, ("__kmp_reserve_threads: T#%d KMP_DEVICE_THREAD_LIMIT "
887 "reduced reservation to 1 thread\n",
Jonathan Peyton30419822017-05-12 18:01:32 +0000888 master_tid));
889 return 1;
890 }
Jonathan Peytonf4392462017-07-27 20:58:41 +0000891 KC_TRACE(10, ("__kmp_reserve_threads: T#%d KMP_DEVICE_THREAD_LIMIT reduced "
892 "reservation to %d threads\n",
893 master_tid, tl_nthreads));
894 new_nthreads = tl_nthreads;
895 }
896
897 // Respect OMP_THREAD_LIMIT
Jonathan Peyton65ebfee2019-02-11 21:04:23 +0000898 int cg_nthreads = this_thr->th.th_cg_roots->cg_nthreads;
899 int max_cg_threads = this_thr->th.th_cg_roots->cg_thread_limit;
900 if (cg_nthreads + new_nthreads -
Jonathan Peytonf4392462017-07-27 20:58:41 +0000901 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) >
Jonathan Peyton65ebfee2019-02-11 21:04:23 +0000902 max_cg_threads) {
903 int tl_nthreads = max_cg_threads - cg_nthreads +
Jonathan Peytonf4392462017-07-27 20:58:41 +0000904 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
905 if (tl_nthreads <= 0) {
906 tl_nthreads = 1;
907 }
908
909 // If dyn-var is false, emit a 1-time warning.
910 if (!get__dynamic_2(parent_team, master_tid) && (!__kmp_reserve_warn)) {
911 __kmp_reserve_warn = 1;
912 __kmp_msg(kmp_ms_warning,
913 KMP_MSG(CantFormThrTeam, set_nthreads, tl_nthreads),
914 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
915 }
916 if (tl_nthreads == 1) {
917 KC_TRACE(10, ("__kmp_reserve_threads: T#%d OMP_THREAD_LIMIT "
918 "reduced reservation to 1 thread\n",
919 master_tid));
920 return 1;
921 }
922 KC_TRACE(10, ("__kmp_reserve_threads: T#%d OMP_THREAD_LIMIT reduced "
Jonathan Peyton30419822017-05-12 18:01:32 +0000923 "reservation to %d threads\n",
924 master_tid, tl_nthreads));
925 new_nthreads = tl_nthreads;
926 }
927
928 // Check if the threads array is large enough, or needs expanding.
Jonathan Peyton30419822017-05-12 18:01:32 +0000929 // See comment in __kmp_register_root() about the adjustment if
930 // __kmp_threads[0] == NULL.
931 capacity = __kmp_threads_capacity;
932 if (TCR_PTR(__kmp_threads[0]) == NULL) {
933 --capacity;
934 }
935 if (__kmp_nth + new_nthreads -
936 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) >
937 capacity) {
938 // Expand the threads array.
939 int slotsRequired = __kmp_nth + new_nthreads -
940 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) -
941 capacity;
Jonathan Peyton1800ece2018-01-10 18:27:01 +0000942 int slotsAdded = __kmp_expand_threads(slotsRequired);
Jonathan Peyton30419822017-05-12 18:01:32 +0000943 if (slotsAdded < slotsRequired) {
944 // The threads array was not expanded enough.
945 new_nthreads -= (slotsRequired - slotsAdded);
946 KMP_ASSERT(new_nthreads >= 1);
947
948 // If dyn-var is false, emit a 1-time warning.
949 if (!get__dynamic_2(parent_team, master_tid) && (!__kmp_reserve_warn)) {
950 __kmp_reserve_warn = 1;
951 if (__kmp_tp_cached) {
952 __kmp_msg(kmp_ms_warning,
953 KMP_MSG(CantFormThrTeam, set_nthreads, new_nthreads),
954 KMP_HNT(Set_ALL_THREADPRIVATE, __kmp_tp_capacity),
955 KMP_HNT(PossibleSystemLimitOnThreads), __kmp_msg_null);
956 } else {
957 __kmp_msg(kmp_ms_warning,
958 KMP_MSG(CantFormThrTeam, set_nthreads, new_nthreads),
959 KMP_HNT(SystemLimitOnThreads), __kmp_msg_null);
960 }
961 }
962 }
963 }
964
Jonathan Peyton642688b2017-06-01 16:46:36 +0000965#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +0000966 if (new_nthreads == 1) {
967 KC_TRACE(10,
968 ("__kmp_reserve_threads: T#%d serializing team after reclaiming "
969 "dead roots and rechecking; requested %d threads\n",
970 __kmp_get_gtid(), set_nthreads));
Jonathan Peyton642688b2017-06-01 16:46:36 +0000971 } else {
972 KC_TRACE(10, ("__kmp_reserve_threads: T#%d allocating %d threads; requested"
973 " %d threads\n",
974 __kmp_get_gtid(), new_nthreads, set_nthreads));
Jonathan Peyton30419822017-05-12 18:01:32 +0000975 }
Jonathan Peyton642688b2017-06-01 16:46:36 +0000976#endif // KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +0000977 return new_nthreads;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000978}
979
Jonathan Peyton30419822017-05-12 18:01:32 +0000980/* Allocate threads from the thread pool and assign them to the new team. We are
981 assured that there are enough threads available, because we checked on that
982 earlier within critical section forkjoin */
983static void __kmp_fork_team_threads(kmp_root_t *root, kmp_team_t *team,
984 kmp_info_t *master_th, int master_gtid) {
985 int i;
986 int use_hot_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000987
Jonathan Peyton30419822017-05-12 18:01:32 +0000988 KA_TRACE(10, ("__kmp_fork_team_threads: new_nprocs = %d\n", team->t.t_nproc));
989 KMP_DEBUG_ASSERT(master_gtid == __kmp_get_gtid());
990 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000991
Jonathan Peyton30419822017-05-12 18:01:32 +0000992 /* first, let's setup the master thread */
993 master_th->th.th_info.ds.ds_tid = 0;
994 master_th->th.th_team = team;
995 master_th->th.th_team_nproc = team->t.t_nproc;
996 master_th->th.th_team_master = master_th;
997 master_th->th.th_team_serialized = FALSE;
998 master_th->th.th_dispatch = &team->t.t_dispatch[0];
Jim Cownie5e8470a2013-09-27 10:38:44 +0000999
Jonathan Peyton30419822017-05-12 18:01:32 +00001000/* make sure we are not the optimized hot team */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001001#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00001002 use_hot_team = 0;
1003 kmp_hot_team_ptr_t *hot_teams = master_th->th.th_hot_teams;
1004 if (hot_teams) { // hot teams array is not allocated if
1005 // KMP_HOT_TEAMS_MAX_LEVEL=0
1006 int level = team->t.t_active_level - 1; // index in array of hot teams
1007 if (master_th->th.th_teams_microtask) { // are we inside the teams?
1008 if (master_th->th.th_teams_size.nteams > 1) {
1009 ++level; // level was not increased in teams construct for
1010 // team_of_masters
1011 }
1012 if (team->t.t_pkfn != (microtask_t)__kmp_teams_master &&
1013 master_th->th.th_teams_level == team->t.t_level) {
1014 ++level; // level was not increased in teams construct for
1015 // team_of_workers before the parallel
1016 } // team->t.t_level will be increased inside parallel
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001017 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001018 if (level < __kmp_hot_teams_max_level) {
1019 if (hot_teams[level].hot_team) {
1020 // hot team has already been allocated for given level
1021 KMP_DEBUG_ASSERT(hot_teams[level].hot_team == team);
1022 use_hot_team = 1; // the team is ready to use
1023 } else {
1024 use_hot_team = 0; // AC: threads are not allocated yet
1025 hot_teams[level].hot_team = team; // remember new hot team
1026 hot_teams[level].hot_team_nth = team->t.t_nproc;
1027 }
1028 } else {
1029 use_hot_team = 0;
1030 }
1031 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001032#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001033 use_hot_team = team == root->r.r_hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001034#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001035 if (!use_hot_team) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00001036
Jonathan Peyton30419822017-05-12 18:01:32 +00001037 /* install the master thread */
1038 team->t.t_threads[0] = master_th;
1039 __kmp_initialize_info(master_th, team, 0, master_gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001040
Jonathan Peyton30419822017-05-12 18:01:32 +00001041 /* now, install the worker threads */
1042 for (i = 1; i < team->t.t_nproc; i++) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00001043
Jonathan Peyton30419822017-05-12 18:01:32 +00001044 /* fork or reallocate a new thread and install it in team */
1045 kmp_info_t *thr = __kmp_allocate_thread(root, team, i);
1046 team->t.t_threads[i] = thr;
1047 KMP_DEBUG_ASSERT(thr);
1048 KMP_DEBUG_ASSERT(thr->th.th_team == team);
1049 /* align team and thread arrived states */
1050 KA_TRACE(20, ("__kmp_fork_team_threads: T#%d(%d:%d) init arrived "
1051 "T#%d(%d:%d) join =%llu, plain=%llu\n",
1052 __kmp_gtid_from_tid(0, team), team->t.t_id, 0,
1053 __kmp_gtid_from_tid(i, team), team->t.t_id, i,
1054 team->t.t_bar[bs_forkjoin_barrier].b_arrived,
1055 team->t.t_bar[bs_plain_barrier].b_arrived));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001056#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001057 thr->th.th_teams_microtask = master_th->th.th_teams_microtask;
1058 thr->th.th_teams_level = master_th->th.th_teams_level;
1059 thr->th.th_teams_size = master_th->th.th_teams_size;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001060#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001061 { // Initialize threads' barrier data.
1062 int b;
1063 kmp_balign_t *balign = team->t.t_threads[i]->th.th_bar;
1064 for (b = 0; b < bs_last_barrier; ++b) {
1065 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
1066 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001067#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00001068 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001069#endif
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00001070 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001071 }
1072 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001073
Alp Toker98758b02014-03-02 04:12:06 +00001074#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00001075 __kmp_partition_places(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001076#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001077 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001078
Jonathan Peyton6d88e042018-12-13 23:14:24 +00001079#if OMP_50_ENABLED
1080 if (__kmp_display_affinity && team->t.t_display_affinity != 1) {
1081 for (i = 0; i < team->t.t_nproc; i++) {
1082 kmp_info_t *thr = team->t.t_threads[i];
1083 if (thr->th.th_prev_num_threads != team->t.t_nproc ||
1084 thr->th.th_prev_level != team->t.t_level) {
1085 team->t.t_display_affinity = 1;
1086 break;
1087 }
1088 }
1089 }
1090#endif
1091
Jonathan Peyton30419822017-05-12 18:01:32 +00001092 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00001093}
1094
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001095#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001096// Propagate any changes to the floating point control registers out to the team
Jonathan Peyton30419822017-05-12 18:01:32 +00001097// We try to avoid unnecessary writes to the relevant cache line in the team
1098// structure, so we don't make changes unless they are needed.
1099inline static void propagateFPControl(kmp_team_t *team) {
1100 if (__kmp_inherit_fp_control) {
1101 kmp_int16 x87_fpu_control_word;
1102 kmp_uint32 mxcsr;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001103
Jonathan Peyton30419822017-05-12 18:01:32 +00001104 // Get master values of FPU control flags (both X87 and vector)
1105 __kmp_store_x87_fpu_control_word(&x87_fpu_control_word);
1106 __kmp_store_mxcsr(&mxcsr);
1107 mxcsr &= KMP_X86_MXCSR_MASK;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001108
Jonathan Peyton94a114f2017-10-20 19:30:57 +00001109 // There is no point looking at t_fp_control_saved here.
1110 // If it is TRUE, we still have to update the values if they are different
Jonas Hahnfeldf0a1c652017-11-03 18:28:19 +00001111 // from those we now have. If it is FALSE we didn't save anything yet, but
1112 // our objective is the same. We have to ensure that the values in the team
1113 // are the same as those we have.
Jonathan Peyton94a114f2017-10-20 19:30:57 +00001114 // So, this code achieves what we need whether or not t_fp_control_saved is
1115 // true. By checking whether the value needs updating we avoid unnecessary
1116 // writes that would put the cache-line into a written state, causing all
1117 // threads in the team to have to read it again.
Jonathan Peyton30419822017-05-12 18:01:32 +00001118 KMP_CHECK_UPDATE(team->t.t_x87_fpu_control_word, x87_fpu_control_word);
1119 KMP_CHECK_UPDATE(team->t.t_mxcsr, mxcsr);
1120 // Although we don't use this value, other code in the runtime wants to know
1121 // whether it should restore them. So we must ensure it is correct.
1122 KMP_CHECK_UPDATE(team->t.t_fp_control_saved, TRUE);
1123 } else {
1124 // Similarly here. Don't write to this cache-line in the team structure
1125 // unless we have to.
1126 KMP_CHECK_UPDATE(team->t.t_fp_control_saved, FALSE);
1127 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001128}
1129
Jonathan Peyton30419822017-05-12 18:01:32 +00001130// Do the opposite, setting the hardware registers to the updated values from
1131// the team.
1132inline static void updateHWFPControl(kmp_team_t *team) {
1133 if (__kmp_inherit_fp_control && team->t.t_fp_control_saved) {
1134 // Only reset the fp control regs if they have been changed in the team.
1135 // the parallel region that we are exiting.
1136 kmp_int16 x87_fpu_control_word;
1137 kmp_uint32 mxcsr;
1138 __kmp_store_x87_fpu_control_word(&x87_fpu_control_word);
1139 __kmp_store_mxcsr(&mxcsr);
1140 mxcsr &= KMP_X86_MXCSR_MASK;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001141
Jonathan Peyton30419822017-05-12 18:01:32 +00001142 if (team->t.t_x87_fpu_control_word != x87_fpu_control_word) {
1143 __kmp_clear_x87_fpu_status_word();
1144 __kmp_load_x87_fpu_control_word(&team->t.t_x87_fpu_control_word);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001145 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001146
1147 if (team->t.t_mxcsr != mxcsr) {
1148 __kmp_load_mxcsr(&team->t.t_mxcsr);
1149 }
1150 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001151}
1152#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001153#define propagateFPControl(x) ((void)0)
1154#define updateHWFPControl(x) ((void)0)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001155#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
1156
Jonathan Peyton30419822017-05-12 18:01:32 +00001157static void __kmp_alloc_argv_entries(int argc, kmp_team_t *team,
1158 int realloc); // forward declaration
Jim Cownie5e8470a2013-09-27 10:38:44 +00001159
Jonathan Peyton30419822017-05-12 18:01:32 +00001160/* Run a parallel region that has been serialized, so runs only in a team of the
1161 single master thread. */
1162void __kmp_serialized_parallel(ident_t *loc, kmp_int32 global_tid) {
1163 kmp_info_t *this_thr;
1164 kmp_team_t *serial_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001165
Jonathan Peyton30419822017-05-12 18:01:32 +00001166 KC_TRACE(10, ("__kmpc_serialized_parallel: called by T#%d\n", global_tid));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001167
Jonathan Peyton30419822017-05-12 18:01:32 +00001168 /* Skip all this code for autopar serialized loops since it results in
1169 unacceptable overhead */
1170 if (loc != NULL && (loc->flags & KMP_IDENT_AUTOPAR))
1171 return;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001172
Jonathan Peyton30419822017-05-12 18:01:32 +00001173 if (!TCR_4(__kmp_init_parallel))
1174 __kmp_parallel_initialize();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001175
Jonathan Peyton9b8bb322019-01-16 20:07:39 +00001176#if OMP_50_ENABLED
1177 __kmp_resume_if_soft_paused();
1178#endif
1179
Jonathan Peyton30419822017-05-12 18:01:32 +00001180 this_thr = __kmp_threads[global_tid];
1181 serial_team = this_thr->th.th_serial_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001182
Jonathan Peyton30419822017-05-12 18:01:32 +00001183 /* utilize the serialized team held by this thread */
1184 KMP_DEBUG_ASSERT(serial_team);
1185 KMP_MB();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001186
Jonathan Peyton30419822017-05-12 18:01:32 +00001187 if (__kmp_tasking_mode != tskm_immediate_exec) {
1188 KMP_DEBUG_ASSERT(
1189 this_thr->th.th_task_team ==
1190 this_thr->th.th_team->t.t_task_team[this_thr->th.th_task_state]);
1191 KMP_DEBUG_ASSERT(serial_team->t.t_task_team[this_thr->th.th_task_state] ==
1192 NULL);
1193 KA_TRACE(20, ("__kmpc_serialized_parallel: T#%d pushing task_team %p / "
1194 "team %p, new task_team = NULL\n",
1195 global_tid, this_thr->th.th_task_team, this_thr->th.th_team));
1196 this_thr->th.th_task_team = NULL;
1197 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001198
1199#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001200 kmp_proc_bind_t proc_bind = this_thr->th.th_set_proc_bind;
1201 if (this_thr->th.th_current_task->td_icvs.proc_bind == proc_bind_false) {
1202 proc_bind = proc_bind_false;
1203 } else if (proc_bind == proc_bind_default) {
1204 // No proc_bind clause was specified, so use the current value
1205 // of proc-bind-var for this parallel region.
1206 proc_bind = this_thr->th.th_current_task->td_icvs.proc_bind;
1207 }
1208 // Reset for next parallel region
1209 this_thr->th.th_set_proc_bind = proc_bind_default;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001210#endif /* OMP_40_ENABLED */
1211
Joachim Protze82e94a52017-11-01 10:08:30 +00001212#if OMPT_SUPPORT
Jonathan Peyton3574f282018-10-04 14:57:04 +00001213 ompt_data_t ompt_parallel_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00001214 ompt_data_t *implicit_task_data;
1215 void *codeptr = OMPT_LOAD_RETURN_ADDRESS(global_tid);
1216 if (ompt_enabled.enabled &&
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001217 this_thr->th.ompt_thread_info.state != ompt_state_overhead) {
Joachim Protze82e94a52017-11-01 10:08:30 +00001218
1219 ompt_task_info_t *parent_task_info;
1220 parent_task_info = OMPT_CUR_TASK_INFO(this_thr);
1221
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001222 parent_task_info->frame.enter_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
Joachim Protze82e94a52017-11-01 10:08:30 +00001223 if (ompt_enabled.ompt_callback_parallel_begin) {
1224 int team_size = 1;
1225
1226 ompt_callbacks.ompt_callback(ompt_callback_parallel_begin)(
1227 &(parent_task_info->task_data), &(parent_task_info->frame),
Joachim Protze489cdb72018-09-10 14:34:54 +00001228 &ompt_parallel_data, team_size, ompt_parallel_invoker_program,
1229 codeptr);
Joachim Protze82e94a52017-11-01 10:08:30 +00001230 }
1231 }
1232#endif // OMPT_SUPPORT
1233
Jonathan Peyton30419822017-05-12 18:01:32 +00001234 if (this_thr->th.th_team != serial_team) {
1235 // Nested level will be an index in the nested nthreads array
1236 int level = this_thr->th.th_team->t.t_level;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001237
Jonathan Peyton30419822017-05-12 18:01:32 +00001238 if (serial_team->t.t_serialized) {
1239 /* this serial team was already used
1240 TODO increase performance by making this locks more specific */
1241 kmp_team_t *new_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001242
Jonathan Peyton30419822017-05-12 18:01:32 +00001243 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001244
Jonathan Peyton30419822017-05-12 18:01:32 +00001245 new_team = __kmp_allocate_team(this_thr->th.th_root, 1, 1,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001246#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001247 ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001248#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001249#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001250 proc_bind,
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001251#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001252 &this_thr->th.th_current_task->td_icvs,
1253 0 USE_NESTED_HOT_ARG(NULL));
1254 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
1255 KMP_ASSERT(new_team);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001256
Jonathan Peyton30419822017-05-12 18:01:32 +00001257 /* setup new serialized team and install it */
1258 new_team->t.t_threads[0] = this_thr;
1259 new_team->t.t_parent = this_thr->th.th_team;
1260 serial_team = new_team;
1261 this_thr->th.th_serial_team = serial_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001262
Jonathan Peyton30419822017-05-12 18:01:32 +00001263 KF_TRACE(
1264 10,
1265 ("__kmpc_serialized_parallel: T#%d allocated new serial team %p\n",
1266 global_tid, serial_team));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001267
Jonathan Peyton30419822017-05-12 18:01:32 +00001268 /* TODO the above breaks the requirement that if we run out of resources,
1269 then we can still guarantee that serialized teams are ok, since we may
1270 need to allocate a new one */
1271 } else {
1272 KF_TRACE(
1273 10,
1274 ("__kmpc_serialized_parallel: T#%d reusing cached serial team %p\n",
1275 global_tid, serial_team));
1276 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001277
Jonathan Peyton30419822017-05-12 18:01:32 +00001278 /* we have to initialize this serial team */
1279 KMP_DEBUG_ASSERT(serial_team->t.t_threads);
1280 KMP_DEBUG_ASSERT(serial_team->t.t_threads[0] == this_thr);
1281 KMP_DEBUG_ASSERT(this_thr->th.th_team != serial_team);
1282 serial_team->t.t_ident = loc;
1283 serial_team->t.t_serialized = 1;
1284 serial_team->t.t_nproc = 1;
1285 serial_team->t.t_parent = this_thr->th.th_team;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00001286 serial_team->t.t_sched.sched = this_thr->th.th_team->t.t_sched.sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00001287 this_thr->th.th_team = serial_team;
1288 serial_team->t.t_master_tid = this_thr->th.th_info.ds.ds_tid;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001289
Jonathan Peyton30419822017-05-12 18:01:32 +00001290 KF_TRACE(10, ("__kmpc_serialized_parallel: T#d curtask=%p\n", global_tid,
1291 this_thr->th.th_current_task));
1292 KMP_ASSERT(this_thr->th.th_current_task->td_flags.executing == 1);
1293 this_thr->th.th_current_task->td_flags.executing = 0;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001294
Jonathan Peyton30419822017-05-12 18:01:32 +00001295 __kmp_push_current_task_to_thread(this_thr, serial_team, 0);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001296
Jonathan Peyton30419822017-05-12 18:01:32 +00001297 /* TODO: GEH: do ICVs work for nested serialized teams? Don't we need an
1298 implicit task for each serialized task represented by
1299 team->t.t_serialized? */
1300 copy_icvs(&this_thr->th.th_current_task->td_icvs,
1301 &this_thr->th.th_current_task->td_parent->td_icvs);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001302
Jonathan Peyton30419822017-05-12 18:01:32 +00001303 // Thread value exists in the nested nthreads array for the next nested
1304 // level
1305 if (__kmp_nested_nth.used && (level + 1 < __kmp_nested_nth.used)) {
1306 this_thr->th.th_current_task->td_icvs.nproc =
1307 __kmp_nested_nth.nth[level + 1];
1308 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001309
1310#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001311 if (__kmp_nested_proc_bind.used &&
1312 (level + 1 < __kmp_nested_proc_bind.used)) {
1313 this_thr->th.th_current_task->td_icvs.proc_bind =
1314 __kmp_nested_proc_bind.bind_types[level + 1];
1315 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001316#endif /* OMP_40_ENABLED */
1317
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001318#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00001319 serial_team->t.t_pkfn = (microtask_t)(~0); // For the debugger.
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001320#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001321 this_thr->th.th_info.ds.ds_tid = 0;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001322
Jonathan Peyton30419822017-05-12 18:01:32 +00001323 /* set thread cache values */
1324 this_thr->th.th_team_nproc = 1;
1325 this_thr->th.th_team_master = this_thr;
1326 this_thr->th.th_team_serialized = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001327
Jonathan Peyton30419822017-05-12 18:01:32 +00001328 serial_team->t.t_level = serial_team->t.t_parent->t.t_level + 1;
1329 serial_team->t.t_active_level = serial_team->t.t_parent->t.t_active_level;
Jonathan Peyton92ca6182018-09-07 18:25:49 +00001330#if OMP_50_ENABLED
1331 serial_team->t.t_def_allocator = this_thr->th.th_def_allocator; // save
1332#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001333
Jonathan Peyton30419822017-05-12 18:01:32 +00001334 propagateFPControl(serial_team);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001335
Jonathan Peyton30419822017-05-12 18:01:32 +00001336 /* check if we need to allocate dispatch buffers stack */
1337 KMP_DEBUG_ASSERT(serial_team->t.t_dispatch);
1338 if (!serial_team->t.t_dispatch->th_disp_buffer) {
1339 serial_team->t.t_dispatch->th_disp_buffer =
1340 (dispatch_private_info_t *)__kmp_allocate(
1341 sizeof(dispatch_private_info_t));
1342 }
1343 this_thr->th.th_dispatch = serial_team->t.t_dispatch;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001344
Jonathan Peyton30419822017-05-12 18:01:32 +00001345 KMP_MB();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001346
Jonathan Peyton30419822017-05-12 18:01:32 +00001347 } else {
1348 /* this serialized team is already being used,
1349 * that's fine, just add another nested level */
1350 KMP_DEBUG_ASSERT(this_thr->th.th_team == serial_team);
1351 KMP_DEBUG_ASSERT(serial_team->t.t_threads);
1352 KMP_DEBUG_ASSERT(serial_team->t.t_threads[0] == this_thr);
1353 ++serial_team->t.t_serialized;
1354 this_thr->th.th_team_serialized = serial_team->t.t_serialized;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001355
Jonathan Peyton30419822017-05-12 18:01:32 +00001356 // Nested level will be an index in the nested nthreads array
1357 int level = this_thr->th.th_team->t.t_level;
1358 // Thread value exists in the nested nthreads array for the next nested
1359 // level
1360 if (__kmp_nested_nth.used && (level + 1 < __kmp_nested_nth.used)) {
1361 this_thr->th.th_current_task->td_icvs.nproc =
1362 __kmp_nested_nth.nth[level + 1];
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001363 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001364 serial_team->t.t_level++;
1365 KF_TRACE(10, ("__kmpc_serialized_parallel: T#%d increasing nesting level "
1366 "of serial team %p to %d\n",
1367 global_tid, serial_team, serial_team->t.t_level));
1368
1369 /* allocate/push dispatch buffers stack */
1370 KMP_DEBUG_ASSERT(serial_team->t.t_dispatch);
1371 {
1372 dispatch_private_info_t *disp_buffer =
1373 (dispatch_private_info_t *)__kmp_allocate(
1374 sizeof(dispatch_private_info_t));
1375 disp_buffer->next = serial_team->t.t_dispatch->th_disp_buffer;
1376 serial_team->t.t_dispatch->th_disp_buffer = disp_buffer;
1377 }
1378 this_thr->th.th_dispatch = serial_team->t.t_dispatch;
1379
1380 KMP_MB();
1381 }
Olga Malyshevadbdcfa12017-04-04 13:56:50 +00001382#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001383 KMP_CHECK_UPDATE(serial_team->t.t_cancel_request, cancel_noreq);
Olga Malyshevadbdcfa12017-04-04 13:56:50 +00001384#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001385
Jonathan Peyton6d88e042018-12-13 23:14:24 +00001386#if OMP_50_ENABLED
1387 // Perform the display affinity functionality for
1388 // serialized parallel regions
1389 if (__kmp_display_affinity) {
1390 if (this_thr->th.th_prev_level != serial_team->t.t_level ||
1391 this_thr->th.th_prev_num_threads != 1) {
1392 // NULL means use the affinity-format-var ICV
1393 __kmp_aux_display_affinity(global_tid, NULL);
1394 this_thr->th.th_prev_level = serial_team->t.t_level;
1395 this_thr->th.th_prev_num_threads = 1;
1396 }
1397 }
1398#endif
1399
Jonathan Peyton30419822017-05-12 18:01:32 +00001400 if (__kmp_env_consistency_check)
1401 __kmp_push_parallel(global_tid, NULL);
Joachim Protze82e94a52017-11-01 10:08:30 +00001402#if OMPT_SUPPORT
1403 serial_team->t.ompt_team_info.master_return_address = codeptr;
1404 if (ompt_enabled.enabled &&
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001405 this_thr->th.ompt_thread_info.state != ompt_state_overhead) {
1406 OMPT_CUR_TASK_INFO(this_thr)->frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
Joachim Protze82e94a52017-11-01 10:08:30 +00001407
1408 ompt_lw_taskteam_t lw_taskteam;
1409 __ompt_lw_taskteam_init(&lw_taskteam, this_thr, global_tid,
1410 &ompt_parallel_data, codeptr);
1411
1412 __ompt_lw_taskteam_link(&lw_taskteam, this_thr, 1);
1413 // don't use lw_taskteam after linking. content was swaped
1414
1415 /* OMPT implicit task begin */
1416 implicit_task_data = OMPT_CUR_TASK_DATA(this_thr);
1417 if (ompt_enabled.ompt_callback_implicit_task) {
1418 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1419 ompt_scope_begin, OMPT_CUR_TEAM_DATA(this_thr),
Joachim Protze2b46d302019-01-15 15:36:53 +00001420 OMPT_CUR_TASK_DATA(this_thr), 1, __kmp_tid_from_gtid(global_tid), ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Joachim Protze9be9cf22018-05-07 12:42:21 +00001421 OMPT_CUR_TASK_INFO(this_thr)
1422 ->thread_num = __kmp_tid_from_gtid(global_tid);
Joachim Protze82e94a52017-11-01 10:08:30 +00001423 }
1424
1425 /* OMPT state */
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001426 this_thr->th.ompt_thread_info.state = ompt_state_work_parallel;
1427 OMPT_CUR_TASK_INFO(this_thr)->frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
Joachim Protze82e94a52017-11-01 10:08:30 +00001428 }
1429#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001430}
Jim Cownie181b4bb2013-12-23 17:28:57 +00001431
Jim Cownie5e8470a2013-09-27 10:38:44 +00001432/* most of the work for a fork */
1433/* return true if we really went parallel, false if serialized */
Jonathan Peyton30419822017-05-12 18:01:32 +00001434int __kmp_fork_call(ident_t *loc, int gtid,
1435 enum fork_context_e call_context, // Intel, GNU, ...
Joachim Protze82e94a52017-11-01 10:08:30 +00001436 kmp_int32 argc, microtask_t microtask, launch_t invoker,
Jim Cownie5e8470a2013-09-27 10:38:44 +00001437/* TODO: revert workaround for Intel(R) 64 tracker #96 */
Andrey Churbanovcbda8682015-01-13 14:43:35 +00001438#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00001439 va_list *ap
Jim Cownie5e8470a2013-09-27 10:38:44 +00001440#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001441 va_list ap
Jim Cownie5e8470a2013-09-27 10:38:44 +00001442#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001443 ) {
1444 void **argv;
1445 int i;
1446 int master_tid;
1447 int master_this_cons;
1448 kmp_team_t *team;
1449 kmp_team_t *parent_team;
1450 kmp_info_t *master_th;
1451 kmp_root_t *root;
1452 int nthreads;
1453 int master_active;
1454 int master_set_numthreads;
1455 int level;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001456#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001457 int active_level;
1458 int teams_level;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001459#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001460#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00001461 kmp_hot_team_ptr_t **p_hot_teams;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001462#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001463 { // KMP_TIME_BLOCK
Jonathan Peyton5375fe82016-11-14 21:13:44 +00001464 KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(KMP_fork_call);
Jonathan Peyton45be4502015-08-11 21:36:41 +00001465 KMP_COUNT_VALUE(OMP_PARALLEL_args, argc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001466
Jonathan Peyton30419822017-05-12 18:01:32 +00001467 KA_TRACE(20, ("__kmp_fork_call: enter T#%d\n", gtid));
1468 if (__kmp_stkpadding > 0 && __kmp_root[gtid] != NULL) {
1469 /* Some systems prefer the stack for the root thread(s) to start with */
1470 /* some gap from the parent stack to prevent false sharing. */
1471 void *dummy = KMP_ALLOCA(__kmp_stkpadding);
1472 /* These 2 lines below are so this does not get optimized out */
1473 if (__kmp_stkpadding > KMP_MAX_STKPADDING)
1474 __kmp_stkpadding += (short)((kmp_int64)dummy);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001475 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001476
1477 /* initialize if needed */
Jonathan Peyton30419822017-05-12 18:01:32 +00001478 KMP_DEBUG_ASSERT(
1479 __kmp_init_serial); // AC: potentially unsafe, not in sync with shutdown
1480 if (!TCR_4(__kmp_init_parallel))
1481 __kmp_parallel_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00001482
Jonathan Peyton9b8bb322019-01-16 20:07:39 +00001483#if OMP_50_ENABLED
1484 __kmp_resume_if_soft_paused();
1485#endif
1486
Jim Cownie5e8470a2013-09-27 10:38:44 +00001487 /* setup current data */
Jonathan Peyton30419822017-05-12 18:01:32 +00001488 master_th = __kmp_threads[gtid]; // AC: potentially unsafe, not in sync with
1489 // shutdown
1490 parent_team = master_th->th.th_team;
1491 master_tid = master_th->th.th_info.ds.ds_tid;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001492 master_this_cons = master_th->th.th_local.this_construct;
Jonathan Peyton30419822017-05-12 18:01:32 +00001493 root = master_th->th.th_root;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001494 master_active = root->r.r_active;
1495 master_set_numthreads = master_th->th.th_set_nproc;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001496
1497#if OMPT_SUPPORT
Jonathan Peyton3574f282018-10-04 14:57:04 +00001498 ompt_data_t ompt_parallel_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00001499 ompt_data_t *parent_task_data;
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001500 ompt_frame_t *ompt_frame;
Joachim Protze82e94a52017-11-01 10:08:30 +00001501 ompt_data_t *implicit_task_data;
1502 void *return_address = NULL;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001503
Joachim Protze82e94a52017-11-01 10:08:30 +00001504 if (ompt_enabled.enabled) {
1505 __ompt_get_task_info_internal(0, NULL, &parent_task_data, &ompt_frame,
1506 NULL, NULL);
1507 return_address = OMPT_LOAD_RETURN_ADDRESS(gtid);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001508 }
1509#endif
1510
Jim Cownie5e8470a2013-09-27 10:38:44 +00001511 // Nested level will be an index in the nested nthreads array
Jonathan Peyton30419822017-05-12 18:01:32 +00001512 level = parent_team->t.t_level;
1513 // used to launch non-serial teams even if nested is not allowed
1514 active_level = parent_team->t.t_active_level;
Jonathan Peytonc76f9f02016-06-21 19:12:07 +00001515#if OMP_40_ENABLED
Jonathan Peyton642688b2017-06-01 16:46:36 +00001516 // needed to check nesting inside the teams
1517 teams_level = master_th->th.th_teams_level;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001518#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001519#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00001520 p_hot_teams = &master_th->th.th_hot_teams;
1521 if (*p_hot_teams == NULL && __kmp_hot_teams_max_level > 0) {
1522 *p_hot_teams = (kmp_hot_team_ptr_t *)__kmp_allocate(
1523 sizeof(kmp_hot_team_ptr_t) * __kmp_hot_teams_max_level);
1524 (*p_hot_teams)[0].hot_team = root->r.r_hot_team;
Jonathan Peyton642688b2017-06-01 16:46:36 +00001525 // it is either actual or not needed (when active_level > 0)
1526 (*p_hot_teams)[0].hot_team_nth = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001527 }
1528#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001529
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001530#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001531 if (ompt_enabled.enabled) {
1532 if (ompt_enabled.ompt_callback_parallel_begin) {
1533 int team_size = master_set_numthreads
1534 ? master_set_numthreads
1535 : get__nproc_2(parent_team, master_tid);
1536 ompt_callbacks.ompt_callback(ompt_callback_parallel_begin)(
1537 parent_task_data, ompt_frame, &ompt_parallel_data, team_size,
1538 OMPT_INVOKER(call_context), return_address);
1539 }
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001540 master_th->th.ompt_thread_info.state = ompt_state_overhead;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001541 }
1542#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001543
Jim Cownie5e8470a2013-09-27 10:38:44 +00001544 master_th->th.th_ident = loc;
1545
1546#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001547 if (master_th->th.th_teams_microtask && ap &&
1548 microtask != (microtask_t)__kmp_teams_master && level == teams_level) {
1549 // AC: This is start of parallel that is nested inside teams construct.
1550 // The team is actual (hot), all workers are ready at the fork barrier.
1551 // No lock needed to initialize the team a bit, then free workers.
1552 parent_team->t.t_ident = loc;
1553 __kmp_alloc_argv_entries(argc, parent_team, TRUE);
1554 parent_team->t.t_argc = argc;
1555 argv = (void **)parent_team->t.t_argv;
1556 for (i = argc - 1; i >= 0; --i)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001557/* TODO: revert workaround for Intel(R) 64 tracker #96 */
Andrey Churbanovcbda8682015-01-13 14:43:35 +00001558#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00001559 *argv++ = va_arg(*ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001560#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001561 *argv++ = va_arg(ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001562#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001563 // Increment our nested depth levels, but not increase the serialization
1564 if (parent_team == master_th->th.th_serial_team) {
1565 // AC: we are in serialized parallel
1566 __kmpc_serialized_parallel(loc, gtid);
1567 KMP_DEBUG_ASSERT(parent_team->t.t_serialized > 1);
1568 // AC: need this in order enquiry functions work
1569 // correctly, will restore at join time
1570 parent_team->t.t_serialized--;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001571#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001572 void *dummy;
1573 void **exit_runtime_p;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001574
Jonathan Peyton30419822017-05-12 18:01:32 +00001575 ompt_lw_taskteam_t lw_taskteam;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001576
Joachim Protze82e94a52017-11-01 10:08:30 +00001577 if (ompt_enabled.enabled) {
1578 __ompt_lw_taskteam_init(&lw_taskteam, master_th, gtid,
1579 &ompt_parallel_data, return_address);
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001580 exit_runtime_p = &(lw_taskteam.ompt_task_info.frame.exit_frame.ptr);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001581
Joachim Protze82e94a52017-11-01 10:08:30 +00001582 __ompt_lw_taskteam_link(&lw_taskteam, master_th, 0);
1583 // don't use lw_taskteam after linking. content was swaped
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001584
Jonathan Peyton30419822017-05-12 18:01:32 +00001585 /* OMPT implicit task begin */
Joachim Protze82e94a52017-11-01 10:08:30 +00001586 implicit_task_data = OMPT_CUR_TASK_DATA(master_th);
1587 if (ompt_enabled.ompt_callback_implicit_task) {
1588 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1589 ompt_scope_begin, OMPT_CUR_TEAM_DATA(master_th),
Joachim Protze2b46d302019-01-15 15:36:53 +00001590 implicit_task_data, 1, __kmp_tid_from_gtid(gtid), ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Joachim Protze9be9cf22018-05-07 12:42:21 +00001591 OMPT_CUR_TASK_INFO(master_th)
1592 ->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001593 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001594
Jonathan Peyton30419822017-05-12 18:01:32 +00001595 /* OMPT state */
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001596 master_th->th.ompt_thread_info.state = ompt_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00001597 } else {
1598 exit_runtime_p = &dummy;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001599 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001600#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001601
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001602 {
Jonathan Peyton30419822017-05-12 18:01:32 +00001603 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
1604 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
1605 __kmp_invoke_microtask(microtask, gtid, 0, argc, parent_team->t.t_argv
1606#if OMPT_SUPPORT
1607 ,
1608 exit_runtime_p
1609#endif
1610 );
Jim Cownie5e8470a2013-09-27 10:38:44 +00001611 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001612
Jonathan Peyton30419822017-05-12 18:01:32 +00001613#if OMPT_SUPPORT
1614 *exit_runtime_p = NULL;
Joachim Protze82e94a52017-11-01 10:08:30 +00001615 if (ompt_enabled.enabled) {
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001616 OMPT_CUR_TASK_INFO(master_th)->frame.exit_frame = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00001617 if (ompt_enabled.ompt_callback_implicit_task) {
1618 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1619 ompt_scope_end, NULL, implicit_task_data, 1,
Joachim Protze2b46d302019-01-15 15:36:53 +00001620 OMPT_CUR_TASK_INFO(master_th)->thread_num, ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Jonathan Peyton30419822017-05-12 18:01:32 +00001621 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001622 __ompt_lw_taskteam_unlink(master_th);
Jonathan Peyton30419822017-05-12 18:01:32 +00001623
Joachim Protze82e94a52017-11-01 10:08:30 +00001624 if (ompt_enabled.ompt_callback_parallel_end) {
1625 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
1626 OMPT_CUR_TEAM_DATA(master_th), OMPT_CUR_TASK_DATA(master_th),
1627 OMPT_INVOKER(call_context), return_address);
Jonathan Peyton30419822017-05-12 18:01:32 +00001628 }
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001629 master_th->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00001630 }
1631#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001632 return TRUE;
Jonathan Peyton30419822017-05-12 18:01:32 +00001633 }
1634
1635 parent_team->t.t_pkfn = microtask;
Jonathan Peyton30419822017-05-12 18:01:32 +00001636 parent_team->t.t_invoke = invoker;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00001637 KMP_ATOMIC_INC(&root->r.r_in_parallel);
Jonathan Peyton30419822017-05-12 18:01:32 +00001638 parent_team->t.t_active_level++;
1639 parent_team->t.t_level++;
Jonathan Peyton92ca6182018-09-07 18:25:49 +00001640#if OMP_50_ENABLED
1641 parent_team->t.t_def_allocator = master_th->th.th_def_allocator; // save
1642#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001643
1644 /* Change number of threads in the team if requested */
1645 if (master_set_numthreads) { // The parallel has num_threads clause
1646 if (master_set_numthreads < master_th->th.th_teams_size.nth) {
1647 // AC: only can reduce number of threads dynamically, can't increase
1648 kmp_info_t **other_threads = parent_team->t.t_threads;
1649 parent_team->t.t_nproc = master_set_numthreads;
1650 for (i = 0; i < master_set_numthreads; ++i) {
1651 other_threads[i]->th.th_team_nproc = master_set_numthreads;
1652 }
1653 // Keep extra threads hot in the team for possible next parallels
1654 }
1655 master_th->th.th_set_nproc = 0;
1656 }
1657
1658#if USE_DEBUGGER
1659 if (__kmp_debugging) { // Let debugger override number of threads.
1660 int nth = __kmp_omp_num_threads(loc);
Jonathan Peyton642688b2017-06-01 16:46:36 +00001661 if (nth > 0) { // 0 means debugger doesn't want to change num threads
Jonathan Peyton30419822017-05-12 18:01:32 +00001662 master_set_numthreads = nth;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00001663 }
1664 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001665#endif
1666
1667 KF_TRACE(10, ("__kmp_fork_call: before internal fork: root=%p, team=%p, "
1668 "master_th=%p, gtid=%d\n",
1669 root, parent_team, master_th, gtid));
1670 __kmp_internal_fork(loc, gtid, parent_team);
1671 KF_TRACE(10, ("__kmp_fork_call: after internal fork: root=%p, team=%p, "
1672 "master_th=%p, gtid=%d\n",
1673 root, parent_team, master_th, gtid));
1674
1675 /* Invoke microtask for MASTER thread */
1676 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) invoke microtask = %p\n", gtid,
1677 parent_team->t.t_id, parent_team->t.t_pkfn));
1678
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00001679 if (!parent_team->t.t_invoke(gtid)) {
1680 KMP_ASSERT2(0, "cannot invoke microtask for MASTER thread");
Jonathan Peyton30419822017-05-12 18:01:32 +00001681 }
1682 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) done microtask = %p\n", gtid,
1683 parent_team->t.t_id, parent_team->t.t_pkfn));
1684 KMP_MB(); /* Flush all pending memory write invalidates. */
1685
1686 KA_TRACE(20, ("__kmp_fork_call: parallel exit T#%d\n", gtid));
1687
1688 return TRUE;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001689 } // Parallel closely nested in teams construct
Jim Cownie5e8470a2013-09-27 10:38:44 +00001690#endif /* OMP_40_ENABLED */
1691
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001692#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00001693 if (__kmp_tasking_mode != tskm_immediate_exec) {
1694 KMP_DEBUG_ASSERT(master_th->th.th_task_team ==
1695 parent_team->t.t_task_team[master_th->th.th_task_state]);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001696 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001697#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001698
Jonathan Peyton30419822017-05-12 18:01:32 +00001699 if (parent_team->t.t_active_level >=
1700 master_th->th.th_current_task->td_icvs.max_active_levels) {
1701 nthreads = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001702 } else {
Andrey Churbanov92effc42015-08-18 10:08:27 +00001703#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001704 int enter_teams = ((ap == NULL && active_level == 0) ||
1705 (ap && teams_level > 0 && teams_level == level));
Andrey Churbanov92effc42015-08-18 10:08:27 +00001706#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001707 nthreads =
1708 master_set_numthreads
1709 ? master_set_numthreads
1710 : get__nproc_2(
1711 parent_team,
1712 master_tid); // TODO: get nproc directly from current task
Andrey Churbanov92effc42015-08-18 10:08:27 +00001713
Jonathan Peyton30419822017-05-12 18:01:32 +00001714 // Check if we need to take forkjoin lock? (no need for serialized
1715 // parallel out of teams construct). This code moved here from
1716 // __kmp_reserve_threads() to speedup nested serialized parallels.
1717 if (nthreads > 1) {
Jonathan Peyton76b45e82019-02-28 20:47:21 +00001718 if ((get__max_active_levels(master_th) == 1 && (root->r.r_in_parallel
Andrey Churbanov92effc42015-08-18 10:08:27 +00001719#if OMP_40_ENABLED
Jonathan Peyton76b45e82019-02-28 20:47:21 +00001720 && !enter_teams
Andrey Churbanov92effc42015-08-18 10:08:27 +00001721#endif /* OMP_40_ENABLED */
Jonathan Peyton76b45e82019-02-28 20:47:21 +00001722 )) ||
Jonathan Peyton30419822017-05-12 18:01:32 +00001723 (__kmp_library == library_serial)) {
Jonathan Peyton642688b2017-06-01 16:46:36 +00001724 KC_TRACE(10, ("__kmp_fork_call: T#%d serializing team; requested %d"
1725 " threads\n",
1726 gtid, nthreads));
Jonathan Peyton30419822017-05-12 18:01:32 +00001727 nthreads = 1;
Andrey Churbanov92effc42015-08-18 10:08:27 +00001728 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001729 }
1730 if (nthreads > 1) {
1731 /* determine how many new threads we can use */
1732 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jonathan Peyton30419822017-05-12 18:01:32 +00001733 nthreads = __kmp_reserve_threads(
1734 root, parent_team, master_tid, nthreads
Jim Cownie5e8470a2013-09-27 10:38:44 +00001735#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001736 /* AC: If we execute teams from parallel region (on host), then
1737 teams should be created but each can only have 1 thread if
1738 nesting is disabled. If teams called from serial region, then
1739 teams and their threads should be created regardless of the
1740 nesting setting. */
1741 ,
1742 enter_teams
Jim Cownie5e8470a2013-09-27 10:38:44 +00001743#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00001744 );
1745 if (nthreads == 1) {
1746 // Free lock for single thread execution here; for multi-thread
1747 // execution it will be freed later after team of threads created
1748 // and initialized
1749 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Andrey Churbanov92effc42015-08-18 10:08:27 +00001750 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001751 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001752 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001753 KMP_DEBUG_ASSERT(nthreads > 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001754
Jonathan Peyton30419822017-05-12 18:01:32 +00001755 // If we temporarily changed the set number of threads then restore it now
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001756 master_th->th.th_set_nproc = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001757
Jim Cownie5e8470a2013-09-27 10:38:44 +00001758 /* create a serialized parallel region? */
Jonathan Peyton30419822017-05-12 18:01:32 +00001759 if (nthreads == 1) {
1760/* josh todo: hypothetical question: what do we do for OS X*? */
1761#if KMP_OS_LINUX && \
1762 (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
1763 void *args[argc];
Jim Cownie5e8470a2013-09-27 10:38:44 +00001764#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001765 void **args = (void **)KMP_ALLOCA(argc * sizeof(void *));
1766#endif /* KMP_OS_LINUX && ( KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || \
1767 KMP_ARCH_AARCH64) */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001768
Jonathan Peyton30419822017-05-12 18:01:32 +00001769 KA_TRACE(20,
1770 ("__kmp_fork_call: T#%d serializing parallel region\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00001771
Jonathan Peyton30419822017-05-12 18:01:32 +00001772 __kmpc_serialized_parallel(loc, gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001773
Jonathan Peyton30419822017-05-12 18:01:32 +00001774 if (call_context == fork_context_intel) {
1775 /* TODO this sucks, use the compiler itself to pass args! :) */
1776 master_th->th.th_serial_team->t.t_ident = loc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001777#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001778 if (!ap) {
1779 // revert change made in __kmpc_serialized_parallel()
1780 master_th->th.th_serial_team->t.t_level--;
1781// Get args from parent team for teams construct
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001782
1783#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001784 void *dummy;
1785 void **exit_runtime_p;
Joachim Protze82e94a52017-11-01 10:08:30 +00001786 ompt_task_info_t *task_info;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001787
Jonathan Peyton30419822017-05-12 18:01:32 +00001788 ompt_lw_taskteam_t lw_taskteam;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001789
Joachim Protze82e94a52017-11-01 10:08:30 +00001790 if (ompt_enabled.enabled) {
Jonathan Peyton30419822017-05-12 18:01:32 +00001791 __ompt_lw_taskteam_init(&lw_taskteam, master_th, gtid,
Joachim Protze82e94a52017-11-01 10:08:30 +00001792 &ompt_parallel_data, return_address);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001793
Joachim Protze82e94a52017-11-01 10:08:30 +00001794 __ompt_lw_taskteam_link(&lw_taskteam, master_th, 0);
1795 // don't use lw_taskteam after linking. content was swaped
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001796
Joachim Protze82e94a52017-11-01 10:08:30 +00001797 task_info = OMPT_CUR_TASK_INFO(master_th);
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001798 exit_runtime_p = &(task_info->frame.exit_frame.ptr);
Joachim Protze82e94a52017-11-01 10:08:30 +00001799 if (ompt_enabled.ompt_callback_implicit_task) {
1800 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1801 ompt_scope_begin, OMPT_CUR_TEAM_DATA(master_th),
Joachim Protze2b46d302019-01-15 15:36:53 +00001802 &(task_info->task_data), 1, __kmp_tid_from_gtid(gtid), ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Joachim Protze9be9cf22018-05-07 12:42:21 +00001803 OMPT_CUR_TASK_INFO(master_th)
1804 ->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001805 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001806
Jonathan Peyton30419822017-05-12 18:01:32 +00001807 /* OMPT state */
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001808 master_th->th.ompt_thread_info.state = ompt_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00001809 } else {
1810 exit_runtime_p = &dummy;
1811 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001812#endif
1813
Jonathan Peyton30419822017-05-12 18:01:32 +00001814 {
1815 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
1816 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
1817 __kmp_invoke_microtask(microtask, gtid, 0, argc,
1818 parent_team->t.t_argv
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001819#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001820 ,
1821 exit_runtime_p
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001822#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001823 );
1824 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001825
1826#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001827 if (ompt_enabled.enabled) {
1828 exit_runtime_p = NULL;
1829 if (ompt_enabled.ompt_callback_implicit_task) {
1830 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1831 ompt_scope_end, NULL, &(task_info->task_data), 1,
Joachim Protze2b46d302019-01-15 15:36:53 +00001832 OMPT_CUR_TASK_INFO(master_th)->thread_num, ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Jonathan Peyton30419822017-05-12 18:01:32 +00001833 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001834
Jonathan Peyton30419822017-05-12 18:01:32 +00001835 __ompt_lw_taskteam_unlink(master_th);
Joachim Protze82e94a52017-11-01 10:08:30 +00001836 if (ompt_enabled.ompt_callback_parallel_end) {
1837 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
1838 OMPT_CUR_TEAM_DATA(master_th), parent_task_data,
1839 OMPT_INVOKER(call_context), return_address);
Jonathan Peyton30419822017-05-12 18:01:32 +00001840 }
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001841 master_th->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00001842 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001843#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001844 } else if (microtask == (microtask_t)__kmp_teams_master) {
1845 KMP_DEBUG_ASSERT(master_th->th.th_team ==
1846 master_th->th.th_serial_team);
1847 team = master_th->th.th_team;
1848 // team->t.t_pkfn = microtask;
1849 team->t.t_invoke = invoker;
1850 __kmp_alloc_argv_entries(argc, team, TRUE);
1851 team->t.t_argc = argc;
1852 argv = (void **)team->t.t_argv;
1853 if (ap) {
1854 for (i = argc - 1; i >= 0; --i)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001855// TODO: revert workaround for Intel(R) 64 tracker #96
Andrey Churbanovcbda8682015-01-13 14:43:35 +00001856#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00001857 *argv++ = va_arg(*ap, void *);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001858#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001859 *argv++ = va_arg(ap, void *);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001860#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001861 } else {
1862 for (i = 0; i < argc; ++i)
1863 // Get args from parent team for teams construct
1864 argv[i] = parent_team->t.t_argv[i];
1865 }
1866 // AC: revert change made in __kmpc_serialized_parallel()
1867 // because initial code in teams should have level=0
1868 team->t.t_level--;
1869 // AC: call special invoker for outer "parallel" of teams construct
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00001870 invoker(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001871 } else {
1872#endif /* OMP_40_ENABLED */
1873 argv = args;
1874 for (i = argc - 1; i >= 0; --i)
1875// TODO: revert workaround for Intel(R) 64 tracker #96
1876#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
1877 *argv++ = va_arg(*ap, void *);
1878#else
1879 *argv++ = va_arg(ap, void *);
1880#endif
1881 KMP_MB();
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001882
1883#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001884 void *dummy;
1885 void **exit_runtime_p;
Joachim Protze82e94a52017-11-01 10:08:30 +00001886 ompt_task_info_t *task_info;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001887
Jonathan Peyton30419822017-05-12 18:01:32 +00001888 ompt_lw_taskteam_t lw_taskteam;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001889
Joachim Protze82e94a52017-11-01 10:08:30 +00001890 if (ompt_enabled.enabled) {
Jonathan Peyton30419822017-05-12 18:01:32 +00001891 __ompt_lw_taskteam_init(&lw_taskteam, master_th, gtid,
Joachim Protze82e94a52017-11-01 10:08:30 +00001892 &ompt_parallel_data, return_address);
1893 __ompt_lw_taskteam_link(&lw_taskteam, master_th, 0);
1894 // don't use lw_taskteam after linking. content was swaped
1895 task_info = OMPT_CUR_TASK_INFO(master_th);
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001896 exit_runtime_p = &(task_info->frame.exit_frame.ptr);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001897
Jonathan Peyton30419822017-05-12 18:01:32 +00001898 /* OMPT implicit task begin */
Joachim Protze82e94a52017-11-01 10:08:30 +00001899 implicit_task_data = OMPT_CUR_TASK_DATA(master_th);
1900 if (ompt_enabled.ompt_callback_implicit_task) {
1901 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1902 ompt_scope_begin, OMPT_CUR_TEAM_DATA(master_th),
Joachim Protze2b46d302019-01-15 15:36:53 +00001903 implicit_task_data, 1, __kmp_tid_from_gtid(gtid), ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Joachim Protze9be9cf22018-05-07 12:42:21 +00001904 OMPT_CUR_TASK_INFO(master_th)
1905 ->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001906 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001907
Jonathan Peyton30419822017-05-12 18:01:32 +00001908 /* OMPT state */
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001909 master_th->th.ompt_thread_info.state = ompt_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00001910 } else {
1911 exit_runtime_p = &dummy;
1912 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001913#endif
1914
Jonathan Peyton30419822017-05-12 18:01:32 +00001915 {
1916 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
1917 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
1918 __kmp_invoke_microtask(microtask, gtid, 0, argc, args
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001919#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001920 ,
1921 exit_runtime_p
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001922#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001923 );
1924 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001925
1926#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001927 if (ompt_enabled.enabled) {
1928 *exit_runtime_p = NULL;
1929 if (ompt_enabled.ompt_callback_implicit_task) {
1930 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1931 ompt_scope_end, NULL, &(task_info->task_data), 1,
Joachim Protze2b46d302019-01-15 15:36:53 +00001932 OMPT_CUR_TASK_INFO(master_th)->thread_num, ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Jonathan Peyton30419822017-05-12 18:01:32 +00001933 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001934
Joachim Protze82e94a52017-11-01 10:08:30 +00001935 ompt_parallel_data = *OMPT_CUR_TEAM_DATA(master_th);
Jonathan Peyton30419822017-05-12 18:01:32 +00001936 __ompt_lw_taskteam_unlink(master_th);
Joachim Protze82e94a52017-11-01 10:08:30 +00001937 if (ompt_enabled.ompt_callback_parallel_end) {
1938 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
1939 &ompt_parallel_data, parent_task_data,
1940 OMPT_INVOKER(call_context), return_address);
Jonathan Peyton30419822017-05-12 18:01:32 +00001941 }
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001942 master_th->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00001943 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001944#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001945#if OMP_40_ENABLED
Jim Cownie5e8470a2013-09-27 10:38:44 +00001946 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001947#endif /* OMP_40_ENABLED */
1948 } else if (call_context == fork_context_gnu) {
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001949#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001950 ompt_lw_taskteam_t lwt;
1951 __ompt_lw_taskteam_init(&lwt, master_th, gtid, &ompt_parallel_data,
1952 return_address);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001953
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00001954 lwt.ompt_task_info.frame.exit_frame = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00001955 __ompt_lw_taskteam_link(&lwt, master_th, 1);
1956// don't use lw_taskteam after linking. content was swaped
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001957#endif
1958
Jonathan Peyton30419822017-05-12 18:01:32 +00001959 // we were called from GNU native code
1960 KA_TRACE(20, ("__kmp_fork_call: T#%d serial exit\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00001961 return FALSE;
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00001962 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00001963 KMP_ASSERT2(call_context < fork_context_last,
1964 "__kmp_fork_call: unknown fork_context parameter");
1965 }
1966
1967 KA_TRACE(20, ("__kmp_fork_call: T#%d serial exit\n", gtid));
1968 KMP_MB();
1969 return FALSE;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00001970 } // if (nthreads == 1)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001971
Jim Cownie5e8470a2013-09-27 10:38:44 +00001972 // GEH: only modify the executing flag in the case when not serialized
1973 // serialized case is handled in kmpc_serialized_parallel
Jonathan Peyton30419822017-05-12 18:01:32 +00001974 KF_TRACE(10, ("__kmp_fork_call: parent_team_aclevel=%d, master_th=%p, "
1975 "curtask=%p, curtask_max_aclevel=%d\n",
1976 parent_team->t.t_active_level, master_th,
1977 master_th->th.th_current_task,
1978 master_th->th.th_current_task->td_icvs.max_active_levels));
1979 // TODO: GEH - cannot do this assertion because root thread not set up as
1980 // executing
Jim Cownie5e8470a2013-09-27 10:38:44 +00001981 // KMP_ASSERT( master_th->th.th_current_task->td_flags.executing == 1 );
1982 master_th->th.th_current_task->td_flags.executing = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001983
1984#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001985 if (!master_th->th.th_teams_microtask || level > teams_level)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001986#endif /* OMP_40_ENABLED */
1987 {
Jonathan Peyton30419822017-05-12 18:01:32 +00001988 /* Increment our nested depth level */
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00001989 KMP_ATOMIC_INC(&root->r.r_in_parallel);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001990 }
1991
Jim Cownie5e8470a2013-09-27 10:38:44 +00001992 // See if we need to make a copy of the ICVs.
Jim Cownie5e8470a2013-09-27 10:38:44 +00001993 int nthreads_icv = master_th->th.th_current_task->td_icvs.nproc;
Jonathan Peyton30419822017-05-12 18:01:32 +00001994 if ((level + 1 < __kmp_nested_nth.used) &&
1995 (__kmp_nested_nth.nth[level + 1] != nthreads_icv)) {
1996 nthreads_icv = __kmp_nested_nth.nth[level + 1];
1997 } else {
1998 nthreads_icv = 0; // don't update
Jim Cownie5e8470a2013-09-27 10:38:44 +00001999 }
2000
2001#if OMP_40_ENABLED
Jim Cownie5e8470a2013-09-27 10:38:44 +00002002 // Figure out the proc_bind_policy for the new team.
Jim Cownie5e8470a2013-09-27 10:38:44 +00002003 kmp_proc_bind_t proc_bind = master_th->th.th_set_proc_bind;
Jonathan Peyton30419822017-05-12 18:01:32 +00002004 kmp_proc_bind_t proc_bind_icv =
2005 proc_bind_default; // proc_bind_default means don't update
2006 if (master_th->th.th_current_task->td_icvs.proc_bind == proc_bind_false) {
2007 proc_bind = proc_bind_false;
2008 } else {
2009 if (proc_bind == proc_bind_default) {
2010 // No proc_bind clause specified; use current proc-bind-var for this
2011 // parallel region
2012 proc_bind = master_th->th.th_current_task->td_icvs.proc_bind;
2013 }
2014 /* else: The proc_bind policy was specified explicitly on parallel clause.
2015 This overrides proc-bind-var for this parallel region, but does not
2016 change proc-bind-var. */
2017 // Figure the value of proc-bind-var for the child threads.
2018 if ((level + 1 < __kmp_nested_proc_bind.used) &&
2019 (__kmp_nested_proc_bind.bind_types[level + 1] !=
2020 master_th->th.th_current_task->td_icvs.proc_bind)) {
2021 proc_bind_icv = __kmp_nested_proc_bind.bind_types[level + 1];
2022 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002023 }
2024
Jim Cownie5e8470a2013-09-27 10:38:44 +00002025 // Reset for next parallel region
Jim Cownie5e8470a2013-09-27 10:38:44 +00002026 master_th->th.th_set_proc_bind = proc_bind_default;
2027#endif /* OMP_40_ENABLED */
2028
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002029 if ((nthreads_icv > 0)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002030#if OMP_40_ENABLED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002031 || (proc_bind_icv != proc_bind_default)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002032#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002033 ) {
2034 kmp_internal_control_t new_icvs;
2035 copy_icvs(&new_icvs, &master_th->th.th_current_task->td_icvs);
2036 new_icvs.next = NULL;
2037 if (nthreads_icv > 0) {
2038 new_icvs.nproc = nthreads_icv;
2039 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002040
2041#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002042 if (proc_bind_icv != proc_bind_default) {
2043 new_icvs.proc_bind = proc_bind_icv;
2044 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002045#endif /* OMP_40_ENABLED */
2046
Jonathan Peyton30419822017-05-12 18:01:32 +00002047 /* allocate a new parallel team */
2048 KF_TRACE(10, ("__kmp_fork_call: before __kmp_allocate_team\n"));
2049 team = __kmp_allocate_team(root, nthreads, nthreads,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002050#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002051 ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002052#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002053#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002054 proc_bind,
Jim Cownie5e8470a2013-09-27 10:38:44 +00002055#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002056 &new_icvs, argc USE_NESTED_HOT_ARG(master_th));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002057 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002058 /* allocate a new parallel team */
2059 KF_TRACE(10, ("__kmp_fork_call: before __kmp_allocate_team\n"));
2060 team = __kmp_allocate_team(root, nthreads, nthreads,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002061#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002062 ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002063#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002064#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002065 proc_bind,
Jim Cownie5e8470a2013-09-27 10:38:44 +00002066#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002067 &master_th->th.th_current_task->td_icvs,
2068 argc USE_NESTED_HOT_ARG(master_th));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002069 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002070 KF_TRACE(
2071 10, ("__kmp_fork_call: after __kmp_allocate_team - team = %p\n", team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002072
2073 /* setup the new team */
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002074 KMP_CHECK_UPDATE(team->t.t_master_tid, master_tid);
2075 KMP_CHECK_UPDATE(team->t.t_master_this_cons, master_this_cons);
2076 KMP_CHECK_UPDATE(team->t.t_ident, loc);
2077 KMP_CHECK_UPDATE(team->t.t_parent, parent_team);
2078 KMP_CHECK_UPDATE_SYNC(team->t.t_pkfn, microtask);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002079#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002080 KMP_CHECK_UPDATE_SYNC(team->t.ompt_team_info.master_return_address,
2081 return_address);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002082#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002083 KMP_CHECK_UPDATE(team->t.t_invoke, invoker); // TODO move to root, maybe
2084// TODO: parent_team->t.t_level == INT_MAX ???
Jim Cownie5e8470a2013-09-27 10:38:44 +00002085#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002086 if (!master_th->th.th_teams_microtask || level > teams_level) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002087#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002088 int new_level = parent_team->t.t_level + 1;
2089 KMP_CHECK_UPDATE(team->t.t_level, new_level);
2090 new_level = parent_team->t.t_active_level + 1;
2091 KMP_CHECK_UPDATE(team->t.t_active_level, new_level);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002092#if OMP_40_ENABLED
2093 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002094 // AC: Do not increase parallel level at start of the teams construct
2095 int new_level = parent_team->t.t_level;
2096 KMP_CHECK_UPDATE(team->t.t_level, new_level);
2097 new_level = parent_team->t.t_active_level;
2098 KMP_CHECK_UPDATE(team->t.t_active_level, new_level);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002099 }
2100#endif /* OMP_40_ENABLED */
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002101 kmp_r_sched_t new_sched = get__sched_2(parent_team, master_tid);
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00002102 // set master's schedule as new run-time schedule
2103 KMP_CHECK_UPDATE(team->t.t_sched.sched, new_sched.sched);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002104
Jonathan Peyton45ca5da2015-10-19 19:33:38 +00002105#if OMP_40_ENABLED
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002106 KMP_CHECK_UPDATE(team->t.t_cancel_request, cancel_noreq);
Jonathan Peyton45ca5da2015-10-19 19:33:38 +00002107#endif
Jonathan Peyton92ca6182018-09-07 18:25:49 +00002108#if OMP_50_ENABLED
2109 KMP_CHECK_UPDATE(team->t.t_def_allocator, master_th->th.th_def_allocator);
2110#endif
Jonathan Peyton45ca5da2015-10-19 19:33:38 +00002111
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002112 // Update the floating point rounding in the team if required.
2113 propagateFPControl(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002114
Jonathan Peyton30419822017-05-12 18:01:32 +00002115 if (__kmp_tasking_mode != tskm_immediate_exec) {
2116 // Set master's task team to team's task team. Unless this is hot team, it
2117 // should be NULL.
Jonathan Peyton30419822017-05-12 18:01:32 +00002118 KMP_DEBUG_ASSERT(master_th->th.th_task_team ==
2119 parent_team->t.t_task_team[master_th->th.th_task_state]);
Jonathan Peyton30419822017-05-12 18:01:32 +00002120 KA_TRACE(20, ("__kmp_fork_call: Master T#%d pushing task_team %p / team "
2121 "%p, new task_team %p / team %p\n",
2122 __kmp_gtid_from_thread(master_th),
2123 master_th->th.th_task_team, parent_team,
2124 team->t.t_task_team[master_th->th.th_task_state], team));
Jonathan Peytond3f2b942016-02-09 22:32:41 +00002125
Jonathan Peyton30419822017-05-12 18:01:32 +00002126 if (active_level || master_th->th.th_task_team) {
2127 // Take a memo of master's task_state
2128 KMP_DEBUG_ASSERT(master_th->th.th_task_state_memo_stack);
2129 if (master_th->th.th_task_state_top >=
2130 master_th->th.th_task_state_stack_sz) { // increase size
2131 kmp_uint32 new_size = 2 * master_th->th.th_task_state_stack_sz;
2132 kmp_uint8 *old_stack, *new_stack;
2133 kmp_uint32 i;
2134 new_stack = (kmp_uint8 *)__kmp_allocate(new_size);
2135 for (i = 0; i < master_th->th.th_task_state_stack_sz; ++i) {
2136 new_stack[i] = master_th->th.th_task_state_memo_stack[i];
2137 }
2138 for (i = master_th->th.th_task_state_stack_sz; i < new_size;
2139 ++i) { // zero-init rest of stack
2140 new_stack[i] = 0;
2141 }
2142 old_stack = master_th->th.th_task_state_memo_stack;
2143 master_th->th.th_task_state_memo_stack = new_stack;
2144 master_th->th.th_task_state_stack_sz = new_size;
2145 __kmp_free(old_stack);
Andrey Churbanov6d224db2015-02-10 18:37:43 +00002146 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002147 // Store master's task_state on stack
2148 master_th->th
2149 .th_task_state_memo_stack[master_th->th.th_task_state_top] =
2150 master_th->th.th_task_state;
2151 master_th->th.th_task_state_top++;
2152#if KMP_NESTED_HOT_TEAMS
Jonathan Peytonca10a762018-08-24 18:05:00 +00002153 if (master_th->th.th_hot_teams &&
Jonathan Peytonf4c07202018-11-28 20:15:11 +00002154 active_level < __kmp_hot_teams_max_level &&
Jonathan Peytonca10a762018-08-24 18:05:00 +00002155 team == master_th->th.th_hot_teams[active_level].hot_team) {
Jonathan Peyton642688b2017-06-01 16:46:36 +00002156 // Restore master's nested state if nested hot team
Jonathan Peyton30419822017-05-12 18:01:32 +00002157 master_th->th.th_task_state =
2158 master_th->th
2159 .th_task_state_memo_stack[master_th->th.th_task_state_top];
2160 } else {
2161#endif
2162 master_th->th.th_task_state = 0;
2163#if KMP_NESTED_HOT_TEAMS
2164 }
2165#endif
2166 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002167#if !KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00002168 KMP_DEBUG_ASSERT((master_th->th.th_task_team == NULL) ||
2169 (team == root->r.r_hot_team));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002170#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002171 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002172
Jonathan Peyton30419822017-05-12 18:01:32 +00002173 KA_TRACE(
2174 20,
2175 ("__kmp_fork_call: T#%d(%d:%d)->(%d:0) created a team of %d threads\n",
2176 gtid, parent_team->t.t_id, team->t.t_master_tid, team->t.t_id,
2177 team->t.t_nproc));
2178 KMP_DEBUG_ASSERT(team != root->r.r_hot_team ||
2179 (team->t.t_master_tid == 0 &&
2180 (team->t.t_parent == root->r.r_root_team ||
2181 team->t.t_parent->t.t_serialized)));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002182 KMP_MB();
2183
2184 /* now, setup the arguments */
Jonathan Peyton30419822017-05-12 18:01:32 +00002185 argv = (void **)team->t.t_argv;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002186#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002187 if (ap) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002188#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002189 for (i = argc - 1; i >= 0; --i) {
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002190// TODO: revert workaround for Intel(R) 64 tracker #96
Andrey Churbanovcbda8682015-01-13 14:43:35 +00002191#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00002192 void *new_argv = va_arg(*ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002193#else
Jonathan Peyton30419822017-05-12 18:01:32 +00002194 void *new_argv = va_arg(ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002195#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002196 KMP_CHECK_UPDATE(*argv, new_argv);
2197 argv++;
2198 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002199#if OMP_40_ENABLED
2200 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002201 for (i = 0; i < argc; ++i) {
2202 // Get args from parent team for teams construct
2203 KMP_CHECK_UPDATE(argv[i], team->t.t_parent->t.t_argv[i]);
2204 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002205 }
2206#endif /* OMP_40_ENABLED */
2207
2208 /* now actually fork the threads */
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002209 KMP_CHECK_UPDATE(team->t.t_master_active, master_active);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002210 if (!root->r.r_active) // Only do assignment if it prevents cache ping-pong
Jonathan Peyton30419822017-05-12 18:01:32 +00002211 root->r.r_active = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002212
Jonathan Peyton30419822017-05-12 18:01:32 +00002213 __kmp_fork_team_threads(root, team, master_th, gtid);
2214 __kmp_setup_icv_copy(team, nthreads,
2215 &master_th->th.th_current_task->td_icvs, loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002216
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002217#if OMPT_SUPPORT
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00002218 master_th->th.ompt_thread_info.state = ompt_state_work_parallel;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002219#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002220
Jonathan Peyton30419822017-05-12 18:01:32 +00002221 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002222
Jim Cownie5e8470a2013-09-27 10:38:44 +00002223#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00002224 if (team->t.t_active_level == 1 // only report frames at level 1
2225#if OMP_40_ENABLED
Andrey Churbanov51aecb82015-05-06 19:22:36 +00002226 && !master_th->th.th_teams_microtask // not in teams construct
Jonathan Peyton30419822017-05-12 18:01:32 +00002227#endif /* OMP_40_ENABLED */
2228 ) {
Andrey Churbanov51aecb82015-05-06 19:22:36 +00002229#if USE_ITT_NOTIFY
Jonathan Peyton30419822017-05-12 18:01:32 +00002230 if ((__itt_frame_submit_v3_ptr || KMP_ITT_DEBUG) &&
2231 (__kmp_forkjoin_frames_mode == 3 ||
2232 __kmp_forkjoin_frames_mode == 1)) {
2233 kmp_uint64 tmp_time = 0;
2234 if (__itt_get_timestamp_ptr)
2235 tmp_time = __itt_get_timestamp();
2236 // Internal fork - report frame begin
2237 master_th->th.th_frame_time = tmp_time;
2238 if (__kmp_forkjoin_frames_mode == 3)
2239 team->t.t_region_time = tmp_time;
Jonathan Peyton642688b2017-06-01 16:46:36 +00002240 } else
2241// only one notification scheme (either "submit" or "forking/joined", not both)
Andrey Churbanov51aecb82015-05-06 19:22:36 +00002242#endif /* USE_ITT_NOTIFY */
Jonathan Peyton30419822017-05-12 18:01:32 +00002243 if ((__itt_frame_begin_v3_ptr || KMP_ITT_DEBUG) &&
2244 __kmp_forkjoin_frames && !__kmp_forkjoin_frames_mode) {
Jonathan Peyton8c432f22018-01-04 22:56:47 +00002245 // Mark start of "parallel" region for Intel(R) VTune(TM) analyzer.
Jonathan Peyton30419822017-05-12 18:01:32 +00002246 __kmp_itt_region_forking(gtid, team->t.t_nproc, 0);
2247 }
Andrey Churbanovf6451d92015-01-16 15:58:03 +00002248 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002249#endif /* USE_ITT_BUILD */
2250
2251 /* now go on and do the work */
Jonathan Peyton30419822017-05-12 18:01:32 +00002252 KMP_DEBUG_ASSERT(team == __kmp_threads[gtid]->th.th_team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002253 KMP_MB();
Jonathan Peyton30419822017-05-12 18:01:32 +00002254 KF_TRACE(10,
2255 ("__kmp_internal_fork : root=%p, team=%p, master_th=%p, gtid=%d\n",
2256 root, team, master_th, gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002257
2258#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00002259 if (__itt_stack_caller_create_ptr) {
2260 team->t.t_stack_id =
2261 __kmp_itt_stack_caller_create(); // create new stack stitching id
2262 // before entering fork barrier
Jim Cownie5e8470a2013-09-27 10:38:44 +00002263 }
2264#endif /* USE_ITT_BUILD */
2265
2266#if OMP_40_ENABLED
Jonathan Peyton642688b2017-06-01 16:46:36 +00002267 // AC: skip __kmp_internal_fork at teams construct, let only master
2268 // threads execute
2269 if (ap)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002270#endif /* OMP_40_ENABLED */
2271 {
Jonathan Peyton30419822017-05-12 18:01:32 +00002272 __kmp_internal_fork(loc, gtid, team);
2273 KF_TRACE(10, ("__kmp_internal_fork : after : root=%p, team=%p, "
2274 "master_th=%p, gtid=%d\n",
2275 root, team, master_th, gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002276 }
2277
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002278 if (call_context == fork_context_gnu) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002279 KA_TRACE(20, ("__kmp_fork_call: parallel exit T#%d\n", gtid));
2280 return TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002281 }
2282
2283 /* Invoke microtask for MASTER thread */
Jonathan Peyton30419822017-05-12 18:01:32 +00002284 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) invoke microtask = %p\n", gtid,
2285 team->t.t_id, team->t.t_pkfn));
2286 } // END of timer KMP_fork_call block
Jim Cownie5e8470a2013-09-27 10:38:44 +00002287
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00002288 if (!team->t.t_invoke(gtid)) {
2289 KMP_ASSERT2(0, "cannot invoke microtask for MASTER thread");
Jonathan Peyton30419822017-05-12 18:01:32 +00002290 }
2291 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) done microtask = %p\n", gtid,
2292 team->t.t_id, team->t.t_pkfn));
2293 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002294
Jonathan Peyton30419822017-05-12 18:01:32 +00002295 KA_TRACE(20, ("__kmp_fork_call: parallel exit T#%d\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002296
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002297#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002298 if (ompt_enabled.enabled) {
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00002299 master_th->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00002300 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002301#endif
2302
Jonathan Peyton30419822017-05-12 18:01:32 +00002303 return TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002304}
2305
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002306#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00002307static inline void __kmp_join_restore_state(kmp_info_t *thread,
2308 kmp_team_t *team) {
2309 // restore state outside the region
2310 thread->th.ompt_thread_info.state =
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00002311 ((team->t.t_serialized) ? ompt_state_work_serial
2312 : ompt_state_work_parallel);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002313}
2314
Joachim Protze82e94a52017-11-01 10:08:30 +00002315static inline void __kmp_join_ompt(int gtid, kmp_info_t *thread,
2316 kmp_team_t *team, ompt_data_t *parallel_data,
2317 fork_context_e fork_context, void *codeptr) {
2318 ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
2319 if (ompt_enabled.ompt_callback_parallel_end) {
2320 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
2321 parallel_data, &(task_info->task_data), OMPT_INVOKER(fork_context),
2322 codeptr);
Jonathan Peyton30419822017-05-12 18:01:32 +00002323 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002324
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00002325 task_info->frame.enter_frame = ompt_data_none;
Jonathan Peyton30419822017-05-12 18:01:32 +00002326 __kmp_join_restore_state(thread, team);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002327}
2328#endif
2329
Jonathan Peyton30419822017-05-12 18:01:32 +00002330void __kmp_join_call(ident_t *loc, int gtid
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00002331#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00002332 ,
2333 enum fork_context_e fork_context
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00002334#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002335#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002336 ,
2337 int exit_teams
Jim Cownie5e8470a2013-09-27 10:38:44 +00002338#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002339 ) {
2340 KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(KMP_join_call);
2341 kmp_team_t *team;
2342 kmp_team_t *parent_team;
2343 kmp_info_t *master_th;
2344 kmp_root_t *root;
2345 int master_active;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002346
Jonathan Peyton30419822017-05-12 18:01:32 +00002347 KA_TRACE(20, ("__kmp_join_call: enter T#%d\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002348
Jonathan Peyton30419822017-05-12 18:01:32 +00002349 /* setup current data */
2350 master_th = __kmp_threads[gtid];
2351 root = master_th->th.th_root;
2352 team = master_th->th.th_team;
2353 parent_team = team->t.t_parent;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002354
Jonathan Peyton30419822017-05-12 18:01:32 +00002355 master_th->th.th_ident = loc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002356
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002357#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002358 if (ompt_enabled.enabled) {
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00002359 master_th->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00002360 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002361#endif
2362
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002363#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00002364 if (__kmp_tasking_mode != tskm_immediate_exec && !exit_teams) {
2365 KA_TRACE(20, ("__kmp_join_call: T#%d, old team = %p old task_team = %p, "
2366 "th_task_team = %p\n",
2367 __kmp_gtid_from_thread(master_th), team,
2368 team->t.t_task_team[master_th->th.th_task_state],
2369 master_th->th.th_task_team));
2370 KMP_DEBUG_ASSERT(master_th->th.th_task_team ==
2371 team->t.t_task_team[master_th->th.th_task_state]);
2372 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002373#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002374
Jonathan Peyton30419822017-05-12 18:01:32 +00002375 if (team->t.t_serialized) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002376#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002377 if (master_th->th.th_teams_microtask) {
2378 // We are in teams construct
2379 int level = team->t.t_level;
2380 int tlevel = master_th->th.th_teams_level;
2381 if (level == tlevel) {
2382 // AC: we haven't incremented it earlier at start of teams construct,
2383 // so do it here - at the end of teams construct
2384 team->t.t_level++;
2385 } else if (level == tlevel + 1) {
2386 // AC: we are exiting parallel inside teams, need to increment
2387 // serialization in order to restore it in the next call to
2388 // __kmpc_end_serialized_parallel
2389 team->t.t_serialized++;
2390 }
Andrey Churbanov6d224db2015-02-10 18:37:43 +00002391 }
Jonathan Peyton441f3372015-09-21 17:24:46 +00002392#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002393 __kmpc_end_serialized_parallel(loc, gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002394
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002395#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002396 if (ompt_enabled.enabled) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002397 __kmp_join_restore_state(master_th, parent_team);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002398 }
2399#endif
2400
Jonathan Peyton30419822017-05-12 18:01:32 +00002401 return;
2402 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002403
Jonathan Peyton30419822017-05-12 18:01:32 +00002404 master_active = team->t.t_master_active;
2405
2406#if OMP_40_ENABLED
2407 if (!exit_teams)
2408#endif /* OMP_40_ENABLED */
2409 {
2410 // AC: No barrier for internal teams at exit from teams construct.
2411 // But there is barrier for external team (league).
2412 __kmp_internal_join(loc, gtid, team);
2413 }
2414#if OMP_40_ENABLED
2415 else {
2416 master_th->th.th_task_state =
2417 0; // AC: no tasking in teams (out of any parallel)
2418 }
2419#endif /* OMP_40_ENABLED */
2420
2421 KMP_MB();
2422
2423#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002424 ompt_data_t *parallel_data = &(team->t.ompt_team_info.parallel_data);
2425 void *codeptr = team->t.ompt_team_info.master_return_address;
Jonathan Peyton30419822017-05-12 18:01:32 +00002426#endif
2427
2428#if USE_ITT_BUILD
2429 if (__itt_stack_caller_create_ptr) {
2430 __kmp_itt_stack_caller_destroy(
2431 (__itt_caller)team->t
2432 .t_stack_id); // destroy the stack stitching id after join barrier
2433 }
2434
Jonathan Peyton8c432f22018-01-04 22:56:47 +00002435 // Mark end of "parallel" region for Intel(R) VTune(TM) analyzer.
Jonathan Peyton30419822017-05-12 18:01:32 +00002436 if (team->t.t_active_level == 1
2437#if OMP_40_ENABLED
2438 && !master_th->th.th_teams_microtask /* not in teams construct */
2439#endif /* OMP_40_ENABLED */
2440 ) {
2441 master_th->th.th_ident = loc;
2442 // only one notification scheme (either "submit" or "forking/joined", not
2443 // both)
2444 if ((__itt_frame_submit_v3_ptr || KMP_ITT_DEBUG) &&
2445 __kmp_forkjoin_frames_mode == 3)
2446 __kmp_itt_frame_submit(gtid, team->t.t_region_time,
2447 master_th->th.th_frame_time, 0, loc,
2448 master_th->th.th_team_nproc, 1);
2449 else if ((__itt_frame_end_v3_ptr || KMP_ITT_DEBUG) &&
2450 !__kmp_forkjoin_frames_mode && __kmp_forkjoin_frames)
2451 __kmp_itt_region_joined(gtid);
2452 } // active_level == 1
2453#endif /* USE_ITT_BUILD */
2454
2455#if OMP_40_ENABLED
2456 if (master_th->th.th_teams_microtask && !exit_teams &&
2457 team->t.t_pkfn != (microtask_t)__kmp_teams_master &&
2458 team->t.t_level == master_th->th.th_teams_level + 1) {
2459 // AC: We need to leave the team structure intact at the end of parallel
2460 // inside the teams construct, so that at the next parallel same (hot) team
2461 // works, only adjust nesting levels
2462
2463 /* Decrement our nested depth level */
2464 team->t.t_level--;
2465 team->t.t_active_level--;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00002466 KMP_ATOMIC_DEC(&root->r.r_in_parallel);
Jonathan Peyton30419822017-05-12 18:01:32 +00002467
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00002468 // Restore number of threads in the team if needed. This code relies on
2469 // the proper adjustment of th_teams_size.nth after the fork in
2470 // __kmp_teams_master on each teams master in the case that
2471 // __kmp_reserve_threads reduced it.
Jonathan Peyton30419822017-05-12 18:01:32 +00002472 if (master_th->th.th_team_nproc < master_th->th.th_teams_size.nth) {
2473 int old_num = master_th->th.th_team_nproc;
2474 int new_num = master_th->th.th_teams_size.nth;
2475 kmp_info_t **other_threads = team->t.t_threads;
2476 team->t.t_nproc = new_num;
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00002477 for (int i = 0; i < old_num; ++i) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002478 other_threads[i]->th.th_team_nproc = new_num;
2479 }
2480 // Adjust states of non-used threads of the team
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00002481 for (int i = old_num; i < new_num; ++i) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002482 // Re-initialize thread's barrier data.
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00002483 KMP_DEBUG_ASSERT(other_threads[i]);
Jonathan Peyton30419822017-05-12 18:01:32 +00002484 kmp_balign_t *balign = other_threads[i]->th.th_bar;
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00002485 for (int b = 0; b < bs_last_barrier; ++b) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002486 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
2487 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
2488#if USE_DEBUGGER
2489 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
2490#endif
2491 }
2492 if (__kmp_tasking_mode != tskm_immediate_exec) {
2493 // Synchronize thread's task state
2494 other_threads[i]->th.th_task_state = master_th->th.th_task_state;
2495 }
2496 }
2497 }
2498
2499#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002500 if (ompt_enabled.enabled) {
2501 __kmp_join_ompt(gtid, master_th, parent_team, parallel_data, fork_context,
2502 codeptr);
Jonathan Peyton30419822017-05-12 18:01:32 +00002503 }
2504#endif
2505
2506 return;
2507 }
2508#endif /* OMP_40_ENABLED */
2509
2510 /* do cleanup and restore the parent team */
2511 master_th->th.th_info.ds.ds_tid = team->t.t_master_tid;
2512 master_th->th.th_local.this_construct = team->t.t_master_this_cons;
2513
2514 master_th->th.th_dispatch = &parent_team->t.t_dispatch[team->t.t_master_tid];
2515
2516 /* jc: The following lock has instructions with REL and ACQ semantics,
2517 separating the parallel user code called in this parallel region
2518 from the serial user code called after this function returns. */
2519 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
2520
2521#if OMP_40_ENABLED
2522 if (!master_th->th.th_teams_microtask ||
2523 team->t.t_level > master_th->th.th_teams_level)
2524#endif /* OMP_40_ENABLED */
2525 {
2526 /* Decrement our nested depth level */
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00002527 KMP_ATOMIC_DEC(&root->r.r_in_parallel);
Jonathan Peyton30419822017-05-12 18:01:32 +00002528 }
2529 KMP_DEBUG_ASSERT(root->r.r_in_parallel >= 0);
2530
Joachim Protze82e94a52017-11-01 10:08:30 +00002531#if OMPT_SUPPORT
2532 if (ompt_enabled.enabled) {
2533 ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
2534 if (ompt_enabled.ompt_callback_implicit_task) {
2535 int ompt_team_size = team->t.t_nproc;
2536 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
2537 ompt_scope_end, NULL, &(task_info->task_data), ompt_team_size,
Joachim Protze2b46d302019-01-15 15:36:53 +00002538 OMPT_CUR_TASK_INFO(master_th)->thread_num, ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Jonathan Peyton30419822017-05-12 18:01:32 +00002539 }
Joachim Protze82e94a52017-11-01 10:08:30 +00002540
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00002541 task_info->frame.exit_frame = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00002542 task_info->task_data = ompt_data_none;
Jonathan Peyton30419822017-05-12 18:01:32 +00002543 }
2544#endif
2545
2546 KF_TRACE(10, ("__kmp_join_call1: T#%d, this_thread=%p team=%p\n", 0,
2547 master_th, team));
2548 __kmp_pop_current_task_from_thread(master_th);
2549
2550#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
2551 // Restore master thread's partition.
2552 master_th->th.th_first_place = team->t.t_first_place;
2553 master_th->th.th_last_place = team->t.t_last_place;
2554#endif /* OMP_40_ENABLED */
Jonathan Peyton92ca6182018-09-07 18:25:49 +00002555#if OMP_50_ENABLED
2556 master_th->th.th_def_allocator = team->t.t_def_allocator;
2557#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002558
2559 updateHWFPControl(team);
2560
2561 if (root->r.r_active != master_active)
2562 root->r.r_active = master_active;
2563
2564 __kmp_free_team(root, team USE_NESTED_HOT_ARG(
2565 master_th)); // this will free worker threads
2566
2567 /* this race was fun to find. make sure the following is in the critical
2568 region otherwise assertions may fail occasionally since the old team may be
2569 reallocated and the hierarchy appears inconsistent. it is actually safe to
2570 run and won't cause any bugs, but will cause those assertion failures. it's
2571 only one deref&assign so might as well put this in the critical region */
2572 master_th->th.th_team = parent_team;
2573 master_th->th.th_team_nproc = parent_team->t.t_nproc;
2574 master_th->th.th_team_master = parent_team->t.t_threads[0];
2575 master_th->th.th_team_serialized = parent_team->t.t_serialized;
2576
2577 /* restore serialized team, if need be */
2578 if (parent_team->t.t_serialized &&
2579 parent_team != master_th->th.th_serial_team &&
2580 parent_team != root->r.r_root_team) {
2581 __kmp_free_team(root,
2582 master_th->th.th_serial_team USE_NESTED_HOT_ARG(NULL));
2583 master_th->th.th_serial_team = parent_team;
2584 }
2585
2586 if (__kmp_tasking_mode != tskm_immediate_exec) {
2587 if (master_th->th.th_task_state_top >
2588 0) { // Restore task state from memo stack
2589 KMP_DEBUG_ASSERT(master_th->th.th_task_state_memo_stack);
2590 // Remember master's state if we re-use this nested hot team
2591 master_th->th.th_task_state_memo_stack[master_th->th.th_task_state_top] =
2592 master_th->th.th_task_state;
2593 --master_th->th.th_task_state_top; // pop
2594 // Now restore state at this level
2595 master_th->th.th_task_state =
2596 master_th->th
2597 .th_task_state_memo_stack[master_th->th.th_task_state_top];
2598 }
2599 // Copy the task team from the parent team to the master thread
2600 master_th->th.th_task_team =
2601 parent_team->t.t_task_team[master_th->th.th_task_state];
2602 KA_TRACE(20,
2603 ("__kmp_join_call: Master T#%d restoring task_team %p / team %p\n",
2604 __kmp_gtid_from_thread(master_th), master_th->th.th_task_team,
2605 parent_team));
2606 }
2607
2608 // TODO: GEH - cannot do this assertion because root thread not set up as
2609 // executing
2610 // KMP_ASSERT( master_th->th.th_current_task->td_flags.executing == 0 );
2611 master_th->th.th_current_task->td_flags.executing = 1;
2612
2613 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
2614
2615#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002616 if (ompt_enabled.enabled) {
2617 __kmp_join_ompt(gtid, master_th, parent_team, parallel_data, fork_context,
2618 codeptr);
Jonathan Peyton30419822017-05-12 18:01:32 +00002619 }
2620#endif
2621
2622 KMP_MB();
2623 KA_TRACE(20, ("__kmp_join_call: exit T#%d\n", gtid));
2624}
Jim Cownie5e8470a2013-09-27 10:38:44 +00002625
2626/* Check whether we should push an internal control record onto the
2627 serial team stack. If so, do it. */
Jonathan Peyton30419822017-05-12 18:01:32 +00002628void __kmp_save_internal_controls(kmp_info_t *thread) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002629
Jonathan Peyton30419822017-05-12 18:01:32 +00002630 if (thread->th.th_team != thread->th.th_serial_team) {
2631 return;
2632 }
2633 if (thread->th.th_team->t.t_serialized > 1) {
2634 int push = 0;
2635
2636 if (thread->th.th_team->t.t_control_stack_top == NULL) {
2637 push = 1;
2638 } else {
2639 if (thread->th.th_team->t.t_control_stack_top->serial_nesting_level !=
2640 thread->th.th_team->t.t_serialized) {
2641 push = 1;
2642 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002643 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002644 if (push) { /* push a record on the serial team's stack */
2645 kmp_internal_control_t *control =
2646 (kmp_internal_control_t *)__kmp_allocate(
2647 sizeof(kmp_internal_control_t));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002648
Jonathan Peyton30419822017-05-12 18:01:32 +00002649 copy_icvs(control, &thread->th.th_current_task->td_icvs);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002650
Jonathan Peyton30419822017-05-12 18:01:32 +00002651 control->serial_nesting_level = thread->th.th_team->t.t_serialized;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002652
Jonathan Peyton30419822017-05-12 18:01:32 +00002653 control->next = thread->th.th_team->t.t_control_stack_top;
2654 thread->th.th_team->t.t_control_stack_top = control;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002655 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002656 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002657}
2658
2659/* Changes set_nproc */
Jonathan Peyton30419822017-05-12 18:01:32 +00002660void __kmp_set_num_threads(int new_nth, int gtid) {
2661 kmp_info_t *thread;
2662 kmp_root_t *root;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002663
Jonathan Peyton30419822017-05-12 18:01:32 +00002664 KF_TRACE(10, ("__kmp_set_num_threads: new __kmp_nth = %d\n", new_nth));
2665 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002666
Jonathan Peyton30419822017-05-12 18:01:32 +00002667 if (new_nth < 1)
2668 new_nth = 1;
2669 else if (new_nth > __kmp_max_nth)
2670 new_nth = __kmp_max_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002671
Jonathan Peyton30419822017-05-12 18:01:32 +00002672 KMP_COUNT_VALUE(OMP_set_numthreads, new_nth);
2673 thread = __kmp_threads[gtid];
Andrey Churbanov82318c62018-11-14 13:49:41 +00002674 if (thread->th.th_current_task->td_icvs.nproc == new_nth)
2675 return; // nothing to do
Jim Cownie5e8470a2013-09-27 10:38:44 +00002676
Jonathan Peyton30419822017-05-12 18:01:32 +00002677 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002678
Jonathan Peyton30419822017-05-12 18:01:32 +00002679 set__nproc(thread, new_nth);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002680
Jonathan Peyton30419822017-05-12 18:01:32 +00002681 // If this omp_set_num_threads() call will cause the hot team size to be
2682 // reduced (in the absence of a num_threads clause), then reduce it now,
2683 // rather than waiting for the next parallel region.
2684 root = thread->th.th_root;
2685 if (__kmp_init_parallel && (!root->r.r_active) &&
2686 (root->r.r_hot_team->t.t_nproc > new_nth)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002687#if KMP_NESTED_HOT_TEAMS
2688 && __kmp_hot_teams_max_level && !__kmp_hot_teams_mode
2689#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002690 ) {
2691 kmp_team_t *hot_team = root->r.r_hot_team;
2692 int f;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002693
Jonathan Peyton30419822017-05-12 18:01:32 +00002694 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002695
Jonathan Peyton30419822017-05-12 18:01:32 +00002696 // Release the extra threads we don't need any more.
2697 for (f = new_nth; f < hot_team->t.t_nproc; f++) {
2698 KMP_DEBUG_ASSERT(hot_team->t.t_threads[f] != NULL);
2699 if (__kmp_tasking_mode != tskm_immediate_exec) {
2700 // When decreasing team size, threads no longer in the team should unref
2701 // task team.
2702 hot_team->t.t_threads[f]->th.th_task_team = NULL;
2703 }
2704 __kmp_free_thread(hot_team->t.t_threads[f]);
2705 hot_team->t.t_threads[f] = NULL;
2706 }
2707 hot_team->t.t_nproc = new_nth;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002708#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00002709 if (thread->th.th_hot_teams) {
2710 KMP_DEBUG_ASSERT(hot_team == thread->th.th_hot_teams[0].hot_team);
2711 thread->th.th_hot_teams[0].hot_team_nth = new_nth;
2712 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002713#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002714
Jonathan Peyton30419822017-05-12 18:01:32 +00002715 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002716
Jonathan Peyton30419822017-05-12 18:01:32 +00002717 // Update the t_nproc field in the threads that are still active.
2718 for (f = 0; f < new_nth; f++) {
2719 KMP_DEBUG_ASSERT(hot_team->t.t_threads[f] != NULL);
2720 hot_team->t.t_threads[f]->th.th_team_nproc = new_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002721 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002722 // Special flag in case omp_set_num_threads() call
2723 hot_team->t.t_size_changed = -1;
2724 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002725}
2726
Jim Cownie5e8470a2013-09-27 10:38:44 +00002727/* Changes max_active_levels */
Jonathan Peyton30419822017-05-12 18:01:32 +00002728void __kmp_set_max_active_levels(int gtid, int max_active_levels) {
2729 kmp_info_t *thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002730
Jonathan Peyton30419822017-05-12 18:01:32 +00002731 KF_TRACE(10, ("__kmp_set_max_active_levels: new max_active_levels for thread "
2732 "%d = (%d)\n",
2733 gtid, max_active_levels));
2734 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002735
Jonathan Peyton30419822017-05-12 18:01:32 +00002736 // validate max_active_levels
2737 if (max_active_levels < 0) {
2738 KMP_WARNING(ActiveLevelsNegative, max_active_levels);
2739 // We ignore this call if the user has specified a negative value.
2740 // The current setting won't be changed. The last valid setting will be
2741 // used. A warning will be issued (if warnings are allowed as controlled by
2742 // the KMP_WARNINGS env var).
2743 KF_TRACE(10, ("__kmp_set_max_active_levels: the call is ignored: new "
2744 "max_active_levels for thread %d = (%d)\n",
2745 gtid, max_active_levels));
2746 return;
2747 }
2748 if (max_active_levels <= KMP_MAX_ACTIVE_LEVELS_LIMIT) {
2749 // it's OK, the max_active_levels is within the valid range: [ 0;
2750 // KMP_MAX_ACTIVE_LEVELS_LIMIT ]
2751 // We allow a zero value. (implementation defined behavior)
2752 } else {
2753 KMP_WARNING(ActiveLevelsExceedLimit, max_active_levels,
2754 KMP_MAX_ACTIVE_LEVELS_LIMIT);
2755 max_active_levels = KMP_MAX_ACTIVE_LEVELS_LIMIT;
2756 // Current upper limit is MAX_INT. (implementation defined behavior)
2757 // If the input exceeds the upper limit, we correct the input to be the
2758 // upper limit. (implementation defined behavior)
2759 // Actually, the flow should never get here until we use MAX_INT limit.
2760 }
2761 KF_TRACE(10, ("__kmp_set_max_active_levels: after validation: new "
2762 "max_active_levels for thread %d = (%d)\n",
2763 gtid, max_active_levels));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002764
Jonathan Peyton30419822017-05-12 18:01:32 +00002765 thread = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002766
Jonathan Peyton30419822017-05-12 18:01:32 +00002767 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002768
Jonathan Peyton30419822017-05-12 18:01:32 +00002769 set__max_active_levels(thread, max_active_levels);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002770}
2771
2772/* Gets max_active_levels */
Jonathan Peyton30419822017-05-12 18:01:32 +00002773int __kmp_get_max_active_levels(int gtid) {
2774 kmp_info_t *thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002775
Jonathan Peyton30419822017-05-12 18:01:32 +00002776 KF_TRACE(10, ("__kmp_get_max_active_levels: thread %d\n", gtid));
2777 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002778
Jonathan Peyton30419822017-05-12 18:01:32 +00002779 thread = __kmp_threads[gtid];
2780 KMP_DEBUG_ASSERT(thread->th.th_current_task);
2781 KF_TRACE(10, ("__kmp_get_max_active_levels: thread %d, curtask=%p, "
2782 "curtask_maxaclevel=%d\n",
2783 gtid, thread->th.th_current_task,
2784 thread->th.th_current_task->td_icvs.max_active_levels));
2785 return thread->th.th_current_task->td_icvs.max_active_levels;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002786}
2787
2788/* Changes def_sched_var ICV values (run-time schedule kind and chunk) */
Jonathan Peyton30419822017-05-12 18:01:32 +00002789void __kmp_set_schedule(int gtid, kmp_sched_t kind, int chunk) {
2790 kmp_info_t *thread;
2791 // kmp_team_t *team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002792
Jonathan Peyton30419822017-05-12 18:01:32 +00002793 KF_TRACE(10, ("__kmp_set_schedule: new schedule for thread %d = (%d, %d)\n",
2794 gtid, (int)kind, chunk));
2795 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002796
Jonathan Peyton30419822017-05-12 18:01:32 +00002797 // Check if the kind parameter is valid, correct if needed.
2798 // Valid parameters should fit in one of two intervals - standard or extended:
2799 // <lower>, <valid>, <upper_std>, <lower_ext>, <valid>, <upper>
2800 // 2008-01-25: 0, 1 - 4, 5, 100, 101 - 102, 103
2801 if (kind <= kmp_sched_lower || kind >= kmp_sched_upper ||
2802 (kind <= kmp_sched_lower_ext && kind >= kmp_sched_upper_std)) {
2803 // TODO: Hint needs attention in case we change the default schedule.
2804 __kmp_msg(kmp_ms_warning, KMP_MSG(ScheduleKindOutOfRange, kind),
2805 KMP_HNT(DefaultScheduleKindUsed, "static, no chunk"),
2806 __kmp_msg_null);
2807 kind = kmp_sched_default;
2808 chunk = 0; // ignore chunk value in case of bad kind
2809 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002810
Jonathan Peyton30419822017-05-12 18:01:32 +00002811 thread = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002812
Jonathan Peyton30419822017-05-12 18:01:32 +00002813 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002814
Jonathan Peyton30419822017-05-12 18:01:32 +00002815 if (kind < kmp_sched_upper_std) {
2816 if (kind == kmp_sched_static && chunk < KMP_DEFAULT_CHUNK) {
2817 // differ static chunked vs. unchunked: chunk should be invalid to
2818 // indicate unchunked schedule (which is the default)
2819 thread->th.th_current_task->td_icvs.sched.r_sched_type = kmp_sch_static;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002820 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002821 thread->th.th_current_task->td_icvs.sched.r_sched_type =
2822 __kmp_sch_map[kind - kmp_sched_lower - 1];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002823 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002824 } else {
2825 // __kmp_sch_map[ kind - kmp_sched_lower_ext + kmp_sched_upper_std -
2826 // kmp_sched_lower - 2 ];
2827 thread->th.th_current_task->td_icvs.sched.r_sched_type =
2828 __kmp_sch_map[kind - kmp_sched_lower_ext + kmp_sched_upper_std -
2829 kmp_sched_lower - 2];
2830 }
Andrey Churbanovd454c732017-06-05 17:17:33 +00002831 if (kind == kmp_sched_auto || chunk < 1) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002832 // ignore parameter chunk for schedule auto
2833 thread->th.th_current_task->td_icvs.sched.chunk = KMP_DEFAULT_CHUNK;
2834 } else {
2835 thread->th.th_current_task->td_icvs.sched.chunk = chunk;
2836 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002837}
2838
2839/* Gets def_sched_var ICV values */
Jonathan Peyton30419822017-05-12 18:01:32 +00002840void __kmp_get_schedule(int gtid, kmp_sched_t *kind, int *chunk) {
2841 kmp_info_t *thread;
2842 enum sched_type th_type;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002843
Jonathan Peyton30419822017-05-12 18:01:32 +00002844 KF_TRACE(10, ("__kmp_get_schedule: thread %d\n", gtid));
2845 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002846
Jonathan Peyton30419822017-05-12 18:01:32 +00002847 thread = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002848
Jonathan Peyton30419822017-05-12 18:01:32 +00002849 th_type = thread->th.th_current_task->td_icvs.sched.r_sched_type;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002850
Jonathan Peyton30419822017-05-12 18:01:32 +00002851 switch (th_type) {
2852 case kmp_sch_static:
2853 case kmp_sch_static_greedy:
2854 case kmp_sch_static_balanced:
2855 *kind = kmp_sched_static;
2856 *chunk = 0; // chunk was not set, try to show this fact via zero value
2857 return;
2858 case kmp_sch_static_chunked:
2859 *kind = kmp_sched_static;
2860 break;
2861 case kmp_sch_dynamic_chunked:
2862 *kind = kmp_sched_dynamic;
2863 break;
2864 case kmp_sch_guided_chunked:
2865 case kmp_sch_guided_iterative_chunked:
2866 case kmp_sch_guided_analytical_chunked:
2867 *kind = kmp_sched_guided;
2868 break;
2869 case kmp_sch_auto:
2870 *kind = kmp_sched_auto;
2871 break;
2872 case kmp_sch_trapezoidal:
2873 *kind = kmp_sched_trapezoidal;
2874 break;
Jonathan Peytona1234cf2016-10-07 18:01:35 +00002875#if KMP_STATIC_STEAL_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002876 case kmp_sch_static_steal:
2877 *kind = kmp_sched_static_steal;
2878 break;
Jonathan Peytona1234cf2016-10-07 18:01:35 +00002879#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002880 default:
2881 KMP_FATAL(UnknownSchedulingType, th_type);
2882 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002883
Jonathan Peyton30419822017-05-12 18:01:32 +00002884 *chunk = thread->th.th_current_task->td_icvs.sched.chunk;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002885}
2886
Jonathan Peyton30419822017-05-12 18:01:32 +00002887int __kmp_get_ancestor_thread_num(int gtid, int level) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002888
Jonathan Peyton30419822017-05-12 18:01:32 +00002889 int ii, dd;
2890 kmp_team_t *team;
2891 kmp_info_t *thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002892
Jonathan Peyton30419822017-05-12 18:01:32 +00002893 KF_TRACE(10, ("__kmp_get_ancestor_thread_num: thread %d %d\n", gtid, level));
2894 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002895
Jonathan Peyton30419822017-05-12 18:01:32 +00002896 // validate level
2897 if (level == 0)
2898 return 0;
2899 if (level < 0)
2900 return -1;
2901 thr = __kmp_threads[gtid];
2902 team = thr->th.th_team;
2903 ii = team->t.t_level;
2904 if (level > ii)
2905 return -1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002906
2907#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002908 if (thr->th.th_teams_microtask) {
2909 // AC: we are in teams region where multiple nested teams have same level
2910 int tlevel = thr->th.th_teams_level; // the level of the teams construct
2911 if (level <=
2912 tlevel) { // otherwise usual algorithm works (will not touch the teams)
2913 KMP_DEBUG_ASSERT(ii >= tlevel);
2914 // AC: As we need to pass by the teams league, we need to artificially
2915 // increase ii
2916 if (ii == tlevel) {
2917 ii += 2; // three teams have same level
2918 } else {
2919 ii++; // two teams have same level
2920 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002921 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002922 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002923#endif
2924
Jonathan Peyton30419822017-05-12 18:01:32 +00002925 if (ii == level)
2926 return __kmp_tid_from_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002927
Jonathan Peyton30419822017-05-12 18:01:32 +00002928 dd = team->t.t_serialized;
2929 level++;
2930 while (ii > level) {
2931 for (dd = team->t.t_serialized; (dd > 0) && (ii > level); dd--, ii--) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002932 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002933 if ((team->t.t_serialized) && (!dd)) {
2934 team = team->t.t_parent;
2935 continue;
2936 }
2937 if (ii > level) {
2938 team = team->t.t_parent;
2939 dd = team->t.t_serialized;
2940 ii--;
2941 }
2942 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002943
Jonathan Peyton30419822017-05-12 18:01:32 +00002944 return (dd > 1) ? (0) : (team->t.t_master_tid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002945}
2946
Jonathan Peyton30419822017-05-12 18:01:32 +00002947int __kmp_get_team_size(int gtid, int level) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002948
Jonathan Peyton30419822017-05-12 18:01:32 +00002949 int ii, dd;
2950 kmp_team_t *team;
2951 kmp_info_t *thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002952
Jonathan Peyton30419822017-05-12 18:01:32 +00002953 KF_TRACE(10, ("__kmp_get_team_size: thread %d %d\n", gtid, level));
2954 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002955
Jonathan Peyton30419822017-05-12 18:01:32 +00002956 // validate level
2957 if (level == 0)
2958 return 1;
2959 if (level < 0)
2960 return -1;
2961 thr = __kmp_threads[gtid];
2962 team = thr->th.th_team;
2963 ii = team->t.t_level;
2964 if (level > ii)
2965 return -1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002966
2967#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002968 if (thr->th.th_teams_microtask) {
2969 // AC: we are in teams region where multiple nested teams have same level
2970 int tlevel = thr->th.th_teams_level; // the level of the teams construct
2971 if (level <=
2972 tlevel) { // otherwise usual algorithm works (will not touch the teams)
2973 KMP_DEBUG_ASSERT(ii >= tlevel);
2974 // AC: As we need to pass by the teams league, we need to artificially
2975 // increase ii
2976 if (ii == tlevel) {
2977 ii += 2; // three teams have same level
2978 } else {
2979 ii++; // two teams have same level
2980 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002981 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002982 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002983#endif
2984
Jonathan Peyton30419822017-05-12 18:01:32 +00002985 while (ii > level) {
2986 for (dd = team->t.t_serialized; (dd > 0) && (ii > level); dd--, ii--) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002987 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002988 if (team->t.t_serialized && (!dd)) {
2989 team = team->t.t_parent;
2990 continue;
2991 }
2992 if (ii > level) {
2993 team = team->t.t_parent;
2994 ii--;
2995 }
2996 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002997
Jonathan Peyton30419822017-05-12 18:01:32 +00002998 return team->t.t_nproc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002999}
3000
Jonathan Peyton30419822017-05-12 18:01:32 +00003001kmp_r_sched_t __kmp_get_schedule_global() {
3002 // This routine created because pairs (__kmp_sched, __kmp_chunk) and
3003 // (__kmp_static, __kmp_guided) may be changed by kmp_set_defaults
3004 // independently. So one can get the updated schedule here.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003005
Jonathan Peyton30419822017-05-12 18:01:32 +00003006 kmp_r_sched_t r_sched;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003007
Jonathan Peyton30419822017-05-12 18:01:32 +00003008 // create schedule from 4 globals: __kmp_sched, __kmp_chunk, __kmp_static,
3009 // __kmp_guided. __kmp_sched should keep original value, so that user can set
3010 // KMP_SCHEDULE multiple times, and thus have different run-time schedules in
3011 // different roots (even in OMP 2.5)
3012 if (__kmp_sched == kmp_sch_static) {
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00003013 // replace STATIC with more detailed schedule (balanced or greedy)
3014 r_sched.r_sched_type = __kmp_static;
Jonathan Peyton30419822017-05-12 18:01:32 +00003015 } else if (__kmp_sched == kmp_sch_guided_chunked) {
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00003016 // replace GUIDED with more detailed schedule (iterative or analytical)
3017 r_sched.r_sched_type = __kmp_guided;
3018 } else { // (STATIC_CHUNKED), or (DYNAMIC_CHUNKED), or other
3019 r_sched.r_sched_type = __kmp_sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00003020 }
3021
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00003022 if (__kmp_chunk < KMP_DEFAULT_CHUNK) {
3023 // __kmp_chunk may be wrong here (if it was not ever set)
Jonathan Peyton30419822017-05-12 18:01:32 +00003024 r_sched.chunk = KMP_DEFAULT_CHUNK;
3025 } else {
3026 r_sched.chunk = __kmp_chunk;
3027 }
3028
3029 return r_sched;
3030}
3031
3032/* Allocate (realloc == FALSE) * or reallocate (realloc == TRUE)
3033 at least argc number of *t_argv entries for the requested team. */
3034static void __kmp_alloc_argv_entries(int argc, kmp_team_t *team, int realloc) {
3035
3036 KMP_DEBUG_ASSERT(team);
3037 if (!realloc || argc > team->t.t_max_argc) {
3038
3039 KA_TRACE(100, ("__kmp_alloc_argv_entries: team %d: needed entries=%d, "
3040 "current entries=%d\n",
3041 team->t.t_id, argc, (realloc) ? team->t.t_max_argc : 0));
3042 /* if previously allocated heap space for args, free them */
3043 if (realloc && team->t.t_argv != &team->t.t_inline_argv[0])
3044 __kmp_free((void *)team->t.t_argv);
3045
3046 if (argc <= KMP_INLINE_ARGV_ENTRIES) {
3047 /* use unused space in the cache line for arguments */
3048 team->t.t_max_argc = KMP_INLINE_ARGV_ENTRIES;
3049 KA_TRACE(100, ("__kmp_alloc_argv_entries: team %d: inline allocate %d "
3050 "argv entries\n",
3051 team->t.t_id, team->t.t_max_argc));
3052 team->t.t_argv = &team->t.t_inline_argv[0];
3053 if (__kmp_storage_map) {
3054 __kmp_print_storage_map_gtid(
3055 -1, &team->t.t_inline_argv[0],
3056 &team->t.t_inline_argv[KMP_INLINE_ARGV_ENTRIES],
3057 (sizeof(void *) * KMP_INLINE_ARGV_ENTRIES), "team_%d.t_inline_argv",
3058 team->t.t_id);
3059 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003060 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00003061 /* allocate space for arguments in the heap */
3062 team->t.t_max_argc = (argc <= (KMP_MIN_MALLOC_ARGV_ENTRIES >> 1))
3063 ? KMP_MIN_MALLOC_ARGV_ENTRIES
3064 : 2 * argc;
3065 KA_TRACE(100, ("__kmp_alloc_argv_entries: team %d: dynamic allocate %d "
3066 "argv entries\n",
3067 team->t.t_id, team->t.t_max_argc));
3068 team->t.t_argv =
3069 (void **)__kmp_page_allocate(sizeof(void *) * team->t.t_max_argc);
3070 if (__kmp_storage_map) {
3071 __kmp_print_storage_map_gtid(-1, &team->t.t_argv[0],
3072 &team->t.t_argv[team->t.t_max_argc],
3073 sizeof(void *) * team->t.t_max_argc,
3074 "team_%d.t_argv", team->t.t_id);
3075 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003076 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003077 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003078}
3079
Jonathan Peyton30419822017-05-12 18:01:32 +00003080static void __kmp_allocate_team_arrays(kmp_team_t *team, int max_nth) {
3081 int i;
3082 int num_disp_buff = max_nth > 1 ? __kmp_dispatch_num_buffers : 2;
3083 team->t.t_threads =
3084 (kmp_info_t **)__kmp_allocate(sizeof(kmp_info_t *) * max_nth);
3085 team->t.t_disp_buffer = (dispatch_shared_info_t *)__kmp_allocate(
3086 sizeof(dispatch_shared_info_t) * num_disp_buff);
3087 team->t.t_dispatch =
3088 (kmp_disp_t *)__kmp_allocate(sizeof(kmp_disp_t) * max_nth);
3089 team->t.t_implicit_task_taskdata =
3090 (kmp_taskdata_t *)__kmp_allocate(sizeof(kmp_taskdata_t) * max_nth);
3091 team->t.t_max_nproc = max_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003092
Jonathan Peyton30419822017-05-12 18:01:32 +00003093 /* setup dispatch buffers */
3094 for (i = 0; i < num_disp_buff; ++i) {
3095 team->t.t_disp_buffer[i].buffer_index = i;
Jonathan Peytondf6818b2016-06-14 17:57:47 +00003096#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003097 team->t.t_disp_buffer[i].doacross_buf_idx = i;
Jonathan Peyton71909c52016-03-02 22:42:06 +00003098#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003099 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003100}
3101
Jonathan Peyton30419822017-05-12 18:01:32 +00003102static void __kmp_free_team_arrays(kmp_team_t *team) {
3103 /* Note: this does not free the threads in t_threads (__kmp_free_threads) */
3104 int i;
3105 for (i = 0; i < team->t.t_max_nproc; ++i) {
3106 if (team->t.t_dispatch[i].th_disp_buffer != NULL) {
3107 __kmp_free(team->t.t_dispatch[i].th_disp_buffer);
3108 team->t.t_dispatch[i].th_disp_buffer = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003109 }
3110 }
Jonathan Peytonf6399362018-07-09 17:51:13 +00003111#if KMP_USE_HIER_SCHED
3112 __kmp_dispatch_free_hierarchies(team);
3113#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003114 __kmp_free(team->t.t_threads);
3115 __kmp_free(team->t.t_disp_buffer);
3116 __kmp_free(team->t.t_dispatch);
3117 __kmp_free(team->t.t_implicit_task_taskdata);
3118 team->t.t_threads = NULL;
3119 team->t.t_disp_buffer = NULL;
3120 team->t.t_dispatch = NULL;
3121 team->t.t_implicit_task_taskdata = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003122}
3123
Jonathan Peyton30419822017-05-12 18:01:32 +00003124static void __kmp_reallocate_team_arrays(kmp_team_t *team, int max_nth) {
3125 kmp_info_t **oldThreads = team->t.t_threads;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003126
Jonathan Peyton30419822017-05-12 18:01:32 +00003127 __kmp_free(team->t.t_disp_buffer);
3128 __kmp_free(team->t.t_dispatch);
3129 __kmp_free(team->t.t_implicit_task_taskdata);
3130 __kmp_allocate_team_arrays(team, max_nth);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003131
Jonathan Peyton30419822017-05-12 18:01:32 +00003132 KMP_MEMCPY(team->t.t_threads, oldThreads,
3133 team->t.t_nproc * sizeof(kmp_info_t *));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003134
Jonathan Peyton30419822017-05-12 18:01:32 +00003135 __kmp_free(oldThreads);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003136}
3137
Jonathan Peyton30419822017-05-12 18:01:32 +00003138static kmp_internal_control_t __kmp_get_global_icvs(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003139
Jonathan Peyton30419822017-05-12 18:01:32 +00003140 kmp_r_sched_t r_sched =
3141 __kmp_get_schedule_global(); // get current state of scheduling globals
Jim Cownie5e8470a2013-09-27 10:38:44 +00003142
3143#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003144 KMP_DEBUG_ASSERT(__kmp_nested_proc_bind.used > 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003145#endif /* OMP_40_ENABLED */
3146
Jonathan Peyton30419822017-05-12 18:01:32 +00003147 kmp_internal_control_t g_icvs = {
3148 0, // int serial_nesting_level; //corresponds to value of th_team_serialized
Jonathan Peyton30419822017-05-12 18:01:32 +00003149 (kmp_int8)__kmp_global.g.g_dynamic, // internal control for dynamic
3150 // adjustment of threads (per thread)
3151 (kmp_int8)__kmp_env_blocktime, // int bt_set; //internal control for
3152 // whether blocktime is explicitly set
3153 __kmp_dflt_blocktime, // int blocktime; //internal control for blocktime
Jonathan Peytone1c7c132016-10-07 18:12:19 +00003154#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00003155 __kmp_bt_intervals, // int bt_intervals; //internal control for blocktime
3156// intervals
Jonathan Peytone1c7c132016-10-07 18:12:19 +00003157#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003158 __kmp_dflt_team_nth, // int nproc; //internal control for # of threads for
3159 // next parallel region (per thread)
3160 // (use a max ub on value if __kmp_parallel_initialize not called yet)
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00003161 __kmp_cg_max_nth, // int thread_limit;
Jonathan Peyton30419822017-05-12 18:01:32 +00003162 __kmp_dflt_max_active_levels, // int max_active_levels; //internal control
3163 // for max_active_levels
3164 r_sched, // kmp_r_sched_t sched; //internal control for runtime schedule
3165// {sched,chunk} pair
Jim Cownie5e8470a2013-09-27 10:38:44 +00003166#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003167 __kmp_nested_proc_bind.bind_types[0],
3168 __kmp_default_device,
Jim Cownie5e8470a2013-09-27 10:38:44 +00003169#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00003170 NULL // struct kmp_internal_control *next;
3171 };
Jim Cownie5e8470a2013-09-27 10:38:44 +00003172
Jonathan Peyton30419822017-05-12 18:01:32 +00003173 return g_icvs;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003174}
3175
Jonathan Peyton30419822017-05-12 18:01:32 +00003176static kmp_internal_control_t __kmp_get_x_global_icvs(const kmp_team_t *team) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003177
Jonathan Peyton30419822017-05-12 18:01:32 +00003178 kmp_internal_control_t gx_icvs;
3179 gx_icvs.serial_nesting_level =
3180 0; // probably =team->t.t_serial like in save_inter_controls
3181 copy_icvs(&gx_icvs, &team->t.t_threads[0]->th.th_current_task->td_icvs);
3182 gx_icvs.next = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003183
Jonathan Peyton30419822017-05-12 18:01:32 +00003184 return gx_icvs;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003185}
3186
Jonathan Peyton30419822017-05-12 18:01:32 +00003187static void __kmp_initialize_root(kmp_root_t *root) {
3188 int f;
3189 kmp_team_t *root_team;
3190 kmp_team_t *hot_team;
3191 int hot_team_max_nth;
3192 kmp_r_sched_t r_sched =
3193 __kmp_get_schedule_global(); // get current state of scheduling globals
3194 kmp_internal_control_t r_icvs = __kmp_get_global_icvs();
3195 KMP_DEBUG_ASSERT(root);
3196 KMP_ASSERT(!root->r.r_begin);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003197
Jonathan Peyton30419822017-05-12 18:01:32 +00003198 /* setup the root state structure */
3199 __kmp_init_lock(&root->r.r_begin_lock);
3200 root->r.r_begin = FALSE;
3201 root->r.r_active = FALSE;
3202 root->r.r_in_parallel = 0;
3203 root->r.r_blocktime = __kmp_dflt_blocktime;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003204
Jonathan Peyton30419822017-05-12 18:01:32 +00003205 /* setup the root team for this task */
3206 /* allocate the root team structure */
3207 KF_TRACE(10, ("__kmp_initialize_root: before root_team\n"));
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003208
Jonathan Peyton30419822017-05-12 18:01:32 +00003209 root_team =
3210 __kmp_allocate_team(root,
3211 1, // new_nproc
3212 1, // max_nproc
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003213#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003214 ompt_data_none, // root parallel id
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003215#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003216#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003217 __kmp_nested_proc_bind.bind_types[0],
Jim Cownie5e8470a2013-09-27 10:38:44 +00003218#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003219 &r_icvs,
3220 0 // argc
3221 USE_NESTED_HOT_ARG(NULL) // master thread is unknown
3222 );
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00003223#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00003224 // Non-NULL value should be assigned to make the debugger display the root
3225 // team.
3226 TCW_SYNC_PTR(root_team->t.t_pkfn, (microtask_t)(~0));
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00003227#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003228
Jonathan Peyton30419822017-05-12 18:01:32 +00003229 KF_TRACE(10, ("__kmp_initialize_root: after root_team = %p\n", root_team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003230
Jonathan Peyton30419822017-05-12 18:01:32 +00003231 root->r.r_root_team = root_team;
3232 root_team->t.t_control_stack_top = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003233
Jonathan Peyton30419822017-05-12 18:01:32 +00003234 /* initialize root team */
3235 root_team->t.t_threads[0] = NULL;
3236 root_team->t.t_nproc = 1;
3237 root_team->t.t_serialized = 1;
3238 // TODO???: root_team->t.t_max_active_levels = __kmp_dflt_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00003239 root_team->t.t_sched.sched = r_sched.sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00003240 KA_TRACE(
3241 20,
3242 ("__kmp_initialize_root: init root team %d arrived: join=%u, plain=%u\n",
3243 root_team->t.t_id, KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003244
Jonathan Peyton30419822017-05-12 18:01:32 +00003245 /* setup the hot team for this task */
3246 /* allocate the hot team structure */
3247 KF_TRACE(10, ("__kmp_initialize_root: before hot_team\n"));
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003248
Jonathan Peyton30419822017-05-12 18:01:32 +00003249 hot_team =
3250 __kmp_allocate_team(root,
3251 1, // new_nproc
3252 __kmp_dflt_team_nth_ub * 2, // max_nproc
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003253#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003254 ompt_data_none, // root parallel id
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003255#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003256#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003257 __kmp_nested_proc_bind.bind_types[0],
Jim Cownie5e8470a2013-09-27 10:38:44 +00003258#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003259 &r_icvs,
3260 0 // argc
3261 USE_NESTED_HOT_ARG(NULL) // master thread is unknown
3262 );
3263 KF_TRACE(10, ("__kmp_initialize_root: after hot_team = %p\n", hot_team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003264
Jonathan Peyton30419822017-05-12 18:01:32 +00003265 root->r.r_hot_team = hot_team;
3266 root_team->t.t_control_stack_top = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003267
Jonathan Peyton30419822017-05-12 18:01:32 +00003268 /* first-time initialization */
3269 hot_team->t.t_parent = root_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003270
Jonathan Peyton30419822017-05-12 18:01:32 +00003271 /* initialize hot team */
3272 hot_team_max_nth = hot_team->t.t_max_nproc;
3273 for (f = 0; f < hot_team_max_nth; ++f) {
3274 hot_team->t.t_threads[f] = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003275 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003276 hot_team->t.t_nproc = 1;
3277 // TODO???: hot_team->t.t_max_active_levels = __kmp_dflt_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00003278 hot_team->t.t_sched.sched = r_sched.sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00003279 hot_team->t.t_size_changed = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003280}
3281
3282#ifdef KMP_DEBUG
3283
Jim Cownie5e8470a2013-09-27 10:38:44 +00003284typedef struct kmp_team_list_item {
Jonathan Peyton30419822017-05-12 18:01:32 +00003285 kmp_team_p const *entry;
3286 struct kmp_team_list_item *next;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003287} kmp_team_list_item_t;
Jonathan Peyton30419822017-05-12 18:01:32 +00003288typedef kmp_team_list_item_t *kmp_team_list_t;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003289
Jonathan Peyton30419822017-05-12 18:01:32 +00003290static void __kmp_print_structure_team_accum( // Add team to list of teams.
3291 kmp_team_list_t list, // List of teams.
3292 kmp_team_p const *team // Team to add.
3293 ) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003294
Jonathan Peyton30419822017-05-12 18:01:32 +00003295 // List must terminate with item where both entry and next are NULL.
3296 // Team is added to the list only once.
3297 // List is sorted in ascending order by team id.
3298 // Team id is *not* a key.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003299
Jonathan Peyton30419822017-05-12 18:01:32 +00003300 kmp_team_list_t l;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003301
Jonathan Peyton30419822017-05-12 18:01:32 +00003302 KMP_DEBUG_ASSERT(list != NULL);
3303 if (team == NULL) {
3304 return;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003305 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003306
Jonathan Peyton30419822017-05-12 18:01:32 +00003307 __kmp_print_structure_team_accum(list, team->t.t_parent);
3308 __kmp_print_structure_team_accum(list, team->t.t_next_pool);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003309
Jonathan Peyton30419822017-05-12 18:01:32 +00003310 // Search list for the team.
3311 l = list;
3312 while (l->next != NULL && l->entry != team) {
3313 l = l->next;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003314 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003315 if (l->next != NULL) {
3316 return; // Team has been added before, exit.
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003317 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003318
Jonathan Peyton30419822017-05-12 18:01:32 +00003319 // Team is not found. Search list again for insertion point.
3320 l = list;
3321 while (l->next != NULL && l->entry->t.t_id <= team->t.t_id) {
3322 l = l->next;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003323 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003324
Jonathan Peyton30419822017-05-12 18:01:32 +00003325 // Insert team.
3326 {
3327 kmp_team_list_item_t *item = (kmp_team_list_item_t *)KMP_INTERNAL_MALLOC(
3328 sizeof(kmp_team_list_item_t));
3329 *item = *l;
3330 l->entry = team;
3331 l->next = item;
3332 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003333}
3334
Jonathan Peyton30419822017-05-12 18:01:32 +00003335static void __kmp_print_structure_team(char const *title, kmp_team_p const *team
Jim Cownie5e8470a2013-09-27 10:38:44 +00003336
Jonathan Peyton30419822017-05-12 18:01:32 +00003337 ) {
3338 __kmp_printf("%s", title);
3339 if (team != NULL) {
3340 __kmp_printf("%2x %p\n", team->t.t_id, team);
3341 } else {
3342 __kmp_printf(" - (nil)\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003343 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003344}
3345
Jonathan Peyton30419822017-05-12 18:01:32 +00003346static void __kmp_print_structure_thread(char const *title,
3347 kmp_info_p const *thread) {
3348 __kmp_printf("%s", title);
3349 if (thread != NULL) {
3350 __kmp_printf("%2d %p\n", thread->th.th_info.ds.ds_gtid, thread);
3351 } else {
3352 __kmp_printf(" - (nil)\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003353 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003354}
3355
Jonathan Peyton30419822017-05-12 18:01:32 +00003356void __kmp_print_structure(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003357
Jonathan Peyton30419822017-05-12 18:01:32 +00003358 kmp_team_list_t list;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003359
Jonathan Peyton30419822017-05-12 18:01:32 +00003360 // Initialize list of teams.
3361 list =
3362 (kmp_team_list_item_t *)KMP_INTERNAL_MALLOC(sizeof(kmp_team_list_item_t));
3363 list->entry = NULL;
3364 list->next = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003365
Jonathan Peyton30419822017-05-12 18:01:32 +00003366 __kmp_printf("\n------------------------------\nGlobal Thread "
3367 "Table\n------------------------------\n");
3368 {
3369 int gtid;
3370 for (gtid = 0; gtid < __kmp_threads_capacity; ++gtid) {
3371 __kmp_printf("%2d", gtid);
3372 if (__kmp_threads != NULL) {
3373 __kmp_printf(" %p", __kmp_threads[gtid]);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003374 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003375 if (__kmp_root != NULL) {
3376 __kmp_printf(" %p", __kmp_root[gtid]);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003377 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003378 __kmp_printf("\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003379 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003380 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003381
Jonathan Peyton30419822017-05-12 18:01:32 +00003382 // Print out __kmp_threads array.
3383 __kmp_printf("\n------------------------------\nThreads\n--------------------"
3384 "----------\n");
3385 if (__kmp_threads != NULL) {
3386 int gtid;
3387 for (gtid = 0; gtid < __kmp_threads_capacity; ++gtid) {
3388 kmp_info_t const *thread = __kmp_threads[gtid];
3389 if (thread != NULL) {
3390 __kmp_printf("GTID %2d %p:\n", gtid, thread);
3391 __kmp_printf(" Our Root: %p\n", thread->th.th_root);
3392 __kmp_print_structure_team(" Our Team: ", thread->th.th_team);
3393 __kmp_print_structure_team(" Serial Team: ",
3394 thread->th.th_serial_team);
3395 __kmp_printf(" Threads: %2d\n", thread->th.th_team_nproc);
3396 __kmp_print_structure_thread(" Master: ",
3397 thread->th.th_team_master);
3398 __kmp_printf(" Serialized?: %2d\n", thread->th.th_team_serialized);
3399 __kmp_printf(" Set NProc: %2d\n", thread->th.th_set_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003400#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003401 __kmp_printf(" Set Proc Bind: %2d\n", thread->th.th_set_proc_bind);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003402#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003403 __kmp_print_structure_thread(" Next in pool: ",
3404 thread->th.th_next_pool);
3405 __kmp_printf("\n");
3406 __kmp_print_structure_team_accum(list, thread->th.th_team);
3407 __kmp_print_structure_team_accum(list, thread->th.th_serial_team);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003408 }
3409 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003410 } else {
3411 __kmp_printf("Threads array is not allocated.\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003412 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003413
Jonathan Peyton30419822017-05-12 18:01:32 +00003414 // Print out __kmp_root array.
3415 __kmp_printf("\n------------------------------\nUbers\n----------------------"
3416 "--------\n");
3417 if (__kmp_root != NULL) {
3418 int gtid;
3419 for (gtid = 0; gtid < __kmp_threads_capacity; ++gtid) {
3420 kmp_root_t const *root = __kmp_root[gtid];
3421 if (root != NULL) {
3422 __kmp_printf("GTID %2d %p:\n", gtid, root);
3423 __kmp_print_structure_team(" Root Team: ", root->r.r_root_team);
3424 __kmp_print_structure_team(" Hot Team: ", root->r.r_hot_team);
3425 __kmp_print_structure_thread(" Uber Thread: ",
3426 root->r.r_uber_thread);
3427 __kmp_printf(" Active?: %2d\n", root->r.r_active);
Jonathan Peyton61d44f12018-07-09 18:09:25 +00003428 __kmp_printf(" In Parallel: %2d\n",
3429 KMP_ATOMIC_LD_RLX(&root->r.r_in_parallel));
Jonathan Peyton30419822017-05-12 18:01:32 +00003430 __kmp_printf("\n");
3431 __kmp_print_structure_team_accum(list, root->r.r_root_team);
3432 __kmp_print_structure_team_accum(list, root->r.r_hot_team);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003433 }
3434 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003435 } else {
3436 __kmp_printf("Ubers array is not allocated.\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003437 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003438
Jonathan Peyton30419822017-05-12 18:01:32 +00003439 __kmp_printf("\n------------------------------\nTeams\n----------------------"
3440 "--------\n");
3441 while (list->next != NULL) {
3442 kmp_team_p const *team = list->entry;
3443 int i;
3444 __kmp_printf("Team %2x %p:\n", team->t.t_id, team);
3445 __kmp_print_structure_team(" Parent Team: ", team->t.t_parent);
3446 __kmp_printf(" Master TID: %2d\n", team->t.t_master_tid);
3447 __kmp_printf(" Max threads: %2d\n", team->t.t_max_nproc);
3448 __kmp_printf(" Levels of serial: %2d\n", team->t.t_serialized);
3449 __kmp_printf(" Number threads: %2d\n", team->t.t_nproc);
3450 for (i = 0; i < team->t.t_nproc; ++i) {
3451 __kmp_printf(" Thread %2d: ", i);
3452 __kmp_print_structure_thread("", team->t.t_threads[i]);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003453 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003454 __kmp_print_structure_team(" Next in pool: ", team->t.t_next_pool);
3455 __kmp_printf("\n");
3456 list = list->next;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003457 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003458
Jonathan Peyton30419822017-05-12 18:01:32 +00003459 // Print out __kmp_thread_pool and __kmp_team_pool.
3460 __kmp_printf("\n------------------------------\nPools\n----------------------"
3461 "--------\n");
3462 __kmp_print_structure_thread("Thread pool: ",
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00003463 CCAST(kmp_info_t *, __kmp_thread_pool));
Jonathan Peyton30419822017-05-12 18:01:32 +00003464 __kmp_print_structure_team("Team pool: ",
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00003465 CCAST(kmp_team_t *, __kmp_team_pool));
Jonathan Peyton30419822017-05-12 18:01:32 +00003466 __kmp_printf("\n");
Jim Cownie5e8470a2013-09-27 10:38:44 +00003467
Jonathan Peyton30419822017-05-12 18:01:32 +00003468 // Free team list.
3469 while (list != NULL) {
3470 kmp_team_list_item_t *item = list;
3471 list = list->next;
3472 KMP_INTERNAL_FREE(item);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003473 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003474}
3475
3476#endif
3477
Jim Cownie5e8470a2013-09-27 10:38:44 +00003478//---------------------------------------------------------------------------
3479// Stuff for per-thread fast random number generator
3480// Table of primes
Jim Cownie5e8470a2013-09-27 10:38:44 +00003481static const unsigned __kmp_primes[] = {
Jonathan Peyton30419822017-05-12 18:01:32 +00003482 0x9e3779b1, 0xffe6cc59, 0x2109f6dd, 0x43977ab5, 0xba5703f5, 0xb495a877,
3483 0xe1626741, 0x79695e6b, 0xbc98c09f, 0xd5bee2b3, 0x287488f9, 0x3af18231,
3484 0x9677cd4d, 0xbe3a6929, 0xadc6a877, 0xdcf0674b, 0xbe4d6fe9, 0x5f15e201,
3485 0x99afc3fd, 0xf3f16801, 0xe222cfff, 0x24ba5fdb, 0x0620452d, 0x79f149e3,
3486 0xc8b93f49, 0x972702cd, 0xb07dd827, 0x6c97d5ed, 0x085a3d61, 0x46eb5ea7,
3487 0x3d9910ed, 0x2e687b5b, 0x29609227, 0x6eb081f1, 0x0954c4e1, 0x9d114db9,
3488 0x542acfa9, 0xb3e6bd7b, 0x0742d917, 0xe9f3ffa7, 0x54581edb, 0xf2480f45,
3489 0x0bb9288f, 0xef1affc7, 0x85fa0ca7, 0x3ccc14db, 0xe6baf34b, 0x343377f7,
3490 0x5ca19031, 0xe6d9293b, 0xf0a9f391, 0x5d2e980b, 0xfc411073, 0xc3749363,
3491 0xb892d829, 0x3549366b, 0x629750ad, 0xb98294e5, 0x892d9483, 0xc235baf3,
3492 0x3d2402a3, 0x6bdef3c9, 0xbec333cd, 0x40c9520f};
Jim Cownie5e8470a2013-09-27 10:38:44 +00003493
3494//---------------------------------------------------------------------------
3495// __kmp_get_random: Get a random number using a linear congruential method.
Jonathan Peyton30419822017-05-12 18:01:32 +00003496unsigned short __kmp_get_random(kmp_info_t *thread) {
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003497 unsigned x = thread->th.th_x;
Jonathan Peyton30419822017-05-12 18:01:32 +00003498 unsigned short r = x >> 16;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003499
Jonathan Peyton30419822017-05-12 18:01:32 +00003500 thread->th.th_x = x * thread->th.th_a + 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003501
3502 KA_TRACE(30, ("__kmp_get_random: THREAD: %d, RETURN: %u\n",
Jonathan Peyton30419822017-05-12 18:01:32 +00003503 thread->th.th_info.ds.ds_tid, r));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003504
3505 return r;
3506}
3507//--------------------------------------------------------
3508// __kmp_init_random: Initialize a random number generator
Jonathan Peyton30419822017-05-12 18:01:32 +00003509void __kmp_init_random(kmp_info_t *thread) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003510 unsigned seed = thread->th.th_info.ds.ds_tid;
3511
Jonathan Peyton30419822017-05-12 18:01:32 +00003512 thread->th.th_a =
3513 __kmp_primes[seed % (sizeof(__kmp_primes) / sizeof(__kmp_primes[0]))];
3514 thread->th.th_x = (seed + 1) * thread->th.th_a + 1;
3515 KA_TRACE(30,
3516 ("__kmp_init_random: THREAD: %u; A: %u\n", seed, thread->th.th_a));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003517}
3518
Jim Cownie5e8470a2013-09-27 10:38:44 +00003519#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00003520/* reclaim array entries for root threads that are already dead, returns number
3521 * reclaimed */
3522static int __kmp_reclaim_dead_roots(void) {
3523 int i, r = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003524
Jonathan Peyton30419822017-05-12 18:01:32 +00003525 for (i = 0; i < __kmp_threads_capacity; ++i) {
3526 if (KMP_UBER_GTID(i) &&
3527 !__kmp_still_running((kmp_info_t *)TCR_SYNC_PTR(__kmp_threads[i])) &&
3528 !__kmp_root[i]
3529 ->r.r_active) { // AC: reclaim only roots died in non-active state
3530 r += __kmp_unregister_root_other_thread(i);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003531 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003532 }
3533 return r;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003534}
3535#endif
3536
Jonathan Peyton30419822017-05-12 18:01:32 +00003537/* This function attempts to create free entries in __kmp_threads and
3538 __kmp_root, and returns the number of free entries generated.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003539
Jonathan Peyton30419822017-05-12 18:01:32 +00003540 For Windows* OS static library, the first mechanism used is to reclaim array
3541 entries for root threads that are already dead.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003542
Jonathan Peyton30419822017-05-12 18:01:32 +00003543 On all platforms, expansion is attempted on the arrays __kmp_threads_ and
3544 __kmp_root, with appropriate update to __kmp_threads_capacity. Array
3545 capacity is increased by doubling with clipping to __kmp_tp_capacity, if
3546 threadprivate cache array has been created. Synchronization with
3547 __kmpc_threadprivate_cached is done using __kmp_tp_cached_lock.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003548
Jonathan Peyton30419822017-05-12 18:01:32 +00003549 After any dead root reclamation, if the clipping value allows array expansion
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003550 to result in the generation of a total of nNeed free slots, the function does
3551 that expansion. If not, nothing is done beyond the possible initial root
3552 thread reclamation.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003553
Jonathan Peyton30419822017-05-12 18:01:32 +00003554 If any argument is negative, the behavior is undefined. */
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003555static int __kmp_expand_threads(int nNeed) {
Jonathan Peyton30419822017-05-12 18:01:32 +00003556 int added = 0;
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003557 int minimumRequiredCapacity;
3558 int newCapacity;
3559 kmp_info_t **newThreads;
3560 kmp_root_t **newRoot;
3561
3562// All calls to __kmp_expand_threads should be under __kmp_forkjoin_lock, so
3563// resizing __kmp_threads does not need additional protection if foreign
3564// threads are present
Jim Cownie5e8470a2013-09-27 10:38:44 +00003565
Jonathan Peyton8b3842f2018-10-05 17:59:39 +00003566#if KMP_OS_WINDOWS && !KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +00003567 /* only for Windows static library */
3568 /* reclaim array entries for root threads that are already dead */
3569 added = __kmp_reclaim_dead_roots();
Jim Cownie5e8470a2013-09-27 10:38:44 +00003570
Jonathan Peyton30419822017-05-12 18:01:32 +00003571 if (nNeed) {
3572 nNeed -= added;
3573 if (nNeed < 0)
3574 nNeed = 0;
3575 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003576#endif
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003577 if (nNeed <= 0)
Jim Cownie5e8470a2013-09-27 10:38:44 +00003578 return added;
Jonathan Peyton30419822017-05-12 18:01:32 +00003579
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003580 // Note that __kmp_threads_capacity is not bounded by __kmp_max_nth. If
3581 // __kmp_max_nth is set to some value less than __kmp_sys_max_nth by the
3582 // user via KMP_DEVICE_THREAD_LIMIT, then __kmp_threads_capacity may become
3583 // > __kmp_max_nth in one of two ways:
3584 //
3585 // 1) The initialization thread (gtid = 0) exits. __kmp_threads[0]
3586 // may not be resused by another thread, so we may need to increase
3587 // __kmp_threads_capacity to __kmp_max_nth + 1.
3588 //
3589 // 2) New foreign root(s) are encountered. We always register new foreign
3590 // roots. This may cause a smaller # of threads to be allocated at
3591 // subsequent parallel regions, but the worker threads hang around (and
3592 // eventually go to sleep) and need slots in the __kmp_threads[] array.
3593 //
3594 // Anyway, that is the reason for moving the check to see if
3595 // __kmp_max_nth was exceeded into __kmp_reserve_threads()
3596 // instead of having it performed here. -BB
Jonathan Peyton30419822017-05-12 18:01:32 +00003597
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003598 KMP_DEBUG_ASSERT(__kmp_sys_max_nth >= __kmp_threads_capacity);
Jonathan Peyton30419822017-05-12 18:01:32 +00003599
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003600 /* compute expansion headroom to check if we can expand */
3601 if (__kmp_sys_max_nth - __kmp_threads_capacity < nNeed) {
3602 /* possible expansion too small -- give up */
3603 return added;
Jonathan Peyton30419822017-05-12 18:01:32 +00003604 }
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003605 minimumRequiredCapacity = __kmp_threads_capacity + nNeed;
3606
3607 newCapacity = __kmp_threads_capacity;
3608 do {
3609 newCapacity = newCapacity <= (__kmp_sys_max_nth >> 1) ? (newCapacity << 1)
3610 : __kmp_sys_max_nth;
3611 } while (newCapacity < minimumRequiredCapacity);
3612 newThreads = (kmp_info_t **)__kmp_allocate(
3613 (sizeof(kmp_info_t *) + sizeof(kmp_root_t *)) * newCapacity + CACHE_LINE);
3614 newRoot =
3615 (kmp_root_t **)((char *)newThreads + sizeof(kmp_info_t *) * newCapacity);
3616 KMP_MEMCPY(newThreads, __kmp_threads,
3617 __kmp_threads_capacity * sizeof(kmp_info_t *));
3618 KMP_MEMCPY(newRoot, __kmp_root,
3619 __kmp_threads_capacity * sizeof(kmp_root_t *));
3620
3621 kmp_info_t **temp_threads = __kmp_threads;
3622 *(kmp_info_t * *volatile *)&__kmp_threads = newThreads;
3623 *(kmp_root_t * *volatile *)&__kmp_root = newRoot;
3624 __kmp_free(temp_threads);
3625 added += newCapacity - __kmp_threads_capacity;
3626 *(volatile int *)&__kmp_threads_capacity = newCapacity;
3627
3628 if (newCapacity > __kmp_tp_capacity) {
3629 __kmp_acquire_bootstrap_lock(&__kmp_tp_cached_lock);
3630 if (__kmp_tp_cached && newCapacity > __kmp_tp_capacity) {
3631 __kmp_threadprivate_resize_cache(newCapacity);
3632 } else { // increase __kmp_tp_capacity to correspond with kmp_threads size
3633 *(volatile int *)&__kmp_tp_capacity = newCapacity;
3634 }
3635 __kmp_release_bootstrap_lock(&__kmp_tp_cached_lock);
3636 }
3637
Jonathan Peyton30419822017-05-12 18:01:32 +00003638 return added;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003639}
3640
Jonathan Peyton30419822017-05-12 18:01:32 +00003641/* Register the current thread as a root thread and obtain our gtid. We must
3642 have the __kmp_initz_lock held at this point. Argument TRUE only if are the
3643 thread that calls from __kmp_do_serial_initialize() */
3644int __kmp_register_root(int initial_thread) {
3645 kmp_info_t *root_thread;
3646 kmp_root_t *root;
3647 int gtid;
3648 int capacity;
3649 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
3650 KA_TRACE(20, ("__kmp_register_root: entered\n"));
3651 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00003652
Jonathan Peyton30419822017-05-12 18:01:32 +00003653 /* 2007-03-02:
3654 If initial thread did not invoke OpenMP RTL yet, and this thread is not an
3655 initial one, "__kmp_all_nth >= __kmp_threads_capacity" condition does not
3656 work as expected -- it may return false (that means there is at least one
3657 empty slot in __kmp_threads array), but it is possible the only free slot
3658 is #0, which is reserved for initial thread and so cannot be used for this
3659 one. Following code workarounds this bug.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003660
Jonathan Peyton30419822017-05-12 18:01:32 +00003661 However, right solution seems to be not reserving slot #0 for initial
3662 thread because:
3663 (1) there is no magic in slot #0,
3664 (2) we cannot detect initial thread reliably (the first thread which does
3665 serial initialization may be not a real initial thread).
3666 */
3667 capacity = __kmp_threads_capacity;
3668 if (!initial_thread && TCR_PTR(__kmp_threads[0]) == NULL) {
3669 --capacity;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003670 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003671
Jonathan Peyton30419822017-05-12 18:01:32 +00003672 /* see if there are too many threads */
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003673 if (__kmp_all_nth >= capacity && !__kmp_expand_threads(1)) {
Jonathan Peyton30419822017-05-12 18:01:32 +00003674 if (__kmp_tp_cached) {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00003675 __kmp_fatal(KMP_MSG(CantRegisterNewThread),
3676 KMP_HNT(Set_ALL_THREADPRIVATE, __kmp_tp_capacity),
3677 KMP_HNT(PossibleSystemLimitOnThreads), __kmp_msg_null);
Jonathan Peyton30419822017-05-12 18:01:32 +00003678 } else {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00003679 __kmp_fatal(KMP_MSG(CantRegisterNewThread), KMP_HNT(SystemLimitOnThreads),
3680 __kmp_msg_null);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003681 }
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003682 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003683
3684 /* find an available thread slot */
3685 /* Don't reassign the zero slot since we need that to only be used by initial
3686 thread */
3687 for (gtid = (initial_thread ? 0 : 1); TCR_PTR(__kmp_threads[gtid]) != NULL;
3688 gtid++)
3689 ;
3690 KA_TRACE(1,
3691 ("__kmp_register_root: found slot in threads array: T#%d\n", gtid));
3692 KMP_ASSERT(gtid < __kmp_threads_capacity);
3693
3694 /* update global accounting */
3695 __kmp_all_nth++;
3696 TCW_4(__kmp_nth, __kmp_nth + 1);
3697
3698 // if __kmp_adjust_gtid_mode is set, then we use method #1 (sp search) for low
3699 // numbers of procs, and method #2 (keyed API call) for higher numbers.
3700 if (__kmp_adjust_gtid_mode) {
3701 if (__kmp_all_nth >= __kmp_tls_gtid_min) {
3702 if (TCR_4(__kmp_gtid_mode) != 2) {
3703 TCW_4(__kmp_gtid_mode, 2);
3704 }
3705 } else {
3706 if (TCR_4(__kmp_gtid_mode) != 1) {
3707 TCW_4(__kmp_gtid_mode, 1);
3708 }
3709 }
3710 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003711
3712#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00003713 /* Adjust blocktime to zero if necessary */
3714 /* Middle initialization might not have occurred yet */
3715 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
3716 if (__kmp_nth > __kmp_avail_proc) {
3717 __kmp_zero_bt = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003718 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003719 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003720#endif /* KMP_ADJUST_BLOCKTIME */
3721
Jonathan Peyton30419822017-05-12 18:01:32 +00003722 /* setup this new hierarchy */
3723 if (!(root = __kmp_root[gtid])) {
3724 root = __kmp_root[gtid] = (kmp_root_t *)__kmp_allocate(sizeof(kmp_root_t));
3725 KMP_DEBUG_ASSERT(!root->r.r_root_team);
3726 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003727
Jonathan Peyton5375fe82016-11-14 21:13:44 +00003728#if KMP_STATS_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003729 // Initialize stats as soon as possible (right after gtid assignment).
3730 __kmp_stats_thread_ptr = __kmp_stats_list->push_back(gtid);
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00003731 __kmp_stats_thread_ptr->startLife();
Jonathan Peyton30419822017-05-12 18:01:32 +00003732 KMP_SET_THREAD_STATE(SERIAL_REGION);
3733 KMP_INIT_PARTITIONED_TIMERS(OMP_serial);
Jonathan Peyton5375fe82016-11-14 21:13:44 +00003734#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003735 __kmp_initialize_root(root);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003736
Jonathan Peyton30419822017-05-12 18:01:32 +00003737 /* setup new root thread structure */
3738 if (root->r.r_uber_thread) {
3739 root_thread = root->r.r_uber_thread;
3740 } else {
3741 root_thread = (kmp_info_t *)__kmp_allocate(sizeof(kmp_info_t));
3742 if (__kmp_storage_map) {
3743 __kmp_print_thread_storage_map(root_thread, gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003744 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003745 root_thread->th.th_info.ds.ds_gtid = gtid;
Joachim Protze82e94a52017-11-01 10:08:30 +00003746#if OMPT_SUPPORT
Jonathan Peyton3574f282018-10-04 14:57:04 +00003747 root_thread->th.ompt_thread_info.thread_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00003748#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003749 root_thread->th.th_root = root;
3750 if (__kmp_env_consistency_check) {
3751 root_thread->th.th_cons = __kmp_allocate_cons_stack(gtid);
3752 }
3753#if USE_FAST_MEMORY
3754 __kmp_initialize_fast_memory(root_thread);
3755#endif /* USE_FAST_MEMORY */
Jim Cownie5e8470a2013-09-27 10:38:44 +00003756
Jonathan Peyton30419822017-05-12 18:01:32 +00003757#if KMP_USE_BGET
3758 KMP_DEBUG_ASSERT(root_thread->th.th_local.bget_data == NULL);
3759 __kmp_initialize_bget(root_thread);
3760#endif
3761 __kmp_init_random(root_thread); // Initialize random number generator
3762 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003763
Jonathan Peyton30419822017-05-12 18:01:32 +00003764 /* setup the serial team held in reserve by the root thread */
3765 if (!root_thread->th.th_serial_team) {
3766 kmp_internal_control_t r_icvs = __kmp_get_global_icvs();
3767 KF_TRACE(10, ("__kmp_register_root: before serial_team\n"));
3768 root_thread->th.th_serial_team =
3769 __kmp_allocate_team(root, 1, 1,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003770#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003771 ompt_data_none, // root parallel id
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003772#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003773#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003774 proc_bind_default,
Jim Cownie5e8470a2013-09-27 10:38:44 +00003775#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003776 &r_icvs, 0 USE_NESTED_HOT_ARG(NULL));
3777 }
3778 KMP_ASSERT(root_thread->th.th_serial_team);
3779 KF_TRACE(10, ("__kmp_register_root: after serial_team = %p\n",
3780 root_thread->th.th_serial_team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003781
Jonathan Peyton30419822017-05-12 18:01:32 +00003782 /* drop root_thread into place */
3783 TCW_SYNC_PTR(__kmp_threads[gtid], root_thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003784
Jonathan Peyton30419822017-05-12 18:01:32 +00003785 root->r.r_root_team->t.t_threads[0] = root_thread;
3786 root->r.r_hot_team->t.t_threads[0] = root_thread;
3787 root_thread->th.th_serial_team->t.t_threads[0] = root_thread;
3788 // AC: the team created in reserve, not for execution (it is unused for now).
3789 root_thread->th.th_serial_team->t.t_serialized = 0;
3790 root->r.r_uber_thread = root_thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003791
Jonathan Peyton30419822017-05-12 18:01:32 +00003792 /* initialize the thread, get it ready to go */
3793 __kmp_initialize_info(root_thread, root->r.r_root_team, 0, gtid);
3794 TCW_4(__kmp_init_gtid, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003795
Jonathan Peyton30419822017-05-12 18:01:32 +00003796 /* prepare the master thread for get_gtid() */
3797 __kmp_gtid_set_specific(gtid);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003798
Jonathan Peyton7abf9d52016-05-26 18:19:10 +00003799#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00003800 __kmp_itt_thread_name(gtid);
Jonathan Peyton7abf9d52016-05-26 18:19:10 +00003801#endif /* USE_ITT_BUILD */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003802
Jonathan Peyton30419822017-05-12 18:01:32 +00003803#ifdef KMP_TDATA_GTID
3804 __kmp_gtid = gtid;
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00003805#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003806 __kmp_create_worker(gtid, root_thread, __kmp_stksize);
3807 KMP_DEBUG_ASSERT(__kmp_gtid_get_specific() == gtid);
3808
3809 KA_TRACE(20, ("__kmp_register_root: T#%d init T#%d(%d:%d) arrived: join=%u, "
3810 "plain=%u\n",
3811 gtid, __kmp_gtid_from_tid(0, root->r.r_hot_team),
3812 root->r.r_hot_team->t.t_id, 0, KMP_INIT_BARRIER_STATE,
3813 KMP_INIT_BARRIER_STATE));
3814 { // Initialize barrier data.
3815 int b;
3816 for (b = 0; b < bs_last_barrier; ++b) {
3817 root_thread->th.th_bar[b].bb.b_arrived = KMP_INIT_BARRIER_STATE;
3818#if USE_DEBUGGER
3819 root_thread->th.th_bar[b].bb.b_worker_arrived = 0;
3820#endif
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003821 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003822 }
3823 KMP_DEBUG_ASSERT(root->r.r_hot_team->t.t_bar[bs_forkjoin_barrier].b_arrived ==
3824 KMP_INIT_BARRIER_STATE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003825
Alp Toker763b9392014-02-28 09:42:41 +00003826#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00003827#if OMP_40_ENABLED
3828 root_thread->th.th_current_place = KMP_PLACE_UNDEFINED;
3829 root_thread->th.th_new_place = KMP_PLACE_UNDEFINED;
3830 root_thread->th.th_first_place = KMP_PLACE_UNDEFINED;
3831 root_thread->th.th_last_place = KMP_PLACE_UNDEFINED;
3832#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003833 if (TCR_4(__kmp_init_middle)) {
3834 __kmp_affinity_set_init_mask(gtid, TRUE);
3835 }
Alp Toker763b9392014-02-28 09:42:41 +00003836#endif /* KMP_AFFINITY_SUPPORTED */
Jonathan Peyton92ca6182018-09-07 18:25:49 +00003837#if OMP_50_ENABLED
3838 root_thread->th.th_def_allocator = __kmp_def_allocator;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00003839 root_thread->th.th_prev_level = 0;
3840 root_thread->th.th_prev_num_threads = 1;
Jonathan Peyton92ca6182018-09-07 18:25:49 +00003841#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003842
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00003843 kmp_cg_root_t *tmp = (kmp_cg_root_t *)__kmp_allocate(sizeof(kmp_cg_root_t));
3844 tmp->cg_root = root_thread;
3845 tmp->cg_thread_limit = __kmp_cg_max_nth;
3846 tmp->cg_nthreads = 1;
3847 KA_TRACE(100, ("__kmp_register_root: Thread %p created node %p with"
3848 " cg_nthreads init to 1\n",
3849 root_thread, tmp));
3850 tmp->up = NULL;
3851 root_thread->th.th_cg_roots = tmp;
3852
Jonathan Peyton30419822017-05-12 18:01:32 +00003853 __kmp_root_counter++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003854
Joachim Protze82e94a52017-11-01 10:08:30 +00003855#if OMPT_SUPPORT
3856 if (!initial_thread && ompt_enabled.enabled) {
3857
Joachim Protze489cdb72018-09-10 14:34:54 +00003858 kmp_info_t *root_thread = ompt_get_thread();
Joachim Protze82e94a52017-11-01 10:08:30 +00003859
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00003860 ompt_set_thread_state(root_thread, ompt_state_overhead);
Joachim Protze82e94a52017-11-01 10:08:30 +00003861
3862 if (ompt_enabled.ompt_callback_thread_begin) {
3863 ompt_callbacks.ompt_callback(ompt_callback_thread_begin)(
3864 ompt_thread_initial, __ompt_get_thread_data_internal());
3865 }
3866 ompt_data_t *task_data;
3867 __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
3868 if (ompt_enabled.ompt_callback_task_create) {
3869 ompt_callbacks.ompt_callback(ompt_callback_task_create)(
3870 NULL, NULL, task_data, ompt_task_initial, 0, NULL);
3871 // initial task has nothing to return to
3872 }
3873
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00003874 ompt_set_thread_state(root_thread, ompt_state_work_serial);
Joachim Protze82e94a52017-11-01 10:08:30 +00003875 }
3876#endif
3877
Jonathan Peyton30419822017-05-12 18:01:32 +00003878 KMP_MB();
3879 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003880
Jonathan Peyton30419822017-05-12 18:01:32 +00003881 return gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003882}
3883
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003884#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00003885static int __kmp_free_hot_teams(kmp_root_t *root, kmp_info_t *thr, int level,
3886 const int max_level) {
3887 int i, n, nth;
3888 kmp_hot_team_ptr_t *hot_teams = thr->th.th_hot_teams;
3889 if (!hot_teams || !hot_teams[level].hot_team) {
3890 return 0;
3891 }
3892 KMP_DEBUG_ASSERT(level < max_level);
3893 kmp_team_t *team = hot_teams[level].hot_team;
3894 nth = hot_teams[level].hot_team_nth;
3895 n = nth - 1; // master is not freed
3896 if (level < max_level - 1) {
3897 for (i = 0; i < nth; ++i) {
3898 kmp_info_t *th = team->t.t_threads[i];
3899 n += __kmp_free_hot_teams(root, th, level + 1, max_level);
3900 if (i > 0 && th->th.th_hot_teams) {
3901 __kmp_free(th->th.th_hot_teams);
3902 th->th.th_hot_teams = NULL;
3903 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003904 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003905 }
3906 __kmp_free_team(root, team, NULL);
3907 return n;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003908}
3909#endif
3910
Jonathan Peyton30419822017-05-12 18:01:32 +00003911// Resets a root thread and clear its root and hot teams.
3912// Returns the number of __kmp_threads entries directly and indirectly freed.
3913static int __kmp_reset_root(int gtid, kmp_root_t *root) {
3914 kmp_team_t *root_team = root->r.r_root_team;
3915 kmp_team_t *hot_team = root->r.r_hot_team;
3916 int n = hot_team->t.t_nproc;
3917 int i;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003918
Jonathan Peyton30419822017-05-12 18:01:32 +00003919 KMP_DEBUG_ASSERT(!root->r.r_active);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003920
Jonathan Peyton30419822017-05-12 18:01:32 +00003921 root->r.r_root_team = NULL;
3922 root->r.r_hot_team = NULL;
3923 // __kmp_free_team() does not free hot teams, so we have to clear r_hot_team
3924 // before call to __kmp_free_team().
3925 __kmp_free_team(root, root_team USE_NESTED_HOT_ARG(NULL));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003926#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00003927 if (__kmp_hot_teams_max_level >
3928 0) { // need to free nested hot teams and their threads if any
3929 for (i = 0; i < hot_team->t.t_nproc; ++i) {
3930 kmp_info_t *th = hot_team->t.t_threads[i];
3931 if (__kmp_hot_teams_max_level > 1) {
3932 n += __kmp_free_hot_teams(root, th, 1, __kmp_hot_teams_max_level);
3933 }
3934 if (th->th.th_hot_teams) {
3935 __kmp_free(th->th.th_hot_teams);
3936 th->th.th_hot_teams = NULL;
3937 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003938 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003939 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003940#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003941 __kmp_free_team(root, hot_team USE_NESTED_HOT_ARG(NULL));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003942
Jonathan Peyton30419822017-05-12 18:01:32 +00003943 // Before we can reap the thread, we need to make certain that all other
3944 // threads in the teams that had this root as ancestor have stopped trying to
3945 // steal tasks.
3946 if (__kmp_tasking_mode != tskm_immediate_exec) {
3947 __kmp_wait_to_unref_task_teams();
3948 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003949
Jonathan Peyton30419822017-05-12 18:01:32 +00003950#if KMP_OS_WINDOWS
3951 /* Close Handle of root duplicated in __kmp_create_worker (tr #62919) */
3952 KA_TRACE(
3953 10, ("__kmp_reset_root: free handle, th = %p, handle = %" KMP_UINTPTR_SPEC
3954 "\n",
3955 (LPVOID) & (root->r.r_uber_thread->th),
3956 root->r.r_uber_thread->th.th_info.ds.ds_thread));
3957 __kmp_free_handle(root->r.r_uber_thread->th.th_info.ds.ds_thread);
3958#endif /* KMP_OS_WINDOWS */
Jim Cownie5e8470a2013-09-27 10:38:44 +00003959
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003960#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003961 if (ompt_enabled.ompt_callback_thread_end) {
3962 ompt_callbacks.ompt_callback(ompt_callback_thread_end)(
3963 &(root->r.r_uber_thread->th.ompt_thread_info.thread_data));
Jonathan Peyton30419822017-05-12 18:01:32 +00003964 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003965#endif
3966
Jonathan Peyton30419822017-05-12 18:01:32 +00003967 TCW_4(__kmp_nth,
3968 __kmp_nth - 1); // __kmp_reap_thread will decrement __kmp_all_nth.
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00003969 root->r.r_uber_thread->th.th_cg_roots->cg_nthreads--;
3970 KA_TRACE(100, ("__kmp_reset_root: Thread %p decrement cg_nthreads on node %p"
3971 " to %d\n",
3972 root->r.r_uber_thread, root->r.r_uber_thread->th.th_cg_roots,
3973 root->r.r_uber_thread->th.th_cg_roots->cg_nthreads));
Jonathan Peytonf4392462017-07-27 20:58:41 +00003974
Jonathan Peyton30419822017-05-12 18:01:32 +00003975 __kmp_reap_thread(root->r.r_uber_thread, 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003976
Jonathan Peyton30419822017-05-12 18:01:32 +00003977 // We canot put root thread to __kmp_thread_pool, so we have to reap it istead
3978 // of freeing.
3979 root->r.r_uber_thread = NULL;
3980 /* mark root as no longer in use */
3981 root->r.r_begin = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003982
Jonathan Peyton30419822017-05-12 18:01:32 +00003983 return n;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003984}
3985
Jonathan Peyton30419822017-05-12 18:01:32 +00003986void __kmp_unregister_root_current_thread(int gtid) {
3987 KA_TRACE(1, ("__kmp_unregister_root_current_thread: enter T#%d\n", gtid));
3988 /* this lock should be ok, since unregister_root_current_thread is never
3989 called during an abort, only during a normal close. furthermore, if you
3990 have the forkjoin lock, you should never try to get the initz lock */
3991 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
3992 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
3993 KC_TRACE(10, ("__kmp_unregister_root_current_thread: already finished, "
3994 "exiting T#%d\n",
3995 gtid));
3996 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
3997 return;
3998 }
3999 kmp_root_t *root = __kmp_root[gtid];
Jim Cownie77c2a632014-09-03 11:34:33 +00004000
Jonathan Peyton30419822017-05-12 18:01:32 +00004001 KMP_DEBUG_ASSERT(__kmp_threads && __kmp_threads[gtid]);
4002 KMP_ASSERT(KMP_UBER_GTID(gtid));
4003 KMP_ASSERT(root == __kmp_threads[gtid]->th.th_root);
4004 KMP_ASSERT(root->r.r_active == FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004005
Jonathan Peyton30419822017-05-12 18:01:32 +00004006 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004007
Jonathan Peytondf6818b2016-06-14 17:57:47 +00004008#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004009 kmp_info_t *thread = __kmp_threads[gtid];
4010 kmp_team_t *team = thread->th.th_team;
4011 kmp_task_team_t *task_team = thread->th.th_task_team;
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00004012
Jonathan Peyton30419822017-05-12 18:01:32 +00004013 // we need to wait for the proxy tasks before finishing the thread
4014 if (task_team != NULL && task_team->tt.tt_found_proxy_tasks) {
Jonathan Peyton6d247f72015-09-10 21:33:50 +00004015#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00004016 // the runtime is shutting down so we won't report any events
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00004017 thread->th.ompt_thread_info.state = ompt_state_undefined;
Jonathan Peyton6d247f72015-09-10 21:33:50 +00004018#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004019 __kmp_task_team_wait(thread, team USE_ITT_BUILD_ARG(NULL));
4020 }
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00004021#endif
4022
Jonathan Peyton30419822017-05-12 18:01:32 +00004023 __kmp_reset_root(gtid, root);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004024
Jonathan Peyton30419822017-05-12 18:01:32 +00004025 /* free up this thread slot */
4026 __kmp_gtid_set_specific(KMP_GTID_DNE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004027#ifdef KMP_TDATA_GTID
Jonathan Peyton30419822017-05-12 18:01:32 +00004028 __kmp_gtid = KMP_GTID_DNE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004029#endif
4030
Jonathan Peyton30419822017-05-12 18:01:32 +00004031 KMP_MB();
4032 KC_TRACE(10,
4033 ("__kmp_unregister_root_current_thread: T#%d unregistered\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004034
Jonathan Peyton30419822017-05-12 18:01:32 +00004035 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004036}
4037
Jonathan Peyton2321d572015-06-08 19:25:25 +00004038#if KMP_OS_WINDOWS
Jim Cownie5e8470a2013-09-27 10:38:44 +00004039/* __kmp_forkjoin_lock must be already held
Jonathan Peyton30419822017-05-12 18:01:32 +00004040 Unregisters a root thread that is not the current thread. Returns the number
4041 of __kmp_threads entries freed as a result. */
4042static int __kmp_unregister_root_other_thread(int gtid) {
4043 kmp_root_t *root = __kmp_root[gtid];
4044 int r;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004045
Jonathan Peyton30419822017-05-12 18:01:32 +00004046 KA_TRACE(1, ("__kmp_unregister_root_other_thread: enter T#%d\n", gtid));
4047 KMP_DEBUG_ASSERT(__kmp_threads && __kmp_threads[gtid]);
4048 KMP_ASSERT(KMP_UBER_GTID(gtid));
4049 KMP_ASSERT(root == __kmp_threads[gtid]->th.th_root);
4050 KMP_ASSERT(root->r.r_active == FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004051
Jonathan Peyton30419822017-05-12 18:01:32 +00004052 r = __kmp_reset_root(gtid, root);
4053 KC_TRACE(10,
4054 ("__kmp_unregister_root_other_thread: T#%d unregistered\n", gtid));
4055 return r;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004056}
Jonathan Peyton2321d572015-06-08 19:25:25 +00004057#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00004058
Jim Cownie5e8470a2013-09-27 10:38:44 +00004059#if KMP_DEBUG
4060void __kmp_task_info() {
4061
Jonathan Peyton30419822017-05-12 18:01:32 +00004062 kmp_int32 gtid = __kmp_entry_gtid();
4063 kmp_int32 tid = __kmp_tid_from_gtid(gtid);
4064 kmp_info_t *this_thr = __kmp_threads[gtid];
4065 kmp_team_t *steam = this_thr->th.th_serial_team;
4066 kmp_team_t *team = this_thr->th.th_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004067
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00004068 __kmp_printf(
4069 "__kmp_task_info: gtid=%d tid=%d t_thread=%p team=%p steam=%p curtask=%p "
4070 "ptask=%p\n",
4071 gtid, tid, this_thr, team, steam, this_thr->th.th_current_task,
4072 team->t.t_implicit_task_taskdata[tid].td_parent);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004073}
4074#endif // KMP_DEBUG
4075
Jonathan Peyton30419822017-05-12 18:01:32 +00004076/* TODO optimize with one big memclr, take out what isn't needed, split
4077 responsibility to workers as much as possible, and delay initialization of
4078 features as much as possible */
4079static void __kmp_initialize_info(kmp_info_t *this_thr, kmp_team_t *team,
4080 int tid, int gtid) {
4081 /* this_thr->th.th_info.ds.ds_gtid is setup in
4082 kmp_allocate_thread/create_worker.
4083 this_thr->th.th_serial_team is setup in __kmp_allocate_thread */
4084 kmp_info_t *master = team->t.t_threads[0];
4085 KMP_DEBUG_ASSERT(this_thr != NULL);
4086 KMP_DEBUG_ASSERT(this_thr->th.th_serial_team);
4087 KMP_DEBUG_ASSERT(team);
4088 KMP_DEBUG_ASSERT(team->t.t_threads);
4089 KMP_DEBUG_ASSERT(team->t.t_dispatch);
4090 KMP_DEBUG_ASSERT(master);
4091 KMP_DEBUG_ASSERT(master->th.th_root);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004092
Jonathan Peyton30419822017-05-12 18:01:32 +00004093 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004094
Jonathan Peyton30419822017-05-12 18:01:32 +00004095 TCW_SYNC_PTR(this_thr->th.th_team, team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004096
Jonathan Peyton30419822017-05-12 18:01:32 +00004097 this_thr->th.th_info.ds.ds_tid = tid;
4098 this_thr->th.th_set_nproc = 0;
4099 if (__kmp_tasking_mode != tskm_immediate_exec)
4100 // When tasking is possible, threads are not safe to reap until they are
4101 // done tasking; this will be set when tasking code is exited in wait
4102 this_thr->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
4103 else // no tasking --> always safe to reap
4104 this_thr->th.th_reap_state = KMP_SAFE_TO_REAP;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004105#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004106 this_thr->th.th_set_proc_bind = proc_bind_default;
4107#if KMP_AFFINITY_SUPPORTED
4108 this_thr->th.th_new_place = this_thr->th.th_current_place;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004109#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004110#endif
4111 this_thr->th.th_root = master->th.th_root;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004112
Jonathan Peyton30419822017-05-12 18:01:32 +00004113 /* setup the thread's cache of the team structure */
4114 this_thr->th.th_team_nproc = team->t.t_nproc;
4115 this_thr->th.th_team_master = master;
4116 this_thr->th.th_team_serialized = team->t.t_serialized;
4117 TCW_PTR(this_thr->th.th_sleep_loc, NULL);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004118
Jonathan Peyton30419822017-05-12 18:01:32 +00004119 KMP_DEBUG_ASSERT(team->t.t_implicit_task_taskdata);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004120
Jonathan Peyton30419822017-05-12 18:01:32 +00004121 KF_TRACE(10, ("__kmp_initialize_info1: T#%d:%d this_thread=%p curtask=%p\n",
4122 tid, gtid, this_thr, this_thr->th.th_current_task));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004123
Jonathan Peyton30419822017-05-12 18:01:32 +00004124 __kmp_init_implicit_task(this_thr->th.th_team_master->th.th_ident, this_thr,
4125 team, tid, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004126
Jonathan Peyton30419822017-05-12 18:01:32 +00004127 KF_TRACE(10, ("__kmp_initialize_info2: T#%d:%d this_thread=%p curtask=%p\n",
4128 tid, gtid, this_thr, this_thr->th.th_current_task));
4129 // TODO: Initialize ICVs from parent; GEH - isn't that already done in
4130 // __kmp_initialize_team()?
Jim Cownie5e8470a2013-09-27 10:38:44 +00004131
Jonathan Peyton30419822017-05-12 18:01:32 +00004132 /* TODO no worksharing in speculative threads */
4133 this_thr->th.th_dispatch = &team->t.t_dispatch[tid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00004134
Jonathan Peyton30419822017-05-12 18:01:32 +00004135 this_thr->th.th_local.this_construct = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004136
Jonathan Peyton30419822017-05-12 18:01:32 +00004137 if (!this_thr->th.th_pri_common) {
4138 this_thr->th.th_pri_common =
4139 (struct common_table *)__kmp_allocate(sizeof(struct common_table));
4140 if (__kmp_storage_map) {
4141 __kmp_print_storage_map_gtid(
4142 gtid, this_thr->th.th_pri_common, this_thr->th.th_pri_common + 1,
4143 sizeof(struct common_table), "th_%d.th_pri_common\n", gtid);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00004144 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004145 this_thr->th.th_pri_head = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00004146 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004147
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00004148 if (this_thr != master && // Master's CG root is initialized elsewhere
4149 this_thr->th.th_cg_roots != master->th.th_cg_roots) { // CG root not set
4150 // Make new thread's CG root same as master's
4151 KMP_DEBUG_ASSERT(master->th.th_cg_roots);
4152 this_thr->th.th_cg_roots = master->th.th_cg_roots;
4153 // Increment new thread's CG root's counter to add the new thread
4154 this_thr->th.th_cg_roots->cg_nthreads++;
4155 KA_TRACE(100, ("__kmp_initialize_info: Thread %p increment cg_nthreads on"
4156 " node %p of thread %p to %d\n",
4157 this_thr, this_thr->th.th_cg_roots,
4158 this_thr->th.th_cg_roots->cg_root,
4159 this_thr->th.th_cg_roots->cg_nthreads));
4160 this_thr->th.th_current_task->td_icvs.thread_limit =
4161 this_thr->th.th_cg_roots->cg_thread_limit;
4162 }
4163
Jonathan Peyton30419822017-05-12 18:01:32 +00004164 /* Initialize dynamic dispatch */
4165 {
4166 volatile kmp_disp_t *dispatch = this_thr->th.th_dispatch;
4167 // Use team max_nproc since this will never change for the team.
4168 size_t disp_size =
4169 sizeof(dispatch_private_info_t) *
4170 (team->t.t_max_nproc == 1 ? 1 : __kmp_dispatch_num_buffers);
4171 KD_TRACE(10, ("__kmp_initialize_info: T#%d max_nproc: %d\n", gtid,
4172 team->t.t_max_nproc));
4173 KMP_ASSERT(dispatch);
4174 KMP_DEBUG_ASSERT(team->t.t_dispatch);
4175 KMP_DEBUG_ASSERT(dispatch == &team->t.t_dispatch[tid]);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004176
Jonathan Peyton30419822017-05-12 18:01:32 +00004177 dispatch->th_disp_index = 0;
Jonathan Peytondf6818b2016-06-14 17:57:47 +00004178#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004179 dispatch->th_doacross_buf_idx = 0;
Jonathan Peyton71909c52016-03-02 22:42:06 +00004180#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004181 if (!dispatch->th_disp_buffer) {
4182 dispatch->th_disp_buffer =
4183 (dispatch_private_info_t *)__kmp_allocate(disp_size);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004184
Jonathan Peyton30419822017-05-12 18:01:32 +00004185 if (__kmp_storage_map) {
4186 __kmp_print_storage_map_gtid(
4187 gtid, &dispatch->th_disp_buffer[0],
4188 &dispatch->th_disp_buffer[team->t.t_max_nproc == 1
4189 ? 1
4190 : __kmp_dispatch_num_buffers],
4191 disp_size, "th_%d.th_dispatch.th_disp_buffer "
4192 "(team_%d.t_dispatch[%d].th_disp_buffer)",
4193 gtid, team->t.t_id, gtid);
4194 }
4195 } else {
4196 memset(&dispatch->th_disp_buffer[0], '\0', disp_size);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004197 }
4198
Jonathan Peyton30419822017-05-12 18:01:32 +00004199 dispatch->th_dispatch_pr_current = 0;
4200 dispatch->th_dispatch_sh_current = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004201
Jonathan Peyton30419822017-05-12 18:01:32 +00004202 dispatch->th_deo_fcn = 0; /* ORDERED */
4203 dispatch->th_dxo_fcn = 0; /* END ORDERED */
4204 }
Andrey Churbanov6d224db2015-02-10 18:37:43 +00004205
Jonathan Peyton30419822017-05-12 18:01:32 +00004206 this_thr->th.th_next_pool = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004207
Jonathan Peyton30419822017-05-12 18:01:32 +00004208 if (!this_thr->th.th_task_state_memo_stack) {
4209 size_t i;
4210 this_thr->th.th_task_state_memo_stack =
4211 (kmp_uint8 *)__kmp_allocate(4 * sizeof(kmp_uint8));
4212 this_thr->th.th_task_state_top = 0;
4213 this_thr->th.th_task_state_stack_sz = 4;
4214 for (i = 0; i < this_thr->th.th_task_state_stack_sz;
4215 ++i) // zero init the stack
4216 this_thr->th.th_task_state_memo_stack[i] = 0;
4217 }
4218
4219 KMP_DEBUG_ASSERT(!this_thr->th.th_spin_here);
4220 KMP_DEBUG_ASSERT(this_thr->th.th_next_waiting == 0);
4221
4222 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004223}
4224
Jonathan Peyton30419822017-05-12 18:01:32 +00004225/* allocate a new thread for the requesting team. this is only called from
4226 within a forkjoin critical section. we will first try to get an available
4227 thread from the thread pool. if none is available, we will fork a new one
4228 assuming we are able to create a new one. this should be assured, as the
4229 caller should check on this first. */
4230kmp_info_t *__kmp_allocate_thread(kmp_root_t *root, kmp_team_t *team,
4231 int new_tid) {
4232 kmp_team_t *serial_team;
4233 kmp_info_t *new_thr;
4234 int new_gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004235
Jonathan Peyton30419822017-05-12 18:01:32 +00004236 KA_TRACE(20, ("__kmp_allocate_thread: T#%d\n", __kmp_get_gtid()));
4237 KMP_DEBUG_ASSERT(root && team);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004238#if !KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004239 KMP_DEBUG_ASSERT(KMP_MASTER_GTID(__kmp_get_gtid()));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004240#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004241 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004242
Jonathan Peyton30419822017-05-12 18:01:32 +00004243 /* first, try to get one from the thread pool */
4244 if (__kmp_thread_pool) {
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00004245 new_thr = CCAST(kmp_info_t *, __kmp_thread_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00004246 __kmp_thread_pool = (volatile kmp_info_t *)new_thr->th.th_next_pool;
4247 if (new_thr == __kmp_thread_pool_insert_pt) {
4248 __kmp_thread_pool_insert_pt = NULL;
4249 }
4250 TCW_4(new_thr->th.th_in_pool, FALSE);
4251 // Don't touch th_active_in_pool or th_active.
4252 // The worker thread adjusts those flags as it sleeps/awakens.
4253 __kmp_thread_pool_nth--;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004254
Jonathan Peyton30419822017-05-12 18:01:32 +00004255 KA_TRACE(20, ("__kmp_allocate_thread: T#%d using thread T#%d\n",
4256 __kmp_get_gtid(), new_thr->th.th_info.ds.ds_gtid));
4257 KMP_ASSERT(!new_thr->th.th_team);
4258 KMP_DEBUG_ASSERT(__kmp_nth < __kmp_threads_capacity);
4259 KMP_DEBUG_ASSERT(__kmp_thread_pool_nth >= 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004260
Jonathan Peyton30419822017-05-12 18:01:32 +00004261 /* setup the thread structure */
4262 __kmp_initialize_info(new_thr, team, new_tid,
4263 new_thr->th.th_info.ds.ds_gtid);
4264 KMP_DEBUG_ASSERT(new_thr->th.th_serial_team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004265
Jonathan Peyton30419822017-05-12 18:01:32 +00004266 TCW_4(__kmp_nth, __kmp_nth + 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004267
Jonathan Peyton30419822017-05-12 18:01:32 +00004268 new_thr->th.th_task_state = 0;
4269 new_thr->th.th_task_state_top = 0;
4270 new_thr->th.th_task_state_stack_sz = 4;
Andrey Churbanov6d224db2015-02-10 18:37:43 +00004271
Jim Cownie5e8470a2013-09-27 10:38:44 +00004272#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00004273 /* Adjust blocktime back to zero if necessary */
4274 /* Middle initialization might not have occurred yet */
4275 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
4276 if (__kmp_nth > __kmp_avail_proc) {
4277 __kmp_zero_bt = TRUE;
4278 }
4279 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004280#endif /* KMP_ADJUST_BLOCKTIME */
4281
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004282#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00004283 // If thread entered pool via __kmp_free_thread, wait_flag should !=
4284 // KMP_BARRIER_PARENT_FLAG.
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004285 int b;
Jonathan Peyton30419822017-05-12 18:01:32 +00004286 kmp_balign_t *balign = new_thr->th.th_bar;
4287 for (b = 0; b < bs_last_barrier; ++b)
4288 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004289#endif
4290
Jonathan Peyton30419822017-05-12 18:01:32 +00004291 KF_TRACE(10, ("__kmp_allocate_thread: T#%d using thread %p T#%d\n",
4292 __kmp_get_gtid(), new_thr, new_thr->th.th_info.ds.ds_gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004293
Jim Cownie5e8470a2013-09-27 10:38:44 +00004294 KMP_MB();
4295 return new_thr;
Jonathan Peyton30419822017-05-12 18:01:32 +00004296 }
4297
4298 /* no, well fork a new one */
4299 KMP_ASSERT(__kmp_nth == __kmp_all_nth);
4300 KMP_ASSERT(__kmp_all_nth < __kmp_threads_capacity);
4301
4302#if KMP_USE_MONITOR
4303 // If this is the first worker thread the RTL is creating, then also
4304 // launch the monitor thread. We try to do this as early as possible.
4305 if (!TCR_4(__kmp_init_monitor)) {
4306 __kmp_acquire_bootstrap_lock(&__kmp_monitor_lock);
4307 if (!TCR_4(__kmp_init_monitor)) {
4308 KF_TRACE(10, ("before __kmp_create_monitor\n"));
4309 TCW_4(__kmp_init_monitor, 1);
4310 __kmp_create_monitor(&__kmp_monitor);
4311 KF_TRACE(10, ("after __kmp_create_monitor\n"));
4312#if KMP_OS_WINDOWS
4313 // AC: wait until monitor has started. This is a fix for CQ232808.
4314 // The reason is that if the library is loaded/unloaded in a loop with
4315 // small (parallel) work in between, then there is high probability that
4316 // monitor thread started after the library shutdown. At shutdown it is
4317 // too late to cope with the problem, because when the master is in
4318 // DllMain (process detach) the monitor has no chances to start (it is
4319 // blocked), and master has no means to inform the monitor that the
4320 // library has gone, because all the memory which the monitor can access
4321 // is going to be released/reset.
4322 while (TCR_4(__kmp_init_monitor) < 2) {
4323 KMP_YIELD(TRUE);
4324 }
4325 KF_TRACE(10, ("after monitor thread has started\n"));
4326#endif
4327 }
4328 __kmp_release_bootstrap_lock(&__kmp_monitor_lock);
4329 }
4330#endif
4331
4332 KMP_MB();
4333 for (new_gtid = 1; TCR_PTR(__kmp_threads[new_gtid]) != NULL; ++new_gtid) {
4334 KMP_DEBUG_ASSERT(new_gtid < __kmp_threads_capacity);
4335 }
4336
4337 /* allocate space for it. */
4338 new_thr = (kmp_info_t *)__kmp_allocate(sizeof(kmp_info_t));
4339
4340 TCW_SYNC_PTR(__kmp_threads[new_gtid], new_thr);
4341
4342 if (__kmp_storage_map) {
4343 __kmp_print_thread_storage_map(new_thr, new_gtid);
4344 }
4345
4346 // add the reserve serialized team, initialized from the team's master thread
4347 {
4348 kmp_internal_control_t r_icvs = __kmp_get_x_global_icvs(team);
4349 KF_TRACE(10, ("__kmp_allocate_thread: before th_serial/serial_team\n"));
4350 new_thr->th.th_serial_team = serial_team =
4351 (kmp_team_t *)__kmp_allocate_team(root, 1, 1,
4352#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00004353 ompt_data_none, // root parallel id
Jonathan Peyton30419822017-05-12 18:01:32 +00004354#endif
4355#if OMP_40_ENABLED
4356 proc_bind_default,
4357#endif
4358 &r_icvs, 0 USE_NESTED_HOT_ARG(NULL));
4359 }
4360 KMP_ASSERT(serial_team);
4361 serial_team->t.t_serialized = 0; // AC: the team created in reserve, not for
4362 // execution (it is unused for now).
4363 serial_team->t.t_threads[0] = new_thr;
4364 KF_TRACE(10,
4365 ("__kmp_allocate_thread: after th_serial/serial_team : new_thr=%p\n",
4366 new_thr));
4367
4368 /* setup the thread structures */
4369 __kmp_initialize_info(new_thr, team, new_tid, new_gtid);
4370
4371#if USE_FAST_MEMORY
4372 __kmp_initialize_fast_memory(new_thr);
4373#endif /* USE_FAST_MEMORY */
4374
4375#if KMP_USE_BGET
4376 KMP_DEBUG_ASSERT(new_thr->th.th_local.bget_data == NULL);
4377 __kmp_initialize_bget(new_thr);
4378#endif
4379
4380 __kmp_init_random(new_thr); // Initialize random number generator
4381
4382 /* Initialize these only once when thread is grabbed for a team allocation */
4383 KA_TRACE(20,
4384 ("__kmp_allocate_thread: T#%d init go fork=%u, plain=%u\n",
4385 __kmp_get_gtid(), KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
4386
4387 int b;
4388 kmp_balign_t *balign = new_thr->th.th_bar;
4389 for (b = 0; b < bs_last_barrier; ++b) {
4390 balign[b].bb.b_go = KMP_INIT_BARRIER_STATE;
4391 balign[b].bb.team = NULL;
4392 balign[b].bb.wait_flag = KMP_BARRIER_NOT_WAITING;
4393 balign[b].bb.use_oncore_barrier = 0;
4394 }
4395
4396 new_thr->th.th_spin_here = FALSE;
4397 new_thr->th.th_next_waiting = 0;
Jonathan Peytona764af62018-07-19 19:17:00 +00004398#if KMP_OS_UNIX
4399 new_thr->th.th_blocking = false;
4400#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004401
4402#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
4403 new_thr->th.th_current_place = KMP_PLACE_UNDEFINED;
4404 new_thr->th.th_new_place = KMP_PLACE_UNDEFINED;
4405 new_thr->th.th_first_place = KMP_PLACE_UNDEFINED;
4406 new_thr->th.th_last_place = KMP_PLACE_UNDEFINED;
4407#endif
Jonathan Peyton92ca6182018-09-07 18:25:49 +00004408#if OMP_50_ENABLED
4409 new_thr->th.th_def_allocator = __kmp_def_allocator;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00004410 new_thr->th.th_prev_level = 0;
4411 new_thr->th.th_prev_num_threads = 1;
Jonathan Peyton92ca6182018-09-07 18:25:49 +00004412#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004413
4414 TCW_4(new_thr->th.th_in_pool, FALSE);
4415 new_thr->th.th_active_in_pool = FALSE;
4416 TCW_4(new_thr->th.th_active, TRUE);
4417
4418 /* adjust the global counters */
4419 __kmp_all_nth++;
4420 __kmp_nth++;
4421
4422 // if __kmp_adjust_gtid_mode is set, then we use method #1 (sp search) for low
4423 // numbers of procs, and method #2 (keyed API call) for higher numbers.
4424 if (__kmp_adjust_gtid_mode) {
4425 if (__kmp_all_nth >= __kmp_tls_gtid_min) {
4426 if (TCR_4(__kmp_gtid_mode) != 2) {
4427 TCW_4(__kmp_gtid_mode, 2);
4428 }
4429 } else {
4430 if (TCR_4(__kmp_gtid_mode) != 1) {
4431 TCW_4(__kmp_gtid_mode, 1);
4432 }
4433 }
4434 }
4435
4436#ifdef KMP_ADJUST_BLOCKTIME
4437 /* Adjust blocktime back to zero if necessary */
4438 /* Middle initialization might not have occurred yet */
4439 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
4440 if (__kmp_nth > __kmp_avail_proc) {
4441 __kmp_zero_bt = TRUE;
4442 }
4443 }
4444#endif /* KMP_ADJUST_BLOCKTIME */
4445
4446 /* actually fork it and create the new worker thread */
4447 KF_TRACE(
4448 10, ("__kmp_allocate_thread: before __kmp_create_worker: %p\n", new_thr));
4449 __kmp_create_worker(new_gtid, new_thr, __kmp_stksize);
4450 KF_TRACE(10,
4451 ("__kmp_allocate_thread: after __kmp_create_worker: %p\n", new_thr));
4452
4453 KA_TRACE(20, ("__kmp_allocate_thread: T#%d forked T#%d\n", __kmp_get_gtid(),
4454 new_gtid));
4455 KMP_MB();
4456 return new_thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004457}
4458
Jonathan Peyton30419822017-05-12 18:01:32 +00004459/* Reinitialize team for reuse.
4460 The hot team code calls this case at every fork barrier, so EPCC barrier
4461 test are extremely sensitive to changes in it, esp. writes to the team
4462 struct, which cause a cache invalidation in all threads.
4463 IF YOU TOUCH THIS ROUTINE, RUN EPCC C SYNCBENCH ON A BIG-IRON MACHINE!!! */
4464static void __kmp_reinitialize_team(kmp_team_t *team,
4465 kmp_internal_control_t *new_icvs,
4466 ident_t *loc) {
4467 KF_TRACE(10, ("__kmp_reinitialize_team: enter this_thread=%p team=%p\n",
4468 team->t.t_threads[0], team));
4469 KMP_DEBUG_ASSERT(team && new_icvs);
4470 KMP_DEBUG_ASSERT((!TCR_4(__kmp_init_parallel)) || new_icvs->nproc);
4471 KMP_CHECK_UPDATE(team->t.t_ident, loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004472
Jonathan Peyton30419822017-05-12 18:01:32 +00004473 KMP_CHECK_UPDATE(team->t.t_id, KMP_GEN_TEAM_ID());
Jonathan Peyton30419822017-05-12 18:01:32 +00004474 // Copy ICVs to the master thread's implicit taskdata
4475 __kmp_init_implicit_task(loc, team->t.t_threads[0], team, 0, FALSE);
4476 copy_icvs(&team->t.t_implicit_task_taskdata[0].td_icvs, new_icvs);
Jim Cownie181b4bb2013-12-23 17:28:57 +00004477
Jonathan Peyton30419822017-05-12 18:01:32 +00004478 KF_TRACE(10, ("__kmp_reinitialize_team: exit this_thread=%p team=%p\n",
4479 team->t.t_threads[0], team));
Jim Cownie181b4bb2013-12-23 17:28:57 +00004480}
4481
Jonathan Peyton30419822017-05-12 18:01:32 +00004482/* Initialize the team data structure.
4483 This assumes the t_threads and t_max_nproc are already set.
4484 Also, we don't touch the arguments */
4485static void __kmp_initialize_team(kmp_team_t *team, int new_nproc,
4486 kmp_internal_control_t *new_icvs,
4487 ident_t *loc) {
4488 KF_TRACE(10, ("__kmp_initialize_team: enter: team=%p\n", team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004489
Jonathan Peyton30419822017-05-12 18:01:32 +00004490 /* verify */
4491 KMP_DEBUG_ASSERT(team);
4492 KMP_DEBUG_ASSERT(new_nproc <= team->t.t_max_nproc);
4493 KMP_DEBUG_ASSERT(team->t.t_threads);
4494 KMP_MB();
Jim Cownie181b4bb2013-12-23 17:28:57 +00004495
Jonathan Peyton30419822017-05-12 18:01:32 +00004496 team->t.t_master_tid = 0; /* not needed */
4497 /* team->t.t_master_bar; not needed */
4498 team->t.t_serialized = new_nproc > 1 ? 0 : 1;
4499 team->t.t_nproc = new_nproc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004500
Jonathan Peyton30419822017-05-12 18:01:32 +00004501 /* team->t.t_parent = NULL; TODO not needed & would mess up hot team */
4502 team->t.t_next_pool = NULL;
4503 /* memset( team->t.t_threads, 0, sizeof(kmp_info_t*)*new_nproc ); would mess
4504 * up hot team */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004505
Jonathan Peyton30419822017-05-12 18:01:32 +00004506 TCW_SYNC_PTR(team->t.t_pkfn, NULL); /* not needed */
4507 team->t.t_invoke = NULL; /* not needed */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004508
Jonathan Peyton30419822017-05-12 18:01:32 +00004509 // TODO???: team->t.t_max_active_levels = new_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00004510 team->t.t_sched.sched = new_icvs->sched.sched;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004511
4512#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Jonathan Peyton30419822017-05-12 18:01:32 +00004513 team->t.t_fp_control_saved = FALSE; /* not needed */
4514 team->t.t_x87_fpu_control_word = 0; /* not needed */
4515 team->t.t_mxcsr = 0; /* not needed */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004516#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
4517
Jonathan Peyton30419822017-05-12 18:01:32 +00004518 team->t.t_construct = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004519
Jonathan Peyton30419822017-05-12 18:01:32 +00004520 team->t.t_ordered.dt.t_value = 0;
4521 team->t.t_master_active = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004522
Jim Cownie5e8470a2013-09-27 10:38:44 +00004523#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00004524 team->t.t_copypriv_data = NULL; /* not necessary, but nice for debugging */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004525#endif
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00004526#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00004527 team->t.t_copyin_counter = 0; /* for barrier-free copyin implementation */
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00004528#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00004529
Jonathan Peyton30419822017-05-12 18:01:32 +00004530 team->t.t_control_stack_top = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004531
Jonathan Peyton30419822017-05-12 18:01:32 +00004532 __kmp_reinitialize_team(team, new_icvs, loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004533
Jonathan Peyton30419822017-05-12 18:01:32 +00004534 KMP_MB();
4535 KF_TRACE(10, ("__kmp_initialize_team: exit: team=%p\n", team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004536}
4537
Alp Toker98758b02014-03-02 04:12:06 +00004538#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00004539/* Sets full mask for thread and returns old mask, no changes to structures. */
4540static void
Jonathan Peyton30419822017-05-12 18:01:32 +00004541__kmp_set_thread_affinity_mask_full_tmp(kmp_affin_mask_t *old_mask) {
4542 if (KMP_AFFINITY_CAPABLE()) {
4543 int status;
4544 if (old_mask != NULL) {
4545 status = __kmp_get_system_affinity(old_mask, TRUE);
4546 int error = errno;
4547 if (status != 0) {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00004548 __kmp_fatal(KMP_MSG(ChangeThreadAffMaskError), KMP_ERR(error),
4549 __kmp_msg_null);
Jonathan Peyton30419822017-05-12 18:01:32 +00004550 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004551 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004552 __kmp_set_system_affinity(__kmp_affin_fullMask, TRUE);
4553 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004554}
4555#endif
4556
Alp Toker98758b02014-03-02 04:12:06 +00004557#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00004558
Jim Cownie5e8470a2013-09-27 10:38:44 +00004559// __kmp_partition_places() is the heart of the OpenMP 4.0 affinity mechanism.
4560// It calculats the worker + master thread's partition based upon the parent
Alp Toker8f2d3f02014-02-24 10:40:15 +00004561// thread's partition, and binds each worker to a thread in their partition.
Jim Cownie5e8470a2013-09-27 10:38:44 +00004562// The master thread's partition should already include its current binding.
Jonathan Peyton30419822017-05-12 18:01:32 +00004563static void __kmp_partition_places(kmp_team_t *team, int update_master_only) {
4564 // Copy the master thread's place partion to the team struct
4565 kmp_info_t *master_th = team->t.t_threads[0];
4566 KMP_DEBUG_ASSERT(master_th != NULL);
4567 kmp_proc_bind_t proc_bind = team->t.t_proc_bind;
4568 int first_place = master_th->th.th_first_place;
4569 int last_place = master_th->th.th_last_place;
4570 int masters_place = master_th->th.th_current_place;
4571 team->t.t_first_place = first_place;
4572 team->t.t_last_place = last_place;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004573
Jonathan Peyton30419822017-05-12 18:01:32 +00004574 KA_TRACE(20, ("__kmp_partition_places: enter: proc_bind = %d T#%d(%d:0) "
4575 "bound to place %d partition = [%d,%d]\n",
4576 proc_bind, __kmp_gtid_from_thread(team->t.t_threads[0]),
4577 team->t.t_id, masters_place, first_place, last_place));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004578
Jonathan Peyton30419822017-05-12 18:01:32 +00004579 switch (proc_bind) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00004580
Jonathan Peyton30419822017-05-12 18:01:32 +00004581 case proc_bind_default:
4582 // serial teams might have the proc_bind policy set to proc_bind_default. It
4583 // doesn't matter, as we don't rebind master thread for any proc_bind policy
4584 KMP_DEBUG_ASSERT(team->t.t_nproc == 1);
4585 break;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004586
Jonathan Peyton30419822017-05-12 18:01:32 +00004587 case proc_bind_master: {
4588 int f;
4589 int n_th = team->t.t_nproc;
4590 for (f = 1; f < n_th; f++) {
4591 kmp_info_t *th = team->t.t_threads[f];
4592 KMP_DEBUG_ASSERT(th != NULL);
4593 th->th.th_first_place = first_place;
4594 th->th.th_last_place = last_place;
4595 th->th.th_new_place = masters_place;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00004596#if OMP_50_ENABLED
4597 if (__kmp_display_affinity && masters_place != th->th.th_current_place &&
4598 team->t.t_display_affinity != 1) {
4599 team->t.t_display_affinity = 1;
4600 }
4601#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00004602
Jonathan Peyton30419822017-05-12 18:01:32 +00004603 KA_TRACE(100, ("__kmp_partition_places: master: T#%d(%d:%d) place %d "
4604 "partition = [%d,%d]\n",
4605 __kmp_gtid_from_thread(team->t.t_threads[f]), team->t.t_id,
4606 f, masters_place, first_place, last_place));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004607 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004608 } break;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004609
Jonathan Peyton30419822017-05-12 18:01:32 +00004610 case proc_bind_close: {
4611 int f;
4612 int n_th = team->t.t_nproc;
4613 int n_places;
4614 if (first_place <= last_place) {
4615 n_places = last_place - first_place + 1;
4616 } else {
4617 n_places = __kmp_affinity_num_masks - first_place + last_place + 1;
4618 }
4619 if (n_th <= n_places) {
4620 int place = masters_place;
4621 for (f = 1; f < n_th; f++) {
4622 kmp_info_t *th = team->t.t_threads[f];
4623 KMP_DEBUG_ASSERT(th != NULL);
4624
4625 if (place == last_place) {
4626 place = first_place;
4627 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4628 place = 0;
4629 } else {
4630 place++;
4631 }
4632 th->th.th_first_place = first_place;
4633 th->th.th_last_place = last_place;
4634 th->th.th_new_place = place;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00004635#if OMP_50_ENABLED
4636 if (__kmp_display_affinity && place != th->th.th_current_place &&
4637 team->t.t_display_affinity != 1) {
4638 team->t.t_display_affinity = 1;
4639 }
4640#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004641
4642 KA_TRACE(100, ("__kmp_partition_places: close: T#%d(%d:%d) place %d "
4643 "partition = [%d,%d]\n",
4644 __kmp_gtid_from_thread(team->t.t_threads[f]),
4645 team->t.t_id, f, place, first_place, last_place));
4646 }
4647 } else {
4648 int S, rem, gap, s_count;
4649 S = n_th / n_places;
4650 s_count = 0;
4651 rem = n_th - (S * n_places);
4652 gap = rem > 0 ? n_places / rem : n_places;
4653 int place = masters_place;
4654 int gap_ct = gap;
4655 for (f = 0; f < n_th; f++) {
4656 kmp_info_t *th = team->t.t_threads[f];
4657 KMP_DEBUG_ASSERT(th != NULL);
4658
4659 th->th.th_first_place = first_place;
4660 th->th.th_last_place = last_place;
4661 th->th.th_new_place = place;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00004662#if OMP_50_ENABLED
4663 if (__kmp_display_affinity && place != th->th.th_current_place &&
4664 team->t.t_display_affinity != 1) {
4665 team->t.t_display_affinity = 1;
4666 }
4667#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004668 s_count++;
4669
4670 if ((s_count == S) && rem && (gap_ct == gap)) {
4671 // do nothing, add an extra thread to place on next iteration
4672 } else if ((s_count == S + 1) && rem && (gap_ct == gap)) {
4673 // we added an extra thread to this place; move to next place
4674 if (place == last_place) {
4675 place = first_place;
4676 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4677 place = 0;
4678 } else {
4679 place++;
4680 }
4681 s_count = 0;
4682 gap_ct = 1;
4683 rem--;
4684 } else if (s_count == S) { // place full; don't add extra
4685 if (place == last_place) {
4686 place = first_place;
4687 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4688 place = 0;
4689 } else {
4690 place++;
4691 }
4692 gap_ct++;
4693 s_count = 0;
4694 }
4695
4696 KA_TRACE(100,
4697 ("__kmp_partition_places: close: T#%d(%d:%d) place %d "
4698 "partition = [%d,%d]\n",
4699 __kmp_gtid_from_thread(team->t.t_threads[f]), team->t.t_id, f,
4700 th->th.th_new_place, first_place, last_place));
4701 }
4702 KMP_DEBUG_ASSERT(place == masters_place);
4703 }
4704 } break;
4705
4706 case proc_bind_spread: {
4707 int f;
4708 int n_th = team->t.t_nproc;
4709 int n_places;
4710 int thidx;
4711 if (first_place <= last_place) {
4712 n_places = last_place - first_place + 1;
4713 } else {
4714 n_places = __kmp_affinity_num_masks - first_place + last_place + 1;
4715 }
4716 if (n_th <= n_places) {
Paul Osmialowskia0162792017-08-10 23:04:11 +00004717 int place = -1;
Jonathan Peyton30419822017-05-12 18:01:32 +00004718
Paul Osmialowskia0162792017-08-10 23:04:11 +00004719 if (n_places != static_cast<int>(__kmp_affinity_num_masks)) {
4720 int S = n_places / n_th;
4721 int s_count, rem, gap, gap_ct;
4722
4723 place = masters_place;
4724 rem = n_places - n_th * S;
4725 gap = rem ? n_th / rem : 1;
4726 gap_ct = gap;
4727 thidx = n_th;
4728 if (update_master_only == 1)
4729 thidx = 1;
4730 for (f = 0; f < thidx; f++) {
4731 kmp_info_t *th = team->t.t_threads[f];
4732 KMP_DEBUG_ASSERT(th != NULL);
4733
4734 th->th.th_first_place = place;
4735 th->th.th_new_place = place;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00004736#if OMP_50_ENABLED
4737 if (__kmp_display_affinity && place != th->th.th_current_place &&
4738 team->t.t_display_affinity != 1) {
4739 team->t.t_display_affinity = 1;
4740 }
4741#endif
Paul Osmialowskia0162792017-08-10 23:04:11 +00004742 s_count = 1;
4743 while (s_count < S) {
4744 if (place == last_place) {
4745 place = first_place;
4746 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4747 place = 0;
4748 } else {
4749 place++;
4750 }
4751 s_count++;
4752 }
4753 if (rem && (gap_ct == gap)) {
4754 if (place == last_place) {
4755 place = first_place;
4756 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4757 place = 0;
4758 } else {
4759 place++;
4760 }
4761 rem--;
4762 gap_ct = 0;
4763 }
4764 th->th.th_last_place = place;
4765 gap_ct++;
4766
Jonathan Peyton30419822017-05-12 18:01:32 +00004767 if (place == last_place) {
4768 place = first_place;
4769 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4770 place = 0;
4771 } else {
4772 place++;
4773 }
Paul Osmialowskia0162792017-08-10 23:04:11 +00004774
Jonathan Peyton94a114f2017-10-20 19:30:57 +00004775 KA_TRACE(100,
4776 ("__kmp_partition_places: spread: T#%d(%d:%d) place %d "
4777 "partition = [%d,%d], __kmp_affinity_num_masks: %u\n",
4778 __kmp_gtid_from_thread(team->t.t_threads[f]), team->t.t_id,
4779 f, th->th.th_new_place, th->th.th_first_place,
4780 th->th.th_last_place, __kmp_affinity_num_masks));
Jonathan Peyton30419822017-05-12 18:01:32 +00004781 }
Paul Osmialowskia0162792017-08-10 23:04:11 +00004782 } else {
4783 /* Having uniform space of available computation places I can create
4784 T partitions of round(P/T) size and put threads into the first
4785 place of each partition. */
4786 double current = static_cast<double>(masters_place);
4787 double spacing =
Jonathan Peyton94a114f2017-10-20 19:30:57 +00004788 (static_cast<double>(n_places + 1) / static_cast<double>(n_th));
Paul Osmialowskia0162792017-08-10 23:04:11 +00004789 int first, last;
4790 kmp_info_t *th;
4791
4792 thidx = n_th + 1;
4793 if (update_master_only == 1)
4794 thidx = 1;
4795 for (f = 0; f < thidx; f++) {
4796 first = static_cast<int>(current);
4797 last = static_cast<int>(current + spacing) - 1;
4798 KMP_DEBUG_ASSERT(last >= first);
4799 if (first >= n_places) {
4800 if (masters_place) {
4801 first -= n_places;
4802 last -= n_places;
4803 if (first == (masters_place + 1)) {
4804 KMP_DEBUG_ASSERT(f == n_th);
4805 first--;
4806 }
4807 if (last == masters_place) {
4808 KMP_DEBUG_ASSERT(f == (n_th - 1));
4809 last--;
4810 }
4811 } else {
4812 KMP_DEBUG_ASSERT(f == n_th);
4813 first = 0;
4814 last = 0;
4815 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004816 }
Paul Osmialowskia0162792017-08-10 23:04:11 +00004817 if (last >= n_places) {
4818 last = (n_places - 1);
4819 }
4820 place = first;
4821 current += spacing;
4822 if (f < n_th) {
4823 KMP_DEBUG_ASSERT(0 <= first);
4824 KMP_DEBUG_ASSERT(n_places > first);
4825 KMP_DEBUG_ASSERT(0 <= last);
4826 KMP_DEBUG_ASSERT(n_places > last);
4827 KMP_DEBUG_ASSERT(last_place >= first_place);
4828 th = team->t.t_threads[f];
4829 KMP_DEBUG_ASSERT(th);
4830 th->th.th_first_place = first;
4831 th->th.th_new_place = place;
4832 th->th.th_last_place = last;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00004833#if OMP_50_ENABLED
4834 if (__kmp_display_affinity && place != th->th.th_current_place &&
4835 team->t.t_display_affinity != 1) {
4836 team->t.t_display_affinity = 1;
4837 }
4838#endif
Jonathan Peyton94a114f2017-10-20 19:30:57 +00004839 KA_TRACE(100,
4840 ("__kmp_partition_places: spread: T#%d(%d:%d) place %d "
4841 "partition = [%d,%d], spacing = %.4f\n",
4842 __kmp_gtid_from_thread(team->t.t_threads[f]),
4843 team->t.t_id, f, th->th.th_new_place,
4844 th->th.th_first_place, th->th.th_last_place, spacing));
Paul Osmialowskia0162792017-08-10 23:04:11 +00004845 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004846 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004847 }
4848 KMP_DEBUG_ASSERT(update_master_only || place == masters_place);
4849 } else {
4850 int S, rem, gap, s_count;
4851 S = n_th / n_places;
4852 s_count = 0;
4853 rem = n_th - (S * n_places);
4854 gap = rem > 0 ? n_places / rem : n_places;
4855 int place = masters_place;
4856 int gap_ct = gap;
4857 thidx = n_th;
4858 if (update_master_only == 1)
4859 thidx = 1;
4860 for (f = 0; f < thidx; f++) {
4861 kmp_info_t *th = team->t.t_threads[f];
4862 KMP_DEBUG_ASSERT(th != NULL);
4863
4864 th->th.th_first_place = place;
4865 th->th.th_last_place = place;
4866 th->th.th_new_place = place;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00004867#if OMP_50_ENABLED
4868 if (__kmp_display_affinity && place != th->th.th_current_place &&
4869 team->t.t_display_affinity != 1) {
4870 team->t.t_display_affinity = 1;
4871 }
4872#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004873 s_count++;
4874
4875 if ((s_count == S) && rem && (gap_ct == gap)) {
4876 // do nothing, add an extra thread to place on next iteration
4877 } else if ((s_count == S + 1) && rem && (gap_ct == gap)) {
4878 // we added an extra thread to this place; move on to next place
4879 if (place == last_place) {
4880 place = first_place;
4881 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4882 place = 0;
4883 } else {
4884 place++;
4885 }
4886 s_count = 0;
4887 gap_ct = 1;
4888 rem--;
4889 } else if (s_count == S) { // place is full; don't add extra thread
4890 if (place == last_place) {
4891 place = first_place;
4892 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4893 place = 0;
4894 } else {
4895 place++;
4896 }
4897 gap_ct++;
4898 s_count = 0;
4899 }
4900
4901 KA_TRACE(100, ("__kmp_partition_places: spread: T#%d(%d:%d) place %d "
4902 "partition = [%d,%d]\n",
4903 __kmp_gtid_from_thread(team->t.t_threads[f]),
4904 team->t.t_id, f, th->th.th_new_place,
4905 th->th.th_first_place, th->th.th_last_place));
4906 }
4907 KMP_DEBUG_ASSERT(update_master_only || place == masters_place);
4908 }
4909 } break;
4910
4911 default:
4912 break;
4913 }
4914
4915 KA_TRACE(20, ("__kmp_partition_places: exit T#%d\n", team->t.t_id));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004916}
4917
Alp Toker98758b02014-03-02 04:12:06 +00004918#endif /* OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004919
Jonathan Peyton30419822017-05-12 18:01:32 +00004920/* allocate a new team data structure to use. take one off of the free pool if
4921 available */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004922kmp_team_t *
Jonathan Peyton30419822017-05-12 18:01:32 +00004923__kmp_allocate_team(kmp_root_t *root, int new_nproc, int max_nproc,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00004924#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00004925 ompt_data_t ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00004926#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00004927#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004928 kmp_proc_bind_t new_proc_bind,
Jim Cownie5e8470a2013-09-27 10:38:44 +00004929#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004930 kmp_internal_control_t *new_icvs,
4931 int argc USE_NESTED_HOT_ARG(kmp_info_t *master)) {
4932 KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(KMP_allocate_team);
4933 int f;
4934 kmp_team_t *team;
4935 int use_hot_team = !root->r.r_active;
4936 int level = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004937
Jonathan Peyton30419822017-05-12 18:01:32 +00004938 KA_TRACE(20, ("__kmp_allocate_team: called\n"));
4939 KMP_DEBUG_ASSERT(new_nproc >= 1 && argc >= 0);
4940 KMP_DEBUG_ASSERT(max_nproc >= new_nproc);
4941 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004942
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004943#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004944 kmp_hot_team_ptr_t *hot_teams;
4945 if (master) {
4946 team = master->th.th_team;
4947 level = team->t.t_active_level;
4948 if (master->th.th_teams_microtask) { // in teams construct?
4949 if (master->th.th_teams_size.nteams > 1 &&
4950 ( // #teams > 1
4951 team->t.t_pkfn ==
4952 (microtask_t)__kmp_teams_master || // inner fork of the teams
4953 master->th.th_teams_level <
4954 team->t.t_level)) { // or nested parallel inside the teams
4955 ++level; // not increment if #teams==1, or for outer fork of the teams;
4956 // increment otherwise
4957 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004958 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004959 hot_teams = master->th.th_hot_teams;
4960 if (level < __kmp_hot_teams_max_level && hot_teams &&
4961 hot_teams[level]
4962 .hot_team) { // hot team has already been allocated for given level
4963 use_hot_team = 1;
4964 } else {
4965 use_hot_team = 0;
4966 }
4967 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004968#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004969 // Optimization to use a "hot" team
4970 if (use_hot_team && new_nproc > 1) {
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00004971 KMP_DEBUG_ASSERT(new_nproc <= max_nproc);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004972#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004973 team = hot_teams[level].hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004974#else
Jonathan Peyton30419822017-05-12 18:01:32 +00004975 team = root->r.r_hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004976#endif
4977#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00004978 if (__kmp_tasking_mode != tskm_immediate_exec) {
4979 KA_TRACE(20, ("__kmp_allocate_team: hot team task_team[0] = %p "
4980 "task_team[1] = %p before reinit\n",
4981 team->t.t_task_team[0], team->t.t_task_team[1]));
4982 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004983#endif
4984
Jonathan Peyton30419822017-05-12 18:01:32 +00004985 // Has the number of threads changed?
4986 /* Let's assume the most common case is that the number of threads is
4987 unchanged, and put that case first. */
4988 if (team->t.t_nproc == new_nproc) { // Check changes in number of threads
4989 KA_TRACE(20, ("__kmp_allocate_team: reusing hot team\n"));
4990 // This case can mean that omp_set_num_threads() was called and the hot
Jonathan Peyton642688b2017-06-01 16:46:36 +00004991 // team size was already reduced, so we check the special flag
Jonathan Peyton30419822017-05-12 18:01:32 +00004992 if (team->t.t_size_changed == -1) {
4993 team->t.t_size_changed = 1;
4994 } else {
4995 KMP_CHECK_UPDATE(team->t.t_size_changed, 0);
4996 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004997
Jonathan Peyton30419822017-05-12 18:01:32 +00004998 // TODO???: team->t.t_max_active_levels = new_max_active_levels;
4999 kmp_r_sched_t new_sched = new_icvs->sched;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00005000 // set master's schedule as new run-time schedule
5001 KMP_CHECK_UPDATE(team->t.t_sched.sched, new_sched.sched);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005002
Jonathan Peyton30419822017-05-12 18:01:32 +00005003 __kmp_reinitialize_team(team, new_icvs,
5004 root->r.r_uber_thread->th.th_ident);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005005
Jonathan Peyton30419822017-05-12 18:01:32 +00005006 KF_TRACE(10, ("__kmp_allocate_team2: T#%d, this_thread=%p team=%p\n", 0,
5007 team->t.t_threads[0], team));
5008 __kmp_push_current_task_to_thread(team->t.t_threads[0], team, 0);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005009
5010#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00005011#if KMP_AFFINITY_SUPPORTED
5012 if ((team->t.t_size_changed == 0) &&
5013 (team->t.t_proc_bind == new_proc_bind)) {
5014 if (new_proc_bind == proc_bind_spread) {
5015 __kmp_partition_places(
5016 team, 1); // add flag to update only master for spread
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005017 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005018 KA_TRACE(200, ("__kmp_allocate_team: reusing hot team #%d bindings: "
5019 "proc_bind = %d, partition = [%d,%d]\n",
5020 team->t.t_id, new_proc_bind, team->t.t_first_place,
5021 team->t.t_last_place));
5022 } else {
5023 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
5024 __kmp_partition_places(team);
5025 }
5026#else
5027 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
5028#endif /* KMP_AFFINITY_SUPPORTED */
5029#endif /* OMP_40_ENABLED */
5030 } else if (team->t.t_nproc > new_nproc) {
5031 KA_TRACE(20,
5032 ("__kmp_allocate_team: decreasing hot team thread count to %d\n",
5033 new_nproc));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005034
Jonathan Peyton30419822017-05-12 18:01:32 +00005035 team->t.t_size_changed = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005036#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005037 if (__kmp_hot_teams_mode == 0) {
5038 // AC: saved number of threads should correspond to team's value in this
5039 // mode, can be bigger in mode 1, when hot team has threads in reserve
5040 KMP_DEBUG_ASSERT(hot_teams[level].hot_team_nth == team->t.t_nproc);
5041 hot_teams[level].hot_team_nth = new_nproc;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005042#endif // KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005043 /* release the extra threads we don't need any more */
5044 for (f = new_nproc; f < team->t.t_nproc; f++) {
5045 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
5046 if (__kmp_tasking_mode != tskm_immediate_exec) {
5047 // When decreasing team size, threads no longer in the team should
5048 // unref task team.
5049 team->t.t_threads[f]->th.th_task_team = NULL;
5050 }
5051 __kmp_free_thread(team->t.t_threads[f]);
5052 team->t.t_threads[f] = NULL;
5053 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005054#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005055 } // (__kmp_hot_teams_mode == 0)
5056 else {
5057 // When keeping extra threads in team, switch threads to wait on own
5058 // b_go flag
5059 for (f = new_nproc; f < team->t.t_nproc; ++f) {
5060 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
5061 kmp_balign_t *balign = team->t.t_threads[f]->th.th_bar;
5062 for (int b = 0; b < bs_last_barrier; ++b) {
5063 if (balign[b].bb.wait_flag == KMP_BARRIER_PARENT_FLAG) {
5064 balign[b].bb.wait_flag = KMP_BARRIER_SWITCH_TO_OWN_FLAG;
Andrey Churbanovd6e1d7e2016-08-11 13:04:00 +00005065 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005066 KMP_CHECK_UPDATE(balign[b].bb.leaf_kids, 0);
5067 }
5068 }
5069 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005070#endif // KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005071 team->t.t_nproc = new_nproc;
5072 // TODO???: team->t.t_max_active_levels = new_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00005073 KMP_CHECK_UPDATE(team->t.t_sched.sched, new_icvs->sched.sched);
Jonathan Peyton30419822017-05-12 18:01:32 +00005074 __kmp_reinitialize_team(team, new_icvs,
5075 root->r.r_uber_thread->th.th_ident);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005076
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00005077 // Update remaining threads
Jonathan Peyton30419822017-05-12 18:01:32 +00005078 for (f = 0; f < new_nproc; ++f) {
5079 team->t.t_threads[f]->th.th_team_nproc = new_nproc;
5080 }
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00005081
Jonathan Peyton30419822017-05-12 18:01:32 +00005082 // restore the current task state of the master thread: should be the
5083 // implicit task
5084 KF_TRACE(10, ("__kmp_allocate_team: T#%d, this_thread=%p team=%p\n", 0,
5085 team->t.t_threads[0], team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005086
Jonathan Peyton30419822017-05-12 18:01:32 +00005087 __kmp_push_current_task_to_thread(team->t.t_threads[0], team, 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005088
5089#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00005090 for (f = 0; f < team->t.t_nproc; f++) {
5091 KMP_DEBUG_ASSERT(team->t.t_threads[f] &&
5092 team->t.t_threads[f]->th.th_team_nproc ==
5093 team->t.t_nproc);
5094 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005095#endif
5096
5097#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00005098 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
5099#if KMP_AFFINITY_SUPPORTED
5100 __kmp_partition_places(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005101#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005102#endif
5103 } else { // team->t.t_nproc < new_nproc
Alp Toker98758b02014-03-02 04:12:06 +00005104#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00005105 kmp_affin_mask_t *old_mask;
5106 if (KMP_AFFINITY_CAPABLE()) {
5107 KMP_CPU_ALLOC(old_mask);
5108 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005109#endif
5110
Jonathan Peyton30419822017-05-12 18:01:32 +00005111 KA_TRACE(20,
5112 ("__kmp_allocate_team: increasing hot team thread count to %d\n",
5113 new_nproc));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005114
Jonathan Peyton30419822017-05-12 18:01:32 +00005115 team->t.t_size_changed = 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005116
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005117#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005118 int avail_threads = hot_teams[level].hot_team_nth;
5119 if (new_nproc < avail_threads)
5120 avail_threads = new_nproc;
5121 kmp_info_t **other_threads = team->t.t_threads;
5122 for (f = team->t.t_nproc; f < avail_threads; ++f) {
5123 // Adjust barrier data of reserved threads (if any) of the team
5124 // Other data will be set in __kmp_initialize_info() below.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005125 int b;
Jonathan Peyton30419822017-05-12 18:01:32 +00005126 kmp_balign_t *balign = other_threads[f]->th.th_bar;
5127 for (b = 0; b < bs_last_barrier; ++b) {
5128 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
5129 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00005130#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00005131 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00005132#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005133 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005134 }
5135 if (hot_teams[level].hot_team_nth >= new_nproc) {
5136 // we have all needed threads in reserve, no need to allocate any
5137 // this only possible in mode 1, cannot have reserved threads in mode 0
5138 KMP_DEBUG_ASSERT(__kmp_hot_teams_mode == 1);
5139 team->t.t_nproc = new_nproc; // just get reserved threads involved
5140 } else {
5141 // we may have some threads in reserve, but not enough
5142 team->t.t_nproc =
5143 hot_teams[level]
5144 .hot_team_nth; // get reserved threads involved if any
5145 hot_teams[level].hot_team_nth = new_nproc; // adjust hot team max size
5146#endif // KMP_NESTED_HOT_TEAMS
5147 if (team->t.t_max_nproc < new_nproc) {
5148 /* reallocate larger arrays */
5149 __kmp_reallocate_team_arrays(team, new_nproc);
5150 __kmp_reinitialize_team(team, new_icvs, NULL);
5151 }
5152
5153#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
5154 /* Temporarily set full mask for master thread before creation of
5155 workers. The reason is that workers inherit the affinity from master,
5156 so if a lot of workers are created on the single core quickly, they
5157 don't get a chance to set their own affinity for a long time. */
5158 __kmp_set_thread_affinity_mask_full_tmp(old_mask);
5159#endif
5160
5161 /* allocate new threads for the hot team */
5162 for (f = team->t.t_nproc; f < new_nproc; f++) {
5163 kmp_info_t *new_worker = __kmp_allocate_thread(root, team, f);
5164 KMP_DEBUG_ASSERT(new_worker);
5165 team->t.t_threads[f] = new_worker;
5166
5167 KA_TRACE(20,
5168 ("__kmp_allocate_team: team %d init T#%d arrived: "
5169 "join=%llu, plain=%llu\n",
5170 team->t.t_id, __kmp_gtid_from_tid(f, team), team->t.t_id, f,
5171 team->t.t_bar[bs_forkjoin_barrier].b_arrived,
5172 team->t.t_bar[bs_plain_barrier].b_arrived));
5173
5174 { // Initialize barrier data for new threads.
5175 int b;
5176 kmp_balign_t *balign = new_worker->th.th_bar;
5177 for (b = 0; b < bs_last_barrier; ++b) {
5178 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
5179 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag !=
5180 KMP_BARRIER_PARENT_FLAG);
5181#if USE_DEBUGGER
5182 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
5183#endif
5184 }
5185 }
5186 }
5187
5188#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
5189 if (KMP_AFFINITY_CAPABLE()) {
5190 /* Restore initial master thread's affinity mask */
5191 __kmp_set_system_affinity(old_mask, TRUE);
5192 KMP_CPU_FREE(old_mask);
5193 }
5194#endif
5195#if KMP_NESTED_HOT_TEAMS
5196 } // end of check of t_nproc vs. new_nproc vs. hot_team_nth
5197#endif // KMP_NESTED_HOT_TEAMS
5198 /* make sure everyone is syncronized */
5199 int old_nproc = team->t.t_nproc; // save old value and use to update only
5200 // new threads below
5201 __kmp_initialize_team(team, new_nproc, new_icvs,
5202 root->r.r_uber_thread->th.th_ident);
5203
5204 /* reinitialize the threads */
5205 KMP_DEBUG_ASSERT(team->t.t_nproc == new_nproc);
5206 for (f = 0; f < team->t.t_nproc; ++f)
5207 __kmp_initialize_info(team->t.t_threads[f], team, f,
5208 __kmp_gtid_from_tid(f, team));
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00005209
Jonathan Peyton30419822017-05-12 18:01:32 +00005210 if (level) { // set th_task_state for new threads in nested hot team
5211 // __kmp_initialize_info() no longer zeroes th_task_state, so we should
5212 // only need to set the th_task_state for the new threads. th_task_state
5213 // for master thread will not be accurate until after this in
5214 // __kmp_fork_call(), so we look to the master's memo_stack to get the
5215 // correct value.
5216 for (f = old_nproc; f < team->t.t_nproc; ++f)
5217 team->t.t_threads[f]->th.th_task_state =
5218 team->t.t_threads[0]->th.th_task_state_memo_stack[level];
5219 } else { // set th_task_state for new threads in non-nested hot team
5220 int old_state =
5221 team->t.t_threads[0]->th.th_task_state; // copy master's state
5222 for (f = old_nproc; f < team->t.t_nproc; ++f)
5223 team->t.t_threads[f]->th.th_task_state = old_state;
5224 }
5225
5226#ifdef KMP_DEBUG
5227 for (f = 0; f < team->t.t_nproc; ++f) {
5228 KMP_DEBUG_ASSERT(team->t.t_threads[f] &&
5229 team->t.t_threads[f]->th.th_team_nproc ==
5230 team->t.t_nproc);
5231 }
5232#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005233
5234#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00005235 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
5236#if KMP_AFFINITY_SUPPORTED
5237 __kmp_partition_places(team);
5238#endif
5239#endif
5240 } // Check changes in number of threads
5241
5242#if OMP_40_ENABLED
5243 kmp_info_t *master = team->t.t_threads[0];
5244 if (master->th.th_teams_microtask) {
5245 for (f = 1; f < new_nproc; ++f) {
5246 // propagate teams construct specific info to workers
5247 kmp_info_t *thr = team->t.t_threads[f];
5248 thr->th.th_teams_microtask = master->th.th_teams_microtask;
5249 thr->th.th_teams_level = master->th.th_teams_level;
5250 thr->th.th_teams_size = master->th.th_teams_size;
5251 }
5252 }
5253#endif /* OMP_40_ENABLED */
5254#if KMP_NESTED_HOT_TEAMS
5255 if (level) {
5256 // Sync barrier state for nested hot teams, not needed for outermost hot
5257 // team.
5258 for (f = 1; f < new_nproc; ++f) {
5259 kmp_info_t *thr = team->t.t_threads[f];
5260 int b;
5261 kmp_balign_t *balign = thr->th.th_bar;
5262 for (b = 0; b < bs_last_barrier; ++b) {
5263 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
5264 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
5265#if USE_DEBUGGER
5266 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
5267#endif
5268 }
5269 }
5270 }
5271#endif // KMP_NESTED_HOT_TEAMS
5272
5273 /* reallocate space for arguments if necessary */
5274 __kmp_alloc_argv_entries(argc, team, TRUE);
5275 KMP_CHECK_UPDATE(team->t.t_argc, argc);
5276 // The hot team re-uses the previous task team,
5277 // if untouched during the previous release->gather phase.
5278
5279 KF_TRACE(10, (" hot_team = %p\n", team));
5280
5281#if KMP_DEBUG
5282 if (__kmp_tasking_mode != tskm_immediate_exec) {
5283 KA_TRACE(20, ("__kmp_allocate_team: hot team task_team[0] = %p "
5284 "task_team[1] = %p after reinit\n",
5285 team->t.t_task_team[0], team->t.t_task_team[1]));
5286 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005287#endif
5288
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005289#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005290 __ompt_team_assign_id(team, ompt_parallel_data);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005291#endif
5292
Jim Cownie5e8470a2013-09-27 10:38:44 +00005293 KMP_MB();
5294
Jim Cownie5e8470a2013-09-27 10:38:44 +00005295 return team;
Jonathan Peyton30419822017-05-12 18:01:32 +00005296 }
5297
5298 /* next, let's try to take one from the team pool */
5299 KMP_MB();
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005300 for (team = CCAST(kmp_team_t *, __kmp_team_pool); (team);) {
Jonathan Peyton30419822017-05-12 18:01:32 +00005301 /* TODO: consider resizing undersized teams instead of reaping them, now
5302 that we have a resizing mechanism */
5303 if (team->t.t_max_nproc >= max_nproc) {
5304 /* take this team from the team pool */
5305 __kmp_team_pool = team->t.t_next_pool;
5306
5307 /* setup the team for fresh use */
5308 __kmp_initialize_team(team, new_nproc, new_icvs, NULL);
5309
5310 KA_TRACE(20, ("__kmp_allocate_team: setting task_team[0] %p and "
5311 "task_team[1] %p to NULL\n",
5312 &team->t.t_task_team[0], &team->t.t_task_team[1]));
5313 team->t.t_task_team[0] = NULL;
5314 team->t.t_task_team[1] = NULL;
5315
5316 /* reallocate space for arguments if necessary */
5317 __kmp_alloc_argv_entries(argc, team, TRUE);
5318 KMP_CHECK_UPDATE(team->t.t_argc, argc);
5319
5320 KA_TRACE(
5321 20, ("__kmp_allocate_team: team %d init arrived: join=%u, plain=%u\n",
5322 team->t.t_id, KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
5323 { // Initialize barrier data.
5324 int b;
5325 for (b = 0; b < bs_last_barrier; ++b) {
5326 team->t.t_bar[b].b_arrived = KMP_INIT_BARRIER_STATE;
5327#if USE_DEBUGGER
5328 team->t.t_bar[b].b_master_arrived = 0;
5329 team->t.t_bar[b].b_team_arrived = 0;
5330#endif
5331 }
5332 }
5333
5334#if OMP_40_ENABLED
5335 team->t.t_proc_bind = new_proc_bind;
5336#endif
5337
5338 KA_TRACE(20, ("__kmp_allocate_team: using team from pool %d.\n",
5339 team->t.t_id));
5340
5341#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005342 __ompt_team_assign_id(team, ompt_parallel_data);
Jonathan Peyton30419822017-05-12 18:01:32 +00005343#endif
5344
5345 KMP_MB();
5346
5347 return team;
5348 }
5349
Jonathan Peyton94a114f2017-10-20 19:30:57 +00005350 /* reap team if it is too small, then loop back and check the next one */
5351 // not sure if this is wise, but, will be redone during the hot-teams
5352 // rewrite.
5353 /* TODO: Use technique to find the right size hot-team, don't reap them */
Jonathan Peyton30419822017-05-12 18:01:32 +00005354 team = __kmp_reap_team(team);
5355 __kmp_team_pool = team;
5356 }
5357
5358 /* nothing available in the pool, no matter, make a new team! */
5359 KMP_MB();
5360 team = (kmp_team_t *)__kmp_allocate(sizeof(kmp_team_t));
5361
5362 /* and set it up */
5363 team->t.t_max_nproc = max_nproc;
5364 /* NOTE well, for some reason allocating one big buffer and dividing it up
5365 seems to really hurt performance a lot on the P4, so, let's not use this */
5366 __kmp_allocate_team_arrays(team, max_nproc);
5367
5368 KA_TRACE(20, ("__kmp_allocate_team: making a new team\n"));
5369 __kmp_initialize_team(team, new_nproc, new_icvs, NULL);
5370
5371 KA_TRACE(20, ("__kmp_allocate_team: setting task_team[0] %p and task_team[1] "
5372 "%p to NULL\n",
5373 &team->t.t_task_team[0], &team->t.t_task_team[1]));
5374 team->t.t_task_team[0] = NULL; // to be removed, as __kmp_allocate zeroes
5375 // memory, no need to duplicate
5376 team->t.t_task_team[1] = NULL; // to be removed, as __kmp_allocate zeroes
5377 // memory, no need to duplicate
5378
5379 if (__kmp_storage_map) {
5380 __kmp_print_team_storage_map("team", team, team->t.t_id, new_nproc);
5381 }
5382
5383 /* allocate space for arguments */
5384 __kmp_alloc_argv_entries(argc, team, FALSE);
5385 team->t.t_argc = argc;
5386
5387 KA_TRACE(20,
5388 ("__kmp_allocate_team: team %d init arrived: join=%u, plain=%u\n",
5389 team->t.t_id, KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
5390 { // Initialize barrier data.
5391 int b;
5392 for (b = 0; b < bs_last_barrier; ++b) {
5393 team->t.t_bar[b].b_arrived = KMP_INIT_BARRIER_STATE;
5394#if USE_DEBUGGER
5395 team->t.t_bar[b].b_master_arrived = 0;
5396 team->t.t_bar[b].b_team_arrived = 0;
5397#endif
5398 }
5399 }
5400
5401#if OMP_40_ENABLED
5402 team->t.t_proc_bind = new_proc_bind;
5403#endif
5404
5405#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005406 __ompt_team_assign_id(team, ompt_parallel_data);
Jonathan Peyton30419822017-05-12 18:01:32 +00005407 team->t.ompt_serialized_team_info = NULL;
5408#endif
5409
5410 KMP_MB();
5411
5412 KA_TRACE(20, ("__kmp_allocate_team: done creating a new team %d.\n",
5413 team->t.t_id));
5414
5415 return team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005416}
5417
5418/* TODO implement hot-teams at all levels */
5419/* TODO implement lazy thread release on demand (disband request) */
5420
5421/* free the team. return it to the team pool. release all the threads
5422 * associated with it */
Jonathan Peyton30419822017-05-12 18:01:32 +00005423void __kmp_free_team(kmp_root_t *root,
5424 kmp_team_t *team USE_NESTED_HOT_ARG(kmp_info_t *master)) {
5425 int f;
5426 KA_TRACE(20, ("__kmp_free_team: T#%d freeing team %d\n", __kmp_get_gtid(),
5427 team->t.t_id));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005428
Jonathan Peyton30419822017-05-12 18:01:32 +00005429 /* verify state */
5430 KMP_DEBUG_ASSERT(root);
5431 KMP_DEBUG_ASSERT(team);
5432 KMP_DEBUG_ASSERT(team->t.t_nproc <= team->t.t_max_nproc);
5433 KMP_DEBUG_ASSERT(team->t.t_threads);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005434
Jonathan Peyton30419822017-05-12 18:01:32 +00005435 int use_hot_team = team == root->r.r_hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005436#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005437 int level;
5438 kmp_hot_team_ptr_t *hot_teams;
5439 if (master) {
5440 level = team->t.t_active_level - 1;
5441 if (master->th.th_teams_microtask) { // in teams construct?
5442 if (master->th.th_teams_size.nteams > 1) {
5443 ++level; // level was not increased in teams construct for
5444 // team_of_masters
5445 }
5446 if (team->t.t_pkfn != (microtask_t)__kmp_teams_master &&
5447 master->th.th_teams_level == team->t.t_level) {
5448 ++level; // level was not increased in teams construct for
5449 // team_of_workers before the parallel
5450 } // team->t.t_level will be increased inside parallel
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005451 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005452 hot_teams = master->th.th_hot_teams;
5453 if (level < __kmp_hot_teams_max_level) {
5454 KMP_DEBUG_ASSERT(team == hot_teams[level].hot_team);
5455 use_hot_team = 1;
5456 }
5457 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005458#endif // KMP_NESTED_HOT_TEAMS
5459
Jonathan Peyton30419822017-05-12 18:01:32 +00005460 /* team is done working */
5461 TCW_SYNC_PTR(team->t.t_pkfn,
5462 NULL); // Important for Debugging Support Library.
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00005463#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00005464 team->t.t_copyin_counter = 0; // init counter for possible reuse
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00005465#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005466 // Do not reset pointer to parent team to NULL for hot teams.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005467
Jonathan Peyton30419822017-05-12 18:01:32 +00005468 /* if we are non-hot team, release our threads */
5469 if (!use_hot_team) {
5470 if (__kmp_tasking_mode != tskm_immediate_exec) {
5471 // Wait for threads to reach reapable state
5472 for (f = 1; f < team->t.t_nproc; ++f) {
5473 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
5474 kmp_info_t *th = team->t.t_threads[f];
5475 volatile kmp_uint32 *state = &th->th.th_reap_state;
5476 while (*state != KMP_SAFE_TO_REAP) {
Andrey Churbanov581490e2017-02-06 18:53:32 +00005477#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00005478 // On Windows a thread can be killed at any time, check this
5479 DWORD ecode;
5480 if (!__kmp_is_thread_alive(th, &ecode)) {
5481 *state = KMP_SAFE_TO_REAP; // reset the flag for dead thread
5482 break;
5483 }
Andrey Churbanov581490e2017-02-06 18:53:32 +00005484#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005485 // first check if thread is sleeping
5486 kmp_flag_64 fl(&th->th.th_bar[bs_forkjoin_barrier].bb.b_go, th);
5487 if (fl.is_sleeping())
5488 fl.resume(__kmp_gtid_from_thread(th));
5489 KMP_CPU_PAUSE();
5490 }
5491 }
Andrey Churbanov581490e2017-02-06 18:53:32 +00005492
Jonathan Peyton30419822017-05-12 18:01:32 +00005493 // Delete task teams
5494 int tt_idx;
5495 for (tt_idx = 0; tt_idx < 2; ++tt_idx) {
5496 kmp_task_team_t *task_team = team->t.t_task_team[tt_idx];
5497 if (task_team != NULL) {
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00005498 for (f = 0; f < team->t.t_nproc; ++f) { // threads unref task teams
5499 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
Jonathan Peyton30419822017-05-12 18:01:32 +00005500 team->t.t_threads[f]->th.th_task_team = NULL;
5501 }
5502 KA_TRACE(
5503 20,
5504 ("__kmp_free_team: T#%d deactivating task_team %p on team %d\n",
5505 __kmp_get_gtid(), task_team, team->t.t_id));
Jonathan Peytonbaaccfa2015-11-16 22:48:41 +00005506#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005507 __kmp_free_task_team(master, task_team);
Jonathan Peytonbaaccfa2015-11-16 22:48:41 +00005508#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005509 team->t.t_task_team[tt_idx] = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005510 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005511 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005512 }
5513
Jonathan Peyton30419822017-05-12 18:01:32 +00005514 // Reset pointer to parent team only for non-hot teams.
5515 team->t.t_parent = NULL;
5516 team->t.t_level = 0;
5517 team->t.t_active_level = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005518
Jonathan Peyton30419822017-05-12 18:01:32 +00005519 /* free the worker threads */
5520 for (f = 1; f < team->t.t_nproc; ++f) {
5521 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
5522 __kmp_free_thread(team->t.t_threads[f]);
5523 team->t.t_threads[f] = NULL;
5524 }
5525
5526 /* put the team back in the team pool */
5527 /* TODO limit size of team pool, call reap_team if pool too large */
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005528 team->t.t_next_pool = CCAST(kmp_team_t *, __kmp_team_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00005529 __kmp_team_pool = (volatile kmp_team_t *)team;
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00005530 } else { // Check if team was created for the masters in a teams construct
5531 // See if first worker is a CG root
5532 KMP_DEBUG_ASSERT(team->t.t_threads[1] &&
5533 team->t.t_threads[1]->th.th_cg_roots);
5534 if (team->t.t_threads[1]->th.th_cg_roots->cg_root == team->t.t_threads[1]) {
5535 // Clean up the CG root nodes on workers so that this team can be re-used
5536 for (f = 1; f < team->t.t_nproc; ++f) {
5537 kmp_info_t *thr = team->t.t_threads[f];
5538 KMP_DEBUG_ASSERT(thr && thr->th.th_cg_roots &&
5539 thr->th.th_cg_roots->cg_root == thr);
5540 // Pop current CG root off list
5541 kmp_cg_root_t *tmp = thr->th.th_cg_roots;
5542 thr->th.th_cg_roots = tmp->up;
5543 KA_TRACE(100, ("__kmp_free_team: Thread %p popping node %p and moving"
5544 " up to node %p. cg_nthreads was %d\n",
5545 thr, tmp, thr->th.th_cg_roots, tmp->cg_nthreads));
5546 __kmp_free(tmp);
5547 // Restore current task's thread_limit from CG root
5548 if (thr->th.th_cg_roots)
5549 thr->th.th_current_task->td_icvs.thread_limit =
5550 thr->th.th_cg_roots->cg_thread_limit;
5551 }
5552 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005553 }
5554
5555 KMP_MB();
5556}
Jim Cownie5e8470a2013-09-27 10:38:44 +00005557
5558/* reap the team. destroy it, reclaim all its resources and free its memory */
Jonathan Peyton30419822017-05-12 18:01:32 +00005559kmp_team_t *__kmp_reap_team(kmp_team_t *team) {
5560 kmp_team_t *next_pool = team->t.t_next_pool;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005561
Jonathan Peyton30419822017-05-12 18:01:32 +00005562 KMP_DEBUG_ASSERT(team);
5563 KMP_DEBUG_ASSERT(team->t.t_dispatch);
5564 KMP_DEBUG_ASSERT(team->t.t_disp_buffer);
5565 KMP_DEBUG_ASSERT(team->t.t_threads);
5566 KMP_DEBUG_ASSERT(team->t.t_argv);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005567
Jonathan Peyton30419822017-05-12 18:01:32 +00005568 /* TODO clean the threads that are a part of this? */
Jim Cownie5e8470a2013-09-27 10:38:44 +00005569
Jonathan Peyton30419822017-05-12 18:01:32 +00005570 /* free stuff */
5571 __kmp_free_team_arrays(team);
5572 if (team->t.t_argv != &team->t.t_inline_argv[0])
5573 __kmp_free((void *)team->t.t_argv);
5574 __kmp_free(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005575
Jonathan Peyton30419822017-05-12 18:01:32 +00005576 KMP_MB();
5577 return next_pool;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005578}
5579
Jim Cownie5e8470a2013-09-27 10:38:44 +00005580// Free the thread. Don't reap it, just place it on the pool of available
5581// threads.
5582//
5583// Changes for Quad issue 527845: We need a predictable OMP tid <-> gtid
5584// binding for the affinity mechanism to be useful.
5585//
5586// Now, we always keep the free list (__kmp_thread_pool) sorted by gtid.
5587// However, we want to avoid a potential performance problem by always
5588// scanning through the list to find the correct point at which to insert
5589// the thread (potential N**2 behavior). To do this we keep track of the
5590// last place a thread struct was inserted (__kmp_thread_pool_insert_pt).
5591// With single-level parallelism, threads will always be added to the tail
5592// of the list, kept track of by __kmp_thread_pool_insert_pt. With nested
5593// parallelism, all bets are off and we may need to scan through the entire
5594// free list.
5595//
5596// This change also has a potentially large performance benefit, for some
5597// applications. Previously, as threads were freed from the hot team, they
5598// would be placed back on the free list in inverse order. If the hot team
5599// grew back to it's original size, then the freed thread would be placed
5600// back on the hot team in reverse order. This could cause bad cache
5601// locality problems on programs where the size of the hot team regularly
5602// grew and shrunk.
5603//
5604// Now, for single-level parallelism, the OMP tid is alway == gtid.
Jonathan Peyton30419822017-05-12 18:01:32 +00005605void __kmp_free_thread(kmp_info_t *this_th) {
5606 int gtid;
5607 kmp_info_t **scan;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005608
Jonathan Peyton30419822017-05-12 18:01:32 +00005609 KA_TRACE(20, ("__kmp_free_thread: T#%d putting T#%d back on free pool.\n",
5610 __kmp_get_gtid(), this_th->th.th_info.ds.ds_gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005611
Jonathan Peyton30419822017-05-12 18:01:32 +00005612 KMP_DEBUG_ASSERT(this_th);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005613
Jonathan Peyton30419822017-05-12 18:01:32 +00005614 // When moving thread to pool, switch thread to wait on own b_go flag, and
5615 // uninitialized (NULL team).
5616 int b;
5617 kmp_balign_t *balign = this_th->th.th_bar;
5618 for (b = 0; b < bs_last_barrier; ++b) {
5619 if (balign[b].bb.wait_flag == KMP_BARRIER_PARENT_FLAG)
5620 balign[b].bb.wait_flag = KMP_BARRIER_SWITCH_TO_OWN_FLAG;
5621 balign[b].bb.team = NULL;
5622 balign[b].bb.leaf_kids = 0;
5623 }
5624 this_th->th.th_task_state = 0;
Andrey Churbanov3336aa02018-03-19 18:05:15 +00005625 this_th->th.th_reap_state = KMP_SAFE_TO_REAP;
Jonathan Peyton30419822017-05-12 18:01:32 +00005626
5627 /* put thread back on the free pool */
5628 TCW_PTR(this_th->th.th_team, NULL);
5629 TCW_PTR(this_th->th.th_root, NULL);
5630 TCW_PTR(this_th->th.th_dispatch, NULL); /* NOT NEEDED */
5631
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00005632 while (this_th->th.th_cg_roots) {
5633 this_th->th.th_cg_roots->cg_nthreads--;
5634 KA_TRACE(100, ("__kmp_free_thread: Thread %p decrement cg_nthreads on node"
5635 " %p of thread %p to %d\n",
5636 this_th, this_th->th.th_cg_roots,
5637 this_th->th.th_cg_roots->cg_root,
5638 this_th->th.th_cg_roots->cg_nthreads));
5639 kmp_cg_root_t *tmp = this_th->th.th_cg_roots;
5640 if (tmp->cg_root == this_th) { // Thread is a cg_root
5641 KMP_DEBUG_ASSERT(tmp->cg_nthreads == 0);
5642 KA_TRACE(
5643 5, ("__kmp_free_thread: Thread %p freeing node %p\n", this_th, tmp));
5644 this_th->th.th_cg_roots = tmp->up;
5645 __kmp_free(tmp);
5646 } else { // Worker thread
5647 this_th->th.th_cg_roots = NULL;
5648 break;
5649 }
5650 }
5651
Jonathan Peytonbff8ded2018-01-10 18:24:09 +00005652 /* If the implicit task assigned to this thread can be used by other threads
5653 * -> multiple threads can share the data and try to free the task at
5654 * __kmp_reap_thread at exit. This duplicate use of the task data can happen
5655 * with higher probability when hot team is disabled but can occurs even when
5656 * the hot team is enabled */
5657 __kmp_free_implicit_task(this_th);
5658 this_th->th.th_current_task = NULL;
5659
Jonathan Peyton30419822017-05-12 18:01:32 +00005660 // If the __kmp_thread_pool_insert_pt is already past the new insert
5661 // point, then we need to re-scan the entire list.
5662 gtid = this_th->th.th_info.ds.ds_gtid;
5663 if (__kmp_thread_pool_insert_pt != NULL) {
5664 KMP_DEBUG_ASSERT(__kmp_thread_pool != NULL);
5665 if (__kmp_thread_pool_insert_pt->th.th_info.ds.ds_gtid > gtid) {
5666 __kmp_thread_pool_insert_pt = NULL;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005667 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005668 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005669
Jonathan Peyton30419822017-05-12 18:01:32 +00005670 // Scan down the list to find the place to insert the thread.
5671 // scan is the address of a link in the list, possibly the address of
5672 // __kmp_thread_pool itself.
5673 //
5674 // In the absence of nested parallism, the for loop will have 0 iterations.
5675 if (__kmp_thread_pool_insert_pt != NULL) {
5676 scan = &(__kmp_thread_pool_insert_pt->th.th_next_pool);
5677 } else {
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005678 scan = CCAST(kmp_info_t **, &__kmp_thread_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00005679 }
5680 for (; (*scan != NULL) && ((*scan)->th.th_info.ds.ds_gtid < gtid);
5681 scan = &((*scan)->th.th_next_pool))
5682 ;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005683
Jonathan Peyton30419822017-05-12 18:01:32 +00005684 // Insert the new element on the list, and set __kmp_thread_pool_insert_pt
5685 // to its address.
5686 TCW_PTR(this_th->th.th_next_pool, *scan);
5687 __kmp_thread_pool_insert_pt = *scan = this_th;
5688 KMP_DEBUG_ASSERT((this_th->th.th_next_pool == NULL) ||
5689 (this_th->th.th_info.ds.ds_gtid <
5690 this_th->th.th_next_pool->th.th_info.ds.ds_gtid));
5691 TCW_4(this_th->th.th_in_pool, TRUE);
5692 __kmp_thread_pool_nth++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005693
Jonathan Peyton30419822017-05-12 18:01:32 +00005694 TCW_4(__kmp_nth, __kmp_nth - 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005695
5696#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00005697 /* Adjust blocktime back to user setting or default if necessary */
5698 /* Middle initialization might never have occurred */
5699 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
5700 KMP_DEBUG_ASSERT(__kmp_avail_proc > 0);
5701 if (__kmp_nth <= __kmp_avail_proc) {
5702 __kmp_zero_bt = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005703 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005704 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005705#endif /* KMP_ADJUST_BLOCKTIME */
5706
Jonathan Peyton30419822017-05-12 18:01:32 +00005707 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00005708}
5709
Jim Cownie5e8470a2013-09-27 10:38:44 +00005710/* ------------------------------------------------------------------------ */
5711
Jonathan Peyton30419822017-05-12 18:01:32 +00005712void *__kmp_launch_thread(kmp_info_t *this_thr) {
5713 int gtid = this_thr->th.th_info.ds.ds_gtid;
5714 /* void *stack_data;*/
5715 kmp_team_t *(*volatile pteam);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005716
Jonathan Peyton30419822017-05-12 18:01:32 +00005717 KMP_MB();
5718 KA_TRACE(10, ("__kmp_launch_thread: T#%d start\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005719
Jonathan Peyton30419822017-05-12 18:01:32 +00005720 if (__kmp_env_consistency_check) {
5721 this_thr->th.th_cons = __kmp_allocate_cons_stack(gtid); // ATT: Memory leak?
5722 }
5723
5724#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005725 ompt_data_t *thread_data;
5726 if (ompt_enabled.enabled) {
5727 thread_data = &(this_thr->th.ompt_thread_info.thread_data);
Jonathan Peyton3574f282018-10-04 14:57:04 +00005728 *thread_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00005729
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00005730 this_thr->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00005731 this_thr->th.ompt_thread_info.wait_id = 0;
Joachim Protze82e94a52017-11-01 10:08:30 +00005732 this_thr->th.ompt_thread_info.idle_frame = OMPT_GET_FRAME_ADDRESS(0);
5733 if (ompt_enabled.ompt_callback_thread_begin) {
5734 ompt_callbacks.ompt_callback(ompt_callback_thread_begin)(
5735 ompt_thread_worker, thread_data);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005736 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005737 }
5738#endif
5739
Joachim Protze82e94a52017-11-01 10:08:30 +00005740#if OMPT_SUPPORT
5741 if (ompt_enabled.enabled) {
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00005742 this_thr->th.ompt_thread_info.state = ompt_state_idle;
Joachim Protze82e94a52017-11-01 10:08:30 +00005743 }
5744#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005745 /* This is the place where threads wait for work */
5746 while (!TCR_4(__kmp_global.g.g_done)) {
5747 KMP_DEBUG_ASSERT(this_thr == __kmp_threads[gtid]);
5748 KMP_MB();
5749
5750 /* wait for work to do */
5751 KA_TRACE(20, ("__kmp_launch_thread: T#%d waiting for work\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005752
Jonathan Peyton30419822017-05-12 18:01:32 +00005753 /* No tid yet since not part of a team */
5754 __kmp_fork_barrier(gtid, KMP_GTID_DNE);
5755
5756#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005757 if (ompt_enabled.enabled) {
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00005758 this_thr->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00005759 }
5760#endif
5761
5762 pteam = (kmp_team_t * (*))(&this_thr->th.th_team);
5763
5764 /* have we been allocated? */
5765 if (TCR_SYNC_PTR(*pteam) && !TCR_4(__kmp_global.g.g_done)) {
Jonathan Peyton30419822017-05-12 18:01:32 +00005766 /* we were just woken up, so run our new task */
5767 if (TCR_SYNC_PTR((*pteam)->t.t_pkfn) != NULL) {
5768 int rc;
5769 KA_TRACE(20,
5770 ("__kmp_launch_thread: T#%d(%d:%d) invoke microtask = %p\n",
5771 gtid, (*pteam)->t.t_id, __kmp_tid_from_gtid(gtid),
5772 (*pteam)->t.t_pkfn));
5773
5774 updateHWFPControl(*pteam);
5775
5776#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005777 if (ompt_enabled.enabled) {
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00005778 this_thr->th.ompt_thread_info.state = ompt_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00005779 }
5780#endif
5781
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00005782 rc = (*pteam)->t.t_invoke(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00005783 KMP_ASSERT(rc);
5784
Jim Cownie5e8470a2013-09-27 10:38:44 +00005785 KMP_MB();
Jonathan Peyton30419822017-05-12 18:01:32 +00005786 KA_TRACE(20, ("__kmp_launch_thread: T#%d(%d:%d) done microtask = %p\n",
5787 gtid, (*pteam)->t.t_id, __kmp_tid_from_gtid(gtid),
5788 (*pteam)->t.t_pkfn));
5789 }
Joachim Protze82e94a52017-11-01 10:08:30 +00005790#if OMPT_SUPPORT
5791 if (ompt_enabled.enabled) {
5792 /* no frame set while outside task */
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00005793 __ompt_get_task_info_object(0)->frame.exit_frame = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00005794
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00005795 this_thr->th.ompt_thread_info.state = ompt_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00005796 }
5797#endif
Joachim Protze82e94a52017-11-01 10:08:30 +00005798 /* join barrier after parallel region */
5799 __kmp_join_barrier(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005800 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005801 }
5802 TCR_SYNC_PTR((intptr_t)__kmp_global.g.g_done);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005803
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005804#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005805 if (ompt_enabled.ompt_callback_thread_end) {
5806 ompt_callbacks.ompt_callback(ompt_callback_thread_end)(thread_data);
Jonathan Peyton30419822017-05-12 18:01:32 +00005807 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005808#endif
5809
Jonathan Peyton30419822017-05-12 18:01:32 +00005810 this_thr->th.th_task_team = NULL;
5811 /* run the destructors for the threadprivate data for this thread */
5812 __kmp_common_destroy_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005813
Jonathan Peyton30419822017-05-12 18:01:32 +00005814 KA_TRACE(10, ("__kmp_launch_thread: T#%d done\n", gtid));
5815 KMP_MB();
5816 return this_thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005817}
5818
5819/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00005820
Jonathan Peyton30419822017-05-12 18:01:32 +00005821void __kmp_internal_end_dest(void *specific_gtid) {
5822#if KMP_COMPILER_ICC
5823#pragma warning(push)
5824#pragma warning(disable : 810) // conversion from "void *" to "int" may lose
5825// significant bits
5826#endif
5827 // Make sure no significant bits are lost
5828 int gtid = (kmp_intptr_t)specific_gtid - 1;
5829#if KMP_COMPILER_ICC
5830#pragma warning(pop)
5831#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005832
Jonathan Peyton30419822017-05-12 18:01:32 +00005833 KA_TRACE(30, ("__kmp_internal_end_dest: T#%d\n", gtid));
5834 /* NOTE: the gtid is stored as gitd+1 in the thread-local-storage
5835 * this is because 0 is reserved for the nothing-stored case */
Jim Cownie5e8470a2013-09-27 10:38:44 +00005836
Jonathan Peyton30419822017-05-12 18:01:32 +00005837 /* josh: One reason for setting the gtid specific data even when it is being
5838 destroyed by pthread is to allow gtid lookup through thread specific data
5839 (__kmp_gtid_get_specific). Some of the code, especially stat code,
5840 that gets executed in the call to __kmp_internal_end_thread, actually
5841 gets the gtid through the thread specific data. Setting it here seems
5842 rather inelegant and perhaps wrong, but allows __kmp_internal_end_thread
5843 to run smoothly.
5844 todo: get rid of this after we remove the dependence on
5845 __kmp_gtid_get_specific */
5846 if (gtid >= 0 && KMP_UBER_GTID(gtid))
5847 __kmp_gtid_set_specific(gtid);
5848#ifdef KMP_TDATA_GTID
5849 __kmp_gtid = gtid;
5850#endif
5851 __kmp_internal_end_thread(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005852}
5853
Jonathan Peyton99016992015-05-26 17:32:53 +00005854#if KMP_OS_UNIX && KMP_DYNAMIC_LIB
Jim Cownie5e8470a2013-09-27 10:38:44 +00005855
Jonathan Peyton30419822017-05-12 18:01:32 +00005856// 2009-09-08 (lev): It looks the destructor does not work. In simple test cases
5857// destructors work perfectly, but in real libomp.so I have no evidence it is
5858// ever called. However, -fini linker option in makefile.mk works fine.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005859
Jonathan Peyton30419822017-05-12 18:01:32 +00005860__attribute__((destructor)) void __kmp_internal_end_dtor(void) {
5861 __kmp_internal_end_atexit();
Jim Cownie5e8470a2013-09-27 10:38:44 +00005862}
5863
Jonathan Peyton30419822017-05-12 18:01:32 +00005864void __kmp_internal_end_fini(void) { __kmp_internal_end_atexit(); }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005865
5866#endif
5867
Jonathan Peyton30419822017-05-12 18:01:32 +00005868/* [Windows] josh: when the atexit handler is called, there may still be more
5869 than one thread alive */
5870void __kmp_internal_end_atexit(void) {
5871 KA_TRACE(30, ("__kmp_internal_end_atexit\n"));
5872 /* [Windows]
5873 josh: ideally, we want to completely shutdown the library in this atexit
5874 handler, but stat code that depends on thread specific data for gtid fails
5875 because that data becomes unavailable at some point during the shutdown, so
5876 we call __kmp_internal_end_thread instead. We should eventually remove the
5877 dependency on __kmp_get_specific_gtid in the stat code and use
5878 __kmp_internal_end_library to cleanly shutdown the library.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005879
Jonathan Peyton30419822017-05-12 18:01:32 +00005880 // TODO: Can some of this comment about GVS be removed?
5881 I suspect that the offending stat code is executed when the calling thread
5882 tries to clean up a dead root thread's data structures, resulting in GVS
5883 code trying to close the GVS structures for that thread, but since the stat
5884 code uses __kmp_get_specific_gtid to get the gtid with the assumption that
5885 the calling thread is cleaning up itself instead of another thread, it get
5886 confused. This happens because allowing a thread to unregister and cleanup
5887 another thread is a recent modification for addressing an issue.
5888 Based on the current design (20050722), a thread may end up
5889 trying to unregister another thread only if thread death does not trigger
5890 the calling of __kmp_internal_end_thread. For Linux* OS, there is the
5891 thread specific data destructor function to detect thread death. For
5892 Windows dynamic, there is DllMain(THREAD_DETACH). For Windows static, there
5893 is nothing. Thus, the workaround is applicable only for Windows static
5894 stat library. */
5895 __kmp_internal_end_library(-1);
5896#if KMP_OS_WINDOWS
5897 __kmp_close_console();
5898#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005899}
5900
Jonathan Peyton30419822017-05-12 18:01:32 +00005901static void __kmp_reap_thread(kmp_info_t *thread, int is_root) {
5902 // It is assumed __kmp_forkjoin_lock is acquired.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005903
Jonathan Peyton30419822017-05-12 18:01:32 +00005904 int gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005905
Jonathan Peyton30419822017-05-12 18:01:32 +00005906 KMP_DEBUG_ASSERT(thread != NULL);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005907
Jonathan Peyton30419822017-05-12 18:01:32 +00005908 gtid = thread->th.th_info.ds.ds_gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005909
Jonathan Peyton30419822017-05-12 18:01:32 +00005910 if (!is_root) {
Jonathan Peyton30419822017-05-12 18:01:32 +00005911 if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
5912 /* Assume the threads are at the fork barrier here */
5913 KA_TRACE(
5914 20, ("__kmp_reap_thread: releasing T#%d from fork barrier for reap\n",
5915 gtid));
5916 /* Need release fence here to prevent seg faults for tree forkjoin barrier
5917 * (GEH) */
5918 ANNOTATE_HAPPENS_BEFORE(thread);
5919 kmp_flag_64 flag(&thread->th.th_bar[bs_forkjoin_barrier].bb.b_go, thread);
5920 __kmp_release_64(&flag);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005921 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005922
Jonathan Peyton30419822017-05-12 18:01:32 +00005923 // Terminate OS thread.
5924 __kmp_reap_worker(thread);
Jonathan Peyton7ca7ef02016-11-21 16:18:57 +00005925
Jonathan Peyton30419822017-05-12 18:01:32 +00005926 // The thread was killed asynchronously. If it was actively
5927 // spinning in the thread pool, decrement the global count.
5928 //
5929 // There is a small timing hole here - if the worker thread was just waking
5930 // up after sleeping in the pool, had reset it's th_active_in_pool flag but
5931 // not decremented the global counter __kmp_thread_pool_active_nth yet, then
5932 // the global counter might not get updated.
5933 //
5934 // Currently, this can only happen as the library is unloaded,
5935 // so there are no harmful side effects.
5936 if (thread->th.th_active_in_pool) {
5937 thread->th.th_active_in_pool = FALSE;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00005938 KMP_ATOMIC_DEC(&__kmp_thread_pool_active_nth);
5939 KMP_DEBUG_ASSERT(__kmp_thread_pool_active_nth >= 0);
Jonathan Peyton30419822017-05-12 18:01:32 +00005940 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005941
Jonathan Peyton30419822017-05-12 18:01:32 +00005942 // Decrement # of [worker] threads in the pool.
5943 KMP_DEBUG_ASSERT(__kmp_thread_pool_nth > 0);
5944 --__kmp_thread_pool_nth;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005945 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005946
Jonathan Peyton30419822017-05-12 18:01:32 +00005947 __kmp_free_implicit_task(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005948
Jonathan Peyton30419822017-05-12 18:01:32 +00005949// Free the fast memory for tasking
5950#if USE_FAST_MEMORY
5951 __kmp_free_fast_memory(thread);
5952#endif /* USE_FAST_MEMORY */
5953
5954 __kmp_suspend_uninitialize_thread(thread);
5955
5956 KMP_DEBUG_ASSERT(__kmp_threads[gtid] == thread);
5957 TCW_SYNC_PTR(__kmp_threads[gtid], NULL);
5958
5959 --__kmp_all_nth;
5960// __kmp_nth was decremented when thread is added to the pool.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005961
5962#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00005963 /* Adjust blocktime back to user setting or default if necessary */
5964 /* Middle initialization might never have occurred */
5965 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
5966 KMP_DEBUG_ASSERT(__kmp_avail_proc > 0);
5967 if (__kmp_nth <= __kmp_avail_proc) {
5968 __kmp_zero_bt = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005969 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005970 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005971#endif /* KMP_ADJUST_BLOCKTIME */
5972
Jonathan Peyton30419822017-05-12 18:01:32 +00005973 /* free the memory being used */
5974 if (__kmp_env_consistency_check) {
5975 if (thread->th.th_cons) {
5976 __kmp_free_cons_stack(thread->th.th_cons);
5977 thread->th.th_cons = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005978 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005979 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005980
Jonathan Peyton30419822017-05-12 18:01:32 +00005981 if (thread->th.th_pri_common != NULL) {
5982 __kmp_free(thread->th.th_pri_common);
5983 thread->th.th_pri_common = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005984 }
Andrey Churbanov6d224db2015-02-10 18:37:43 +00005985
Jonathan Peyton30419822017-05-12 18:01:32 +00005986 if (thread->th.th_task_state_memo_stack != NULL) {
5987 __kmp_free(thread->th.th_task_state_memo_stack);
5988 thread->th.th_task_state_memo_stack = NULL;
5989 }
5990
5991#if KMP_USE_BGET
5992 if (thread->th.th_local.bget_data != NULL) {
5993 __kmp_finalize_bget(thread);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005994 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005995#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005996
Alp Toker98758b02014-03-02 04:12:06 +00005997#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00005998 if (thread->th.th_affin_mask != NULL) {
5999 KMP_CPU_FREE(thread->th.th_affin_mask);
6000 thread->th.th_affin_mask = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006001 }
Alp Toker98758b02014-03-02 04:12:06 +00006002#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006003
Jonathan Peytonf6399362018-07-09 17:51:13 +00006004#if KMP_USE_HIER_SCHED
6005 if (thread->th.th_hier_bar_data != NULL) {
6006 __kmp_free(thread->th.th_hier_bar_data);
6007 thread->th.th_hier_bar_data = NULL;
6008 }
6009#endif
6010
Jonathan Peyton30419822017-05-12 18:01:32 +00006011 __kmp_reap_team(thread->th.th_serial_team);
6012 thread->th.th_serial_team = NULL;
6013 __kmp_free(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006014
Jonathan Peyton30419822017-05-12 18:01:32 +00006015 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006016
6017} // __kmp_reap_thread
6018
Jonathan Peyton30419822017-05-12 18:01:32 +00006019static void __kmp_internal_end(void) {
6020 int i;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006021
Jonathan Peyton30419822017-05-12 18:01:32 +00006022 /* First, unregister the library */
6023 __kmp_unregister_library();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006024
Jonathan Peyton30419822017-05-12 18:01:32 +00006025#if KMP_OS_WINDOWS
6026 /* In Win static library, we can't tell when a root actually dies, so we
6027 reclaim the data structures for any root threads that have died but not
6028 unregistered themselves, in order to shut down cleanly.
6029 In Win dynamic library we also can't tell when a thread dies. */
6030 __kmp_reclaim_dead_roots(); // AC: moved here to always clean resources of
6031// dead roots
Jonathan Peytonb66d1aa2016-09-27 17:11:17 +00006032#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006033
Jonathan Peyton30419822017-05-12 18:01:32 +00006034 for (i = 0; i < __kmp_threads_capacity; i++)
6035 if (__kmp_root[i])
6036 if (__kmp_root[i]->r.r_active)
6037 break;
6038 KMP_MB(); /* Flush all pending memory write invalidates. */
6039 TCW_SYNC_4(__kmp_global.g.g_done, TRUE);
6040
6041 if (i < __kmp_threads_capacity) {
6042#if KMP_USE_MONITOR
6043 // 2009-09-08 (lev): Other alive roots found. Why do we kill the monitor??
6044 KMP_MB(); /* Flush all pending memory write invalidates. */
6045
Jonathan Peyton94a114f2017-10-20 19:30:57 +00006046 // Need to check that monitor was initialized before reaping it. If we are
6047 // called form __kmp_atfork_child (which sets __kmp_init_parallel = 0), then
6048 // __kmp_monitor will appear to contain valid data, but it is only valid in
6049 // the parent process, not the child.
Jonathan Peyton30419822017-05-12 18:01:32 +00006050 // New behavior (201008): instead of keying off of the flag
6051 // __kmp_init_parallel, the monitor thread creation is keyed off
6052 // of the new flag __kmp_init_monitor.
6053 __kmp_acquire_bootstrap_lock(&__kmp_monitor_lock);
6054 if (TCR_4(__kmp_init_monitor)) {
6055 __kmp_reap_monitor(&__kmp_monitor);
6056 TCW_4(__kmp_init_monitor, 0);
6057 }
6058 __kmp_release_bootstrap_lock(&__kmp_monitor_lock);
6059 KA_TRACE(10, ("__kmp_internal_end: monitor reaped\n"));
6060#endif // KMP_USE_MONITOR
6061 } else {
6062/* TODO move this to cleanup code */
6063#ifdef KMP_DEBUG
6064 /* make sure that everything has properly ended */
6065 for (i = 0; i < __kmp_threads_capacity; i++) {
6066 if (__kmp_root[i]) {
6067 // KMP_ASSERT( ! KMP_UBER_GTID( i ) ); // AC:
6068 // there can be uber threads alive here
6069 KMP_ASSERT(!__kmp_root[i]->r.r_active); // TODO: can they be active?
6070 }
6071 }
6072#endif
6073
6074 KMP_MB();
6075
6076 // Reap the worker threads.
6077 // This is valid for now, but be careful if threads are reaped sooner.
6078 while (__kmp_thread_pool != NULL) { // Loop thru all the thread in the pool.
6079 // Get the next thread from the pool.
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00006080 kmp_info_t *thread = CCAST(kmp_info_t *, __kmp_thread_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00006081 __kmp_thread_pool = thread->th.th_next_pool;
6082 // Reap it.
6083 KMP_DEBUG_ASSERT(thread->th.th_reap_state == KMP_SAFE_TO_REAP);
6084 thread->th.th_next_pool = NULL;
6085 thread->th.th_in_pool = FALSE;
6086 __kmp_reap_thread(thread, 0);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006087 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006088 __kmp_thread_pool_insert_pt = NULL;
6089
6090 // Reap teams.
6091 while (__kmp_team_pool != NULL) { // Loop thru all the teams in the pool.
6092 // Get the next team from the pool.
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00006093 kmp_team_t *team = CCAST(kmp_team_t *, __kmp_team_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00006094 __kmp_team_pool = team->t.t_next_pool;
6095 // Reap it.
6096 team->t.t_next_pool = NULL;
6097 __kmp_reap_team(team);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006098 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006099
6100 __kmp_reap_task_teams();
6101
Jonathan Peytona764af62018-07-19 19:17:00 +00006102#if KMP_OS_UNIX
6103 // Threads that are not reaped should not access any resources since they
6104 // are going to be deallocated soon, so the shutdown sequence should wait
6105 // until all threads either exit the final spin-waiting loop or begin
6106 // sleeping after the given blocktime.
6107 for (i = 0; i < __kmp_threads_capacity; i++) {
6108 kmp_info_t *thr = __kmp_threads[i];
6109 while (thr && KMP_ATOMIC_LD_ACQ(&thr->th.th_blocking))
6110 KMP_CPU_PAUSE();
6111 }
6112#endif
6113
Jonathan Peyton30419822017-05-12 18:01:32 +00006114 for (i = 0; i < __kmp_threads_capacity; ++i) {
6115 // TBD: Add some checking...
6116 // Something like KMP_DEBUG_ASSERT( __kmp_thread[ i ] == NULL );
6117 }
6118
6119 /* Make sure all threadprivate destructors get run by joining with all
6120 worker threads before resetting this flag */
6121 TCW_SYNC_4(__kmp_init_common, FALSE);
6122
6123 KA_TRACE(10, ("__kmp_internal_end: all workers reaped\n"));
6124 KMP_MB();
6125
6126#if KMP_USE_MONITOR
6127 // See note above: One of the possible fixes for CQ138434 / CQ140126
6128 //
6129 // FIXME: push both code fragments down and CSE them?
6130 // push them into __kmp_cleanup() ?
6131 __kmp_acquire_bootstrap_lock(&__kmp_monitor_lock);
6132 if (TCR_4(__kmp_init_monitor)) {
6133 __kmp_reap_monitor(&__kmp_monitor);
6134 TCW_4(__kmp_init_monitor, 0);
6135 }
6136 __kmp_release_bootstrap_lock(&__kmp_monitor_lock);
6137 KA_TRACE(10, ("__kmp_internal_end: monitor reaped\n"));
6138#endif
6139 } /* else !__kmp_global.t_active */
6140 TCW_4(__kmp_init_gtid, FALSE);
6141 KMP_MB(); /* Flush all pending memory write invalidates. */
6142
6143 __kmp_cleanup();
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006144#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006145 ompt_fini();
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006146#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006147}
6148
Jonathan Peyton30419822017-05-12 18:01:32 +00006149void __kmp_internal_end_library(int gtid_req) {
6150 /* if we have already cleaned up, don't try again, it wouldn't be pretty */
6151 /* this shouldn't be a race condition because __kmp_internal_end() is the
6152 only place to clear __kmp_serial_init */
6153 /* we'll check this later too, after we get the lock */
6154 // 2009-09-06: We do not set g_abort without setting g_done. This check looks
6155 // redundaant, because the next check will work in any case.
6156 if (__kmp_global.g.g_abort) {
6157 KA_TRACE(11, ("__kmp_internal_end_library: abort, exiting\n"));
6158 /* TODO abort? */
6159 return;
6160 }
6161 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6162 KA_TRACE(10, ("__kmp_internal_end_library: already finished\n"));
6163 return;
6164 }
6165
6166 KMP_MB(); /* Flush all pending memory write invalidates. */
6167
6168 /* find out who we are and what we should do */
6169 {
6170 int gtid = (gtid_req >= 0) ? gtid_req : __kmp_gtid_get_specific();
6171 KA_TRACE(
6172 10, ("__kmp_internal_end_library: enter T#%d (%d)\n", gtid, gtid_req));
6173 if (gtid == KMP_GTID_SHUTDOWN) {
6174 KA_TRACE(10, ("__kmp_internal_end_library: !__kmp_init_runtime, system "
6175 "already shutdown\n"));
6176 return;
6177 } else if (gtid == KMP_GTID_MONITOR) {
6178 KA_TRACE(10, ("__kmp_internal_end_library: monitor thread, gtid not "
6179 "registered, or system shutdown\n"));
6180 return;
6181 } else if (gtid == KMP_GTID_DNE) {
6182 KA_TRACE(10, ("__kmp_internal_end_library: gtid not registered or system "
6183 "shutdown\n"));
6184 /* we don't know who we are, but we may still shutdown the library */
6185 } else if (KMP_UBER_GTID(gtid)) {
6186 /* unregister ourselves as an uber thread. gtid is no longer valid */
6187 if (__kmp_root[gtid]->r.r_active) {
6188 __kmp_global.g.g_abort = -1;
6189 TCW_SYNC_4(__kmp_global.g.g_done, TRUE);
6190 KA_TRACE(10,
6191 ("__kmp_internal_end_library: root still active, abort T#%d\n",
6192 gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006193 return;
Jonathan Peyton30419822017-05-12 18:01:32 +00006194 } else {
6195 KA_TRACE(
6196 10,
6197 ("__kmp_internal_end_library: unregistering sibling T#%d\n", gtid));
6198 __kmp_unregister_root_current_thread(gtid);
6199 }
6200 } else {
6201/* worker threads may call this function through the atexit handler, if they
6202 * call exit() */
6203/* For now, skip the usual subsequent processing and just dump the debug buffer.
6204 TODO: do a thorough shutdown instead */
6205#ifdef DUMP_DEBUG_ON_EXIT
6206 if (__kmp_debug_buf)
6207 __kmp_dump_debug_buffer();
6208#endif
6209 return;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006210 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006211 }
6212 /* synchronize the termination process */
6213 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006214
Jonathan Peyton30419822017-05-12 18:01:32 +00006215 /* have we already finished */
6216 if (__kmp_global.g.g_abort) {
6217 KA_TRACE(10, ("__kmp_internal_end_library: abort, exiting\n"));
6218 /* TODO abort? */
6219 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6220 return;
6221 }
6222 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6223 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6224 return;
6225 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006226
Jonathan Peyton30419822017-05-12 18:01:32 +00006227 /* We need this lock to enforce mutex between this reading of
6228 __kmp_threads_capacity and the writing by __kmp_register_root.
6229 Alternatively, we can use a counter of roots that is atomically updated by
6230 __kmp_get_global_thread_id_reg, __kmp_do_serial_initialize and
6231 __kmp_internal_end_*. */
6232 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006233
Jonathan Peyton30419822017-05-12 18:01:32 +00006234 /* now we can safely conduct the actual termination */
6235 __kmp_internal_end();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006236
Jonathan Peyton30419822017-05-12 18:01:32 +00006237 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
6238 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006239
Jonathan Peyton30419822017-05-12 18:01:32 +00006240 KA_TRACE(10, ("__kmp_internal_end_library: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006241
Jonathan Peyton30419822017-05-12 18:01:32 +00006242#ifdef DUMP_DEBUG_ON_EXIT
6243 if (__kmp_debug_buf)
6244 __kmp_dump_debug_buffer();
6245#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006246
Jonathan Peyton30419822017-05-12 18:01:32 +00006247#if KMP_OS_WINDOWS
6248 __kmp_close_console();
6249#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006250
Jonathan Peyton30419822017-05-12 18:01:32 +00006251 __kmp_fini_allocator();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006252
6253} // __kmp_internal_end_library
6254
Jonathan Peyton30419822017-05-12 18:01:32 +00006255void __kmp_internal_end_thread(int gtid_req) {
6256 int i;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006257
Jonathan Peyton30419822017-05-12 18:01:32 +00006258 /* if we have already cleaned up, don't try again, it wouldn't be pretty */
6259 /* this shouldn't be a race condition because __kmp_internal_end() is the
6260 * only place to clear __kmp_serial_init */
6261 /* we'll check this later too, after we get the lock */
6262 // 2009-09-06: We do not set g_abort without setting g_done. This check looks
6263 // redundant, because the next check will work in any case.
6264 if (__kmp_global.g.g_abort) {
6265 KA_TRACE(11, ("__kmp_internal_end_thread: abort, exiting\n"));
6266 /* TODO abort? */
6267 return;
6268 }
6269 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6270 KA_TRACE(10, ("__kmp_internal_end_thread: already finished\n"));
6271 return;
6272 }
6273
6274 KMP_MB(); /* Flush all pending memory write invalidates. */
6275
6276 /* find out who we are and what we should do */
6277 {
6278 int gtid = (gtid_req >= 0) ? gtid_req : __kmp_gtid_get_specific();
6279 KA_TRACE(10,
6280 ("__kmp_internal_end_thread: enter T#%d (%d)\n", gtid, gtid_req));
6281 if (gtid == KMP_GTID_SHUTDOWN) {
6282 KA_TRACE(10, ("__kmp_internal_end_thread: !__kmp_init_runtime, system "
6283 "already shutdown\n"));
6284 return;
6285 } else if (gtid == KMP_GTID_MONITOR) {
6286 KA_TRACE(10, ("__kmp_internal_end_thread: monitor thread, gtid not "
6287 "registered, or system shutdown\n"));
6288 return;
6289 } else if (gtid == KMP_GTID_DNE) {
6290 KA_TRACE(10, ("__kmp_internal_end_thread: gtid not registered or system "
6291 "shutdown\n"));
6292 return;
6293 /* we don't know who we are */
6294 } else if (KMP_UBER_GTID(gtid)) {
6295 /* unregister ourselves as an uber thread. gtid is no longer valid */
6296 if (__kmp_root[gtid]->r.r_active) {
6297 __kmp_global.g.g_abort = -1;
6298 TCW_SYNC_4(__kmp_global.g.g_done, TRUE);
6299 KA_TRACE(10,
6300 ("__kmp_internal_end_thread: root still active, abort T#%d\n",
6301 gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006302 return;
Jonathan Peyton30419822017-05-12 18:01:32 +00006303 } else {
6304 KA_TRACE(10, ("__kmp_internal_end_thread: unregistering sibling T#%d\n",
6305 gtid));
6306 __kmp_unregister_root_current_thread(gtid);
6307 }
6308 } else {
6309 /* just a worker thread, let's leave */
6310 KA_TRACE(10, ("__kmp_internal_end_thread: worker thread T#%d\n", gtid));
6311
6312 if (gtid >= 0) {
6313 __kmp_threads[gtid]->th.th_task_team = NULL;
6314 }
6315
6316 KA_TRACE(10,
6317 ("__kmp_internal_end_thread: worker thread done, exiting T#%d\n",
6318 gtid));
6319 return;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006320 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006321 }
Jonathan Peyton8b3842f2018-10-05 17:59:39 +00006322#if KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +00006323 // AC: lets not shutdown the Linux* OS dynamic library at the exit of uber
6324 // thread, because we will better shutdown later in the library destructor.
6325 // The reason of this change is performance problem when non-openmp thread in
6326 // a loop forks and joins many openmp threads. We can save a lot of time
6327 // keeping worker threads alive until the program shutdown.
6328 // OM: Removed Linux* OS restriction to fix the crash on OS X* (DPD200239966)
6329 // and Windows(DPD200287443) that occurs when using critical sections from
6330 // foreign threads.
Jonathan Peyton9b8bb322019-01-16 20:07:39 +00006331 if (__kmp_pause_status != kmp_hard_paused) {
6332 KA_TRACE(10, ("__kmp_internal_end_thread: exiting T#%d\n", gtid_req));
6333 return;
6334 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006335#endif
6336 /* synchronize the termination process */
6337 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006338
Jonathan Peyton30419822017-05-12 18:01:32 +00006339 /* have we already finished */
6340 if (__kmp_global.g.g_abort) {
6341 KA_TRACE(10, ("__kmp_internal_end_thread: abort, exiting\n"));
6342 /* TODO abort? */
6343 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6344 return;
6345 }
6346 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6347 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6348 return;
6349 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006350
Jonathan Peyton30419822017-05-12 18:01:32 +00006351 /* We need this lock to enforce mutex between this reading of
6352 __kmp_threads_capacity and the writing by __kmp_register_root.
6353 Alternatively, we can use a counter of roots that is atomically updated by
6354 __kmp_get_global_thread_id_reg, __kmp_do_serial_initialize and
6355 __kmp_internal_end_*. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006356
Jonathan Peyton30419822017-05-12 18:01:32 +00006357 /* should we finish the run-time? are all siblings done? */
6358 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006359
Jonathan Peyton30419822017-05-12 18:01:32 +00006360 for (i = 0; i < __kmp_threads_capacity; ++i) {
6361 if (KMP_UBER_GTID(i)) {
6362 KA_TRACE(
6363 10,
6364 ("__kmp_internal_end_thread: remaining sibling task: gtid==%d\n", i));
6365 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
6366 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6367 return;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006368 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006369 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006370
Jonathan Peyton30419822017-05-12 18:01:32 +00006371 /* now we can safely conduct the actual termination */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006372
Jonathan Peyton30419822017-05-12 18:01:32 +00006373 __kmp_internal_end();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006374
Jonathan Peyton30419822017-05-12 18:01:32 +00006375 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
6376 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006377
Jonathan Peyton30419822017-05-12 18:01:32 +00006378 KA_TRACE(10, ("__kmp_internal_end_thread: exit T#%d\n", gtid_req));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006379
Jonathan Peyton30419822017-05-12 18:01:32 +00006380#ifdef DUMP_DEBUG_ON_EXIT
6381 if (__kmp_debug_buf)
6382 __kmp_dump_debug_buffer();
6383#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006384} // __kmp_internal_end_thread
6385
Jonathan Peyton30419822017-05-12 18:01:32 +00006386// -----------------------------------------------------------------------------
Jim Cownie5e8470a2013-09-27 10:38:44 +00006387// Library registration stuff.
6388
Jonathan Peyton30419822017-05-12 18:01:32 +00006389static long __kmp_registration_flag = 0;
6390// Random value used to indicate library initialization.
6391static char *__kmp_registration_str = NULL;
6392// Value to be saved in env var __KMP_REGISTERED_LIB_<pid>.
Jim Cownie5e8470a2013-09-27 10:38:44 +00006393
Jonathan Peyton30419822017-05-12 18:01:32 +00006394static inline char *__kmp_reg_status_name() {
6395 /* On RHEL 3u5 if linked statically, getpid() returns different values in
6396 each thread. If registration and unregistration go in different threads
6397 (omp_misc_other_root_exit.cpp test case), the name of registered_lib_env
6398 env var can not be found, because the name will contain different pid. */
6399 return __kmp_str_format("__KMP_REGISTERED_LIB_%d", (int)getpid());
Jim Cownie5e8470a2013-09-27 10:38:44 +00006400} // __kmp_reg_status_get
6401
Jonathan Peyton30419822017-05-12 18:01:32 +00006402void __kmp_register_library_startup(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006403
Jonathan Peyton30419822017-05-12 18:01:32 +00006404 char *name = __kmp_reg_status_name(); // Name of the environment variable.
6405 int done = 0;
6406 union {
6407 double dtime;
6408 long ltime;
6409 } time;
6410#if KMP_ARCH_X86 || KMP_ARCH_X86_64
6411 __kmp_initialize_system_tick();
6412#endif
6413 __kmp_read_system_time(&time.dtime);
6414 __kmp_registration_flag = 0xCAFE0000L | (time.ltime & 0x0000FFFFL);
6415 __kmp_registration_str =
6416 __kmp_str_format("%p-%lx-%s", &__kmp_registration_flag,
6417 __kmp_registration_flag, KMP_LIBRARY_FILE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006418
Jonathan Peyton30419822017-05-12 18:01:32 +00006419 KA_TRACE(50, ("__kmp_register_library_startup: %s=\"%s\"\n", name,
6420 __kmp_registration_str));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006421
Jonathan Peyton30419822017-05-12 18:01:32 +00006422 while (!done) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006423
Jonathan Peyton30419822017-05-12 18:01:32 +00006424 char *value = NULL; // Actual value of the environment variable.
Jim Cownie5e8470a2013-09-27 10:38:44 +00006425
Jonathan Peyton30419822017-05-12 18:01:32 +00006426 // Set environment variable, but do not overwrite if it is exist.
6427 __kmp_env_set(name, __kmp_registration_str, 0);
6428 // Check the variable is written.
6429 value = __kmp_env_get(name);
6430 if (value != NULL && strcmp(value, __kmp_registration_str) == 0) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006431
Jonathan Peyton30419822017-05-12 18:01:32 +00006432 done = 1; // Ok, environment variable set successfully, exit the loop.
Jim Cownie5e8470a2013-09-27 10:38:44 +00006433
Jonathan Peyton30419822017-05-12 18:01:32 +00006434 } else {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006435
Jonathan Peyton30419822017-05-12 18:01:32 +00006436 // Oops. Write failed. Another copy of OpenMP RTL is in memory.
6437 // Check whether it alive or dead.
6438 int neighbor = 0; // 0 -- unknown status, 1 -- alive, 2 -- dead.
6439 char *tail = value;
6440 char *flag_addr_str = NULL;
6441 char *flag_val_str = NULL;
6442 char const *file_name = NULL;
6443 __kmp_str_split(tail, '-', &flag_addr_str, &tail);
6444 __kmp_str_split(tail, '-', &flag_val_str, &tail);
6445 file_name = tail;
6446 if (tail != NULL) {
6447 long *flag_addr = 0;
6448 long flag_val = 0;
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00006449 KMP_SSCANF(flag_addr_str, "%p", RCAST(void**, &flag_addr));
Jonathan Peyton30419822017-05-12 18:01:32 +00006450 KMP_SSCANF(flag_val_str, "%lx", &flag_val);
6451 if (flag_addr != 0 && flag_val != 0 && strcmp(file_name, "") != 0) {
6452 // First, check whether environment-encoded address is mapped into
6453 // addr space.
6454 // If so, dereference it to see if it still has the right value.
6455 if (__kmp_is_address_mapped(flag_addr) && *flag_addr == flag_val) {
6456 neighbor = 1;
6457 } else {
6458 // If not, then we know the other copy of the library is no longer
6459 // running.
6460 neighbor = 2;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006461 }
6462 }
6463 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006464 switch (neighbor) {
6465 case 0: // Cannot parse environment variable -- neighbor status unknown.
6466 // Assume it is the incompatible format of future version of the
6467 // library. Assume the other library is alive.
6468 // WARN( ... ); // TODO: Issue a warning.
6469 file_name = "unknown library";
Joachim Protze0c599c32019-02-04 15:59:42 +00006470 KMP_FALLTHROUGH();
Jonathan Peyton30419822017-05-12 18:01:32 +00006471 // Attention! Falling to the next case. That's intentional.
6472 case 1: { // Neighbor is alive.
6473 // Check it is allowed.
6474 char *duplicate_ok = __kmp_env_get("KMP_DUPLICATE_LIB_OK");
6475 if (!__kmp_str_match_true(duplicate_ok)) {
6476 // That's not allowed. Issue fatal error.
Jonathan Peyton6a393f72017-09-05 15:43:58 +00006477 __kmp_fatal(KMP_MSG(DuplicateLibrary, KMP_LIBRARY_FILE, file_name),
6478 KMP_HNT(DuplicateLibrary), __kmp_msg_null);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006479 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006480 KMP_INTERNAL_FREE(duplicate_ok);
6481 __kmp_duplicate_library_ok = 1;
6482 done = 1; // Exit the loop.
6483 } break;
6484 case 2: { // Neighbor is dead.
6485 // Clear the variable and try to register library again.
6486 __kmp_env_unset(name);
6487 } break;
6488 default: { KMP_DEBUG_ASSERT(0); } break;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006489 }
6490 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006491 KMP_INTERNAL_FREE((void *)value);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006492 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006493 KMP_INTERNAL_FREE((void *)name);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006494
6495} // func __kmp_register_library_startup
6496
Jonathan Peyton30419822017-05-12 18:01:32 +00006497void __kmp_unregister_library(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006498
Jonathan Peyton30419822017-05-12 18:01:32 +00006499 char *name = __kmp_reg_status_name();
6500 char *value = __kmp_env_get(name);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006501
Jonathan Peyton30419822017-05-12 18:01:32 +00006502 KMP_DEBUG_ASSERT(__kmp_registration_flag != 0);
6503 KMP_DEBUG_ASSERT(__kmp_registration_str != NULL);
6504 if (value != NULL && strcmp(value, __kmp_registration_str) == 0) {
6505 // Ok, this is our variable. Delete it.
6506 __kmp_env_unset(name);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006507 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006508
Jonathan Peyton30419822017-05-12 18:01:32 +00006509 KMP_INTERNAL_FREE(__kmp_registration_str);
6510 KMP_INTERNAL_FREE(value);
6511 KMP_INTERNAL_FREE(name);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006512
Jonathan Peyton30419822017-05-12 18:01:32 +00006513 __kmp_registration_flag = 0;
6514 __kmp_registration_str = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006515
6516} // __kmp_unregister_library
6517
Jim Cownie5e8470a2013-09-27 10:38:44 +00006518// End of Library registration stuff.
Jonathan Peyton30419822017-05-12 18:01:32 +00006519// -----------------------------------------------------------------------------
Jim Cownie5e8470a2013-09-27 10:38:44 +00006520
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006521#if KMP_MIC_SUPPORTED
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006522
Jonathan Peyton30419822017-05-12 18:01:32 +00006523static void __kmp_check_mic_type() {
6524 kmp_cpuid_t cpuid_state = {0};
6525 kmp_cpuid_t *cs_p = &cpuid_state;
6526 __kmp_x86_cpuid(1, 0, cs_p);
6527 // We don't support mic1 at the moment
6528 if ((cs_p->eax & 0xff0) == 0xB10) {
6529 __kmp_mic_type = mic2;
6530 } else if ((cs_p->eax & 0xf0ff0) == 0x50670) {
6531 __kmp_mic_type = mic3;
6532 } else {
6533 __kmp_mic_type = non_mic;
6534 }
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006535}
6536
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006537#endif /* KMP_MIC_SUPPORTED */
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006538
Jonathan Peyton30419822017-05-12 18:01:32 +00006539static void __kmp_do_serial_initialize(void) {
6540 int i, gtid;
6541 int size;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006542
Jonathan Peyton30419822017-05-12 18:01:32 +00006543 KA_TRACE(10, ("__kmp_do_serial_initialize: enter\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006544
Jonathan Peyton30419822017-05-12 18:01:32 +00006545 KMP_DEBUG_ASSERT(sizeof(kmp_int32) == 4);
6546 KMP_DEBUG_ASSERT(sizeof(kmp_uint32) == 4);
6547 KMP_DEBUG_ASSERT(sizeof(kmp_int64) == 8);
6548 KMP_DEBUG_ASSERT(sizeof(kmp_uint64) == 8);
6549 KMP_DEBUG_ASSERT(sizeof(kmp_intptr_t) == sizeof(void *));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006550
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006551#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006552 ompt_pre_init();
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006553#endif
6554
Jonathan Peyton30419822017-05-12 18:01:32 +00006555 __kmp_validate_locks();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006556
Jonathan Peyton30419822017-05-12 18:01:32 +00006557 /* Initialize internal memory allocator */
6558 __kmp_init_allocator();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006559
Jonathan Peyton30419822017-05-12 18:01:32 +00006560 /* Register the library startup via an environment variable and check to see
6561 whether another copy of the library is already registered. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006562
Jonathan Peyton30419822017-05-12 18:01:32 +00006563 __kmp_register_library_startup();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006564
Jonathan Peyton30419822017-05-12 18:01:32 +00006565 /* TODO reinitialization of library */
6566 if (TCR_4(__kmp_global.g.g_done)) {
6567 KA_TRACE(10, ("__kmp_do_serial_initialize: reinitialization of library\n"));
6568 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006569
Jonathan Peyton30419822017-05-12 18:01:32 +00006570 __kmp_global.g.g_abort = 0;
6571 TCW_SYNC_4(__kmp_global.g.g_done, FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006572
Jonathan Peyton30419822017-05-12 18:01:32 +00006573/* initialize the locks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006574#if KMP_USE_ADAPTIVE_LOCKS
6575#if KMP_DEBUG_ADAPTIVE_LOCKS
Jonathan Peyton30419822017-05-12 18:01:32 +00006576 __kmp_init_speculative_stats();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006577#endif
6578#endif
Jonathan Peytonad579922015-12-17 16:19:05 +00006579#if KMP_STATS_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00006580 __kmp_stats_init();
Jonathan Peytonad579922015-12-17 16:19:05 +00006581#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006582 __kmp_init_lock(&__kmp_global_lock);
6583 __kmp_init_queuing_lock(&__kmp_dispatch_lock);
6584 __kmp_init_lock(&__kmp_debug_lock);
6585 __kmp_init_atomic_lock(&__kmp_atomic_lock);
6586 __kmp_init_atomic_lock(&__kmp_atomic_lock_1i);
6587 __kmp_init_atomic_lock(&__kmp_atomic_lock_2i);
6588 __kmp_init_atomic_lock(&__kmp_atomic_lock_4i);
6589 __kmp_init_atomic_lock(&__kmp_atomic_lock_4r);
6590 __kmp_init_atomic_lock(&__kmp_atomic_lock_8i);
6591 __kmp_init_atomic_lock(&__kmp_atomic_lock_8r);
6592 __kmp_init_atomic_lock(&__kmp_atomic_lock_8c);
6593 __kmp_init_atomic_lock(&__kmp_atomic_lock_10r);
6594 __kmp_init_atomic_lock(&__kmp_atomic_lock_16r);
6595 __kmp_init_atomic_lock(&__kmp_atomic_lock_16c);
6596 __kmp_init_atomic_lock(&__kmp_atomic_lock_20c);
6597 __kmp_init_atomic_lock(&__kmp_atomic_lock_32c);
6598 __kmp_init_bootstrap_lock(&__kmp_forkjoin_lock);
6599 __kmp_init_bootstrap_lock(&__kmp_exit_lock);
Jonathan Peytonb66d1aa2016-09-27 17:11:17 +00006600#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00006601 __kmp_init_bootstrap_lock(&__kmp_monitor_lock);
Jonathan Peytonb66d1aa2016-09-27 17:11:17 +00006602#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006603 __kmp_init_bootstrap_lock(&__kmp_tp_cached_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006604
Jonathan Peyton30419822017-05-12 18:01:32 +00006605 /* conduct initialization and initial setup of configuration */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006606
Jonathan Peyton30419822017-05-12 18:01:32 +00006607 __kmp_runtime_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006608
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006609#if KMP_MIC_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00006610 __kmp_check_mic_type();
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006611#endif
6612
Jonathan Peyton30419822017-05-12 18:01:32 +00006613// Some global variable initialization moved here from kmp_env_initialize()
Jim Cownie5e8470a2013-09-27 10:38:44 +00006614#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00006615 kmp_diag = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006616#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006617 __kmp_abort_delay = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006618
Jonathan Peyton30419822017-05-12 18:01:32 +00006619 // From __kmp_init_dflt_team_nth()
6620 /* assume the entire machine will be used */
6621 __kmp_dflt_team_nth_ub = __kmp_xproc;
6622 if (__kmp_dflt_team_nth_ub < KMP_MIN_NTH) {
6623 __kmp_dflt_team_nth_ub = KMP_MIN_NTH;
6624 }
6625 if (__kmp_dflt_team_nth_ub > __kmp_sys_max_nth) {
6626 __kmp_dflt_team_nth_ub = __kmp_sys_max_nth;
6627 }
6628 __kmp_max_nth = __kmp_sys_max_nth;
Jonathan Peytonf4392462017-07-27 20:58:41 +00006629 __kmp_cg_max_nth = __kmp_sys_max_nth;
Jonathan Peyton4f90c822017-08-02 20:04:45 +00006630 __kmp_teams_max_nth = __kmp_xproc; // set a "reasonable" default
6631 if (__kmp_teams_max_nth > __kmp_sys_max_nth) {
6632 __kmp_teams_max_nth = __kmp_sys_max_nth;
6633 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006634
Jonathan Peyton30419822017-05-12 18:01:32 +00006635 // Three vars below moved here from __kmp_env_initialize() "KMP_BLOCKTIME"
6636 // part
6637 __kmp_dflt_blocktime = KMP_DEFAULT_BLOCKTIME;
Jonathan Peytone1c7c132016-10-07 18:12:19 +00006638#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00006639 __kmp_monitor_wakeups =
6640 KMP_WAKEUPS_FROM_BLOCKTIME(__kmp_dflt_blocktime, __kmp_monitor_wakeups);
6641 __kmp_bt_intervals =
6642 KMP_INTERVALS_FROM_BLOCKTIME(__kmp_dflt_blocktime, __kmp_monitor_wakeups);
Jonathan Peytone1c7c132016-10-07 18:12:19 +00006643#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006644 // From "KMP_LIBRARY" part of __kmp_env_initialize()
6645 __kmp_library = library_throughput;
6646 // From KMP_SCHEDULE initialization
6647 __kmp_static = kmp_sch_static_balanced;
6648// AC: do not use analytical here, because it is non-monotonous
6649//__kmp_guided = kmp_sch_guided_iterative_chunked;
6650//__kmp_auto = kmp_sch_guided_analytical_chunked; // AC: it is the default, no
6651// need to repeat assignment
6652// Barrier initialization. Moved here from __kmp_env_initialize() Barrier branch
6653// bit control and barrier method control parts
Jim Cownie4cc4bb42014-10-07 16:25:50 +00006654#if KMP_FAST_REDUCTION_BARRIER
Jonathan Peyton30419822017-05-12 18:01:32 +00006655#define kmp_reduction_barrier_gather_bb ((int)1)
6656#define kmp_reduction_barrier_release_bb ((int)1)
6657#define kmp_reduction_barrier_gather_pat bp_hyper_bar
6658#define kmp_reduction_barrier_release_pat bp_hyper_bar
6659#endif // KMP_FAST_REDUCTION_BARRIER
6660 for (i = bs_plain_barrier; i < bs_last_barrier; i++) {
6661 __kmp_barrier_gather_branch_bits[i] = __kmp_barrier_gather_bb_dflt;
6662 __kmp_barrier_release_branch_bits[i] = __kmp_barrier_release_bb_dflt;
6663 __kmp_barrier_gather_pattern[i] = __kmp_barrier_gather_pat_dflt;
6664 __kmp_barrier_release_pattern[i] = __kmp_barrier_release_pat_dflt;
6665#if KMP_FAST_REDUCTION_BARRIER
6666 if (i == bs_reduction_barrier) { // tested and confirmed on ALTIX only (
6667 // lin_64 ): hyper,1
6668 __kmp_barrier_gather_branch_bits[i] = kmp_reduction_barrier_gather_bb;
6669 __kmp_barrier_release_branch_bits[i] = kmp_reduction_barrier_release_bb;
6670 __kmp_barrier_gather_pattern[i] = kmp_reduction_barrier_gather_pat;
6671 __kmp_barrier_release_pattern[i] = kmp_reduction_barrier_release_pat;
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006672 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006673#endif // KMP_FAST_REDUCTION_BARRIER
6674 }
6675#if KMP_FAST_REDUCTION_BARRIER
6676#undef kmp_reduction_barrier_release_pat
6677#undef kmp_reduction_barrier_gather_pat
6678#undef kmp_reduction_barrier_release_bb
6679#undef kmp_reduction_barrier_gather_bb
6680#endif // KMP_FAST_REDUCTION_BARRIER
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006681#if KMP_MIC_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00006682 if (__kmp_mic_type == mic2) { // KNC
6683 // AC: plane=3,2, forkjoin=2,1 are optimal for 240 threads on KNC
6684 __kmp_barrier_gather_branch_bits[bs_plain_barrier] = 3; // plain gather
6685 __kmp_barrier_release_branch_bits[bs_forkjoin_barrier] =
6686 1; // forkjoin release
6687 __kmp_barrier_gather_pattern[bs_forkjoin_barrier] = bp_hierarchical_bar;
6688 __kmp_barrier_release_pattern[bs_forkjoin_barrier] = bp_hierarchical_bar;
6689 }
6690#if KMP_FAST_REDUCTION_BARRIER
6691 if (__kmp_mic_type == mic2) { // KNC
6692 __kmp_barrier_gather_pattern[bs_reduction_barrier] = bp_hierarchical_bar;
6693 __kmp_barrier_release_pattern[bs_reduction_barrier] = bp_hierarchical_bar;
6694 }
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006695#endif // KMP_FAST_REDUCTION_BARRIER
6696#endif // KMP_MIC_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00006697
Jonathan Peyton30419822017-05-12 18:01:32 +00006698// From KMP_CHECKS initialization
Jim Cownie5e8470a2013-09-27 10:38:44 +00006699#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00006700 __kmp_env_checks = TRUE; /* development versions have the extra checks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006701#else
Jonathan Peyton30419822017-05-12 18:01:32 +00006702 __kmp_env_checks = FALSE; /* port versions do not have the extra checks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006703#endif
6704
Jonathan Peyton30419822017-05-12 18:01:32 +00006705 // From "KMP_FOREIGN_THREADS_THREADPRIVATE" initialization
6706 __kmp_foreign_tp = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006707
Jonathan Peyton30419822017-05-12 18:01:32 +00006708 __kmp_global.g.g_dynamic = FALSE;
6709 __kmp_global.g.g_dynamic_mode = dynamic_default;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006710
Jonathan Peyton30419822017-05-12 18:01:32 +00006711 __kmp_env_initialize(NULL);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00006712
Jonathan Peyton30419822017-05-12 18:01:32 +00006713// Print all messages in message catalog for testing purposes.
6714#ifdef KMP_DEBUG
6715 char const *val = __kmp_env_get("KMP_DUMP_CATALOG");
6716 if (__kmp_str_match_true(val)) {
6717 kmp_str_buf_t buffer;
6718 __kmp_str_buf_init(&buffer);
6719 __kmp_i18n_dump_catalog(&buffer);
6720 __kmp_printf("%s", buffer.str);
6721 __kmp_str_buf_free(&buffer);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006722 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006723 __kmp_env_free(&val);
6724#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006725
Jonathan Peyton30419822017-05-12 18:01:32 +00006726 __kmp_threads_capacity =
6727 __kmp_initial_threads_capacity(__kmp_dflt_team_nth_ub);
6728 // Moved here from __kmp_env_initialize() "KMP_ALL_THREADPRIVATE" part
6729 __kmp_tp_capacity = __kmp_default_tp_capacity(
6730 __kmp_dflt_team_nth_ub, __kmp_max_nth, __kmp_allThreadsSpecified);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006731
Jonathan Peyton30419822017-05-12 18:01:32 +00006732 // If the library is shut down properly, both pools must be NULL. Just in
6733 // case, set them to NULL -- some memory may leak, but subsequent code will
6734 // work even if pools are not freed.
6735 KMP_DEBUG_ASSERT(__kmp_thread_pool == NULL);
6736 KMP_DEBUG_ASSERT(__kmp_thread_pool_insert_pt == NULL);
6737 KMP_DEBUG_ASSERT(__kmp_team_pool == NULL);
6738 __kmp_thread_pool = NULL;
6739 __kmp_thread_pool_insert_pt = NULL;
6740 __kmp_team_pool = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006741
Jonathan Peyton30419822017-05-12 18:01:32 +00006742 /* Allocate all of the variable sized records */
6743 /* NOTE: __kmp_threads_capacity entries are allocated, but the arrays are
6744 * expandable */
6745 /* Since allocation is cache-aligned, just add extra padding at the end */
6746 size =
6747 (sizeof(kmp_info_t *) + sizeof(kmp_root_t *)) * __kmp_threads_capacity +
6748 CACHE_LINE;
6749 __kmp_threads = (kmp_info_t **)__kmp_allocate(size);
6750 __kmp_root = (kmp_root_t **)((char *)__kmp_threads +
6751 sizeof(kmp_info_t *) * __kmp_threads_capacity);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006752
Jonathan Peyton30419822017-05-12 18:01:32 +00006753 /* init thread counts */
6754 KMP_DEBUG_ASSERT(__kmp_all_nth ==
6755 0); // Asserts fail if the library is reinitializing and
6756 KMP_DEBUG_ASSERT(__kmp_nth == 0); // something was wrong in termination.
6757 __kmp_all_nth = 0;
6758 __kmp_nth = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006759
Jonathan Peyton30419822017-05-12 18:01:32 +00006760 /* setup the uber master thread and hierarchy */
6761 gtid = __kmp_register_root(TRUE);
6762 KA_TRACE(10, ("__kmp_do_serial_initialize T#%d\n", gtid));
6763 KMP_ASSERT(KMP_UBER_GTID(gtid));
6764 KMP_ASSERT(KMP_INITIAL_GTID(gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006765
Jonathan Peyton30419822017-05-12 18:01:32 +00006766 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006767
Jonathan Peyton30419822017-05-12 18:01:32 +00006768 __kmp_common_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006769
Jonathan Peyton30419822017-05-12 18:01:32 +00006770#if KMP_OS_UNIX
6771 /* invoke the child fork handler */
6772 __kmp_register_atfork();
6773#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006774
Jonathan Peyton8b3842f2018-10-05 17:59:39 +00006775#if !KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +00006776 {
6777 /* Invoke the exit handler when the program finishes, only for static
6778 library. For dynamic library, we already have _fini and DllMain. */
6779 int rc = atexit(__kmp_internal_end_atexit);
6780 if (rc != 0) {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00006781 __kmp_fatal(KMP_MSG(FunctionError, "atexit()"), KMP_ERR(rc),
6782 __kmp_msg_null);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006783 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006784 }
6785#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006786
Jonathan Peyton30419822017-05-12 18:01:32 +00006787#if KMP_HANDLE_SIGNALS
6788#if KMP_OS_UNIX
6789 /* NOTE: make sure that this is called before the user installs their own
6790 signal handlers so that the user handlers are called first. this way they
6791 can return false, not call our handler, avoid terminating the library, and
6792 continue execution where they left off. */
6793 __kmp_install_signals(FALSE);
6794#endif /* KMP_OS_UNIX */
6795#if KMP_OS_WINDOWS
6796 __kmp_install_signals(TRUE);
6797#endif /* KMP_OS_WINDOWS */
6798#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006799
Jonathan Peyton30419822017-05-12 18:01:32 +00006800 /* we have finished the serial initialization */
6801 __kmp_init_counter++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006802
Jonathan Peyton30419822017-05-12 18:01:32 +00006803 __kmp_init_serial = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006804
Jonathan Peyton30419822017-05-12 18:01:32 +00006805 if (__kmp_settings) {
6806 __kmp_env_print();
6807 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006808
6809#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00006810 if (__kmp_display_env || __kmp_display_env_verbose) {
6811 __kmp_env_print_2();
6812 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006813#endif // OMP_40_ENABLED
6814
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006815#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006816 ompt_post_init();
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006817#endif
6818
Jonathan Peyton30419822017-05-12 18:01:32 +00006819 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006820
Jonathan Peyton30419822017-05-12 18:01:32 +00006821 KA_TRACE(10, ("__kmp_do_serial_initialize: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006822}
6823
Jonathan Peyton30419822017-05-12 18:01:32 +00006824void __kmp_serial_initialize(void) {
6825 if (__kmp_init_serial) {
6826 return;
6827 }
6828 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
6829 if (__kmp_init_serial) {
6830 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6831 return;
6832 }
6833 __kmp_do_serial_initialize();
6834 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6835}
6836
6837static void __kmp_do_middle_initialize(void) {
6838 int i, j;
6839 int prev_dflt_team_nth;
6840
6841 if (!__kmp_init_serial) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006842 __kmp_do_serial_initialize();
Jonathan Peyton30419822017-05-12 18:01:32 +00006843 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006844
Jonathan Peyton30419822017-05-12 18:01:32 +00006845 KA_TRACE(10, ("__kmp_middle_initialize: enter\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006846
Jonathan Peyton30419822017-05-12 18:01:32 +00006847 // Save the previous value for the __kmp_dflt_team_nth so that
6848 // we can avoid some reinitialization if it hasn't changed.
6849 prev_dflt_team_nth = __kmp_dflt_team_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006850
Alp Toker98758b02014-03-02 04:12:06 +00006851#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00006852 // __kmp_affinity_initialize() will try to set __kmp_ncores to the
6853 // number of cores on the machine.
6854 __kmp_affinity_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006855
Jonathan Peyton30419822017-05-12 18:01:32 +00006856 // Run through the __kmp_threads array and set the affinity mask
6857 // for each root thread that is currently registered with the RTL.
6858 for (i = 0; i < __kmp_threads_capacity; i++) {
6859 if (TCR_PTR(__kmp_threads[i]) != NULL) {
6860 __kmp_affinity_set_init_mask(i, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006861 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006862 }
Alp Toker98758b02014-03-02 04:12:06 +00006863#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006864
Jonathan Peyton30419822017-05-12 18:01:32 +00006865 KMP_ASSERT(__kmp_xproc > 0);
6866 if (__kmp_avail_proc == 0) {
6867 __kmp_avail_proc = __kmp_xproc;
6868 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006869
Jonathan Peyton30419822017-05-12 18:01:32 +00006870 // If there were empty places in num_threads list (OMP_NUM_THREADS=,,2,3),
6871 // correct them now
6872 j = 0;
6873 while ((j < __kmp_nested_nth.used) && !__kmp_nested_nth.nth[j]) {
6874 __kmp_nested_nth.nth[j] = __kmp_dflt_team_nth = __kmp_dflt_team_nth_ub =
6875 __kmp_avail_proc;
6876 j++;
6877 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006878
Jonathan Peyton30419822017-05-12 18:01:32 +00006879 if (__kmp_dflt_team_nth == 0) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006880#ifdef KMP_DFLT_NTH_CORES
Jonathan Peyton30419822017-05-12 18:01:32 +00006881 // Default #threads = #cores
6882 __kmp_dflt_team_nth = __kmp_ncores;
6883 KA_TRACE(20, ("__kmp_middle_initialize: setting __kmp_dflt_team_nth = "
6884 "__kmp_ncores (%d)\n",
6885 __kmp_dflt_team_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006886#else
Jonathan Peyton30419822017-05-12 18:01:32 +00006887 // Default #threads = #available OS procs
6888 __kmp_dflt_team_nth = __kmp_avail_proc;
6889 KA_TRACE(20, ("__kmp_middle_initialize: setting __kmp_dflt_team_nth = "
6890 "__kmp_avail_proc(%d)\n",
6891 __kmp_dflt_team_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006892#endif /* KMP_DFLT_NTH_CORES */
Jonathan Peyton30419822017-05-12 18:01:32 +00006893 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006894
Jonathan Peyton30419822017-05-12 18:01:32 +00006895 if (__kmp_dflt_team_nth < KMP_MIN_NTH) {
6896 __kmp_dflt_team_nth = KMP_MIN_NTH;
6897 }
6898 if (__kmp_dflt_team_nth > __kmp_sys_max_nth) {
6899 __kmp_dflt_team_nth = __kmp_sys_max_nth;
6900 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006901
Jonathan Peyton30419822017-05-12 18:01:32 +00006902 // There's no harm in continuing if the following check fails,
6903 // but it indicates an error in the previous logic.
6904 KMP_DEBUG_ASSERT(__kmp_dflt_team_nth <= __kmp_dflt_team_nth_ub);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006905
Jonathan Peyton30419822017-05-12 18:01:32 +00006906 if (__kmp_dflt_team_nth != prev_dflt_team_nth) {
6907 // Run through the __kmp_threads array and set the num threads icv for each
6908 // root thread that is currently registered with the RTL (which has not
6909 // already explicitly set its nthreads-var with a call to
6910 // omp_set_num_threads()).
6911 for (i = 0; i < __kmp_threads_capacity; i++) {
6912 kmp_info_t *thread = __kmp_threads[i];
6913 if (thread == NULL)
6914 continue;
6915 if (thread->th.th_current_task->td_icvs.nproc != 0)
6916 continue;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006917
Jonathan Peyton30419822017-05-12 18:01:32 +00006918 set__nproc(__kmp_threads[i], __kmp_dflt_team_nth);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006919 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006920 }
6921 KA_TRACE(
6922 20,
6923 ("__kmp_middle_initialize: final value for __kmp_dflt_team_nth = %d\n",
6924 __kmp_dflt_team_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006925
6926#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00006927 /* Adjust blocktime to zero if necessary now that __kmp_avail_proc is set */
6928 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
6929 KMP_DEBUG_ASSERT(__kmp_avail_proc > 0);
6930 if (__kmp_nth > __kmp_avail_proc) {
6931 __kmp_zero_bt = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006932 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006933 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006934#endif /* KMP_ADJUST_BLOCKTIME */
6935
Jonathan Peyton30419822017-05-12 18:01:32 +00006936 /* we have finished middle initialization */
6937 TCW_SYNC_4(__kmp_init_middle, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006938
Jonathan Peyton30419822017-05-12 18:01:32 +00006939 KA_TRACE(10, ("__kmp_do_middle_initialize: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006940}
6941
Jonathan Peyton30419822017-05-12 18:01:32 +00006942void __kmp_middle_initialize(void) {
6943 if (__kmp_init_middle) {
6944 return;
6945 }
6946 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
6947 if (__kmp_init_middle) {
6948 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6949 return;
6950 }
6951 __kmp_do_middle_initialize();
6952 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6953}
6954
6955void __kmp_parallel_initialize(void) {
6956 int gtid = __kmp_entry_gtid(); // this might be a new root
6957
6958 /* synchronize parallel initialization (for sibling) */
6959 if (TCR_4(__kmp_init_parallel))
6960 return;
6961 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
6962 if (TCR_4(__kmp_init_parallel)) {
6963 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6964 return;
6965 }
6966
6967 /* TODO reinitialization after we have already shut down */
6968 if (TCR_4(__kmp_global.g.g_done)) {
6969 KA_TRACE(
6970 10,
6971 ("__kmp_parallel_initialize: attempt to init while shutting down\n"));
6972 __kmp_infinite_loop();
6973 }
6974
6975 /* jc: The lock __kmp_initz_lock is already held, so calling
6976 __kmp_serial_initialize would cause a deadlock. So we call
6977 __kmp_do_serial_initialize directly. */
6978 if (!__kmp_init_middle) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006979 __kmp_do_middle_initialize();
Jonathan Peyton30419822017-05-12 18:01:32 +00006980 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006981
Jonathan Peyton9b8bb322019-01-16 20:07:39 +00006982#if OMP_50_ENABLED
6983 __kmp_resume_if_hard_paused();
6984#endif
6985
Jonathan Peyton30419822017-05-12 18:01:32 +00006986 /* begin initialization */
6987 KA_TRACE(10, ("__kmp_parallel_initialize: enter\n"));
6988 KMP_ASSERT(KMP_UBER_GTID(gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006989
6990#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Jonathan Peyton30419822017-05-12 18:01:32 +00006991 // Save the FP control regs.
6992 // Worker threads will set theirs to these values at thread startup.
6993 __kmp_store_x87_fpu_control_word(&__kmp_init_x87_fpu_control_word);
6994 __kmp_store_mxcsr(&__kmp_init_mxcsr);
6995 __kmp_init_mxcsr &= KMP_X86_MXCSR_MASK;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006996#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
6997
6998#if KMP_OS_UNIX
Jonathan Peyton30419822017-05-12 18:01:32 +00006999#if KMP_HANDLE_SIGNALS
7000 /* must be after __kmp_serial_initialize */
7001 __kmp_install_signals(TRUE);
7002#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007003#endif
7004
Jonathan Peyton30419822017-05-12 18:01:32 +00007005 __kmp_suspend_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007006
Jonathan Peyton749b4d52016-01-27 21:02:04 +00007007#if defined(USE_LOAD_BALANCE)
Jonathan Peyton30419822017-05-12 18:01:32 +00007008 if (__kmp_global.g.g_dynamic_mode == dynamic_default) {
7009 __kmp_global.g.g_dynamic_mode = dynamic_load_balance;
7010 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007011#else
Jonathan Peyton30419822017-05-12 18:01:32 +00007012 if (__kmp_global.g.g_dynamic_mode == dynamic_default) {
7013 __kmp_global.g.g_dynamic_mode = dynamic_thread_limit;
7014 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007015#endif
7016
Jonathan Peyton30419822017-05-12 18:01:32 +00007017 if (__kmp_version) {
7018 __kmp_print_version_2();
7019 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007020
Jonathan Peyton30419822017-05-12 18:01:32 +00007021 /* we have finished parallel initialization */
7022 TCW_SYNC_4(__kmp_init_parallel, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007023
Jonathan Peyton30419822017-05-12 18:01:32 +00007024 KMP_MB();
7025 KA_TRACE(10, ("__kmp_parallel_initialize: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007026
Jonathan Peyton30419822017-05-12 18:01:32 +00007027 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007028}
7029
Jim Cownie5e8470a2013-09-27 10:38:44 +00007030/* ------------------------------------------------------------------------ */
7031
Jonathan Peyton30419822017-05-12 18:01:32 +00007032void __kmp_run_before_invoked_task(int gtid, int tid, kmp_info_t *this_thr,
7033 kmp_team_t *team) {
7034 kmp_disp_t *dispatch;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007035
Jonathan Peyton30419822017-05-12 18:01:32 +00007036 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007037
Jonathan Peyton30419822017-05-12 18:01:32 +00007038 /* none of the threads have encountered any constructs, yet. */
7039 this_thr->th.th_local.this_construct = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007040#if KMP_CACHE_MANAGE
Jonathan Peyton30419822017-05-12 18:01:32 +00007041 KMP_CACHE_PREFETCH(&this_thr->th.th_bar[bs_forkjoin_barrier].bb.b_arrived);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007042#endif /* KMP_CACHE_MANAGE */
Jonathan Peyton30419822017-05-12 18:01:32 +00007043 dispatch = (kmp_disp_t *)TCR_PTR(this_thr->th.th_dispatch);
7044 KMP_DEBUG_ASSERT(dispatch);
7045 KMP_DEBUG_ASSERT(team->t.t_dispatch);
7046 // KMP_DEBUG_ASSERT( this_thr->th.th_dispatch == &team->t.t_dispatch[
7047 // this_thr->th.th_info.ds.ds_tid ] );
Jim Cownie5e8470a2013-09-27 10:38:44 +00007048
Jonathan Peyton30419822017-05-12 18:01:32 +00007049 dispatch->th_disp_index = 0; /* reset the dispatch buffer counter */
Jonathan Peytondf6818b2016-06-14 17:57:47 +00007050#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007051 dispatch->th_doacross_buf_idx =
7052 0; /* reset the doacross dispatch buffer counter */
Jonathan Peyton71909c52016-03-02 22:42:06 +00007053#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007054 if (__kmp_env_consistency_check)
7055 __kmp_push_parallel(gtid, team->t.t_ident);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007056
Jonathan Peyton30419822017-05-12 18:01:32 +00007057 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007058}
7059
Jonathan Peyton30419822017-05-12 18:01:32 +00007060void __kmp_run_after_invoked_task(int gtid, int tid, kmp_info_t *this_thr,
7061 kmp_team_t *team) {
7062 if (__kmp_env_consistency_check)
7063 __kmp_pop_parallel(gtid, team->t.t_ident);
Andrey Churbanovdf0d75e2016-10-27 11:43:07 +00007064
Jonathan Peyton30419822017-05-12 18:01:32 +00007065 __kmp_finish_implicit_task(this_thr);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007066}
7067
Jonathan Peyton30419822017-05-12 18:01:32 +00007068int __kmp_invoke_task_func(int gtid) {
7069 int rc;
7070 int tid = __kmp_tid_from_gtid(gtid);
7071 kmp_info_t *this_thr = __kmp_threads[gtid];
7072 kmp_team_t *team = this_thr->th.th_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007073
Jonathan Peyton30419822017-05-12 18:01:32 +00007074 __kmp_run_before_invoked_task(gtid, tid, this_thr, team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007075#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00007076 if (__itt_stack_caller_create_ptr) {
7077 __kmp_itt_stack_callee_enter(
7078 (__itt_caller)
7079 team->t.t_stack_id); // inform ittnotify about entering user's code
7080 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007081#endif /* USE_ITT_BUILD */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007082#if INCLUDE_SSC_MARKS
Jonathan Peyton30419822017-05-12 18:01:32 +00007083 SSC_MARK_INVOKING();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007084#endif
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007085
7086#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00007087 void *dummy;
7088 void **exit_runtime_p;
Joachim Protze82e94a52017-11-01 10:08:30 +00007089 ompt_data_t *my_task_data;
7090 ompt_data_t *my_parallel_data;
7091 int ompt_team_size;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007092
Joachim Protze82e94a52017-11-01 10:08:30 +00007093 if (ompt_enabled.enabled) {
Joachim Protzec255ca72017-11-05 14:11:10 +00007094 exit_runtime_p = &(
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00007095 team->t.t_implicit_task_taskdata[tid].ompt_task_info.frame.exit_frame.ptr);
Jonathan Peyton30419822017-05-12 18:01:32 +00007096 } else {
7097 exit_runtime_p = &dummy;
7098 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007099
Joachim Protze82e94a52017-11-01 10:08:30 +00007100 my_task_data =
7101 &(team->t.t_implicit_task_taskdata[tid].ompt_task_info.task_data);
7102 my_parallel_data = &(team->t.ompt_team_info.parallel_data);
7103 if (ompt_enabled.ompt_callback_implicit_task) {
7104 ompt_team_size = team->t.t_nproc;
7105 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
7106 ompt_scope_begin, my_parallel_data, my_task_data, ompt_team_size,
Joachim Protze2b46d302019-01-15 15:36:53 +00007107 __kmp_tid_from_gtid(gtid), ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Joachim Protze9be9cf22018-05-07 12:42:21 +00007108 OMPT_CUR_TASK_INFO(this_thr)->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00007109 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007110#endif
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007111
Jonathan Peyton30419822017-05-12 18:01:32 +00007112 {
7113 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
7114 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
7115 rc =
7116 __kmp_invoke_microtask((microtask_t)TCR_SYNC_PTR(team->t.t_pkfn), gtid,
7117 tid, (int)team->t.t_argc, (void **)team->t.t_argv
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007118#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00007119 ,
7120 exit_runtime_p
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007121#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007122 );
Jonas Hahnfeld8a270642016-09-14 13:59:19 +00007123#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00007124 *exit_runtime_p = NULL;
Jonas Hahnfeld8a270642016-09-14 13:59:19 +00007125#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007126 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00007127
Jim Cownie5e8470a2013-09-27 10:38:44 +00007128#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00007129 if (__itt_stack_caller_create_ptr) {
7130 __kmp_itt_stack_callee_leave(
7131 (__itt_caller)
7132 team->t.t_stack_id); // inform ittnotify about leaving user's code
7133 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007134#endif /* USE_ITT_BUILD */
Jonathan Peyton30419822017-05-12 18:01:32 +00007135 __kmp_run_after_invoked_task(gtid, tid, this_thr, team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007136
Jonathan Peyton30419822017-05-12 18:01:32 +00007137 return rc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007138}
7139
7140#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007141void __kmp_teams_master(int gtid) {
7142 // This routine is called by all master threads in teams construct
7143 kmp_info_t *thr = __kmp_threads[gtid];
7144 kmp_team_t *team = thr->th.th_team;
7145 ident_t *loc = team->t.t_ident;
7146 thr->th.th_set_nproc = thr->th.th_teams_size.nth;
7147 KMP_DEBUG_ASSERT(thr->th.th_teams_microtask);
7148 KMP_DEBUG_ASSERT(thr->th.th_set_nproc);
7149 KA_TRACE(20, ("__kmp_teams_master: T#%d, Tid %d, microtask %p\n", gtid,
7150 __kmp_tid_from_gtid(gtid), thr->th.th_teams_microtask));
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00007151
7152 // This thread is a new CG root. Set up the proper variables.
7153 kmp_cg_root_t *tmp = (kmp_cg_root_t *)__kmp_allocate(sizeof(kmp_cg_root_t));
7154 tmp->cg_root = thr; // Make thr the CG root
7155 // Init to thread limit that was stored when league masters were forked
7156 tmp->cg_thread_limit = thr->th.th_current_task->td_icvs.thread_limit;
7157 tmp->cg_nthreads = 1; // Init counter to one active thread, this one
7158 KA_TRACE(100, ("__kmp_teams_master: Thread %p created node %p and init"
7159 " cg_threads to 1\n",
7160 thr, tmp));
7161 tmp->up = thr->th.th_cg_roots;
7162 thr->th.th_cg_roots = tmp;
7163
Jonathan Peyton30419822017-05-12 18:01:32 +00007164// Launch league of teams now, but not let workers execute
7165// (they hang on fork barrier until next parallel)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007166#if INCLUDE_SSC_MARKS
Jonathan Peyton30419822017-05-12 18:01:32 +00007167 SSC_MARK_FORKING();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007168#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007169 __kmp_fork_call(loc, gtid, fork_context_intel, team->t.t_argc,
Jonathan Peyton30419822017-05-12 18:01:32 +00007170 (microtask_t)thr->th.th_teams_microtask, // "wrapped" task
7171 VOLATILE_CAST(launch_t) __kmp_invoke_task_func, NULL);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007172#if INCLUDE_SSC_MARKS
Jonathan Peyton30419822017-05-12 18:01:32 +00007173 SSC_MARK_JOINING();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007174#endif
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00007175 // If the team size was reduced from the limit, set it to the new size
7176 if (thr->th.th_team_nproc < thr->th.th_teams_size.nth)
7177 thr->th.th_teams_size.nth = thr->th.th_team_nproc;
Jonathan Peyton30419822017-05-12 18:01:32 +00007178 // AC: last parameter "1" eliminates join barrier which won't work because
7179 // worker threads are in a fork barrier waiting for more parallel regions
7180 __kmp_join_call(loc, gtid
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00007181#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00007182 ,
7183 fork_context_intel
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00007184#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007185 ,
7186 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007187}
7188
Jonathan Peyton30419822017-05-12 18:01:32 +00007189int __kmp_invoke_teams_master(int gtid) {
7190 kmp_info_t *this_thr = __kmp_threads[gtid];
7191 kmp_team_t *team = this_thr->th.th_team;
7192#if KMP_DEBUG
7193 if (!__kmp_threads[gtid]->th.th_team->t.t_serialized)
7194 KMP_DEBUG_ASSERT((void *)__kmp_threads[gtid]->th.th_team->t.t_pkfn ==
7195 (void *)__kmp_teams_master);
7196#endif
7197 __kmp_run_before_invoked_task(gtid, 0, this_thr, team);
7198 __kmp_teams_master(gtid);
7199 __kmp_run_after_invoked_task(gtid, 0, this_thr, team);
7200 return 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007201}
7202#endif /* OMP_40_ENABLED */
7203
7204/* this sets the requested number of threads for the next parallel region
Jonathan Peyton30419822017-05-12 18:01:32 +00007205 encountered by this team. since this should be enclosed in the forkjoin
7206 critical section it should avoid race conditions with assymmetrical nested
7207 parallelism */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007208
Jonathan Peyton30419822017-05-12 18:01:32 +00007209void __kmp_push_num_threads(ident_t *id, int gtid, int num_threads) {
7210 kmp_info_t *thr = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00007211
Jonathan Peyton30419822017-05-12 18:01:32 +00007212 if (num_threads > 0)
7213 thr->th.th_set_nproc = num_threads;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007214}
7215
7216#if OMP_40_ENABLED
7217
7218/* this sets the requested number of teams for the teams region and/or
Jonathan Peyton30419822017-05-12 18:01:32 +00007219 the number of threads for the next parallel region encountered */
7220void __kmp_push_num_teams(ident_t *id, int gtid, int num_teams,
7221 int num_threads) {
7222 kmp_info_t *thr = __kmp_threads[gtid];
7223 KMP_DEBUG_ASSERT(num_teams >= 0);
7224 KMP_DEBUG_ASSERT(num_threads >= 0);
Jonathan Peyton1be692e2015-11-30 20:14:05 +00007225
Jonathan Peyton30419822017-05-12 18:01:32 +00007226 if (num_teams == 0)
7227 num_teams = 1; // default number of teams is 1.
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007228 if (num_teams > __kmp_teams_max_nth) { // if too many teams requested?
Jonathan Peyton30419822017-05-12 18:01:32 +00007229 if (!__kmp_reserve_warn) {
7230 __kmp_reserve_warn = 1;
7231 __kmp_msg(kmp_ms_warning,
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007232 KMP_MSG(CantFormThrTeam, num_teams, __kmp_teams_max_nth),
Jonathan Peyton30419822017-05-12 18:01:32 +00007233 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007234 }
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007235 num_teams = __kmp_teams_max_nth;
Jonathan Peyton30419822017-05-12 18:01:32 +00007236 }
7237 // Set number of teams (number of threads in the outer "parallel" of the
7238 // teams)
7239 thr->th.th_set_nproc = thr->th.th_teams_size.nteams = num_teams;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007240
Jonathan Peyton30419822017-05-12 18:01:32 +00007241 // Remember the number of threads for inner parallel regions
7242 if (num_threads == 0) {
7243 if (!TCR_4(__kmp_init_middle))
7244 __kmp_middle_initialize(); // get __kmp_avail_proc calculated
7245 num_threads = __kmp_avail_proc / num_teams;
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007246 if (num_teams * num_threads > __kmp_teams_max_nth) {
Jonathan Peyton30419822017-05-12 18:01:32 +00007247 // adjust num_threads w/o warning as it is not user setting
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007248 num_threads = __kmp_teams_max_nth / num_teams;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007249 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007250 } else {
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00007251 // This thread will be the master of the league masters
7252 // Store new thread limit; old limit is saved in th_cg_roots list
7253 thr->th.th_current_task->td_icvs.thread_limit = num_threads;
7254
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007255 if (num_teams * num_threads > __kmp_teams_max_nth) {
7256 int new_threads = __kmp_teams_max_nth / num_teams;
Jonathan Peyton30419822017-05-12 18:01:32 +00007257 if (!__kmp_reserve_warn) { // user asked for too many threads
Jonathan Peyton65ebfee2019-02-11 21:04:23 +00007258 __kmp_reserve_warn = 1; // conflicts with KMP_TEAMS_THREAD_LIMIT
Jonathan Peyton30419822017-05-12 18:01:32 +00007259 __kmp_msg(kmp_ms_warning,
7260 KMP_MSG(CantFormThrTeam, num_threads, new_threads),
7261 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
7262 }
7263 num_threads = new_threads;
7264 }
7265 }
7266 thr->th.th_teams_size.nth = num_threads;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007267}
7268
Jim Cownie5e8470a2013-09-27 10:38:44 +00007269// Set the proc_bind var to use in the following parallel region.
Jonathan Peyton30419822017-05-12 18:01:32 +00007270void __kmp_push_proc_bind(ident_t *id, int gtid, kmp_proc_bind_t proc_bind) {
7271 kmp_info_t *thr = __kmp_threads[gtid];
7272 thr->th.th_set_proc_bind = proc_bind;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007273}
7274
7275#endif /* OMP_40_ENABLED */
7276
7277/* Launch the worker threads into the microtask. */
7278
Jonathan Peyton30419822017-05-12 18:01:32 +00007279void __kmp_internal_fork(ident_t *id, int gtid, kmp_team_t *team) {
7280 kmp_info_t *this_thr = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00007281
7282#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00007283 int f;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007284#endif /* KMP_DEBUG */
7285
Jonathan Peyton30419822017-05-12 18:01:32 +00007286 KMP_DEBUG_ASSERT(team);
7287 KMP_DEBUG_ASSERT(this_thr->th.th_team == team);
7288 KMP_ASSERT(KMP_MASTER_GTID(gtid));
7289 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007290
Jonathan Peyton30419822017-05-12 18:01:32 +00007291 team->t.t_construct = 0; /* no single directives seen yet */
7292 team->t.t_ordered.dt.t_value =
7293 0; /* thread 0 enters the ordered section first */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007294
Jonathan Peyton30419822017-05-12 18:01:32 +00007295 /* Reset the identifiers on the dispatch buffer */
7296 KMP_DEBUG_ASSERT(team->t.t_disp_buffer);
7297 if (team->t.t_max_nproc > 1) {
7298 int i;
7299 for (i = 0; i < __kmp_dispatch_num_buffers; ++i) {
7300 team->t.t_disp_buffer[i].buffer_index = i;
Jonathan Peytondf6818b2016-06-14 17:57:47 +00007301#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007302 team->t.t_disp_buffer[i].doacross_buf_idx = i;
Jonathan Peyton71909c52016-03-02 22:42:06 +00007303#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007304 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007305 } else {
7306 team->t.t_disp_buffer[0].buffer_index = 0;
7307#if OMP_45_ENABLED
7308 team->t.t_disp_buffer[0].doacross_buf_idx = 0;
7309#endif
7310 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007311
Jonathan Peyton30419822017-05-12 18:01:32 +00007312 KMP_MB(); /* Flush all pending memory write invalidates. */
7313 KMP_ASSERT(this_thr->th.th_team == team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007314
7315#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00007316 for (f = 0; f < team->t.t_nproc; f++) {
7317 KMP_DEBUG_ASSERT(team->t.t_threads[f] &&
7318 team->t.t_threads[f]->th.th_team_nproc == team->t.t_nproc);
7319 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007320#endif /* KMP_DEBUG */
7321
Jonathan Peyton30419822017-05-12 18:01:32 +00007322 /* release the worker threads so they may begin working */
7323 __kmp_fork_barrier(gtid, 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007324}
7325
Jonathan Peyton30419822017-05-12 18:01:32 +00007326void __kmp_internal_join(ident_t *id, int gtid, kmp_team_t *team) {
7327 kmp_info_t *this_thr = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00007328
Jonathan Peyton30419822017-05-12 18:01:32 +00007329 KMP_DEBUG_ASSERT(team);
7330 KMP_DEBUG_ASSERT(this_thr->th.th_team == team);
7331 KMP_ASSERT(KMP_MASTER_GTID(gtid));
7332 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007333
Jonathan Peyton30419822017-05-12 18:01:32 +00007334/* Join barrier after fork */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007335
7336#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00007337 if (__kmp_threads[gtid] &&
7338 __kmp_threads[gtid]->th.th_team_nproc != team->t.t_nproc) {
7339 __kmp_printf("GTID: %d, __kmp_threads[%d]=%p\n", gtid, gtid,
7340 __kmp_threads[gtid]);
7341 __kmp_printf("__kmp_threads[%d]->th.th_team_nproc=%d, TEAM: %p, "
7342 "team->t.t_nproc=%d\n",
7343 gtid, __kmp_threads[gtid]->th.th_team_nproc, team,
7344 team->t.t_nproc);
7345 __kmp_print_structure();
7346 }
7347 KMP_DEBUG_ASSERT(__kmp_threads[gtid] &&
7348 __kmp_threads[gtid]->th.th_team_nproc == team->t.t_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007349#endif /* KMP_DEBUG */
7350
Jonathan Peyton30419822017-05-12 18:01:32 +00007351 __kmp_join_barrier(gtid); /* wait for everyone */
Joachim Protze82e94a52017-11-01 10:08:30 +00007352#if OMPT_SUPPORT
Jonas Hahnfeld82768d02018-02-23 16:46:25 +00007353 if (ompt_enabled.enabled &&
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00007354 this_thr->th.ompt_thread_info.state == ompt_state_wait_barrier_implicit) {
Jonas Hahnfeld82768d02018-02-23 16:46:25 +00007355 int ds_tid = this_thr->th.th_info.ds.ds_tid;
7356 ompt_data_t *task_data = OMPT_CUR_TASK_DATA(this_thr);
Joachim Protze0e0d6cd2018-12-18 08:52:30 +00007357 this_thr->th.ompt_thread_info.state = ompt_state_overhead;
Joachim Protze82e94a52017-11-01 10:08:30 +00007358#if OMPT_OPTIONAL
7359 void *codeptr = NULL;
7360 if (KMP_MASTER_TID(ds_tid) &&
7361 (ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait) ||
7362 ompt_callbacks.ompt_callback(ompt_callback_sync_region)))
7363 codeptr = OMPT_CUR_TEAM_INFO(this_thr)->master_return_address;
7364
7365 if (ompt_enabled.ompt_callback_sync_region_wait) {
7366 ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
Jonathan Peytonad1ad7a2019-02-28 20:55:39 +00007367 ompt_sync_region_barrier_implicit, ompt_scope_end, NULL, task_data,
7368 codeptr);
Joachim Protze82e94a52017-11-01 10:08:30 +00007369 }
7370 if (ompt_enabled.ompt_callback_sync_region) {
7371 ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
Jonathan Peytonad1ad7a2019-02-28 20:55:39 +00007372 ompt_sync_region_barrier_implicit, ompt_scope_end, NULL, task_data,
7373 codeptr);
Joachim Protze82e94a52017-11-01 10:08:30 +00007374 }
7375#endif
7376 if (!KMP_MASTER_TID(ds_tid) && ompt_enabled.ompt_callback_implicit_task) {
7377 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
Joachim Protze2b46d302019-01-15 15:36:53 +00007378 ompt_scope_end, NULL, task_data, 0, ds_tid, ompt_task_implicit); // TODO: Can this be ompt_task_initial?
Joachim Protze82e94a52017-11-01 10:08:30 +00007379 }
Joachim Protze82e94a52017-11-01 10:08:30 +00007380 }
7381#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007382
Jonathan Peyton30419822017-05-12 18:01:32 +00007383 KMP_MB(); /* Flush all pending memory write invalidates. */
7384 KMP_ASSERT(this_thr->th.th_team == team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007385}
7386
Jim Cownie5e8470a2013-09-27 10:38:44 +00007387/* ------------------------------------------------------------------------ */
7388
7389#ifdef USE_LOAD_BALANCE
7390
Jim Cownie5e8470a2013-09-27 10:38:44 +00007391// Return the worker threads actively spinning in the hot team, if we
7392// are at the outermost level of parallelism. Otherwise, return 0.
Jonathan Peyton30419822017-05-12 18:01:32 +00007393static int __kmp_active_hot_team_nproc(kmp_root_t *root) {
7394 int i;
7395 int retval;
7396 kmp_team_t *hot_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007397
Jonathan Peyton30419822017-05-12 18:01:32 +00007398 if (root->r.r_active) {
7399 return 0;
7400 }
7401 hot_team = root->r.r_hot_team;
7402 if (__kmp_dflt_blocktime == KMP_MAX_BLOCKTIME) {
7403 return hot_team->t.t_nproc - 1; // Don't count master thread
7404 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007405
Jonathan Peyton30419822017-05-12 18:01:32 +00007406 // Skip the master thread - it is accounted for elsewhere.
7407 retval = 0;
7408 for (i = 1; i < hot_team->t.t_nproc; i++) {
7409 if (hot_team->t.t_threads[i]->th.th_active) {
7410 retval++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007411 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007412 }
7413 return retval;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007414}
7415
Jim Cownie5e8470a2013-09-27 10:38:44 +00007416// Perform an automatic adjustment to the number of
7417// threads used by the next parallel region.
Jonathan Peyton30419822017-05-12 18:01:32 +00007418static int __kmp_load_balance_nproc(kmp_root_t *root, int set_nproc) {
7419 int retval;
7420 int pool_active;
7421 int hot_team_active;
7422 int team_curr_active;
7423 int system_active;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007424
Jonathan Peyton30419822017-05-12 18:01:32 +00007425 KB_TRACE(20, ("__kmp_load_balance_nproc: called root:%p set_nproc:%d\n", root,
7426 set_nproc));
7427 KMP_DEBUG_ASSERT(root);
7428 KMP_DEBUG_ASSERT(root->r.r_root_team->t.t_threads[0]
7429 ->th.th_current_task->td_icvs.dynamic == TRUE);
7430 KMP_DEBUG_ASSERT(set_nproc > 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007431
Jonathan Peyton30419822017-05-12 18:01:32 +00007432 if (set_nproc == 1) {
7433 KB_TRACE(20, ("__kmp_load_balance_nproc: serial execution.\n"));
7434 return 1;
7435 }
7436
7437 // Threads that are active in the thread pool, active in the hot team for this
7438 // particular root (if we are at the outer par level), and the currently
7439 // executing thread (to become the master) are available to add to the new
7440 // team, but are currently contributing to the system load, and must be
7441 // accounted for.
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00007442 pool_active = __kmp_thread_pool_active_nth;
Jonathan Peyton30419822017-05-12 18:01:32 +00007443 hot_team_active = __kmp_active_hot_team_nproc(root);
7444 team_curr_active = pool_active + hot_team_active + 1;
7445
7446 // Check the system load.
7447 system_active = __kmp_get_load_balance(__kmp_avail_proc + team_curr_active);
7448 KB_TRACE(30, ("__kmp_load_balance_nproc: system active = %d pool active = %d "
7449 "hot team active = %d\n",
7450 system_active, pool_active, hot_team_active));
7451
7452 if (system_active < 0) {
7453 // There was an error reading the necessary info from /proc, so use the
7454 // thread limit algorithm instead. Once we set __kmp_global.g.g_dynamic_mode
7455 // = dynamic_thread_limit, we shouldn't wind up getting back here.
7456 __kmp_global.g.g_dynamic_mode = dynamic_thread_limit;
7457 KMP_WARNING(CantLoadBalUsing, "KMP_DYNAMIC_MODE=thread limit");
7458
7459 // Make this call behave like the thread limit algorithm.
7460 retval = __kmp_avail_proc - __kmp_nth +
7461 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
7462 if (retval > set_nproc) {
7463 retval = set_nproc;
7464 }
7465 if (retval < KMP_MIN_NTH) {
7466 retval = KMP_MIN_NTH;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007467 }
7468
Jonathan Peyton30419822017-05-12 18:01:32 +00007469 KB_TRACE(20, ("__kmp_load_balance_nproc: thread limit exit. retval:%d\n",
7470 retval));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007471 return retval;
Jonathan Peyton30419822017-05-12 18:01:32 +00007472 }
7473
7474 // There is a slight delay in the load balance algorithm in detecting new
7475 // running procs. The real system load at this instant should be at least as
7476 // large as the #active omp thread that are available to add to the team.
7477 if (system_active < team_curr_active) {
7478 system_active = team_curr_active;
7479 }
7480 retval = __kmp_avail_proc - system_active + team_curr_active;
7481 if (retval > set_nproc) {
7482 retval = set_nproc;
7483 }
7484 if (retval < KMP_MIN_NTH) {
7485 retval = KMP_MIN_NTH;
7486 }
7487
7488 KB_TRACE(20, ("__kmp_load_balance_nproc: exit. retval:%d\n", retval));
7489 return retval;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007490} // __kmp_load_balance_nproc()
7491
7492#endif /* USE_LOAD_BALANCE */
7493
Jim Cownie5e8470a2013-09-27 10:38:44 +00007494/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007495
7496/* NOTE: this is called with the __kmp_init_lock held */
Jonathan Peyton30419822017-05-12 18:01:32 +00007497void __kmp_cleanup(void) {
7498 int f;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007499
Jonathan Peyton30419822017-05-12 18:01:32 +00007500 KA_TRACE(10, ("__kmp_cleanup: enter\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007501
Jonathan Peyton30419822017-05-12 18:01:32 +00007502 if (TCR_4(__kmp_init_parallel)) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00007503#if KMP_HANDLE_SIGNALS
Jonathan Peyton30419822017-05-12 18:01:32 +00007504 __kmp_remove_signals();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007505#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007506 TCW_4(__kmp_init_parallel, FALSE);
7507 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007508
Jonathan Peyton30419822017-05-12 18:01:32 +00007509 if (TCR_4(__kmp_init_middle)) {
Alp Toker763b9392014-02-28 09:42:41 +00007510#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00007511 __kmp_affinity_uninitialize();
Alp Toker763b9392014-02-28 09:42:41 +00007512#endif /* KMP_AFFINITY_SUPPORTED */
Jonathan Peyton30419822017-05-12 18:01:32 +00007513 __kmp_cleanup_hierarchy();
7514 TCW_4(__kmp_init_middle, FALSE);
7515 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007516
Jonathan Peyton30419822017-05-12 18:01:32 +00007517 KA_TRACE(10, ("__kmp_cleanup: go serial cleanup\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007518
Jonathan Peyton30419822017-05-12 18:01:32 +00007519 if (__kmp_init_serial) {
7520 __kmp_runtime_destroy();
7521 __kmp_init_serial = FALSE;
7522 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007523
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00007524 __kmp_cleanup_threadprivate_caches();
7525
Jonathan Peyton30419822017-05-12 18:01:32 +00007526 for (f = 0; f < __kmp_threads_capacity; f++) {
7527 if (__kmp_root[f] != NULL) {
7528 __kmp_free(__kmp_root[f]);
7529 __kmp_root[f] = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007530 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007531 }
7532 __kmp_free(__kmp_threads);
7533 // __kmp_threads and __kmp_root were allocated at once, as single block, so
7534 // there is no need in freeing __kmp_root.
7535 __kmp_threads = NULL;
7536 __kmp_root = NULL;
7537 __kmp_threads_capacity = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007538
Andrey Churbanov5c56fb52015-02-20 18:05:17 +00007539#if KMP_USE_DYNAMIC_LOCK
Jonathan Peyton30419822017-05-12 18:01:32 +00007540 __kmp_cleanup_indirect_user_locks();
Andrey Churbanov5c56fb52015-02-20 18:05:17 +00007541#else
Jonathan Peyton30419822017-05-12 18:01:32 +00007542 __kmp_cleanup_user_locks();
Andrey Churbanov5c56fb52015-02-20 18:05:17 +00007543#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007544
Jonathan Peyton30419822017-05-12 18:01:32 +00007545#if KMP_AFFINITY_SUPPORTED
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00007546 KMP_INTERNAL_FREE(CCAST(char *, __kmp_cpuinfo_file));
Jonathan Peyton30419822017-05-12 18:01:32 +00007547 __kmp_cpuinfo_file = NULL;
7548#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007549
Jonathan Peyton30419822017-05-12 18:01:32 +00007550#if KMP_USE_ADAPTIVE_LOCKS
7551#if KMP_DEBUG_ADAPTIVE_LOCKS
7552 __kmp_print_speculative_stats();
7553#endif
7554#endif
7555 KMP_INTERNAL_FREE(__kmp_nested_nth.nth);
7556 __kmp_nested_nth.nth = NULL;
7557 __kmp_nested_nth.size = 0;
7558 __kmp_nested_nth.used = 0;
7559 KMP_INTERNAL_FREE(__kmp_nested_proc_bind.bind_types);
7560 __kmp_nested_proc_bind.bind_types = NULL;
7561 __kmp_nested_proc_bind.size = 0;
7562 __kmp_nested_proc_bind.used = 0;
Jonathan Peyton6d88e042018-12-13 23:14:24 +00007563#if OMP_50_ENABLED
7564 if (__kmp_affinity_format) {
7565 KMP_INTERNAL_FREE(__kmp_affinity_format);
7566 __kmp_affinity_format = NULL;
7567 }
7568#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007569
Jonathan Peyton30419822017-05-12 18:01:32 +00007570 __kmp_i18n_catclose();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007571
Jonathan Peytonf6399362018-07-09 17:51:13 +00007572#if KMP_USE_HIER_SCHED
7573 __kmp_hier_scheds.deallocate();
7574#endif
7575
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007576#if KMP_STATS_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007577 __kmp_stats_fini();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007578#endif
7579
Jonathan Peyton30419822017-05-12 18:01:32 +00007580 KA_TRACE(10, ("__kmp_cleanup: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007581}
7582
7583/* ------------------------------------------------------------------------ */
Jonathan Peyton30419822017-05-12 18:01:32 +00007584
7585int __kmp_ignore_mppbeg(void) {
7586 char *env;
7587
7588 if ((env = getenv("KMP_IGNORE_MPPBEG")) != NULL) {
7589 if (__kmp_str_match_false(env))
7590 return FALSE;
7591 }
7592 // By default __kmpc_begin() is no-op.
7593 return TRUE;
7594}
7595
7596int __kmp_ignore_mppend(void) {
7597 char *env;
7598
7599 if ((env = getenv("KMP_IGNORE_MPPEND")) != NULL) {
7600 if (__kmp_str_match_false(env))
7601 return FALSE;
7602 }
7603 // By default __kmpc_end() is no-op.
7604 return TRUE;
7605}
7606
7607void __kmp_internal_begin(void) {
7608 int gtid;
7609 kmp_root_t *root;
7610
7611 /* this is a very important step as it will register new sibling threads
7612 and assign these new uber threads a new gtid */
7613 gtid = __kmp_entry_gtid();
7614 root = __kmp_threads[gtid]->th.th_root;
7615 KMP_ASSERT(KMP_UBER_GTID(gtid));
7616
7617 if (root->r.r_begin)
7618 return;
7619 __kmp_acquire_lock(&root->r.r_begin_lock, gtid);
7620 if (root->r.r_begin) {
7621 __kmp_release_lock(&root->r.r_begin_lock, gtid);
7622 return;
7623 }
7624
7625 root->r.r_begin = TRUE;
7626
7627 __kmp_release_lock(&root->r.r_begin_lock, gtid);
7628}
7629
Jim Cownie5e8470a2013-09-27 10:38:44 +00007630/* ------------------------------------------------------------------------ */
7631
Jonathan Peyton30419822017-05-12 18:01:32 +00007632void __kmp_user_set_library(enum library_type arg) {
7633 int gtid;
7634 kmp_root_t *root;
7635 kmp_info_t *thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007636
Jonathan Peyton30419822017-05-12 18:01:32 +00007637 /* first, make sure we are initialized so we can get our gtid */
7638
7639 gtid = __kmp_entry_gtid();
7640 thread = __kmp_threads[gtid];
7641
7642 root = thread->th.th_root;
7643
7644 KA_TRACE(20, ("__kmp_user_set_library: enter T#%d, arg: %d, %d\n", gtid, arg,
7645 library_serial));
7646 if (root->r.r_in_parallel) { /* Must be called in serial section of top-level
7647 thread */
7648 KMP_WARNING(SetLibraryIncorrectCall);
7649 return;
7650 }
7651
7652 switch (arg) {
7653 case library_serial:
7654 thread->th.th_set_nproc = 0;
7655 set__nproc(thread, 1);
7656 break;
7657 case library_turnaround:
7658 thread->th.th_set_nproc = 0;
7659 set__nproc(thread, __kmp_dflt_team_nth ? __kmp_dflt_team_nth
7660 : __kmp_dflt_team_nth_ub);
7661 break;
7662 case library_throughput:
7663 thread->th.th_set_nproc = 0;
7664 set__nproc(thread, __kmp_dflt_team_nth ? __kmp_dflt_team_nth
7665 : __kmp_dflt_team_nth_ub);
7666 break;
7667 default:
7668 KMP_FATAL(UnknownLibraryType, arg);
7669 }
7670
7671 __kmp_aux_set_library(arg);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007672}
7673
Jonathan Peyton30419822017-05-12 18:01:32 +00007674void __kmp_aux_set_stacksize(size_t arg) {
7675 if (!__kmp_init_serial)
7676 __kmp_serial_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007677
7678#if KMP_OS_DARWIN
Jonathan Peyton30419822017-05-12 18:01:32 +00007679 if (arg & (0x1000 - 1)) {
7680 arg &= ~(0x1000 - 1);
7681 if (arg + 0x1000) /* check for overflow if we round up */
7682 arg += 0x1000;
7683 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007684#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007685 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007686
Jonathan Peyton30419822017-05-12 18:01:32 +00007687 /* only change the default stacksize before the first parallel region */
7688 if (!TCR_4(__kmp_init_parallel)) {
7689 size_t value = arg; /* argument is in bytes */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007690
Jonathan Peyton30419822017-05-12 18:01:32 +00007691 if (value < __kmp_sys_min_stksize)
7692 value = __kmp_sys_min_stksize;
7693 else if (value > KMP_MAX_STKSIZE)
7694 value = KMP_MAX_STKSIZE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007695
Jonathan Peyton30419822017-05-12 18:01:32 +00007696 __kmp_stksize = value;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007697
Jonathan Peyton30419822017-05-12 18:01:32 +00007698 __kmp_env_stksize = TRUE; /* was KMP_STACKSIZE specified? */
7699 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007700
Jonathan Peyton30419822017-05-12 18:01:32 +00007701 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007702}
7703
7704/* set the behaviour of the runtime library */
7705/* TODO this can cause some odd behaviour with sibling parallelism... */
Jonathan Peyton30419822017-05-12 18:01:32 +00007706void __kmp_aux_set_library(enum library_type arg) {
7707 __kmp_library = arg;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007708
Jonathan Peyton30419822017-05-12 18:01:32 +00007709 switch (__kmp_library) {
7710 case library_serial: {
7711 KMP_INFORM(LibraryIsSerial);
Jonathan Peyton30419822017-05-12 18:01:32 +00007712 } break;
7713 case library_turnaround:
Jonathan Peytone47d32f2019-02-28 19:11:29 +00007714 if (__kmp_use_yield == 1 && !__kmp_use_yield_exp_set)
7715 __kmp_use_yield = 2; // only yield when oversubscribed
Jonathan Peyton30419822017-05-12 18:01:32 +00007716 break;
7717 case library_throughput:
Jonathan Peytone47d32f2019-02-28 19:11:29 +00007718 if (__kmp_dflt_blocktime == KMP_MAX_BLOCKTIME)
7719 __kmp_dflt_blocktime = 200;
Jonathan Peyton30419822017-05-12 18:01:32 +00007720 break;
7721 default:
7722 KMP_FATAL(UnknownLibraryType, arg);
7723 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007724}
7725
Jonathan Peyton6d88e042018-12-13 23:14:24 +00007726/* Getting team information common for all team API */
7727// Returns NULL if not in teams construct
7728static kmp_team_t *__kmp_aux_get_team_info(int &teams_serialized) {
7729 kmp_info_t *thr = __kmp_entry_thread();
7730 teams_serialized = 0;
7731 if (thr->th.th_teams_microtask) {
7732 kmp_team_t *team = thr->th.th_team;
7733 int tlevel = thr->th.th_teams_level; // the level of the teams construct
7734 int ii = team->t.t_level;
7735 teams_serialized = team->t.t_serialized;
7736 int level = tlevel + 1;
7737 KMP_DEBUG_ASSERT(ii >= tlevel);
7738 while (ii > level) {
7739 for (teams_serialized = team->t.t_serialized;
7740 (teams_serialized > 0) && (ii > level); teams_serialized--, ii--) {
7741 }
7742 if (team->t.t_serialized && (!teams_serialized)) {
7743 team = team->t.t_parent;
7744 continue;
7745 }
7746 if (ii > level) {
7747 team = team->t.t_parent;
7748 ii--;
7749 }
7750 }
7751 return team;
7752 }
7753 return NULL;
7754}
7755
7756int __kmp_aux_get_team_num() {
7757 int serialized;
7758 kmp_team_t *team = __kmp_aux_get_team_info(serialized);
7759 if (team) {
7760 if (serialized > 1) {
7761 return 0; // teams region is serialized ( 1 team of 1 thread ).
7762 } else {
7763 return team->t.t_master_tid;
7764 }
7765 }
7766 return 0;
7767}
7768
7769int __kmp_aux_get_num_teams() {
7770 int serialized;
7771 kmp_team_t *team = __kmp_aux_get_team_info(serialized);
7772 if (team) {
7773 if (serialized > 1) {
7774 return 1;
7775 } else {
7776 return team->t.t_parent->t.t_nproc;
7777 }
7778 }
7779 return 1;
7780}
7781
7782/* ------------------------------------------------------------------------ */
7783
7784#if OMP_50_ENABLED
7785/*
7786 * Affinity Format Parser
7787 *
7788 * Field is in form of: %[[[0].]size]type
7789 * % and type are required (%% means print a literal '%')
7790 * type is either single char or long name surrounded by {},
7791 * e.g., N or {num_threads}
7792 * 0 => leading zeros
7793 * . => right justified when size is specified
7794 * by default output is left justified
7795 * size is the *minimum* field length
7796 * All other characters are printed as is
7797 *
7798 * Available field types:
7799 * L {thread_level} - omp_get_level()
7800 * n {thread_num} - omp_get_thread_num()
7801 * h {host} - name of host machine
7802 * P {process_id} - process id (integer)
7803 * T {thread_identifier} - native thread identifier (integer)
7804 * N {num_threads} - omp_get_num_threads()
7805 * A {ancestor_tnum} - omp_get_ancestor_thread_num(omp_get_level()-1)
7806 * a {thread_affinity} - comma separated list of integers or integer ranges
7807 * (values of affinity mask)
7808 *
7809 * Implementation-specific field types can be added
7810 * If a type is unknown, print "undefined"
7811*/
7812
7813// Structure holding the short name, long name, and corresponding data type
7814// for snprintf. A table of these will represent the entire valid keyword
7815// field types.
7816typedef struct kmp_affinity_format_field_t {
7817 char short_name; // from spec e.g., L -> thread level
7818 const char *long_name; // from spec thread_level -> thread level
7819 char field_format; // data type for snprintf (typically 'd' or 's'
7820 // for integer or string)
7821} kmp_affinity_format_field_t;
7822
7823static const kmp_affinity_format_field_t __kmp_affinity_format_table[] = {
7824#if KMP_AFFINITY_SUPPORTED
7825 {'A', "thread_affinity", 's'},
7826#endif
7827 {'t', "team_num", 'd'},
7828 {'T', "num_teams", 'd'},
7829 {'L', "nesting_level", 'd'},
7830 {'n', "thread_num", 'd'},
7831 {'N', "num_threads", 'd'},
7832 {'a', "ancestor_tnum", 'd'},
7833 {'H', "host", 's'},
7834 {'P', "process_id", 'd'},
7835 {'i', "native_thread_id", 'd'}};
7836
7837// Return the number of characters it takes to hold field
7838static int __kmp_aux_capture_affinity_field(int gtid, const kmp_info_t *th,
7839 const char **ptr,
7840 kmp_str_buf_t *field_buffer) {
7841 int rc, format_index, field_value;
7842 const char *width_left, *width_right;
7843 bool pad_zeros, right_justify, parse_long_name, found_valid_name;
7844 static const int FORMAT_SIZE = 20;
7845 char format[FORMAT_SIZE] = {0};
7846 char absolute_short_name = 0;
7847
7848 KMP_DEBUG_ASSERT(gtid >= 0);
7849 KMP_DEBUG_ASSERT(th);
7850 KMP_DEBUG_ASSERT(**ptr == '%');
7851 KMP_DEBUG_ASSERT(field_buffer);
7852
7853 __kmp_str_buf_clear(field_buffer);
7854
7855 // Skip the initial %
7856 (*ptr)++;
7857
7858 // Check for %% first
7859 if (**ptr == '%') {
7860 __kmp_str_buf_cat(field_buffer, "%", 1);
7861 (*ptr)++; // skip over the second %
7862 return 1;
7863 }
7864
7865 // Parse field modifiers if they are present
7866 pad_zeros = false;
7867 if (**ptr == '0') {
7868 pad_zeros = true;
7869 (*ptr)++; // skip over 0
7870 }
7871 right_justify = false;
7872 if (**ptr == '.') {
7873 right_justify = true;
7874 (*ptr)++; // skip over .
7875 }
7876 // Parse width of field: [width_left, width_right)
7877 width_left = width_right = NULL;
7878 if (**ptr >= '0' && **ptr <= '9') {
7879 width_left = *ptr;
7880 SKIP_DIGITS(*ptr);
7881 width_right = *ptr;
7882 }
7883
7884 // Create the format for KMP_SNPRINTF based on flags parsed above
7885 format_index = 0;
7886 format[format_index++] = '%';
7887 if (!right_justify)
7888 format[format_index++] = '-';
7889 if (pad_zeros)
7890 format[format_index++] = '0';
7891 if (width_left && width_right) {
7892 int i = 0;
7893 // Only allow 8 digit number widths.
7894 // This also prevents overflowing format variable
7895 while (i < 8 && width_left < width_right) {
7896 format[format_index++] = *width_left;
7897 width_left++;
7898 i++;
7899 }
7900 }
7901
7902 // Parse a name (long or short)
7903 // Canonicalize the name into absolute_short_name
7904 found_valid_name = false;
7905 parse_long_name = (**ptr == '{');
7906 if (parse_long_name)
7907 (*ptr)++; // skip initial left brace
7908 for (size_t i = 0; i < sizeof(__kmp_affinity_format_table) /
7909 sizeof(__kmp_affinity_format_table[0]);
7910 ++i) {
7911 char short_name = __kmp_affinity_format_table[i].short_name;
7912 const char *long_name = __kmp_affinity_format_table[i].long_name;
7913 char field_format = __kmp_affinity_format_table[i].field_format;
7914 if (parse_long_name) {
7915 int length = KMP_STRLEN(long_name);
7916 if (strncmp(*ptr, long_name, length) == 0) {
7917 found_valid_name = true;
7918 (*ptr) += length; // skip the long name
7919 }
7920 } else if (**ptr == short_name) {
7921 found_valid_name = true;
7922 (*ptr)++; // skip the short name
7923 }
7924 if (found_valid_name) {
7925 format[format_index++] = field_format;
7926 format[format_index++] = '\0';
7927 absolute_short_name = short_name;
7928 break;
7929 }
7930 }
7931 if (parse_long_name) {
7932 if (**ptr != '}') {
7933 absolute_short_name = 0;
7934 } else {
7935 (*ptr)++; // skip over the right brace
7936 }
7937 }
7938
7939 // Attempt to fill the buffer with the requested
7940 // value using snprintf within __kmp_str_buf_print()
7941 switch (absolute_short_name) {
7942 case 't':
7943 rc = __kmp_str_buf_print(field_buffer, format, __kmp_aux_get_team_num());
7944 break;
7945 case 'T':
7946 rc = __kmp_str_buf_print(field_buffer, format, __kmp_aux_get_num_teams());
7947 break;
7948 case 'L':
7949 rc = __kmp_str_buf_print(field_buffer, format, th->th.th_team->t.t_level);
7950 break;
7951 case 'n':
7952 rc = __kmp_str_buf_print(field_buffer, format, __kmp_tid_from_gtid(gtid));
7953 break;
7954 case 'H': {
7955 static const int BUFFER_SIZE = 256;
7956 char buf[BUFFER_SIZE];
7957 __kmp_expand_host_name(buf, BUFFER_SIZE);
7958 rc = __kmp_str_buf_print(field_buffer, format, buf);
7959 } break;
7960 case 'P':
7961 rc = __kmp_str_buf_print(field_buffer, format, getpid());
7962 break;
7963 case 'i':
7964 rc = __kmp_str_buf_print(field_buffer, format, __kmp_gettid());
7965 break;
7966 case 'N':
7967 rc = __kmp_str_buf_print(field_buffer, format, th->th.th_team->t.t_nproc);
7968 break;
7969 case 'a':
7970 field_value =
7971 __kmp_get_ancestor_thread_num(gtid, th->th.th_team->t.t_level - 1);
7972 rc = __kmp_str_buf_print(field_buffer, format, field_value);
7973 break;
7974#if KMP_AFFINITY_SUPPORTED
7975 case 'A': {
7976 kmp_str_buf_t buf;
7977 __kmp_str_buf_init(&buf);
7978 __kmp_affinity_str_buf_mask(&buf, th->th.th_affin_mask);
7979 rc = __kmp_str_buf_print(field_buffer, format, buf.str);
7980 __kmp_str_buf_free(&buf);
7981 } break;
7982#endif
7983 default:
7984 // According to spec, If an implementation does not have info for field
7985 // type, then "undefined" is printed
7986 rc = __kmp_str_buf_print(field_buffer, "%s", "undefined");
7987 // Skip the field
7988 if (parse_long_name) {
7989 SKIP_TOKEN(*ptr);
7990 if (**ptr == '}')
7991 (*ptr)++;
7992 } else {
7993 (*ptr)++;
7994 }
7995 }
7996
7997 KMP_ASSERT(format_index <= FORMAT_SIZE);
7998 return rc;
7999}
8000
8001/*
8002 * Return number of characters needed to hold the affinity string
8003 * (not including null byte character)
8004 * The resultant string is printed to buffer, which the caller can then
8005 * handle afterwards
8006*/
8007size_t __kmp_aux_capture_affinity(int gtid, const char *format,
8008 kmp_str_buf_t *buffer) {
8009 const char *parse_ptr;
8010 size_t retval;
8011 const kmp_info_t *th;
8012 kmp_str_buf_t field;
8013
8014 KMP_DEBUG_ASSERT(buffer);
8015 KMP_DEBUG_ASSERT(gtid >= 0);
8016
8017 __kmp_str_buf_init(&field);
8018 __kmp_str_buf_clear(buffer);
8019
8020 th = __kmp_threads[gtid];
8021 retval = 0;
8022
8023 // If format is NULL or zero-length string, then we use
8024 // affinity-format-var ICV
8025 parse_ptr = format;
8026 if (parse_ptr == NULL || *parse_ptr == '\0') {
8027 parse_ptr = __kmp_affinity_format;
8028 }
8029 KMP_DEBUG_ASSERT(parse_ptr);
8030
8031 while (*parse_ptr != '\0') {
8032 // Parse a field
8033 if (*parse_ptr == '%') {
8034 // Put field in the buffer
8035 int rc = __kmp_aux_capture_affinity_field(gtid, th, &parse_ptr, &field);
8036 __kmp_str_buf_catbuf(buffer, &field);
8037 retval += rc;
8038 } else {
8039 // Put literal character in buffer
8040 __kmp_str_buf_cat(buffer, parse_ptr, 1);
8041 retval++;
8042 parse_ptr++;
8043 }
8044 }
8045 __kmp_str_buf_free(&field);
8046 return retval;
8047}
8048
8049// Displays the affinity string to stdout
8050void __kmp_aux_display_affinity(int gtid, const char *format) {
8051 kmp_str_buf_t buf;
8052 __kmp_str_buf_init(&buf);
8053 __kmp_aux_capture_affinity(gtid, format, &buf);
8054 __kmp_fprintf(kmp_out, "%s" KMP_END_OF_LINE, buf.str);
8055 __kmp_str_buf_free(&buf);
8056}
8057#endif // OMP_50_ENABLED
8058
Jim Cownie5e8470a2013-09-27 10:38:44 +00008059/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00008060
Jonathan Peyton30419822017-05-12 18:01:32 +00008061void __kmp_aux_set_blocktime(int arg, kmp_info_t *thread, int tid) {
8062 int blocktime = arg; /* argument is in milliseconds */
Jonathan Peytone1c7c132016-10-07 18:12:19 +00008063#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00008064 int bt_intervals;
Jonathan Peytone1c7c132016-10-07 18:12:19 +00008065#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00008066 int bt_set;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008067
Jonathan Peyton30419822017-05-12 18:01:32 +00008068 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00008069
Jonathan Peyton30419822017-05-12 18:01:32 +00008070 /* Normalize and set blocktime for the teams */
8071 if (blocktime < KMP_MIN_BLOCKTIME)
8072 blocktime = KMP_MIN_BLOCKTIME;
8073 else if (blocktime > KMP_MAX_BLOCKTIME)
8074 blocktime = KMP_MAX_BLOCKTIME;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008075
Jonathan Peyton30419822017-05-12 18:01:32 +00008076 set__blocktime_team(thread->th.th_team, tid, blocktime);
8077 set__blocktime_team(thread->th.th_serial_team, 0, blocktime);
Jim Cownie5e8470a2013-09-27 10:38:44 +00008078
Jonathan Peytone1c7c132016-10-07 18:12:19 +00008079#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00008080 /* Calculate and set blocktime intervals for the teams */
8081 bt_intervals = KMP_INTERVALS_FROM_BLOCKTIME(blocktime, __kmp_monitor_wakeups);
Jim Cownie5e8470a2013-09-27 10:38:44 +00008082
Jonathan Peyton30419822017-05-12 18:01:32 +00008083 set__bt_intervals_team(thread->th.th_team, tid, bt_intervals);
8084 set__bt_intervals_team(thread->th.th_serial_team, 0, bt_intervals);
Jonathan Peytone1c7c132016-10-07 18:12:19 +00008085#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00008086
Jonathan Peyton30419822017-05-12 18:01:32 +00008087 /* Set whether blocktime has been set to "TRUE" */
8088 bt_set = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008089
Jonathan Peyton30419822017-05-12 18:01:32 +00008090 set__bt_set_team(thread->th.th_team, tid, bt_set);
8091 set__bt_set_team(thread->th.th_serial_team, 0, bt_set);
Jonathan Peytone1c7c132016-10-07 18:12:19 +00008092#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00008093 KF_TRACE(10, ("kmp_set_blocktime: T#%d(%d:%d), blocktime=%d, "
8094 "bt_intervals=%d, monitor_updates=%d\n",
8095 __kmp_gtid_from_tid(tid, thread->th.th_team),
8096 thread->th.th_team->t.t_id, tid, blocktime, bt_intervals,
8097 __kmp_monitor_wakeups));
Samuel Antao33515192016-10-20 13:20:17 +00008098#else
Jonathan Peyton30419822017-05-12 18:01:32 +00008099 KF_TRACE(10, ("kmp_set_blocktime: T#%d(%d:%d), blocktime=%d\n",
8100 __kmp_gtid_from_tid(tid, thread->th.th_team),
8101 thread->th.th_team->t.t_id, tid, blocktime));
Jonathan Peytone1c7c132016-10-07 18:12:19 +00008102#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00008103}
8104
Jonathan Peyton30419822017-05-12 18:01:32 +00008105void __kmp_aux_set_defaults(char const *str, int len) {
8106 if (!__kmp_init_serial) {
8107 __kmp_serial_initialize();
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00008108 }
Jonathan Peyton30419822017-05-12 18:01:32 +00008109 __kmp_env_initialize(str);
Jim Cownie5e8470a2013-09-27 10:38:44 +00008110
Jonathan Peyton30419822017-05-12 18:01:32 +00008111 if (__kmp_settings
Jim Cownie5e8470a2013-09-27 10:38:44 +00008112#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00008113 || __kmp_display_env || __kmp_display_env_verbose
Jim Cownie5e8470a2013-09-27 10:38:44 +00008114#endif // OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00008115 ) {
8116 __kmp_env_print();
8117 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00008118} // __kmp_aux_set_defaults
8119
8120/* ------------------------------------------------------------------------ */
Jonathan Peyton30419822017-05-12 18:01:32 +00008121/* internal fast reduction routines */
Jim Cownie5e8470a2013-09-27 10:38:44 +00008122
Jim Cownie5e8470a2013-09-27 10:38:44 +00008123PACKED_REDUCTION_METHOD_T
Jonathan Peyton30419822017-05-12 18:01:32 +00008124__kmp_determine_reduction_method(
8125 ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
8126 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
8127 kmp_critical_name *lck) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00008128
Jonathan Peyton30419822017-05-12 18:01:32 +00008129 // Default reduction method: critical construct ( lck != NULL, like in current
8130 // PAROPT )
8131 // If ( reduce_data!=NULL && reduce_func!=NULL ): the tree-reduction method
8132 // can be selected by RTL
8133 // If loc->flags contains KMP_IDENT_ATOMIC_REDUCE, the atomic reduce method
8134 // can be selected by RTL
8135 // Finally, it's up to OpenMP RTL to make a decision on which method to select
8136 // among generated by PAROPT.
Jim Cownie5e8470a2013-09-27 10:38:44 +00008137
Jonathan Peyton30419822017-05-12 18:01:32 +00008138 PACKED_REDUCTION_METHOD_T retval;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008139
Jonathan Peyton30419822017-05-12 18:01:32 +00008140 int team_size;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008141
Jonathan Peyton30419822017-05-12 18:01:32 +00008142 KMP_DEBUG_ASSERT(loc); // it would be nice to test ( loc != 0 )
8143 KMP_DEBUG_ASSERT(lck); // it would be nice to test ( lck != 0 )
Jim Cownie5e8470a2013-09-27 10:38:44 +00008144
Jonathan Peyton30419822017-05-12 18:01:32 +00008145#define FAST_REDUCTION_ATOMIC_METHOD_GENERATED \
8146 ((loc->flags & (KMP_IDENT_ATOMIC_REDUCE)) == (KMP_IDENT_ATOMIC_REDUCE))
8147#define FAST_REDUCTION_TREE_METHOD_GENERATED ((reduce_data) && (reduce_func))
Jim Cownie5e8470a2013-09-27 10:38:44 +00008148
Jonathan Peyton30419822017-05-12 18:01:32 +00008149 retval = critical_reduce_block;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008150
Jonathan Peyton30419822017-05-12 18:01:32 +00008151 // another choice of getting a team size (with 1 dynamic deference) is slower
8152 team_size = __kmp_get_team_num_threads(global_tid);
8153 if (team_size == 1) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00008154
Jonathan Peyton30419822017-05-12 18:01:32 +00008155 retval = empty_reduce_block;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008156
Jonathan Peyton30419822017-05-12 18:01:32 +00008157 } else {
Jim Cownie5e8470a2013-09-27 10:38:44 +00008158
Jonathan Peyton30419822017-05-12 18:01:32 +00008159 int atomic_available = FAST_REDUCTION_ATOMIC_METHOD_GENERATED;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008160
Jonathan Peyton30419822017-05-12 18:01:32 +00008161#if KMP_ARCH_X86_64 || KMP_ARCH_PPC64 || KMP_ARCH_AARCH64 || KMP_ARCH_MIPS64
Jim Cownie5e8470a2013-09-27 10:38:44 +00008162
Kamil Rytarowskia56ac942018-12-09 16:40:33 +00008163#if KMP_OS_LINUX || KMP_OS_DRAGONFLY || KMP_OS_FREEBSD || KMP_OS_NETBSD || \
Kamil Rytarowski7e1ea992018-12-09 16:46:48 +00008164 KMP_OS_OPENBSD || KMP_OS_WINDOWS || KMP_OS_DARWIN || KMP_OS_HURD
Jim Cownie5e8470a2013-09-27 10:38:44 +00008165
Jonathan Peyton30419822017-05-12 18:01:32 +00008166 int teamsize_cutoff = 4;
Jonathan Peyton91b78702015-06-08 19:39:07 +00008167
Jonathan Peyton492e0a32017-06-13 17:17:26 +00008168#if KMP_MIC_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00008169 if (__kmp_mic_type != non_mic) {
8170 teamsize_cutoff = 8;
8171 }
Andrey Churbanov613edeb2015-02-20 18:14:43 +00008172#endif
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00008173 int tree_available = FAST_REDUCTION_TREE_METHOD_GENERATED;
Jonathan Peyton30419822017-05-12 18:01:32 +00008174 if (tree_available) {
8175 if (team_size <= teamsize_cutoff) {
8176 if (atomic_available) {
8177 retval = atomic_reduce_block;
Jim Cownie5e8470a2013-09-27 10:38:44 +00008178 }
Jonathan Peyton30419822017-05-12 18:01:32 +00008179 } else {
8180 retval = TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER;
8181 }
8182 } else if (atomic_available) {
8183 retval = atomic_reduce_block;
8184 }
8185#else
8186#error "Unknown or unsupported OS"
Jonathan Peyton17e53b92018-12-10 18:26:50 +00008187#endif // KMP_OS_LINUX || KMP_OS_DRAGONFLY || KMP_OS_FREEBSD || KMP_OS_NETBSD ||
8188 // KMP_OS_OPENBSD || KMP_OS_WINDOWS || KMP_OS_DARWIN || KMP_OS_HURD
Jim Cownie5e8470a2013-09-27 10:38:44 +00008189
Jonathan Peyton30419822017-05-12 18:01:32 +00008190#elif KMP_ARCH_X86 || KMP_ARCH_ARM || KMP_ARCH_AARCH || KMP_ARCH_MIPS
8191
Andrey Churbanov855d0982018-11-07 12:27:38 +00008192#if KMP_OS_LINUX || KMP_OS_WINDOWS || KMP_OS_HURD
Jonathan Peyton30419822017-05-12 18:01:32 +00008193
8194 // basic tuning
8195
8196 if (atomic_available) {
8197 if (num_vars <= 2) { // && ( team_size <= 8 ) due to false-sharing ???
8198 retval = atomic_reduce_block;
8199 }
8200 } // otherwise: use critical section
8201
8202#elif KMP_OS_DARWIN
8203
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00008204 int tree_available = FAST_REDUCTION_TREE_METHOD_GENERATED;
Jonathan Peyton30419822017-05-12 18:01:32 +00008205 if (atomic_available && (num_vars <= 3)) {
8206 retval = atomic_reduce_block;
8207 } else if (tree_available) {
8208 if ((reduce_size > (9 * sizeof(kmp_real64))) &&
8209 (reduce_size < (2000 * sizeof(kmp_real64)))) {
8210 retval = TREE_REDUCE_BLOCK_WITH_PLAIN_BARRIER;
8211 }
8212 } // otherwise: use critical section
8213
8214#else
8215#error "Unknown or unsupported OS"
8216#endif
8217
8218#else
8219#error "Unknown or unsupported architecture"
8220#endif
8221 }
8222
8223 // KMP_FORCE_REDUCTION
8224
8225 // If the team is serialized (team_size == 1), ignore the forced reduction
8226 // method and stay with the unsynchronized method (empty_reduce_block)
8227 if (__kmp_force_reduction_method != reduction_method_not_defined &&
8228 team_size != 1) {
8229
8230 PACKED_REDUCTION_METHOD_T forced_retval = critical_reduce_block;
8231
8232 int atomic_available, tree_available;
8233
8234 switch ((forced_retval = __kmp_force_reduction_method)) {
8235 case critical_reduce_block:
8236 KMP_ASSERT(lck); // lck should be != 0
8237 break;
8238
8239 case atomic_reduce_block:
8240 atomic_available = FAST_REDUCTION_ATOMIC_METHOD_GENERATED;
8241 if (!atomic_available) {
8242 KMP_WARNING(RedMethodNotSupported, "atomic");
8243 forced_retval = critical_reduce_block;
8244 }
8245 break;
8246
8247 case tree_reduce_block:
8248 tree_available = FAST_REDUCTION_TREE_METHOD_GENERATED;
8249 if (!tree_available) {
8250 KMP_WARNING(RedMethodNotSupported, "tree");
8251 forced_retval = critical_reduce_block;
8252 } else {
8253#if KMP_FAST_REDUCTION_BARRIER
8254 forced_retval = TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER;
8255#endif
8256 }
8257 break;
8258
8259 default:
8260 KMP_ASSERT(0); // "unsupported method specified"
Jim Cownie5e8470a2013-09-27 10:38:44 +00008261 }
8262
Jonathan Peyton30419822017-05-12 18:01:32 +00008263 retval = forced_retval;
8264 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00008265
Jonathan Peyton30419822017-05-12 18:01:32 +00008266 KA_TRACE(10, ("reduction method selected=%08x\n", retval));
Jim Cownie5e8470a2013-09-27 10:38:44 +00008267
Jonathan Peyton30419822017-05-12 18:01:32 +00008268#undef FAST_REDUCTION_TREE_METHOD_GENERATED
8269#undef FAST_REDUCTION_ATOMIC_METHOD_GENERATED
8270
8271 return (retval);
Jim Cownie5e8470a2013-09-27 10:38:44 +00008272}
8273
8274// this function is for testing set/get/determine reduce method
Jonathan Peyton30419822017-05-12 18:01:32 +00008275kmp_int32 __kmp_get_reduce_method(void) {
8276 return ((__kmp_entry_thread()->th.th_local.packed_reduction_method) >> 8);
Jim Cownie5e8470a2013-09-27 10:38:44 +00008277}
Jonathan Peyton9b8bb322019-01-16 20:07:39 +00008278
8279#if OMP_50_ENABLED
8280
8281// Soft pause sets up threads to ignore blocktime and just go to sleep.
8282// Spin-wait code checks __kmp_pause_status and reacts accordingly.
8283void __kmp_soft_pause() { __kmp_pause_status = kmp_soft_paused; }
8284
8285// Hard pause shuts down the runtime completely. Resume happens naturally when
8286// OpenMP is used subsequently.
8287void __kmp_hard_pause() {
8288 __kmp_pause_status = kmp_hard_paused;
8289 __kmp_internal_end_thread(-1);
8290}
8291
8292// Soft resume sets __kmp_pause_status, and wakes up all threads.
8293void __kmp_resume_if_soft_paused() {
8294 if (__kmp_pause_status == kmp_soft_paused) {
8295 __kmp_pause_status = kmp_not_paused;
8296
8297 for (int gtid = 1; gtid < __kmp_threads_capacity; ++gtid) {
8298 kmp_info_t *thread = __kmp_threads[gtid];
8299 if (thread) { // Wake it if sleeping
8300 kmp_flag_64 fl(&thread->th.th_bar[bs_forkjoin_barrier].bb.b_go, thread);
8301 if (fl.is_sleeping())
8302 fl.resume(gtid);
8303 else if (__kmp_try_suspend_mx(thread)) { // got suspend lock
8304 __kmp_unlock_suspend_mx(thread); // unlock it; it won't sleep
8305 } else { // thread holds the lock and may sleep soon
8306 do { // until either the thread sleeps, or we can get the lock
8307 if (fl.is_sleeping()) {
8308 fl.resume(gtid);
8309 break;
8310 } else if (__kmp_try_suspend_mx(thread)) {
8311 __kmp_unlock_suspend_mx(thread);
8312 break;
8313 }
8314 } while (1);
8315 }
8316 }
8317 }
8318 }
8319}
8320
8321// This function is called via __kmpc_pause_resource. Returns 0 if successful.
8322// TODO: add warning messages
8323int __kmp_pause_resource(kmp_pause_status_t level) {
8324 if (level == kmp_not_paused) { // requesting resume
8325 if (__kmp_pause_status == kmp_not_paused) {
8326 // error message about runtime not being paused, so can't resume
8327 return 1;
8328 } else {
8329 KMP_DEBUG_ASSERT(__kmp_pause_status == kmp_soft_paused ||
8330 __kmp_pause_status == kmp_hard_paused);
8331 __kmp_pause_status = kmp_not_paused;
8332 return 0;
8333 }
8334 } else if (level == kmp_soft_paused) { // requesting soft pause
8335 if (__kmp_pause_status != kmp_not_paused) {
8336 // error message about already being paused
8337 return 1;
8338 } else {
8339 __kmp_soft_pause();
8340 return 0;
8341 }
8342 } else if (level == kmp_hard_paused) { // requesting hard pause
8343 if (__kmp_pause_status != kmp_not_paused) {
8344 // error message about already being paused
8345 return 1;
8346 } else {
8347 __kmp_hard_pause();
8348 return 0;
8349 }
8350 } else {
8351 // error message about invalid level
8352 return 1;
8353 }
8354}
8355
8356#endif // OMP_50_ENABLED