blob: 01dd4b9601c106dc552b7848ea2b3ec8de556d87 [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//
7// The LLVM Compiler Infrastructure
8//
9// This file is dual licensed under the MIT and the University of Illinois Open
10// Source Licenses. See LICENSE.txt for details.
11//
12//===----------------------------------------------------------------------===//
13
Jim Cownie5e8470a2013-09-27 10:38:44 +000014#include "kmp.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000015#include "kmp_affinity.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000016#include "kmp_atomic.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000017#include "kmp_environment.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000018#include "kmp_error.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000019#include "kmp_i18n.h"
20#include "kmp_io.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000021#include "kmp_itt.h"
22#include "kmp_settings.h"
Jim Cownie4cc4bb42014-10-07 16:25:50 +000023#include "kmp_stats.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000024#include "kmp_str.h"
Jim Cownie4cc4bb42014-10-07 16:25:50 +000025#include "kmp_wait_release.h"
Jonathan Peyton30419822017-05-12 18:01:32 +000026#include "kmp_wrapper_getpid.h"
Jonathan Peytonf6399362018-07-09 17:51:13 +000027#include "kmp_dispatch.h"
28#if KMP_USE_HIER_SCHED
29#include "kmp_dispatch_hier.h"
30#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +000031
Andrey Churbanovd7d088f2015-04-29 16:42:24 +000032#if OMPT_SUPPORT
33#include "ompt-specific.h"
34#endif
35
Jim Cownie5e8470a2013-09-27 10:38:44 +000036/* these are temporary issues to be dealt with */
37#define KMP_USE_PRCTL 0
Jim Cownie5e8470a2013-09-27 10:38:44 +000038
Jim Cownie5e8470a2013-09-27 10:38:44 +000039#if KMP_OS_WINDOWS
40#include <process.h>
41#endif
42
Jonas Hahnfeld50fed042016-11-07 15:58:36 +000043#include "tsan_annotations.h"
Jim Cownie5e8470a2013-09-27 10:38:44 +000044
45#if defined(KMP_GOMP_COMPAT)
Jonathan Peyton30419822017-05-12 18:01:32 +000046char const __kmp_version_alt_comp[] =
47 KMP_VERSION_PREFIX "alternative compiler support: yes";
Jim Cownie5e8470a2013-09-27 10:38:44 +000048#endif /* defined(KMP_GOMP_COMPAT) */
49
50char const __kmp_version_omp_api[] = KMP_VERSION_PREFIX "API version: "
Jonathan Peytone844a542017-03-06 22:07:40 +000051#if OMP_50_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +000052 "5.0 (201611)";
Jonathan Peytone844a542017-03-06 22:07:40 +000053#elif OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +000054 "4.5 (201511)";
Jonathan Peyton74f3ffc2016-09-30 15:50:14 +000055#elif OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +000056 "4.0 (201307)";
Jim Cownie5e8470a2013-09-27 10:38:44 +000057#else
Jonathan Peyton30419822017-05-12 18:01:32 +000058 "3.1 (201107)";
Jim Cownie5e8470a2013-09-27 10:38:44 +000059#endif
60
61#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +000062char const __kmp_version_lock[] =
63 KMP_VERSION_PREFIX "lock type: run time selectable";
Jim Cownie5e8470a2013-09-27 10:38:44 +000064#endif /* KMP_DEBUG */
65
Jonathan Peyton30419822017-05-12 18:01:32 +000066#define KMP_MIN(x, y) ((x) < (y) ? (x) : (y))
Jim Cownie181b4bb2013-12-23 17:28:57 +000067
Jim Cownie5e8470a2013-09-27 10:38:44 +000068/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +000069
Jonathan Peyton37e2ef52018-07-09 17:36:22 +000070#if KMP_USE_MONITOR
Jim Cownie5e8470a2013-09-27 10:38:44 +000071kmp_info_t __kmp_monitor;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +000072#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +000073
Jim Cownie5e8470a2013-09-27 10:38:44 +000074/* Forward declarations */
75
Jonathan Peyton30419822017-05-12 18:01:32 +000076void __kmp_cleanup(void);
Jim Cownie5e8470a2013-09-27 10:38:44 +000077
Jonathan Peyton30419822017-05-12 18:01:32 +000078static void __kmp_initialize_info(kmp_info_t *, kmp_team_t *, int tid,
79 int gtid);
80static void __kmp_initialize_team(kmp_team_t *team, int new_nproc,
81 kmp_internal_control_t *new_icvs,
82 ident_t *loc);
Jonathan Peyton2321d572015-06-08 19:25:25 +000083#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +000084static void __kmp_partition_places(kmp_team_t *team,
85 int update_master_only = 0);
Jonathan Peyton2321d572015-06-08 19:25:25 +000086#endif
Jonathan Peyton30419822017-05-12 18:01:32 +000087static void __kmp_do_serial_initialize(void);
88void __kmp_fork_barrier(int gtid, int tid);
89void __kmp_join_barrier(int gtid);
90void __kmp_setup_icv_copy(kmp_team_t *team, int new_nproc,
91 kmp_internal_control_t *new_icvs, ident_t *loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +000092
Jim Cownie5e8470a2013-09-27 10:38:44 +000093#ifdef USE_LOAD_BALANCE
Jonathan Peyton30419822017-05-12 18:01:32 +000094static int __kmp_load_balance_nproc(kmp_root_t *root, int set_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +000095#endif
96
Jonathan Peyton1800ece2018-01-10 18:27:01 +000097static int __kmp_expand_threads(int nNeed);
Jonathan Peyton2321d572015-06-08 19:25:25 +000098#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +000099static int __kmp_unregister_root_other_thread(int gtid);
Jonathan Peyton2321d572015-06-08 19:25:25 +0000100#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000101static void __kmp_unregister_library(void); // called by __kmp_internal_end()
102static void __kmp_reap_thread(kmp_info_t *thread, int is_root);
Jonathan Peytoneaa9e402018-01-10 18:21:48 +0000103kmp_info_t *__kmp_thread_pool_insert_pt = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000104
Jim Cownie5e8470a2013-09-27 10:38:44 +0000105/* Calculate the identifier of the current thread */
Jonathan Peyton30419822017-05-12 18:01:32 +0000106/* fast (and somewhat portable) way to get unique identifier of executing
107 thread. Returns KMP_GTID_DNE if we haven't been assigned a gtid. */
Jonathan Peyton30419822017-05-12 18:01:32 +0000108int __kmp_get_global_thread_id() {
109 int i;
110 kmp_info_t **other_threads;
111 size_t stack_data;
112 char *stack_addr;
113 size_t stack_size;
114 char *stack_base;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000115
Jonathan Peyton30419822017-05-12 18:01:32 +0000116 KA_TRACE(
117 1000,
118 ("*** __kmp_get_global_thread_id: entering, nproc=%d all_nproc=%d\n",
119 __kmp_nth, __kmp_all_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +0000120
Jonathan Peyton30419822017-05-12 18:01:32 +0000121 /* JPH - to handle the case where __kmpc_end(0) is called immediately prior to
122 a parallel region, made it return KMP_GTID_DNE to force serial_initialize
123 by caller. Had to handle KMP_GTID_DNE at all call-sites, or else guarantee
124 __kmp_init_gtid for this to work. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000125
Jonathan Peyton30419822017-05-12 18:01:32 +0000126 if (!TCR_4(__kmp_init_gtid))
127 return KMP_GTID_DNE;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000128
129#ifdef KMP_TDATA_GTID
Jonathan Peyton30419822017-05-12 18:01:32 +0000130 if (TCR_4(__kmp_gtid_mode) >= 3) {
131 KA_TRACE(1000, ("*** __kmp_get_global_thread_id: using TDATA\n"));
132 return __kmp_gtid;
133 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000134#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000135 if (TCR_4(__kmp_gtid_mode) >= 2) {
136 KA_TRACE(1000, ("*** __kmp_get_global_thread_id: using keyed TLS\n"));
137 return __kmp_gtid_get_specific();
138 }
139 KA_TRACE(1000, ("*** __kmp_get_global_thread_id: using internal alg.\n"));
140
141 stack_addr = (char *)&stack_data;
142 other_threads = __kmp_threads;
143
144 /* ATT: The code below is a source of potential bugs due to unsynchronized
145 access to __kmp_threads array. For example:
146 1. Current thread loads other_threads[i] to thr and checks it, it is
147 non-NULL.
148 2. Current thread is suspended by OS.
149 3. Another thread unregisters and finishes (debug versions of free()
150 may fill memory with something like 0xEF).
151 4. Current thread is resumed.
152 5. Current thread reads junk from *thr.
153 TODO: Fix it. --ln */
154
155 for (i = 0; i < __kmp_threads_capacity; i++) {
156
157 kmp_info_t *thr = (kmp_info_t *)TCR_SYNC_PTR(other_threads[i]);
158 if (!thr)
159 continue;
160
161 stack_size = (size_t)TCR_PTR(thr->th.th_info.ds.ds_stacksize);
162 stack_base = (char *)TCR_PTR(thr->th.th_info.ds.ds_stackbase);
163
164 /* stack grows down -- search through all of the active threads */
165
166 if (stack_addr <= stack_base) {
167 size_t stack_diff = stack_base - stack_addr;
168
169 if (stack_diff <= stack_size) {
170 /* The only way we can be closer than the allocated */
171 /* stack size is if we are running on this thread. */
172 KMP_DEBUG_ASSERT(__kmp_gtid_get_specific() == i);
173 return i;
174 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000175 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000176 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000177
Jonathan Peyton30419822017-05-12 18:01:32 +0000178 /* get specific to try and determine our gtid */
179 KA_TRACE(1000,
180 ("*** __kmp_get_global_thread_id: internal alg. failed to find "
181 "thread, using TLS\n"));
182 i = __kmp_gtid_get_specific();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000183
Jonathan Peyton30419822017-05-12 18:01:32 +0000184 /*fprintf( stderr, "=== %d\n", i ); */ /* GROO */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000185
Jonathan Peyton30419822017-05-12 18:01:32 +0000186 /* if we havn't been assigned a gtid, then return code */
187 if (i < 0)
Jim Cownie5e8470a2013-09-27 10:38:44 +0000188 return i;
Jonathan Peyton30419822017-05-12 18:01:32 +0000189
190 /* dynamically updated stack window for uber threads to avoid get_specific
191 call */
192 if (!TCR_4(other_threads[i]->th.th_info.ds.ds_stackgrow)) {
193 KMP_FATAL(StackOverflow, i);
194 }
195
196 stack_base = (char *)other_threads[i]->th.th_info.ds.ds_stackbase;
197 if (stack_addr > stack_base) {
198 TCW_PTR(other_threads[i]->th.th_info.ds.ds_stackbase, stack_addr);
199 TCW_PTR(other_threads[i]->th.th_info.ds.ds_stacksize,
200 other_threads[i]->th.th_info.ds.ds_stacksize + stack_addr -
201 stack_base);
202 } else {
203 TCW_PTR(other_threads[i]->th.th_info.ds.ds_stacksize,
204 stack_base - stack_addr);
205 }
206
207 /* Reprint stack bounds for ubermaster since they have been refined */
208 if (__kmp_storage_map) {
209 char *stack_end = (char *)other_threads[i]->th.th_info.ds.ds_stackbase;
210 char *stack_beg = stack_end - other_threads[i]->th.th_info.ds.ds_stacksize;
211 __kmp_print_storage_map_gtid(i, stack_beg, stack_end,
212 other_threads[i]->th.th_info.ds.ds_stacksize,
213 "th_%d stack (refinement)", i);
214 }
215 return i;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000216}
217
Jonathan Peyton30419822017-05-12 18:01:32 +0000218int __kmp_get_global_thread_id_reg() {
219 int gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000220
Jonathan Peyton30419822017-05-12 18:01:32 +0000221 if (!__kmp_init_serial) {
222 gtid = KMP_GTID_DNE;
223 } else
Jim Cownie5e8470a2013-09-27 10:38:44 +0000224#ifdef KMP_TDATA_GTID
Jonathan Peyton30419822017-05-12 18:01:32 +0000225 if (TCR_4(__kmp_gtid_mode) >= 3) {
226 KA_TRACE(1000, ("*** __kmp_get_global_thread_id_reg: using TDATA\n"));
227 gtid = __kmp_gtid;
228 } else
Jim Cownie5e8470a2013-09-27 10:38:44 +0000229#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000230 if (TCR_4(__kmp_gtid_mode) >= 2) {
231 KA_TRACE(1000, ("*** __kmp_get_global_thread_id_reg: using keyed TLS\n"));
232 gtid = __kmp_gtid_get_specific();
233 } else {
234 KA_TRACE(1000,
235 ("*** __kmp_get_global_thread_id_reg: using internal alg.\n"));
236 gtid = __kmp_get_global_thread_id();
237 }
238
239 /* we must be a new uber master sibling thread */
240 if (gtid == KMP_GTID_DNE) {
241 KA_TRACE(10,
242 ("__kmp_get_global_thread_id_reg: Encountered new root thread. "
243 "Registering a new gtid.\n"));
244 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
245 if (!__kmp_init_serial) {
246 __kmp_do_serial_initialize();
247 gtid = __kmp_gtid_get_specific();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000248 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +0000249 gtid = __kmp_register_root(FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000250 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000251 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
252 /*__kmp_printf( "+++ %d\n", gtid ); */ /* GROO */
253 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000254
Jonathan Peyton30419822017-05-12 18:01:32 +0000255 KMP_DEBUG_ASSERT(gtid >= 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000256
Jonathan Peyton30419822017-05-12 18:01:32 +0000257 return gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000258}
259
260/* caller must hold forkjoin_lock */
Jonathan Peyton30419822017-05-12 18:01:32 +0000261void __kmp_check_stack_overlap(kmp_info_t *th) {
262 int f;
263 char *stack_beg = NULL;
264 char *stack_end = NULL;
265 int gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000266
Jonathan Peyton30419822017-05-12 18:01:32 +0000267 KA_TRACE(10, ("__kmp_check_stack_overlap: called\n"));
268 if (__kmp_storage_map) {
269 stack_end = (char *)th->th.th_info.ds.ds_stackbase;
270 stack_beg = stack_end - th->th.th_info.ds.ds_stacksize;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000271
Jonathan Peyton30419822017-05-12 18:01:32 +0000272 gtid = __kmp_gtid_from_thread(th);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000273
Jonathan Peyton30419822017-05-12 18:01:32 +0000274 if (gtid == KMP_GTID_MONITOR) {
275 __kmp_print_storage_map_gtid(
276 gtid, stack_beg, stack_end, th->th.th_info.ds.ds_stacksize,
277 "th_%s stack (%s)", "mon",
278 (th->th.th_info.ds.ds_stackgrow) ? "initial" : "actual");
Jim Cownie5e8470a2013-09-27 10:38:44 +0000279 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +0000280 __kmp_print_storage_map_gtid(
281 gtid, stack_beg, stack_end, th->th.th_info.ds.ds_stacksize,
282 "th_%d stack (%s)", gtid,
283 (th->th.th_info.ds.ds_stackgrow) ? "initial" : "actual");
284 }
285 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000286
Jonathan Peyton30419822017-05-12 18:01:32 +0000287 /* No point in checking ubermaster threads since they use refinement and
288 * cannot overlap */
289 gtid = __kmp_gtid_from_thread(th);
290 if (__kmp_env_checks == TRUE && !KMP_UBER_GTID(gtid)) {
291 KA_TRACE(10,
292 ("__kmp_check_stack_overlap: performing extensive checking\n"));
293 if (stack_beg == NULL) {
294 stack_end = (char *)th->th.th_info.ds.ds_stackbase;
295 stack_beg = stack_end - th->th.th_info.ds.ds_stacksize;
296 }
297
298 for (f = 0; f < __kmp_threads_capacity; f++) {
299 kmp_info_t *f_th = (kmp_info_t *)TCR_SYNC_PTR(__kmp_threads[f]);
300
301 if (f_th && f_th != th) {
302 char *other_stack_end =
303 (char *)TCR_PTR(f_th->th.th_info.ds.ds_stackbase);
304 char *other_stack_beg =
305 other_stack_end - (size_t)TCR_PTR(f_th->th.th_info.ds.ds_stacksize);
306 if ((stack_beg > other_stack_beg && stack_beg < other_stack_end) ||
307 (stack_end > other_stack_beg && stack_end < other_stack_end)) {
308
309 /* Print the other stack values before the abort */
310 if (__kmp_storage_map)
311 __kmp_print_storage_map_gtid(
312 -1, other_stack_beg, other_stack_end,
313 (size_t)TCR_PTR(f_th->th.th_info.ds.ds_stacksize),
314 "th_%d stack (overlapped)", __kmp_gtid_from_thread(f_th));
315
Jonathan Peyton6a393f72017-09-05 15:43:58 +0000316 __kmp_fatal(KMP_MSG(StackOverlap), KMP_HNT(ChangeStackLimit),
317 __kmp_msg_null);
Jonathan Peyton30419822017-05-12 18:01:32 +0000318 }
319 }
320 }
321 }
322 KA_TRACE(10, ("__kmp_check_stack_overlap: returning\n"));
323}
324
325/* ------------------------------------------------------------------------ */
326
327void __kmp_infinite_loop(void) {
328 static int done = FALSE;
329
330 while (!done) {
331 KMP_YIELD(1);
332 }
333}
334
335#define MAX_MESSAGE 512
336
337void __kmp_print_storage_map_gtid(int gtid, void *p1, void *p2, size_t size,
338 char const *format, ...) {
339 char buffer[MAX_MESSAGE];
340 va_list ap;
341
342 va_start(ap, format);
343 KMP_SNPRINTF(buffer, sizeof(buffer), "OMP storage map: %p %p%8lu %s\n", p1,
344 p2, (unsigned long)size, format);
345 __kmp_acquire_bootstrap_lock(&__kmp_stdio_lock);
346 __kmp_vprintf(kmp_err, buffer, ap);
347#if KMP_PRINT_DATA_PLACEMENT
348 int node;
349 if (gtid >= 0) {
350 if (p1 <= p2 && (char *)p2 - (char *)p1 == size) {
351 if (__kmp_storage_map_verbose) {
352 node = __kmp_get_host_node(p1);
353 if (node < 0) /* doesn't work, so don't try this next time */
354 __kmp_storage_map_verbose = FALSE;
355 else {
356 char *last;
357 int lastNode;
358 int localProc = __kmp_get_cpu_from_gtid(gtid);
359
360 const int page_size = KMP_GET_PAGE_SIZE();
361
362 p1 = (void *)((size_t)p1 & ~((size_t)page_size - 1));
363 p2 = (void *)(((size_t)p2 - 1) & ~((size_t)page_size - 1));
364 if (localProc >= 0)
365 __kmp_printf_no_lock(" GTID %d localNode %d\n", gtid,
366 localProc >> 1);
367 else
368 __kmp_printf_no_lock(" GTID %d\n", gtid);
369#if KMP_USE_PRCTL
370 /* The more elaborate format is disabled for now because of the prctl
371 * hanging bug. */
372 do {
373 last = p1;
374 lastNode = node;
375 /* This loop collates adjacent pages with the same host node. */
376 do {
377 (char *)p1 += page_size;
378 } while (p1 <= p2 && (node = __kmp_get_host_node(p1)) == lastNode);
379 __kmp_printf_no_lock(" %p-%p memNode %d\n", last, (char *)p1 - 1,
380 lastNode);
381 } while (p1 <= p2);
382#else
383 __kmp_printf_no_lock(" %p-%p memNode %d\n", p1,
384 (char *)p1 + (page_size - 1),
385 __kmp_get_host_node(p1));
386 if (p1 < p2) {
387 __kmp_printf_no_lock(" %p-%p memNode %d\n", p2,
388 (char *)p2 + (page_size - 1),
389 __kmp_get_host_node(p2));
390 }
391#endif
392 }
393 }
394 } else
395 __kmp_printf_no_lock(" %s\n", KMP_I18N_STR(StorageMapWarning));
396 }
397#endif /* KMP_PRINT_DATA_PLACEMENT */
398 __kmp_release_bootstrap_lock(&__kmp_stdio_lock);
399}
400
401void __kmp_warn(char const *format, ...) {
402 char buffer[MAX_MESSAGE];
403 va_list ap;
404
405 if (__kmp_generate_warnings == kmp_warnings_off) {
406 return;
407 }
408
409 va_start(ap, format);
410
411 KMP_SNPRINTF(buffer, sizeof(buffer), "OMP warning: %s\n", format);
412 __kmp_acquire_bootstrap_lock(&__kmp_stdio_lock);
413 __kmp_vprintf(kmp_err, buffer, ap);
414 __kmp_release_bootstrap_lock(&__kmp_stdio_lock);
415
416 va_end(ap);
417}
418
419void __kmp_abort_process() {
420 // Later threads may stall here, but that's ok because abort() will kill them.
421 __kmp_acquire_bootstrap_lock(&__kmp_exit_lock);
422
423 if (__kmp_debug_buf) {
424 __kmp_dump_debug_buffer();
Jonathan Peytonbd3a7632017-09-27 20:36:27 +0000425 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000426
427 if (KMP_OS_WINDOWS) {
428 // Let other threads know of abnormal termination and prevent deadlock
429 // if abort happened during library initialization or shutdown
430 __kmp_global.g.g_abort = SIGABRT;
431
432 /* On Windows* OS by default abort() causes pop-up error box, which stalls
433 nightly testing. Unfortunately, we cannot reliably suppress pop-up error
434 boxes. _set_abort_behavior() works well, but this function is not
435 available in VS7 (this is not problem for DLL, but it is a problem for
436 static OpenMP RTL). SetErrorMode (and so, timelimit utility) does not
437 help, at least in some versions of MS C RTL.
438
439 It seems following sequence is the only way to simulate abort() and
440 avoid pop-up error box. */
441 raise(SIGABRT);
442 _exit(3); // Just in case, if signal ignored, exit anyway.
443 } else {
444 abort();
Jonathan Peytonbd3a7632017-09-27 20:36:27 +0000445 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000446
447 __kmp_infinite_loop();
448 __kmp_release_bootstrap_lock(&__kmp_exit_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000449
450} // __kmp_abort_process
451
Jonathan Peyton30419822017-05-12 18:01:32 +0000452void __kmp_abort_thread(void) {
453 // TODO: Eliminate g_abort global variable and this function.
454 // In case of abort just call abort(), it will kill all the threads.
455 __kmp_infinite_loop();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000456} // __kmp_abort_thread
457
Jonathan Peyton30419822017-05-12 18:01:32 +0000458/* Print out the storage map for the major kmp_info_t thread data structures
459 that are allocated together. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000460
Jonathan Peyton30419822017-05-12 18:01:32 +0000461static void __kmp_print_thread_storage_map(kmp_info_t *thr, int gtid) {
462 __kmp_print_storage_map_gtid(gtid, thr, thr + 1, sizeof(kmp_info_t), "th_%d",
463 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000464
Jonathan Peyton30419822017-05-12 18:01:32 +0000465 __kmp_print_storage_map_gtid(gtid, &thr->th.th_info, &thr->th.th_team,
466 sizeof(kmp_desc_t), "th_%d.th_info", gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000467
Jonathan Peyton30419822017-05-12 18:01:32 +0000468 __kmp_print_storage_map_gtid(gtid, &thr->th.th_local, &thr->th.th_pri_head,
469 sizeof(kmp_local_t), "th_%d.th_local", gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000470
Jonathan Peyton30419822017-05-12 18:01:32 +0000471 __kmp_print_storage_map_gtid(
472 gtid, &thr->th.th_bar[0], &thr->th.th_bar[bs_last_barrier],
473 sizeof(kmp_balign_t) * bs_last_barrier, "th_%d.th_bar", gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000474
Jonathan Peyton30419822017-05-12 18:01:32 +0000475 __kmp_print_storage_map_gtid(gtid, &thr->th.th_bar[bs_plain_barrier],
476 &thr->th.th_bar[bs_plain_barrier + 1],
477 sizeof(kmp_balign_t), "th_%d.th_bar[plain]",
478 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000479
Jonathan Peyton30419822017-05-12 18:01:32 +0000480 __kmp_print_storage_map_gtid(gtid, &thr->th.th_bar[bs_forkjoin_barrier],
481 &thr->th.th_bar[bs_forkjoin_barrier + 1],
482 sizeof(kmp_balign_t), "th_%d.th_bar[forkjoin]",
483 gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000484
Jonathan Peyton30419822017-05-12 18:01:32 +0000485#if KMP_FAST_REDUCTION_BARRIER
486 __kmp_print_storage_map_gtid(gtid, &thr->th.th_bar[bs_reduction_barrier],
487 &thr->th.th_bar[bs_reduction_barrier + 1],
488 sizeof(kmp_balign_t), "th_%d.th_bar[reduction]",
489 gtid);
490#endif // KMP_FAST_REDUCTION_BARRIER
Jim Cownie5e8470a2013-09-27 10:38:44 +0000491}
492
Jonathan Peyton30419822017-05-12 18:01:32 +0000493/* Print out the storage map for the major kmp_team_t team data structures
494 that are allocated together. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000495
Jonathan Peyton30419822017-05-12 18:01:32 +0000496static void __kmp_print_team_storage_map(const char *header, kmp_team_t *team,
497 int team_id, int num_thr) {
498 int num_disp_buff = team->t.t_max_nproc > 1 ? __kmp_dispatch_num_buffers : 2;
499 __kmp_print_storage_map_gtid(-1, team, team + 1, sizeof(kmp_team_t), "%s_%d",
500 header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000501
Jonathan Peyton30419822017-05-12 18:01:32 +0000502 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[0],
503 &team->t.t_bar[bs_last_barrier],
504 sizeof(kmp_balign_team_t) * bs_last_barrier,
505 "%s_%d.t_bar", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000506
Jonathan Peyton30419822017-05-12 18:01:32 +0000507 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[bs_plain_barrier],
508 &team->t.t_bar[bs_plain_barrier + 1],
509 sizeof(kmp_balign_team_t), "%s_%d.t_bar[plain]",
510 header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000511
Jonathan Peyton30419822017-05-12 18:01:32 +0000512 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[bs_forkjoin_barrier],
513 &team->t.t_bar[bs_forkjoin_barrier + 1],
514 sizeof(kmp_balign_team_t),
515 "%s_%d.t_bar[forkjoin]", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000516
Jonathan Peyton30419822017-05-12 18:01:32 +0000517#if KMP_FAST_REDUCTION_BARRIER
518 __kmp_print_storage_map_gtid(-1, &team->t.t_bar[bs_reduction_barrier],
519 &team->t.t_bar[bs_reduction_barrier + 1],
520 sizeof(kmp_balign_team_t),
521 "%s_%d.t_bar[reduction]", header, team_id);
522#endif // KMP_FAST_REDUCTION_BARRIER
Jim Cownie5e8470a2013-09-27 10:38:44 +0000523
Jonathan Peyton30419822017-05-12 18:01:32 +0000524 __kmp_print_storage_map_gtid(
525 -1, &team->t.t_dispatch[0], &team->t.t_dispatch[num_thr],
526 sizeof(kmp_disp_t) * num_thr, "%s_%d.t_dispatch", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000527
Jonathan Peyton30419822017-05-12 18:01:32 +0000528 __kmp_print_storage_map_gtid(
529 -1, &team->t.t_threads[0], &team->t.t_threads[num_thr],
530 sizeof(kmp_info_t *) * num_thr, "%s_%d.t_threads", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000531
Jonathan Peyton30419822017-05-12 18:01:32 +0000532 __kmp_print_storage_map_gtid(-1, &team->t.t_disp_buffer[0],
533 &team->t.t_disp_buffer[num_disp_buff],
534 sizeof(dispatch_shared_info_t) * num_disp_buff,
535 "%s_%d.t_disp_buffer", header, team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000536
Jonathan Peyton30419822017-05-12 18:01:32 +0000537 __kmp_print_storage_map_gtid(-1, &team->t.t_taskq, &team->t.t_copypriv_data,
538 sizeof(kmp_taskq_t), "%s_%d.t_taskq", header,
539 team_id);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000540}
541
Jonathan Peyton92ca6182018-09-07 18:25:49 +0000542static void __kmp_init_allocator() {
543#if OMP_50_ENABLED
544 __kmp_init_memkind();
545#endif
546}
547static void __kmp_fini_allocator() {
548#if OMP_50_ENABLED
549 __kmp_fini_memkind();
550#endif
551}
Jim Cownie5e8470a2013-09-27 10:38:44 +0000552
553/* ------------------------------------------------------------------------ */
554
Jonathan Peyton8b3842f2018-10-05 17:59:39 +0000555#if KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +0000556#if KMP_OS_WINDOWS
Jim Cownie5e8470a2013-09-27 10:38:44 +0000557
Jonathan Peyton30419822017-05-12 18:01:32 +0000558static void __kmp_reset_lock(kmp_bootstrap_lock_t *lck) {
559 // TODO: Change to __kmp_break_bootstrap_lock().
560 __kmp_init_bootstrap_lock(lck); // make the lock released
Jim Cownie5e8470a2013-09-27 10:38:44 +0000561}
562
Jonathan Peyton30419822017-05-12 18:01:32 +0000563static void __kmp_reset_locks_on_process_detach(int gtid_req) {
564 int i;
565 int thread_count;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000566
Jonathan Peyton30419822017-05-12 18:01:32 +0000567 // PROCESS_DETACH is expected to be called by a thread that executes
568 // ProcessExit() or FreeLibrary(). OS terminates other threads (except the one
569 // calling ProcessExit or FreeLibrary). So, it might be safe to access the
570 // __kmp_threads[] without taking the forkjoin_lock. However, in fact, some
571 // threads can be still alive here, although being about to be terminated. The
572 // threads in the array with ds_thread==0 are most suspicious. Actually, it
573 // can be not safe to access the __kmp_threads[].
Jim Cownie5e8470a2013-09-27 10:38:44 +0000574
Jonathan Peyton30419822017-05-12 18:01:32 +0000575 // TODO: does it make sense to check __kmp_roots[] ?
Jim Cownie5e8470a2013-09-27 10:38:44 +0000576
Jonathan Peyton30419822017-05-12 18:01:32 +0000577 // Let's check that there are no other alive threads registered with the OMP
578 // lib.
579 while (1) {
580 thread_count = 0;
581 for (i = 0; i < __kmp_threads_capacity; ++i) {
582 if (!__kmp_threads)
583 continue;
584 kmp_info_t *th = __kmp_threads[i];
585 if (th == NULL)
586 continue;
587 int gtid = th->th.th_info.ds.ds_gtid;
588 if (gtid == gtid_req)
589 continue;
590 if (gtid < 0)
591 continue;
592 DWORD exit_val;
593 int alive = __kmp_is_thread_alive(th, &exit_val);
594 if (alive) {
595 ++thread_count;
596 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000597 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000598 if (thread_count == 0)
599 break; // success
600 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000601
Jonathan Peyton30419822017-05-12 18:01:32 +0000602 // Assume that I'm alone. Now it might be safe to check and reset locks.
603 // __kmp_forkjoin_lock and __kmp_stdio_lock are expected to be reset.
604 __kmp_reset_lock(&__kmp_forkjoin_lock);
605#ifdef KMP_DEBUG
606 __kmp_reset_lock(&__kmp_stdio_lock);
607#endif // KMP_DEBUG
Jim Cownie5e8470a2013-09-27 10:38:44 +0000608}
609
Jonathan Peyton30419822017-05-12 18:01:32 +0000610BOOL WINAPI DllMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID lpReserved) {
611 //__kmp_acquire_bootstrap_lock( &__kmp_initz_lock );
Jim Cownie5e8470a2013-09-27 10:38:44 +0000612
Jonathan Peyton30419822017-05-12 18:01:32 +0000613 switch (fdwReason) {
Jim Cownie5e8470a2013-09-27 10:38:44 +0000614
Jonathan Peyton30419822017-05-12 18:01:32 +0000615 case DLL_PROCESS_ATTACH:
616 KA_TRACE(10, ("DllMain: PROCESS_ATTACH\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +0000617
618 return TRUE;
Jonathan Peyton30419822017-05-12 18:01:32 +0000619
620 case DLL_PROCESS_DETACH:
621 KA_TRACE(10, ("DllMain: PROCESS_DETACH T#%d\n", __kmp_gtid_get_specific()));
622
623 if (lpReserved != NULL) {
624 // lpReserved is used for telling the difference:
625 // lpReserved == NULL when FreeLibrary() was called,
626 // lpReserved != NULL when the process terminates.
627 // When FreeLibrary() is called, worker threads remain alive. So they will
628 // release the forkjoin lock by themselves. When the process terminates,
629 // worker threads disappear triggering the problem of unreleased forkjoin
630 // lock as described below.
631
632 // A worker thread can take the forkjoin lock. The problem comes up if
633 // that worker thread becomes dead before it releases the forkjoin lock.
634 // The forkjoin lock remains taken, while the thread executing
635 // DllMain()->PROCESS_DETACH->__kmp_internal_end_library() below will try
636 // to take the forkjoin lock and will always fail, so that the application
637 // will never finish [normally]. This scenario is possible if
638 // __kmpc_end() has not been executed. It looks like it's not a corner
639 // case, but common cases:
640 // - the main function was compiled by an alternative compiler;
641 // - the main function was compiled by icl but without /Qopenmp
642 // (application with plugins);
643 // - application terminates by calling C exit(), Fortran CALL EXIT() or
644 // Fortran STOP.
645 // - alive foreign thread prevented __kmpc_end from doing cleanup.
646 //
647 // This is a hack to work around the problem.
648 // TODO: !!! figure out something better.
649 __kmp_reset_locks_on_process_detach(__kmp_gtid_get_specific());
650 }
651
652 __kmp_internal_end_library(__kmp_gtid_get_specific());
653
654 return TRUE;
655
656 case DLL_THREAD_ATTACH:
657 KA_TRACE(10, ("DllMain: THREAD_ATTACH\n"));
658
659 /* if we want to register new siblings all the time here call
660 * __kmp_get_gtid(); */
661 return TRUE;
662
663 case DLL_THREAD_DETACH:
664 KA_TRACE(10, ("DllMain: THREAD_DETACH T#%d\n", __kmp_gtid_get_specific()));
665
666 __kmp_internal_end_thread(__kmp_gtid_get_specific());
667 return TRUE;
668 }
669
670 return TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000671}
672
Jonathan Peyton30419822017-05-12 18:01:32 +0000673#endif /* KMP_OS_WINDOWS */
Jonathan Peyton99016992015-05-26 17:32:53 +0000674#endif /* KMP_DYNAMIC_LIB */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000675
Jim Cownie5e8470a2013-09-27 10:38:44 +0000676/* Change the library type to "status" and return the old type */
677/* called from within initialization routines where __kmp_initz_lock is held */
Jonathan Peyton30419822017-05-12 18:01:32 +0000678int __kmp_change_library(int status) {
679 int old_status;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000680
Jonathan Peyton30419822017-05-12 18:01:32 +0000681 old_status = __kmp_yield_init &
682 1; // check whether KMP_LIBRARY=throughput (even init count)
Jim Cownie5e8470a2013-09-27 10:38:44 +0000683
Jonathan Peyton30419822017-05-12 18:01:32 +0000684 if (status) {
685 __kmp_yield_init |= 1; // throughput => turnaround (odd init count)
686 } else {
687 __kmp_yield_init &= ~1; // turnaround => throughput (even init count)
688 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000689
Jonathan Peyton30419822017-05-12 18:01:32 +0000690 return old_status; // return previous setting of whether
691 // KMP_LIBRARY=throughput
Jim Cownie5e8470a2013-09-27 10:38:44 +0000692}
693
Jonathan Peyton30419822017-05-12 18:01:32 +0000694/* __kmp_parallel_deo -- Wait until it's our turn. */
695void __kmp_parallel_deo(int *gtid_ref, int *cid_ref, ident_t *loc_ref) {
696 int gtid = *gtid_ref;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000697#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000698 kmp_team_t *team = __kmp_team_from_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000699#endif /* BUILD_PARALLEL_ORDERED */
700
Jonathan Peyton30419822017-05-12 18:01:32 +0000701 if (__kmp_env_consistency_check) {
702 if (__kmp_threads[gtid]->th.th_root->r.r_active)
Andrey Churbanov5c56fb52015-02-20 18:05:17 +0000703#if KMP_USE_DYNAMIC_LOCK
Jonathan Peyton30419822017-05-12 18:01:32 +0000704 __kmp_push_sync(gtid, ct_ordered_in_parallel, loc_ref, NULL, 0);
Andrey Churbanov5c56fb52015-02-20 18:05:17 +0000705#else
Jonathan Peyton30419822017-05-12 18:01:32 +0000706 __kmp_push_sync(gtid, ct_ordered_in_parallel, loc_ref, NULL);
Andrey Churbanov5c56fb52015-02-20 18:05:17 +0000707#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000708 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000709#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000710 if (!team->t.t_serialized) {
711 KMP_MB();
712 KMP_WAIT_YIELD(&team->t.t_ordered.dt.t_value, __kmp_tid_from_gtid(gtid),
713 KMP_EQ, NULL);
714 KMP_MB();
715 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000716#endif /* BUILD_PARALLEL_ORDERED */
717}
718
Jonathan Peyton30419822017-05-12 18:01:32 +0000719/* __kmp_parallel_dxo -- Signal the next task. */
720void __kmp_parallel_dxo(int *gtid_ref, int *cid_ref, ident_t *loc_ref) {
721 int gtid = *gtid_ref;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000722#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000723 int tid = __kmp_tid_from_gtid(gtid);
724 kmp_team_t *team = __kmp_team_from_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000725#endif /* BUILD_PARALLEL_ORDERED */
726
Jonathan Peyton30419822017-05-12 18:01:32 +0000727 if (__kmp_env_consistency_check) {
728 if (__kmp_threads[gtid]->th.th_root->r.r_active)
729 __kmp_pop_sync(gtid, ct_ordered_in_parallel, loc_ref);
730 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000731#ifdef BUILD_PARALLEL_ORDERED
Jonathan Peyton30419822017-05-12 18:01:32 +0000732 if (!team->t.t_serialized) {
733 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000734
Jonathan Peyton30419822017-05-12 18:01:32 +0000735 /* use the tid of the next thread in this team */
736 /* TODO replace with general release procedure */
737 team->t.t_ordered.dt.t_value = ((tid + 1) % team->t.t_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000738
Jonathan Peyton30419822017-05-12 18:01:32 +0000739 KMP_MB(); /* Flush all pending memory write invalidates. */
740 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000741#endif /* BUILD_PARALLEL_ORDERED */
742}
743
744/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +0000745/* The BARRIER for a SINGLE process section is always explicit */
746
Jonathan Peyton30419822017-05-12 18:01:32 +0000747int __kmp_enter_single(int gtid, ident_t *id_ref, int push_ws) {
748 int status;
749 kmp_info_t *th;
750 kmp_team_t *team;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000751
Jonathan Peyton30419822017-05-12 18:01:32 +0000752 if (!TCR_4(__kmp_init_parallel))
753 __kmp_parallel_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +0000754
Jonathan Peyton30419822017-05-12 18:01:32 +0000755 th = __kmp_threads[gtid];
756 team = th->th.th_team;
757 status = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000758
Jonathan Peyton30419822017-05-12 18:01:32 +0000759 th->th.th_ident = id_ref;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000760
Jonathan Peyton30419822017-05-12 18:01:32 +0000761 if (team->t.t_serialized) {
762 status = 1;
763 } else {
764 kmp_int32 old_this = th->th.th_local.this_construct;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000765
Jonathan Peyton30419822017-05-12 18:01:32 +0000766 ++th->th.th_local.this_construct;
767 /* try to set team count to thread count--success means thread got the
768 single block */
769 /* TODO: Should this be acquire or release? */
770 if (team->t.t_construct == old_this) {
Jonathan Peyton37e2ef52018-07-09 17:36:22 +0000771 status = __kmp_atomic_compare_store_acq(&team->t.t_construct, old_this,
772 th->th.th_local.this_construct);
Jonathan Peyton30419822017-05-12 18:01:32 +0000773 }
Andrey Churbanov51aecb82015-05-06 19:22:36 +0000774#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +0000775 if (__itt_metadata_add_ptr && __kmp_forkjoin_frames_mode == 3 &&
776 KMP_MASTER_GTID(gtid) &&
Andrey Churbanov51aecb82015-05-06 19:22:36 +0000777#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +0000778 th->th.th_teams_microtask == NULL &&
Andrey Churbanov51aecb82015-05-06 19:22:36 +0000779#endif
Jonathan Peyton30419822017-05-12 18:01:32 +0000780 team->t.t_active_level ==
781 1) { // Only report metadata by master of active team at level 1
782 __kmp_itt_metadata_single(id_ref);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000783 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000784#endif /* USE_ITT_BUILD */
785 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000786
Jonathan Peyton30419822017-05-12 18:01:32 +0000787 if (__kmp_env_consistency_check) {
788 if (status && push_ws) {
789 __kmp_push_workshare(gtid, ct_psingle, id_ref);
790 } else {
791 __kmp_check_workshare(gtid, ct_psingle, id_ref);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000792 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000793 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000794#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +0000795 if (status) {
796 __kmp_itt_single_start(gtid);
797 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000798#endif /* USE_ITT_BUILD */
Jonathan Peyton30419822017-05-12 18:01:32 +0000799 return status;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000800}
801
Jonathan Peyton30419822017-05-12 18:01:32 +0000802void __kmp_exit_single(int gtid) {
Jim Cownie5e8470a2013-09-27 10:38:44 +0000803#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +0000804 __kmp_itt_single_end(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000805#endif /* USE_ITT_BUILD */
Jonathan Peyton30419822017-05-12 18:01:32 +0000806 if (__kmp_env_consistency_check)
807 __kmp_pop_workshare(gtid, ct_psingle, NULL);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000808}
809
Jonathan Peyton30419822017-05-12 18:01:32 +0000810/* determine if we can go parallel or must use a serialized parallel region and
Jim Cownie5e8470a2013-09-27 10:38:44 +0000811 * how many threads we can use
812 * set_nproc is the number of threads requested for the team
813 * returns 0 if we should serialize or only use one thread,
814 * otherwise the number of threads to use
Jonathan Peyton30419822017-05-12 18:01:32 +0000815 * The forkjoin lock is held by the caller. */
816static int __kmp_reserve_threads(kmp_root_t *root, kmp_team_t *parent_team,
817 int master_tid, int set_nthreads
Jim Cownie5e8470a2013-09-27 10:38:44 +0000818#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +0000819 ,
820 int enter_teams
Jim Cownie5e8470a2013-09-27 10:38:44 +0000821#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +0000822 ) {
823 int capacity;
824 int new_nthreads;
825 KMP_DEBUG_ASSERT(__kmp_init_serial);
826 KMP_DEBUG_ASSERT(root && parent_team);
Jim Cownie5e8470a2013-09-27 10:38:44 +0000827
Jonathan Peyton30419822017-05-12 18:01:32 +0000828 // If dyn-var is set, dynamically adjust the number of desired threads,
829 // according to the method specified by dynamic_mode.
830 new_nthreads = set_nthreads;
831 if (!get__dynamic_2(parent_team, master_tid)) {
832 ;
833 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000834#ifdef USE_LOAD_BALANCE
Jonathan Peyton30419822017-05-12 18:01:32 +0000835 else if (__kmp_global.g.g_dynamic_mode == dynamic_load_balance) {
836 new_nthreads = __kmp_load_balance_nproc(root, set_nthreads);
837 if (new_nthreads == 1) {
838 KC_TRACE(10, ("__kmp_reserve_threads: T#%d load balance reduced "
839 "reservation to 1 thread\n",
840 master_tid));
841 return 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000842 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000843 if (new_nthreads < set_nthreads) {
844 KC_TRACE(10, ("__kmp_reserve_threads: T#%d load balance reduced "
845 "reservation to %d threads\n",
846 master_tid, new_nthreads));
847 }
848 }
Jim Cownie5e8470a2013-09-27 10:38:44 +0000849#endif /* USE_LOAD_BALANCE */
Jonathan Peyton30419822017-05-12 18:01:32 +0000850 else if (__kmp_global.g.g_dynamic_mode == dynamic_thread_limit) {
851 new_nthreads = __kmp_avail_proc - __kmp_nth +
852 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
853 if (new_nthreads <= 1) {
854 KC_TRACE(10, ("__kmp_reserve_threads: T#%d thread limit reduced "
855 "reservation to 1 thread\n",
856 master_tid));
857 return 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000858 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000859 if (new_nthreads < set_nthreads) {
860 KC_TRACE(10, ("__kmp_reserve_threads: T#%d thread limit reduced "
861 "reservation to %d threads\n",
862 master_tid, new_nthreads));
863 } else {
864 new_nthreads = set_nthreads;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000865 }
Jonathan Peyton30419822017-05-12 18:01:32 +0000866 } else if (__kmp_global.g.g_dynamic_mode == dynamic_random) {
867 if (set_nthreads > 2) {
868 new_nthreads = __kmp_get_random(parent_team->t.t_threads[master_tid]);
869 new_nthreads = (new_nthreads % set_nthreads) + 1;
870 if (new_nthreads == 1) {
871 KC_TRACE(10, ("__kmp_reserve_threads: T#%d dynamic random reduced "
872 "reservation to 1 thread\n",
873 master_tid));
Jim Cownie5e8470a2013-09-27 10:38:44 +0000874 return 1;
Jonathan Peyton30419822017-05-12 18:01:32 +0000875 }
876 if (new_nthreads < set_nthreads) {
877 KC_TRACE(10, ("__kmp_reserve_threads: T#%d dynamic random reduced "
878 "reservation to %d threads\n",
879 master_tid, new_nthreads));
880 }
881 }
882 } else {
883 KMP_ASSERT(0);
884 }
885
Jonathan Peytonf4392462017-07-27 20:58:41 +0000886 // Respect KMP_ALL_THREADS/KMP_DEVICE_THREAD_LIMIT.
Jonathan Peyton30419822017-05-12 18:01:32 +0000887 if (__kmp_nth + new_nthreads -
888 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) >
889 __kmp_max_nth) {
890 int tl_nthreads = __kmp_max_nth - __kmp_nth +
891 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
892 if (tl_nthreads <= 0) {
893 tl_nthreads = 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000894 }
895
Jonathan Peyton30419822017-05-12 18:01:32 +0000896 // If dyn-var is false, emit a 1-time warning.
897 if (!get__dynamic_2(parent_team, master_tid) && (!__kmp_reserve_warn)) {
898 __kmp_reserve_warn = 1;
899 __kmp_msg(kmp_ms_warning,
900 KMP_MSG(CantFormThrTeam, set_nthreads, tl_nthreads),
901 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
902 }
903 if (tl_nthreads == 1) {
Jonathan Peytonf4392462017-07-27 20:58:41 +0000904 KC_TRACE(10, ("__kmp_reserve_threads: T#%d KMP_DEVICE_THREAD_LIMIT "
905 "reduced reservation to 1 thread\n",
Jonathan Peyton30419822017-05-12 18:01:32 +0000906 master_tid));
907 return 1;
908 }
Jonathan Peytonf4392462017-07-27 20:58:41 +0000909 KC_TRACE(10, ("__kmp_reserve_threads: T#%d KMP_DEVICE_THREAD_LIMIT reduced "
910 "reservation to %d threads\n",
911 master_tid, tl_nthreads));
912 new_nthreads = tl_nthreads;
913 }
914
915 // Respect OMP_THREAD_LIMIT
916 if (root->r.r_cg_nthreads + new_nthreads -
917 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) >
918 __kmp_cg_max_nth) {
919 int tl_nthreads = __kmp_cg_max_nth - root->r.r_cg_nthreads +
920 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
921 if (tl_nthreads <= 0) {
922 tl_nthreads = 1;
923 }
924
925 // If dyn-var is false, emit a 1-time warning.
926 if (!get__dynamic_2(parent_team, master_tid) && (!__kmp_reserve_warn)) {
927 __kmp_reserve_warn = 1;
928 __kmp_msg(kmp_ms_warning,
929 KMP_MSG(CantFormThrTeam, set_nthreads, tl_nthreads),
930 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
931 }
932 if (tl_nthreads == 1) {
933 KC_TRACE(10, ("__kmp_reserve_threads: T#%d OMP_THREAD_LIMIT "
934 "reduced reservation to 1 thread\n",
935 master_tid));
936 return 1;
937 }
938 KC_TRACE(10, ("__kmp_reserve_threads: T#%d OMP_THREAD_LIMIT reduced "
Jonathan Peyton30419822017-05-12 18:01:32 +0000939 "reservation to %d threads\n",
940 master_tid, tl_nthreads));
941 new_nthreads = tl_nthreads;
942 }
943
944 // Check if the threads array is large enough, or needs expanding.
Jonathan Peyton30419822017-05-12 18:01:32 +0000945 // See comment in __kmp_register_root() about the adjustment if
946 // __kmp_threads[0] == NULL.
947 capacity = __kmp_threads_capacity;
948 if (TCR_PTR(__kmp_threads[0]) == NULL) {
949 --capacity;
950 }
951 if (__kmp_nth + new_nthreads -
952 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) >
953 capacity) {
954 // Expand the threads array.
955 int slotsRequired = __kmp_nth + new_nthreads -
956 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc) -
957 capacity;
Jonathan Peyton1800ece2018-01-10 18:27:01 +0000958 int slotsAdded = __kmp_expand_threads(slotsRequired);
Jonathan Peyton30419822017-05-12 18:01:32 +0000959 if (slotsAdded < slotsRequired) {
960 // The threads array was not expanded enough.
961 new_nthreads -= (slotsRequired - slotsAdded);
962 KMP_ASSERT(new_nthreads >= 1);
963
964 // If dyn-var is false, emit a 1-time warning.
965 if (!get__dynamic_2(parent_team, master_tid) && (!__kmp_reserve_warn)) {
966 __kmp_reserve_warn = 1;
967 if (__kmp_tp_cached) {
968 __kmp_msg(kmp_ms_warning,
969 KMP_MSG(CantFormThrTeam, set_nthreads, new_nthreads),
970 KMP_HNT(Set_ALL_THREADPRIVATE, __kmp_tp_capacity),
971 KMP_HNT(PossibleSystemLimitOnThreads), __kmp_msg_null);
972 } else {
973 __kmp_msg(kmp_ms_warning,
974 KMP_MSG(CantFormThrTeam, set_nthreads, new_nthreads),
975 KMP_HNT(SystemLimitOnThreads), __kmp_msg_null);
976 }
977 }
978 }
979 }
980
Jonathan Peyton642688b2017-06-01 16:46:36 +0000981#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +0000982 if (new_nthreads == 1) {
983 KC_TRACE(10,
984 ("__kmp_reserve_threads: T#%d serializing team after reclaiming "
985 "dead roots and rechecking; requested %d threads\n",
986 __kmp_get_gtid(), set_nthreads));
Jonathan Peyton642688b2017-06-01 16:46:36 +0000987 } else {
988 KC_TRACE(10, ("__kmp_reserve_threads: T#%d allocating %d threads; requested"
989 " %d threads\n",
990 __kmp_get_gtid(), new_nthreads, set_nthreads));
Jonathan Peyton30419822017-05-12 18:01:32 +0000991 }
Jonathan Peyton642688b2017-06-01 16:46:36 +0000992#endif // KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +0000993 return new_nthreads;
Jim Cownie5e8470a2013-09-27 10:38:44 +0000994}
995
Jonathan Peyton30419822017-05-12 18:01:32 +0000996/* Allocate threads from the thread pool and assign them to the new team. We are
997 assured that there are enough threads available, because we checked on that
998 earlier within critical section forkjoin */
999static void __kmp_fork_team_threads(kmp_root_t *root, kmp_team_t *team,
1000 kmp_info_t *master_th, int master_gtid) {
1001 int i;
1002 int use_hot_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001003
Jonathan Peyton30419822017-05-12 18:01:32 +00001004 KA_TRACE(10, ("__kmp_fork_team_threads: new_nprocs = %d\n", team->t.t_nproc));
1005 KMP_DEBUG_ASSERT(master_gtid == __kmp_get_gtid());
1006 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00001007
Jonathan Peyton30419822017-05-12 18:01:32 +00001008 /* first, let's setup the master thread */
1009 master_th->th.th_info.ds.ds_tid = 0;
1010 master_th->th.th_team = team;
1011 master_th->th.th_team_nproc = team->t.t_nproc;
1012 master_th->th.th_team_master = master_th;
1013 master_th->th.th_team_serialized = FALSE;
1014 master_th->th.th_dispatch = &team->t.t_dispatch[0];
Jim Cownie5e8470a2013-09-27 10:38:44 +00001015
Jonathan Peyton30419822017-05-12 18:01:32 +00001016/* make sure we are not the optimized hot team */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001017#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00001018 use_hot_team = 0;
1019 kmp_hot_team_ptr_t *hot_teams = master_th->th.th_hot_teams;
1020 if (hot_teams) { // hot teams array is not allocated if
1021 // KMP_HOT_TEAMS_MAX_LEVEL=0
1022 int level = team->t.t_active_level - 1; // index in array of hot teams
1023 if (master_th->th.th_teams_microtask) { // are we inside the teams?
1024 if (master_th->th.th_teams_size.nteams > 1) {
1025 ++level; // level was not increased in teams construct for
1026 // team_of_masters
1027 }
1028 if (team->t.t_pkfn != (microtask_t)__kmp_teams_master &&
1029 master_th->th.th_teams_level == team->t.t_level) {
1030 ++level; // level was not increased in teams construct for
1031 // team_of_workers before the parallel
1032 } // team->t.t_level will be increased inside parallel
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001033 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001034 if (level < __kmp_hot_teams_max_level) {
1035 if (hot_teams[level].hot_team) {
1036 // hot team has already been allocated for given level
1037 KMP_DEBUG_ASSERT(hot_teams[level].hot_team == team);
1038 use_hot_team = 1; // the team is ready to use
1039 } else {
1040 use_hot_team = 0; // AC: threads are not allocated yet
1041 hot_teams[level].hot_team = team; // remember new hot team
1042 hot_teams[level].hot_team_nth = team->t.t_nproc;
1043 }
1044 } else {
1045 use_hot_team = 0;
1046 }
1047 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001048#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001049 use_hot_team = team == root->r.r_hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001050#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001051 if (!use_hot_team) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00001052
Jonathan Peyton30419822017-05-12 18:01:32 +00001053 /* install the master thread */
1054 team->t.t_threads[0] = master_th;
1055 __kmp_initialize_info(master_th, team, 0, master_gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001056
Jonathan Peyton30419822017-05-12 18:01:32 +00001057 /* now, install the worker threads */
1058 for (i = 1; i < team->t.t_nproc; i++) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00001059
Jonathan Peyton30419822017-05-12 18:01:32 +00001060 /* fork or reallocate a new thread and install it in team */
1061 kmp_info_t *thr = __kmp_allocate_thread(root, team, i);
1062 team->t.t_threads[i] = thr;
1063 KMP_DEBUG_ASSERT(thr);
1064 KMP_DEBUG_ASSERT(thr->th.th_team == team);
1065 /* align team and thread arrived states */
1066 KA_TRACE(20, ("__kmp_fork_team_threads: T#%d(%d:%d) init arrived "
1067 "T#%d(%d:%d) join =%llu, plain=%llu\n",
1068 __kmp_gtid_from_tid(0, team), team->t.t_id, 0,
1069 __kmp_gtid_from_tid(i, team), team->t.t_id, i,
1070 team->t.t_bar[bs_forkjoin_barrier].b_arrived,
1071 team->t.t_bar[bs_plain_barrier].b_arrived));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001072#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001073 thr->th.th_teams_microtask = master_th->th.th_teams_microtask;
1074 thr->th.th_teams_level = master_th->th.th_teams_level;
1075 thr->th.th_teams_size = master_th->th.th_teams_size;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001076#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001077 { // Initialize threads' barrier data.
1078 int b;
1079 kmp_balign_t *balign = team->t.t_threads[i]->th.th_bar;
1080 for (b = 0; b < bs_last_barrier; ++b) {
1081 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
1082 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001083#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00001084 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001085#endif
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00001086 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001087 }
1088 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001089
Alp Toker98758b02014-03-02 04:12:06 +00001090#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00001091 __kmp_partition_places(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001092#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001093 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001094
Jonathan Peyton30419822017-05-12 18:01:32 +00001095 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00001096}
1097
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001098#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001099// Propagate any changes to the floating point control registers out to the team
Jonathan Peyton30419822017-05-12 18:01:32 +00001100// We try to avoid unnecessary writes to the relevant cache line in the team
1101// structure, so we don't make changes unless they are needed.
1102inline static void propagateFPControl(kmp_team_t *team) {
1103 if (__kmp_inherit_fp_control) {
1104 kmp_int16 x87_fpu_control_word;
1105 kmp_uint32 mxcsr;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001106
Jonathan Peyton30419822017-05-12 18:01:32 +00001107 // Get master values of FPU control flags (both X87 and vector)
1108 __kmp_store_x87_fpu_control_word(&x87_fpu_control_word);
1109 __kmp_store_mxcsr(&mxcsr);
1110 mxcsr &= KMP_X86_MXCSR_MASK;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001111
Jonathan Peyton94a114f2017-10-20 19:30:57 +00001112 // There is no point looking at t_fp_control_saved here.
1113 // If it is TRUE, we still have to update the values if they are different
Jonas Hahnfeldf0a1c652017-11-03 18:28:19 +00001114 // from those we now have. If it is FALSE we didn't save anything yet, but
1115 // our objective is the same. We have to ensure that the values in the team
1116 // are the same as those we have.
Jonathan Peyton94a114f2017-10-20 19:30:57 +00001117 // So, this code achieves what we need whether or not t_fp_control_saved is
1118 // true. By checking whether the value needs updating we avoid unnecessary
1119 // writes that would put the cache-line into a written state, causing all
1120 // threads in the team to have to read it again.
Jonathan Peyton30419822017-05-12 18:01:32 +00001121 KMP_CHECK_UPDATE(team->t.t_x87_fpu_control_word, x87_fpu_control_word);
1122 KMP_CHECK_UPDATE(team->t.t_mxcsr, mxcsr);
1123 // Although we don't use this value, other code in the runtime wants to know
1124 // whether it should restore them. So we must ensure it is correct.
1125 KMP_CHECK_UPDATE(team->t.t_fp_control_saved, TRUE);
1126 } else {
1127 // Similarly here. Don't write to this cache-line in the team structure
1128 // unless we have to.
1129 KMP_CHECK_UPDATE(team->t.t_fp_control_saved, FALSE);
1130 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001131}
1132
Jonathan Peyton30419822017-05-12 18:01:32 +00001133// Do the opposite, setting the hardware registers to the updated values from
1134// the team.
1135inline static void updateHWFPControl(kmp_team_t *team) {
1136 if (__kmp_inherit_fp_control && team->t.t_fp_control_saved) {
1137 // Only reset the fp control regs if they have been changed in the team.
1138 // the parallel region that we are exiting.
1139 kmp_int16 x87_fpu_control_word;
1140 kmp_uint32 mxcsr;
1141 __kmp_store_x87_fpu_control_word(&x87_fpu_control_word);
1142 __kmp_store_mxcsr(&mxcsr);
1143 mxcsr &= KMP_X86_MXCSR_MASK;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001144
Jonathan Peyton30419822017-05-12 18:01:32 +00001145 if (team->t.t_x87_fpu_control_word != x87_fpu_control_word) {
1146 __kmp_clear_x87_fpu_status_word();
1147 __kmp_load_x87_fpu_control_word(&team->t.t_x87_fpu_control_word);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001148 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001149
1150 if (team->t.t_mxcsr != mxcsr) {
1151 __kmp_load_mxcsr(&team->t.t_mxcsr);
1152 }
1153 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001154}
1155#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001156#define propagateFPControl(x) ((void)0)
1157#define updateHWFPControl(x) ((void)0)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001158#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
1159
Jonathan Peyton30419822017-05-12 18:01:32 +00001160static void __kmp_alloc_argv_entries(int argc, kmp_team_t *team,
1161 int realloc); // forward declaration
Jim Cownie5e8470a2013-09-27 10:38:44 +00001162
Jonathan Peyton30419822017-05-12 18:01:32 +00001163/* Run a parallel region that has been serialized, so runs only in a team of the
1164 single master thread. */
1165void __kmp_serialized_parallel(ident_t *loc, kmp_int32 global_tid) {
1166 kmp_info_t *this_thr;
1167 kmp_team_t *serial_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001168
Jonathan Peyton30419822017-05-12 18:01:32 +00001169 KC_TRACE(10, ("__kmpc_serialized_parallel: called by T#%d\n", global_tid));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001170
Jonathan Peyton30419822017-05-12 18:01:32 +00001171 /* Skip all this code for autopar serialized loops since it results in
1172 unacceptable overhead */
1173 if (loc != NULL && (loc->flags & KMP_IDENT_AUTOPAR))
1174 return;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001175
Jonathan Peyton30419822017-05-12 18:01:32 +00001176 if (!TCR_4(__kmp_init_parallel))
1177 __kmp_parallel_initialize();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001178
Jonathan Peyton30419822017-05-12 18:01:32 +00001179 this_thr = __kmp_threads[global_tid];
1180 serial_team = this_thr->th.th_serial_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001181
Jonathan Peyton30419822017-05-12 18:01:32 +00001182 /* utilize the serialized team held by this thread */
1183 KMP_DEBUG_ASSERT(serial_team);
1184 KMP_MB();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001185
Jonathan Peyton30419822017-05-12 18:01:32 +00001186 if (__kmp_tasking_mode != tskm_immediate_exec) {
1187 KMP_DEBUG_ASSERT(
1188 this_thr->th.th_task_team ==
1189 this_thr->th.th_team->t.t_task_team[this_thr->th.th_task_state]);
1190 KMP_DEBUG_ASSERT(serial_team->t.t_task_team[this_thr->th.th_task_state] ==
1191 NULL);
1192 KA_TRACE(20, ("__kmpc_serialized_parallel: T#%d pushing task_team %p / "
1193 "team %p, new task_team = NULL\n",
1194 global_tid, this_thr->th.th_task_team, this_thr->th.th_team));
1195 this_thr->th.th_task_team = NULL;
1196 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001197
1198#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001199 kmp_proc_bind_t proc_bind = this_thr->th.th_set_proc_bind;
1200 if (this_thr->th.th_current_task->td_icvs.proc_bind == proc_bind_false) {
1201 proc_bind = proc_bind_false;
1202 } else if (proc_bind == proc_bind_default) {
1203 // No proc_bind clause was specified, so use the current value
1204 // of proc-bind-var for this parallel region.
1205 proc_bind = this_thr->th.th_current_task->td_icvs.proc_bind;
1206 }
1207 // Reset for next parallel region
1208 this_thr->th.th_set_proc_bind = proc_bind_default;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001209#endif /* OMP_40_ENABLED */
1210
Joachim Protze82e94a52017-11-01 10:08:30 +00001211#if OMPT_SUPPORT
Jonathan Peyton3574f282018-10-04 14:57:04 +00001212 ompt_data_t ompt_parallel_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00001213 ompt_data_t *implicit_task_data;
1214 void *codeptr = OMPT_LOAD_RETURN_ADDRESS(global_tid);
1215 if (ompt_enabled.enabled &&
1216 this_thr->th.ompt_thread_info.state != omp_state_overhead) {
1217
1218 ompt_task_info_t *parent_task_info;
1219 parent_task_info = OMPT_CUR_TASK_INFO(this_thr);
1220
Joachim Protzec255ca72017-11-05 14:11:10 +00001221 parent_task_info->frame.enter_frame = OMPT_GET_FRAME_ADDRESS(1);
Joachim Protze82e94a52017-11-01 10:08:30 +00001222 if (ompt_enabled.ompt_callback_parallel_begin) {
1223 int team_size = 1;
1224
1225 ompt_callbacks.ompt_callback(ompt_callback_parallel_begin)(
1226 &(parent_task_info->task_data), &(parent_task_info->frame),
Joachim Protze489cdb72018-09-10 14:34:54 +00001227 &ompt_parallel_data, team_size, ompt_parallel_invoker_program,
1228 codeptr);
Joachim Protze82e94a52017-11-01 10:08:30 +00001229 }
1230 }
1231#endif // OMPT_SUPPORT
1232
Jonathan Peyton30419822017-05-12 18:01:32 +00001233 if (this_thr->th.th_team != serial_team) {
1234 // Nested level will be an index in the nested nthreads array
1235 int level = this_thr->th.th_team->t.t_level;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001236
Jonathan Peyton30419822017-05-12 18:01:32 +00001237 if (serial_team->t.t_serialized) {
1238 /* this serial team was already used
1239 TODO increase performance by making this locks more specific */
1240 kmp_team_t *new_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001241
Jonathan Peyton30419822017-05-12 18:01:32 +00001242 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001243
Jonathan Peyton30419822017-05-12 18:01:32 +00001244 new_team = __kmp_allocate_team(this_thr->th.th_root, 1, 1,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001245#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001246 ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001247#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001248#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001249 proc_bind,
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001250#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001251 &this_thr->th.th_current_task->td_icvs,
1252 0 USE_NESTED_HOT_ARG(NULL));
1253 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
1254 KMP_ASSERT(new_team);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001255
Jonathan Peyton30419822017-05-12 18:01:32 +00001256 /* setup new serialized team and install it */
1257 new_team->t.t_threads[0] = this_thr;
1258 new_team->t.t_parent = this_thr->th.th_team;
1259 serial_team = new_team;
1260 this_thr->th.th_serial_team = serial_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001261
Jonathan Peyton30419822017-05-12 18:01:32 +00001262 KF_TRACE(
1263 10,
1264 ("__kmpc_serialized_parallel: T#%d allocated new serial team %p\n",
1265 global_tid, serial_team));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001266
Jonathan Peyton30419822017-05-12 18:01:32 +00001267 /* TODO the above breaks the requirement that if we run out of resources,
1268 then we can still guarantee that serialized teams are ok, since we may
1269 need to allocate a new one */
1270 } else {
1271 KF_TRACE(
1272 10,
1273 ("__kmpc_serialized_parallel: T#%d reusing cached serial team %p\n",
1274 global_tid, serial_team));
1275 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001276
Jonathan Peyton30419822017-05-12 18:01:32 +00001277 /* we have to initialize this serial team */
1278 KMP_DEBUG_ASSERT(serial_team->t.t_threads);
1279 KMP_DEBUG_ASSERT(serial_team->t.t_threads[0] == this_thr);
1280 KMP_DEBUG_ASSERT(this_thr->th.th_team != serial_team);
1281 serial_team->t.t_ident = loc;
1282 serial_team->t.t_serialized = 1;
1283 serial_team->t.t_nproc = 1;
1284 serial_team->t.t_parent = this_thr->th.th_team;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00001285 serial_team->t.t_sched.sched = this_thr->th.th_team->t.t_sched.sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00001286 this_thr->th.th_team = serial_team;
1287 serial_team->t.t_master_tid = this_thr->th.th_info.ds.ds_tid;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001288
Jonathan Peyton30419822017-05-12 18:01:32 +00001289 KF_TRACE(10, ("__kmpc_serialized_parallel: T#d curtask=%p\n", global_tid,
1290 this_thr->th.th_current_task));
1291 KMP_ASSERT(this_thr->th.th_current_task->td_flags.executing == 1);
1292 this_thr->th.th_current_task->td_flags.executing = 0;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001293
Jonathan Peyton30419822017-05-12 18:01:32 +00001294 __kmp_push_current_task_to_thread(this_thr, serial_team, 0);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001295
Jonathan Peyton30419822017-05-12 18:01:32 +00001296 /* TODO: GEH: do ICVs work for nested serialized teams? Don't we need an
1297 implicit task for each serialized task represented by
1298 team->t.t_serialized? */
1299 copy_icvs(&this_thr->th.th_current_task->td_icvs,
1300 &this_thr->th.th_current_task->td_parent->td_icvs);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001301
Jonathan Peyton30419822017-05-12 18:01:32 +00001302 // Thread value exists in the nested nthreads array for the next nested
1303 // level
1304 if (__kmp_nested_nth.used && (level + 1 < __kmp_nested_nth.used)) {
1305 this_thr->th.th_current_task->td_icvs.nproc =
1306 __kmp_nested_nth.nth[level + 1];
1307 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001308
1309#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001310 if (__kmp_nested_proc_bind.used &&
1311 (level + 1 < __kmp_nested_proc_bind.used)) {
1312 this_thr->th.th_current_task->td_icvs.proc_bind =
1313 __kmp_nested_proc_bind.bind_types[level + 1];
1314 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001315#endif /* OMP_40_ENABLED */
1316
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001317#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00001318 serial_team->t.t_pkfn = (microtask_t)(~0); // For the debugger.
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00001319#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001320 this_thr->th.th_info.ds.ds_tid = 0;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001321
Jonathan Peyton30419822017-05-12 18:01:32 +00001322 /* set thread cache values */
1323 this_thr->th.th_team_nproc = 1;
1324 this_thr->th.th_team_master = this_thr;
1325 this_thr->th.th_team_serialized = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001326
Jonathan Peyton30419822017-05-12 18:01:32 +00001327 serial_team->t.t_level = serial_team->t.t_parent->t.t_level + 1;
1328 serial_team->t.t_active_level = serial_team->t.t_parent->t.t_active_level;
Jonathan Peyton92ca6182018-09-07 18:25:49 +00001329#if OMP_50_ENABLED
1330 serial_team->t.t_def_allocator = this_thr->th.th_def_allocator; // save
1331#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001332
Jonathan Peyton30419822017-05-12 18:01:32 +00001333 propagateFPControl(serial_team);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001334
Jonathan Peyton30419822017-05-12 18:01:32 +00001335 /* check if we need to allocate dispatch buffers stack */
1336 KMP_DEBUG_ASSERT(serial_team->t.t_dispatch);
1337 if (!serial_team->t.t_dispatch->th_disp_buffer) {
1338 serial_team->t.t_dispatch->th_disp_buffer =
1339 (dispatch_private_info_t *)__kmp_allocate(
1340 sizeof(dispatch_private_info_t));
1341 }
1342 this_thr->th.th_dispatch = serial_team->t.t_dispatch;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001343
Jonathan Peyton30419822017-05-12 18:01:32 +00001344 KMP_MB();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001345
Jonathan Peyton30419822017-05-12 18:01:32 +00001346 } else {
1347 /* this serialized team is already being used,
1348 * that's fine, just add another nested level */
1349 KMP_DEBUG_ASSERT(this_thr->th.th_team == serial_team);
1350 KMP_DEBUG_ASSERT(serial_team->t.t_threads);
1351 KMP_DEBUG_ASSERT(serial_team->t.t_threads[0] == this_thr);
1352 ++serial_team->t.t_serialized;
1353 this_thr->th.th_team_serialized = serial_team->t.t_serialized;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001354
Jonathan Peyton30419822017-05-12 18:01:32 +00001355 // Nested level will be an index in the nested nthreads array
1356 int level = this_thr->th.th_team->t.t_level;
1357 // Thread value exists in the nested nthreads array for the next nested
1358 // level
1359 if (__kmp_nested_nth.used && (level + 1 < __kmp_nested_nth.used)) {
1360 this_thr->th.th_current_task->td_icvs.nproc =
1361 __kmp_nested_nth.nth[level + 1];
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001362 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001363 serial_team->t.t_level++;
1364 KF_TRACE(10, ("__kmpc_serialized_parallel: T#%d increasing nesting level "
1365 "of serial team %p to %d\n",
1366 global_tid, serial_team, serial_team->t.t_level));
1367
1368 /* allocate/push dispatch buffers stack */
1369 KMP_DEBUG_ASSERT(serial_team->t.t_dispatch);
1370 {
1371 dispatch_private_info_t *disp_buffer =
1372 (dispatch_private_info_t *)__kmp_allocate(
1373 sizeof(dispatch_private_info_t));
1374 disp_buffer->next = serial_team->t.t_dispatch->th_disp_buffer;
1375 serial_team->t.t_dispatch->th_disp_buffer = disp_buffer;
1376 }
1377 this_thr->th.th_dispatch = serial_team->t.t_dispatch;
1378
1379 KMP_MB();
1380 }
Olga Malyshevadbdcfa12017-04-04 13:56:50 +00001381#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001382 KMP_CHECK_UPDATE(serial_team->t.t_cancel_request, cancel_noreq);
Olga Malyshevadbdcfa12017-04-04 13:56:50 +00001383#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001384
Jonathan Peyton30419822017-05-12 18:01:32 +00001385 if (__kmp_env_consistency_check)
1386 __kmp_push_parallel(global_tid, NULL);
Joachim Protze82e94a52017-11-01 10:08:30 +00001387#if OMPT_SUPPORT
1388 serial_team->t.ompt_team_info.master_return_address = codeptr;
1389 if (ompt_enabled.enabled &&
1390 this_thr->th.ompt_thread_info.state != omp_state_overhead) {
Joachim Protzec255ca72017-11-05 14:11:10 +00001391 OMPT_CUR_TASK_INFO(this_thr)->frame.exit_frame = OMPT_GET_FRAME_ADDRESS(1);
Joachim Protze82e94a52017-11-01 10:08:30 +00001392
1393 ompt_lw_taskteam_t lw_taskteam;
1394 __ompt_lw_taskteam_init(&lw_taskteam, this_thr, global_tid,
1395 &ompt_parallel_data, codeptr);
1396
1397 __ompt_lw_taskteam_link(&lw_taskteam, this_thr, 1);
1398 // don't use lw_taskteam after linking. content was swaped
1399
1400 /* OMPT implicit task begin */
1401 implicit_task_data = OMPT_CUR_TASK_DATA(this_thr);
1402 if (ompt_enabled.ompt_callback_implicit_task) {
1403 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1404 ompt_scope_begin, OMPT_CUR_TEAM_DATA(this_thr),
1405 OMPT_CUR_TASK_DATA(this_thr), 1, __kmp_tid_from_gtid(global_tid));
Joachim Protze9be9cf22018-05-07 12:42:21 +00001406 OMPT_CUR_TASK_INFO(this_thr)
1407 ->thread_num = __kmp_tid_from_gtid(global_tid);
Joachim Protze82e94a52017-11-01 10:08:30 +00001408 }
1409
1410 /* OMPT state */
1411 this_thr->th.ompt_thread_info.state = omp_state_work_parallel;
Joachim Protzec255ca72017-11-05 14:11:10 +00001412 OMPT_CUR_TASK_INFO(this_thr)->frame.exit_frame = OMPT_GET_FRAME_ADDRESS(1);
Joachim Protze82e94a52017-11-01 10:08:30 +00001413 }
1414#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001415}
Jim Cownie181b4bb2013-12-23 17:28:57 +00001416
Jim Cownie5e8470a2013-09-27 10:38:44 +00001417/* most of the work for a fork */
1418/* return true if we really went parallel, false if serialized */
Jonathan Peyton30419822017-05-12 18:01:32 +00001419int __kmp_fork_call(ident_t *loc, int gtid,
1420 enum fork_context_e call_context, // Intel, GNU, ...
Joachim Protze82e94a52017-11-01 10:08:30 +00001421 kmp_int32 argc, microtask_t microtask, launch_t invoker,
Jim Cownie5e8470a2013-09-27 10:38:44 +00001422/* TODO: revert workaround for Intel(R) 64 tracker #96 */
Andrey Churbanovcbda8682015-01-13 14:43:35 +00001423#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00001424 va_list *ap
Jim Cownie5e8470a2013-09-27 10:38:44 +00001425#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001426 va_list ap
Jim Cownie5e8470a2013-09-27 10:38:44 +00001427#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001428 ) {
1429 void **argv;
1430 int i;
1431 int master_tid;
1432 int master_this_cons;
1433 kmp_team_t *team;
1434 kmp_team_t *parent_team;
1435 kmp_info_t *master_th;
1436 kmp_root_t *root;
1437 int nthreads;
1438 int master_active;
1439 int master_set_numthreads;
1440 int level;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001441#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001442 int active_level;
1443 int teams_level;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001444#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001445#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00001446 kmp_hot_team_ptr_t **p_hot_teams;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001447#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001448 { // KMP_TIME_BLOCK
Jonathan Peyton5375fe82016-11-14 21:13:44 +00001449 KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(KMP_fork_call);
Jonathan Peyton45be4502015-08-11 21:36:41 +00001450 KMP_COUNT_VALUE(OMP_PARALLEL_args, argc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001451
Jonathan Peyton30419822017-05-12 18:01:32 +00001452 KA_TRACE(20, ("__kmp_fork_call: enter T#%d\n", gtid));
1453 if (__kmp_stkpadding > 0 && __kmp_root[gtid] != NULL) {
1454 /* Some systems prefer the stack for the root thread(s) to start with */
1455 /* some gap from the parent stack to prevent false sharing. */
1456 void *dummy = KMP_ALLOCA(__kmp_stkpadding);
1457 /* These 2 lines below are so this does not get optimized out */
1458 if (__kmp_stkpadding > KMP_MAX_STKPADDING)
1459 __kmp_stkpadding += (short)((kmp_int64)dummy);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001460 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001461
1462 /* initialize if needed */
Jonathan Peyton30419822017-05-12 18:01:32 +00001463 KMP_DEBUG_ASSERT(
1464 __kmp_init_serial); // AC: potentially unsafe, not in sync with shutdown
1465 if (!TCR_4(__kmp_init_parallel))
1466 __kmp_parallel_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00001467
1468 /* setup current data */
Jonathan Peyton30419822017-05-12 18:01:32 +00001469 master_th = __kmp_threads[gtid]; // AC: potentially unsafe, not in sync with
1470 // shutdown
1471 parent_team = master_th->th.th_team;
1472 master_tid = master_th->th.th_info.ds.ds_tid;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001473 master_this_cons = master_th->th.th_local.this_construct;
Jonathan Peyton30419822017-05-12 18:01:32 +00001474 root = master_th->th.th_root;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001475 master_active = root->r.r_active;
1476 master_set_numthreads = master_th->th.th_set_nproc;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001477
1478#if OMPT_SUPPORT
Jonathan Peyton3574f282018-10-04 14:57:04 +00001479 ompt_data_t ompt_parallel_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00001480 ompt_data_t *parent_task_data;
Joachim Protzec5836064b2018-05-28 08:14:58 +00001481 omp_frame_t *ompt_frame;
Joachim Protze82e94a52017-11-01 10:08:30 +00001482 ompt_data_t *implicit_task_data;
1483 void *return_address = NULL;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001484
Joachim Protze82e94a52017-11-01 10:08:30 +00001485 if (ompt_enabled.enabled) {
1486 __ompt_get_task_info_internal(0, NULL, &parent_task_data, &ompt_frame,
1487 NULL, NULL);
1488 return_address = OMPT_LOAD_RETURN_ADDRESS(gtid);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001489 }
1490#endif
1491
Jim Cownie5e8470a2013-09-27 10:38:44 +00001492 // Nested level will be an index in the nested nthreads array
Jonathan Peyton30419822017-05-12 18:01:32 +00001493 level = parent_team->t.t_level;
1494 // used to launch non-serial teams even if nested is not allowed
1495 active_level = parent_team->t.t_active_level;
Jonathan Peytonc76f9f02016-06-21 19:12:07 +00001496#if OMP_40_ENABLED
Jonathan Peyton642688b2017-06-01 16:46:36 +00001497 // needed to check nesting inside the teams
1498 teams_level = master_th->th.th_teams_level;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001499#endif
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001500#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00001501 p_hot_teams = &master_th->th.th_hot_teams;
1502 if (*p_hot_teams == NULL && __kmp_hot_teams_max_level > 0) {
1503 *p_hot_teams = (kmp_hot_team_ptr_t *)__kmp_allocate(
1504 sizeof(kmp_hot_team_ptr_t) * __kmp_hot_teams_max_level);
1505 (*p_hot_teams)[0].hot_team = root->r.r_hot_team;
Jonathan Peyton642688b2017-06-01 16:46:36 +00001506 // it is either actual or not needed (when active_level > 0)
1507 (*p_hot_teams)[0].hot_team_nth = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001508 }
1509#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001510
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001511#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001512 if (ompt_enabled.enabled) {
1513 if (ompt_enabled.ompt_callback_parallel_begin) {
1514 int team_size = master_set_numthreads
1515 ? master_set_numthreads
1516 : get__nproc_2(parent_team, master_tid);
1517 ompt_callbacks.ompt_callback(ompt_callback_parallel_begin)(
1518 parent_task_data, ompt_frame, &ompt_parallel_data, team_size,
1519 OMPT_INVOKER(call_context), return_address);
1520 }
1521 master_th->th.ompt_thread_info.state = omp_state_overhead;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001522 }
1523#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001524
Jim Cownie5e8470a2013-09-27 10:38:44 +00001525 master_th->th.th_ident = loc;
1526
1527#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001528 if (master_th->th.th_teams_microtask && ap &&
1529 microtask != (microtask_t)__kmp_teams_master && level == teams_level) {
1530 // AC: This is start of parallel that is nested inside teams construct.
1531 // The team is actual (hot), all workers are ready at the fork barrier.
1532 // No lock needed to initialize the team a bit, then free workers.
1533 parent_team->t.t_ident = loc;
1534 __kmp_alloc_argv_entries(argc, parent_team, TRUE);
1535 parent_team->t.t_argc = argc;
1536 argv = (void **)parent_team->t.t_argv;
1537 for (i = argc - 1; i >= 0; --i)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001538/* TODO: revert workaround for Intel(R) 64 tracker #96 */
Andrey Churbanovcbda8682015-01-13 14:43:35 +00001539#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00001540 *argv++ = va_arg(*ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001541#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001542 *argv++ = va_arg(ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001543#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001544 // Increment our nested depth levels, but not increase the serialization
1545 if (parent_team == master_th->th.th_serial_team) {
1546 // AC: we are in serialized parallel
1547 __kmpc_serialized_parallel(loc, gtid);
1548 KMP_DEBUG_ASSERT(parent_team->t.t_serialized > 1);
1549 // AC: need this in order enquiry functions work
1550 // correctly, will restore at join time
1551 parent_team->t.t_serialized--;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001552#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001553 void *dummy;
1554 void **exit_runtime_p;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001555
Jonathan Peyton30419822017-05-12 18:01:32 +00001556 ompt_lw_taskteam_t lw_taskteam;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001557
Joachim Protze82e94a52017-11-01 10:08:30 +00001558 if (ompt_enabled.enabled) {
1559 __ompt_lw_taskteam_init(&lw_taskteam, master_th, gtid,
1560 &ompt_parallel_data, return_address);
Joachim Protzec255ca72017-11-05 14:11:10 +00001561 exit_runtime_p = &(lw_taskteam.ompt_task_info.frame.exit_frame);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001562
Joachim Protze82e94a52017-11-01 10:08:30 +00001563 __ompt_lw_taskteam_link(&lw_taskteam, master_th, 0);
1564 // don't use lw_taskteam after linking. content was swaped
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001565
Jonathan Peyton30419822017-05-12 18:01:32 +00001566 /* OMPT implicit task begin */
Joachim Protze82e94a52017-11-01 10:08:30 +00001567 implicit_task_data = OMPT_CUR_TASK_DATA(master_th);
1568 if (ompt_enabled.ompt_callback_implicit_task) {
1569 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1570 ompt_scope_begin, OMPT_CUR_TEAM_DATA(master_th),
1571 implicit_task_data, 1, __kmp_tid_from_gtid(gtid));
Joachim Protze9be9cf22018-05-07 12:42:21 +00001572 OMPT_CUR_TASK_INFO(master_th)
1573 ->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001574 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001575
Jonathan Peyton30419822017-05-12 18:01:32 +00001576 /* OMPT state */
Joachim Protze82e94a52017-11-01 10:08:30 +00001577 master_th->th.ompt_thread_info.state = omp_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00001578 } else {
1579 exit_runtime_p = &dummy;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001580 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001581#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001582
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001583 {
Jonathan Peyton30419822017-05-12 18:01:32 +00001584 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
1585 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
1586 __kmp_invoke_microtask(microtask, gtid, 0, argc, parent_team->t.t_argv
1587#if OMPT_SUPPORT
1588 ,
1589 exit_runtime_p
1590#endif
1591 );
Jim Cownie5e8470a2013-09-27 10:38:44 +00001592 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001593
Jonathan Peyton30419822017-05-12 18:01:32 +00001594#if OMPT_SUPPORT
1595 *exit_runtime_p = NULL;
Joachim Protze82e94a52017-11-01 10:08:30 +00001596 if (ompt_enabled.enabled) {
Joachim Protzec255ca72017-11-05 14:11:10 +00001597 OMPT_CUR_TASK_INFO(master_th)->frame.exit_frame = NULL;
Joachim Protze82e94a52017-11-01 10:08:30 +00001598 if (ompt_enabled.ompt_callback_implicit_task) {
1599 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1600 ompt_scope_end, NULL, implicit_task_data, 1,
Joachim Protze9be9cf22018-05-07 12:42:21 +00001601 OMPT_CUR_TASK_INFO(master_th)->thread_num);
Jonathan Peyton30419822017-05-12 18:01:32 +00001602 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001603 __ompt_lw_taskteam_unlink(master_th);
Jonathan Peyton30419822017-05-12 18:01:32 +00001604
Joachim Protze82e94a52017-11-01 10:08:30 +00001605 if (ompt_enabled.ompt_callback_parallel_end) {
1606 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
1607 OMPT_CUR_TEAM_DATA(master_th), OMPT_CUR_TASK_DATA(master_th),
1608 OMPT_INVOKER(call_context), return_address);
Jonathan Peyton30419822017-05-12 18:01:32 +00001609 }
Joachim Protze82e94a52017-11-01 10:08:30 +00001610 master_th->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00001611 }
1612#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001613 return TRUE;
Jonathan Peyton30419822017-05-12 18:01:32 +00001614 }
1615
1616 parent_team->t.t_pkfn = microtask;
Jonathan Peyton30419822017-05-12 18:01:32 +00001617 parent_team->t.t_invoke = invoker;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00001618 KMP_ATOMIC_INC(&root->r.r_in_parallel);
Jonathan Peyton30419822017-05-12 18:01:32 +00001619 parent_team->t.t_active_level++;
1620 parent_team->t.t_level++;
Jonathan Peyton92ca6182018-09-07 18:25:49 +00001621#if OMP_50_ENABLED
1622 parent_team->t.t_def_allocator = master_th->th.th_def_allocator; // save
1623#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001624
1625 /* Change number of threads in the team if requested */
1626 if (master_set_numthreads) { // The parallel has num_threads clause
1627 if (master_set_numthreads < master_th->th.th_teams_size.nth) {
1628 // AC: only can reduce number of threads dynamically, can't increase
1629 kmp_info_t **other_threads = parent_team->t.t_threads;
1630 parent_team->t.t_nproc = master_set_numthreads;
1631 for (i = 0; i < master_set_numthreads; ++i) {
1632 other_threads[i]->th.th_team_nproc = master_set_numthreads;
1633 }
1634 // Keep extra threads hot in the team for possible next parallels
1635 }
1636 master_th->th.th_set_nproc = 0;
1637 }
1638
1639#if USE_DEBUGGER
1640 if (__kmp_debugging) { // Let debugger override number of threads.
1641 int nth = __kmp_omp_num_threads(loc);
Jonathan Peyton642688b2017-06-01 16:46:36 +00001642 if (nth > 0) { // 0 means debugger doesn't want to change num threads
Jonathan Peyton30419822017-05-12 18:01:32 +00001643 master_set_numthreads = nth;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00001644 }
1645 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001646#endif
1647
1648 KF_TRACE(10, ("__kmp_fork_call: before internal fork: root=%p, team=%p, "
1649 "master_th=%p, gtid=%d\n",
1650 root, parent_team, master_th, gtid));
1651 __kmp_internal_fork(loc, gtid, parent_team);
1652 KF_TRACE(10, ("__kmp_fork_call: after internal fork: root=%p, team=%p, "
1653 "master_th=%p, gtid=%d\n",
1654 root, parent_team, master_th, gtid));
1655
1656 /* Invoke microtask for MASTER thread */
1657 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) invoke microtask = %p\n", gtid,
1658 parent_team->t.t_id, parent_team->t.t_pkfn));
1659
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00001660 if (!parent_team->t.t_invoke(gtid)) {
1661 KMP_ASSERT2(0, "cannot invoke microtask for MASTER thread");
Jonathan Peyton30419822017-05-12 18:01:32 +00001662 }
1663 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) done microtask = %p\n", gtid,
1664 parent_team->t.t_id, parent_team->t.t_pkfn));
1665 KMP_MB(); /* Flush all pending memory write invalidates. */
1666
1667 KA_TRACE(20, ("__kmp_fork_call: parallel exit T#%d\n", gtid));
1668
1669 return TRUE;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001670 } // Parallel closely nested in teams construct
Jim Cownie5e8470a2013-09-27 10:38:44 +00001671#endif /* OMP_40_ENABLED */
1672
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001673#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00001674 if (__kmp_tasking_mode != tskm_immediate_exec) {
1675 KMP_DEBUG_ASSERT(master_th->th.th_task_team ==
1676 parent_team->t.t_task_team[master_th->th.th_task_state]);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001677 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001678#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001679
Jonathan Peyton30419822017-05-12 18:01:32 +00001680 if (parent_team->t.t_active_level >=
1681 master_th->th.th_current_task->td_icvs.max_active_levels) {
1682 nthreads = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001683 } else {
Andrey Churbanov92effc42015-08-18 10:08:27 +00001684#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001685 int enter_teams = ((ap == NULL && active_level == 0) ||
1686 (ap && teams_level > 0 && teams_level == level));
Andrey Churbanov92effc42015-08-18 10:08:27 +00001687#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001688 nthreads =
1689 master_set_numthreads
1690 ? master_set_numthreads
1691 : get__nproc_2(
1692 parent_team,
1693 master_tid); // TODO: get nproc directly from current task
Andrey Churbanov92effc42015-08-18 10:08:27 +00001694
Jonathan Peyton30419822017-05-12 18:01:32 +00001695 // Check if we need to take forkjoin lock? (no need for serialized
1696 // parallel out of teams construct). This code moved here from
1697 // __kmp_reserve_threads() to speedup nested serialized parallels.
1698 if (nthreads > 1) {
1699 if ((!get__nested(master_th) && (root->r.r_in_parallel
Andrey Churbanov92effc42015-08-18 10:08:27 +00001700#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001701 && !enter_teams
Andrey Churbanov92effc42015-08-18 10:08:27 +00001702#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00001703 )) ||
1704 (__kmp_library == library_serial)) {
Jonathan Peyton642688b2017-06-01 16:46:36 +00001705 KC_TRACE(10, ("__kmp_fork_call: T#%d serializing team; requested %d"
1706 " threads\n",
1707 gtid, nthreads));
Jonathan Peyton30419822017-05-12 18:01:32 +00001708 nthreads = 1;
Andrey Churbanov92effc42015-08-18 10:08:27 +00001709 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001710 }
1711 if (nthreads > 1) {
1712 /* determine how many new threads we can use */
1713 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jonathan Peyton30419822017-05-12 18:01:32 +00001714 nthreads = __kmp_reserve_threads(
1715 root, parent_team, master_tid, nthreads
Jim Cownie5e8470a2013-09-27 10:38:44 +00001716#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001717 /* AC: If we execute teams from parallel region (on host), then
1718 teams should be created but each can only have 1 thread if
1719 nesting is disabled. If teams called from serial region, then
1720 teams and their threads should be created regardless of the
1721 nesting setting. */
1722 ,
1723 enter_teams
Jim Cownie5e8470a2013-09-27 10:38:44 +00001724#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00001725 );
1726 if (nthreads == 1) {
1727 // Free lock for single thread execution here; for multi-thread
1728 // execution it will be freed later after team of threads created
1729 // and initialized
1730 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Andrey Churbanov92effc42015-08-18 10:08:27 +00001731 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001732 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00001733 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001734 KMP_DEBUG_ASSERT(nthreads > 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001735
Jonathan Peyton30419822017-05-12 18:01:32 +00001736 // If we temporarily changed the set number of threads then restore it now
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001737 master_th->th.th_set_nproc = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001738
Jim Cownie5e8470a2013-09-27 10:38:44 +00001739 /* create a serialized parallel region? */
Jonathan Peyton30419822017-05-12 18:01:32 +00001740 if (nthreads == 1) {
1741/* josh todo: hypothetical question: what do we do for OS X*? */
1742#if KMP_OS_LINUX && \
1743 (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
1744 void *args[argc];
Jim Cownie5e8470a2013-09-27 10:38:44 +00001745#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001746 void **args = (void **)KMP_ALLOCA(argc * sizeof(void *));
1747#endif /* KMP_OS_LINUX && ( KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || \
1748 KMP_ARCH_AARCH64) */
Jim Cownie5e8470a2013-09-27 10:38:44 +00001749
Jonathan Peyton30419822017-05-12 18:01:32 +00001750 KA_TRACE(20,
1751 ("__kmp_fork_call: T#%d serializing parallel region\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00001752
Jonathan Peyton30419822017-05-12 18:01:32 +00001753 __kmpc_serialized_parallel(loc, gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001754
Jonathan Peyton30419822017-05-12 18:01:32 +00001755 if (call_context == fork_context_intel) {
1756 /* TODO this sucks, use the compiler itself to pass args! :) */
1757 master_th->th.th_serial_team->t.t_ident = loc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001758#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001759 if (!ap) {
1760 // revert change made in __kmpc_serialized_parallel()
1761 master_th->th.th_serial_team->t.t_level--;
1762// Get args from parent team for teams construct
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001763
1764#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001765 void *dummy;
1766 void **exit_runtime_p;
Joachim Protze82e94a52017-11-01 10:08:30 +00001767 ompt_task_info_t *task_info;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001768
Jonathan Peyton30419822017-05-12 18:01:32 +00001769 ompt_lw_taskteam_t lw_taskteam;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001770
Joachim Protze82e94a52017-11-01 10:08:30 +00001771 if (ompt_enabled.enabled) {
Jonathan Peyton30419822017-05-12 18:01:32 +00001772 __ompt_lw_taskteam_init(&lw_taskteam, master_th, gtid,
Joachim Protze82e94a52017-11-01 10:08:30 +00001773 &ompt_parallel_data, return_address);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001774
Joachim Protze82e94a52017-11-01 10:08:30 +00001775 __ompt_lw_taskteam_link(&lw_taskteam, master_th, 0);
1776 // don't use lw_taskteam after linking. content was swaped
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001777
Joachim Protze82e94a52017-11-01 10:08:30 +00001778 task_info = OMPT_CUR_TASK_INFO(master_th);
Joachim Protzec255ca72017-11-05 14:11:10 +00001779 exit_runtime_p = &(task_info->frame.exit_frame);
Joachim Protze82e94a52017-11-01 10:08:30 +00001780 if (ompt_enabled.ompt_callback_implicit_task) {
1781 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1782 ompt_scope_begin, OMPT_CUR_TEAM_DATA(master_th),
1783 &(task_info->task_data), 1, __kmp_tid_from_gtid(gtid));
Joachim Protze9be9cf22018-05-07 12:42:21 +00001784 OMPT_CUR_TASK_INFO(master_th)
1785 ->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001786 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001787
Jonathan Peyton30419822017-05-12 18:01:32 +00001788 /* OMPT state */
Joachim Protze82e94a52017-11-01 10:08:30 +00001789 master_th->th.ompt_thread_info.state = omp_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00001790 } else {
1791 exit_runtime_p = &dummy;
1792 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001793#endif
1794
Jonathan Peyton30419822017-05-12 18:01:32 +00001795 {
1796 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
1797 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
1798 __kmp_invoke_microtask(microtask, gtid, 0, argc,
1799 parent_team->t.t_argv
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001800#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001801 ,
1802 exit_runtime_p
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001803#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001804 );
1805 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001806
1807#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001808 if (ompt_enabled.enabled) {
1809 exit_runtime_p = NULL;
1810 if (ompt_enabled.ompt_callback_implicit_task) {
1811 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1812 ompt_scope_end, NULL, &(task_info->task_data), 1,
Joachim Protze9be9cf22018-05-07 12:42:21 +00001813 OMPT_CUR_TASK_INFO(master_th)->thread_num);
Jonathan Peyton30419822017-05-12 18:01:32 +00001814 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001815
Jonathan Peyton30419822017-05-12 18:01:32 +00001816 __ompt_lw_taskteam_unlink(master_th);
Joachim Protze82e94a52017-11-01 10:08:30 +00001817 if (ompt_enabled.ompt_callback_parallel_end) {
1818 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
1819 OMPT_CUR_TEAM_DATA(master_th), parent_task_data,
1820 OMPT_INVOKER(call_context), return_address);
Jonathan Peyton30419822017-05-12 18:01:32 +00001821 }
Joachim Protze82e94a52017-11-01 10:08:30 +00001822 master_th->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00001823 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001824#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001825 } else if (microtask == (microtask_t)__kmp_teams_master) {
1826 KMP_DEBUG_ASSERT(master_th->th.th_team ==
1827 master_th->th.th_serial_team);
1828 team = master_th->th.th_team;
1829 // team->t.t_pkfn = microtask;
1830 team->t.t_invoke = invoker;
1831 __kmp_alloc_argv_entries(argc, team, TRUE);
1832 team->t.t_argc = argc;
1833 argv = (void **)team->t.t_argv;
1834 if (ap) {
1835 for (i = argc - 1; i >= 0; --i)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001836// TODO: revert workaround for Intel(R) 64 tracker #96
Andrey Churbanovcbda8682015-01-13 14:43:35 +00001837#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00001838 *argv++ = va_arg(*ap, void *);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001839#else
Jonathan Peyton30419822017-05-12 18:01:32 +00001840 *argv++ = va_arg(ap, void *);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001841#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001842 } else {
1843 for (i = 0; i < argc; ++i)
1844 // Get args from parent team for teams construct
1845 argv[i] = parent_team->t.t_argv[i];
1846 }
1847 // AC: revert change made in __kmpc_serialized_parallel()
1848 // because initial code in teams should have level=0
1849 team->t.t_level--;
1850 // AC: call special invoker for outer "parallel" of teams construct
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00001851 invoker(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001852 } else {
1853#endif /* OMP_40_ENABLED */
1854 argv = args;
1855 for (i = argc - 1; i >= 0; --i)
1856// TODO: revert workaround for Intel(R) 64 tracker #96
1857#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
1858 *argv++ = va_arg(*ap, void *);
1859#else
1860 *argv++ = va_arg(ap, void *);
1861#endif
1862 KMP_MB();
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001863
1864#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001865 void *dummy;
1866 void **exit_runtime_p;
Joachim Protze82e94a52017-11-01 10:08:30 +00001867 ompt_task_info_t *task_info;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001868
Jonathan Peyton30419822017-05-12 18:01:32 +00001869 ompt_lw_taskteam_t lw_taskteam;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001870
Joachim Protze82e94a52017-11-01 10:08:30 +00001871 if (ompt_enabled.enabled) {
Jonathan Peyton30419822017-05-12 18:01:32 +00001872 __ompt_lw_taskteam_init(&lw_taskteam, master_th, gtid,
Joachim Protze82e94a52017-11-01 10:08:30 +00001873 &ompt_parallel_data, return_address);
1874 __ompt_lw_taskteam_link(&lw_taskteam, master_th, 0);
1875 // don't use lw_taskteam after linking. content was swaped
1876 task_info = OMPT_CUR_TASK_INFO(master_th);
Joachim Protzec255ca72017-11-05 14:11:10 +00001877 exit_runtime_p = &(task_info->frame.exit_frame);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001878
Jonathan Peyton30419822017-05-12 18:01:32 +00001879 /* OMPT implicit task begin */
Joachim Protze82e94a52017-11-01 10:08:30 +00001880 implicit_task_data = OMPT_CUR_TASK_DATA(master_th);
1881 if (ompt_enabled.ompt_callback_implicit_task) {
1882 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1883 ompt_scope_begin, OMPT_CUR_TEAM_DATA(master_th),
1884 implicit_task_data, 1, __kmp_tid_from_gtid(gtid));
Joachim Protze9be9cf22018-05-07 12:42:21 +00001885 OMPT_CUR_TASK_INFO(master_th)
1886 ->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00001887 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001888
Jonathan Peyton30419822017-05-12 18:01:32 +00001889 /* OMPT state */
Joachim Protze82e94a52017-11-01 10:08:30 +00001890 master_th->th.ompt_thread_info.state = omp_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00001891 } else {
1892 exit_runtime_p = &dummy;
1893 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001894#endif
1895
Jonathan Peyton30419822017-05-12 18:01:32 +00001896 {
1897 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
1898 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
1899 __kmp_invoke_microtask(microtask, gtid, 0, argc, args
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001900#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00001901 ,
1902 exit_runtime_p
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001903#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00001904 );
1905 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001906
1907#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001908 if (ompt_enabled.enabled) {
1909 *exit_runtime_p = NULL;
1910 if (ompt_enabled.ompt_callback_implicit_task) {
1911 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
1912 ompt_scope_end, NULL, &(task_info->task_data), 1,
Joachim Protze9be9cf22018-05-07 12:42:21 +00001913 OMPT_CUR_TASK_INFO(master_th)->thread_num);
Jonathan Peyton30419822017-05-12 18:01:32 +00001914 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001915
Joachim Protze82e94a52017-11-01 10:08:30 +00001916 ompt_parallel_data = *OMPT_CUR_TEAM_DATA(master_th);
Jonathan Peyton30419822017-05-12 18:01:32 +00001917 __ompt_lw_taskteam_unlink(master_th);
Joachim Protze82e94a52017-11-01 10:08:30 +00001918 if (ompt_enabled.ompt_callback_parallel_end) {
1919 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
1920 &ompt_parallel_data, parent_task_data,
1921 OMPT_INVOKER(call_context), return_address);
Jonathan Peyton30419822017-05-12 18:01:32 +00001922 }
Joachim Protze82e94a52017-11-01 10:08:30 +00001923 master_th->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00001924 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001925#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00001926#if OMP_40_ENABLED
Jim Cownie5e8470a2013-09-27 10:38:44 +00001927 }
Jonathan Peyton30419822017-05-12 18:01:32 +00001928#endif /* OMP_40_ENABLED */
1929 } else if (call_context == fork_context_gnu) {
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001930#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00001931 ompt_lw_taskteam_t lwt;
1932 __ompt_lw_taskteam_init(&lwt, master_th, gtid, &ompt_parallel_data,
1933 return_address);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001934
Joachim Protzec255ca72017-11-05 14:11:10 +00001935 lwt.ompt_task_info.frame.exit_frame = NULL;
Joachim Protze82e94a52017-11-01 10:08:30 +00001936 __ompt_lw_taskteam_link(&lwt, master_th, 1);
1937// don't use lw_taskteam after linking. content was swaped
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00001938#endif
1939
Jonathan Peyton30419822017-05-12 18:01:32 +00001940 // we were called from GNU native code
1941 KA_TRACE(20, ("__kmp_fork_call: T#%d serial exit\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00001942 return FALSE;
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00001943 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00001944 KMP_ASSERT2(call_context < fork_context_last,
1945 "__kmp_fork_call: unknown fork_context parameter");
1946 }
1947
1948 KA_TRACE(20, ("__kmp_fork_call: T#%d serial exit\n", gtid));
1949 KMP_MB();
1950 return FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001951 }
1952
Jim Cownie5e8470a2013-09-27 10:38:44 +00001953 // GEH: only modify the executing flag in the case when not serialized
1954 // serialized case is handled in kmpc_serialized_parallel
Jonathan Peyton30419822017-05-12 18:01:32 +00001955 KF_TRACE(10, ("__kmp_fork_call: parent_team_aclevel=%d, master_th=%p, "
1956 "curtask=%p, curtask_max_aclevel=%d\n",
1957 parent_team->t.t_active_level, master_th,
1958 master_th->th.th_current_task,
1959 master_th->th.th_current_task->td_icvs.max_active_levels));
1960 // TODO: GEH - cannot do this assertion because root thread not set up as
1961 // executing
Jim Cownie5e8470a2013-09-27 10:38:44 +00001962 // KMP_ASSERT( master_th->th.th_current_task->td_flags.executing == 1 );
1963 master_th->th.th_current_task->td_flags.executing = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00001964
1965#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00001966 if (!master_th->th.th_teams_microtask || level > teams_level)
Jim Cownie5e8470a2013-09-27 10:38:44 +00001967#endif /* OMP_40_ENABLED */
1968 {
Jonathan Peyton30419822017-05-12 18:01:32 +00001969 /* Increment our nested depth level */
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00001970 KMP_ATOMIC_INC(&root->r.r_in_parallel);
Jim Cownie5e8470a2013-09-27 10:38:44 +00001971 }
1972
Jim Cownie5e8470a2013-09-27 10:38:44 +00001973 // See if we need to make a copy of the ICVs.
Jim Cownie5e8470a2013-09-27 10:38:44 +00001974 int nthreads_icv = master_th->th.th_current_task->td_icvs.nproc;
Jonathan Peyton30419822017-05-12 18:01:32 +00001975 if ((level + 1 < __kmp_nested_nth.used) &&
1976 (__kmp_nested_nth.nth[level + 1] != nthreads_icv)) {
1977 nthreads_icv = __kmp_nested_nth.nth[level + 1];
1978 } else {
1979 nthreads_icv = 0; // don't update
Jim Cownie5e8470a2013-09-27 10:38:44 +00001980 }
1981
1982#if OMP_40_ENABLED
Jim Cownie5e8470a2013-09-27 10:38:44 +00001983 // Figure out the proc_bind_policy for the new team.
Jim Cownie5e8470a2013-09-27 10:38:44 +00001984 kmp_proc_bind_t proc_bind = master_th->th.th_set_proc_bind;
Jonathan Peyton30419822017-05-12 18:01:32 +00001985 kmp_proc_bind_t proc_bind_icv =
1986 proc_bind_default; // proc_bind_default means don't update
1987 if (master_th->th.th_current_task->td_icvs.proc_bind == proc_bind_false) {
1988 proc_bind = proc_bind_false;
1989 } else {
1990 if (proc_bind == proc_bind_default) {
1991 // No proc_bind clause specified; use current proc-bind-var for this
1992 // parallel region
1993 proc_bind = master_th->th.th_current_task->td_icvs.proc_bind;
1994 }
1995 /* else: The proc_bind policy was specified explicitly on parallel clause.
1996 This overrides proc-bind-var for this parallel region, but does not
1997 change proc-bind-var. */
1998 // Figure the value of proc-bind-var for the child threads.
1999 if ((level + 1 < __kmp_nested_proc_bind.used) &&
2000 (__kmp_nested_proc_bind.bind_types[level + 1] !=
2001 master_th->th.th_current_task->td_icvs.proc_bind)) {
2002 proc_bind_icv = __kmp_nested_proc_bind.bind_types[level + 1];
2003 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002004 }
2005
Jim Cownie5e8470a2013-09-27 10:38:44 +00002006 // Reset for next parallel region
Jim Cownie5e8470a2013-09-27 10:38:44 +00002007 master_th->th.th_set_proc_bind = proc_bind_default;
2008#endif /* OMP_40_ENABLED */
2009
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002010 if ((nthreads_icv > 0)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002011#if OMP_40_ENABLED
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002012 || (proc_bind_icv != proc_bind_default)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002013#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002014 ) {
2015 kmp_internal_control_t new_icvs;
2016 copy_icvs(&new_icvs, &master_th->th.th_current_task->td_icvs);
2017 new_icvs.next = NULL;
2018 if (nthreads_icv > 0) {
2019 new_icvs.nproc = nthreads_icv;
2020 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002021
2022#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002023 if (proc_bind_icv != proc_bind_default) {
2024 new_icvs.proc_bind = proc_bind_icv;
2025 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002026#endif /* OMP_40_ENABLED */
2027
Jonathan Peyton30419822017-05-12 18:01:32 +00002028 /* allocate a new parallel team */
2029 KF_TRACE(10, ("__kmp_fork_call: before __kmp_allocate_team\n"));
2030 team = __kmp_allocate_team(root, nthreads, nthreads,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002031#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002032 ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002033#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002034#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002035 proc_bind,
Jim Cownie5e8470a2013-09-27 10:38:44 +00002036#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002037 &new_icvs, argc USE_NESTED_HOT_ARG(master_th));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002038 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002039 /* allocate a new parallel team */
2040 KF_TRACE(10, ("__kmp_fork_call: before __kmp_allocate_team\n"));
2041 team = __kmp_allocate_team(root, nthreads, nthreads,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002042#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002043 ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002044#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002045#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002046 proc_bind,
Jim Cownie5e8470a2013-09-27 10:38:44 +00002047#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002048 &master_th->th.th_current_task->td_icvs,
2049 argc USE_NESTED_HOT_ARG(master_th));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002050 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002051 KF_TRACE(
2052 10, ("__kmp_fork_call: after __kmp_allocate_team - team = %p\n", team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002053
2054 /* setup the new team */
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002055 KMP_CHECK_UPDATE(team->t.t_master_tid, master_tid);
2056 KMP_CHECK_UPDATE(team->t.t_master_this_cons, master_this_cons);
2057 KMP_CHECK_UPDATE(team->t.t_ident, loc);
2058 KMP_CHECK_UPDATE(team->t.t_parent, parent_team);
2059 KMP_CHECK_UPDATE_SYNC(team->t.t_pkfn, microtask);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002060#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002061 KMP_CHECK_UPDATE_SYNC(team->t.ompt_team_info.master_return_address,
2062 return_address);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002063#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002064 KMP_CHECK_UPDATE(team->t.t_invoke, invoker); // TODO move to root, maybe
2065// TODO: parent_team->t.t_level == INT_MAX ???
Jim Cownie5e8470a2013-09-27 10:38:44 +00002066#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002067 if (!master_th->th.th_teams_microtask || level > teams_level) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002068#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002069 int new_level = parent_team->t.t_level + 1;
2070 KMP_CHECK_UPDATE(team->t.t_level, new_level);
2071 new_level = parent_team->t.t_active_level + 1;
2072 KMP_CHECK_UPDATE(team->t.t_active_level, new_level);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002073#if OMP_40_ENABLED
2074 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002075 // AC: Do not increase parallel level at start of the teams construct
2076 int new_level = parent_team->t.t_level;
2077 KMP_CHECK_UPDATE(team->t.t_level, new_level);
2078 new_level = parent_team->t.t_active_level;
2079 KMP_CHECK_UPDATE(team->t.t_active_level, new_level);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002080 }
2081#endif /* OMP_40_ENABLED */
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002082 kmp_r_sched_t new_sched = get__sched_2(parent_team, master_tid);
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00002083 // set master's schedule as new run-time schedule
2084 KMP_CHECK_UPDATE(team->t.t_sched.sched, new_sched.sched);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002085
Jonathan Peyton45ca5da2015-10-19 19:33:38 +00002086#if OMP_40_ENABLED
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002087 KMP_CHECK_UPDATE(team->t.t_cancel_request, cancel_noreq);
Jonathan Peyton45ca5da2015-10-19 19:33:38 +00002088#endif
Jonathan Peyton92ca6182018-09-07 18:25:49 +00002089#if OMP_50_ENABLED
2090 KMP_CHECK_UPDATE(team->t.t_def_allocator, master_th->th.th_def_allocator);
2091#endif
Jonathan Peyton45ca5da2015-10-19 19:33:38 +00002092
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002093 // Update the floating point rounding in the team if required.
2094 propagateFPControl(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002095
Jonathan Peyton30419822017-05-12 18:01:32 +00002096 if (__kmp_tasking_mode != tskm_immediate_exec) {
2097 // Set master's task team to team's task team. Unless this is hot team, it
2098 // should be NULL.
Jonathan Peyton30419822017-05-12 18:01:32 +00002099 KMP_DEBUG_ASSERT(master_th->th.th_task_team ==
2100 parent_team->t.t_task_team[master_th->th.th_task_state]);
Jonathan Peyton30419822017-05-12 18:01:32 +00002101 KA_TRACE(20, ("__kmp_fork_call: Master T#%d pushing task_team %p / team "
2102 "%p, new task_team %p / team %p\n",
2103 __kmp_gtid_from_thread(master_th),
2104 master_th->th.th_task_team, parent_team,
2105 team->t.t_task_team[master_th->th.th_task_state], team));
Jonathan Peytond3f2b942016-02-09 22:32:41 +00002106
Jonathan Peyton30419822017-05-12 18:01:32 +00002107 if (active_level || master_th->th.th_task_team) {
2108 // Take a memo of master's task_state
2109 KMP_DEBUG_ASSERT(master_th->th.th_task_state_memo_stack);
2110 if (master_th->th.th_task_state_top >=
2111 master_th->th.th_task_state_stack_sz) { // increase size
2112 kmp_uint32 new_size = 2 * master_th->th.th_task_state_stack_sz;
2113 kmp_uint8 *old_stack, *new_stack;
2114 kmp_uint32 i;
2115 new_stack = (kmp_uint8 *)__kmp_allocate(new_size);
2116 for (i = 0; i < master_th->th.th_task_state_stack_sz; ++i) {
2117 new_stack[i] = master_th->th.th_task_state_memo_stack[i];
2118 }
2119 for (i = master_th->th.th_task_state_stack_sz; i < new_size;
2120 ++i) { // zero-init rest of stack
2121 new_stack[i] = 0;
2122 }
2123 old_stack = master_th->th.th_task_state_memo_stack;
2124 master_th->th.th_task_state_memo_stack = new_stack;
2125 master_th->th.th_task_state_stack_sz = new_size;
2126 __kmp_free(old_stack);
Andrey Churbanov6d224db2015-02-10 18:37:43 +00002127 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002128 // Store master's task_state on stack
2129 master_th->th
2130 .th_task_state_memo_stack[master_th->th.th_task_state_top] =
2131 master_th->th.th_task_state;
2132 master_th->th.th_task_state_top++;
2133#if KMP_NESTED_HOT_TEAMS
Jonathan Peytonca10a762018-08-24 18:05:00 +00002134 if (master_th->th.th_hot_teams &&
2135 team == master_th->th.th_hot_teams[active_level].hot_team) {
Jonathan Peyton642688b2017-06-01 16:46:36 +00002136 // Restore master's nested state if nested hot team
Jonathan Peyton30419822017-05-12 18:01:32 +00002137 master_th->th.th_task_state =
2138 master_th->th
2139 .th_task_state_memo_stack[master_th->th.th_task_state_top];
2140 } else {
2141#endif
2142 master_th->th.th_task_state = 0;
2143#if KMP_NESTED_HOT_TEAMS
2144 }
2145#endif
2146 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002147#if !KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00002148 KMP_DEBUG_ASSERT((master_th->th.th_task_team == NULL) ||
2149 (team == root->r.r_hot_team));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002150#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002151 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002152
Jonathan Peyton30419822017-05-12 18:01:32 +00002153 KA_TRACE(
2154 20,
2155 ("__kmp_fork_call: T#%d(%d:%d)->(%d:0) created a team of %d threads\n",
2156 gtid, parent_team->t.t_id, team->t.t_master_tid, team->t.t_id,
2157 team->t.t_nproc));
2158 KMP_DEBUG_ASSERT(team != root->r.r_hot_team ||
2159 (team->t.t_master_tid == 0 &&
2160 (team->t.t_parent == root->r.r_root_team ||
2161 team->t.t_parent->t.t_serialized)));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002162 KMP_MB();
2163
2164 /* now, setup the arguments */
Jonathan Peyton30419822017-05-12 18:01:32 +00002165 argv = (void **)team->t.t_argv;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002166#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002167 if (ap) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002168#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002169 for (i = argc - 1; i >= 0; --i) {
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002170// TODO: revert workaround for Intel(R) 64 tracker #96
Andrey Churbanovcbda8682015-01-13 14:43:35 +00002171#if (KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64) && KMP_OS_LINUX
Jonathan Peyton30419822017-05-12 18:01:32 +00002172 void *new_argv = va_arg(*ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002173#else
Jonathan Peyton30419822017-05-12 18:01:32 +00002174 void *new_argv = va_arg(ap, void *);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002175#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002176 KMP_CHECK_UPDATE(*argv, new_argv);
2177 argv++;
2178 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002179#if OMP_40_ENABLED
2180 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002181 for (i = 0; i < argc; ++i) {
2182 // Get args from parent team for teams construct
2183 KMP_CHECK_UPDATE(argv[i], team->t.t_parent->t.t_argv[i]);
2184 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002185 }
2186#endif /* OMP_40_ENABLED */
2187
2188 /* now actually fork the threads */
Jonathan Peytonb044e4f2016-05-23 18:01:19 +00002189 KMP_CHECK_UPDATE(team->t.t_master_active, master_active);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002190 if (!root->r.r_active) // Only do assignment if it prevents cache ping-pong
Jonathan Peyton30419822017-05-12 18:01:32 +00002191 root->r.r_active = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002192
Jonathan Peyton30419822017-05-12 18:01:32 +00002193 __kmp_fork_team_threads(root, team, master_th, gtid);
2194 __kmp_setup_icv_copy(team, nthreads,
2195 &master_th->th.th_current_task->td_icvs, loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002196
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002197#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002198 master_th->th.ompt_thread_info.state = omp_state_work_parallel;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002199#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002200
Jonathan Peyton30419822017-05-12 18:01:32 +00002201 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002202
Jim Cownie5e8470a2013-09-27 10:38:44 +00002203#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00002204 if (team->t.t_active_level == 1 // only report frames at level 1
2205#if OMP_40_ENABLED
Andrey Churbanov51aecb82015-05-06 19:22:36 +00002206 && !master_th->th.th_teams_microtask // not in teams construct
Jonathan Peyton30419822017-05-12 18:01:32 +00002207#endif /* OMP_40_ENABLED */
2208 ) {
Andrey Churbanov51aecb82015-05-06 19:22:36 +00002209#if USE_ITT_NOTIFY
Jonathan Peyton30419822017-05-12 18:01:32 +00002210 if ((__itt_frame_submit_v3_ptr || KMP_ITT_DEBUG) &&
2211 (__kmp_forkjoin_frames_mode == 3 ||
2212 __kmp_forkjoin_frames_mode == 1)) {
2213 kmp_uint64 tmp_time = 0;
2214 if (__itt_get_timestamp_ptr)
2215 tmp_time = __itt_get_timestamp();
2216 // Internal fork - report frame begin
2217 master_th->th.th_frame_time = tmp_time;
2218 if (__kmp_forkjoin_frames_mode == 3)
2219 team->t.t_region_time = tmp_time;
Jonathan Peyton642688b2017-06-01 16:46:36 +00002220 } else
2221// only one notification scheme (either "submit" or "forking/joined", not both)
Andrey Churbanov51aecb82015-05-06 19:22:36 +00002222#endif /* USE_ITT_NOTIFY */
Jonathan Peyton30419822017-05-12 18:01:32 +00002223 if ((__itt_frame_begin_v3_ptr || KMP_ITT_DEBUG) &&
2224 __kmp_forkjoin_frames && !__kmp_forkjoin_frames_mode) {
Jonathan Peyton8c432f22018-01-04 22:56:47 +00002225 // Mark start of "parallel" region for Intel(R) VTune(TM) analyzer.
Jonathan Peyton30419822017-05-12 18:01:32 +00002226 __kmp_itt_region_forking(gtid, team->t.t_nproc, 0);
2227 }
Andrey Churbanovf6451d92015-01-16 15:58:03 +00002228 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002229#endif /* USE_ITT_BUILD */
2230
2231 /* now go on and do the work */
Jonathan Peyton30419822017-05-12 18:01:32 +00002232 KMP_DEBUG_ASSERT(team == __kmp_threads[gtid]->th.th_team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002233 KMP_MB();
Jonathan Peyton30419822017-05-12 18:01:32 +00002234 KF_TRACE(10,
2235 ("__kmp_internal_fork : root=%p, team=%p, master_th=%p, gtid=%d\n",
2236 root, team, master_th, gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002237
2238#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00002239 if (__itt_stack_caller_create_ptr) {
2240 team->t.t_stack_id =
2241 __kmp_itt_stack_caller_create(); // create new stack stitching id
2242 // before entering fork barrier
Jim Cownie5e8470a2013-09-27 10:38:44 +00002243 }
2244#endif /* USE_ITT_BUILD */
2245
2246#if OMP_40_ENABLED
Jonathan Peyton642688b2017-06-01 16:46:36 +00002247 // AC: skip __kmp_internal_fork at teams construct, let only master
2248 // threads execute
2249 if (ap)
Jim Cownie5e8470a2013-09-27 10:38:44 +00002250#endif /* OMP_40_ENABLED */
2251 {
Jonathan Peyton30419822017-05-12 18:01:32 +00002252 __kmp_internal_fork(loc, gtid, team);
2253 KF_TRACE(10, ("__kmp_internal_fork : after : root=%p, team=%p, "
2254 "master_th=%p, gtid=%d\n",
2255 root, team, master_th, gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002256 }
2257
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002258 if (call_context == fork_context_gnu) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002259 KA_TRACE(20, ("__kmp_fork_call: parallel exit T#%d\n", gtid));
2260 return TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002261 }
2262
2263 /* Invoke microtask for MASTER thread */
Jonathan Peyton30419822017-05-12 18:01:32 +00002264 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) invoke microtask = %p\n", gtid,
2265 team->t.t_id, team->t.t_pkfn));
2266 } // END of timer KMP_fork_call block
Jim Cownie5e8470a2013-09-27 10:38:44 +00002267
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00002268 if (!team->t.t_invoke(gtid)) {
2269 KMP_ASSERT2(0, "cannot invoke microtask for MASTER thread");
Jonathan Peyton30419822017-05-12 18:01:32 +00002270 }
2271 KA_TRACE(20, ("__kmp_fork_call: T#%d(%d:0) done microtask = %p\n", gtid,
2272 team->t.t_id, team->t.t_pkfn));
2273 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00002274
Jonathan Peyton30419822017-05-12 18:01:32 +00002275 KA_TRACE(20, ("__kmp_fork_call: parallel exit T#%d\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002276
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002277#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002278 if (ompt_enabled.enabled) {
2279 master_th->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00002280 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002281#endif
2282
Jonathan Peyton30419822017-05-12 18:01:32 +00002283 return TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002284}
2285
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002286#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00002287static inline void __kmp_join_restore_state(kmp_info_t *thread,
2288 kmp_team_t *team) {
2289 // restore state outside the region
2290 thread->th.ompt_thread_info.state =
Joachim Protze82e94a52017-11-01 10:08:30 +00002291 ((team->t.t_serialized) ? omp_state_work_serial
2292 : omp_state_work_parallel);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002293}
2294
Joachim Protze82e94a52017-11-01 10:08:30 +00002295static inline void __kmp_join_ompt(int gtid, kmp_info_t *thread,
2296 kmp_team_t *team, ompt_data_t *parallel_data,
2297 fork_context_e fork_context, void *codeptr) {
2298 ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
2299 if (ompt_enabled.ompt_callback_parallel_end) {
2300 ompt_callbacks.ompt_callback(ompt_callback_parallel_end)(
2301 parallel_data, &(task_info->task_data), OMPT_INVOKER(fork_context),
2302 codeptr);
Jonathan Peyton30419822017-05-12 18:01:32 +00002303 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002304
Joachim Protzec255ca72017-11-05 14:11:10 +00002305 task_info->frame.enter_frame = NULL;
Jonathan Peyton30419822017-05-12 18:01:32 +00002306 __kmp_join_restore_state(thread, team);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002307}
2308#endif
2309
Jonathan Peyton30419822017-05-12 18:01:32 +00002310void __kmp_join_call(ident_t *loc, int gtid
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00002311#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00002312 ,
2313 enum fork_context_e fork_context
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00002314#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002315#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002316 ,
2317 int exit_teams
Jim Cownie5e8470a2013-09-27 10:38:44 +00002318#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002319 ) {
2320 KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(KMP_join_call);
2321 kmp_team_t *team;
2322 kmp_team_t *parent_team;
2323 kmp_info_t *master_th;
2324 kmp_root_t *root;
2325 int master_active;
2326 int i;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002327
Jonathan Peyton30419822017-05-12 18:01:32 +00002328 KA_TRACE(20, ("__kmp_join_call: enter T#%d\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002329
Jonathan Peyton30419822017-05-12 18:01:32 +00002330 /* setup current data */
2331 master_th = __kmp_threads[gtid];
2332 root = master_th->th.th_root;
2333 team = master_th->th.th_team;
2334 parent_team = team->t.t_parent;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002335
Jonathan Peyton30419822017-05-12 18:01:32 +00002336 master_th->th.th_ident = loc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002337
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002338#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002339 if (ompt_enabled.enabled) {
2340 master_th->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00002341 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002342#endif
2343
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002344#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00002345 if (__kmp_tasking_mode != tskm_immediate_exec && !exit_teams) {
2346 KA_TRACE(20, ("__kmp_join_call: T#%d, old team = %p old task_team = %p, "
2347 "th_task_team = %p\n",
2348 __kmp_gtid_from_thread(master_th), team,
2349 team->t.t_task_team[master_th->th.th_task_state],
2350 master_th->th.th_task_team));
2351 KMP_DEBUG_ASSERT(master_th->th.th_task_team ==
2352 team->t.t_task_team[master_th->th.th_task_state]);
2353 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002354#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002355
Jonathan Peyton30419822017-05-12 18:01:32 +00002356 if (team->t.t_serialized) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002357#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002358 if (master_th->th.th_teams_microtask) {
2359 // We are in teams construct
2360 int level = team->t.t_level;
2361 int tlevel = master_th->th.th_teams_level;
2362 if (level == tlevel) {
2363 // AC: we haven't incremented it earlier at start of teams construct,
2364 // so do it here - at the end of teams construct
2365 team->t.t_level++;
2366 } else if (level == tlevel + 1) {
2367 // AC: we are exiting parallel inside teams, need to increment
2368 // serialization in order to restore it in the next call to
2369 // __kmpc_end_serialized_parallel
2370 team->t.t_serialized++;
2371 }
Andrey Churbanov6d224db2015-02-10 18:37:43 +00002372 }
Jonathan Peyton441f3372015-09-21 17:24:46 +00002373#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00002374 __kmpc_end_serialized_parallel(loc, gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002375
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002376#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002377 if (ompt_enabled.enabled) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002378 __kmp_join_restore_state(master_th, parent_team);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00002379 }
2380#endif
2381
Jonathan Peyton30419822017-05-12 18:01:32 +00002382 return;
2383 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002384
Jonathan Peyton30419822017-05-12 18:01:32 +00002385 master_active = team->t.t_master_active;
2386
2387#if OMP_40_ENABLED
2388 if (!exit_teams)
2389#endif /* OMP_40_ENABLED */
2390 {
2391 // AC: No barrier for internal teams at exit from teams construct.
2392 // But there is barrier for external team (league).
2393 __kmp_internal_join(loc, gtid, team);
2394 }
2395#if OMP_40_ENABLED
2396 else {
2397 master_th->th.th_task_state =
2398 0; // AC: no tasking in teams (out of any parallel)
2399 }
2400#endif /* OMP_40_ENABLED */
2401
2402 KMP_MB();
2403
2404#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002405 ompt_data_t *parallel_data = &(team->t.ompt_team_info.parallel_data);
2406 void *codeptr = team->t.ompt_team_info.master_return_address;
Jonathan Peyton30419822017-05-12 18:01:32 +00002407#endif
2408
2409#if USE_ITT_BUILD
2410 if (__itt_stack_caller_create_ptr) {
2411 __kmp_itt_stack_caller_destroy(
2412 (__itt_caller)team->t
2413 .t_stack_id); // destroy the stack stitching id after join barrier
2414 }
2415
Jonathan Peyton8c432f22018-01-04 22:56:47 +00002416 // Mark end of "parallel" region for Intel(R) VTune(TM) analyzer.
Jonathan Peyton30419822017-05-12 18:01:32 +00002417 if (team->t.t_active_level == 1
2418#if OMP_40_ENABLED
2419 && !master_th->th.th_teams_microtask /* not in teams construct */
2420#endif /* OMP_40_ENABLED */
2421 ) {
2422 master_th->th.th_ident = loc;
2423 // only one notification scheme (either "submit" or "forking/joined", not
2424 // both)
2425 if ((__itt_frame_submit_v3_ptr || KMP_ITT_DEBUG) &&
2426 __kmp_forkjoin_frames_mode == 3)
2427 __kmp_itt_frame_submit(gtid, team->t.t_region_time,
2428 master_th->th.th_frame_time, 0, loc,
2429 master_th->th.th_team_nproc, 1);
2430 else if ((__itt_frame_end_v3_ptr || KMP_ITT_DEBUG) &&
2431 !__kmp_forkjoin_frames_mode && __kmp_forkjoin_frames)
2432 __kmp_itt_region_joined(gtid);
2433 } // active_level == 1
2434#endif /* USE_ITT_BUILD */
2435
2436#if OMP_40_ENABLED
2437 if (master_th->th.th_teams_microtask && !exit_teams &&
2438 team->t.t_pkfn != (microtask_t)__kmp_teams_master &&
2439 team->t.t_level == master_th->th.th_teams_level + 1) {
2440 // AC: We need to leave the team structure intact at the end of parallel
2441 // inside the teams construct, so that at the next parallel same (hot) team
2442 // works, only adjust nesting levels
2443
2444 /* Decrement our nested depth level */
2445 team->t.t_level--;
2446 team->t.t_active_level--;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00002447 KMP_ATOMIC_DEC(&root->r.r_in_parallel);
Jonathan Peyton30419822017-05-12 18:01:32 +00002448
2449 /* Restore number of threads in the team if needed */
2450 if (master_th->th.th_team_nproc < master_th->th.th_teams_size.nth) {
2451 int old_num = master_th->th.th_team_nproc;
2452 int new_num = master_th->th.th_teams_size.nth;
2453 kmp_info_t **other_threads = team->t.t_threads;
2454 team->t.t_nproc = new_num;
2455 for (i = 0; i < old_num; ++i) {
2456 other_threads[i]->th.th_team_nproc = new_num;
2457 }
2458 // Adjust states of non-used threads of the team
2459 for (i = old_num; i < new_num; ++i) {
2460 // Re-initialize thread's barrier data.
2461 int b;
2462 kmp_balign_t *balign = other_threads[i]->th.th_bar;
2463 for (b = 0; b < bs_last_barrier; ++b) {
2464 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
2465 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
2466#if USE_DEBUGGER
2467 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
2468#endif
2469 }
2470 if (__kmp_tasking_mode != tskm_immediate_exec) {
2471 // Synchronize thread's task state
2472 other_threads[i]->th.th_task_state = master_th->th.th_task_state;
2473 }
2474 }
2475 }
2476
2477#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002478 if (ompt_enabled.enabled) {
2479 __kmp_join_ompt(gtid, master_th, parent_team, parallel_data, fork_context,
2480 codeptr);
Jonathan Peyton30419822017-05-12 18:01:32 +00002481 }
2482#endif
2483
2484 return;
2485 }
2486#endif /* OMP_40_ENABLED */
2487
2488 /* do cleanup and restore the parent team */
2489 master_th->th.th_info.ds.ds_tid = team->t.t_master_tid;
2490 master_th->th.th_local.this_construct = team->t.t_master_this_cons;
2491
2492 master_th->th.th_dispatch = &parent_team->t.t_dispatch[team->t.t_master_tid];
2493
2494 /* jc: The following lock has instructions with REL and ACQ semantics,
2495 separating the parallel user code called in this parallel region
2496 from the serial user code called after this function returns. */
2497 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
2498
2499#if OMP_40_ENABLED
2500 if (!master_th->th.th_teams_microtask ||
2501 team->t.t_level > master_th->th.th_teams_level)
2502#endif /* OMP_40_ENABLED */
2503 {
2504 /* Decrement our nested depth level */
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00002505 KMP_ATOMIC_DEC(&root->r.r_in_parallel);
Jonathan Peyton30419822017-05-12 18:01:32 +00002506 }
2507 KMP_DEBUG_ASSERT(root->r.r_in_parallel >= 0);
2508
Joachim Protze82e94a52017-11-01 10:08:30 +00002509#if OMPT_SUPPORT
2510 if (ompt_enabled.enabled) {
2511 ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
2512 if (ompt_enabled.ompt_callback_implicit_task) {
2513 int ompt_team_size = team->t.t_nproc;
2514 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
2515 ompt_scope_end, NULL, &(task_info->task_data), ompt_team_size,
Joachim Protze9be9cf22018-05-07 12:42:21 +00002516 OMPT_CUR_TASK_INFO(master_th)->thread_num);
Jonathan Peyton30419822017-05-12 18:01:32 +00002517 }
Joachim Protze82e94a52017-11-01 10:08:30 +00002518
Joachim Protzec255ca72017-11-05 14:11:10 +00002519 task_info->frame.exit_frame = NULL;
Joachim Protze82e94a52017-11-01 10:08:30 +00002520 task_info->task_data = ompt_data_none;
Jonathan Peyton30419822017-05-12 18:01:32 +00002521 }
2522#endif
2523
2524 KF_TRACE(10, ("__kmp_join_call1: T#%d, this_thread=%p team=%p\n", 0,
2525 master_th, team));
2526 __kmp_pop_current_task_from_thread(master_th);
2527
2528#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
2529 // Restore master thread's partition.
2530 master_th->th.th_first_place = team->t.t_first_place;
2531 master_th->th.th_last_place = team->t.t_last_place;
2532#endif /* OMP_40_ENABLED */
Jonathan Peyton92ca6182018-09-07 18:25:49 +00002533#if OMP_50_ENABLED
2534 master_th->th.th_def_allocator = team->t.t_def_allocator;
2535#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002536
2537 updateHWFPControl(team);
2538
2539 if (root->r.r_active != master_active)
2540 root->r.r_active = master_active;
2541
2542 __kmp_free_team(root, team USE_NESTED_HOT_ARG(
2543 master_th)); // this will free worker threads
2544
2545 /* this race was fun to find. make sure the following is in the critical
2546 region otherwise assertions may fail occasionally since the old team may be
2547 reallocated and the hierarchy appears inconsistent. it is actually safe to
2548 run and won't cause any bugs, but will cause those assertion failures. it's
2549 only one deref&assign so might as well put this in the critical region */
2550 master_th->th.th_team = parent_team;
2551 master_th->th.th_team_nproc = parent_team->t.t_nproc;
2552 master_th->th.th_team_master = parent_team->t.t_threads[0];
2553 master_th->th.th_team_serialized = parent_team->t.t_serialized;
2554
2555 /* restore serialized team, if need be */
2556 if (parent_team->t.t_serialized &&
2557 parent_team != master_th->th.th_serial_team &&
2558 parent_team != root->r.r_root_team) {
2559 __kmp_free_team(root,
2560 master_th->th.th_serial_team USE_NESTED_HOT_ARG(NULL));
2561 master_th->th.th_serial_team = parent_team;
2562 }
2563
2564 if (__kmp_tasking_mode != tskm_immediate_exec) {
2565 if (master_th->th.th_task_state_top >
2566 0) { // Restore task state from memo stack
2567 KMP_DEBUG_ASSERT(master_th->th.th_task_state_memo_stack);
2568 // Remember master's state if we re-use this nested hot team
2569 master_th->th.th_task_state_memo_stack[master_th->th.th_task_state_top] =
2570 master_th->th.th_task_state;
2571 --master_th->th.th_task_state_top; // pop
2572 // Now restore state at this level
2573 master_th->th.th_task_state =
2574 master_th->th
2575 .th_task_state_memo_stack[master_th->th.th_task_state_top];
2576 }
2577 // Copy the task team from the parent team to the master thread
2578 master_th->th.th_task_team =
2579 parent_team->t.t_task_team[master_th->th.th_task_state];
2580 KA_TRACE(20,
2581 ("__kmp_join_call: Master T#%d restoring task_team %p / team %p\n",
2582 __kmp_gtid_from_thread(master_th), master_th->th.th_task_team,
2583 parent_team));
2584 }
2585
2586 // TODO: GEH - cannot do this assertion because root thread not set up as
2587 // executing
2588 // KMP_ASSERT( master_th->th.th_current_task->td_flags.executing == 0 );
2589 master_th->th.th_current_task->td_flags.executing = 1;
2590
2591 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
2592
2593#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00002594 if (ompt_enabled.enabled) {
2595 __kmp_join_ompt(gtid, master_th, parent_team, parallel_data, fork_context,
2596 codeptr);
Jonathan Peyton30419822017-05-12 18:01:32 +00002597 }
2598#endif
2599
2600 KMP_MB();
2601 KA_TRACE(20, ("__kmp_join_call: exit T#%d\n", gtid));
2602}
Jim Cownie5e8470a2013-09-27 10:38:44 +00002603
2604/* Check whether we should push an internal control record onto the
2605 serial team stack. If so, do it. */
Jonathan Peyton30419822017-05-12 18:01:32 +00002606void __kmp_save_internal_controls(kmp_info_t *thread) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002607
Jonathan Peyton30419822017-05-12 18:01:32 +00002608 if (thread->th.th_team != thread->th.th_serial_team) {
2609 return;
2610 }
2611 if (thread->th.th_team->t.t_serialized > 1) {
2612 int push = 0;
2613
2614 if (thread->th.th_team->t.t_control_stack_top == NULL) {
2615 push = 1;
2616 } else {
2617 if (thread->th.th_team->t.t_control_stack_top->serial_nesting_level !=
2618 thread->th.th_team->t.t_serialized) {
2619 push = 1;
2620 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002621 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002622 if (push) { /* push a record on the serial team's stack */
2623 kmp_internal_control_t *control =
2624 (kmp_internal_control_t *)__kmp_allocate(
2625 sizeof(kmp_internal_control_t));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002626
Jonathan Peyton30419822017-05-12 18:01:32 +00002627 copy_icvs(control, &thread->th.th_current_task->td_icvs);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002628
Jonathan Peyton30419822017-05-12 18:01:32 +00002629 control->serial_nesting_level = thread->th.th_team->t.t_serialized;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002630
Jonathan Peyton30419822017-05-12 18:01:32 +00002631 control->next = thread->th.th_team->t.t_control_stack_top;
2632 thread->th.th_team->t.t_control_stack_top = control;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002633 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002634 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002635}
2636
2637/* Changes set_nproc */
Jonathan Peyton30419822017-05-12 18:01:32 +00002638void __kmp_set_num_threads(int new_nth, int gtid) {
2639 kmp_info_t *thread;
2640 kmp_root_t *root;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002641
Jonathan Peyton30419822017-05-12 18:01:32 +00002642 KF_TRACE(10, ("__kmp_set_num_threads: new __kmp_nth = %d\n", new_nth));
2643 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002644
Jonathan Peyton30419822017-05-12 18:01:32 +00002645 if (new_nth < 1)
2646 new_nth = 1;
2647 else if (new_nth > __kmp_max_nth)
2648 new_nth = __kmp_max_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002649
Jonathan Peyton30419822017-05-12 18:01:32 +00002650 KMP_COUNT_VALUE(OMP_set_numthreads, new_nth);
2651 thread = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002652
Jonathan Peyton30419822017-05-12 18:01:32 +00002653 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002654
Jonathan Peyton30419822017-05-12 18:01:32 +00002655 set__nproc(thread, new_nth);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002656
Jonathan Peyton30419822017-05-12 18:01:32 +00002657 // If this omp_set_num_threads() call will cause the hot team size to be
2658 // reduced (in the absence of a num_threads clause), then reduce it now,
2659 // rather than waiting for the next parallel region.
2660 root = thread->th.th_root;
2661 if (__kmp_init_parallel && (!root->r.r_active) &&
2662 (root->r.r_hot_team->t.t_nproc > new_nth)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002663#if KMP_NESTED_HOT_TEAMS
2664 && __kmp_hot_teams_max_level && !__kmp_hot_teams_mode
2665#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002666 ) {
2667 kmp_team_t *hot_team = root->r.r_hot_team;
2668 int f;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002669
Jonathan Peyton30419822017-05-12 18:01:32 +00002670 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002671
Jonathan Peyton30419822017-05-12 18:01:32 +00002672 // Release the extra threads we don't need any more.
2673 for (f = new_nth; f < hot_team->t.t_nproc; f++) {
2674 KMP_DEBUG_ASSERT(hot_team->t.t_threads[f] != NULL);
2675 if (__kmp_tasking_mode != tskm_immediate_exec) {
2676 // When decreasing team size, threads no longer in the team should unref
2677 // task team.
2678 hot_team->t.t_threads[f]->th.th_task_team = NULL;
2679 }
2680 __kmp_free_thread(hot_team->t.t_threads[f]);
2681 hot_team->t.t_threads[f] = NULL;
2682 }
2683 hot_team->t.t_nproc = new_nth;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002684#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00002685 if (thread->th.th_hot_teams) {
2686 KMP_DEBUG_ASSERT(hot_team == thread->th.th_hot_teams[0].hot_team);
2687 thread->th.th_hot_teams[0].hot_team_nth = new_nth;
2688 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00002689#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00002690
Jonathan Peyton30419822017-05-12 18:01:32 +00002691 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002692
Jonathan Peyton30419822017-05-12 18:01:32 +00002693 // Update the t_nproc field in the threads that are still active.
2694 for (f = 0; f < new_nth; f++) {
2695 KMP_DEBUG_ASSERT(hot_team->t.t_threads[f] != NULL);
2696 hot_team->t.t_threads[f]->th.th_team_nproc = new_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002697 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002698 // Special flag in case omp_set_num_threads() call
2699 hot_team->t.t_size_changed = -1;
2700 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002701}
2702
Jim Cownie5e8470a2013-09-27 10:38:44 +00002703/* Changes max_active_levels */
Jonathan Peyton30419822017-05-12 18:01:32 +00002704void __kmp_set_max_active_levels(int gtid, int max_active_levels) {
2705 kmp_info_t *thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002706
Jonathan Peyton30419822017-05-12 18:01:32 +00002707 KF_TRACE(10, ("__kmp_set_max_active_levels: new max_active_levels for thread "
2708 "%d = (%d)\n",
2709 gtid, max_active_levels));
2710 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002711
Jonathan Peyton30419822017-05-12 18:01:32 +00002712 // validate max_active_levels
2713 if (max_active_levels < 0) {
2714 KMP_WARNING(ActiveLevelsNegative, max_active_levels);
2715 // We ignore this call if the user has specified a negative value.
2716 // The current setting won't be changed. The last valid setting will be
2717 // used. A warning will be issued (if warnings are allowed as controlled by
2718 // the KMP_WARNINGS env var).
2719 KF_TRACE(10, ("__kmp_set_max_active_levels: the call is ignored: new "
2720 "max_active_levels for thread %d = (%d)\n",
2721 gtid, max_active_levels));
2722 return;
2723 }
2724 if (max_active_levels <= KMP_MAX_ACTIVE_LEVELS_LIMIT) {
2725 // it's OK, the max_active_levels is within the valid range: [ 0;
2726 // KMP_MAX_ACTIVE_LEVELS_LIMIT ]
2727 // We allow a zero value. (implementation defined behavior)
2728 } else {
2729 KMP_WARNING(ActiveLevelsExceedLimit, max_active_levels,
2730 KMP_MAX_ACTIVE_LEVELS_LIMIT);
2731 max_active_levels = KMP_MAX_ACTIVE_LEVELS_LIMIT;
2732 // Current upper limit is MAX_INT. (implementation defined behavior)
2733 // If the input exceeds the upper limit, we correct the input to be the
2734 // upper limit. (implementation defined behavior)
2735 // Actually, the flow should never get here until we use MAX_INT limit.
2736 }
2737 KF_TRACE(10, ("__kmp_set_max_active_levels: after validation: new "
2738 "max_active_levels for thread %d = (%d)\n",
2739 gtid, max_active_levels));
Jim Cownie5e8470a2013-09-27 10:38:44 +00002740
Jonathan Peyton30419822017-05-12 18:01:32 +00002741 thread = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002742
Jonathan Peyton30419822017-05-12 18:01:32 +00002743 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002744
Jonathan Peyton30419822017-05-12 18:01:32 +00002745 set__max_active_levels(thread, max_active_levels);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002746}
2747
2748/* Gets max_active_levels */
Jonathan Peyton30419822017-05-12 18:01:32 +00002749int __kmp_get_max_active_levels(int gtid) {
2750 kmp_info_t *thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002751
Jonathan Peyton30419822017-05-12 18:01:32 +00002752 KF_TRACE(10, ("__kmp_get_max_active_levels: thread %d\n", gtid));
2753 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002754
Jonathan Peyton30419822017-05-12 18:01:32 +00002755 thread = __kmp_threads[gtid];
2756 KMP_DEBUG_ASSERT(thread->th.th_current_task);
2757 KF_TRACE(10, ("__kmp_get_max_active_levels: thread %d, curtask=%p, "
2758 "curtask_maxaclevel=%d\n",
2759 gtid, thread->th.th_current_task,
2760 thread->th.th_current_task->td_icvs.max_active_levels));
2761 return thread->th.th_current_task->td_icvs.max_active_levels;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002762}
2763
2764/* Changes def_sched_var ICV values (run-time schedule kind and chunk) */
Jonathan Peyton30419822017-05-12 18:01:32 +00002765void __kmp_set_schedule(int gtid, kmp_sched_t kind, int chunk) {
2766 kmp_info_t *thread;
2767 // kmp_team_t *team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002768
Jonathan Peyton30419822017-05-12 18:01:32 +00002769 KF_TRACE(10, ("__kmp_set_schedule: new schedule for thread %d = (%d, %d)\n",
2770 gtid, (int)kind, chunk));
2771 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002772
Jonathan Peyton30419822017-05-12 18:01:32 +00002773 // Check if the kind parameter is valid, correct if needed.
2774 // Valid parameters should fit in one of two intervals - standard or extended:
2775 // <lower>, <valid>, <upper_std>, <lower_ext>, <valid>, <upper>
2776 // 2008-01-25: 0, 1 - 4, 5, 100, 101 - 102, 103
2777 if (kind <= kmp_sched_lower || kind >= kmp_sched_upper ||
2778 (kind <= kmp_sched_lower_ext && kind >= kmp_sched_upper_std)) {
2779 // TODO: Hint needs attention in case we change the default schedule.
2780 __kmp_msg(kmp_ms_warning, KMP_MSG(ScheduleKindOutOfRange, kind),
2781 KMP_HNT(DefaultScheduleKindUsed, "static, no chunk"),
2782 __kmp_msg_null);
2783 kind = kmp_sched_default;
2784 chunk = 0; // ignore chunk value in case of bad kind
2785 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002786
Jonathan Peyton30419822017-05-12 18:01:32 +00002787 thread = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002788
Jonathan Peyton30419822017-05-12 18:01:32 +00002789 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002790
Jonathan Peyton30419822017-05-12 18:01:32 +00002791 if (kind < kmp_sched_upper_std) {
2792 if (kind == kmp_sched_static && chunk < KMP_DEFAULT_CHUNK) {
2793 // differ static chunked vs. unchunked: chunk should be invalid to
2794 // indicate unchunked schedule (which is the default)
2795 thread->th.th_current_task->td_icvs.sched.r_sched_type = kmp_sch_static;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002796 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00002797 thread->th.th_current_task->td_icvs.sched.r_sched_type =
2798 __kmp_sch_map[kind - kmp_sched_lower - 1];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002799 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002800 } else {
2801 // __kmp_sch_map[ kind - kmp_sched_lower_ext + kmp_sched_upper_std -
2802 // kmp_sched_lower - 2 ];
2803 thread->th.th_current_task->td_icvs.sched.r_sched_type =
2804 __kmp_sch_map[kind - kmp_sched_lower_ext + kmp_sched_upper_std -
2805 kmp_sched_lower - 2];
2806 }
Andrey Churbanovd454c732017-06-05 17:17:33 +00002807 if (kind == kmp_sched_auto || chunk < 1) {
Jonathan Peyton30419822017-05-12 18:01:32 +00002808 // ignore parameter chunk for schedule auto
2809 thread->th.th_current_task->td_icvs.sched.chunk = KMP_DEFAULT_CHUNK;
2810 } else {
2811 thread->th.th_current_task->td_icvs.sched.chunk = chunk;
2812 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002813}
2814
2815/* Gets def_sched_var ICV values */
Jonathan Peyton30419822017-05-12 18:01:32 +00002816void __kmp_get_schedule(int gtid, kmp_sched_t *kind, int *chunk) {
2817 kmp_info_t *thread;
2818 enum sched_type th_type;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002819
Jonathan Peyton30419822017-05-12 18:01:32 +00002820 KF_TRACE(10, ("__kmp_get_schedule: thread %d\n", gtid));
2821 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002822
Jonathan Peyton30419822017-05-12 18:01:32 +00002823 thread = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00002824
Jonathan Peyton30419822017-05-12 18:01:32 +00002825 th_type = thread->th.th_current_task->td_icvs.sched.r_sched_type;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002826
Jonathan Peyton30419822017-05-12 18:01:32 +00002827 switch (th_type) {
2828 case kmp_sch_static:
2829 case kmp_sch_static_greedy:
2830 case kmp_sch_static_balanced:
2831 *kind = kmp_sched_static;
2832 *chunk = 0; // chunk was not set, try to show this fact via zero value
2833 return;
2834 case kmp_sch_static_chunked:
2835 *kind = kmp_sched_static;
2836 break;
2837 case kmp_sch_dynamic_chunked:
2838 *kind = kmp_sched_dynamic;
2839 break;
2840 case kmp_sch_guided_chunked:
2841 case kmp_sch_guided_iterative_chunked:
2842 case kmp_sch_guided_analytical_chunked:
2843 *kind = kmp_sched_guided;
2844 break;
2845 case kmp_sch_auto:
2846 *kind = kmp_sched_auto;
2847 break;
2848 case kmp_sch_trapezoidal:
2849 *kind = kmp_sched_trapezoidal;
2850 break;
Jonathan Peytona1234cf2016-10-07 18:01:35 +00002851#if KMP_STATIC_STEAL_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002852 case kmp_sch_static_steal:
2853 *kind = kmp_sched_static_steal;
2854 break;
Jonathan Peytona1234cf2016-10-07 18:01:35 +00002855#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00002856 default:
2857 KMP_FATAL(UnknownSchedulingType, th_type);
2858 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002859
Jonathan Peyton30419822017-05-12 18:01:32 +00002860 *chunk = thread->th.th_current_task->td_icvs.sched.chunk;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002861}
2862
Jonathan Peyton30419822017-05-12 18:01:32 +00002863int __kmp_get_ancestor_thread_num(int gtid, int level) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002864
Jonathan Peyton30419822017-05-12 18:01:32 +00002865 int ii, dd;
2866 kmp_team_t *team;
2867 kmp_info_t *thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002868
Jonathan Peyton30419822017-05-12 18:01:32 +00002869 KF_TRACE(10, ("__kmp_get_ancestor_thread_num: thread %d %d\n", gtid, level));
2870 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002871
Jonathan Peyton30419822017-05-12 18:01:32 +00002872 // validate level
2873 if (level == 0)
2874 return 0;
2875 if (level < 0)
2876 return -1;
2877 thr = __kmp_threads[gtid];
2878 team = thr->th.th_team;
2879 ii = team->t.t_level;
2880 if (level > ii)
2881 return -1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002882
2883#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002884 if (thr->th.th_teams_microtask) {
2885 // AC: we are in teams region where multiple nested teams have same level
2886 int tlevel = thr->th.th_teams_level; // the level of the teams construct
2887 if (level <=
2888 tlevel) { // otherwise usual algorithm works (will not touch the teams)
2889 KMP_DEBUG_ASSERT(ii >= tlevel);
2890 // AC: As we need to pass by the teams league, we need to artificially
2891 // increase ii
2892 if (ii == tlevel) {
2893 ii += 2; // three teams have same level
2894 } else {
2895 ii++; // two teams have same level
2896 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002897 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002898 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002899#endif
2900
Jonathan Peyton30419822017-05-12 18:01:32 +00002901 if (ii == level)
2902 return __kmp_tid_from_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002903
Jonathan Peyton30419822017-05-12 18:01:32 +00002904 dd = team->t.t_serialized;
2905 level++;
2906 while (ii > level) {
2907 for (dd = team->t.t_serialized; (dd > 0) && (ii > level); dd--, ii--) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002908 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002909 if ((team->t.t_serialized) && (!dd)) {
2910 team = team->t.t_parent;
2911 continue;
2912 }
2913 if (ii > level) {
2914 team = team->t.t_parent;
2915 dd = team->t.t_serialized;
2916 ii--;
2917 }
2918 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002919
Jonathan Peyton30419822017-05-12 18:01:32 +00002920 return (dd > 1) ? (0) : (team->t.t_master_tid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002921}
2922
Jonathan Peyton30419822017-05-12 18:01:32 +00002923int __kmp_get_team_size(int gtid, int level) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002924
Jonathan Peyton30419822017-05-12 18:01:32 +00002925 int ii, dd;
2926 kmp_team_t *team;
2927 kmp_info_t *thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002928
Jonathan Peyton30419822017-05-12 18:01:32 +00002929 KF_TRACE(10, ("__kmp_get_team_size: thread %d %d\n", gtid, level));
2930 KMP_DEBUG_ASSERT(__kmp_init_serial);
Jim Cownie5e8470a2013-09-27 10:38:44 +00002931
Jonathan Peyton30419822017-05-12 18:01:32 +00002932 // validate level
2933 if (level == 0)
2934 return 1;
2935 if (level < 0)
2936 return -1;
2937 thr = __kmp_threads[gtid];
2938 team = thr->th.th_team;
2939 ii = team->t.t_level;
2940 if (level > ii)
2941 return -1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002942
2943#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00002944 if (thr->th.th_teams_microtask) {
2945 // AC: we are in teams region where multiple nested teams have same level
2946 int tlevel = thr->th.th_teams_level; // the level of the teams construct
2947 if (level <=
2948 tlevel) { // otherwise usual algorithm works (will not touch the teams)
2949 KMP_DEBUG_ASSERT(ii >= tlevel);
2950 // AC: As we need to pass by the teams league, we need to artificially
2951 // increase ii
2952 if (ii == tlevel) {
2953 ii += 2; // three teams have same level
2954 } else {
2955 ii++; // two teams have same level
2956 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002957 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002958 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002959#endif
2960
Jonathan Peyton30419822017-05-12 18:01:32 +00002961 while (ii > level) {
2962 for (dd = team->t.t_serialized; (dd > 0) && (ii > level); dd--, ii--) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00002963 }
Jonathan Peyton30419822017-05-12 18:01:32 +00002964 if (team->t.t_serialized && (!dd)) {
2965 team = team->t.t_parent;
2966 continue;
2967 }
2968 if (ii > level) {
2969 team = team->t.t_parent;
2970 ii--;
2971 }
2972 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00002973
Jonathan Peyton30419822017-05-12 18:01:32 +00002974 return team->t.t_nproc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002975}
2976
Jonathan Peyton30419822017-05-12 18:01:32 +00002977kmp_r_sched_t __kmp_get_schedule_global() {
2978 // This routine created because pairs (__kmp_sched, __kmp_chunk) and
2979 // (__kmp_static, __kmp_guided) may be changed by kmp_set_defaults
2980 // independently. So one can get the updated schedule here.
Jim Cownie5e8470a2013-09-27 10:38:44 +00002981
Jonathan Peyton30419822017-05-12 18:01:32 +00002982 kmp_r_sched_t r_sched;
Jim Cownie5e8470a2013-09-27 10:38:44 +00002983
Jonathan Peyton30419822017-05-12 18:01:32 +00002984 // create schedule from 4 globals: __kmp_sched, __kmp_chunk, __kmp_static,
2985 // __kmp_guided. __kmp_sched should keep original value, so that user can set
2986 // KMP_SCHEDULE multiple times, and thus have different run-time schedules in
2987 // different roots (even in OMP 2.5)
2988 if (__kmp_sched == kmp_sch_static) {
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00002989 // replace STATIC with more detailed schedule (balanced or greedy)
2990 r_sched.r_sched_type = __kmp_static;
Jonathan Peyton30419822017-05-12 18:01:32 +00002991 } else if (__kmp_sched == kmp_sch_guided_chunked) {
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00002992 // replace GUIDED with more detailed schedule (iterative or analytical)
2993 r_sched.r_sched_type = __kmp_guided;
2994 } else { // (STATIC_CHUNKED), or (DYNAMIC_CHUNKED), or other
2995 r_sched.r_sched_type = __kmp_sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00002996 }
2997
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00002998 if (__kmp_chunk < KMP_DEFAULT_CHUNK) {
2999 // __kmp_chunk may be wrong here (if it was not ever set)
Jonathan Peyton30419822017-05-12 18:01:32 +00003000 r_sched.chunk = KMP_DEFAULT_CHUNK;
3001 } else {
3002 r_sched.chunk = __kmp_chunk;
3003 }
3004
3005 return r_sched;
3006}
3007
3008/* Allocate (realloc == FALSE) * or reallocate (realloc == TRUE)
3009 at least argc number of *t_argv entries for the requested team. */
3010static void __kmp_alloc_argv_entries(int argc, kmp_team_t *team, int realloc) {
3011
3012 KMP_DEBUG_ASSERT(team);
3013 if (!realloc || argc > team->t.t_max_argc) {
3014
3015 KA_TRACE(100, ("__kmp_alloc_argv_entries: team %d: needed entries=%d, "
3016 "current entries=%d\n",
3017 team->t.t_id, argc, (realloc) ? team->t.t_max_argc : 0));
3018 /* if previously allocated heap space for args, free them */
3019 if (realloc && team->t.t_argv != &team->t.t_inline_argv[0])
3020 __kmp_free((void *)team->t.t_argv);
3021
3022 if (argc <= KMP_INLINE_ARGV_ENTRIES) {
3023 /* use unused space in the cache line for arguments */
3024 team->t.t_max_argc = KMP_INLINE_ARGV_ENTRIES;
3025 KA_TRACE(100, ("__kmp_alloc_argv_entries: team %d: inline allocate %d "
3026 "argv entries\n",
3027 team->t.t_id, team->t.t_max_argc));
3028 team->t.t_argv = &team->t.t_inline_argv[0];
3029 if (__kmp_storage_map) {
3030 __kmp_print_storage_map_gtid(
3031 -1, &team->t.t_inline_argv[0],
3032 &team->t.t_inline_argv[KMP_INLINE_ARGV_ENTRIES],
3033 (sizeof(void *) * KMP_INLINE_ARGV_ENTRIES), "team_%d.t_inline_argv",
3034 team->t.t_id);
3035 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003036 } else {
Jonathan Peyton30419822017-05-12 18:01:32 +00003037 /* allocate space for arguments in the heap */
3038 team->t.t_max_argc = (argc <= (KMP_MIN_MALLOC_ARGV_ENTRIES >> 1))
3039 ? KMP_MIN_MALLOC_ARGV_ENTRIES
3040 : 2 * argc;
3041 KA_TRACE(100, ("__kmp_alloc_argv_entries: team %d: dynamic allocate %d "
3042 "argv entries\n",
3043 team->t.t_id, team->t.t_max_argc));
3044 team->t.t_argv =
3045 (void **)__kmp_page_allocate(sizeof(void *) * team->t.t_max_argc);
3046 if (__kmp_storage_map) {
3047 __kmp_print_storage_map_gtid(-1, &team->t.t_argv[0],
3048 &team->t.t_argv[team->t.t_max_argc],
3049 sizeof(void *) * team->t.t_max_argc,
3050 "team_%d.t_argv", team->t.t_id);
3051 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003052 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003053 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003054}
3055
Jonathan Peyton30419822017-05-12 18:01:32 +00003056static void __kmp_allocate_team_arrays(kmp_team_t *team, int max_nth) {
3057 int i;
3058 int num_disp_buff = max_nth > 1 ? __kmp_dispatch_num_buffers : 2;
3059 team->t.t_threads =
3060 (kmp_info_t **)__kmp_allocate(sizeof(kmp_info_t *) * max_nth);
3061 team->t.t_disp_buffer = (dispatch_shared_info_t *)__kmp_allocate(
3062 sizeof(dispatch_shared_info_t) * num_disp_buff);
3063 team->t.t_dispatch =
3064 (kmp_disp_t *)__kmp_allocate(sizeof(kmp_disp_t) * max_nth);
3065 team->t.t_implicit_task_taskdata =
3066 (kmp_taskdata_t *)__kmp_allocate(sizeof(kmp_taskdata_t) * max_nth);
3067 team->t.t_max_nproc = max_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003068
Jonathan Peyton30419822017-05-12 18:01:32 +00003069 /* setup dispatch buffers */
3070 for (i = 0; i < num_disp_buff; ++i) {
3071 team->t.t_disp_buffer[i].buffer_index = i;
Jonathan Peytondf6818b2016-06-14 17:57:47 +00003072#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003073 team->t.t_disp_buffer[i].doacross_buf_idx = i;
Jonathan Peyton71909c52016-03-02 22:42:06 +00003074#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003075 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003076}
3077
Jonathan Peyton30419822017-05-12 18:01:32 +00003078static void __kmp_free_team_arrays(kmp_team_t *team) {
3079 /* Note: this does not free the threads in t_threads (__kmp_free_threads) */
3080 int i;
3081 for (i = 0; i < team->t.t_max_nproc; ++i) {
3082 if (team->t.t_dispatch[i].th_disp_buffer != NULL) {
3083 __kmp_free(team->t.t_dispatch[i].th_disp_buffer);
3084 team->t.t_dispatch[i].th_disp_buffer = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003085 }
3086 }
Jonathan Peytonf6399362018-07-09 17:51:13 +00003087#if KMP_USE_HIER_SCHED
3088 __kmp_dispatch_free_hierarchies(team);
3089#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003090 __kmp_free(team->t.t_threads);
3091 __kmp_free(team->t.t_disp_buffer);
3092 __kmp_free(team->t.t_dispatch);
3093 __kmp_free(team->t.t_implicit_task_taskdata);
3094 team->t.t_threads = NULL;
3095 team->t.t_disp_buffer = NULL;
3096 team->t.t_dispatch = NULL;
3097 team->t.t_implicit_task_taskdata = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003098}
3099
Jonathan Peyton30419822017-05-12 18:01:32 +00003100static void __kmp_reallocate_team_arrays(kmp_team_t *team, int max_nth) {
3101 kmp_info_t **oldThreads = team->t.t_threads;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003102
Jonathan Peyton30419822017-05-12 18:01:32 +00003103 __kmp_free(team->t.t_disp_buffer);
3104 __kmp_free(team->t.t_dispatch);
3105 __kmp_free(team->t.t_implicit_task_taskdata);
3106 __kmp_allocate_team_arrays(team, max_nth);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003107
Jonathan Peyton30419822017-05-12 18:01:32 +00003108 KMP_MEMCPY(team->t.t_threads, oldThreads,
3109 team->t.t_nproc * sizeof(kmp_info_t *));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003110
Jonathan Peyton30419822017-05-12 18:01:32 +00003111 __kmp_free(oldThreads);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003112}
3113
Jonathan Peyton30419822017-05-12 18:01:32 +00003114static kmp_internal_control_t __kmp_get_global_icvs(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003115
Jonathan Peyton30419822017-05-12 18:01:32 +00003116 kmp_r_sched_t r_sched =
3117 __kmp_get_schedule_global(); // get current state of scheduling globals
Jim Cownie5e8470a2013-09-27 10:38:44 +00003118
3119#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003120 KMP_DEBUG_ASSERT(__kmp_nested_proc_bind.used > 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003121#endif /* OMP_40_ENABLED */
3122
Jonathan Peyton30419822017-05-12 18:01:32 +00003123 kmp_internal_control_t g_icvs = {
3124 0, // int serial_nesting_level; //corresponds to value of th_team_serialized
3125 (kmp_int8)__kmp_dflt_nested, // int nested; //internal control
3126 // for nested parallelism (per thread)
3127 (kmp_int8)__kmp_global.g.g_dynamic, // internal control for dynamic
3128 // adjustment of threads (per thread)
3129 (kmp_int8)__kmp_env_blocktime, // int bt_set; //internal control for
3130 // whether blocktime is explicitly set
3131 __kmp_dflt_blocktime, // int blocktime; //internal control for blocktime
Jonathan Peytone1c7c132016-10-07 18:12:19 +00003132#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00003133 __kmp_bt_intervals, // int bt_intervals; //internal control for blocktime
3134// intervals
Jonathan Peytone1c7c132016-10-07 18:12:19 +00003135#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003136 __kmp_dflt_team_nth, // int nproc; //internal control for # of threads for
3137 // next parallel region (per thread)
3138 // (use a max ub on value if __kmp_parallel_initialize not called yet)
3139 __kmp_dflt_max_active_levels, // int max_active_levels; //internal control
3140 // for max_active_levels
3141 r_sched, // kmp_r_sched_t sched; //internal control for runtime schedule
3142// {sched,chunk} pair
Jim Cownie5e8470a2013-09-27 10:38:44 +00003143#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003144 __kmp_nested_proc_bind.bind_types[0],
3145 __kmp_default_device,
Jim Cownie5e8470a2013-09-27 10:38:44 +00003146#endif /* OMP_40_ENABLED */
Jonathan Peyton30419822017-05-12 18:01:32 +00003147 NULL // struct kmp_internal_control *next;
3148 };
Jim Cownie5e8470a2013-09-27 10:38:44 +00003149
Jonathan Peyton30419822017-05-12 18:01:32 +00003150 return g_icvs;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003151}
3152
Jonathan Peyton30419822017-05-12 18:01:32 +00003153static kmp_internal_control_t __kmp_get_x_global_icvs(const kmp_team_t *team) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003154
Jonathan Peyton30419822017-05-12 18:01:32 +00003155 kmp_internal_control_t gx_icvs;
3156 gx_icvs.serial_nesting_level =
3157 0; // probably =team->t.t_serial like in save_inter_controls
3158 copy_icvs(&gx_icvs, &team->t.t_threads[0]->th.th_current_task->td_icvs);
3159 gx_icvs.next = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003160
Jonathan Peyton30419822017-05-12 18:01:32 +00003161 return gx_icvs;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003162}
3163
Jonathan Peyton30419822017-05-12 18:01:32 +00003164static void __kmp_initialize_root(kmp_root_t *root) {
3165 int f;
3166 kmp_team_t *root_team;
3167 kmp_team_t *hot_team;
3168 int hot_team_max_nth;
3169 kmp_r_sched_t r_sched =
3170 __kmp_get_schedule_global(); // get current state of scheduling globals
3171 kmp_internal_control_t r_icvs = __kmp_get_global_icvs();
3172 KMP_DEBUG_ASSERT(root);
3173 KMP_ASSERT(!root->r.r_begin);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003174
Jonathan Peyton30419822017-05-12 18:01:32 +00003175 /* setup the root state structure */
3176 __kmp_init_lock(&root->r.r_begin_lock);
3177 root->r.r_begin = FALSE;
3178 root->r.r_active = FALSE;
3179 root->r.r_in_parallel = 0;
3180 root->r.r_blocktime = __kmp_dflt_blocktime;
3181 root->r.r_nested = __kmp_dflt_nested;
Jonathan Peytonf4392462017-07-27 20:58:41 +00003182 root->r.r_cg_nthreads = 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003183
Jonathan Peyton30419822017-05-12 18:01:32 +00003184 /* setup the root team for this task */
3185 /* allocate the root team structure */
3186 KF_TRACE(10, ("__kmp_initialize_root: before root_team\n"));
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003187
Jonathan Peyton30419822017-05-12 18:01:32 +00003188 root_team =
3189 __kmp_allocate_team(root,
3190 1, // new_nproc
3191 1, // max_nproc
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003192#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003193 ompt_data_none, // root parallel id
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003194#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003195#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003196 __kmp_nested_proc_bind.bind_types[0],
Jim Cownie5e8470a2013-09-27 10:38:44 +00003197#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003198 &r_icvs,
3199 0 // argc
3200 USE_NESTED_HOT_ARG(NULL) // master thread is unknown
3201 );
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00003202#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00003203 // Non-NULL value should be assigned to make the debugger display the root
3204 // team.
3205 TCW_SYNC_PTR(root_team->t.t_pkfn, (microtask_t)(~0));
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00003206#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003207
Jonathan Peyton30419822017-05-12 18:01:32 +00003208 KF_TRACE(10, ("__kmp_initialize_root: after root_team = %p\n", root_team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003209
Jonathan Peyton30419822017-05-12 18:01:32 +00003210 root->r.r_root_team = root_team;
3211 root_team->t.t_control_stack_top = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003212
Jonathan Peyton30419822017-05-12 18:01:32 +00003213 /* initialize root team */
3214 root_team->t.t_threads[0] = NULL;
3215 root_team->t.t_nproc = 1;
3216 root_team->t.t_serialized = 1;
3217 // TODO???: root_team->t.t_max_active_levels = __kmp_dflt_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00003218 root_team->t.t_sched.sched = r_sched.sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00003219 KA_TRACE(
3220 20,
3221 ("__kmp_initialize_root: init root team %d arrived: join=%u, plain=%u\n",
3222 root_team->t.t_id, KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003223
Jonathan Peyton30419822017-05-12 18:01:32 +00003224 /* setup the hot team for this task */
3225 /* allocate the hot team structure */
3226 KF_TRACE(10, ("__kmp_initialize_root: before hot_team\n"));
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003227
Jonathan Peyton30419822017-05-12 18:01:32 +00003228 hot_team =
3229 __kmp_allocate_team(root,
3230 1, // new_nproc
3231 __kmp_dflt_team_nth_ub * 2, // max_nproc
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003232#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003233 ompt_data_none, // root parallel id
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003234#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003235#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003236 __kmp_nested_proc_bind.bind_types[0],
Jim Cownie5e8470a2013-09-27 10:38:44 +00003237#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003238 &r_icvs,
3239 0 // argc
3240 USE_NESTED_HOT_ARG(NULL) // master thread is unknown
3241 );
3242 KF_TRACE(10, ("__kmp_initialize_root: after hot_team = %p\n", hot_team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003243
Jonathan Peyton30419822017-05-12 18:01:32 +00003244 root->r.r_hot_team = hot_team;
3245 root_team->t.t_control_stack_top = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003246
Jonathan Peyton30419822017-05-12 18:01:32 +00003247 /* first-time initialization */
3248 hot_team->t.t_parent = root_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003249
Jonathan Peyton30419822017-05-12 18:01:32 +00003250 /* initialize hot team */
3251 hot_team_max_nth = hot_team->t.t_max_nproc;
3252 for (f = 0; f < hot_team_max_nth; ++f) {
3253 hot_team->t.t_threads[f] = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003254 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003255 hot_team->t.t_nproc = 1;
3256 // TODO???: hot_team->t.t_max_active_levels = __kmp_dflt_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00003257 hot_team->t.t_sched.sched = r_sched.sched;
Jonathan Peyton30419822017-05-12 18:01:32 +00003258 hot_team->t.t_size_changed = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003259}
3260
3261#ifdef KMP_DEBUG
3262
Jim Cownie5e8470a2013-09-27 10:38:44 +00003263typedef struct kmp_team_list_item {
Jonathan Peyton30419822017-05-12 18:01:32 +00003264 kmp_team_p const *entry;
3265 struct kmp_team_list_item *next;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003266} kmp_team_list_item_t;
Jonathan Peyton30419822017-05-12 18:01:32 +00003267typedef kmp_team_list_item_t *kmp_team_list_t;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003268
Jonathan Peyton30419822017-05-12 18:01:32 +00003269static void __kmp_print_structure_team_accum( // Add team to list of teams.
3270 kmp_team_list_t list, // List of teams.
3271 kmp_team_p const *team // Team to add.
3272 ) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003273
Jonathan Peyton30419822017-05-12 18:01:32 +00003274 // List must terminate with item where both entry and next are NULL.
3275 // Team is added to the list only once.
3276 // List is sorted in ascending order by team id.
3277 // Team id is *not* a key.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003278
Jonathan Peyton30419822017-05-12 18:01:32 +00003279 kmp_team_list_t l;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003280
Jonathan Peyton30419822017-05-12 18:01:32 +00003281 KMP_DEBUG_ASSERT(list != NULL);
3282 if (team == NULL) {
3283 return;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003284 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003285
Jonathan Peyton30419822017-05-12 18:01:32 +00003286 __kmp_print_structure_team_accum(list, team->t.t_parent);
3287 __kmp_print_structure_team_accum(list, team->t.t_next_pool);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003288
Jonathan Peyton30419822017-05-12 18:01:32 +00003289 // Search list for the team.
3290 l = list;
3291 while (l->next != NULL && l->entry != team) {
3292 l = l->next;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003293 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003294 if (l->next != NULL) {
3295 return; // Team has been added before, exit.
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003296 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003297
Jonathan Peyton30419822017-05-12 18:01:32 +00003298 // Team is not found. Search list again for insertion point.
3299 l = list;
3300 while (l->next != NULL && l->entry->t.t_id <= team->t.t_id) {
3301 l = l->next;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003302 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003303
Jonathan Peyton30419822017-05-12 18:01:32 +00003304 // Insert team.
3305 {
3306 kmp_team_list_item_t *item = (kmp_team_list_item_t *)KMP_INTERNAL_MALLOC(
3307 sizeof(kmp_team_list_item_t));
3308 *item = *l;
3309 l->entry = team;
3310 l->next = item;
3311 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003312}
3313
Jonathan Peyton30419822017-05-12 18:01:32 +00003314static void __kmp_print_structure_team(char const *title, kmp_team_p const *team
Jim Cownie5e8470a2013-09-27 10:38:44 +00003315
Jonathan Peyton30419822017-05-12 18:01:32 +00003316 ) {
3317 __kmp_printf("%s", title);
3318 if (team != NULL) {
3319 __kmp_printf("%2x %p\n", team->t.t_id, team);
3320 } else {
3321 __kmp_printf(" - (nil)\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003322 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003323}
3324
Jonathan Peyton30419822017-05-12 18:01:32 +00003325static void __kmp_print_structure_thread(char const *title,
3326 kmp_info_p const *thread) {
3327 __kmp_printf("%s", title);
3328 if (thread != NULL) {
3329 __kmp_printf("%2d %p\n", thread->th.th_info.ds.ds_gtid, thread);
3330 } else {
3331 __kmp_printf(" - (nil)\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003332 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003333}
3334
Jonathan Peyton30419822017-05-12 18:01:32 +00003335void __kmp_print_structure(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003336
Jonathan Peyton30419822017-05-12 18:01:32 +00003337 kmp_team_list_t list;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003338
Jonathan Peyton30419822017-05-12 18:01:32 +00003339 // Initialize list of teams.
3340 list =
3341 (kmp_team_list_item_t *)KMP_INTERNAL_MALLOC(sizeof(kmp_team_list_item_t));
3342 list->entry = NULL;
3343 list->next = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003344
Jonathan Peyton30419822017-05-12 18:01:32 +00003345 __kmp_printf("\n------------------------------\nGlobal Thread "
3346 "Table\n------------------------------\n");
3347 {
3348 int gtid;
3349 for (gtid = 0; gtid < __kmp_threads_capacity; ++gtid) {
3350 __kmp_printf("%2d", gtid);
3351 if (__kmp_threads != NULL) {
3352 __kmp_printf(" %p", __kmp_threads[gtid]);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003353 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003354 if (__kmp_root != NULL) {
3355 __kmp_printf(" %p", __kmp_root[gtid]);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003356 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003357 __kmp_printf("\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003358 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003359 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003360
Jonathan Peyton30419822017-05-12 18:01:32 +00003361 // Print out __kmp_threads array.
3362 __kmp_printf("\n------------------------------\nThreads\n--------------------"
3363 "----------\n");
3364 if (__kmp_threads != NULL) {
3365 int gtid;
3366 for (gtid = 0; gtid < __kmp_threads_capacity; ++gtid) {
3367 kmp_info_t const *thread = __kmp_threads[gtid];
3368 if (thread != NULL) {
3369 __kmp_printf("GTID %2d %p:\n", gtid, thread);
3370 __kmp_printf(" Our Root: %p\n", thread->th.th_root);
3371 __kmp_print_structure_team(" Our Team: ", thread->th.th_team);
3372 __kmp_print_structure_team(" Serial Team: ",
3373 thread->th.th_serial_team);
3374 __kmp_printf(" Threads: %2d\n", thread->th.th_team_nproc);
3375 __kmp_print_structure_thread(" Master: ",
3376 thread->th.th_team_master);
3377 __kmp_printf(" Serialized?: %2d\n", thread->th.th_team_serialized);
3378 __kmp_printf(" Set NProc: %2d\n", thread->th.th_set_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003379#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003380 __kmp_printf(" Set Proc Bind: %2d\n", thread->th.th_set_proc_bind);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003381#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003382 __kmp_print_structure_thread(" Next in pool: ",
3383 thread->th.th_next_pool);
3384 __kmp_printf("\n");
3385 __kmp_print_structure_team_accum(list, thread->th.th_team);
3386 __kmp_print_structure_team_accum(list, thread->th.th_serial_team);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003387 }
3388 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003389 } else {
3390 __kmp_printf("Threads array is not allocated.\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003391 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003392
Jonathan Peyton30419822017-05-12 18:01:32 +00003393 // Print out __kmp_root array.
3394 __kmp_printf("\n------------------------------\nUbers\n----------------------"
3395 "--------\n");
3396 if (__kmp_root != NULL) {
3397 int gtid;
3398 for (gtid = 0; gtid < __kmp_threads_capacity; ++gtid) {
3399 kmp_root_t const *root = __kmp_root[gtid];
3400 if (root != NULL) {
3401 __kmp_printf("GTID %2d %p:\n", gtid, root);
3402 __kmp_print_structure_team(" Root Team: ", root->r.r_root_team);
3403 __kmp_print_structure_team(" Hot Team: ", root->r.r_hot_team);
3404 __kmp_print_structure_thread(" Uber Thread: ",
3405 root->r.r_uber_thread);
3406 __kmp_printf(" Active?: %2d\n", root->r.r_active);
3407 __kmp_printf(" Nested?: %2d\n", root->r.r_nested);
Jonathan Peyton61d44f12018-07-09 18:09:25 +00003408 __kmp_printf(" In Parallel: %2d\n",
3409 KMP_ATOMIC_LD_RLX(&root->r.r_in_parallel));
Jonathan Peyton30419822017-05-12 18:01:32 +00003410 __kmp_printf("\n");
3411 __kmp_print_structure_team_accum(list, root->r.r_root_team);
3412 __kmp_print_structure_team_accum(list, root->r.r_hot_team);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003413 }
3414 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003415 } else {
3416 __kmp_printf("Ubers array is not allocated.\n");
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003417 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003418
Jonathan Peyton30419822017-05-12 18:01:32 +00003419 __kmp_printf("\n------------------------------\nTeams\n----------------------"
3420 "--------\n");
3421 while (list->next != NULL) {
3422 kmp_team_p const *team = list->entry;
3423 int i;
3424 __kmp_printf("Team %2x %p:\n", team->t.t_id, team);
3425 __kmp_print_structure_team(" Parent Team: ", team->t.t_parent);
3426 __kmp_printf(" Master TID: %2d\n", team->t.t_master_tid);
3427 __kmp_printf(" Max threads: %2d\n", team->t.t_max_nproc);
3428 __kmp_printf(" Levels of serial: %2d\n", team->t.t_serialized);
3429 __kmp_printf(" Number threads: %2d\n", team->t.t_nproc);
3430 for (i = 0; i < team->t.t_nproc; ++i) {
3431 __kmp_printf(" Thread %2d: ", i);
3432 __kmp_print_structure_thread("", team->t.t_threads[i]);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003433 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003434 __kmp_print_structure_team(" Next in pool: ", team->t.t_next_pool);
3435 __kmp_printf("\n");
3436 list = list->next;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003437 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003438
Jonathan Peyton30419822017-05-12 18:01:32 +00003439 // Print out __kmp_thread_pool and __kmp_team_pool.
3440 __kmp_printf("\n------------------------------\nPools\n----------------------"
3441 "--------\n");
3442 __kmp_print_structure_thread("Thread pool: ",
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00003443 CCAST(kmp_info_t *, __kmp_thread_pool));
Jonathan Peyton30419822017-05-12 18:01:32 +00003444 __kmp_print_structure_team("Team pool: ",
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00003445 CCAST(kmp_team_t *, __kmp_team_pool));
Jonathan Peyton30419822017-05-12 18:01:32 +00003446 __kmp_printf("\n");
Jim Cownie5e8470a2013-09-27 10:38:44 +00003447
Jonathan Peyton30419822017-05-12 18:01:32 +00003448 // Free team list.
3449 while (list != NULL) {
3450 kmp_team_list_item_t *item = list;
3451 list = list->next;
3452 KMP_INTERNAL_FREE(item);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003453 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003454}
3455
3456#endif
3457
Jim Cownie5e8470a2013-09-27 10:38:44 +00003458//---------------------------------------------------------------------------
3459// Stuff for per-thread fast random number generator
3460// Table of primes
Jim Cownie5e8470a2013-09-27 10:38:44 +00003461static const unsigned __kmp_primes[] = {
Jonathan Peyton30419822017-05-12 18:01:32 +00003462 0x9e3779b1, 0xffe6cc59, 0x2109f6dd, 0x43977ab5, 0xba5703f5, 0xb495a877,
3463 0xe1626741, 0x79695e6b, 0xbc98c09f, 0xd5bee2b3, 0x287488f9, 0x3af18231,
3464 0x9677cd4d, 0xbe3a6929, 0xadc6a877, 0xdcf0674b, 0xbe4d6fe9, 0x5f15e201,
3465 0x99afc3fd, 0xf3f16801, 0xe222cfff, 0x24ba5fdb, 0x0620452d, 0x79f149e3,
3466 0xc8b93f49, 0x972702cd, 0xb07dd827, 0x6c97d5ed, 0x085a3d61, 0x46eb5ea7,
3467 0x3d9910ed, 0x2e687b5b, 0x29609227, 0x6eb081f1, 0x0954c4e1, 0x9d114db9,
3468 0x542acfa9, 0xb3e6bd7b, 0x0742d917, 0xe9f3ffa7, 0x54581edb, 0xf2480f45,
3469 0x0bb9288f, 0xef1affc7, 0x85fa0ca7, 0x3ccc14db, 0xe6baf34b, 0x343377f7,
3470 0x5ca19031, 0xe6d9293b, 0xf0a9f391, 0x5d2e980b, 0xfc411073, 0xc3749363,
3471 0xb892d829, 0x3549366b, 0x629750ad, 0xb98294e5, 0x892d9483, 0xc235baf3,
3472 0x3d2402a3, 0x6bdef3c9, 0xbec333cd, 0x40c9520f};
Jim Cownie5e8470a2013-09-27 10:38:44 +00003473
3474//---------------------------------------------------------------------------
3475// __kmp_get_random: Get a random number using a linear congruential method.
Jonathan Peyton30419822017-05-12 18:01:32 +00003476unsigned short __kmp_get_random(kmp_info_t *thread) {
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003477 unsigned x = thread->th.th_x;
Jonathan Peyton30419822017-05-12 18:01:32 +00003478 unsigned short r = x >> 16;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003479
Jonathan Peyton30419822017-05-12 18:01:32 +00003480 thread->th.th_x = x * thread->th.th_a + 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003481
3482 KA_TRACE(30, ("__kmp_get_random: THREAD: %d, RETURN: %u\n",
Jonathan Peyton30419822017-05-12 18:01:32 +00003483 thread->th.th_info.ds.ds_tid, r));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003484
3485 return r;
3486}
3487//--------------------------------------------------------
3488// __kmp_init_random: Initialize a random number generator
Jonathan Peyton30419822017-05-12 18:01:32 +00003489void __kmp_init_random(kmp_info_t *thread) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00003490 unsigned seed = thread->th.th_info.ds.ds_tid;
3491
Jonathan Peyton30419822017-05-12 18:01:32 +00003492 thread->th.th_a =
3493 __kmp_primes[seed % (sizeof(__kmp_primes) / sizeof(__kmp_primes[0]))];
3494 thread->th.th_x = (seed + 1) * thread->th.th_a + 1;
3495 KA_TRACE(30,
3496 ("__kmp_init_random: THREAD: %u; A: %u\n", seed, thread->th.th_a));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003497}
3498
Jim Cownie5e8470a2013-09-27 10:38:44 +00003499#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00003500/* reclaim array entries for root threads that are already dead, returns number
3501 * reclaimed */
3502static int __kmp_reclaim_dead_roots(void) {
3503 int i, r = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003504
Jonathan Peyton30419822017-05-12 18:01:32 +00003505 for (i = 0; i < __kmp_threads_capacity; ++i) {
3506 if (KMP_UBER_GTID(i) &&
3507 !__kmp_still_running((kmp_info_t *)TCR_SYNC_PTR(__kmp_threads[i])) &&
3508 !__kmp_root[i]
3509 ->r.r_active) { // AC: reclaim only roots died in non-active state
3510 r += __kmp_unregister_root_other_thread(i);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003511 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003512 }
3513 return r;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003514}
3515#endif
3516
Jonathan Peyton30419822017-05-12 18:01:32 +00003517/* This function attempts to create free entries in __kmp_threads and
3518 __kmp_root, and returns the number of free entries generated.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003519
Jonathan Peyton30419822017-05-12 18:01:32 +00003520 For Windows* OS static library, the first mechanism used is to reclaim array
3521 entries for root threads that are already dead.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003522
Jonathan Peyton30419822017-05-12 18:01:32 +00003523 On all platforms, expansion is attempted on the arrays __kmp_threads_ and
3524 __kmp_root, with appropriate update to __kmp_threads_capacity. Array
3525 capacity is increased by doubling with clipping to __kmp_tp_capacity, if
3526 threadprivate cache array has been created. Synchronization with
3527 __kmpc_threadprivate_cached is done using __kmp_tp_cached_lock.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003528
Jonathan Peyton30419822017-05-12 18:01:32 +00003529 After any dead root reclamation, if the clipping value allows array expansion
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003530 to result in the generation of a total of nNeed free slots, the function does
3531 that expansion. If not, nothing is done beyond the possible initial root
3532 thread reclamation.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003533
Jonathan Peyton30419822017-05-12 18:01:32 +00003534 If any argument is negative, the behavior is undefined. */
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003535static int __kmp_expand_threads(int nNeed) {
Jonathan Peyton30419822017-05-12 18:01:32 +00003536 int added = 0;
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003537 int minimumRequiredCapacity;
3538 int newCapacity;
3539 kmp_info_t **newThreads;
3540 kmp_root_t **newRoot;
3541
3542// All calls to __kmp_expand_threads should be under __kmp_forkjoin_lock, so
3543// resizing __kmp_threads does not need additional protection if foreign
3544// threads are present
Jim Cownie5e8470a2013-09-27 10:38:44 +00003545
Jonathan Peyton8b3842f2018-10-05 17:59:39 +00003546#if KMP_OS_WINDOWS && !KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +00003547 /* only for Windows static library */
3548 /* reclaim array entries for root threads that are already dead */
3549 added = __kmp_reclaim_dead_roots();
Jim Cownie5e8470a2013-09-27 10:38:44 +00003550
Jonathan Peyton30419822017-05-12 18:01:32 +00003551 if (nNeed) {
3552 nNeed -= added;
3553 if (nNeed < 0)
3554 nNeed = 0;
3555 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003556#endif
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003557 if (nNeed <= 0)
Jim Cownie5e8470a2013-09-27 10:38:44 +00003558 return added;
Jonathan Peyton30419822017-05-12 18:01:32 +00003559
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003560 // Note that __kmp_threads_capacity is not bounded by __kmp_max_nth. If
3561 // __kmp_max_nth is set to some value less than __kmp_sys_max_nth by the
3562 // user via KMP_DEVICE_THREAD_LIMIT, then __kmp_threads_capacity may become
3563 // > __kmp_max_nth in one of two ways:
3564 //
3565 // 1) The initialization thread (gtid = 0) exits. __kmp_threads[0]
3566 // may not be resused by another thread, so we may need to increase
3567 // __kmp_threads_capacity to __kmp_max_nth + 1.
3568 //
3569 // 2) New foreign root(s) are encountered. We always register new foreign
3570 // roots. This may cause a smaller # of threads to be allocated at
3571 // subsequent parallel regions, but the worker threads hang around (and
3572 // eventually go to sleep) and need slots in the __kmp_threads[] array.
3573 //
3574 // Anyway, that is the reason for moving the check to see if
3575 // __kmp_max_nth was exceeded into __kmp_reserve_threads()
3576 // instead of having it performed here. -BB
Jonathan Peyton30419822017-05-12 18:01:32 +00003577
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003578 KMP_DEBUG_ASSERT(__kmp_sys_max_nth >= __kmp_threads_capacity);
Jonathan Peyton30419822017-05-12 18:01:32 +00003579
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003580 /* compute expansion headroom to check if we can expand */
3581 if (__kmp_sys_max_nth - __kmp_threads_capacity < nNeed) {
3582 /* possible expansion too small -- give up */
3583 return added;
Jonathan Peyton30419822017-05-12 18:01:32 +00003584 }
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00003585 minimumRequiredCapacity = __kmp_threads_capacity + nNeed;
3586
3587 newCapacity = __kmp_threads_capacity;
3588 do {
3589 newCapacity = newCapacity <= (__kmp_sys_max_nth >> 1) ? (newCapacity << 1)
3590 : __kmp_sys_max_nth;
3591 } while (newCapacity < minimumRequiredCapacity);
3592 newThreads = (kmp_info_t **)__kmp_allocate(
3593 (sizeof(kmp_info_t *) + sizeof(kmp_root_t *)) * newCapacity + CACHE_LINE);
3594 newRoot =
3595 (kmp_root_t **)((char *)newThreads + sizeof(kmp_info_t *) * newCapacity);
3596 KMP_MEMCPY(newThreads, __kmp_threads,
3597 __kmp_threads_capacity * sizeof(kmp_info_t *));
3598 KMP_MEMCPY(newRoot, __kmp_root,
3599 __kmp_threads_capacity * sizeof(kmp_root_t *));
3600
3601 kmp_info_t **temp_threads = __kmp_threads;
3602 *(kmp_info_t * *volatile *)&__kmp_threads = newThreads;
3603 *(kmp_root_t * *volatile *)&__kmp_root = newRoot;
3604 __kmp_free(temp_threads);
3605 added += newCapacity - __kmp_threads_capacity;
3606 *(volatile int *)&__kmp_threads_capacity = newCapacity;
3607
3608 if (newCapacity > __kmp_tp_capacity) {
3609 __kmp_acquire_bootstrap_lock(&__kmp_tp_cached_lock);
3610 if (__kmp_tp_cached && newCapacity > __kmp_tp_capacity) {
3611 __kmp_threadprivate_resize_cache(newCapacity);
3612 } else { // increase __kmp_tp_capacity to correspond with kmp_threads size
3613 *(volatile int *)&__kmp_tp_capacity = newCapacity;
3614 }
3615 __kmp_release_bootstrap_lock(&__kmp_tp_cached_lock);
3616 }
3617
Jonathan Peyton30419822017-05-12 18:01:32 +00003618 return added;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003619}
3620
Jonathan Peyton30419822017-05-12 18:01:32 +00003621/* Register the current thread as a root thread and obtain our gtid. We must
3622 have the __kmp_initz_lock held at this point. Argument TRUE only if are the
3623 thread that calls from __kmp_do_serial_initialize() */
3624int __kmp_register_root(int initial_thread) {
3625 kmp_info_t *root_thread;
3626 kmp_root_t *root;
3627 int gtid;
3628 int capacity;
3629 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
3630 KA_TRACE(20, ("__kmp_register_root: entered\n"));
3631 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00003632
Jonathan Peyton30419822017-05-12 18:01:32 +00003633 /* 2007-03-02:
3634 If initial thread did not invoke OpenMP RTL yet, and this thread is not an
3635 initial one, "__kmp_all_nth >= __kmp_threads_capacity" condition does not
3636 work as expected -- it may return false (that means there is at least one
3637 empty slot in __kmp_threads array), but it is possible the only free slot
3638 is #0, which is reserved for initial thread and so cannot be used for this
3639 one. Following code workarounds this bug.
Jim Cownie5e8470a2013-09-27 10:38:44 +00003640
Jonathan Peyton30419822017-05-12 18:01:32 +00003641 However, right solution seems to be not reserving slot #0 for initial
3642 thread because:
3643 (1) there is no magic in slot #0,
3644 (2) we cannot detect initial thread reliably (the first thread which does
3645 serial initialization may be not a real initial thread).
3646 */
3647 capacity = __kmp_threads_capacity;
3648 if (!initial_thread && TCR_PTR(__kmp_threads[0]) == NULL) {
3649 --capacity;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003650 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003651
Jonathan Peyton30419822017-05-12 18:01:32 +00003652 /* see if there are too many threads */
Jonathan Peyton1800ece2018-01-10 18:27:01 +00003653 if (__kmp_all_nth >= capacity && !__kmp_expand_threads(1)) {
Jonathan Peyton30419822017-05-12 18:01:32 +00003654 if (__kmp_tp_cached) {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00003655 __kmp_fatal(KMP_MSG(CantRegisterNewThread),
3656 KMP_HNT(Set_ALL_THREADPRIVATE, __kmp_tp_capacity),
3657 KMP_HNT(PossibleSystemLimitOnThreads), __kmp_msg_null);
Jonathan Peyton30419822017-05-12 18:01:32 +00003658 } else {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00003659 __kmp_fatal(KMP_MSG(CantRegisterNewThread), KMP_HNT(SystemLimitOnThreads),
3660 __kmp_msg_null);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003661 }
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003662 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003663
3664 /* find an available thread slot */
3665 /* Don't reassign the zero slot since we need that to only be used by initial
3666 thread */
3667 for (gtid = (initial_thread ? 0 : 1); TCR_PTR(__kmp_threads[gtid]) != NULL;
3668 gtid++)
3669 ;
3670 KA_TRACE(1,
3671 ("__kmp_register_root: found slot in threads array: T#%d\n", gtid));
3672 KMP_ASSERT(gtid < __kmp_threads_capacity);
3673
3674 /* update global accounting */
3675 __kmp_all_nth++;
3676 TCW_4(__kmp_nth, __kmp_nth + 1);
3677
3678 // if __kmp_adjust_gtid_mode is set, then we use method #1 (sp search) for low
3679 // numbers of procs, and method #2 (keyed API call) for higher numbers.
3680 if (__kmp_adjust_gtid_mode) {
3681 if (__kmp_all_nth >= __kmp_tls_gtid_min) {
3682 if (TCR_4(__kmp_gtid_mode) != 2) {
3683 TCW_4(__kmp_gtid_mode, 2);
3684 }
3685 } else {
3686 if (TCR_4(__kmp_gtid_mode) != 1) {
3687 TCW_4(__kmp_gtid_mode, 1);
3688 }
3689 }
3690 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003691
3692#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00003693 /* Adjust blocktime to zero if necessary */
3694 /* Middle initialization might not have occurred yet */
3695 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
3696 if (__kmp_nth > __kmp_avail_proc) {
3697 __kmp_zero_bt = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003698 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003699 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003700#endif /* KMP_ADJUST_BLOCKTIME */
3701
Jonathan Peyton30419822017-05-12 18:01:32 +00003702 /* setup this new hierarchy */
3703 if (!(root = __kmp_root[gtid])) {
3704 root = __kmp_root[gtid] = (kmp_root_t *)__kmp_allocate(sizeof(kmp_root_t));
3705 KMP_DEBUG_ASSERT(!root->r.r_root_team);
3706 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003707
Jonathan Peyton5375fe82016-11-14 21:13:44 +00003708#if KMP_STATS_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003709 // Initialize stats as soon as possible (right after gtid assignment).
3710 __kmp_stats_thread_ptr = __kmp_stats_list->push_back(gtid);
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00003711 __kmp_stats_thread_ptr->startLife();
Jonathan Peyton30419822017-05-12 18:01:32 +00003712 KMP_SET_THREAD_STATE(SERIAL_REGION);
3713 KMP_INIT_PARTITIONED_TIMERS(OMP_serial);
Jonathan Peyton5375fe82016-11-14 21:13:44 +00003714#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003715 __kmp_initialize_root(root);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003716
Jonathan Peyton30419822017-05-12 18:01:32 +00003717 /* setup new root thread structure */
3718 if (root->r.r_uber_thread) {
3719 root_thread = root->r.r_uber_thread;
3720 } else {
3721 root_thread = (kmp_info_t *)__kmp_allocate(sizeof(kmp_info_t));
3722 if (__kmp_storage_map) {
3723 __kmp_print_thread_storage_map(root_thread, gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003724 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003725 root_thread->th.th_info.ds.ds_gtid = gtid;
Joachim Protze82e94a52017-11-01 10:08:30 +00003726#if OMPT_SUPPORT
Jonathan Peyton3574f282018-10-04 14:57:04 +00003727 root_thread->th.ompt_thread_info.thread_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00003728#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003729 root_thread->th.th_root = root;
3730 if (__kmp_env_consistency_check) {
3731 root_thread->th.th_cons = __kmp_allocate_cons_stack(gtid);
3732 }
3733#if USE_FAST_MEMORY
3734 __kmp_initialize_fast_memory(root_thread);
3735#endif /* USE_FAST_MEMORY */
Jim Cownie5e8470a2013-09-27 10:38:44 +00003736
Jonathan Peyton30419822017-05-12 18:01:32 +00003737#if KMP_USE_BGET
3738 KMP_DEBUG_ASSERT(root_thread->th.th_local.bget_data == NULL);
3739 __kmp_initialize_bget(root_thread);
3740#endif
3741 __kmp_init_random(root_thread); // Initialize random number generator
3742 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003743
Jonathan Peyton30419822017-05-12 18:01:32 +00003744 /* setup the serial team held in reserve by the root thread */
3745 if (!root_thread->th.th_serial_team) {
3746 kmp_internal_control_t r_icvs = __kmp_get_global_icvs();
3747 KF_TRACE(10, ("__kmp_register_root: before serial_team\n"));
3748 root_thread->th.th_serial_team =
3749 __kmp_allocate_team(root, 1, 1,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003750#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003751 ompt_data_none, // root parallel id
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003752#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003753#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003754 proc_bind_default,
Jim Cownie5e8470a2013-09-27 10:38:44 +00003755#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003756 &r_icvs, 0 USE_NESTED_HOT_ARG(NULL));
3757 }
3758 KMP_ASSERT(root_thread->th.th_serial_team);
3759 KF_TRACE(10, ("__kmp_register_root: after serial_team = %p\n",
3760 root_thread->th.th_serial_team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003761
Jonathan Peyton30419822017-05-12 18:01:32 +00003762 /* drop root_thread into place */
3763 TCW_SYNC_PTR(__kmp_threads[gtid], root_thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003764
Jonathan Peyton30419822017-05-12 18:01:32 +00003765 root->r.r_root_team->t.t_threads[0] = root_thread;
3766 root->r.r_hot_team->t.t_threads[0] = root_thread;
3767 root_thread->th.th_serial_team->t.t_threads[0] = root_thread;
3768 // AC: the team created in reserve, not for execution (it is unused for now).
3769 root_thread->th.th_serial_team->t.t_serialized = 0;
3770 root->r.r_uber_thread = root_thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003771
Jonathan Peyton30419822017-05-12 18:01:32 +00003772 /* initialize the thread, get it ready to go */
3773 __kmp_initialize_info(root_thread, root->r.r_root_team, 0, gtid);
3774 TCW_4(__kmp_init_gtid, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003775
Jonathan Peyton30419822017-05-12 18:01:32 +00003776 /* prepare the master thread for get_gtid() */
3777 __kmp_gtid_set_specific(gtid);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003778
Jonathan Peyton7abf9d52016-05-26 18:19:10 +00003779#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00003780 __kmp_itt_thread_name(gtid);
Jonathan Peyton7abf9d52016-05-26 18:19:10 +00003781#endif /* USE_ITT_BUILD */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003782
Jonathan Peyton30419822017-05-12 18:01:32 +00003783#ifdef KMP_TDATA_GTID
3784 __kmp_gtid = gtid;
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00003785#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003786 __kmp_create_worker(gtid, root_thread, __kmp_stksize);
3787 KMP_DEBUG_ASSERT(__kmp_gtid_get_specific() == gtid);
3788
3789 KA_TRACE(20, ("__kmp_register_root: T#%d init T#%d(%d:%d) arrived: join=%u, "
3790 "plain=%u\n",
3791 gtid, __kmp_gtid_from_tid(0, root->r.r_hot_team),
3792 root->r.r_hot_team->t.t_id, 0, KMP_INIT_BARRIER_STATE,
3793 KMP_INIT_BARRIER_STATE));
3794 { // Initialize barrier data.
3795 int b;
3796 for (b = 0; b < bs_last_barrier; ++b) {
3797 root_thread->th.th_bar[b].bb.b_arrived = KMP_INIT_BARRIER_STATE;
3798#if USE_DEBUGGER
3799 root_thread->th.th_bar[b].bb.b_worker_arrived = 0;
3800#endif
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00003801 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003802 }
3803 KMP_DEBUG_ASSERT(root->r.r_hot_team->t.t_bar[bs_forkjoin_barrier].b_arrived ==
3804 KMP_INIT_BARRIER_STATE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003805
Alp Toker763b9392014-02-28 09:42:41 +00003806#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00003807#if OMP_40_ENABLED
3808 root_thread->th.th_current_place = KMP_PLACE_UNDEFINED;
3809 root_thread->th.th_new_place = KMP_PLACE_UNDEFINED;
3810 root_thread->th.th_first_place = KMP_PLACE_UNDEFINED;
3811 root_thread->th.th_last_place = KMP_PLACE_UNDEFINED;
3812#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003813 if (TCR_4(__kmp_init_middle)) {
3814 __kmp_affinity_set_init_mask(gtid, TRUE);
3815 }
Alp Toker763b9392014-02-28 09:42:41 +00003816#endif /* KMP_AFFINITY_SUPPORTED */
Jonathan Peyton92ca6182018-09-07 18:25:49 +00003817#if OMP_50_ENABLED
3818 root_thread->th.th_def_allocator = __kmp_def_allocator;
3819#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00003820
Jonathan Peyton30419822017-05-12 18:01:32 +00003821 __kmp_root_counter++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003822
Joachim Protze82e94a52017-11-01 10:08:30 +00003823#if OMPT_SUPPORT
3824 if (!initial_thread && ompt_enabled.enabled) {
3825
Joachim Protze489cdb72018-09-10 14:34:54 +00003826 kmp_info_t *root_thread = ompt_get_thread();
Joachim Protze82e94a52017-11-01 10:08:30 +00003827
3828 ompt_set_thread_state(root_thread, omp_state_overhead);
3829
3830 if (ompt_enabled.ompt_callback_thread_begin) {
3831 ompt_callbacks.ompt_callback(ompt_callback_thread_begin)(
3832 ompt_thread_initial, __ompt_get_thread_data_internal());
3833 }
3834 ompt_data_t *task_data;
3835 __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
3836 if (ompt_enabled.ompt_callback_task_create) {
3837 ompt_callbacks.ompt_callback(ompt_callback_task_create)(
3838 NULL, NULL, task_data, ompt_task_initial, 0, NULL);
3839 // initial task has nothing to return to
3840 }
3841
3842 ompt_set_thread_state(root_thread, omp_state_work_serial);
3843 }
3844#endif
3845
Jonathan Peyton30419822017-05-12 18:01:32 +00003846 KMP_MB();
3847 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003848
Jonathan Peyton30419822017-05-12 18:01:32 +00003849 return gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003850}
3851
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003852#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00003853static int __kmp_free_hot_teams(kmp_root_t *root, kmp_info_t *thr, int level,
3854 const int max_level) {
3855 int i, n, nth;
3856 kmp_hot_team_ptr_t *hot_teams = thr->th.th_hot_teams;
3857 if (!hot_teams || !hot_teams[level].hot_team) {
3858 return 0;
3859 }
3860 KMP_DEBUG_ASSERT(level < max_level);
3861 kmp_team_t *team = hot_teams[level].hot_team;
3862 nth = hot_teams[level].hot_team_nth;
3863 n = nth - 1; // master is not freed
3864 if (level < max_level - 1) {
3865 for (i = 0; i < nth; ++i) {
3866 kmp_info_t *th = team->t.t_threads[i];
3867 n += __kmp_free_hot_teams(root, th, level + 1, max_level);
3868 if (i > 0 && th->th.th_hot_teams) {
3869 __kmp_free(th->th.th_hot_teams);
3870 th->th.th_hot_teams = NULL;
3871 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003872 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003873 }
3874 __kmp_free_team(root, team, NULL);
3875 return n;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003876}
3877#endif
3878
Jonathan Peyton30419822017-05-12 18:01:32 +00003879// Resets a root thread and clear its root and hot teams.
3880// Returns the number of __kmp_threads entries directly and indirectly freed.
3881static int __kmp_reset_root(int gtid, kmp_root_t *root) {
3882 kmp_team_t *root_team = root->r.r_root_team;
3883 kmp_team_t *hot_team = root->r.r_hot_team;
3884 int n = hot_team->t.t_nproc;
3885 int i;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003886
Jonathan Peyton30419822017-05-12 18:01:32 +00003887 KMP_DEBUG_ASSERT(!root->r.r_active);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003888
Jonathan Peyton30419822017-05-12 18:01:32 +00003889 root->r.r_root_team = NULL;
3890 root->r.r_hot_team = NULL;
3891 // __kmp_free_team() does not free hot teams, so we have to clear r_hot_team
3892 // before call to __kmp_free_team().
3893 __kmp_free_team(root, root_team USE_NESTED_HOT_ARG(NULL));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003894#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00003895 if (__kmp_hot_teams_max_level >
3896 0) { // need to free nested hot teams and their threads if any
3897 for (i = 0; i < hot_team->t.t_nproc; ++i) {
3898 kmp_info_t *th = hot_team->t.t_threads[i];
3899 if (__kmp_hot_teams_max_level > 1) {
3900 n += __kmp_free_hot_teams(root, th, 1, __kmp_hot_teams_max_level);
3901 }
3902 if (th->th.th_hot_teams) {
3903 __kmp_free(th->th.th_hot_teams);
3904 th->th.th_hot_teams = NULL;
3905 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003906 }
Jonathan Peyton30419822017-05-12 18:01:32 +00003907 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00003908#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003909 __kmp_free_team(root, hot_team USE_NESTED_HOT_ARG(NULL));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003910
Jonathan Peyton30419822017-05-12 18:01:32 +00003911 // Before we can reap the thread, we need to make certain that all other
3912 // threads in the teams that had this root as ancestor have stopped trying to
3913 // steal tasks.
3914 if (__kmp_tasking_mode != tskm_immediate_exec) {
3915 __kmp_wait_to_unref_task_teams();
3916 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00003917
Jonathan Peyton30419822017-05-12 18:01:32 +00003918#if KMP_OS_WINDOWS
3919 /* Close Handle of root duplicated in __kmp_create_worker (tr #62919) */
3920 KA_TRACE(
3921 10, ("__kmp_reset_root: free handle, th = %p, handle = %" KMP_UINTPTR_SPEC
3922 "\n",
3923 (LPVOID) & (root->r.r_uber_thread->th),
3924 root->r.r_uber_thread->th.th_info.ds.ds_thread));
3925 __kmp_free_handle(root->r.r_uber_thread->th.th_info.ds.ds_thread);
3926#endif /* KMP_OS_WINDOWS */
Jim Cownie5e8470a2013-09-27 10:38:44 +00003927
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003928#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00003929 if (ompt_enabled.ompt_callback_thread_end) {
3930 ompt_callbacks.ompt_callback(ompt_callback_thread_end)(
3931 &(root->r.r_uber_thread->th.ompt_thread_info.thread_data));
Jonathan Peyton30419822017-05-12 18:01:32 +00003932 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00003933#endif
3934
Jonathan Peyton30419822017-05-12 18:01:32 +00003935 TCW_4(__kmp_nth,
3936 __kmp_nth - 1); // __kmp_reap_thread will decrement __kmp_all_nth.
Jonathan Peytonf4392462017-07-27 20:58:41 +00003937 root->r.r_cg_nthreads--;
3938
Jonathan Peyton30419822017-05-12 18:01:32 +00003939 __kmp_reap_thread(root->r.r_uber_thread, 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003940
Jonathan Peyton30419822017-05-12 18:01:32 +00003941 // We canot put root thread to __kmp_thread_pool, so we have to reap it istead
3942 // of freeing.
3943 root->r.r_uber_thread = NULL;
3944 /* mark root as no longer in use */
3945 root->r.r_begin = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003946
Jonathan Peyton30419822017-05-12 18:01:32 +00003947 return n;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003948}
3949
Jonathan Peyton30419822017-05-12 18:01:32 +00003950void __kmp_unregister_root_current_thread(int gtid) {
3951 KA_TRACE(1, ("__kmp_unregister_root_current_thread: enter T#%d\n", gtid));
3952 /* this lock should be ok, since unregister_root_current_thread is never
3953 called during an abort, only during a normal close. furthermore, if you
3954 have the forkjoin lock, you should never try to get the initz lock */
3955 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
3956 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
3957 KC_TRACE(10, ("__kmp_unregister_root_current_thread: already finished, "
3958 "exiting T#%d\n",
3959 gtid));
3960 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
3961 return;
3962 }
3963 kmp_root_t *root = __kmp_root[gtid];
Jim Cownie77c2a632014-09-03 11:34:33 +00003964
Jonathan Peyton30419822017-05-12 18:01:32 +00003965 KMP_DEBUG_ASSERT(__kmp_threads && __kmp_threads[gtid]);
3966 KMP_ASSERT(KMP_UBER_GTID(gtid));
3967 KMP_ASSERT(root == __kmp_threads[gtid]->th.th_root);
3968 KMP_ASSERT(root->r.r_active == FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003969
Jonathan Peyton30419822017-05-12 18:01:32 +00003970 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00003971
Jonathan Peytondf6818b2016-06-14 17:57:47 +00003972#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00003973 kmp_info_t *thread = __kmp_threads[gtid];
3974 kmp_team_t *team = thread->th.th_team;
3975 kmp_task_team_t *task_team = thread->th.th_task_team;
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00003976
Jonathan Peyton30419822017-05-12 18:01:32 +00003977 // we need to wait for the proxy tasks before finishing the thread
3978 if (task_team != NULL && task_team->tt.tt_found_proxy_tasks) {
Jonathan Peyton6d247f72015-09-10 21:33:50 +00003979#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00003980 // the runtime is shutting down so we won't report any events
Joachim Protze82e94a52017-11-01 10:08:30 +00003981 thread->th.ompt_thread_info.state = omp_state_undefined;
Jonathan Peyton6d247f72015-09-10 21:33:50 +00003982#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00003983 __kmp_task_team_wait(thread, team USE_ITT_BUILD_ARG(NULL));
3984 }
Andrey Churbanov535b6fa2015-05-07 17:41:51 +00003985#endif
3986
Jonathan Peyton30419822017-05-12 18:01:32 +00003987 __kmp_reset_root(gtid, root);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003988
Jonathan Peyton30419822017-05-12 18:01:32 +00003989 /* free up this thread slot */
3990 __kmp_gtid_set_specific(KMP_GTID_DNE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00003991#ifdef KMP_TDATA_GTID
Jonathan Peyton30419822017-05-12 18:01:32 +00003992 __kmp_gtid = KMP_GTID_DNE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00003993#endif
3994
Jonathan Peyton30419822017-05-12 18:01:32 +00003995 KMP_MB();
3996 KC_TRACE(10,
3997 ("__kmp_unregister_root_current_thread: T#%d unregistered\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00003998
Jonathan Peyton30419822017-05-12 18:01:32 +00003999 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004000}
4001
Jonathan Peyton2321d572015-06-08 19:25:25 +00004002#if KMP_OS_WINDOWS
Jim Cownie5e8470a2013-09-27 10:38:44 +00004003/* __kmp_forkjoin_lock must be already held
Jonathan Peyton30419822017-05-12 18:01:32 +00004004 Unregisters a root thread that is not the current thread. Returns the number
4005 of __kmp_threads entries freed as a result. */
4006static int __kmp_unregister_root_other_thread(int gtid) {
4007 kmp_root_t *root = __kmp_root[gtid];
4008 int r;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004009
Jonathan Peyton30419822017-05-12 18:01:32 +00004010 KA_TRACE(1, ("__kmp_unregister_root_other_thread: enter T#%d\n", gtid));
4011 KMP_DEBUG_ASSERT(__kmp_threads && __kmp_threads[gtid]);
4012 KMP_ASSERT(KMP_UBER_GTID(gtid));
4013 KMP_ASSERT(root == __kmp_threads[gtid]->th.th_root);
4014 KMP_ASSERT(root->r.r_active == FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004015
Jonathan Peyton30419822017-05-12 18:01:32 +00004016 r = __kmp_reset_root(gtid, root);
4017 KC_TRACE(10,
4018 ("__kmp_unregister_root_other_thread: T#%d unregistered\n", gtid));
4019 return r;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004020}
Jonathan Peyton2321d572015-06-08 19:25:25 +00004021#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00004022
Jim Cownie5e8470a2013-09-27 10:38:44 +00004023#if KMP_DEBUG
4024void __kmp_task_info() {
4025
Jonathan Peyton30419822017-05-12 18:01:32 +00004026 kmp_int32 gtid = __kmp_entry_gtid();
4027 kmp_int32 tid = __kmp_tid_from_gtid(gtid);
4028 kmp_info_t *this_thr = __kmp_threads[gtid];
4029 kmp_team_t *steam = this_thr->th.th_serial_team;
4030 kmp_team_t *team = this_thr->th.th_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004031
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00004032 __kmp_printf(
4033 "__kmp_task_info: gtid=%d tid=%d t_thread=%p team=%p steam=%p curtask=%p "
4034 "ptask=%p\n",
4035 gtid, tid, this_thr, team, steam, this_thr->th.th_current_task,
4036 team->t.t_implicit_task_taskdata[tid].td_parent);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004037}
4038#endif // KMP_DEBUG
4039
Jonathan Peyton30419822017-05-12 18:01:32 +00004040/* TODO optimize with one big memclr, take out what isn't needed, split
4041 responsibility to workers as much as possible, and delay initialization of
4042 features as much as possible */
4043static void __kmp_initialize_info(kmp_info_t *this_thr, kmp_team_t *team,
4044 int tid, int gtid) {
4045 /* this_thr->th.th_info.ds.ds_gtid is setup in
4046 kmp_allocate_thread/create_worker.
4047 this_thr->th.th_serial_team is setup in __kmp_allocate_thread */
4048 kmp_info_t *master = team->t.t_threads[0];
4049 KMP_DEBUG_ASSERT(this_thr != NULL);
4050 KMP_DEBUG_ASSERT(this_thr->th.th_serial_team);
4051 KMP_DEBUG_ASSERT(team);
4052 KMP_DEBUG_ASSERT(team->t.t_threads);
4053 KMP_DEBUG_ASSERT(team->t.t_dispatch);
4054 KMP_DEBUG_ASSERT(master);
4055 KMP_DEBUG_ASSERT(master->th.th_root);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004056
Jonathan Peyton30419822017-05-12 18:01:32 +00004057 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004058
Jonathan Peyton30419822017-05-12 18:01:32 +00004059 TCW_SYNC_PTR(this_thr->th.th_team, team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004060
Jonathan Peyton30419822017-05-12 18:01:32 +00004061 this_thr->th.th_info.ds.ds_tid = tid;
4062 this_thr->th.th_set_nproc = 0;
4063 if (__kmp_tasking_mode != tskm_immediate_exec)
4064 // When tasking is possible, threads are not safe to reap until they are
4065 // done tasking; this will be set when tasking code is exited in wait
4066 this_thr->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
4067 else // no tasking --> always safe to reap
4068 this_thr->th.th_reap_state = KMP_SAFE_TO_REAP;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004069#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004070 this_thr->th.th_set_proc_bind = proc_bind_default;
4071#if KMP_AFFINITY_SUPPORTED
4072 this_thr->th.th_new_place = this_thr->th.th_current_place;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004073#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004074#endif
4075 this_thr->th.th_root = master->th.th_root;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004076
Jonathan Peyton30419822017-05-12 18:01:32 +00004077 /* setup the thread's cache of the team structure */
4078 this_thr->th.th_team_nproc = team->t.t_nproc;
4079 this_thr->th.th_team_master = master;
4080 this_thr->th.th_team_serialized = team->t.t_serialized;
4081 TCW_PTR(this_thr->th.th_sleep_loc, NULL);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004082
Jonathan Peyton30419822017-05-12 18:01:32 +00004083 KMP_DEBUG_ASSERT(team->t.t_implicit_task_taskdata);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004084
Jonathan Peyton30419822017-05-12 18:01:32 +00004085 KF_TRACE(10, ("__kmp_initialize_info1: T#%d:%d this_thread=%p curtask=%p\n",
4086 tid, gtid, this_thr, this_thr->th.th_current_task));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004087
Jonathan Peyton30419822017-05-12 18:01:32 +00004088 __kmp_init_implicit_task(this_thr->th.th_team_master->th.th_ident, this_thr,
4089 team, tid, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004090
Jonathan Peyton30419822017-05-12 18:01:32 +00004091 KF_TRACE(10, ("__kmp_initialize_info2: T#%d:%d this_thread=%p curtask=%p\n",
4092 tid, gtid, this_thr, this_thr->th.th_current_task));
4093 // TODO: Initialize ICVs from parent; GEH - isn't that already done in
4094 // __kmp_initialize_team()?
Jim Cownie5e8470a2013-09-27 10:38:44 +00004095
Jonathan Peyton30419822017-05-12 18:01:32 +00004096 /* TODO no worksharing in speculative threads */
4097 this_thr->th.th_dispatch = &team->t.t_dispatch[tid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00004098
Jonathan Peyton30419822017-05-12 18:01:32 +00004099 this_thr->th.th_local.this_construct = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004100
Jonathan Peyton30419822017-05-12 18:01:32 +00004101 if (!this_thr->th.th_pri_common) {
4102 this_thr->th.th_pri_common =
4103 (struct common_table *)__kmp_allocate(sizeof(struct common_table));
4104 if (__kmp_storage_map) {
4105 __kmp_print_storage_map_gtid(
4106 gtid, this_thr->th.th_pri_common, this_thr->th.th_pri_common + 1,
4107 sizeof(struct common_table), "th_%d.th_pri_common\n", gtid);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00004108 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004109 this_thr->th.th_pri_head = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00004110 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004111
Jonathan Peyton30419822017-05-12 18:01:32 +00004112 /* Initialize dynamic dispatch */
4113 {
4114 volatile kmp_disp_t *dispatch = this_thr->th.th_dispatch;
4115 // Use team max_nproc since this will never change for the team.
4116 size_t disp_size =
4117 sizeof(dispatch_private_info_t) *
4118 (team->t.t_max_nproc == 1 ? 1 : __kmp_dispatch_num_buffers);
4119 KD_TRACE(10, ("__kmp_initialize_info: T#%d max_nproc: %d\n", gtid,
4120 team->t.t_max_nproc));
4121 KMP_ASSERT(dispatch);
4122 KMP_DEBUG_ASSERT(team->t.t_dispatch);
4123 KMP_DEBUG_ASSERT(dispatch == &team->t.t_dispatch[tid]);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004124
Jonathan Peyton30419822017-05-12 18:01:32 +00004125 dispatch->th_disp_index = 0;
Jonathan Peytondf6818b2016-06-14 17:57:47 +00004126#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004127 dispatch->th_doacross_buf_idx = 0;
Jonathan Peyton71909c52016-03-02 22:42:06 +00004128#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004129 if (!dispatch->th_disp_buffer) {
4130 dispatch->th_disp_buffer =
4131 (dispatch_private_info_t *)__kmp_allocate(disp_size);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004132
Jonathan Peyton30419822017-05-12 18:01:32 +00004133 if (__kmp_storage_map) {
4134 __kmp_print_storage_map_gtid(
4135 gtid, &dispatch->th_disp_buffer[0],
4136 &dispatch->th_disp_buffer[team->t.t_max_nproc == 1
4137 ? 1
4138 : __kmp_dispatch_num_buffers],
4139 disp_size, "th_%d.th_dispatch.th_disp_buffer "
4140 "(team_%d.t_dispatch[%d].th_disp_buffer)",
4141 gtid, team->t.t_id, gtid);
4142 }
4143 } else {
4144 memset(&dispatch->th_disp_buffer[0], '\0', disp_size);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004145 }
4146
Jonathan Peyton30419822017-05-12 18:01:32 +00004147 dispatch->th_dispatch_pr_current = 0;
4148 dispatch->th_dispatch_sh_current = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004149
Jonathan Peyton30419822017-05-12 18:01:32 +00004150 dispatch->th_deo_fcn = 0; /* ORDERED */
4151 dispatch->th_dxo_fcn = 0; /* END ORDERED */
4152 }
Andrey Churbanov6d224db2015-02-10 18:37:43 +00004153
Jonathan Peyton30419822017-05-12 18:01:32 +00004154 this_thr->th.th_next_pool = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004155
Jonathan Peyton30419822017-05-12 18:01:32 +00004156 if (!this_thr->th.th_task_state_memo_stack) {
4157 size_t i;
4158 this_thr->th.th_task_state_memo_stack =
4159 (kmp_uint8 *)__kmp_allocate(4 * sizeof(kmp_uint8));
4160 this_thr->th.th_task_state_top = 0;
4161 this_thr->th.th_task_state_stack_sz = 4;
4162 for (i = 0; i < this_thr->th.th_task_state_stack_sz;
4163 ++i) // zero init the stack
4164 this_thr->th.th_task_state_memo_stack[i] = 0;
4165 }
4166
4167 KMP_DEBUG_ASSERT(!this_thr->th.th_spin_here);
4168 KMP_DEBUG_ASSERT(this_thr->th.th_next_waiting == 0);
4169
4170 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004171}
4172
Jonathan Peyton30419822017-05-12 18:01:32 +00004173/* allocate a new thread for the requesting team. this is only called from
4174 within a forkjoin critical section. we will first try to get an available
4175 thread from the thread pool. if none is available, we will fork a new one
4176 assuming we are able to create a new one. this should be assured, as the
4177 caller should check on this first. */
4178kmp_info_t *__kmp_allocate_thread(kmp_root_t *root, kmp_team_t *team,
4179 int new_tid) {
4180 kmp_team_t *serial_team;
4181 kmp_info_t *new_thr;
4182 int new_gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004183
Jonathan Peyton30419822017-05-12 18:01:32 +00004184 KA_TRACE(20, ("__kmp_allocate_thread: T#%d\n", __kmp_get_gtid()));
4185 KMP_DEBUG_ASSERT(root && team);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004186#if !KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004187 KMP_DEBUG_ASSERT(KMP_MASTER_GTID(__kmp_get_gtid()));
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004188#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004189 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004190
Jonathan Peyton30419822017-05-12 18:01:32 +00004191 /* first, try to get one from the thread pool */
4192 if (__kmp_thread_pool) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00004193
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00004194 new_thr = CCAST(kmp_info_t *, __kmp_thread_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00004195 __kmp_thread_pool = (volatile kmp_info_t *)new_thr->th.th_next_pool;
4196 if (new_thr == __kmp_thread_pool_insert_pt) {
4197 __kmp_thread_pool_insert_pt = NULL;
4198 }
4199 TCW_4(new_thr->th.th_in_pool, FALSE);
4200 // Don't touch th_active_in_pool or th_active.
4201 // The worker thread adjusts those flags as it sleeps/awakens.
4202 __kmp_thread_pool_nth--;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004203
Jonathan Peyton30419822017-05-12 18:01:32 +00004204 KA_TRACE(20, ("__kmp_allocate_thread: T#%d using thread T#%d\n",
4205 __kmp_get_gtid(), new_thr->th.th_info.ds.ds_gtid));
4206 KMP_ASSERT(!new_thr->th.th_team);
4207 KMP_DEBUG_ASSERT(__kmp_nth < __kmp_threads_capacity);
4208 KMP_DEBUG_ASSERT(__kmp_thread_pool_nth >= 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004209
Jonathan Peyton30419822017-05-12 18:01:32 +00004210 /* setup the thread structure */
4211 __kmp_initialize_info(new_thr, team, new_tid,
4212 new_thr->th.th_info.ds.ds_gtid);
4213 KMP_DEBUG_ASSERT(new_thr->th.th_serial_team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004214
Jonathan Peyton30419822017-05-12 18:01:32 +00004215 TCW_4(__kmp_nth, __kmp_nth + 1);
Jonathan Peytonf4392462017-07-27 20:58:41 +00004216 root->r.r_cg_nthreads++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004217
Jonathan Peyton30419822017-05-12 18:01:32 +00004218 new_thr->th.th_task_state = 0;
4219 new_thr->th.th_task_state_top = 0;
4220 new_thr->th.th_task_state_stack_sz = 4;
Andrey Churbanov6d224db2015-02-10 18:37:43 +00004221
Jim Cownie5e8470a2013-09-27 10:38:44 +00004222#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00004223 /* Adjust blocktime back to zero if necessary */
4224 /* Middle initialization might not have occurred yet */
4225 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
4226 if (__kmp_nth > __kmp_avail_proc) {
4227 __kmp_zero_bt = TRUE;
4228 }
4229 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004230#endif /* KMP_ADJUST_BLOCKTIME */
4231
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004232#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00004233 // If thread entered pool via __kmp_free_thread, wait_flag should !=
4234 // KMP_BARRIER_PARENT_FLAG.
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004235 int b;
Jonathan Peyton30419822017-05-12 18:01:32 +00004236 kmp_balign_t *balign = new_thr->th.th_bar;
4237 for (b = 0; b < bs_last_barrier; ++b)
4238 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004239#endif
4240
Jonathan Peyton30419822017-05-12 18:01:32 +00004241 KF_TRACE(10, ("__kmp_allocate_thread: T#%d using thread %p T#%d\n",
4242 __kmp_get_gtid(), new_thr, new_thr->th.th_info.ds.ds_gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004243
Jim Cownie5e8470a2013-09-27 10:38:44 +00004244 KMP_MB();
4245 return new_thr;
Jonathan Peyton30419822017-05-12 18:01:32 +00004246 }
4247
4248 /* no, well fork a new one */
4249 KMP_ASSERT(__kmp_nth == __kmp_all_nth);
4250 KMP_ASSERT(__kmp_all_nth < __kmp_threads_capacity);
4251
4252#if KMP_USE_MONITOR
4253 // If this is the first worker thread the RTL is creating, then also
4254 // launch the monitor thread. We try to do this as early as possible.
4255 if (!TCR_4(__kmp_init_monitor)) {
4256 __kmp_acquire_bootstrap_lock(&__kmp_monitor_lock);
4257 if (!TCR_4(__kmp_init_monitor)) {
4258 KF_TRACE(10, ("before __kmp_create_monitor\n"));
4259 TCW_4(__kmp_init_monitor, 1);
4260 __kmp_create_monitor(&__kmp_monitor);
4261 KF_TRACE(10, ("after __kmp_create_monitor\n"));
4262#if KMP_OS_WINDOWS
4263 // AC: wait until monitor has started. This is a fix for CQ232808.
4264 // The reason is that if the library is loaded/unloaded in a loop with
4265 // small (parallel) work in between, then there is high probability that
4266 // monitor thread started after the library shutdown. At shutdown it is
4267 // too late to cope with the problem, because when the master is in
4268 // DllMain (process detach) the monitor has no chances to start (it is
4269 // blocked), and master has no means to inform the monitor that the
4270 // library has gone, because all the memory which the monitor can access
4271 // is going to be released/reset.
4272 while (TCR_4(__kmp_init_monitor) < 2) {
4273 KMP_YIELD(TRUE);
4274 }
4275 KF_TRACE(10, ("after monitor thread has started\n"));
4276#endif
4277 }
4278 __kmp_release_bootstrap_lock(&__kmp_monitor_lock);
4279 }
4280#endif
4281
4282 KMP_MB();
4283 for (new_gtid = 1; TCR_PTR(__kmp_threads[new_gtid]) != NULL; ++new_gtid) {
4284 KMP_DEBUG_ASSERT(new_gtid < __kmp_threads_capacity);
4285 }
4286
4287 /* allocate space for it. */
4288 new_thr = (kmp_info_t *)__kmp_allocate(sizeof(kmp_info_t));
4289
4290 TCW_SYNC_PTR(__kmp_threads[new_gtid], new_thr);
4291
4292 if (__kmp_storage_map) {
4293 __kmp_print_thread_storage_map(new_thr, new_gtid);
4294 }
4295
4296 // add the reserve serialized team, initialized from the team's master thread
4297 {
4298 kmp_internal_control_t r_icvs = __kmp_get_x_global_icvs(team);
4299 KF_TRACE(10, ("__kmp_allocate_thread: before th_serial/serial_team\n"));
4300 new_thr->th.th_serial_team = serial_team =
4301 (kmp_team_t *)__kmp_allocate_team(root, 1, 1,
4302#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00004303 ompt_data_none, // root parallel id
Jonathan Peyton30419822017-05-12 18:01:32 +00004304#endif
4305#if OMP_40_ENABLED
4306 proc_bind_default,
4307#endif
4308 &r_icvs, 0 USE_NESTED_HOT_ARG(NULL));
4309 }
4310 KMP_ASSERT(serial_team);
4311 serial_team->t.t_serialized = 0; // AC: the team created in reserve, not for
4312 // execution (it is unused for now).
4313 serial_team->t.t_threads[0] = new_thr;
4314 KF_TRACE(10,
4315 ("__kmp_allocate_thread: after th_serial/serial_team : new_thr=%p\n",
4316 new_thr));
4317
4318 /* setup the thread structures */
4319 __kmp_initialize_info(new_thr, team, new_tid, new_gtid);
4320
4321#if USE_FAST_MEMORY
4322 __kmp_initialize_fast_memory(new_thr);
4323#endif /* USE_FAST_MEMORY */
4324
4325#if KMP_USE_BGET
4326 KMP_DEBUG_ASSERT(new_thr->th.th_local.bget_data == NULL);
4327 __kmp_initialize_bget(new_thr);
4328#endif
4329
4330 __kmp_init_random(new_thr); // Initialize random number generator
4331
4332 /* Initialize these only once when thread is grabbed for a team allocation */
4333 KA_TRACE(20,
4334 ("__kmp_allocate_thread: T#%d init go fork=%u, plain=%u\n",
4335 __kmp_get_gtid(), KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
4336
4337 int b;
4338 kmp_balign_t *balign = new_thr->th.th_bar;
4339 for (b = 0; b < bs_last_barrier; ++b) {
4340 balign[b].bb.b_go = KMP_INIT_BARRIER_STATE;
4341 balign[b].bb.team = NULL;
4342 balign[b].bb.wait_flag = KMP_BARRIER_NOT_WAITING;
4343 balign[b].bb.use_oncore_barrier = 0;
4344 }
4345
4346 new_thr->th.th_spin_here = FALSE;
4347 new_thr->th.th_next_waiting = 0;
Jonathan Peytona764af62018-07-19 19:17:00 +00004348#if KMP_OS_UNIX
4349 new_thr->th.th_blocking = false;
4350#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004351
4352#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
4353 new_thr->th.th_current_place = KMP_PLACE_UNDEFINED;
4354 new_thr->th.th_new_place = KMP_PLACE_UNDEFINED;
4355 new_thr->th.th_first_place = KMP_PLACE_UNDEFINED;
4356 new_thr->th.th_last_place = KMP_PLACE_UNDEFINED;
4357#endif
Jonathan Peyton92ca6182018-09-07 18:25:49 +00004358#if OMP_50_ENABLED
4359 new_thr->th.th_def_allocator = __kmp_def_allocator;
4360#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004361
4362 TCW_4(new_thr->th.th_in_pool, FALSE);
4363 new_thr->th.th_active_in_pool = FALSE;
4364 TCW_4(new_thr->th.th_active, TRUE);
4365
4366 /* adjust the global counters */
4367 __kmp_all_nth++;
4368 __kmp_nth++;
4369
Jonathan Peytonf4392462017-07-27 20:58:41 +00004370 root->r.r_cg_nthreads++;
4371
Jonathan Peyton30419822017-05-12 18:01:32 +00004372 // if __kmp_adjust_gtid_mode is set, then we use method #1 (sp search) for low
4373 // numbers of procs, and method #2 (keyed API call) for higher numbers.
4374 if (__kmp_adjust_gtid_mode) {
4375 if (__kmp_all_nth >= __kmp_tls_gtid_min) {
4376 if (TCR_4(__kmp_gtid_mode) != 2) {
4377 TCW_4(__kmp_gtid_mode, 2);
4378 }
4379 } else {
4380 if (TCR_4(__kmp_gtid_mode) != 1) {
4381 TCW_4(__kmp_gtid_mode, 1);
4382 }
4383 }
4384 }
4385
4386#ifdef KMP_ADJUST_BLOCKTIME
4387 /* Adjust blocktime back to zero if necessary */
4388 /* Middle initialization might not have occurred yet */
4389 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
4390 if (__kmp_nth > __kmp_avail_proc) {
4391 __kmp_zero_bt = TRUE;
4392 }
4393 }
4394#endif /* KMP_ADJUST_BLOCKTIME */
4395
4396 /* actually fork it and create the new worker thread */
4397 KF_TRACE(
4398 10, ("__kmp_allocate_thread: before __kmp_create_worker: %p\n", new_thr));
4399 __kmp_create_worker(new_gtid, new_thr, __kmp_stksize);
4400 KF_TRACE(10,
4401 ("__kmp_allocate_thread: after __kmp_create_worker: %p\n", new_thr));
4402
4403 KA_TRACE(20, ("__kmp_allocate_thread: T#%d forked T#%d\n", __kmp_get_gtid(),
4404 new_gtid));
4405 KMP_MB();
4406 return new_thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004407}
4408
Jonathan Peyton30419822017-05-12 18:01:32 +00004409/* Reinitialize team for reuse.
4410 The hot team code calls this case at every fork barrier, so EPCC barrier
4411 test are extremely sensitive to changes in it, esp. writes to the team
4412 struct, which cause a cache invalidation in all threads.
4413 IF YOU TOUCH THIS ROUTINE, RUN EPCC C SYNCBENCH ON A BIG-IRON MACHINE!!! */
4414static void __kmp_reinitialize_team(kmp_team_t *team,
4415 kmp_internal_control_t *new_icvs,
4416 ident_t *loc) {
4417 KF_TRACE(10, ("__kmp_reinitialize_team: enter this_thread=%p team=%p\n",
4418 team->t.t_threads[0], team));
4419 KMP_DEBUG_ASSERT(team && new_icvs);
4420 KMP_DEBUG_ASSERT((!TCR_4(__kmp_init_parallel)) || new_icvs->nproc);
4421 KMP_CHECK_UPDATE(team->t.t_ident, loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004422
Jonathan Peyton30419822017-05-12 18:01:32 +00004423 KMP_CHECK_UPDATE(team->t.t_id, KMP_GEN_TEAM_ID());
Jonathan Peyton30419822017-05-12 18:01:32 +00004424 // Copy ICVs to the master thread's implicit taskdata
4425 __kmp_init_implicit_task(loc, team->t.t_threads[0], team, 0, FALSE);
4426 copy_icvs(&team->t.t_implicit_task_taskdata[0].td_icvs, new_icvs);
Jim Cownie181b4bb2013-12-23 17:28:57 +00004427
Jonathan Peyton30419822017-05-12 18:01:32 +00004428 KF_TRACE(10, ("__kmp_reinitialize_team: exit this_thread=%p team=%p\n",
4429 team->t.t_threads[0], team));
Jim Cownie181b4bb2013-12-23 17:28:57 +00004430}
4431
Jonathan Peyton30419822017-05-12 18:01:32 +00004432/* Initialize the team data structure.
4433 This assumes the t_threads and t_max_nproc are already set.
4434 Also, we don't touch the arguments */
4435static void __kmp_initialize_team(kmp_team_t *team, int new_nproc,
4436 kmp_internal_control_t *new_icvs,
4437 ident_t *loc) {
4438 KF_TRACE(10, ("__kmp_initialize_team: enter: team=%p\n", team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004439
Jonathan Peyton30419822017-05-12 18:01:32 +00004440 /* verify */
4441 KMP_DEBUG_ASSERT(team);
4442 KMP_DEBUG_ASSERT(new_nproc <= team->t.t_max_nproc);
4443 KMP_DEBUG_ASSERT(team->t.t_threads);
4444 KMP_MB();
Jim Cownie181b4bb2013-12-23 17:28:57 +00004445
Jonathan Peyton30419822017-05-12 18:01:32 +00004446 team->t.t_master_tid = 0; /* not needed */
4447 /* team->t.t_master_bar; not needed */
4448 team->t.t_serialized = new_nproc > 1 ? 0 : 1;
4449 team->t.t_nproc = new_nproc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004450
Jonathan Peyton30419822017-05-12 18:01:32 +00004451 /* team->t.t_parent = NULL; TODO not needed & would mess up hot team */
4452 team->t.t_next_pool = NULL;
4453 /* memset( team->t.t_threads, 0, sizeof(kmp_info_t*)*new_nproc ); would mess
4454 * up hot team */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004455
Jonathan Peyton30419822017-05-12 18:01:32 +00004456 TCW_SYNC_PTR(team->t.t_pkfn, NULL); /* not needed */
4457 team->t.t_invoke = NULL; /* not needed */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004458
Jonathan Peyton30419822017-05-12 18:01:32 +00004459 // TODO???: team->t.t_max_active_levels = new_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00004460 team->t.t_sched.sched = new_icvs->sched.sched;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004461
4462#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Jonathan Peyton30419822017-05-12 18:01:32 +00004463 team->t.t_fp_control_saved = FALSE; /* not needed */
4464 team->t.t_x87_fpu_control_word = 0; /* not needed */
4465 team->t.t_mxcsr = 0; /* not needed */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004466#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
4467
Jonathan Peyton30419822017-05-12 18:01:32 +00004468 team->t.t_construct = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004469
Jonathan Peyton30419822017-05-12 18:01:32 +00004470 team->t.t_ordered.dt.t_value = 0;
4471 team->t.t_master_active = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004472
Jonathan Peyton30419822017-05-12 18:01:32 +00004473 memset(&team->t.t_taskq, '\0', sizeof(kmp_taskq_t));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004474
4475#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00004476 team->t.t_copypriv_data = NULL; /* not necessary, but nice for debugging */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004477#endif
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00004478#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00004479 team->t.t_copyin_counter = 0; /* for barrier-free copyin implementation */
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00004480#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00004481
Jonathan Peyton30419822017-05-12 18:01:32 +00004482 team->t.t_control_stack_top = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004483
Jonathan Peyton30419822017-05-12 18:01:32 +00004484 __kmp_reinitialize_team(team, new_icvs, loc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004485
Jonathan Peyton30419822017-05-12 18:01:32 +00004486 KMP_MB();
4487 KF_TRACE(10, ("__kmp_initialize_team: exit: team=%p\n", team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004488}
4489
Alp Toker98758b02014-03-02 04:12:06 +00004490#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00004491/* Sets full mask for thread and returns old mask, no changes to structures. */
4492static void
Jonathan Peyton30419822017-05-12 18:01:32 +00004493__kmp_set_thread_affinity_mask_full_tmp(kmp_affin_mask_t *old_mask) {
4494 if (KMP_AFFINITY_CAPABLE()) {
4495 int status;
4496 if (old_mask != NULL) {
4497 status = __kmp_get_system_affinity(old_mask, TRUE);
4498 int error = errno;
4499 if (status != 0) {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00004500 __kmp_fatal(KMP_MSG(ChangeThreadAffMaskError), KMP_ERR(error),
4501 __kmp_msg_null);
Jonathan Peyton30419822017-05-12 18:01:32 +00004502 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004503 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004504 __kmp_set_system_affinity(__kmp_affin_fullMask, TRUE);
4505 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004506}
4507#endif
4508
Alp Toker98758b02014-03-02 04:12:06 +00004509#if OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00004510
Jim Cownie5e8470a2013-09-27 10:38:44 +00004511// __kmp_partition_places() is the heart of the OpenMP 4.0 affinity mechanism.
4512// It calculats the worker + master thread's partition based upon the parent
Alp Toker8f2d3f02014-02-24 10:40:15 +00004513// thread's partition, and binds each worker to a thread in their partition.
Jim Cownie5e8470a2013-09-27 10:38:44 +00004514// The master thread's partition should already include its current binding.
Jonathan Peyton30419822017-05-12 18:01:32 +00004515static void __kmp_partition_places(kmp_team_t *team, int update_master_only) {
4516 // Copy the master thread's place partion to the team struct
4517 kmp_info_t *master_th = team->t.t_threads[0];
4518 KMP_DEBUG_ASSERT(master_th != NULL);
4519 kmp_proc_bind_t proc_bind = team->t.t_proc_bind;
4520 int first_place = master_th->th.th_first_place;
4521 int last_place = master_th->th.th_last_place;
4522 int masters_place = master_th->th.th_current_place;
4523 team->t.t_first_place = first_place;
4524 team->t.t_last_place = last_place;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004525
Jonathan Peyton30419822017-05-12 18:01:32 +00004526 KA_TRACE(20, ("__kmp_partition_places: enter: proc_bind = %d T#%d(%d:0) "
4527 "bound to place %d partition = [%d,%d]\n",
4528 proc_bind, __kmp_gtid_from_thread(team->t.t_threads[0]),
4529 team->t.t_id, masters_place, first_place, last_place));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004530
Jonathan Peyton30419822017-05-12 18:01:32 +00004531 switch (proc_bind) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00004532
Jonathan Peyton30419822017-05-12 18:01:32 +00004533 case proc_bind_default:
4534 // serial teams might have the proc_bind policy set to proc_bind_default. It
4535 // doesn't matter, as we don't rebind master thread for any proc_bind policy
4536 KMP_DEBUG_ASSERT(team->t.t_nproc == 1);
4537 break;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004538
Jonathan Peyton30419822017-05-12 18:01:32 +00004539 case proc_bind_master: {
4540 int f;
4541 int n_th = team->t.t_nproc;
4542 for (f = 1; f < n_th; f++) {
4543 kmp_info_t *th = team->t.t_threads[f];
4544 KMP_DEBUG_ASSERT(th != NULL);
4545 th->th.th_first_place = first_place;
4546 th->th.th_last_place = last_place;
4547 th->th.th_new_place = masters_place;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004548
Jonathan Peyton30419822017-05-12 18:01:32 +00004549 KA_TRACE(100, ("__kmp_partition_places: master: T#%d(%d:%d) place %d "
4550 "partition = [%d,%d]\n",
4551 __kmp_gtid_from_thread(team->t.t_threads[f]), team->t.t_id,
4552 f, masters_place, first_place, last_place));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004553 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004554 } break;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004555
Jonathan Peyton30419822017-05-12 18:01:32 +00004556 case proc_bind_close: {
4557 int f;
4558 int n_th = team->t.t_nproc;
4559 int n_places;
4560 if (first_place <= last_place) {
4561 n_places = last_place - first_place + 1;
4562 } else {
4563 n_places = __kmp_affinity_num_masks - first_place + last_place + 1;
4564 }
4565 if (n_th <= n_places) {
4566 int place = masters_place;
4567 for (f = 1; f < n_th; f++) {
4568 kmp_info_t *th = team->t.t_threads[f];
4569 KMP_DEBUG_ASSERT(th != NULL);
4570
4571 if (place == last_place) {
4572 place = first_place;
4573 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4574 place = 0;
4575 } else {
4576 place++;
4577 }
4578 th->th.th_first_place = first_place;
4579 th->th.th_last_place = last_place;
4580 th->th.th_new_place = place;
4581
4582 KA_TRACE(100, ("__kmp_partition_places: close: T#%d(%d:%d) place %d "
4583 "partition = [%d,%d]\n",
4584 __kmp_gtid_from_thread(team->t.t_threads[f]),
4585 team->t.t_id, f, place, first_place, last_place));
4586 }
4587 } else {
4588 int S, rem, gap, s_count;
4589 S = n_th / n_places;
4590 s_count = 0;
4591 rem = n_th - (S * n_places);
4592 gap = rem > 0 ? n_places / rem : n_places;
4593 int place = masters_place;
4594 int gap_ct = gap;
4595 for (f = 0; f < n_th; f++) {
4596 kmp_info_t *th = team->t.t_threads[f];
4597 KMP_DEBUG_ASSERT(th != NULL);
4598
4599 th->th.th_first_place = first_place;
4600 th->th.th_last_place = last_place;
4601 th->th.th_new_place = place;
4602 s_count++;
4603
4604 if ((s_count == S) && rem && (gap_ct == gap)) {
4605 // do nothing, add an extra thread to place on next iteration
4606 } else if ((s_count == S + 1) && rem && (gap_ct == gap)) {
4607 // we added an extra thread to this place; move to next place
4608 if (place == last_place) {
4609 place = first_place;
4610 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4611 place = 0;
4612 } else {
4613 place++;
4614 }
4615 s_count = 0;
4616 gap_ct = 1;
4617 rem--;
4618 } else if (s_count == S) { // place full; don't add extra
4619 if (place == last_place) {
4620 place = first_place;
4621 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4622 place = 0;
4623 } else {
4624 place++;
4625 }
4626 gap_ct++;
4627 s_count = 0;
4628 }
4629
4630 KA_TRACE(100,
4631 ("__kmp_partition_places: close: T#%d(%d:%d) place %d "
4632 "partition = [%d,%d]\n",
4633 __kmp_gtid_from_thread(team->t.t_threads[f]), team->t.t_id, f,
4634 th->th.th_new_place, first_place, last_place));
4635 }
4636 KMP_DEBUG_ASSERT(place == masters_place);
4637 }
4638 } break;
4639
4640 case proc_bind_spread: {
4641 int f;
4642 int n_th = team->t.t_nproc;
4643 int n_places;
4644 int thidx;
4645 if (first_place <= last_place) {
4646 n_places = last_place - first_place + 1;
4647 } else {
4648 n_places = __kmp_affinity_num_masks - first_place + last_place + 1;
4649 }
4650 if (n_th <= n_places) {
Paul Osmialowskia0162792017-08-10 23:04:11 +00004651 int place = -1;
Jonathan Peyton30419822017-05-12 18:01:32 +00004652
Paul Osmialowskia0162792017-08-10 23:04:11 +00004653 if (n_places != static_cast<int>(__kmp_affinity_num_masks)) {
4654 int S = n_places / n_th;
4655 int s_count, rem, gap, gap_ct;
4656
4657 place = masters_place;
4658 rem = n_places - n_th * S;
4659 gap = rem ? n_th / rem : 1;
4660 gap_ct = gap;
4661 thidx = n_th;
4662 if (update_master_only == 1)
4663 thidx = 1;
4664 for (f = 0; f < thidx; f++) {
4665 kmp_info_t *th = team->t.t_threads[f];
4666 KMP_DEBUG_ASSERT(th != NULL);
4667
4668 th->th.th_first_place = place;
4669 th->th.th_new_place = place;
4670 s_count = 1;
4671 while (s_count < S) {
4672 if (place == last_place) {
4673 place = first_place;
4674 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4675 place = 0;
4676 } else {
4677 place++;
4678 }
4679 s_count++;
4680 }
4681 if (rem && (gap_ct == gap)) {
4682 if (place == last_place) {
4683 place = first_place;
4684 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4685 place = 0;
4686 } else {
4687 place++;
4688 }
4689 rem--;
4690 gap_ct = 0;
4691 }
4692 th->th.th_last_place = place;
4693 gap_ct++;
4694
Jonathan Peyton30419822017-05-12 18:01:32 +00004695 if (place == last_place) {
4696 place = first_place;
4697 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4698 place = 0;
4699 } else {
4700 place++;
4701 }
Paul Osmialowskia0162792017-08-10 23:04:11 +00004702
Jonathan Peyton94a114f2017-10-20 19:30:57 +00004703 KA_TRACE(100,
4704 ("__kmp_partition_places: spread: T#%d(%d:%d) place %d "
4705 "partition = [%d,%d], __kmp_affinity_num_masks: %u\n",
4706 __kmp_gtid_from_thread(team->t.t_threads[f]), team->t.t_id,
4707 f, th->th.th_new_place, th->th.th_first_place,
4708 th->th.th_last_place, __kmp_affinity_num_masks));
Jonathan Peyton30419822017-05-12 18:01:32 +00004709 }
Paul Osmialowskia0162792017-08-10 23:04:11 +00004710 } else {
4711 /* Having uniform space of available computation places I can create
4712 T partitions of round(P/T) size and put threads into the first
4713 place of each partition. */
4714 double current = static_cast<double>(masters_place);
4715 double spacing =
Jonathan Peyton94a114f2017-10-20 19:30:57 +00004716 (static_cast<double>(n_places + 1) / static_cast<double>(n_th));
Paul Osmialowskia0162792017-08-10 23:04:11 +00004717 int first, last;
4718 kmp_info_t *th;
4719
4720 thidx = n_th + 1;
4721 if (update_master_only == 1)
4722 thidx = 1;
4723 for (f = 0; f < thidx; f++) {
4724 first = static_cast<int>(current);
4725 last = static_cast<int>(current + spacing) - 1;
4726 KMP_DEBUG_ASSERT(last >= first);
4727 if (first >= n_places) {
4728 if (masters_place) {
4729 first -= n_places;
4730 last -= n_places;
4731 if (first == (masters_place + 1)) {
4732 KMP_DEBUG_ASSERT(f == n_th);
4733 first--;
4734 }
4735 if (last == masters_place) {
4736 KMP_DEBUG_ASSERT(f == (n_th - 1));
4737 last--;
4738 }
4739 } else {
4740 KMP_DEBUG_ASSERT(f == n_th);
4741 first = 0;
4742 last = 0;
4743 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004744 }
Paul Osmialowskia0162792017-08-10 23:04:11 +00004745 if (last >= n_places) {
4746 last = (n_places - 1);
4747 }
4748 place = first;
4749 current += spacing;
4750 if (f < n_th) {
4751 KMP_DEBUG_ASSERT(0 <= first);
4752 KMP_DEBUG_ASSERT(n_places > first);
4753 KMP_DEBUG_ASSERT(0 <= last);
4754 KMP_DEBUG_ASSERT(n_places > last);
4755 KMP_DEBUG_ASSERT(last_place >= first_place);
4756 th = team->t.t_threads[f];
4757 KMP_DEBUG_ASSERT(th);
4758 th->th.th_first_place = first;
4759 th->th.th_new_place = place;
4760 th->th.th_last_place = last;
Jonathan Peyton30419822017-05-12 18:01:32 +00004761
Jonathan Peyton94a114f2017-10-20 19:30:57 +00004762 KA_TRACE(100,
4763 ("__kmp_partition_places: spread: T#%d(%d:%d) place %d "
4764 "partition = [%d,%d], spacing = %.4f\n",
4765 __kmp_gtid_from_thread(team->t.t_threads[f]),
4766 team->t.t_id, f, th->th.th_new_place,
4767 th->th.th_first_place, th->th.th_last_place, spacing));
Paul Osmialowskia0162792017-08-10 23:04:11 +00004768 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004769 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004770 }
4771 KMP_DEBUG_ASSERT(update_master_only || place == masters_place);
4772 } else {
4773 int S, rem, gap, s_count;
4774 S = n_th / n_places;
4775 s_count = 0;
4776 rem = n_th - (S * n_places);
4777 gap = rem > 0 ? n_places / rem : n_places;
4778 int place = masters_place;
4779 int gap_ct = gap;
4780 thidx = n_th;
4781 if (update_master_only == 1)
4782 thidx = 1;
4783 for (f = 0; f < thidx; f++) {
4784 kmp_info_t *th = team->t.t_threads[f];
4785 KMP_DEBUG_ASSERT(th != NULL);
4786
4787 th->th.th_first_place = place;
4788 th->th.th_last_place = place;
4789 th->th.th_new_place = place;
4790 s_count++;
4791
4792 if ((s_count == S) && rem && (gap_ct == gap)) {
4793 // do nothing, add an extra thread to place on next iteration
4794 } else if ((s_count == S + 1) && rem && (gap_ct == gap)) {
4795 // we added an extra thread to this place; move on to next place
4796 if (place == last_place) {
4797 place = first_place;
4798 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4799 place = 0;
4800 } else {
4801 place++;
4802 }
4803 s_count = 0;
4804 gap_ct = 1;
4805 rem--;
4806 } else if (s_count == S) { // place is full; don't add extra thread
4807 if (place == last_place) {
4808 place = first_place;
4809 } else if (place == (int)(__kmp_affinity_num_masks - 1)) {
4810 place = 0;
4811 } else {
4812 place++;
4813 }
4814 gap_ct++;
4815 s_count = 0;
4816 }
4817
4818 KA_TRACE(100, ("__kmp_partition_places: spread: T#%d(%d:%d) place %d "
4819 "partition = [%d,%d]\n",
4820 __kmp_gtid_from_thread(team->t.t_threads[f]),
4821 team->t.t_id, f, th->th.th_new_place,
4822 th->th.th_first_place, th->th.th_last_place));
4823 }
4824 KMP_DEBUG_ASSERT(update_master_only || place == masters_place);
4825 }
4826 } break;
4827
4828 default:
4829 break;
4830 }
4831
4832 KA_TRACE(20, ("__kmp_partition_places: exit T#%d\n", team->t.t_id));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004833}
4834
Alp Toker98758b02014-03-02 04:12:06 +00004835#endif /* OMP_40_ENABLED && KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004836
Jonathan Peyton30419822017-05-12 18:01:32 +00004837/* allocate a new team data structure to use. take one off of the free pool if
4838 available */
Jim Cownie5e8470a2013-09-27 10:38:44 +00004839kmp_team_t *
Jonathan Peyton30419822017-05-12 18:01:32 +00004840__kmp_allocate_team(kmp_root_t *root, int new_nproc, int max_nproc,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00004841#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00004842 ompt_data_t ompt_parallel_data,
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00004843#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00004844#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004845 kmp_proc_bind_t new_proc_bind,
Jim Cownie5e8470a2013-09-27 10:38:44 +00004846#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004847 kmp_internal_control_t *new_icvs,
4848 int argc USE_NESTED_HOT_ARG(kmp_info_t *master)) {
4849 KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(KMP_allocate_team);
4850 int f;
4851 kmp_team_t *team;
4852 int use_hot_team = !root->r.r_active;
4853 int level = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00004854
Jonathan Peyton30419822017-05-12 18:01:32 +00004855 KA_TRACE(20, ("__kmp_allocate_team: called\n"));
4856 KMP_DEBUG_ASSERT(new_nproc >= 1 && argc >= 0);
4857 KMP_DEBUG_ASSERT(max_nproc >= new_nproc);
4858 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00004859
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004860#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004861 kmp_hot_team_ptr_t *hot_teams;
4862 if (master) {
4863 team = master->th.th_team;
4864 level = team->t.t_active_level;
4865 if (master->th.th_teams_microtask) { // in teams construct?
4866 if (master->th.th_teams_size.nteams > 1 &&
4867 ( // #teams > 1
4868 team->t.t_pkfn ==
4869 (microtask_t)__kmp_teams_master || // inner fork of the teams
4870 master->th.th_teams_level <
4871 team->t.t_level)) { // or nested parallel inside the teams
4872 ++level; // not increment if #teams==1, or for outer fork of the teams;
4873 // increment otherwise
4874 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004875 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004876 hot_teams = master->th.th_hot_teams;
4877 if (level < __kmp_hot_teams_max_level && hot_teams &&
4878 hot_teams[level]
4879 .hot_team) { // hot team has already been allocated for given level
4880 use_hot_team = 1;
4881 } else {
4882 use_hot_team = 0;
4883 }
4884 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004885#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00004886 // Optimization to use a "hot" team
4887 if (use_hot_team && new_nproc > 1) {
4888 KMP_DEBUG_ASSERT(new_nproc == max_nproc);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004889#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004890 team = hot_teams[level].hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004891#else
Jonathan Peyton30419822017-05-12 18:01:32 +00004892 team = root->r.r_hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004893#endif
4894#if KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00004895 if (__kmp_tasking_mode != tskm_immediate_exec) {
4896 KA_TRACE(20, ("__kmp_allocate_team: hot team task_team[0] = %p "
4897 "task_team[1] = %p before reinit\n",
4898 team->t.t_task_team[0], team->t.t_task_team[1]));
4899 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00004900#endif
4901
Jonathan Peyton30419822017-05-12 18:01:32 +00004902 // Has the number of threads changed?
4903 /* Let's assume the most common case is that the number of threads is
4904 unchanged, and put that case first. */
4905 if (team->t.t_nproc == new_nproc) { // Check changes in number of threads
4906 KA_TRACE(20, ("__kmp_allocate_team: reusing hot team\n"));
4907 // This case can mean that omp_set_num_threads() was called and the hot
Jonathan Peyton642688b2017-06-01 16:46:36 +00004908 // team size was already reduced, so we check the special flag
Jonathan Peyton30419822017-05-12 18:01:32 +00004909 if (team->t.t_size_changed == -1) {
4910 team->t.t_size_changed = 1;
4911 } else {
4912 KMP_CHECK_UPDATE(team->t.t_size_changed, 0);
4913 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004914
Jonathan Peyton30419822017-05-12 18:01:32 +00004915 // TODO???: team->t.t_max_active_levels = new_max_active_levels;
4916 kmp_r_sched_t new_sched = new_icvs->sched;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00004917 // set master's schedule as new run-time schedule
4918 KMP_CHECK_UPDATE(team->t.t_sched.sched, new_sched.sched);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004919
Jonathan Peyton30419822017-05-12 18:01:32 +00004920 __kmp_reinitialize_team(team, new_icvs,
4921 root->r.r_uber_thread->th.th_ident);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004922
Jonathan Peyton30419822017-05-12 18:01:32 +00004923 KF_TRACE(10, ("__kmp_allocate_team2: T#%d, this_thread=%p team=%p\n", 0,
4924 team->t.t_threads[0], team));
4925 __kmp_push_current_task_to_thread(team->t.t_threads[0], team, 0);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004926
4927#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00004928#if KMP_AFFINITY_SUPPORTED
4929 if ((team->t.t_size_changed == 0) &&
4930 (team->t.t_proc_bind == new_proc_bind)) {
4931 if (new_proc_bind == proc_bind_spread) {
4932 __kmp_partition_places(
4933 team, 1); // add flag to update only master for spread
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004934 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004935 KA_TRACE(200, ("__kmp_allocate_team: reusing hot team #%d bindings: "
4936 "proc_bind = %d, partition = [%d,%d]\n",
4937 team->t.t_id, new_proc_bind, team->t.t_first_place,
4938 team->t.t_last_place));
4939 } else {
4940 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
4941 __kmp_partition_places(team);
4942 }
4943#else
4944 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
4945#endif /* KMP_AFFINITY_SUPPORTED */
4946#endif /* OMP_40_ENABLED */
4947 } else if (team->t.t_nproc > new_nproc) {
4948 KA_TRACE(20,
4949 ("__kmp_allocate_team: decreasing hot team thread count to %d\n",
4950 new_nproc));
Jim Cownie5e8470a2013-09-27 10:38:44 +00004951
Jonathan Peyton30419822017-05-12 18:01:32 +00004952 team->t.t_size_changed = 1;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004953#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004954 if (__kmp_hot_teams_mode == 0) {
4955 // AC: saved number of threads should correspond to team's value in this
4956 // mode, can be bigger in mode 1, when hot team has threads in reserve
4957 KMP_DEBUG_ASSERT(hot_teams[level].hot_team_nth == team->t.t_nproc);
4958 hot_teams[level].hot_team_nth = new_nproc;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004959#endif // KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004960 /* release the extra threads we don't need any more */
4961 for (f = new_nproc; f < team->t.t_nproc; f++) {
4962 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
4963 if (__kmp_tasking_mode != tskm_immediate_exec) {
4964 // When decreasing team size, threads no longer in the team should
4965 // unref task team.
4966 team->t.t_threads[f]->th.th_task_team = NULL;
4967 }
4968 __kmp_free_thread(team->t.t_threads[f]);
4969 team->t.t_threads[f] = NULL;
4970 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004971#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004972 } // (__kmp_hot_teams_mode == 0)
4973 else {
4974 // When keeping extra threads in team, switch threads to wait on own
4975 // b_go flag
4976 for (f = new_nproc; f < team->t.t_nproc; ++f) {
4977 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
4978 kmp_balign_t *balign = team->t.t_threads[f]->th.th_bar;
4979 for (int b = 0; b < bs_last_barrier; ++b) {
4980 if (balign[b].bb.wait_flag == KMP_BARRIER_PARENT_FLAG) {
4981 balign[b].bb.wait_flag = KMP_BARRIER_SWITCH_TO_OWN_FLAG;
Andrey Churbanovd6e1d7e2016-08-11 13:04:00 +00004982 }
Jonathan Peyton30419822017-05-12 18:01:32 +00004983 KMP_CHECK_UPDATE(balign[b].bb.leaf_kids, 0);
4984 }
4985 }
4986 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00004987#endif // KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00004988 team->t.t_nproc = new_nproc;
4989 // TODO???: team->t.t_max_active_levels = new_max_active_levels;
Jonathan Peytonba55a7b2017-11-29 22:47:52 +00004990 KMP_CHECK_UPDATE(team->t.t_sched.sched, new_icvs->sched.sched);
Jonathan Peyton30419822017-05-12 18:01:32 +00004991 __kmp_reinitialize_team(team, new_icvs,
4992 root->r.r_uber_thread->th.th_ident);
Jim Cownie5e8470a2013-09-27 10:38:44 +00004993
Jonathan Peyton30419822017-05-12 18:01:32 +00004994 /* update the remaining threads */
4995 for (f = 0; f < new_nproc; ++f) {
4996 team->t.t_threads[f]->th.th_team_nproc = new_nproc;
4997 }
4998 // restore the current task state of the master thread: should be the
4999 // implicit task
5000 KF_TRACE(10, ("__kmp_allocate_team: T#%d, this_thread=%p team=%p\n", 0,
5001 team->t.t_threads[0], team));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005002
Jonathan Peyton30419822017-05-12 18:01:32 +00005003 __kmp_push_current_task_to_thread(team->t.t_threads[0], team, 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005004
5005#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00005006 for (f = 0; f < team->t.t_nproc; f++) {
5007 KMP_DEBUG_ASSERT(team->t.t_threads[f] &&
5008 team->t.t_threads[f]->th.th_team_nproc ==
5009 team->t.t_nproc);
5010 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005011#endif
5012
5013#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00005014 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
5015#if KMP_AFFINITY_SUPPORTED
5016 __kmp_partition_places(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005017#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005018#endif
5019 } else { // team->t.t_nproc < new_nproc
Alp Toker98758b02014-03-02 04:12:06 +00005020#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00005021 kmp_affin_mask_t *old_mask;
5022 if (KMP_AFFINITY_CAPABLE()) {
5023 KMP_CPU_ALLOC(old_mask);
5024 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005025#endif
5026
Jonathan Peyton30419822017-05-12 18:01:32 +00005027 KA_TRACE(20,
5028 ("__kmp_allocate_team: increasing hot team thread count to %d\n",
5029 new_nproc));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005030
Jonathan Peyton30419822017-05-12 18:01:32 +00005031 team->t.t_size_changed = 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005032
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005033#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005034 int avail_threads = hot_teams[level].hot_team_nth;
5035 if (new_nproc < avail_threads)
5036 avail_threads = new_nproc;
5037 kmp_info_t **other_threads = team->t.t_threads;
5038 for (f = team->t.t_nproc; f < avail_threads; ++f) {
5039 // Adjust barrier data of reserved threads (if any) of the team
5040 // Other data will be set in __kmp_initialize_info() below.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005041 int b;
Jonathan Peyton30419822017-05-12 18:01:32 +00005042 kmp_balign_t *balign = other_threads[f]->th.th_bar;
5043 for (b = 0; b < bs_last_barrier; ++b) {
5044 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
5045 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag != KMP_BARRIER_PARENT_FLAG);
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00005046#if USE_DEBUGGER
Jonathan Peyton30419822017-05-12 18:01:32 +00005047 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
Jonathan Peyton8fbb49a2015-07-09 18:16:58 +00005048#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005049 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005050 }
5051 if (hot_teams[level].hot_team_nth >= new_nproc) {
5052 // we have all needed threads in reserve, no need to allocate any
5053 // this only possible in mode 1, cannot have reserved threads in mode 0
5054 KMP_DEBUG_ASSERT(__kmp_hot_teams_mode == 1);
5055 team->t.t_nproc = new_nproc; // just get reserved threads involved
5056 } else {
5057 // we may have some threads in reserve, but not enough
5058 team->t.t_nproc =
5059 hot_teams[level]
5060 .hot_team_nth; // get reserved threads involved if any
5061 hot_teams[level].hot_team_nth = new_nproc; // adjust hot team max size
5062#endif // KMP_NESTED_HOT_TEAMS
5063 if (team->t.t_max_nproc < new_nproc) {
5064 /* reallocate larger arrays */
5065 __kmp_reallocate_team_arrays(team, new_nproc);
5066 __kmp_reinitialize_team(team, new_icvs, NULL);
5067 }
5068
5069#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
5070 /* Temporarily set full mask for master thread before creation of
5071 workers. The reason is that workers inherit the affinity from master,
5072 so if a lot of workers are created on the single core quickly, they
5073 don't get a chance to set their own affinity for a long time. */
5074 __kmp_set_thread_affinity_mask_full_tmp(old_mask);
5075#endif
5076
5077 /* allocate new threads for the hot team */
5078 for (f = team->t.t_nproc; f < new_nproc; f++) {
5079 kmp_info_t *new_worker = __kmp_allocate_thread(root, team, f);
5080 KMP_DEBUG_ASSERT(new_worker);
5081 team->t.t_threads[f] = new_worker;
5082
5083 KA_TRACE(20,
5084 ("__kmp_allocate_team: team %d init T#%d arrived: "
5085 "join=%llu, plain=%llu\n",
5086 team->t.t_id, __kmp_gtid_from_tid(f, team), team->t.t_id, f,
5087 team->t.t_bar[bs_forkjoin_barrier].b_arrived,
5088 team->t.t_bar[bs_plain_barrier].b_arrived));
5089
5090 { // Initialize barrier data for new threads.
5091 int b;
5092 kmp_balign_t *balign = new_worker->th.th_bar;
5093 for (b = 0; b < bs_last_barrier; ++b) {
5094 balign[b].bb.b_arrived = team->t.t_bar[b].b_arrived;
5095 KMP_DEBUG_ASSERT(balign[b].bb.wait_flag !=
5096 KMP_BARRIER_PARENT_FLAG);
5097#if USE_DEBUGGER
5098 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
5099#endif
5100 }
5101 }
5102 }
5103
5104#if KMP_OS_LINUX && KMP_AFFINITY_SUPPORTED
5105 if (KMP_AFFINITY_CAPABLE()) {
5106 /* Restore initial master thread's affinity mask */
5107 __kmp_set_system_affinity(old_mask, TRUE);
5108 KMP_CPU_FREE(old_mask);
5109 }
5110#endif
5111#if KMP_NESTED_HOT_TEAMS
5112 } // end of check of t_nproc vs. new_nproc vs. hot_team_nth
5113#endif // KMP_NESTED_HOT_TEAMS
5114 /* make sure everyone is syncronized */
5115 int old_nproc = team->t.t_nproc; // save old value and use to update only
5116 // new threads below
5117 __kmp_initialize_team(team, new_nproc, new_icvs,
5118 root->r.r_uber_thread->th.th_ident);
5119
5120 /* reinitialize the threads */
5121 KMP_DEBUG_ASSERT(team->t.t_nproc == new_nproc);
5122 for (f = 0; f < team->t.t_nproc; ++f)
5123 __kmp_initialize_info(team->t.t_threads[f], team, f,
5124 __kmp_gtid_from_tid(f, team));
5125 if (level) { // set th_task_state for new threads in nested hot team
5126 // __kmp_initialize_info() no longer zeroes th_task_state, so we should
5127 // only need to set the th_task_state for the new threads. th_task_state
5128 // for master thread will not be accurate until after this in
5129 // __kmp_fork_call(), so we look to the master's memo_stack to get the
5130 // correct value.
5131 for (f = old_nproc; f < team->t.t_nproc; ++f)
5132 team->t.t_threads[f]->th.th_task_state =
5133 team->t.t_threads[0]->th.th_task_state_memo_stack[level];
5134 } else { // set th_task_state for new threads in non-nested hot team
5135 int old_state =
5136 team->t.t_threads[0]->th.th_task_state; // copy master's state
5137 for (f = old_nproc; f < team->t.t_nproc; ++f)
5138 team->t.t_threads[f]->th.th_task_state = old_state;
5139 }
5140
5141#ifdef KMP_DEBUG
5142 for (f = 0; f < team->t.t_nproc; ++f) {
5143 KMP_DEBUG_ASSERT(team->t.t_threads[f] &&
5144 team->t.t_threads[f]->th.th_team_nproc ==
5145 team->t.t_nproc);
5146 }
5147#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005148
5149#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00005150 KMP_CHECK_UPDATE(team->t.t_proc_bind, new_proc_bind);
5151#if KMP_AFFINITY_SUPPORTED
5152 __kmp_partition_places(team);
5153#endif
5154#endif
5155 } // Check changes in number of threads
5156
5157#if OMP_40_ENABLED
5158 kmp_info_t *master = team->t.t_threads[0];
5159 if (master->th.th_teams_microtask) {
5160 for (f = 1; f < new_nproc; ++f) {
5161 // propagate teams construct specific info to workers
5162 kmp_info_t *thr = team->t.t_threads[f];
5163 thr->th.th_teams_microtask = master->th.th_teams_microtask;
5164 thr->th.th_teams_level = master->th.th_teams_level;
5165 thr->th.th_teams_size = master->th.th_teams_size;
5166 }
5167 }
5168#endif /* OMP_40_ENABLED */
5169#if KMP_NESTED_HOT_TEAMS
5170 if (level) {
5171 // Sync barrier state for nested hot teams, not needed for outermost hot
5172 // team.
5173 for (f = 1; f < new_nproc; ++f) {
5174 kmp_info_t *thr = team->t.t_threads[f];
5175 int b;
5176 kmp_balign_t *balign = thr->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 != KMP_BARRIER_PARENT_FLAG);
5180#if USE_DEBUGGER
5181 balign[b].bb.b_worker_arrived = team->t.t_bar[b].b_team_arrived;
5182#endif
5183 }
5184 }
5185 }
5186#endif // KMP_NESTED_HOT_TEAMS
5187
5188 /* reallocate space for arguments if necessary */
5189 __kmp_alloc_argv_entries(argc, team, TRUE);
5190 KMP_CHECK_UPDATE(team->t.t_argc, argc);
5191 // The hot team re-uses the previous task team,
5192 // if untouched during the previous release->gather phase.
5193
5194 KF_TRACE(10, (" hot_team = %p\n", team));
5195
5196#if KMP_DEBUG
5197 if (__kmp_tasking_mode != tskm_immediate_exec) {
5198 KA_TRACE(20, ("__kmp_allocate_team: hot team task_team[0] = %p "
5199 "task_team[1] = %p after reinit\n",
5200 team->t.t_task_team[0], team->t.t_task_team[1]));
5201 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005202#endif
5203
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005204#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005205 __ompt_team_assign_id(team, ompt_parallel_data);
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005206#endif
5207
Jim Cownie5e8470a2013-09-27 10:38:44 +00005208 KMP_MB();
5209
Jim Cownie5e8470a2013-09-27 10:38:44 +00005210 return team;
Jonathan Peyton30419822017-05-12 18:01:32 +00005211 }
5212
5213 /* next, let's try to take one from the team pool */
5214 KMP_MB();
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005215 for (team = CCAST(kmp_team_t *, __kmp_team_pool); (team);) {
Jonathan Peyton30419822017-05-12 18:01:32 +00005216 /* TODO: consider resizing undersized teams instead of reaping them, now
5217 that we have a resizing mechanism */
5218 if (team->t.t_max_nproc >= max_nproc) {
5219 /* take this team from the team pool */
5220 __kmp_team_pool = team->t.t_next_pool;
5221
5222 /* setup the team for fresh use */
5223 __kmp_initialize_team(team, new_nproc, new_icvs, NULL);
5224
5225 KA_TRACE(20, ("__kmp_allocate_team: setting task_team[0] %p and "
5226 "task_team[1] %p to NULL\n",
5227 &team->t.t_task_team[0], &team->t.t_task_team[1]));
5228 team->t.t_task_team[0] = NULL;
5229 team->t.t_task_team[1] = NULL;
5230
5231 /* reallocate space for arguments if necessary */
5232 __kmp_alloc_argv_entries(argc, team, TRUE);
5233 KMP_CHECK_UPDATE(team->t.t_argc, argc);
5234
5235 KA_TRACE(
5236 20, ("__kmp_allocate_team: team %d init arrived: join=%u, plain=%u\n",
5237 team->t.t_id, KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
5238 { // Initialize barrier data.
5239 int b;
5240 for (b = 0; b < bs_last_barrier; ++b) {
5241 team->t.t_bar[b].b_arrived = KMP_INIT_BARRIER_STATE;
5242#if USE_DEBUGGER
5243 team->t.t_bar[b].b_master_arrived = 0;
5244 team->t.t_bar[b].b_team_arrived = 0;
5245#endif
5246 }
5247 }
5248
5249#if OMP_40_ENABLED
5250 team->t.t_proc_bind = new_proc_bind;
5251#endif
5252
5253 KA_TRACE(20, ("__kmp_allocate_team: using team from pool %d.\n",
5254 team->t.t_id));
5255
5256#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005257 __ompt_team_assign_id(team, ompt_parallel_data);
Jonathan Peyton30419822017-05-12 18:01:32 +00005258#endif
5259
5260 KMP_MB();
5261
5262 return team;
5263 }
5264
Jonathan Peyton94a114f2017-10-20 19:30:57 +00005265 /* reap team if it is too small, then loop back and check the next one */
5266 // not sure if this is wise, but, will be redone during the hot-teams
5267 // rewrite.
5268 /* TODO: Use technique to find the right size hot-team, don't reap them */
Jonathan Peyton30419822017-05-12 18:01:32 +00005269 team = __kmp_reap_team(team);
5270 __kmp_team_pool = team;
5271 }
5272
5273 /* nothing available in the pool, no matter, make a new team! */
5274 KMP_MB();
5275 team = (kmp_team_t *)__kmp_allocate(sizeof(kmp_team_t));
5276
5277 /* and set it up */
5278 team->t.t_max_nproc = max_nproc;
5279 /* NOTE well, for some reason allocating one big buffer and dividing it up
5280 seems to really hurt performance a lot on the P4, so, let's not use this */
5281 __kmp_allocate_team_arrays(team, max_nproc);
5282
5283 KA_TRACE(20, ("__kmp_allocate_team: making a new team\n"));
5284 __kmp_initialize_team(team, new_nproc, new_icvs, NULL);
5285
5286 KA_TRACE(20, ("__kmp_allocate_team: setting task_team[0] %p and task_team[1] "
5287 "%p to NULL\n",
5288 &team->t.t_task_team[0], &team->t.t_task_team[1]));
5289 team->t.t_task_team[0] = NULL; // to be removed, as __kmp_allocate zeroes
5290 // memory, no need to duplicate
5291 team->t.t_task_team[1] = NULL; // to be removed, as __kmp_allocate zeroes
5292 // memory, no need to duplicate
5293
5294 if (__kmp_storage_map) {
5295 __kmp_print_team_storage_map("team", team, team->t.t_id, new_nproc);
5296 }
5297
5298 /* allocate space for arguments */
5299 __kmp_alloc_argv_entries(argc, team, FALSE);
5300 team->t.t_argc = argc;
5301
5302 KA_TRACE(20,
5303 ("__kmp_allocate_team: team %d init arrived: join=%u, plain=%u\n",
5304 team->t.t_id, KMP_INIT_BARRIER_STATE, KMP_INIT_BARRIER_STATE));
5305 { // Initialize barrier data.
5306 int b;
5307 for (b = 0; b < bs_last_barrier; ++b) {
5308 team->t.t_bar[b].b_arrived = KMP_INIT_BARRIER_STATE;
5309#if USE_DEBUGGER
5310 team->t.t_bar[b].b_master_arrived = 0;
5311 team->t.t_bar[b].b_team_arrived = 0;
5312#endif
5313 }
5314 }
5315
5316#if OMP_40_ENABLED
5317 team->t.t_proc_bind = new_proc_bind;
5318#endif
5319
5320#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005321 __ompt_team_assign_id(team, ompt_parallel_data);
Jonathan Peyton30419822017-05-12 18:01:32 +00005322 team->t.ompt_serialized_team_info = NULL;
5323#endif
5324
5325 KMP_MB();
5326
5327 KA_TRACE(20, ("__kmp_allocate_team: done creating a new team %d.\n",
5328 team->t.t_id));
5329
5330 return team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005331}
5332
5333/* TODO implement hot-teams at all levels */
5334/* TODO implement lazy thread release on demand (disband request) */
5335
5336/* free the team. return it to the team pool. release all the threads
5337 * associated with it */
Jonathan Peyton30419822017-05-12 18:01:32 +00005338void __kmp_free_team(kmp_root_t *root,
5339 kmp_team_t *team USE_NESTED_HOT_ARG(kmp_info_t *master)) {
5340 int f;
5341 KA_TRACE(20, ("__kmp_free_team: T#%d freeing team %d\n", __kmp_get_gtid(),
5342 team->t.t_id));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005343
Jonathan Peyton30419822017-05-12 18:01:32 +00005344 /* verify state */
5345 KMP_DEBUG_ASSERT(root);
5346 KMP_DEBUG_ASSERT(team);
5347 KMP_DEBUG_ASSERT(team->t.t_nproc <= team->t.t_max_nproc);
5348 KMP_DEBUG_ASSERT(team->t.t_threads);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005349
Jonathan Peyton30419822017-05-12 18:01:32 +00005350 int use_hot_team = team == root->r.r_hot_team;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005351#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005352 int level;
5353 kmp_hot_team_ptr_t *hot_teams;
5354 if (master) {
5355 level = team->t.t_active_level - 1;
5356 if (master->th.th_teams_microtask) { // in teams construct?
5357 if (master->th.th_teams_size.nteams > 1) {
5358 ++level; // level was not increased in teams construct for
5359 // team_of_masters
5360 }
5361 if (team->t.t_pkfn != (microtask_t)__kmp_teams_master &&
5362 master->th.th_teams_level == team->t.t_level) {
5363 ++level; // level was not increased in teams construct for
5364 // team_of_workers before the parallel
5365 } // team->t.t_level will be increased inside parallel
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005366 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005367 hot_teams = master->th.th_hot_teams;
5368 if (level < __kmp_hot_teams_max_level) {
5369 KMP_DEBUG_ASSERT(team == hot_teams[level].hot_team);
5370 use_hot_team = 1;
5371 }
5372 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005373#endif // KMP_NESTED_HOT_TEAMS
5374
Jonathan Peyton30419822017-05-12 18:01:32 +00005375 /* team is done working */
5376 TCW_SYNC_PTR(team->t.t_pkfn,
5377 NULL); // Important for Debugging Support Library.
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00005378#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00005379 team->t.t_copyin_counter = 0; // init counter for possible reuse
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00005380#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005381 // Do not reset pointer to parent team to NULL for hot teams.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005382
Jonathan Peyton30419822017-05-12 18:01:32 +00005383 /* if we are non-hot team, release our threads */
5384 if (!use_hot_team) {
5385 if (__kmp_tasking_mode != tskm_immediate_exec) {
5386 // Wait for threads to reach reapable state
5387 for (f = 1; f < team->t.t_nproc; ++f) {
5388 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
5389 kmp_info_t *th = team->t.t_threads[f];
5390 volatile kmp_uint32 *state = &th->th.th_reap_state;
5391 while (*state != KMP_SAFE_TO_REAP) {
Andrey Churbanov581490e2017-02-06 18:53:32 +00005392#if KMP_OS_WINDOWS
Jonathan Peyton30419822017-05-12 18:01:32 +00005393 // On Windows a thread can be killed at any time, check this
5394 DWORD ecode;
5395 if (!__kmp_is_thread_alive(th, &ecode)) {
5396 *state = KMP_SAFE_TO_REAP; // reset the flag for dead thread
5397 break;
5398 }
Andrey Churbanov581490e2017-02-06 18:53:32 +00005399#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005400 // first check if thread is sleeping
5401 kmp_flag_64 fl(&th->th.th_bar[bs_forkjoin_barrier].bb.b_go, th);
5402 if (fl.is_sleeping())
5403 fl.resume(__kmp_gtid_from_thread(th));
5404 KMP_CPU_PAUSE();
5405 }
5406 }
Andrey Churbanov581490e2017-02-06 18:53:32 +00005407
Jonathan Peyton30419822017-05-12 18:01:32 +00005408 // Delete task teams
5409 int tt_idx;
5410 for (tt_idx = 0; tt_idx < 2; ++tt_idx) {
5411 kmp_task_team_t *task_team = team->t.t_task_team[tt_idx];
5412 if (task_team != NULL) {
5413 for (f = 0; f < team->t.t_nproc;
5414 ++f) { // Have all threads unref task teams
5415 team->t.t_threads[f]->th.th_task_team = NULL;
5416 }
5417 KA_TRACE(
5418 20,
5419 ("__kmp_free_team: T#%d deactivating task_team %p on team %d\n",
5420 __kmp_get_gtid(), task_team, team->t.t_id));
Jonathan Peytonbaaccfa2015-11-16 22:48:41 +00005421#if KMP_NESTED_HOT_TEAMS
Jonathan Peyton30419822017-05-12 18:01:32 +00005422 __kmp_free_task_team(master, task_team);
Jonathan Peytonbaaccfa2015-11-16 22:48:41 +00005423#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005424 team->t.t_task_team[tt_idx] = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005425 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005426 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005427 }
5428
Jonathan Peyton30419822017-05-12 18:01:32 +00005429 // Reset pointer to parent team only for non-hot teams.
5430 team->t.t_parent = NULL;
5431 team->t.t_level = 0;
5432 team->t.t_active_level = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005433
Jonathan Peyton30419822017-05-12 18:01:32 +00005434 /* free the worker threads */
5435 for (f = 1; f < team->t.t_nproc; ++f) {
5436 KMP_DEBUG_ASSERT(team->t.t_threads[f]);
5437 __kmp_free_thread(team->t.t_threads[f]);
5438 team->t.t_threads[f] = NULL;
5439 }
5440
5441 /* put the team back in the team pool */
5442 /* TODO limit size of team pool, call reap_team if pool too large */
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005443 team->t.t_next_pool = CCAST(kmp_team_t *, __kmp_team_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00005444 __kmp_team_pool = (volatile kmp_team_t *)team;
5445 }
5446
5447 KMP_MB();
5448}
Jim Cownie5e8470a2013-09-27 10:38:44 +00005449
5450/* reap the team. destroy it, reclaim all its resources and free its memory */
Jonathan Peyton30419822017-05-12 18:01:32 +00005451kmp_team_t *__kmp_reap_team(kmp_team_t *team) {
5452 kmp_team_t *next_pool = team->t.t_next_pool;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005453
Jonathan Peyton30419822017-05-12 18:01:32 +00005454 KMP_DEBUG_ASSERT(team);
5455 KMP_DEBUG_ASSERT(team->t.t_dispatch);
5456 KMP_DEBUG_ASSERT(team->t.t_disp_buffer);
5457 KMP_DEBUG_ASSERT(team->t.t_threads);
5458 KMP_DEBUG_ASSERT(team->t.t_argv);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005459
Jonathan Peyton30419822017-05-12 18:01:32 +00005460 /* TODO clean the threads that are a part of this? */
Jim Cownie5e8470a2013-09-27 10:38:44 +00005461
Jonathan Peyton30419822017-05-12 18:01:32 +00005462 /* free stuff */
5463 __kmp_free_team_arrays(team);
5464 if (team->t.t_argv != &team->t.t_inline_argv[0])
5465 __kmp_free((void *)team->t.t_argv);
5466 __kmp_free(team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005467
Jonathan Peyton30419822017-05-12 18:01:32 +00005468 KMP_MB();
5469 return next_pool;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005470}
5471
Jim Cownie5e8470a2013-09-27 10:38:44 +00005472// Free the thread. Don't reap it, just place it on the pool of available
5473// threads.
5474//
5475// Changes for Quad issue 527845: We need a predictable OMP tid <-> gtid
5476// binding for the affinity mechanism to be useful.
5477//
5478// Now, we always keep the free list (__kmp_thread_pool) sorted by gtid.
5479// However, we want to avoid a potential performance problem by always
5480// scanning through the list to find the correct point at which to insert
5481// the thread (potential N**2 behavior). To do this we keep track of the
5482// last place a thread struct was inserted (__kmp_thread_pool_insert_pt).
5483// With single-level parallelism, threads will always be added to the tail
5484// of the list, kept track of by __kmp_thread_pool_insert_pt. With nested
5485// parallelism, all bets are off and we may need to scan through the entire
5486// free list.
5487//
5488// This change also has a potentially large performance benefit, for some
5489// applications. Previously, as threads were freed from the hot team, they
5490// would be placed back on the free list in inverse order. If the hot team
5491// grew back to it's original size, then the freed thread would be placed
5492// back on the hot team in reverse order. This could cause bad cache
5493// locality problems on programs where the size of the hot team regularly
5494// grew and shrunk.
5495//
5496// Now, for single-level parallelism, the OMP tid is alway == gtid.
Jonathan Peyton30419822017-05-12 18:01:32 +00005497void __kmp_free_thread(kmp_info_t *this_th) {
5498 int gtid;
5499 kmp_info_t **scan;
Jonathan Peytonf4392462017-07-27 20:58:41 +00005500 kmp_root_t *root = this_th->th.th_root;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005501
Jonathan Peyton30419822017-05-12 18:01:32 +00005502 KA_TRACE(20, ("__kmp_free_thread: T#%d putting T#%d back on free pool.\n",
5503 __kmp_get_gtid(), this_th->th.th_info.ds.ds_gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005504
Jonathan Peyton30419822017-05-12 18:01:32 +00005505 KMP_DEBUG_ASSERT(this_th);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005506
Jonathan Peyton30419822017-05-12 18:01:32 +00005507 // When moving thread to pool, switch thread to wait on own b_go flag, and
5508 // uninitialized (NULL team).
5509 int b;
5510 kmp_balign_t *balign = this_th->th.th_bar;
5511 for (b = 0; b < bs_last_barrier; ++b) {
5512 if (balign[b].bb.wait_flag == KMP_BARRIER_PARENT_FLAG)
5513 balign[b].bb.wait_flag = KMP_BARRIER_SWITCH_TO_OWN_FLAG;
5514 balign[b].bb.team = NULL;
5515 balign[b].bb.leaf_kids = 0;
5516 }
5517 this_th->th.th_task_state = 0;
Andrey Churbanov3336aa02018-03-19 18:05:15 +00005518 this_th->th.th_reap_state = KMP_SAFE_TO_REAP;
Jonathan Peyton30419822017-05-12 18:01:32 +00005519
5520 /* put thread back on the free pool */
5521 TCW_PTR(this_th->th.th_team, NULL);
5522 TCW_PTR(this_th->th.th_root, NULL);
5523 TCW_PTR(this_th->th.th_dispatch, NULL); /* NOT NEEDED */
5524
Jonathan Peytonbff8ded2018-01-10 18:24:09 +00005525 /* If the implicit task assigned to this thread can be used by other threads
5526 * -> multiple threads can share the data and try to free the task at
5527 * __kmp_reap_thread at exit. This duplicate use of the task data can happen
5528 * with higher probability when hot team is disabled but can occurs even when
5529 * the hot team is enabled */
5530 __kmp_free_implicit_task(this_th);
5531 this_th->th.th_current_task = NULL;
5532
Jonathan Peyton30419822017-05-12 18:01:32 +00005533 // If the __kmp_thread_pool_insert_pt is already past the new insert
5534 // point, then we need to re-scan the entire list.
5535 gtid = this_th->th.th_info.ds.ds_gtid;
5536 if (__kmp_thread_pool_insert_pt != NULL) {
5537 KMP_DEBUG_ASSERT(__kmp_thread_pool != NULL);
5538 if (__kmp_thread_pool_insert_pt->th.th_info.ds.ds_gtid > gtid) {
5539 __kmp_thread_pool_insert_pt = NULL;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005540 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005541 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +00005542
Jonathan Peyton30419822017-05-12 18:01:32 +00005543 // Scan down the list to find the place to insert the thread.
5544 // scan is the address of a link in the list, possibly the address of
5545 // __kmp_thread_pool itself.
5546 //
5547 // In the absence of nested parallism, the for loop will have 0 iterations.
5548 if (__kmp_thread_pool_insert_pt != NULL) {
5549 scan = &(__kmp_thread_pool_insert_pt->th.th_next_pool);
5550 } else {
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005551 scan = CCAST(kmp_info_t **, &__kmp_thread_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00005552 }
5553 for (; (*scan != NULL) && ((*scan)->th.th_info.ds.ds_gtid < gtid);
5554 scan = &((*scan)->th.th_next_pool))
5555 ;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005556
Jonathan Peyton30419822017-05-12 18:01:32 +00005557 // Insert the new element on the list, and set __kmp_thread_pool_insert_pt
5558 // to its address.
5559 TCW_PTR(this_th->th.th_next_pool, *scan);
5560 __kmp_thread_pool_insert_pt = *scan = this_th;
5561 KMP_DEBUG_ASSERT((this_th->th.th_next_pool == NULL) ||
5562 (this_th->th.th_info.ds.ds_gtid <
5563 this_th->th.th_next_pool->th.th_info.ds.ds_gtid));
5564 TCW_4(this_th->th.th_in_pool, TRUE);
5565 __kmp_thread_pool_nth++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005566
Jonathan Peyton30419822017-05-12 18:01:32 +00005567 TCW_4(__kmp_nth, __kmp_nth - 1);
Jonathan Peytonf4392462017-07-27 20:58:41 +00005568 root->r.r_cg_nthreads--;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005569
5570#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00005571 /* Adjust blocktime back to user setting or default if necessary */
5572 /* Middle initialization might never have occurred */
5573 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
5574 KMP_DEBUG_ASSERT(__kmp_avail_proc > 0);
5575 if (__kmp_nth <= __kmp_avail_proc) {
5576 __kmp_zero_bt = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005577 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005578 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005579#endif /* KMP_ADJUST_BLOCKTIME */
5580
Jonathan Peyton30419822017-05-12 18:01:32 +00005581 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00005582}
5583
Jim Cownie5e8470a2013-09-27 10:38:44 +00005584/* ------------------------------------------------------------------------ */
5585
Jonathan Peyton30419822017-05-12 18:01:32 +00005586void *__kmp_launch_thread(kmp_info_t *this_thr) {
5587 int gtid = this_thr->th.th_info.ds.ds_gtid;
5588 /* void *stack_data;*/
5589 kmp_team_t *(*volatile pteam);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005590
Jonathan Peyton30419822017-05-12 18:01:32 +00005591 KMP_MB();
5592 KA_TRACE(10, ("__kmp_launch_thread: T#%d start\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005593
Jonathan Peyton30419822017-05-12 18:01:32 +00005594 if (__kmp_env_consistency_check) {
5595 this_thr->th.th_cons = __kmp_allocate_cons_stack(gtid); // ATT: Memory leak?
5596 }
5597
5598#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005599 ompt_data_t *thread_data;
5600 if (ompt_enabled.enabled) {
5601 thread_data = &(this_thr->th.ompt_thread_info.thread_data);
Jonathan Peyton3574f282018-10-04 14:57:04 +00005602 *thread_data = ompt_data_none;
Joachim Protze82e94a52017-11-01 10:08:30 +00005603
5604 this_thr->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00005605 this_thr->th.ompt_thread_info.wait_id = 0;
Joachim Protze82e94a52017-11-01 10:08:30 +00005606 this_thr->th.ompt_thread_info.idle_frame = OMPT_GET_FRAME_ADDRESS(0);
5607 if (ompt_enabled.ompt_callback_thread_begin) {
5608 ompt_callbacks.ompt_callback(ompt_callback_thread_begin)(
5609 ompt_thread_worker, thread_data);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005610 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005611 }
5612#endif
5613
Joachim Protze82e94a52017-11-01 10:08:30 +00005614#if OMPT_SUPPORT
5615 if (ompt_enabled.enabled) {
5616 this_thr->th.ompt_thread_info.state = omp_state_idle;
5617 }
5618#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00005619 /* This is the place where threads wait for work */
5620 while (!TCR_4(__kmp_global.g.g_done)) {
5621 KMP_DEBUG_ASSERT(this_thr == __kmp_threads[gtid]);
5622 KMP_MB();
5623
5624 /* wait for work to do */
5625 KA_TRACE(20, ("__kmp_launch_thread: T#%d waiting for work\n", gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00005626
Jonathan Peyton30419822017-05-12 18:01:32 +00005627 /* No tid yet since not part of a team */
5628 __kmp_fork_barrier(gtid, KMP_GTID_DNE);
5629
5630#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005631 if (ompt_enabled.enabled) {
5632 this_thr->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00005633 }
5634#endif
5635
5636 pteam = (kmp_team_t * (*))(&this_thr->th.th_team);
5637
5638 /* have we been allocated? */
5639 if (TCR_SYNC_PTR(*pteam) && !TCR_4(__kmp_global.g.g_done)) {
Jonathan Peyton30419822017-05-12 18:01:32 +00005640 /* we were just woken up, so run our new task */
5641 if (TCR_SYNC_PTR((*pteam)->t.t_pkfn) != NULL) {
5642 int rc;
5643 KA_TRACE(20,
5644 ("__kmp_launch_thread: T#%d(%d:%d) invoke microtask = %p\n",
5645 gtid, (*pteam)->t.t_id, __kmp_tid_from_gtid(gtid),
5646 (*pteam)->t.t_pkfn));
5647
5648 updateHWFPControl(*pteam);
5649
5650#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005651 if (ompt_enabled.enabled) {
5652 this_thr->th.ompt_thread_info.state = omp_state_work_parallel;
Jonathan Peyton30419822017-05-12 18:01:32 +00005653 }
5654#endif
5655
Jonathan Peytonf0682ac2018-07-30 17:41:08 +00005656 rc = (*pteam)->t.t_invoke(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00005657 KMP_ASSERT(rc);
5658
Jim Cownie5e8470a2013-09-27 10:38:44 +00005659 KMP_MB();
Jonathan Peyton30419822017-05-12 18:01:32 +00005660 KA_TRACE(20, ("__kmp_launch_thread: T#%d(%d:%d) done microtask = %p\n",
5661 gtid, (*pteam)->t.t_id, __kmp_tid_from_gtid(gtid),
5662 (*pteam)->t.t_pkfn));
5663 }
Joachim Protze82e94a52017-11-01 10:08:30 +00005664#if OMPT_SUPPORT
5665 if (ompt_enabled.enabled) {
5666 /* no frame set while outside task */
Joachim Protzec255ca72017-11-05 14:11:10 +00005667 __ompt_get_task_info_object(0)->frame.exit_frame = NULL;
Joachim Protze82e94a52017-11-01 10:08:30 +00005668
5669 this_thr->th.ompt_thread_info.state = omp_state_overhead;
Jonathan Peyton30419822017-05-12 18:01:32 +00005670 }
5671#endif
Joachim Protze82e94a52017-11-01 10:08:30 +00005672 /* join barrier after parallel region */
5673 __kmp_join_barrier(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005674 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005675 }
5676 TCR_SYNC_PTR((intptr_t)__kmp_global.g.g_done);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005677
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005678#if OMPT_SUPPORT
Joachim Protze82e94a52017-11-01 10:08:30 +00005679 if (ompt_enabled.ompt_callback_thread_end) {
5680 ompt_callbacks.ompt_callback(ompt_callback_thread_end)(thread_data);
Jonathan Peyton30419822017-05-12 18:01:32 +00005681 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00005682#endif
5683
Jonathan Peyton30419822017-05-12 18:01:32 +00005684 this_thr->th.th_task_team = NULL;
5685 /* run the destructors for the threadprivate data for this thread */
5686 __kmp_common_destroy_gtid(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005687
Jonathan Peyton30419822017-05-12 18:01:32 +00005688 KA_TRACE(10, ("__kmp_launch_thread: T#%d done\n", gtid));
5689 KMP_MB();
5690 return this_thr;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005691}
5692
5693/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00005694
Jonathan Peyton30419822017-05-12 18:01:32 +00005695void __kmp_internal_end_dest(void *specific_gtid) {
5696#if KMP_COMPILER_ICC
5697#pragma warning(push)
5698#pragma warning(disable : 810) // conversion from "void *" to "int" may lose
5699// significant bits
5700#endif
5701 // Make sure no significant bits are lost
5702 int gtid = (kmp_intptr_t)specific_gtid - 1;
5703#if KMP_COMPILER_ICC
5704#pragma warning(pop)
5705#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005706
Jonathan Peyton30419822017-05-12 18:01:32 +00005707 KA_TRACE(30, ("__kmp_internal_end_dest: T#%d\n", gtid));
5708 /* NOTE: the gtid is stored as gitd+1 in the thread-local-storage
5709 * this is because 0 is reserved for the nothing-stored case */
Jim Cownie5e8470a2013-09-27 10:38:44 +00005710
Jonathan Peyton30419822017-05-12 18:01:32 +00005711 /* josh: One reason for setting the gtid specific data even when it is being
5712 destroyed by pthread is to allow gtid lookup through thread specific data
5713 (__kmp_gtid_get_specific). Some of the code, especially stat code,
5714 that gets executed in the call to __kmp_internal_end_thread, actually
5715 gets the gtid through the thread specific data. Setting it here seems
5716 rather inelegant and perhaps wrong, but allows __kmp_internal_end_thread
5717 to run smoothly.
5718 todo: get rid of this after we remove the dependence on
5719 __kmp_gtid_get_specific */
5720 if (gtid >= 0 && KMP_UBER_GTID(gtid))
5721 __kmp_gtid_set_specific(gtid);
5722#ifdef KMP_TDATA_GTID
5723 __kmp_gtid = gtid;
5724#endif
5725 __kmp_internal_end_thread(gtid);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005726}
5727
Jonathan Peyton99016992015-05-26 17:32:53 +00005728#if KMP_OS_UNIX && KMP_DYNAMIC_LIB
Jim Cownie5e8470a2013-09-27 10:38:44 +00005729
Jonathan Peyton30419822017-05-12 18:01:32 +00005730// 2009-09-08 (lev): It looks the destructor does not work. In simple test cases
5731// destructors work perfectly, but in real libomp.so I have no evidence it is
5732// ever called. However, -fini linker option in makefile.mk works fine.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005733
Jonathan Peyton30419822017-05-12 18:01:32 +00005734__attribute__((destructor)) void __kmp_internal_end_dtor(void) {
5735 __kmp_internal_end_atexit();
Jim Cownie5e8470a2013-09-27 10:38:44 +00005736}
5737
Jonathan Peyton30419822017-05-12 18:01:32 +00005738void __kmp_internal_end_fini(void) { __kmp_internal_end_atexit(); }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005739
5740#endif
5741
Jonathan Peyton30419822017-05-12 18:01:32 +00005742/* [Windows] josh: when the atexit handler is called, there may still be more
5743 than one thread alive */
5744void __kmp_internal_end_atexit(void) {
5745 KA_TRACE(30, ("__kmp_internal_end_atexit\n"));
5746 /* [Windows]
5747 josh: ideally, we want to completely shutdown the library in this atexit
5748 handler, but stat code that depends on thread specific data for gtid fails
5749 because that data becomes unavailable at some point during the shutdown, so
5750 we call __kmp_internal_end_thread instead. We should eventually remove the
5751 dependency on __kmp_get_specific_gtid in the stat code and use
5752 __kmp_internal_end_library to cleanly shutdown the library.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005753
Jonathan Peyton30419822017-05-12 18:01:32 +00005754 // TODO: Can some of this comment about GVS be removed?
5755 I suspect that the offending stat code is executed when the calling thread
5756 tries to clean up a dead root thread's data structures, resulting in GVS
5757 code trying to close the GVS structures for that thread, but since the stat
5758 code uses __kmp_get_specific_gtid to get the gtid with the assumption that
5759 the calling thread is cleaning up itself instead of another thread, it get
5760 confused. This happens because allowing a thread to unregister and cleanup
5761 another thread is a recent modification for addressing an issue.
5762 Based on the current design (20050722), a thread may end up
5763 trying to unregister another thread only if thread death does not trigger
5764 the calling of __kmp_internal_end_thread. For Linux* OS, there is the
5765 thread specific data destructor function to detect thread death. For
5766 Windows dynamic, there is DllMain(THREAD_DETACH). For Windows static, there
5767 is nothing. Thus, the workaround is applicable only for Windows static
5768 stat library. */
5769 __kmp_internal_end_library(-1);
5770#if KMP_OS_WINDOWS
5771 __kmp_close_console();
5772#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005773}
5774
Jonathan Peyton30419822017-05-12 18:01:32 +00005775static void __kmp_reap_thread(kmp_info_t *thread, int is_root) {
5776 // It is assumed __kmp_forkjoin_lock is acquired.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005777
Jonathan Peyton30419822017-05-12 18:01:32 +00005778 int gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005779
Jonathan Peyton30419822017-05-12 18:01:32 +00005780 KMP_DEBUG_ASSERT(thread != NULL);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005781
Jonathan Peyton30419822017-05-12 18:01:32 +00005782 gtid = thread->th.th_info.ds.ds_gtid;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005783
Jonathan Peyton30419822017-05-12 18:01:32 +00005784 if (!is_root) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00005785
Jonathan Peyton30419822017-05-12 18:01:32 +00005786 if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
5787 /* Assume the threads are at the fork barrier here */
5788 KA_TRACE(
5789 20, ("__kmp_reap_thread: releasing T#%d from fork barrier for reap\n",
5790 gtid));
5791 /* Need release fence here to prevent seg faults for tree forkjoin barrier
5792 * (GEH) */
5793 ANNOTATE_HAPPENS_BEFORE(thread);
5794 kmp_flag_64 flag(&thread->th.th_bar[bs_forkjoin_barrier].bb.b_go, thread);
5795 __kmp_release_64(&flag);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005796 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005797
Jonathan Peyton30419822017-05-12 18:01:32 +00005798 // Terminate OS thread.
5799 __kmp_reap_worker(thread);
Jonathan Peyton7ca7ef02016-11-21 16:18:57 +00005800
Jonathan Peyton30419822017-05-12 18:01:32 +00005801 // The thread was killed asynchronously. If it was actively
5802 // spinning in the thread pool, decrement the global count.
5803 //
5804 // There is a small timing hole here - if the worker thread was just waking
5805 // up after sleeping in the pool, had reset it's th_active_in_pool flag but
5806 // not decremented the global counter __kmp_thread_pool_active_nth yet, then
5807 // the global counter might not get updated.
5808 //
5809 // Currently, this can only happen as the library is unloaded,
5810 // so there are no harmful side effects.
5811 if (thread->th.th_active_in_pool) {
5812 thread->th.th_active_in_pool = FALSE;
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00005813 KMP_ATOMIC_DEC(&__kmp_thread_pool_active_nth);
5814 KMP_DEBUG_ASSERT(__kmp_thread_pool_active_nth >= 0);
Jonathan Peyton30419822017-05-12 18:01:32 +00005815 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005816
Jonathan Peyton30419822017-05-12 18:01:32 +00005817 // Decrement # of [worker] threads in the pool.
5818 KMP_DEBUG_ASSERT(__kmp_thread_pool_nth > 0);
5819 --__kmp_thread_pool_nth;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005820 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005821
Jonathan Peyton30419822017-05-12 18:01:32 +00005822 __kmp_free_implicit_task(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005823
Jonathan Peyton30419822017-05-12 18:01:32 +00005824// Free the fast memory for tasking
5825#if USE_FAST_MEMORY
5826 __kmp_free_fast_memory(thread);
5827#endif /* USE_FAST_MEMORY */
5828
5829 __kmp_suspend_uninitialize_thread(thread);
5830
5831 KMP_DEBUG_ASSERT(__kmp_threads[gtid] == thread);
5832 TCW_SYNC_PTR(__kmp_threads[gtid], NULL);
5833
5834 --__kmp_all_nth;
5835// __kmp_nth was decremented when thread is added to the pool.
Jim Cownie5e8470a2013-09-27 10:38:44 +00005836
5837#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00005838 /* Adjust blocktime back to user setting or default if necessary */
5839 /* Middle initialization might never have occurred */
5840 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
5841 KMP_DEBUG_ASSERT(__kmp_avail_proc > 0);
5842 if (__kmp_nth <= __kmp_avail_proc) {
5843 __kmp_zero_bt = FALSE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005844 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005845 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005846#endif /* KMP_ADJUST_BLOCKTIME */
5847
Jonathan Peyton30419822017-05-12 18:01:32 +00005848 /* free the memory being used */
5849 if (__kmp_env_consistency_check) {
5850 if (thread->th.th_cons) {
5851 __kmp_free_cons_stack(thread->th.th_cons);
5852 thread->th.th_cons = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005853 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005854 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00005855
Jonathan Peyton30419822017-05-12 18:01:32 +00005856 if (thread->th.th_pri_common != NULL) {
5857 __kmp_free(thread->th.th_pri_common);
5858 thread->th.th_pri_common = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005859 }
Andrey Churbanov6d224db2015-02-10 18:37:43 +00005860
Jonathan Peyton30419822017-05-12 18:01:32 +00005861 if (thread->th.th_task_state_memo_stack != NULL) {
5862 __kmp_free(thread->th.th_task_state_memo_stack);
5863 thread->th.th_task_state_memo_stack = NULL;
5864 }
5865
5866#if KMP_USE_BGET
5867 if (thread->th.th_local.bget_data != NULL) {
5868 __kmp_finalize_bget(thread);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005869 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005870#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005871
Alp Toker98758b02014-03-02 04:12:06 +00005872#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00005873 if (thread->th.th_affin_mask != NULL) {
5874 KMP_CPU_FREE(thread->th.th_affin_mask);
5875 thread->th.th_affin_mask = NULL;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005876 }
Alp Toker98758b02014-03-02 04:12:06 +00005877#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00005878
Jonathan Peytonf6399362018-07-09 17:51:13 +00005879#if KMP_USE_HIER_SCHED
5880 if (thread->th.th_hier_bar_data != NULL) {
5881 __kmp_free(thread->th.th_hier_bar_data);
5882 thread->th.th_hier_bar_data = NULL;
5883 }
5884#endif
5885
Jonathan Peyton30419822017-05-12 18:01:32 +00005886 __kmp_reap_team(thread->th.th_serial_team);
5887 thread->th.th_serial_team = NULL;
5888 __kmp_free(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00005889
Jonathan Peyton30419822017-05-12 18:01:32 +00005890 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00005891
5892} // __kmp_reap_thread
5893
Jonathan Peyton30419822017-05-12 18:01:32 +00005894static void __kmp_internal_end(void) {
5895 int i;
Jim Cownie5e8470a2013-09-27 10:38:44 +00005896
Jonathan Peyton30419822017-05-12 18:01:32 +00005897 /* First, unregister the library */
5898 __kmp_unregister_library();
Jim Cownie5e8470a2013-09-27 10:38:44 +00005899
Jonathan Peyton30419822017-05-12 18:01:32 +00005900#if KMP_OS_WINDOWS
5901 /* In Win static library, we can't tell when a root actually dies, so we
5902 reclaim the data structures for any root threads that have died but not
5903 unregistered themselves, in order to shut down cleanly.
5904 In Win dynamic library we also can't tell when a thread dies. */
5905 __kmp_reclaim_dead_roots(); // AC: moved here to always clean resources of
5906// dead roots
Jonathan Peytonb66d1aa2016-09-27 17:11:17 +00005907#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00005908
Jonathan Peyton30419822017-05-12 18:01:32 +00005909 for (i = 0; i < __kmp_threads_capacity; i++)
5910 if (__kmp_root[i])
5911 if (__kmp_root[i]->r.r_active)
5912 break;
5913 KMP_MB(); /* Flush all pending memory write invalidates. */
5914 TCW_SYNC_4(__kmp_global.g.g_done, TRUE);
5915
5916 if (i < __kmp_threads_capacity) {
5917#if KMP_USE_MONITOR
5918 // 2009-09-08 (lev): Other alive roots found. Why do we kill the monitor??
5919 KMP_MB(); /* Flush all pending memory write invalidates. */
5920
Jonathan Peyton94a114f2017-10-20 19:30:57 +00005921 // Need to check that monitor was initialized before reaping it. If we are
5922 // called form __kmp_atfork_child (which sets __kmp_init_parallel = 0), then
5923 // __kmp_monitor will appear to contain valid data, but it is only valid in
5924 // the parent process, not the child.
Jonathan Peyton30419822017-05-12 18:01:32 +00005925 // New behavior (201008): instead of keying off of the flag
5926 // __kmp_init_parallel, the monitor thread creation is keyed off
5927 // of the new flag __kmp_init_monitor.
5928 __kmp_acquire_bootstrap_lock(&__kmp_monitor_lock);
5929 if (TCR_4(__kmp_init_monitor)) {
5930 __kmp_reap_monitor(&__kmp_monitor);
5931 TCW_4(__kmp_init_monitor, 0);
5932 }
5933 __kmp_release_bootstrap_lock(&__kmp_monitor_lock);
5934 KA_TRACE(10, ("__kmp_internal_end: monitor reaped\n"));
5935#endif // KMP_USE_MONITOR
5936 } else {
5937/* TODO move this to cleanup code */
5938#ifdef KMP_DEBUG
5939 /* make sure that everything has properly ended */
5940 for (i = 0; i < __kmp_threads_capacity; i++) {
5941 if (__kmp_root[i]) {
5942 // KMP_ASSERT( ! KMP_UBER_GTID( i ) ); // AC:
5943 // there can be uber threads alive here
5944 KMP_ASSERT(!__kmp_root[i]->r.r_active); // TODO: can they be active?
5945 }
5946 }
5947#endif
5948
5949 KMP_MB();
5950
5951 // Reap the worker threads.
5952 // This is valid for now, but be careful if threads are reaped sooner.
5953 while (__kmp_thread_pool != NULL) { // Loop thru all the thread in the pool.
5954 // Get the next thread from the pool.
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005955 kmp_info_t *thread = CCAST(kmp_info_t *, __kmp_thread_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00005956 __kmp_thread_pool = thread->th.th_next_pool;
5957 // Reap it.
5958 KMP_DEBUG_ASSERT(thread->th.th_reap_state == KMP_SAFE_TO_REAP);
5959 thread->th.th_next_pool = NULL;
5960 thread->th.th_in_pool = FALSE;
5961 __kmp_reap_thread(thread, 0);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005962 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005963 __kmp_thread_pool_insert_pt = NULL;
5964
5965 // Reap teams.
5966 while (__kmp_team_pool != NULL) { // Loop thru all the teams in the pool.
5967 // Get the next team from the pool.
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00005968 kmp_team_t *team = CCAST(kmp_team_t *, __kmp_team_pool);
Jonathan Peyton30419822017-05-12 18:01:32 +00005969 __kmp_team_pool = team->t.t_next_pool;
5970 // Reap it.
5971 team->t.t_next_pool = NULL;
5972 __kmp_reap_team(team);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00005973 }
Jonathan Peyton30419822017-05-12 18:01:32 +00005974
5975 __kmp_reap_task_teams();
5976
Jonathan Peytona764af62018-07-19 19:17:00 +00005977#if KMP_OS_UNIX
5978 // Threads that are not reaped should not access any resources since they
5979 // are going to be deallocated soon, so the shutdown sequence should wait
5980 // until all threads either exit the final spin-waiting loop or begin
5981 // sleeping after the given blocktime.
5982 for (i = 0; i < __kmp_threads_capacity; i++) {
5983 kmp_info_t *thr = __kmp_threads[i];
5984 while (thr && KMP_ATOMIC_LD_ACQ(&thr->th.th_blocking))
5985 KMP_CPU_PAUSE();
5986 }
5987#endif
5988
Jonathan Peyton30419822017-05-12 18:01:32 +00005989 for (i = 0; i < __kmp_threads_capacity; ++i) {
5990 // TBD: Add some checking...
5991 // Something like KMP_DEBUG_ASSERT( __kmp_thread[ i ] == NULL );
5992 }
5993
5994 /* Make sure all threadprivate destructors get run by joining with all
5995 worker threads before resetting this flag */
5996 TCW_SYNC_4(__kmp_init_common, FALSE);
5997
5998 KA_TRACE(10, ("__kmp_internal_end: all workers reaped\n"));
5999 KMP_MB();
6000
6001#if KMP_USE_MONITOR
6002 // See note above: One of the possible fixes for CQ138434 / CQ140126
6003 //
6004 // FIXME: push both code fragments down and CSE them?
6005 // push them into __kmp_cleanup() ?
6006 __kmp_acquire_bootstrap_lock(&__kmp_monitor_lock);
6007 if (TCR_4(__kmp_init_monitor)) {
6008 __kmp_reap_monitor(&__kmp_monitor);
6009 TCW_4(__kmp_init_monitor, 0);
6010 }
6011 __kmp_release_bootstrap_lock(&__kmp_monitor_lock);
6012 KA_TRACE(10, ("__kmp_internal_end: monitor reaped\n"));
6013#endif
6014 } /* else !__kmp_global.t_active */
6015 TCW_4(__kmp_init_gtid, FALSE);
6016 KMP_MB(); /* Flush all pending memory write invalidates. */
6017
6018 __kmp_cleanup();
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006019#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006020 ompt_fini();
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006021#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006022}
6023
Jonathan Peyton30419822017-05-12 18:01:32 +00006024void __kmp_internal_end_library(int gtid_req) {
6025 /* if we have already cleaned up, don't try again, it wouldn't be pretty */
6026 /* this shouldn't be a race condition because __kmp_internal_end() is the
6027 only place to clear __kmp_serial_init */
6028 /* we'll check this later too, after we get the lock */
6029 // 2009-09-06: We do not set g_abort without setting g_done. This check looks
6030 // redundaant, because the next check will work in any case.
6031 if (__kmp_global.g.g_abort) {
6032 KA_TRACE(11, ("__kmp_internal_end_library: abort, exiting\n"));
6033 /* TODO abort? */
6034 return;
6035 }
6036 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6037 KA_TRACE(10, ("__kmp_internal_end_library: already finished\n"));
6038 return;
6039 }
6040
6041 KMP_MB(); /* Flush all pending memory write invalidates. */
6042
6043 /* find out who we are and what we should do */
6044 {
6045 int gtid = (gtid_req >= 0) ? gtid_req : __kmp_gtid_get_specific();
6046 KA_TRACE(
6047 10, ("__kmp_internal_end_library: enter T#%d (%d)\n", gtid, gtid_req));
6048 if (gtid == KMP_GTID_SHUTDOWN) {
6049 KA_TRACE(10, ("__kmp_internal_end_library: !__kmp_init_runtime, system "
6050 "already shutdown\n"));
6051 return;
6052 } else if (gtid == KMP_GTID_MONITOR) {
6053 KA_TRACE(10, ("__kmp_internal_end_library: monitor thread, gtid not "
6054 "registered, or system shutdown\n"));
6055 return;
6056 } else if (gtid == KMP_GTID_DNE) {
6057 KA_TRACE(10, ("__kmp_internal_end_library: gtid not registered or system "
6058 "shutdown\n"));
6059 /* we don't know who we are, but we may still shutdown the library */
6060 } else if (KMP_UBER_GTID(gtid)) {
6061 /* unregister ourselves as an uber thread. gtid is no longer valid */
6062 if (__kmp_root[gtid]->r.r_active) {
6063 __kmp_global.g.g_abort = -1;
6064 TCW_SYNC_4(__kmp_global.g.g_done, TRUE);
6065 KA_TRACE(10,
6066 ("__kmp_internal_end_library: root still active, abort T#%d\n",
6067 gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006068 return;
Jonathan Peyton30419822017-05-12 18:01:32 +00006069 } else {
6070 KA_TRACE(
6071 10,
6072 ("__kmp_internal_end_library: unregistering sibling T#%d\n", gtid));
6073 __kmp_unregister_root_current_thread(gtid);
6074 }
6075 } else {
6076/* worker threads may call this function through the atexit handler, if they
6077 * call exit() */
6078/* For now, skip the usual subsequent processing and just dump the debug buffer.
6079 TODO: do a thorough shutdown instead */
6080#ifdef DUMP_DEBUG_ON_EXIT
6081 if (__kmp_debug_buf)
6082 __kmp_dump_debug_buffer();
6083#endif
6084 return;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006085 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006086 }
6087 /* synchronize the termination process */
6088 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006089
Jonathan Peyton30419822017-05-12 18:01:32 +00006090 /* have we already finished */
6091 if (__kmp_global.g.g_abort) {
6092 KA_TRACE(10, ("__kmp_internal_end_library: abort, exiting\n"));
6093 /* TODO abort? */
6094 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6095 return;
6096 }
6097 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6098 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6099 return;
6100 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006101
Jonathan Peyton30419822017-05-12 18:01:32 +00006102 /* We need this lock to enforce mutex between this reading of
6103 __kmp_threads_capacity and the writing by __kmp_register_root.
6104 Alternatively, we can use a counter of roots that is atomically updated by
6105 __kmp_get_global_thread_id_reg, __kmp_do_serial_initialize and
6106 __kmp_internal_end_*. */
6107 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006108
Jonathan Peyton30419822017-05-12 18:01:32 +00006109 /* now we can safely conduct the actual termination */
6110 __kmp_internal_end();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006111
Jonathan Peyton30419822017-05-12 18:01:32 +00006112 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
6113 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006114
Jonathan Peyton30419822017-05-12 18:01:32 +00006115 KA_TRACE(10, ("__kmp_internal_end_library: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006116
Jonathan Peyton30419822017-05-12 18:01:32 +00006117#ifdef DUMP_DEBUG_ON_EXIT
6118 if (__kmp_debug_buf)
6119 __kmp_dump_debug_buffer();
6120#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006121
Jonathan Peyton30419822017-05-12 18:01:32 +00006122#if KMP_OS_WINDOWS
6123 __kmp_close_console();
6124#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006125
Jonathan Peyton30419822017-05-12 18:01:32 +00006126 __kmp_fini_allocator();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006127
6128} // __kmp_internal_end_library
6129
Jonathan Peyton30419822017-05-12 18:01:32 +00006130void __kmp_internal_end_thread(int gtid_req) {
6131 int i;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006132
Jonathan Peyton30419822017-05-12 18:01:32 +00006133 /* if we have already cleaned up, don't try again, it wouldn't be pretty */
6134 /* this shouldn't be a race condition because __kmp_internal_end() is the
6135 * only place to clear __kmp_serial_init */
6136 /* we'll check this later too, after we get the lock */
6137 // 2009-09-06: We do not set g_abort without setting g_done. This check looks
6138 // redundant, because the next check will work in any case.
6139 if (__kmp_global.g.g_abort) {
6140 KA_TRACE(11, ("__kmp_internal_end_thread: abort, exiting\n"));
6141 /* TODO abort? */
6142 return;
6143 }
6144 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6145 KA_TRACE(10, ("__kmp_internal_end_thread: already finished\n"));
6146 return;
6147 }
6148
6149 KMP_MB(); /* Flush all pending memory write invalidates. */
6150
6151 /* find out who we are and what we should do */
6152 {
6153 int gtid = (gtid_req >= 0) ? gtid_req : __kmp_gtid_get_specific();
6154 KA_TRACE(10,
6155 ("__kmp_internal_end_thread: enter T#%d (%d)\n", gtid, gtid_req));
6156 if (gtid == KMP_GTID_SHUTDOWN) {
6157 KA_TRACE(10, ("__kmp_internal_end_thread: !__kmp_init_runtime, system "
6158 "already shutdown\n"));
6159 return;
6160 } else if (gtid == KMP_GTID_MONITOR) {
6161 KA_TRACE(10, ("__kmp_internal_end_thread: monitor thread, gtid not "
6162 "registered, or system shutdown\n"));
6163 return;
6164 } else if (gtid == KMP_GTID_DNE) {
6165 KA_TRACE(10, ("__kmp_internal_end_thread: gtid not registered or system "
6166 "shutdown\n"));
6167 return;
6168 /* we don't know who we are */
6169 } else if (KMP_UBER_GTID(gtid)) {
6170 /* unregister ourselves as an uber thread. gtid is no longer valid */
6171 if (__kmp_root[gtid]->r.r_active) {
6172 __kmp_global.g.g_abort = -1;
6173 TCW_SYNC_4(__kmp_global.g.g_done, TRUE);
6174 KA_TRACE(10,
6175 ("__kmp_internal_end_thread: root still active, abort T#%d\n",
6176 gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006177 return;
Jonathan Peyton30419822017-05-12 18:01:32 +00006178 } else {
6179 KA_TRACE(10, ("__kmp_internal_end_thread: unregistering sibling T#%d\n",
6180 gtid));
6181 __kmp_unregister_root_current_thread(gtid);
6182 }
6183 } else {
6184 /* just a worker thread, let's leave */
6185 KA_TRACE(10, ("__kmp_internal_end_thread: worker thread T#%d\n", gtid));
6186
6187 if (gtid >= 0) {
6188 __kmp_threads[gtid]->th.th_task_team = NULL;
6189 }
6190
6191 KA_TRACE(10,
6192 ("__kmp_internal_end_thread: worker thread done, exiting T#%d\n",
6193 gtid));
6194 return;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006195 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006196 }
Jonathan Peyton8b3842f2018-10-05 17:59:39 +00006197#if KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +00006198 // AC: lets not shutdown the Linux* OS dynamic library at the exit of uber
6199 // thread, because we will better shutdown later in the library destructor.
6200 // The reason of this change is performance problem when non-openmp thread in
6201 // a loop forks and joins many openmp threads. We can save a lot of time
6202 // keeping worker threads alive until the program shutdown.
6203 // OM: Removed Linux* OS restriction to fix the crash on OS X* (DPD200239966)
6204 // and Windows(DPD200287443) that occurs when using critical sections from
6205 // foreign threads.
6206 KA_TRACE(10, ("__kmp_internal_end_thread: exiting T#%d\n", gtid_req));
6207 return;
6208#endif
6209 /* synchronize the termination process */
6210 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006211
Jonathan Peyton30419822017-05-12 18:01:32 +00006212 /* have we already finished */
6213 if (__kmp_global.g.g_abort) {
6214 KA_TRACE(10, ("__kmp_internal_end_thread: abort, exiting\n"));
6215 /* TODO abort? */
6216 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6217 return;
6218 }
6219 if (TCR_4(__kmp_global.g.g_done) || !__kmp_init_serial) {
6220 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6221 return;
6222 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006223
Jonathan Peyton30419822017-05-12 18:01:32 +00006224 /* We need this lock to enforce mutex between this reading of
6225 __kmp_threads_capacity and the writing by __kmp_register_root.
6226 Alternatively, we can use a counter of roots that is atomically updated by
6227 __kmp_get_global_thread_id_reg, __kmp_do_serial_initialize and
6228 __kmp_internal_end_*. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006229
Jonathan Peyton30419822017-05-12 18:01:32 +00006230 /* should we finish the run-time? are all siblings done? */
6231 __kmp_acquire_bootstrap_lock(&__kmp_forkjoin_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006232
Jonathan Peyton30419822017-05-12 18:01:32 +00006233 for (i = 0; i < __kmp_threads_capacity; ++i) {
6234 if (KMP_UBER_GTID(i)) {
6235 KA_TRACE(
6236 10,
6237 ("__kmp_internal_end_thread: remaining sibling task: gtid==%d\n", i));
6238 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
6239 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6240 return;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006241 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006242 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006243
Jonathan Peyton30419822017-05-12 18:01:32 +00006244 /* now we can safely conduct the actual termination */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006245
Jonathan Peyton30419822017-05-12 18:01:32 +00006246 __kmp_internal_end();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006247
Jonathan Peyton30419822017-05-12 18:01:32 +00006248 __kmp_release_bootstrap_lock(&__kmp_forkjoin_lock);
6249 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006250
Jonathan Peyton30419822017-05-12 18:01:32 +00006251 KA_TRACE(10, ("__kmp_internal_end_thread: exit T#%d\n", gtid_req));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006252
Jonathan Peyton30419822017-05-12 18:01:32 +00006253#ifdef DUMP_DEBUG_ON_EXIT
6254 if (__kmp_debug_buf)
6255 __kmp_dump_debug_buffer();
6256#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006257} // __kmp_internal_end_thread
6258
Jonathan Peyton30419822017-05-12 18:01:32 +00006259// -----------------------------------------------------------------------------
Jim Cownie5e8470a2013-09-27 10:38:44 +00006260// Library registration stuff.
6261
Jonathan Peyton30419822017-05-12 18:01:32 +00006262static long __kmp_registration_flag = 0;
6263// Random value used to indicate library initialization.
6264static char *__kmp_registration_str = NULL;
6265// Value to be saved in env var __KMP_REGISTERED_LIB_<pid>.
Jim Cownie5e8470a2013-09-27 10:38:44 +00006266
Jonathan Peyton30419822017-05-12 18:01:32 +00006267static inline char *__kmp_reg_status_name() {
6268 /* On RHEL 3u5 if linked statically, getpid() returns different values in
6269 each thread. If registration and unregistration go in different threads
6270 (omp_misc_other_root_exit.cpp test case), the name of registered_lib_env
6271 env var can not be found, because the name will contain different pid. */
6272 return __kmp_str_format("__KMP_REGISTERED_LIB_%d", (int)getpid());
Jim Cownie5e8470a2013-09-27 10:38:44 +00006273} // __kmp_reg_status_get
6274
Jonathan Peyton30419822017-05-12 18:01:32 +00006275void __kmp_register_library_startup(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006276
Jonathan Peyton30419822017-05-12 18:01:32 +00006277 char *name = __kmp_reg_status_name(); // Name of the environment variable.
6278 int done = 0;
6279 union {
6280 double dtime;
6281 long ltime;
6282 } time;
6283#if KMP_ARCH_X86 || KMP_ARCH_X86_64
6284 __kmp_initialize_system_tick();
6285#endif
6286 __kmp_read_system_time(&time.dtime);
6287 __kmp_registration_flag = 0xCAFE0000L | (time.ltime & 0x0000FFFFL);
6288 __kmp_registration_str =
6289 __kmp_str_format("%p-%lx-%s", &__kmp_registration_flag,
6290 __kmp_registration_flag, KMP_LIBRARY_FILE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006291
Jonathan Peyton30419822017-05-12 18:01:32 +00006292 KA_TRACE(50, ("__kmp_register_library_startup: %s=\"%s\"\n", name,
6293 __kmp_registration_str));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006294
Jonathan Peyton30419822017-05-12 18:01:32 +00006295 while (!done) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006296
Jonathan Peyton30419822017-05-12 18:01:32 +00006297 char *value = NULL; // Actual value of the environment variable.
Jim Cownie5e8470a2013-09-27 10:38:44 +00006298
Jonathan Peyton30419822017-05-12 18:01:32 +00006299 // Set environment variable, but do not overwrite if it is exist.
6300 __kmp_env_set(name, __kmp_registration_str, 0);
6301 // Check the variable is written.
6302 value = __kmp_env_get(name);
6303 if (value != NULL && strcmp(value, __kmp_registration_str) == 0) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006304
Jonathan Peyton30419822017-05-12 18:01:32 +00006305 done = 1; // Ok, environment variable set successfully, exit the loop.
Jim Cownie5e8470a2013-09-27 10:38:44 +00006306
Jonathan Peyton30419822017-05-12 18:01:32 +00006307 } else {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006308
Jonathan Peyton30419822017-05-12 18:01:32 +00006309 // Oops. Write failed. Another copy of OpenMP RTL is in memory.
6310 // Check whether it alive or dead.
6311 int neighbor = 0; // 0 -- unknown status, 1 -- alive, 2 -- dead.
6312 char *tail = value;
6313 char *flag_addr_str = NULL;
6314 char *flag_val_str = NULL;
6315 char const *file_name = NULL;
6316 __kmp_str_split(tail, '-', &flag_addr_str, &tail);
6317 __kmp_str_split(tail, '-', &flag_val_str, &tail);
6318 file_name = tail;
6319 if (tail != NULL) {
6320 long *flag_addr = 0;
6321 long flag_val = 0;
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00006322 KMP_SSCANF(flag_addr_str, "%p", RCAST(void**, &flag_addr));
Jonathan Peyton30419822017-05-12 18:01:32 +00006323 KMP_SSCANF(flag_val_str, "%lx", &flag_val);
6324 if (flag_addr != 0 && flag_val != 0 && strcmp(file_name, "") != 0) {
6325 // First, check whether environment-encoded address is mapped into
6326 // addr space.
6327 // If so, dereference it to see if it still has the right value.
6328 if (__kmp_is_address_mapped(flag_addr) && *flag_addr == flag_val) {
6329 neighbor = 1;
6330 } else {
6331 // If not, then we know the other copy of the library is no longer
6332 // running.
6333 neighbor = 2;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006334 }
6335 }
6336 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006337 switch (neighbor) {
6338 case 0: // Cannot parse environment variable -- neighbor status unknown.
6339 // Assume it is the incompatible format of future version of the
6340 // library. Assume the other library is alive.
6341 // WARN( ... ); // TODO: Issue a warning.
6342 file_name = "unknown library";
6343 // Attention! Falling to the next case. That's intentional.
6344 case 1: { // Neighbor is alive.
6345 // Check it is allowed.
6346 char *duplicate_ok = __kmp_env_get("KMP_DUPLICATE_LIB_OK");
6347 if (!__kmp_str_match_true(duplicate_ok)) {
6348 // That's not allowed. Issue fatal error.
Jonathan Peyton6a393f72017-09-05 15:43:58 +00006349 __kmp_fatal(KMP_MSG(DuplicateLibrary, KMP_LIBRARY_FILE, file_name),
6350 KMP_HNT(DuplicateLibrary), __kmp_msg_null);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006351 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006352 KMP_INTERNAL_FREE(duplicate_ok);
6353 __kmp_duplicate_library_ok = 1;
6354 done = 1; // Exit the loop.
6355 } break;
6356 case 2: { // Neighbor is dead.
6357 // Clear the variable and try to register library again.
6358 __kmp_env_unset(name);
6359 } break;
6360 default: { KMP_DEBUG_ASSERT(0); } break;
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006361 }
6362 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006363 KMP_INTERNAL_FREE((void *)value);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006364 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006365 KMP_INTERNAL_FREE((void *)name);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006366
6367} // func __kmp_register_library_startup
6368
Jonathan Peyton30419822017-05-12 18:01:32 +00006369void __kmp_unregister_library(void) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006370
Jonathan Peyton30419822017-05-12 18:01:32 +00006371 char *name = __kmp_reg_status_name();
6372 char *value = __kmp_env_get(name);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006373
Jonathan Peyton30419822017-05-12 18:01:32 +00006374 KMP_DEBUG_ASSERT(__kmp_registration_flag != 0);
6375 KMP_DEBUG_ASSERT(__kmp_registration_str != NULL);
6376 if (value != NULL && strcmp(value, __kmp_registration_str) == 0) {
6377 // Ok, this is our variable. Delete it.
6378 __kmp_env_unset(name);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006379 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006380
Jonathan Peyton30419822017-05-12 18:01:32 +00006381 KMP_INTERNAL_FREE(__kmp_registration_str);
6382 KMP_INTERNAL_FREE(value);
6383 KMP_INTERNAL_FREE(name);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006384
Jonathan Peyton30419822017-05-12 18:01:32 +00006385 __kmp_registration_flag = 0;
6386 __kmp_registration_str = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006387
6388} // __kmp_unregister_library
6389
Jim Cownie5e8470a2013-09-27 10:38:44 +00006390// End of Library registration stuff.
Jonathan Peyton30419822017-05-12 18:01:32 +00006391// -----------------------------------------------------------------------------
Jim Cownie5e8470a2013-09-27 10:38:44 +00006392
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006393#if KMP_MIC_SUPPORTED
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006394
Jonathan Peyton30419822017-05-12 18:01:32 +00006395static void __kmp_check_mic_type() {
6396 kmp_cpuid_t cpuid_state = {0};
6397 kmp_cpuid_t *cs_p = &cpuid_state;
6398 __kmp_x86_cpuid(1, 0, cs_p);
6399 // We don't support mic1 at the moment
6400 if ((cs_p->eax & 0xff0) == 0xB10) {
6401 __kmp_mic_type = mic2;
6402 } else if ((cs_p->eax & 0xf0ff0) == 0x50670) {
6403 __kmp_mic_type = mic3;
6404 } else {
6405 __kmp_mic_type = non_mic;
6406 }
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006407}
6408
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006409#endif /* KMP_MIC_SUPPORTED */
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006410
Jonathan Peyton30419822017-05-12 18:01:32 +00006411static void __kmp_do_serial_initialize(void) {
6412 int i, gtid;
6413 int size;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006414
Jonathan Peyton30419822017-05-12 18:01:32 +00006415 KA_TRACE(10, ("__kmp_do_serial_initialize: enter\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006416
Jonathan Peyton30419822017-05-12 18:01:32 +00006417 KMP_DEBUG_ASSERT(sizeof(kmp_int32) == 4);
6418 KMP_DEBUG_ASSERT(sizeof(kmp_uint32) == 4);
6419 KMP_DEBUG_ASSERT(sizeof(kmp_int64) == 8);
6420 KMP_DEBUG_ASSERT(sizeof(kmp_uint64) == 8);
6421 KMP_DEBUG_ASSERT(sizeof(kmp_intptr_t) == sizeof(void *));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006422
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006423#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006424 ompt_pre_init();
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006425#endif
6426
Jonathan Peyton30419822017-05-12 18:01:32 +00006427 __kmp_validate_locks();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006428
Jonathan Peyton30419822017-05-12 18:01:32 +00006429 /* Initialize internal memory allocator */
6430 __kmp_init_allocator();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006431
Jonathan Peyton30419822017-05-12 18:01:32 +00006432 /* Register the library startup via an environment variable and check to see
6433 whether another copy of the library is already registered. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006434
Jonathan Peyton30419822017-05-12 18:01:32 +00006435 __kmp_register_library_startup();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006436
Jonathan Peyton30419822017-05-12 18:01:32 +00006437 /* TODO reinitialization of library */
6438 if (TCR_4(__kmp_global.g.g_done)) {
6439 KA_TRACE(10, ("__kmp_do_serial_initialize: reinitialization of library\n"));
6440 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006441
Jonathan Peyton30419822017-05-12 18:01:32 +00006442 __kmp_global.g.g_abort = 0;
6443 TCW_SYNC_4(__kmp_global.g.g_done, FALSE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006444
Jonathan Peyton30419822017-05-12 18:01:32 +00006445/* initialize the locks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006446#if KMP_USE_ADAPTIVE_LOCKS
6447#if KMP_DEBUG_ADAPTIVE_LOCKS
Jonathan Peyton30419822017-05-12 18:01:32 +00006448 __kmp_init_speculative_stats();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006449#endif
6450#endif
Jonathan Peytonad579922015-12-17 16:19:05 +00006451#if KMP_STATS_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00006452 __kmp_stats_init();
Jonathan Peytonad579922015-12-17 16:19:05 +00006453#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006454 __kmp_init_lock(&__kmp_global_lock);
6455 __kmp_init_queuing_lock(&__kmp_dispatch_lock);
6456 __kmp_init_lock(&__kmp_debug_lock);
6457 __kmp_init_atomic_lock(&__kmp_atomic_lock);
6458 __kmp_init_atomic_lock(&__kmp_atomic_lock_1i);
6459 __kmp_init_atomic_lock(&__kmp_atomic_lock_2i);
6460 __kmp_init_atomic_lock(&__kmp_atomic_lock_4i);
6461 __kmp_init_atomic_lock(&__kmp_atomic_lock_4r);
6462 __kmp_init_atomic_lock(&__kmp_atomic_lock_8i);
6463 __kmp_init_atomic_lock(&__kmp_atomic_lock_8r);
6464 __kmp_init_atomic_lock(&__kmp_atomic_lock_8c);
6465 __kmp_init_atomic_lock(&__kmp_atomic_lock_10r);
6466 __kmp_init_atomic_lock(&__kmp_atomic_lock_16r);
6467 __kmp_init_atomic_lock(&__kmp_atomic_lock_16c);
6468 __kmp_init_atomic_lock(&__kmp_atomic_lock_20c);
6469 __kmp_init_atomic_lock(&__kmp_atomic_lock_32c);
6470 __kmp_init_bootstrap_lock(&__kmp_forkjoin_lock);
6471 __kmp_init_bootstrap_lock(&__kmp_exit_lock);
Jonathan Peytonb66d1aa2016-09-27 17:11:17 +00006472#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00006473 __kmp_init_bootstrap_lock(&__kmp_monitor_lock);
Jonathan Peytonb66d1aa2016-09-27 17:11:17 +00006474#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006475 __kmp_init_bootstrap_lock(&__kmp_tp_cached_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006476
Jonathan Peyton30419822017-05-12 18:01:32 +00006477 /* conduct initialization and initial setup of configuration */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006478
Jonathan Peyton30419822017-05-12 18:01:32 +00006479 __kmp_runtime_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006480
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006481#if KMP_MIC_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00006482 __kmp_check_mic_type();
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006483#endif
6484
Jonathan Peyton30419822017-05-12 18:01:32 +00006485// Some global variable initialization moved here from kmp_env_initialize()
Jim Cownie5e8470a2013-09-27 10:38:44 +00006486#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00006487 kmp_diag = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006488#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006489 __kmp_abort_delay = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006490
Jonathan Peyton30419822017-05-12 18:01:32 +00006491 // From __kmp_init_dflt_team_nth()
6492 /* assume the entire machine will be used */
6493 __kmp_dflt_team_nth_ub = __kmp_xproc;
6494 if (__kmp_dflt_team_nth_ub < KMP_MIN_NTH) {
6495 __kmp_dflt_team_nth_ub = KMP_MIN_NTH;
6496 }
6497 if (__kmp_dflt_team_nth_ub > __kmp_sys_max_nth) {
6498 __kmp_dflt_team_nth_ub = __kmp_sys_max_nth;
6499 }
6500 __kmp_max_nth = __kmp_sys_max_nth;
Jonathan Peytonf4392462017-07-27 20:58:41 +00006501 __kmp_cg_max_nth = __kmp_sys_max_nth;
Jonathan Peyton4f90c822017-08-02 20:04:45 +00006502 __kmp_teams_max_nth = __kmp_xproc; // set a "reasonable" default
6503 if (__kmp_teams_max_nth > __kmp_sys_max_nth) {
6504 __kmp_teams_max_nth = __kmp_sys_max_nth;
6505 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006506
Jonathan Peyton30419822017-05-12 18:01:32 +00006507 // Three vars below moved here from __kmp_env_initialize() "KMP_BLOCKTIME"
6508 // part
6509 __kmp_dflt_blocktime = KMP_DEFAULT_BLOCKTIME;
Jonathan Peytone1c7c132016-10-07 18:12:19 +00006510#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00006511 __kmp_monitor_wakeups =
6512 KMP_WAKEUPS_FROM_BLOCKTIME(__kmp_dflt_blocktime, __kmp_monitor_wakeups);
6513 __kmp_bt_intervals =
6514 KMP_INTERVALS_FROM_BLOCKTIME(__kmp_dflt_blocktime, __kmp_monitor_wakeups);
Jonathan Peytone1c7c132016-10-07 18:12:19 +00006515#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006516 // From "KMP_LIBRARY" part of __kmp_env_initialize()
6517 __kmp_library = library_throughput;
6518 // From KMP_SCHEDULE initialization
6519 __kmp_static = kmp_sch_static_balanced;
6520// AC: do not use analytical here, because it is non-monotonous
6521//__kmp_guided = kmp_sch_guided_iterative_chunked;
6522//__kmp_auto = kmp_sch_guided_analytical_chunked; // AC: it is the default, no
6523// need to repeat assignment
6524// Barrier initialization. Moved here from __kmp_env_initialize() Barrier branch
6525// bit control and barrier method control parts
Jim Cownie4cc4bb42014-10-07 16:25:50 +00006526#if KMP_FAST_REDUCTION_BARRIER
Jonathan Peyton30419822017-05-12 18:01:32 +00006527#define kmp_reduction_barrier_gather_bb ((int)1)
6528#define kmp_reduction_barrier_release_bb ((int)1)
6529#define kmp_reduction_barrier_gather_pat bp_hyper_bar
6530#define kmp_reduction_barrier_release_pat bp_hyper_bar
6531#endif // KMP_FAST_REDUCTION_BARRIER
6532 for (i = bs_plain_barrier; i < bs_last_barrier; i++) {
6533 __kmp_barrier_gather_branch_bits[i] = __kmp_barrier_gather_bb_dflt;
6534 __kmp_barrier_release_branch_bits[i] = __kmp_barrier_release_bb_dflt;
6535 __kmp_barrier_gather_pattern[i] = __kmp_barrier_gather_pat_dflt;
6536 __kmp_barrier_release_pattern[i] = __kmp_barrier_release_pat_dflt;
6537#if KMP_FAST_REDUCTION_BARRIER
6538 if (i == bs_reduction_barrier) { // tested and confirmed on ALTIX only (
6539 // lin_64 ): hyper,1
6540 __kmp_barrier_gather_branch_bits[i] = kmp_reduction_barrier_gather_bb;
6541 __kmp_barrier_release_branch_bits[i] = kmp_reduction_barrier_release_bb;
6542 __kmp_barrier_gather_pattern[i] = kmp_reduction_barrier_gather_pat;
6543 __kmp_barrier_release_pattern[i] = kmp_reduction_barrier_release_pat;
Andrey Churbanov613edeb2015-02-20 18:14:43 +00006544 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006545#endif // KMP_FAST_REDUCTION_BARRIER
6546 }
6547#if KMP_FAST_REDUCTION_BARRIER
6548#undef kmp_reduction_barrier_release_pat
6549#undef kmp_reduction_barrier_gather_pat
6550#undef kmp_reduction_barrier_release_bb
6551#undef kmp_reduction_barrier_gather_bb
6552#endif // KMP_FAST_REDUCTION_BARRIER
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006553#if KMP_MIC_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00006554 if (__kmp_mic_type == mic2) { // KNC
6555 // AC: plane=3,2, forkjoin=2,1 are optimal for 240 threads on KNC
6556 __kmp_barrier_gather_branch_bits[bs_plain_barrier] = 3; // plain gather
6557 __kmp_barrier_release_branch_bits[bs_forkjoin_barrier] =
6558 1; // forkjoin release
6559 __kmp_barrier_gather_pattern[bs_forkjoin_barrier] = bp_hierarchical_bar;
6560 __kmp_barrier_release_pattern[bs_forkjoin_barrier] = bp_hierarchical_bar;
6561 }
6562#if KMP_FAST_REDUCTION_BARRIER
6563 if (__kmp_mic_type == mic2) { // KNC
6564 __kmp_barrier_gather_pattern[bs_reduction_barrier] = bp_hierarchical_bar;
6565 __kmp_barrier_release_pattern[bs_reduction_barrier] = bp_hierarchical_bar;
6566 }
Jonathan Peyton492e0a32017-06-13 17:17:26 +00006567#endif // KMP_FAST_REDUCTION_BARRIER
6568#endif // KMP_MIC_SUPPORTED
Jim Cownie5e8470a2013-09-27 10:38:44 +00006569
Jonathan Peyton30419822017-05-12 18:01:32 +00006570// From KMP_CHECKS initialization
Jim Cownie5e8470a2013-09-27 10:38:44 +00006571#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00006572 __kmp_env_checks = TRUE; /* development versions have the extra checks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006573#else
Jonathan Peyton30419822017-05-12 18:01:32 +00006574 __kmp_env_checks = FALSE; /* port versions do not have the extra checks */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006575#endif
6576
Jonathan Peyton30419822017-05-12 18:01:32 +00006577 // From "KMP_FOREIGN_THREADS_THREADPRIVATE" initialization
6578 __kmp_foreign_tp = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006579
Jonathan Peyton30419822017-05-12 18:01:32 +00006580 __kmp_global.g.g_dynamic = FALSE;
6581 __kmp_global.g.g_dynamic_mode = dynamic_default;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006582
Jonathan Peyton30419822017-05-12 18:01:32 +00006583 __kmp_env_initialize(NULL);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00006584
Jonathan Peyton30419822017-05-12 18:01:32 +00006585// Print all messages in message catalog for testing purposes.
6586#ifdef KMP_DEBUG
6587 char const *val = __kmp_env_get("KMP_DUMP_CATALOG");
6588 if (__kmp_str_match_true(val)) {
6589 kmp_str_buf_t buffer;
6590 __kmp_str_buf_init(&buffer);
6591 __kmp_i18n_dump_catalog(&buffer);
6592 __kmp_printf("%s", buffer.str);
6593 __kmp_str_buf_free(&buffer);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006594 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006595 __kmp_env_free(&val);
6596#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006597
Jonathan Peyton30419822017-05-12 18:01:32 +00006598 __kmp_threads_capacity =
6599 __kmp_initial_threads_capacity(__kmp_dflt_team_nth_ub);
6600 // Moved here from __kmp_env_initialize() "KMP_ALL_THREADPRIVATE" part
6601 __kmp_tp_capacity = __kmp_default_tp_capacity(
6602 __kmp_dflt_team_nth_ub, __kmp_max_nth, __kmp_allThreadsSpecified);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006603
Jonathan Peyton30419822017-05-12 18:01:32 +00006604 // If the library is shut down properly, both pools must be NULL. Just in
6605 // case, set them to NULL -- some memory may leak, but subsequent code will
6606 // work even if pools are not freed.
6607 KMP_DEBUG_ASSERT(__kmp_thread_pool == NULL);
6608 KMP_DEBUG_ASSERT(__kmp_thread_pool_insert_pt == NULL);
6609 KMP_DEBUG_ASSERT(__kmp_team_pool == NULL);
6610 __kmp_thread_pool = NULL;
6611 __kmp_thread_pool_insert_pt = NULL;
6612 __kmp_team_pool = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006613
Jonathan Peyton30419822017-05-12 18:01:32 +00006614 /* Allocate all of the variable sized records */
6615 /* NOTE: __kmp_threads_capacity entries are allocated, but the arrays are
6616 * expandable */
6617 /* Since allocation is cache-aligned, just add extra padding at the end */
6618 size =
6619 (sizeof(kmp_info_t *) + sizeof(kmp_root_t *)) * __kmp_threads_capacity +
6620 CACHE_LINE;
6621 __kmp_threads = (kmp_info_t **)__kmp_allocate(size);
6622 __kmp_root = (kmp_root_t **)((char *)__kmp_threads +
6623 sizeof(kmp_info_t *) * __kmp_threads_capacity);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006624
Jonathan Peyton30419822017-05-12 18:01:32 +00006625 /* init thread counts */
6626 KMP_DEBUG_ASSERT(__kmp_all_nth ==
6627 0); // Asserts fail if the library is reinitializing and
6628 KMP_DEBUG_ASSERT(__kmp_nth == 0); // something was wrong in termination.
6629 __kmp_all_nth = 0;
6630 __kmp_nth = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006631
Jonathan Peyton30419822017-05-12 18:01:32 +00006632 /* setup the uber master thread and hierarchy */
6633 gtid = __kmp_register_root(TRUE);
6634 KA_TRACE(10, ("__kmp_do_serial_initialize T#%d\n", gtid));
6635 KMP_ASSERT(KMP_UBER_GTID(gtid));
6636 KMP_ASSERT(KMP_INITIAL_GTID(gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006637
Jonathan Peyton30419822017-05-12 18:01:32 +00006638 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006639
Jonathan Peyton30419822017-05-12 18:01:32 +00006640 __kmp_common_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006641
Jonathan Peyton30419822017-05-12 18:01:32 +00006642#if KMP_OS_UNIX
6643 /* invoke the child fork handler */
6644 __kmp_register_atfork();
6645#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006646
Jonathan Peyton8b3842f2018-10-05 17:59:39 +00006647#if !KMP_DYNAMIC_LIB
Jonathan Peyton30419822017-05-12 18:01:32 +00006648 {
6649 /* Invoke the exit handler when the program finishes, only for static
6650 library. For dynamic library, we already have _fini and DllMain. */
6651 int rc = atexit(__kmp_internal_end_atexit);
6652 if (rc != 0) {
Jonathan Peyton6a393f72017-09-05 15:43:58 +00006653 __kmp_fatal(KMP_MSG(FunctionError, "atexit()"), KMP_ERR(rc),
6654 __kmp_msg_null);
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00006655 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006656 }
6657#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006658
Jonathan Peyton30419822017-05-12 18:01:32 +00006659#if KMP_HANDLE_SIGNALS
6660#if KMP_OS_UNIX
6661 /* NOTE: make sure that this is called before the user installs their own
6662 signal handlers so that the user handlers are called first. this way they
6663 can return false, not call our handler, avoid terminating the library, and
6664 continue execution where they left off. */
6665 __kmp_install_signals(FALSE);
6666#endif /* KMP_OS_UNIX */
6667#if KMP_OS_WINDOWS
6668 __kmp_install_signals(TRUE);
6669#endif /* KMP_OS_WINDOWS */
6670#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006671
Jonathan Peyton30419822017-05-12 18:01:32 +00006672 /* we have finished the serial initialization */
6673 __kmp_init_counter++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006674
Jonathan Peyton30419822017-05-12 18:01:32 +00006675 __kmp_init_serial = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006676
Jonathan Peyton30419822017-05-12 18:01:32 +00006677 if (__kmp_settings) {
6678 __kmp_env_print();
6679 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006680
6681#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00006682 if (__kmp_display_env || __kmp_display_env_verbose) {
6683 __kmp_env_print_2();
6684 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006685#endif // OMP_40_ENABLED
6686
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006687#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006688 ompt_post_init();
Jonathan Peyton82a13bf2015-09-21 18:01:02 +00006689#endif
6690
Jonathan Peyton30419822017-05-12 18:01:32 +00006691 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006692
Jonathan Peyton30419822017-05-12 18:01:32 +00006693 KA_TRACE(10, ("__kmp_do_serial_initialize: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006694}
6695
Jonathan Peyton30419822017-05-12 18:01:32 +00006696void __kmp_serial_initialize(void) {
6697 if (__kmp_init_serial) {
6698 return;
6699 }
6700 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
6701 if (__kmp_init_serial) {
6702 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6703 return;
6704 }
6705 __kmp_do_serial_initialize();
6706 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6707}
6708
6709static void __kmp_do_middle_initialize(void) {
6710 int i, j;
6711 int prev_dflt_team_nth;
6712
6713 if (!__kmp_init_serial) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006714 __kmp_do_serial_initialize();
Jonathan Peyton30419822017-05-12 18:01:32 +00006715 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006716
Jonathan Peyton30419822017-05-12 18:01:32 +00006717 KA_TRACE(10, ("__kmp_middle_initialize: enter\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006718
Jonathan Peyton30419822017-05-12 18:01:32 +00006719 // Save the previous value for the __kmp_dflt_team_nth so that
6720 // we can avoid some reinitialization if it hasn't changed.
6721 prev_dflt_team_nth = __kmp_dflt_team_nth;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006722
Alp Toker98758b02014-03-02 04:12:06 +00006723#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00006724 // __kmp_affinity_initialize() will try to set __kmp_ncores to the
6725 // number of cores on the machine.
6726 __kmp_affinity_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006727
Jonathan Peyton30419822017-05-12 18:01:32 +00006728 // Run through the __kmp_threads array and set the affinity mask
6729 // for each root thread that is currently registered with the RTL.
6730 for (i = 0; i < __kmp_threads_capacity; i++) {
6731 if (TCR_PTR(__kmp_threads[i]) != NULL) {
6732 __kmp_affinity_set_init_mask(i, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006733 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006734 }
Alp Toker98758b02014-03-02 04:12:06 +00006735#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006736
Jonathan Peyton30419822017-05-12 18:01:32 +00006737 KMP_ASSERT(__kmp_xproc > 0);
6738 if (__kmp_avail_proc == 0) {
6739 __kmp_avail_proc = __kmp_xproc;
6740 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006741
Jonathan Peyton30419822017-05-12 18:01:32 +00006742 // If there were empty places in num_threads list (OMP_NUM_THREADS=,,2,3),
6743 // correct them now
6744 j = 0;
6745 while ((j < __kmp_nested_nth.used) && !__kmp_nested_nth.nth[j]) {
6746 __kmp_nested_nth.nth[j] = __kmp_dflt_team_nth = __kmp_dflt_team_nth_ub =
6747 __kmp_avail_proc;
6748 j++;
6749 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006750
Jonathan Peyton30419822017-05-12 18:01:32 +00006751 if (__kmp_dflt_team_nth == 0) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006752#ifdef KMP_DFLT_NTH_CORES
Jonathan Peyton30419822017-05-12 18:01:32 +00006753 // Default #threads = #cores
6754 __kmp_dflt_team_nth = __kmp_ncores;
6755 KA_TRACE(20, ("__kmp_middle_initialize: setting __kmp_dflt_team_nth = "
6756 "__kmp_ncores (%d)\n",
6757 __kmp_dflt_team_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006758#else
Jonathan Peyton30419822017-05-12 18:01:32 +00006759 // Default #threads = #available OS procs
6760 __kmp_dflt_team_nth = __kmp_avail_proc;
6761 KA_TRACE(20, ("__kmp_middle_initialize: setting __kmp_dflt_team_nth = "
6762 "__kmp_avail_proc(%d)\n",
6763 __kmp_dflt_team_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006764#endif /* KMP_DFLT_NTH_CORES */
Jonathan Peyton30419822017-05-12 18:01:32 +00006765 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006766
Jonathan Peyton30419822017-05-12 18:01:32 +00006767 if (__kmp_dflt_team_nth < KMP_MIN_NTH) {
6768 __kmp_dflt_team_nth = KMP_MIN_NTH;
6769 }
6770 if (__kmp_dflt_team_nth > __kmp_sys_max_nth) {
6771 __kmp_dflt_team_nth = __kmp_sys_max_nth;
6772 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006773
Jonathan Peyton30419822017-05-12 18:01:32 +00006774 // There's no harm in continuing if the following check fails,
6775 // but it indicates an error in the previous logic.
6776 KMP_DEBUG_ASSERT(__kmp_dflt_team_nth <= __kmp_dflt_team_nth_ub);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006777
Jonathan Peyton30419822017-05-12 18:01:32 +00006778 if (__kmp_dflt_team_nth != prev_dflt_team_nth) {
6779 // Run through the __kmp_threads array and set the num threads icv for each
6780 // root thread that is currently registered with the RTL (which has not
6781 // already explicitly set its nthreads-var with a call to
6782 // omp_set_num_threads()).
6783 for (i = 0; i < __kmp_threads_capacity; i++) {
6784 kmp_info_t *thread = __kmp_threads[i];
6785 if (thread == NULL)
6786 continue;
6787 if (thread->th.th_current_task->td_icvs.nproc != 0)
6788 continue;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006789
Jonathan Peyton30419822017-05-12 18:01:32 +00006790 set__nproc(__kmp_threads[i], __kmp_dflt_team_nth);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006791 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006792 }
6793 KA_TRACE(
6794 20,
6795 ("__kmp_middle_initialize: final value for __kmp_dflt_team_nth = %d\n",
6796 __kmp_dflt_team_nth));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006797
6798#ifdef KMP_ADJUST_BLOCKTIME
Jonathan Peyton30419822017-05-12 18:01:32 +00006799 /* Adjust blocktime to zero if necessary now that __kmp_avail_proc is set */
6800 if (!__kmp_env_blocktime && (__kmp_avail_proc > 0)) {
6801 KMP_DEBUG_ASSERT(__kmp_avail_proc > 0);
6802 if (__kmp_nth > __kmp_avail_proc) {
6803 __kmp_zero_bt = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006804 }
Jonathan Peyton30419822017-05-12 18:01:32 +00006805 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006806#endif /* KMP_ADJUST_BLOCKTIME */
6807
Jonathan Peyton30419822017-05-12 18:01:32 +00006808 /* we have finished middle initialization */
6809 TCW_SYNC_4(__kmp_init_middle, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006810
Jonathan Peyton30419822017-05-12 18:01:32 +00006811 KA_TRACE(10, ("__kmp_do_middle_initialize: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006812}
6813
Jonathan Peyton30419822017-05-12 18:01:32 +00006814void __kmp_middle_initialize(void) {
6815 if (__kmp_init_middle) {
6816 return;
6817 }
6818 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
6819 if (__kmp_init_middle) {
6820 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6821 return;
6822 }
6823 __kmp_do_middle_initialize();
6824 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6825}
6826
6827void __kmp_parallel_initialize(void) {
6828 int gtid = __kmp_entry_gtid(); // this might be a new root
6829
6830 /* synchronize parallel initialization (for sibling) */
6831 if (TCR_4(__kmp_init_parallel))
6832 return;
6833 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
6834 if (TCR_4(__kmp_init_parallel)) {
6835 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
6836 return;
6837 }
6838
6839 /* TODO reinitialization after we have already shut down */
6840 if (TCR_4(__kmp_global.g.g_done)) {
6841 KA_TRACE(
6842 10,
6843 ("__kmp_parallel_initialize: attempt to init while shutting down\n"));
6844 __kmp_infinite_loop();
6845 }
6846
6847 /* jc: The lock __kmp_initz_lock is already held, so calling
6848 __kmp_serial_initialize would cause a deadlock. So we call
6849 __kmp_do_serial_initialize directly. */
6850 if (!__kmp_init_middle) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00006851 __kmp_do_middle_initialize();
Jonathan Peyton30419822017-05-12 18:01:32 +00006852 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006853
Jonathan Peyton30419822017-05-12 18:01:32 +00006854 /* begin initialization */
6855 KA_TRACE(10, ("__kmp_parallel_initialize: enter\n"));
6856 KMP_ASSERT(KMP_UBER_GTID(gtid));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006857
6858#if KMP_ARCH_X86 || KMP_ARCH_X86_64
Jonathan Peyton30419822017-05-12 18:01:32 +00006859 // Save the FP control regs.
6860 // Worker threads will set theirs to these values at thread startup.
6861 __kmp_store_x87_fpu_control_word(&__kmp_init_x87_fpu_control_word);
6862 __kmp_store_mxcsr(&__kmp_init_mxcsr);
6863 __kmp_init_mxcsr &= KMP_X86_MXCSR_MASK;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006864#endif /* KMP_ARCH_X86 || KMP_ARCH_X86_64 */
6865
6866#if KMP_OS_UNIX
Jonathan Peyton30419822017-05-12 18:01:32 +00006867#if KMP_HANDLE_SIGNALS
6868 /* must be after __kmp_serial_initialize */
6869 __kmp_install_signals(TRUE);
6870#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00006871#endif
6872
Jonathan Peyton30419822017-05-12 18:01:32 +00006873 __kmp_suspend_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006874
Jonathan Peyton749b4d52016-01-27 21:02:04 +00006875#if defined(USE_LOAD_BALANCE)
Jonathan Peyton30419822017-05-12 18:01:32 +00006876 if (__kmp_global.g.g_dynamic_mode == dynamic_default) {
6877 __kmp_global.g.g_dynamic_mode = dynamic_load_balance;
6878 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006879#else
Jonathan Peyton30419822017-05-12 18:01:32 +00006880 if (__kmp_global.g.g_dynamic_mode == dynamic_default) {
6881 __kmp_global.g.g_dynamic_mode = dynamic_thread_limit;
6882 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006883#endif
6884
Jonathan Peyton30419822017-05-12 18:01:32 +00006885 if (__kmp_version) {
6886 __kmp_print_version_2();
6887 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006888
Jonathan Peyton30419822017-05-12 18:01:32 +00006889 /* we have finished parallel initialization */
6890 TCW_SYNC_4(__kmp_init_parallel, TRUE);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006891
Jonathan Peyton30419822017-05-12 18:01:32 +00006892 KMP_MB();
6893 KA_TRACE(10, ("__kmp_parallel_initialize: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00006894
Jonathan Peyton30419822017-05-12 18:01:32 +00006895 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006896}
6897
Jim Cownie5e8470a2013-09-27 10:38:44 +00006898/* ------------------------------------------------------------------------ */
6899
Jonathan Peyton30419822017-05-12 18:01:32 +00006900void __kmp_run_before_invoked_task(int gtid, int tid, kmp_info_t *this_thr,
6901 kmp_team_t *team) {
6902 kmp_disp_t *dispatch;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006903
Jonathan Peyton30419822017-05-12 18:01:32 +00006904 KMP_MB();
Jim Cownie5e8470a2013-09-27 10:38:44 +00006905
Jonathan Peyton30419822017-05-12 18:01:32 +00006906 /* none of the threads have encountered any constructs, yet. */
6907 this_thr->th.th_local.this_construct = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006908#if KMP_CACHE_MANAGE
Jonathan Peyton30419822017-05-12 18:01:32 +00006909 KMP_CACHE_PREFETCH(&this_thr->th.th_bar[bs_forkjoin_barrier].bb.b_arrived);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006910#endif /* KMP_CACHE_MANAGE */
Jonathan Peyton30419822017-05-12 18:01:32 +00006911 dispatch = (kmp_disp_t *)TCR_PTR(this_thr->th.th_dispatch);
6912 KMP_DEBUG_ASSERT(dispatch);
6913 KMP_DEBUG_ASSERT(team->t.t_dispatch);
6914 // KMP_DEBUG_ASSERT( this_thr->th.th_dispatch == &team->t.t_dispatch[
6915 // this_thr->th.th_info.ds.ds_tid ] );
Jim Cownie5e8470a2013-09-27 10:38:44 +00006916
Jonathan Peyton30419822017-05-12 18:01:32 +00006917 dispatch->th_disp_index = 0; /* reset the dispatch buffer counter */
Jonathan Peytondf6818b2016-06-14 17:57:47 +00006918#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00006919 dispatch->th_doacross_buf_idx =
6920 0; /* reset the doacross dispatch buffer counter */
Jonathan Peyton71909c52016-03-02 22:42:06 +00006921#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006922 if (__kmp_env_consistency_check)
6923 __kmp_push_parallel(gtid, team->t.t_ident);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006924
Jonathan Peyton30419822017-05-12 18:01:32 +00006925 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00006926}
6927
Jonathan Peyton30419822017-05-12 18:01:32 +00006928void __kmp_run_after_invoked_task(int gtid, int tid, kmp_info_t *this_thr,
6929 kmp_team_t *team) {
6930 if (__kmp_env_consistency_check)
6931 __kmp_pop_parallel(gtid, team->t.t_ident);
Andrey Churbanovdf0d75e2016-10-27 11:43:07 +00006932
Jonathan Peyton30419822017-05-12 18:01:32 +00006933 __kmp_finish_implicit_task(this_thr);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006934}
6935
Jonathan Peyton30419822017-05-12 18:01:32 +00006936int __kmp_invoke_task_func(int gtid) {
6937 int rc;
6938 int tid = __kmp_tid_from_gtid(gtid);
6939 kmp_info_t *this_thr = __kmp_threads[gtid];
6940 kmp_team_t *team = this_thr->th.th_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00006941
Jonathan Peyton30419822017-05-12 18:01:32 +00006942 __kmp_run_before_invoked_task(gtid, tid, this_thr, team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00006943#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00006944 if (__itt_stack_caller_create_ptr) {
6945 __kmp_itt_stack_callee_enter(
6946 (__itt_caller)
6947 team->t.t_stack_id); // inform ittnotify about entering user's code
6948 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00006949#endif /* USE_ITT_BUILD */
Jim Cownie4cc4bb42014-10-07 16:25:50 +00006950#if INCLUDE_SSC_MARKS
Jonathan Peyton30419822017-05-12 18:01:32 +00006951 SSC_MARK_INVOKING();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00006952#endif
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006953
6954#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006955 void *dummy;
6956 void **exit_runtime_p;
Joachim Protze82e94a52017-11-01 10:08:30 +00006957 ompt_data_t *my_task_data;
6958 ompt_data_t *my_parallel_data;
6959 int ompt_team_size;
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006960
Joachim Protze82e94a52017-11-01 10:08:30 +00006961 if (ompt_enabled.enabled) {
Joachim Protzec255ca72017-11-05 14:11:10 +00006962 exit_runtime_p = &(
6963 team->t.t_implicit_task_taskdata[tid].ompt_task_info.frame.exit_frame);
Jonathan Peyton30419822017-05-12 18:01:32 +00006964 } else {
6965 exit_runtime_p = &dummy;
6966 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006967
Joachim Protze82e94a52017-11-01 10:08:30 +00006968 my_task_data =
6969 &(team->t.t_implicit_task_taskdata[tid].ompt_task_info.task_data);
6970 my_parallel_data = &(team->t.ompt_team_info.parallel_data);
6971 if (ompt_enabled.ompt_callback_implicit_task) {
6972 ompt_team_size = team->t.t_nproc;
6973 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
6974 ompt_scope_begin, my_parallel_data, my_task_data, ompt_team_size,
6975 __kmp_tid_from_gtid(gtid));
Joachim Protze9be9cf22018-05-07 12:42:21 +00006976 OMPT_CUR_TASK_INFO(this_thr)->thread_num = __kmp_tid_from_gtid(gtid);
Jonathan Peyton30419822017-05-12 18:01:32 +00006977 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006978#endif
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006979
Jonathan Peyton30419822017-05-12 18:01:32 +00006980 {
6981 KMP_TIME_PARTITIONED_BLOCK(OMP_parallel);
6982 KMP_SET_THREAD_STATE_BLOCK(IMPLICIT_TASK);
6983 rc =
6984 __kmp_invoke_microtask((microtask_t)TCR_SYNC_PTR(team->t.t_pkfn), gtid,
6985 tid, (int)team->t.t_argc, (void **)team->t.t_argv
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006986#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006987 ,
6988 exit_runtime_p
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006989#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006990 );
Jonas Hahnfeld8a270642016-09-14 13:59:19 +00006991#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00006992 *exit_runtime_p = NULL;
Jonas Hahnfeld8a270642016-09-14 13:59:19 +00006993#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00006994 }
Andrey Churbanovd7d088f2015-04-29 16:42:24 +00006995
Jim Cownie5e8470a2013-09-27 10:38:44 +00006996#if USE_ITT_BUILD
Jonathan Peyton30419822017-05-12 18:01:32 +00006997 if (__itt_stack_caller_create_ptr) {
6998 __kmp_itt_stack_callee_leave(
6999 (__itt_caller)
7000 team->t.t_stack_id); // inform ittnotify about leaving user's code
7001 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007002#endif /* USE_ITT_BUILD */
Jonathan Peyton30419822017-05-12 18:01:32 +00007003 __kmp_run_after_invoked_task(gtid, tid, this_thr, team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007004
Jonathan Peyton30419822017-05-12 18:01:32 +00007005 return rc;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007006}
7007
7008#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007009void __kmp_teams_master(int gtid) {
7010 // This routine is called by all master threads in teams construct
7011 kmp_info_t *thr = __kmp_threads[gtid];
7012 kmp_team_t *team = thr->th.th_team;
7013 ident_t *loc = team->t.t_ident;
7014 thr->th.th_set_nproc = thr->th.th_teams_size.nth;
7015 KMP_DEBUG_ASSERT(thr->th.th_teams_microtask);
7016 KMP_DEBUG_ASSERT(thr->th.th_set_nproc);
7017 KA_TRACE(20, ("__kmp_teams_master: T#%d, Tid %d, microtask %p\n", gtid,
7018 __kmp_tid_from_gtid(gtid), thr->th.th_teams_microtask));
7019// Launch league of teams now, but not let workers execute
7020// (they hang on fork barrier until next parallel)
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007021#if INCLUDE_SSC_MARKS
Jonathan Peyton30419822017-05-12 18:01:32 +00007022 SSC_MARK_FORKING();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007023#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007024 __kmp_fork_call(loc, gtid, fork_context_intel, team->t.t_argc,
Jonathan Peyton30419822017-05-12 18:01:32 +00007025 (microtask_t)thr->th.th_teams_microtask, // "wrapped" task
7026 VOLATILE_CAST(launch_t) __kmp_invoke_task_func, NULL);
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007027#if INCLUDE_SSC_MARKS
Jonathan Peyton30419822017-05-12 18:01:32 +00007028 SSC_MARK_JOINING();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007029#endif
Jonathan Peyton61118492016-05-20 19:03:38 +00007030
Jonathan Peyton30419822017-05-12 18:01:32 +00007031 // AC: last parameter "1" eliminates join barrier which won't work because
7032 // worker threads are in a fork barrier waiting for more parallel regions
7033 __kmp_join_call(loc, gtid
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00007034#if OMPT_SUPPORT
Jonathan Peyton30419822017-05-12 18:01:32 +00007035 ,
7036 fork_context_intel
Jonathan Peytonf89fbbb2015-08-31 18:15:00 +00007037#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007038 ,
7039 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007040}
7041
Jonathan Peyton30419822017-05-12 18:01:32 +00007042int __kmp_invoke_teams_master(int gtid) {
7043 kmp_info_t *this_thr = __kmp_threads[gtid];
7044 kmp_team_t *team = this_thr->th.th_team;
7045#if KMP_DEBUG
7046 if (!__kmp_threads[gtid]->th.th_team->t.t_serialized)
7047 KMP_DEBUG_ASSERT((void *)__kmp_threads[gtid]->th.th_team->t.t_pkfn ==
7048 (void *)__kmp_teams_master);
7049#endif
7050 __kmp_run_before_invoked_task(gtid, 0, this_thr, team);
7051 __kmp_teams_master(gtid);
7052 __kmp_run_after_invoked_task(gtid, 0, this_thr, team);
7053 return 1;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007054}
7055#endif /* OMP_40_ENABLED */
7056
7057/* this sets the requested number of threads for the next parallel region
Jonathan Peyton30419822017-05-12 18:01:32 +00007058 encountered by this team. since this should be enclosed in the forkjoin
7059 critical section it should avoid race conditions with assymmetrical nested
7060 parallelism */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007061
Jonathan Peyton30419822017-05-12 18:01:32 +00007062void __kmp_push_num_threads(ident_t *id, int gtid, int num_threads) {
7063 kmp_info_t *thr = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00007064
Jonathan Peyton30419822017-05-12 18:01:32 +00007065 if (num_threads > 0)
7066 thr->th.th_set_nproc = num_threads;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007067}
7068
7069#if OMP_40_ENABLED
7070
7071/* this sets the requested number of teams for the teams region and/or
Jonathan Peyton30419822017-05-12 18:01:32 +00007072 the number of threads for the next parallel region encountered */
7073void __kmp_push_num_teams(ident_t *id, int gtid, int num_teams,
7074 int num_threads) {
7075 kmp_info_t *thr = __kmp_threads[gtid];
7076 KMP_DEBUG_ASSERT(num_teams >= 0);
7077 KMP_DEBUG_ASSERT(num_threads >= 0);
Jonathan Peyton1be692e2015-11-30 20:14:05 +00007078
Jonathan Peyton30419822017-05-12 18:01:32 +00007079 if (num_teams == 0)
7080 num_teams = 1; // default number of teams is 1.
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007081 if (num_teams > __kmp_teams_max_nth) { // if too many teams requested?
Jonathan Peyton30419822017-05-12 18:01:32 +00007082 if (!__kmp_reserve_warn) {
7083 __kmp_reserve_warn = 1;
7084 __kmp_msg(kmp_ms_warning,
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007085 KMP_MSG(CantFormThrTeam, num_teams, __kmp_teams_max_nth),
Jonathan Peyton30419822017-05-12 18:01:32 +00007086 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007087 }
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007088 num_teams = __kmp_teams_max_nth;
Jonathan Peyton30419822017-05-12 18:01:32 +00007089 }
7090 // Set number of teams (number of threads in the outer "parallel" of the
7091 // teams)
7092 thr->th.th_set_nproc = thr->th.th_teams_size.nteams = num_teams;
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007093
Jonathan Peyton30419822017-05-12 18:01:32 +00007094 // Remember the number of threads for inner parallel regions
7095 if (num_threads == 0) {
7096 if (!TCR_4(__kmp_init_middle))
7097 __kmp_middle_initialize(); // get __kmp_avail_proc calculated
7098 num_threads = __kmp_avail_proc / num_teams;
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007099 if (num_teams * num_threads > __kmp_teams_max_nth) {
Jonathan Peyton30419822017-05-12 18:01:32 +00007100 // adjust num_threads w/o warning as it is not user setting
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007101 num_threads = __kmp_teams_max_nth / num_teams;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007102 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007103 } else {
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007104 if (num_teams * num_threads > __kmp_teams_max_nth) {
7105 int new_threads = __kmp_teams_max_nth / num_teams;
Jonathan Peyton30419822017-05-12 18:01:32 +00007106 if (!__kmp_reserve_warn) { // user asked for too many threads
Jonathan Peyton4f90c822017-08-02 20:04:45 +00007107 __kmp_reserve_warn = 1; // that conflicts with KMP_TEAMS_THREAD_LIMIT
Jonathan Peyton30419822017-05-12 18:01:32 +00007108 __kmp_msg(kmp_ms_warning,
7109 KMP_MSG(CantFormThrTeam, num_threads, new_threads),
7110 KMP_HNT(Unset_ALL_THREADS), __kmp_msg_null);
7111 }
7112 num_threads = new_threads;
7113 }
7114 }
7115 thr->th.th_teams_size.nth = num_threads;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007116}
7117
Jim Cownie5e8470a2013-09-27 10:38:44 +00007118// Set the proc_bind var to use in the following parallel region.
Jonathan Peyton30419822017-05-12 18:01:32 +00007119void __kmp_push_proc_bind(ident_t *id, int gtid, kmp_proc_bind_t proc_bind) {
7120 kmp_info_t *thr = __kmp_threads[gtid];
7121 thr->th.th_set_proc_bind = proc_bind;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007122}
7123
7124#endif /* OMP_40_ENABLED */
7125
7126/* Launch the worker threads into the microtask. */
7127
Jonathan Peyton30419822017-05-12 18:01:32 +00007128void __kmp_internal_fork(ident_t *id, int gtid, kmp_team_t *team) {
7129 kmp_info_t *this_thr = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00007130
7131#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00007132 int f;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007133#endif /* KMP_DEBUG */
7134
Jonathan Peyton30419822017-05-12 18:01:32 +00007135 KMP_DEBUG_ASSERT(team);
7136 KMP_DEBUG_ASSERT(this_thr->th.th_team == team);
7137 KMP_ASSERT(KMP_MASTER_GTID(gtid));
7138 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007139
Jonathan Peyton30419822017-05-12 18:01:32 +00007140 team->t.t_construct = 0; /* no single directives seen yet */
7141 team->t.t_ordered.dt.t_value =
7142 0; /* thread 0 enters the ordered section first */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007143
Jonathan Peyton30419822017-05-12 18:01:32 +00007144 /* Reset the identifiers on the dispatch buffer */
7145 KMP_DEBUG_ASSERT(team->t.t_disp_buffer);
7146 if (team->t.t_max_nproc > 1) {
7147 int i;
7148 for (i = 0; i < __kmp_dispatch_num_buffers; ++i) {
7149 team->t.t_disp_buffer[i].buffer_index = i;
Jonathan Peytondf6818b2016-06-14 17:57:47 +00007150#if OMP_45_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007151 team->t.t_disp_buffer[i].doacross_buf_idx = i;
Jonathan Peyton71909c52016-03-02 22:42:06 +00007152#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007153 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007154 } else {
7155 team->t.t_disp_buffer[0].buffer_index = 0;
7156#if OMP_45_ENABLED
7157 team->t.t_disp_buffer[0].doacross_buf_idx = 0;
7158#endif
7159 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007160
Jonathan Peyton30419822017-05-12 18:01:32 +00007161 KMP_MB(); /* Flush all pending memory write invalidates. */
7162 KMP_ASSERT(this_thr->th.th_team == team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007163
7164#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00007165 for (f = 0; f < team->t.t_nproc; f++) {
7166 KMP_DEBUG_ASSERT(team->t.t_threads[f] &&
7167 team->t.t_threads[f]->th.th_team_nproc == team->t.t_nproc);
7168 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007169#endif /* KMP_DEBUG */
7170
Jonathan Peyton30419822017-05-12 18:01:32 +00007171 /* release the worker threads so they may begin working */
7172 __kmp_fork_barrier(gtid, 0);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007173}
7174
Jonathan Peyton30419822017-05-12 18:01:32 +00007175void __kmp_internal_join(ident_t *id, int gtid, kmp_team_t *team) {
7176 kmp_info_t *this_thr = __kmp_threads[gtid];
Jim Cownie5e8470a2013-09-27 10:38:44 +00007177
Jonathan Peyton30419822017-05-12 18:01:32 +00007178 KMP_DEBUG_ASSERT(team);
7179 KMP_DEBUG_ASSERT(this_thr->th.th_team == team);
7180 KMP_ASSERT(KMP_MASTER_GTID(gtid));
7181 KMP_MB(); /* Flush all pending memory write invalidates. */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007182
Jonathan Peyton30419822017-05-12 18:01:32 +00007183/* Join barrier after fork */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007184
7185#ifdef KMP_DEBUG
Jonathan Peyton30419822017-05-12 18:01:32 +00007186 if (__kmp_threads[gtid] &&
7187 __kmp_threads[gtid]->th.th_team_nproc != team->t.t_nproc) {
7188 __kmp_printf("GTID: %d, __kmp_threads[%d]=%p\n", gtid, gtid,
7189 __kmp_threads[gtid]);
7190 __kmp_printf("__kmp_threads[%d]->th.th_team_nproc=%d, TEAM: %p, "
7191 "team->t.t_nproc=%d\n",
7192 gtid, __kmp_threads[gtid]->th.th_team_nproc, team,
7193 team->t.t_nproc);
7194 __kmp_print_structure();
7195 }
7196 KMP_DEBUG_ASSERT(__kmp_threads[gtid] &&
7197 __kmp_threads[gtid]->th.th_team_nproc == team->t.t_nproc);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007198#endif /* KMP_DEBUG */
7199
Jonathan Peyton30419822017-05-12 18:01:32 +00007200 __kmp_join_barrier(gtid); /* wait for everyone */
Joachim Protze82e94a52017-11-01 10:08:30 +00007201#if OMPT_SUPPORT
Jonas Hahnfeld82768d02018-02-23 16:46:25 +00007202 if (ompt_enabled.enabled &&
7203 this_thr->th.ompt_thread_info.state == omp_state_wait_barrier_implicit) {
7204 int ds_tid = this_thr->th.th_info.ds.ds_tid;
7205 ompt_data_t *task_data = OMPT_CUR_TASK_DATA(this_thr);
Joachim Protze82e94a52017-11-01 10:08:30 +00007206 this_thr->th.ompt_thread_info.state = omp_state_overhead;
7207#if OMPT_OPTIONAL
7208 void *codeptr = NULL;
7209 if (KMP_MASTER_TID(ds_tid) &&
7210 (ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait) ||
7211 ompt_callbacks.ompt_callback(ompt_callback_sync_region)))
7212 codeptr = OMPT_CUR_TEAM_INFO(this_thr)->master_return_address;
7213
7214 if (ompt_enabled.ompt_callback_sync_region_wait) {
7215 ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
Jonas Hahnfeld82768d02018-02-23 16:46:25 +00007216 ompt_sync_region_barrier, ompt_scope_end, NULL, task_data, codeptr);
Joachim Protze82e94a52017-11-01 10:08:30 +00007217 }
7218 if (ompt_enabled.ompt_callback_sync_region) {
7219 ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
Jonas Hahnfeld82768d02018-02-23 16:46:25 +00007220 ompt_sync_region_barrier, ompt_scope_end, NULL, task_data, codeptr);
Joachim Protze82e94a52017-11-01 10:08:30 +00007221 }
7222#endif
7223 if (!KMP_MASTER_TID(ds_tid) && ompt_enabled.ompt_callback_implicit_task) {
7224 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
Jonas Hahnfeld82768d02018-02-23 16:46:25 +00007225 ompt_scope_end, NULL, task_data, 0, ds_tid);
Joachim Protze82e94a52017-11-01 10:08:30 +00007226 }
Joachim Protze82e94a52017-11-01 10:08:30 +00007227 }
7228#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007229
Jonathan Peyton30419822017-05-12 18:01:32 +00007230 KMP_MB(); /* Flush all pending memory write invalidates. */
7231 KMP_ASSERT(this_thr->th.th_team == team);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007232}
7233
Jim Cownie5e8470a2013-09-27 10:38:44 +00007234/* ------------------------------------------------------------------------ */
7235
7236#ifdef USE_LOAD_BALANCE
7237
Jim Cownie5e8470a2013-09-27 10:38:44 +00007238// Return the worker threads actively spinning in the hot team, if we
7239// are at the outermost level of parallelism. Otherwise, return 0.
Jonathan Peyton30419822017-05-12 18:01:32 +00007240static int __kmp_active_hot_team_nproc(kmp_root_t *root) {
7241 int i;
7242 int retval;
7243 kmp_team_t *hot_team;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007244
Jonathan Peyton30419822017-05-12 18:01:32 +00007245 if (root->r.r_active) {
7246 return 0;
7247 }
7248 hot_team = root->r.r_hot_team;
7249 if (__kmp_dflt_blocktime == KMP_MAX_BLOCKTIME) {
7250 return hot_team->t.t_nproc - 1; // Don't count master thread
7251 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007252
Jonathan Peyton30419822017-05-12 18:01:32 +00007253 // Skip the master thread - it is accounted for elsewhere.
7254 retval = 0;
7255 for (i = 1; i < hot_team->t.t_nproc; i++) {
7256 if (hot_team->t.t_threads[i]->th.th_active) {
7257 retval++;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007258 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007259 }
7260 return retval;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007261}
7262
Jim Cownie5e8470a2013-09-27 10:38:44 +00007263// Perform an automatic adjustment to the number of
7264// threads used by the next parallel region.
Jonathan Peyton30419822017-05-12 18:01:32 +00007265static int __kmp_load_balance_nproc(kmp_root_t *root, int set_nproc) {
7266 int retval;
7267 int pool_active;
7268 int hot_team_active;
7269 int team_curr_active;
7270 int system_active;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007271
Jonathan Peyton30419822017-05-12 18:01:32 +00007272 KB_TRACE(20, ("__kmp_load_balance_nproc: called root:%p set_nproc:%d\n", root,
7273 set_nproc));
7274 KMP_DEBUG_ASSERT(root);
7275 KMP_DEBUG_ASSERT(root->r.r_root_team->t.t_threads[0]
7276 ->th.th_current_task->td_icvs.dynamic == TRUE);
7277 KMP_DEBUG_ASSERT(set_nproc > 1);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007278
Jonathan Peyton30419822017-05-12 18:01:32 +00007279 if (set_nproc == 1) {
7280 KB_TRACE(20, ("__kmp_load_balance_nproc: serial execution.\n"));
7281 return 1;
7282 }
7283
7284 // Threads that are active in the thread pool, active in the hot team for this
7285 // particular root (if we are at the outer par level), and the currently
7286 // executing thread (to become the master) are available to add to the new
7287 // team, but are currently contributing to the system load, and must be
7288 // accounted for.
Jonathan Peyton37e2ef52018-07-09 17:36:22 +00007289 pool_active = __kmp_thread_pool_active_nth;
Jonathan Peyton30419822017-05-12 18:01:32 +00007290 hot_team_active = __kmp_active_hot_team_nproc(root);
7291 team_curr_active = pool_active + hot_team_active + 1;
7292
7293 // Check the system load.
7294 system_active = __kmp_get_load_balance(__kmp_avail_proc + team_curr_active);
7295 KB_TRACE(30, ("__kmp_load_balance_nproc: system active = %d pool active = %d "
7296 "hot team active = %d\n",
7297 system_active, pool_active, hot_team_active));
7298
7299 if (system_active < 0) {
7300 // There was an error reading the necessary info from /proc, so use the
7301 // thread limit algorithm instead. Once we set __kmp_global.g.g_dynamic_mode
7302 // = dynamic_thread_limit, we shouldn't wind up getting back here.
7303 __kmp_global.g.g_dynamic_mode = dynamic_thread_limit;
7304 KMP_WARNING(CantLoadBalUsing, "KMP_DYNAMIC_MODE=thread limit");
7305
7306 // Make this call behave like the thread limit algorithm.
7307 retval = __kmp_avail_proc - __kmp_nth +
7308 (root->r.r_active ? 1 : root->r.r_hot_team->t.t_nproc);
7309 if (retval > set_nproc) {
7310 retval = set_nproc;
7311 }
7312 if (retval < KMP_MIN_NTH) {
7313 retval = KMP_MIN_NTH;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007314 }
7315
Jonathan Peyton30419822017-05-12 18:01:32 +00007316 KB_TRACE(20, ("__kmp_load_balance_nproc: thread limit exit. retval:%d\n",
7317 retval));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007318 return retval;
Jonathan Peyton30419822017-05-12 18:01:32 +00007319 }
7320
7321 // There is a slight delay in the load balance algorithm in detecting new
7322 // running procs. The real system load at this instant should be at least as
7323 // large as the #active omp thread that are available to add to the team.
7324 if (system_active < team_curr_active) {
7325 system_active = team_curr_active;
7326 }
7327 retval = __kmp_avail_proc - system_active + team_curr_active;
7328 if (retval > set_nproc) {
7329 retval = set_nproc;
7330 }
7331 if (retval < KMP_MIN_NTH) {
7332 retval = KMP_MIN_NTH;
7333 }
7334
7335 KB_TRACE(20, ("__kmp_load_balance_nproc: exit. retval:%d\n", retval));
7336 return retval;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007337} // __kmp_load_balance_nproc()
7338
7339#endif /* USE_LOAD_BALANCE */
7340
Jim Cownie5e8470a2013-09-27 10:38:44 +00007341/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007342
7343/* NOTE: this is called with the __kmp_init_lock held */
Jonathan Peyton30419822017-05-12 18:01:32 +00007344void __kmp_cleanup(void) {
7345 int f;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007346
Jonathan Peyton30419822017-05-12 18:01:32 +00007347 KA_TRACE(10, ("__kmp_cleanup: enter\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007348
Jonathan Peyton30419822017-05-12 18:01:32 +00007349 if (TCR_4(__kmp_init_parallel)) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00007350#if KMP_HANDLE_SIGNALS
Jonathan Peyton30419822017-05-12 18:01:32 +00007351 __kmp_remove_signals();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007352#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007353 TCW_4(__kmp_init_parallel, FALSE);
7354 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007355
Jonathan Peyton30419822017-05-12 18:01:32 +00007356 if (TCR_4(__kmp_init_middle)) {
Alp Toker763b9392014-02-28 09:42:41 +00007357#if KMP_AFFINITY_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00007358 __kmp_affinity_uninitialize();
Alp Toker763b9392014-02-28 09:42:41 +00007359#endif /* KMP_AFFINITY_SUPPORTED */
Jonathan Peyton30419822017-05-12 18:01:32 +00007360 __kmp_cleanup_hierarchy();
7361 TCW_4(__kmp_init_middle, FALSE);
7362 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007363
Jonathan Peyton30419822017-05-12 18:01:32 +00007364 KA_TRACE(10, ("__kmp_cleanup: go serial cleanup\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007365
Jonathan Peyton30419822017-05-12 18:01:32 +00007366 if (__kmp_init_serial) {
7367 __kmp_runtime_destroy();
7368 __kmp_init_serial = FALSE;
7369 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007370
Andrey Churbanov9e9333a2018-03-05 18:42:01 +00007371 __kmp_cleanup_threadprivate_caches();
7372
Jonathan Peyton30419822017-05-12 18:01:32 +00007373 for (f = 0; f < __kmp_threads_capacity; f++) {
7374 if (__kmp_root[f] != NULL) {
7375 __kmp_free(__kmp_root[f]);
7376 __kmp_root[f] = NULL;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007377 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007378 }
7379 __kmp_free(__kmp_threads);
7380 // __kmp_threads and __kmp_root were allocated at once, as single block, so
7381 // there is no need in freeing __kmp_root.
7382 __kmp_threads = NULL;
7383 __kmp_root = NULL;
7384 __kmp_threads_capacity = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007385
Andrey Churbanov5c56fb52015-02-20 18:05:17 +00007386#if KMP_USE_DYNAMIC_LOCK
Jonathan Peyton30419822017-05-12 18:01:32 +00007387 __kmp_cleanup_indirect_user_locks();
Andrey Churbanov5c56fb52015-02-20 18:05:17 +00007388#else
Jonathan Peyton30419822017-05-12 18:01:32 +00007389 __kmp_cleanup_user_locks();
Andrey Churbanov5c56fb52015-02-20 18:05:17 +00007390#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007391
Jonathan Peyton30419822017-05-12 18:01:32 +00007392#if KMP_AFFINITY_SUPPORTED
Andrey Churbanovc47afcd2017-07-03 11:24:08 +00007393 KMP_INTERNAL_FREE(CCAST(char *, __kmp_cpuinfo_file));
Jonathan Peyton30419822017-05-12 18:01:32 +00007394 __kmp_cpuinfo_file = NULL;
7395#endif /* KMP_AFFINITY_SUPPORTED */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007396
Jonathan Peyton30419822017-05-12 18:01:32 +00007397#if KMP_USE_ADAPTIVE_LOCKS
7398#if KMP_DEBUG_ADAPTIVE_LOCKS
7399 __kmp_print_speculative_stats();
7400#endif
7401#endif
7402 KMP_INTERNAL_FREE(__kmp_nested_nth.nth);
7403 __kmp_nested_nth.nth = NULL;
7404 __kmp_nested_nth.size = 0;
7405 __kmp_nested_nth.used = 0;
7406 KMP_INTERNAL_FREE(__kmp_nested_proc_bind.bind_types);
7407 __kmp_nested_proc_bind.bind_types = NULL;
7408 __kmp_nested_proc_bind.size = 0;
7409 __kmp_nested_proc_bind.used = 0;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007410
Jonathan Peyton30419822017-05-12 18:01:32 +00007411 __kmp_i18n_catclose();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007412
Jonathan Peytonf6399362018-07-09 17:51:13 +00007413#if KMP_USE_HIER_SCHED
7414 __kmp_hier_scheds.deallocate();
7415#endif
7416
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007417#if KMP_STATS_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007418 __kmp_stats_fini();
Jim Cownie4cc4bb42014-10-07 16:25:50 +00007419#endif
7420
Jonathan Peyton30419822017-05-12 18:01:32 +00007421 KA_TRACE(10, ("__kmp_cleanup: exit\n"));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007422}
7423
7424/* ------------------------------------------------------------------------ */
Jonathan Peyton30419822017-05-12 18:01:32 +00007425
7426int __kmp_ignore_mppbeg(void) {
7427 char *env;
7428
7429 if ((env = getenv("KMP_IGNORE_MPPBEG")) != NULL) {
7430 if (__kmp_str_match_false(env))
7431 return FALSE;
7432 }
7433 // By default __kmpc_begin() is no-op.
7434 return TRUE;
7435}
7436
7437int __kmp_ignore_mppend(void) {
7438 char *env;
7439
7440 if ((env = getenv("KMP_IGNORE_MPPEND")) != NULL) {
7441 if (__kmp_str_match_false(env))
7442 return FALSE;
7443 }
7444 // By default __kmpc_end() is no-op.
7445 return TRUE;
7446}
7447
7448void __kmp_internal_begin(void) {
7449 int gtid;
7450 kmp_root_t *root;
7451
7452 /* this is a very important step as it will register new sibling threads
7453 and assign these new uber threads a new gtid */
7454 gtid = __kmp_entry_gtid();
7455 root = __kmp_threads[gtid]->th.th_root;
7456 KMP_ASSERT(KMP_UBER_GTID(gtid));
7457
7458 if (root->r.r_begin)
7459 return;
7460 __kmp_acquire_lock(&root->r.r_begin_lock, gtid);
7461 if (root->r.r_begin) {
7462 __kmp_release_lock(&root->r.r_begin_lock, gtid);
7463 return;
7464 }
7465
7466 root->r.r_begin = TRUE;
7467
7468 __kmp_release_lock(&root->r.r_begin_lock, gtid);
7469}
7470
Jim Cownie5e8470a2013-09-27 10:38:44 +00007471/* ------------------------------------------------------------------------ */
7472
Jonathan Peyton30419822017-05-12 18:01:32 +00007473void __kmp_user_set_library(enum library_type arg) {
7474 int gtid;
7475 kmp_root_t *root;
7476 kmp_info_t *thread;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007477
Jonathan Peyton30419822017-05-12 18:01:32 +00007478 /* first, make sure we are initialized so we can get our gtid */
7479
7480 gtid = __kmp_entry_gtid();
7481 thread = __kmp_threads[gtid];
7482
7483 root = thread->th.th_root;
7484
7485 KA_TRACE(20, ("__kmp_user_set_library: enter T#%d, arg: %d, %d\n", gtid, arg,
7486 library_serial));
7487 if (root->r.r_in_parallel) { /* Must be called in serial section of top-level
7488 thread */
7489 KMP_WARNING(SetLibraryIncorrectCall);
7490 return;
7491 }
7492
7493 switch (arg) {
7494 case library_serial:
7495 thread->th.th_set_nproc = 0;
7496 set__nproc(thread, 1);
7497 break;
7498 case library_turnaround:
7499 thread->th.th_set_nproc = 0;
7500 set__nproc(thread, __kmp_dflt_team_nth ? __kmp_dflt_team_nth
7501 : __kmp_dflt_team_nth_ub);
7502 break;
7503 case library_throughput:
7504 thread->th.th_set_nproc = 0;
7505 set__nproc(thread, __kmp_dflt_team_nth ? __kmp_dflt_team_nth
7506 : __kmp_dflt_team_nth_ub);
7507 break;
7508 default:
7509 KMP_FATAL(UnknownLibraryType, arg);
7510 }
7511
7512 __kmp_aux_set_library(arg);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007513}
7514
Jonathan Peyton30419822017-05-12 18:01:32 +00007515void __kmp_aux_set_stacksize(size_t arg) {
7516 if (!__kmp_init_serial)
7517 __kmp_serial_initialize();
Jim Cownie5e8470a2013-09-27 10:38:44 +00007518
7519#if KMP_OS_DARWIN
Jonathan Peyton30419822017-05-12 18:01:32 +00007520 if (arg & (0x1000 - 1)) {
7521 arg &= ~(0x1000 - 1);
7522 if (arg + 0x1000) /* check for overflow if we round up */
7523 arg += 0x1000;
7524 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007525#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007526 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007527
Jonathan Peyton30419822017-05-12 18:01:32 +00007528 /* only change the default stacksize before the first parallel region */
7529 if (!TCR_4(__kmp_init_parallel)) {
7530 size_t value = arg; /* argument is in bytes */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007531
Jonathan Peyton30419822017-05-12 18:01:32 +00007532 if (value < __kmp_sys_min_stksize)
7533 value = __kmp_sys_min_stksize;
7534 else if (value > KMP_MAX_STKSIZE)
7535 value = KMP_MAX_STKSIZE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007536
Jonathan Peyton30419822017-05-12 18:01:32 +00007537 __kmp_stksize = value;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007538
Jonathan Peyton30419822017-05-12 18:01:32 +00007539 __kmp_env_stksize = TRUE; /* was KMP_STACKSIZE specified? */
7540 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007541
Jonathan Peyton30419822017-05-12 18:01:32 +00007542 __kmp_release_bootstrap_lock(&__kmp_initz_lock);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007543}
7544
7545/* set the behaviour of the runtime library */
7546/* TODO this can cause some odd behaviour with sibling parallelism... */
Jonathan Peyton30419822017-05-12 18:01:32 +00007547void __kmp_aux_set_library(enum library_type arg) {
7548 __kmp_library = arg;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007549
Jonathan Peyton30419822017-05-12 18:01:32 +00007550 switch (__kmp_library) {
7551 case library_serial: {
7552 KMP_INFORM(LibraryIsSerial);
7553 (void)__kmp_change_library(TRUE);
7554 } break;
7555 case library_turnaround:
7556 (void)__kmp_change_library(TRUE);
7557 break;
7558 case library_throughput:
7559 (void)__kmp_change_library(FALSE);
7560 break;
7561 default:
7562 KMP_FATAL(UnknownLibraryType, arg);
7563 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007564}
7565
7566/* ------------------------------------------------------------------------ */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007567
Jonathan Peyton30419822017-05-12 18:01:32 +00007568void __kmp_aux_set_blocktime(int arg, kmp_info_t *thread, int tid) {
7569 int blocktime = arg; /* argument is in milliseconds */
Jonathan Peytone1c7c132016-10-07 18:12:19 +00007570#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00007571 int bt_intervals;
Jonathan Peytone1c7c132016-10-07 18:12:19 +00007572#endif
Jonathan Peyton30419822017-05-12 18:01:32 +00007573 int bt_set;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007574
Jonathan Peyton30419822017-05-12 18:01:32 +00007575 __kmp_save_internal_controls(thread);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007576
Jonathan Peyton30419822017-05-12 18:01:32 +00007577 /* Normalize and set blocktime for the teams */
7578 if (blocktime < KMP_MIN_BLOCKTIME)
7579 blocktime = KMP_MIN_BLOCKTIME;
7580 else if (blocktime > KMP_MAX_BLOCKTIME)
7581 blocktime = KMP_MAX_BLOCKTIME;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007582
Jonathan Peyton30419822017-05-12 18:01:32 +00007583 set__blocktime_team(thread->th.th_team, tid, blocktime);
7584 set__blocktime_team(thread->th.th_serial_team, 0, blocktime);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007585
Jonathan Peytone1c7c132016-10-07 18:12:19 +00007586#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00007587 /* Calculate and set blocktime intervals for the teams */
7588 bt_intervals = KMP_INTERVALS_FROM_BLOCKTIME(blocktime, __kmp_monitor_wakeups);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007589
Jonathan Peyton30419822017-05-12 18:01:32 +00007590 set__bt_intervals_team(thread->th.th_team, tid, bt_intervals);
7591 set__bt_intervals_team(thread->th.th_serial_team, 0, bt_intervals);
Jonathan Peytone1c7c132016-10-07 18:12:19 +00007592#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007593
Jonathan Peyton30419822017-05-12 18:01:32 +00007594 /* Set whether blocktime has been set to "TRUE" */
7595 bt_set = TRUE;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007596
Jonathan Peyton30419822017-05-12 18:01:32 +00007597 set__bt_set_team(thread->th.th_team, tid, bt_set);
7598 set__bt_set_team(thread->th.th_serial_team, 0, bt_set);
Jonathan Peytone1c7c132016-10-07 18:12:19 +00007599#if KMP_USE_MONITOR
Jonathan Peyton30419822017-05-12 18:01:32 +00007600 KF_TRACE(10, ("kmp_set_blocktime: T#%d(%d:%d), blocktime=%d, "
7601 "bt_intervals=%d, monitor_updates=%d\n",
7602 __kmp_gtid_from_tid(tid, thread->th.th_team),
7603 thread->th.th_team->t.t_id, tid, blocktime, bt_intervals,
7604 __kmp_monitor_wakeups));
Samuel Antao33515192016-10-20 13:20:17 +00007605#else
Jonathan Peyton30419822017-05-12 18:01:32 +00007606 KF_TRACE(10, ("kmp_set_blocktime: T#%d(%d:%d), blocktime=%d\n",
7607 __kmp_gtid_from_tid(tid, thread->th.th_team),
7608 thread->th.th_team->t.t_id, tid, blocktime));
Jonathan Peytone1c7c132016-10-07 18:12:19 +00007609#endif
Jim Cownie5e8470a2013-09-27 10:38:44 +00007610}
7611
Jonathan Peyton30419822017-05-12 18:01:32 +00007612void __kmp_aux_set_defaults(char const *str, int len) {
7613 if (!__kmp_init_serial) {
7614 __kmp_serial_initialize();
Jonathan Peytonbd3a7632017-09-27 20:36:27 +00007615 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007616 __kmp_env_initialize(str);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007617
Jonathan Peyton30419822017-05-12 18:01:32 +00007618 if (__kmp_settings
Jim Cownie5e8470a2013-09-27 10:38:44 +00007619#if OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007620 || __kmp_display_env || __kmp_display_env_verbose
Jim Cownie5e8470a2013-09-27 10:38:44 +00007621#endif // OMP_40_ENABLED
Jonathan Peyton30419822017-05-12 18:01:32 +00007622 ) {
7623 __kmp_env_print();
7624 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007625} // __kmp_aux_set_defaults
7626
7627/* ------------------------------------------------------------------------ */
Jonathan Peyton30419822017-05-12 18:01:32 +00007628/* internal fast reduction routines */
Jim Cownie5e8470a2013-09-27 10:38:44 +00007629
Jim Cownie5e8470a2013-09-27 10:38:44 +00007630PACKED_REDUCTION_METHOD_T
Jonathan Peyton30419822017-05-12 18:01:32 +00007631__kmp_determine_reduction_method(
7632 ident_t *loc, kmp_int32 global_tid, kmp_int32 num_vars, size_t reduce_size,
7633 void *reduce_data, void (*reduce_func)(void *lhs_data, void *rhs_data),
7634 kmp_critical_name *lck) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00007635
Jonathan Peyton30419822017-05-12 18:01:32 +00007636 // Default reduction method: critical construct ( lck != NULL, like in current
7637 // PAROPT )
7638 // If ( reduce_data!=NULL && reduce_func!=NULL ): the tree-reduction method
7639 // can be selected by RTL
7640 // If loc->flags contains KMP_IDENT_ATOMIC_REDUCE, the atomic reduce method
7641 // can be selected by RTL
7642 // Finally, it's up to OpenMP RTL to make a decision on which method to select
7643 // among generated by PAROPT.
Jim Cownie5e8470a2013-09-27 10:38:44 +00007644
Jonathan Peyton30419822017-05-12 18:01:32 +00007645 PACKED_REDUCTION_METHOD_T retval;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007646
Jonathan Peyton30419822017-05-12 18:01:32 +00007647 int team_size;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007648
Jonathan Peyton30419822017-05-12 18:01:32 +00007649 KMP_DEBUG_ASSERT(loc); // it would be nice to test ( loc != 0 )
7650 KMP_DEBUG_ASSERT(lck); // it would be nice to test ( lck != 0 )
Jim Cownie5e8470a2013-09-27 10:38:44 +00007651
Jonathan Peyton30419822017-05-12 18:01:32 +00007652#define FAST_REDUCTION_ATOMIC_METHOD_GENERATED \
7653 ((loc->flags & (KMP_IDENT_ATOMIC_REDUCE)) == (KMP_IDENT_ATOMIC_REDUCE))
7654#define FAST_REDUCTION_TREE_METHOD_GENERATED ((reduce_data) && (reduce_func))
Jim Cownie5e8470a2013-09-27 10:38:44 +00007655
Jonathan Peyton30419822017-05-12 18:01:32 +00007656 retval = critical_reduce_block;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007657
Jonathan Peyton30419822017-05-12 18:01:32 +00007658 // another choice of getting a team size (with 1 dynamic deference) is slower
7659 team_size = __kmp_get_team_num_threads(global_tid);
7660 if (team_size == 1) {
Jim Cownie5e8470a2013-09-27 10:38:44 +00007661
Jonathan Peyton30419822017-05-12 18:01:32 +00007662 retval = empty_reduce_block;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007663
Jonathan Peyton30419822017-05-12 18:01:32 +00007664 } else {
Jim Cownie5e8470a2013-09-27 10:38:44 +00007665
Jonathan Peyton30419822017-05-12 18:01:32 +00007666 int atomic_available = FAST_REDUCTION_ATOMIC_METHOD_GENERATED;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007667
Jonathan Peyton30419822017-05-12 18:01:32 +00007668#if KMP_ARCH_X86_64 || KMP_ARCH_PPC64 || KMP_ARCH_AARCH64 || KMP_ARCH_MIPS64
Jim Cownie5e8470a2013-09-27 10:38:44 +00007669
Jonathan Peyton30419822017-05-12 18:01:32 +00007670#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_WINDOWS || \
7671 KMP_OS_DARWIN
Jim Cownie5e8470a2013-09-27 10:38:44 +00007672
Jonathan Peyton30419822017-05-12 18:01:32 +00007673 int teamsize_cutoff = 4;
Jonathan Peyton91b78702015-06-08 19:39:07 +00007674
Jonathan Peyton492e0a32017-06-13 17:17:26 +00007675#if KMP_MIC_SUPPORTED
Jonathan Peyton30419822017-05-12 18:01:32 +00007676 if (__kmp_mic_type != non_mic) {
7677 teamsize_cutoff = 8;
7678 }
Andrey Churbanov613edeb2015-02-20 18:14:43 +00007679#endif
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00007680 int tree_available = FAST_REDUCTION_TREE_METHOD_GENERATED;
Jonathan Peyton30419822017-05-12 18:01:32 +00007681 if (tree_available) {
7682 if (team_size <= teamsize_cutoff) {
7683 if (atomic_available) {
7684 retval = atomic_reduce_block;
Jim Cownie5e8470a2013-09-27 10:38:44 +00007685 }
Jonathan Peyton30419822017-05-12 18:01:32 +00007686 } else {
7687 retval = TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER;
7688 }
7689 } else if (atomic_available) {
7690 retval = atomic_reduce_block;
7691 }
7692#else
7693#error "Unknown or unsupported OS"
7694#endif // KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_WINDOWS ||
7695// KMP_OS_DARWIN
Jim Cownie5e8470a2013-09-27 10:38:44 +00007696
Jonathan Peyton30419822017-05-12 18:01:32 +00007697#elif KMP_ARCH_X86 || KMP_ARCH_ARM || KMP_ARCH_AARCH || KMP_ARCH_MIPS
7698
7699#if KMP_OS_LINUX || KMP_OS_WINDOWS
7700
7701 // basic tuning
7702
7703 if (atomic_available) {
7704 if (num_vars <= 2) { // && ( team_size <= 8 ) due to false-sharing ???
7705 retval = atomic_reduce_block;
7706 }
7707 } // otherwise: use critical section
7708
7709#elif KMP_OS_DARWIN
7710
Jonathan Peytonbaad3f62018-08-09 22:04:30 +00007711 int tree_available = FAST_REDUCTION_TREE_METHOD_GENERATED;
Jonathan Peyton30419822017-05-12 18:01:32 +00007712 if (atomic_available && (num_vars <= 3)) {
7713 retval = atomic_reduce_block;
7714 } else if (tree_available) {
7715 if ((reduce_size > (9 * sizeof(kmp_real64))) &&
7716 (reduce_size < (2000 * sizeof(kmp_real64)))) {
7717 retval = TREE_REDUCE_BLOCK_WITH_PLAIN_BARRIER;
7718 }
7719 } // otherwise: use critical section
7720
7721#else
7722#error "Unknown or unsupported OS"
7723#endif
7724
7725#else
7726#error "Unknown or unsupported architecture"
7727#endif
7728 }
7729
7730 // KMP_FORCE_REDUCTION
7731
7732 // If the team is serialized (team_size == 1), ignore the forced reduction
7733 // method and stay with the unsynchronized method (empty_reduce_block)
7734 if (__kmp_force_reduction_method != reduction_method_not_defined &&
7735 team_size != 1) {
7736
7737 PACKED_REDUCTION_METHOD_T forced_retval = critical_reduce_block;
7738
7739 int atomic_available, tree_available;
7740
7741 switch ((forced_retval = __kmp_force_reduction_method)) {
7742 case critical_reduce_block:
7743 KMP_ASSERT(lck); // lck should be != 0
7744 break;
7745
7746 case atomic_reduce_block:
7747 atomic_available = FAST_REDUCTION_ATOMIC_METHOD_GENERATED;
7748 if (!atomic_available) {
7749 KMP_WARNING(RedMethodNotSupported, "atomic");
7750 forced_retval = critical_reduce_block;
7751 }
7752 break;
7753
7754 case tree_reduce_block:
7755 tree_available = FAST_REDUCTION_TREE_METHOD_GENERATED;
7756 if (!tree_available) {
7757 KMP_WARNING(RedMethodNotSupported, "tree");
7758 forced_retval = critical_reduce_block;
7759 } else {
7760#if KMP_FAST_REDUCTION_BARRIER
7761 forced_retval = TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER;
7762#endif
7763 }
7764 break;
7765
7766 default:
7767 KMP_ASSERT(0); // "unsupported method specified"
Jim Cownie5e8470a2013-09-27 10:38:44 +00007768 }
7769
Jonathan Peyton30419822017-05-12 18:01:32 +00007770 retval = forced_retval;
7771 }
Jim Cownie5e8470a2013-09-27 10:38:44 +00007772
Jonathan Peyton30419822017-05-12 18:01:32 +00007773 KA_TRACE(10, ("reduction method selected=%08x\n", retval));
Jim Cownie5e8470a2013-09-27 10:38:44 +00007774
Jonathan Peyton30419822017-05-12 18:01:32 +00007775#undef FAST_REDUCTION_TREE_METHOD_GENERATED
7776#undef FAST_REDUCTION_ATOMIC_METHOD_GENERATED
7777
7778 return (retval);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007779}
7780
7781// this function is for testing set/get/determine reduce method
Jonathan Peyton30419822017-05-12 18:01:32 +00007782kmp_int32 __kmp_get_reduce_method(void) {
7783 return ((__kmp_entry_thread()->th.th_local.packed_reduction_method) >> 8);
Jim Cownie5e8470a2013-09-27 10:38:44 +00007784}