17cc577a4SJonathan Peyton /*
2de4749b7SJonathan Peyton  * kmp_tasking.cpp -- OpenMP 3.0 tasking support.
37cc577a4SJonathan Peyton  */
47cc577a4SJonathan Peyton 
57cc577a4SJonathan Peyton //===----------------------------------------------------------------------===//
67cc577a4SJonathan Peyton //
757b08b09SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
857b08b09SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
957b08b09SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
107cc577a4SJonathan Peyton //
117cc577a4SJonathan Peyton //===----------------------------------------------------------------------===//
127cc577a4SJonathan Peyton 
137cc577a4SJonathan Peyton #include "kmp.h"
147cc577a4SJonathan Peyton #include "kmp_i18n.h"
157cc577a4SJonathan Peyton #include "kmp_itt.h"
167cc577a4SJonathan Peyton #include "kmp_stats.h"
173041982dSJonathan Peyton #include "kmp_wait_release.h"
18cf27e31bSJonathan Peyton #include "kmp_taskdeps.h"
197cc577a4SJonathan Peyton 
207cc577a4SJonathan Peyton #if OMPT_SUPPORT
217cc577a4SJonathan Peyton #include "ompt-specific.h"
227cc577a4SJonathan Peyton #endif
237cc577a4SJonathan Peyton 
247cc577a4SJonathan Peyton #include "tsan_annotations.h"
257cc577a4SJonathan Peyton 
267cc577a4SJonathan Peyton /* forward declaration */
273041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
283041982dSJonathan Peyton                                  kmp_info_t *this_thr);
293041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
303041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data);
313041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
323041982dSJonathan Peyton                                            kmp_task_team_t *task_team);
337cc577a4SJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask);
347cc577a4SJonathan Peyton 
357cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
367cc577a4SJonathan Peyton 
377cc577a4SJonathan Peyton //  __kmp_trace_task_stack: print the tied tasks from the task stack in order
387cc577a4SJonathan Peyton //  from top do bottom
397cc577a4SJonathan Peyton //
407cc577a4SJonathan Peyton //  gtid: global thread identifier for thread containing stack
417cc577a4SJonathan Peyton //  thread_data: thread data for task team thread containing stack
427cc577a4SJonathan Peyton //  threshold: value above which the trace statement triggers
437cc577a4SJonathan Peyton //  location: string identifying call site of this function (for trace)
443041982dSJonathan Peyton static void __kmp_trace_task_stack(kmp_int32 gtid,
453041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data,
463041982dSJonathan Peyton                                    int threshold, char *location) {
477cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
487cc577a4SJonathan Peyton   kmp_taskdata_t **stack_top = task_stack->ts_top;
497cc577a4SJonathan Peyton   kmp_int32 entries = task_stack->ts_entries;
507cc577a4SJonathan Peyton   kmp_taskdata_t *tied_task;
517cc577a4SJonathan Peyton 
523041982dSJonathan Peyton   KA_TRACE(
533041982dSJonathan Peyton       threshold,
543041982dSJonathan Peyton       ("__kmp_trace_task_stack(start): location = %s, gtid = %d, entries = %d, "
557cc577a4SJonathan Peyton        "first_block = %p, stack_top = %p \n",
567cc577a4SJonathan Peyton        location, gtid, entries, task_stack->ts_first_block, stack_top));
577cc577a4SJonathan Peyton 
587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(stack_top != NULL);
597cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(entries > 0);
607cc577a4SJonathan Peyton 
613041982dSJonathan Peyton   while (entries != 0) {
627cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(stack_top != &task_stack->ts_first_block.sb_block[0]);
637cc577a4SJonathan Peyton     // fix up ts_top if we need to pop from previous block
643041982dSJonathan Peyton     if (entries & TASK_STACK_INDEX_MASK == 0) {
657cc577a4SJonathan Peyton       kmp_stack_block_t *stack_block = (kmp_stack_block_t *)(stack_top);
667cc577a4SJonathan Peyton 
677cc577a4SJonathan Peyton       stack_block = stack_block->sb_prev;
687cc577a4SJonathan Peyton       stack_top = &stack_block->sb_block[TASK_STACK_BLOCK_SIZE];
697cc577a4SJonathan Peyton     }
707cc577a4SJonathan Peyton 
717cc577a4SJonathan Peyton     // finish bookkeeping
727cc577a4SJonathan Peyton     stack_top--;
737cc577a4SJonathan Peyton     entries--;
747cc577a4SJonathan Peyton 
757cc577a4SJonathan Peyton     tied_task = *stack_top;
767cc577a4SJonathan Peyton 
777cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(tied_task != NULL);
787cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
797cc577a4SJonathan Peyton 
803041982dSJonathan Peyton     KA_TRACE(threshold,
813041982dSJonathan Peyton              ("__kmp_trace_task_stack(%s):             gtid=%d, entry=%d, "
827cc577a4SJonathan Peyton               "stack_top=%p, tied_task=%p\n",
837cc577a4SJonathan Peyton               location, gtid, entries, stack_top, tied_task));
847cc577a4SJonathan Peyton   }
857cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(stack_top == &task_stack->ts_first_block.sb_block[0]);
867cc577a4SJonathan Peyton 
873041982dSJonathan Peyton   KA_TRACE(threshold,
883041982dSJonathan Peyton            ("__kmp_trace_task_stack(exit): location = %s, gtid = %d\n",
897cc577a4SJonathan Peyton             location, gtid));
907cc577a4SJonathan Peyton }
917cc577a4SJonathan Peyton 
927cc577a4SJonathan Peyton //  __kmp_init_task_stack: initialize the task stack for the first time
937cc577a4SJonathan Peyton //  after a thread_data structure is created.
947cc577a4SJonathan Peyton //  It should not be necessary to do this again (assuming the stack works).
957cc577a4SJonathan Peyton //
967cc577a4SJonathan Peyton //  gtid: global thread identifier of calling thread
977cc577a4SJonathan Peyton //  thread_data: thread data for task team thread containing stack
983041982dSJonathan Peyton static void __kmp_init_task_stack(kmp_int32 gtid,
993041982dSJonathan Peyton                                   kmp_thread_data_t *thread_data) {
1007cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1017cc577a4SJonathan Peyton   kmp_stack_block_t *first_block;
1027cc577a4SJonathan Peyton 
1037cc577a4SJonathan Peyton   // set up the first block of the stack
1047cc577a4SJonathan Peyton   first_block = &task_stack->ts_first_block;
1057cc577a4SJonathan Peyton   task_stack->ts_top = (kmp_taskdata_t **)first_block;
1063041982dSJonathan Peyton   memset((void *)first_block, '\0',
1073041982dSJonathan Peyton          TASK_STACK_BLOCK_SIZE * sizeof(kmp_taskdata_t *));
1087cc577a4SJonathan Peyton 
1097cc577a4SJonathan Peyton   // initialize the stack to be empty
1107cc577a4SJonathan Peyton   task_stack->ts_entries = TASK_STACK_EMPTY;
1117cc577a4SJonathan Peyton   first_block->sb_next = NULL;
1127cc577a4SJonathan Peyton   first_block->sb_prev = NULL;
1137cc577a4SJonathan Peyton }
1147cc577a4SJonathan Peyton 
1157cc577a4SJonathan Peyton //  __kmp_free_task_stack: free the task stack when thread_data is destroyed.
1167cc577a4SJonathan Peyton //
1177cc577a4SJonathan Peyton //  gtid: global thread identifier for calling thread
1187cc577a4SJonathan Peyton //  thread_data: thread info for thread containing stack
1193041982dSJonathan Peyton static void __kmp_free_task_stack(kmp_int32 gtid,
1203041982dSJonathan Peyton                                   kmp_thread_data_t *thread_data) {
1217cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1227cc577a4SJonathan Peyton   kmp_stack_block_t *stack_block = &task_stack->ts_first_block;
1237cc577a4SJonathan Peyton 
1247cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_entries == TASK_STACK_EMPTY);
1257cc577a4SJonathan Peyton   // free from the second block of the stack
1267cc577a4SJonathan Peyton   while (stack_block != NULL) {
1277cc577a4SJonathan Peyton     kmp_stack_block_t *next_block = (stack_block) ? stack_block->sb_next : NULL;
1287cc577a4SJonathan Peyton 
1297cc577a4SJonathan Peyton     stack_block->sb_next = NULL;
1307cc577a4SJonathan Peyton     stack_block->sb_prev = NULL;
1317cc577a4SJonathan Peyton     if (stack_block != &task_stack->ts_first_block) {
1323041982dSJonathan Peyton       __kmp_thread_free(thread,
1333041982dSJonathan Peyton                         stack_block); // free the block, if not the first
1347cc577a4SJonathan Peyton     }
1357cc577a4SJonathan Peyton     stack_block = next_block;
1367cc577a4SJonathan Peyton   }
1377cc577a4SJonathan Peyton   // initialize the stack to be empty
1387cc577a4SJonathan Peyton   task_stack->ts_entries = 0;
1397cc577a4SJonathan Peyton   task_stack->ts_top = NULL;
1407cc577a4SJonathan Peyton }
1417cc577a4SJonathan Peyton 
1427cc577a4SJonathan Peyton //  __kmp_push_task_stack: Push the tied task onto the task stack.
1437cc577a4SJonathan Peyton //     Grow the stack if necessary by allocating another block.
1447cc577a4SJonathan Peyton //
1457cc577a4SJonathan Peyton //  gtid: global thread identifier for calling thread
1467cc577a4SJonathan Peyton //  thread: thread info for thread containing stack
1477cc577a4SJonathan Peyton //  tied_task: the task to push on the stack
1483041982dSJonathan Peyton static void __kmp_push_task_stack(kmp_int32 gtid, kmp_info_t *thread,
1493041982dSJonathan Peyton                                   kmp_taskdata_t *tied_task) {
1507cc577a4SJonathan Peyton   // GEH - need to consider what to do if tt_threads_data not allocated yet
1513041982dSJonathan Peyton   kmp_thread_data_t *thread_data =
1523041982dSJonathan Peyton       &thread->th.th_task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
1537cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1547cc577a4SJonathan Peyton 
1557cc577a4SJonathan Peyton   if (tied_task->td_flags.team_serial || tied_task->td_flags.tasking_ser) {
1567cc577a4SJonathan Peyton     return; // Don't push anything on stack if team or team tasks are serialized
1577cc577a4SJonathan Peyton   }
1587cc577a4SJonathan Peyton 
1597cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
1607cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_top != NULL);
1617cc577a4SJonathan Peyton 
1623041982dSJonathan Peyton   KA_TRACE(20,
1633041982dSJonathan Peyton            ("__kmp_push_task_stack(enter): GTID: %d; THREAD: %p; TASK: %p\n",
1647cc577a4SJonathan Peyton             gtid, thread, tied_task));
1657cc577a4SJonathan Peyton   // Store entry
1667cc577a4SJonathan Peyton   *(task_stack->ts_top) = tied_task;
1677cc577a4SJonathan Peyton 
1687cc577a4SJonathan Peyton   // Do bookkeeping for next push
1697cc577a4SJonathan Peyton   task_stack->ts_top++;
1707cc577a4SJonathan Peyton   task_stack->ts_entries++;
1717cc577a4SJonathan Peyton 
1723041982dSJonathan Peyton   if (task_stack->ts_entries & TASK_STACK_INDEX_MASK == 0) {
1737cc577a4SJonathan Peyton     // Find beginning of this task block
1747cc577a4SJonathan Peyton     kmp_stack_block_t *stack_block =
1757cc577a4SJonathan Peyton         (kmp_stack_block_t *)(task_stack->ts_top - TASK_STACK_BLOCK_SIZE);
1767cc577a4SJonathan Peyton 
1777cc577a4SJonathan Peyton     // Check if we already have a block
1783041982dSJonathan Peyton     if (stack_block->sb_next !=
1793041982dSJonathan Peyton         NULL) { // reset ts_top to beginning of next block
1807cc577a4SJonathan Peyton       task_stack->ts_top = &stack_block->sb_next->sb_block[0];
1813041982dSJonathan Peyton     } else { // Alloc new block and link it up
1823041982dSJonathan Peyton       kmp_stack_block_t *new_block = (kmp_stack_block_t *)__kmp_thread_calloc(
1833041982dSJonathan Peyton           thread, sizeof(kmp_stack_block_t));
1847cc577a4SJonathan Peyton 
1857cc577a4SJonathan Peyton       task_stack->ts_top = &new_block->sb_block[0];
1867cc577a4SJonathan Peyton       stack_block->sb_next = new_block;
1877cc577a4SJonathan Peyton       new_block->sb_prev = stack_block;
1887cc577a4SJonathan Peyton       new_block->sb_next = NULL;
1897cc577a4SJonathan Peyton 
1903041982dSJonathan Peyton       KA_TRACE(
1913041982dSJonathan Peyton           30,
1923041982dSJonathan Peyton           ("__kmp_push_task_stack(): GTID: %d; TASK: %p; Alloc new block: %p\n",
1937cc577a4SJonathan Peyton            gtid, tied_task, new_block));
1947cc577a4SJonathan Peyton     }
1957cc577a4SJonathan Peyton   }
1963041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_push_task_stack(exit): GTID: %d; TASK: %p\n", gtid,
1973041982dSJonathan Peyton                 tied_task));
1987cc577a4SJonathan Peyton }
1997cc577a4SJonathan Peyton 
2007cc577a4SJonathan Peyton //  __kmp_pop_task_stack: Pop the tied task from the task stack.  Don't return
2017cc577a4SJonathan Peyton //  the task, just check to make sure it matches the ending task passed in.
2027cc577a4SJonathan Peyton //
2037cc577a4SJonathan Peyton //  gtid: global thread identifier for the calling thread
2047cc577a4SJonathan Peyton //  thread: thread info structure containing stack
2057cc577a4SJonathan Peyton //  tied_task: the task popped off the stack
2067cc577a4SJonathan Peyton //  ending_task: the task that is ending (should match popped task)
2073041982dSJonathan Peyton static void __kmp_pop_task_stack(kmp_int32 gtid, kmp_info_t *thread,
2083041982dSJonathan Peyton                                  kmp_taskdata_t *ending_task) {
2097cc577a4SJonathan Peyton   // GEH - need to consider what to do if tt_threads_data not allocated yet
2103041982dSJonathan Peyton   kmp_thread_data_t *thread_data =
2113041982dSJonathan Peyton       &thread->th.th_task_team->tt_threads_data[__kmp_tid_from_gtid(gtid)];
2127cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
2137cc577a4SJonathan Peyton   kmp_taskdata_t *tied_task;
2147cc577a4SJonathan Peyton 
2157cc577a4SJonathan Peyton   if (ending_task->td_flags.team_serial || ending_task->td_flags.tasking_ser) {
2163041982dSJonathan Peyton     // Don't pop anything from stack if team or team tasks are serialized
2173041982dSJonathan Peyton     return;
2187cc577a4SJonathan Peyton   }
2197cc577a4SJonathan Peyton 
2207cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_top != NULL);
2217cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_entries > 0);
2227cc577a4SJonathan Peyton 
2233041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_pop_task_stack(enter): GTID: %d; THREAD: %p\n", gtid,
2243041982dSJonathan Peyton                 thread));
2257cc577a4SJonathan Peyton 
2267cc577a4SJonathan Peyton   // fix up ts_top if we need to pop from previous block
2273041982dSJonathan Peyton   if (task_stack->ts_entries & TASK_STACK_INDEX_MASK == 0) {
2283041982dSJonathan Peyton     kmp_stack_block_t *stack_block = (kmp_stack_block_t *)(task_stack->ts_top);
2297cc577a4SJonathan Peyton 
2307cc577a4SJonathan Peyton     stack_block = stack_block->sb_prev;
2317cc577a4SJonathan Peyton     task_stack->ts_top = &stack_block->sb_block[TASK_STACK_BLOCK_SIZE];
2327cc577a4SJonathan Peyton   }
2337cc577a4SJonathan Peyton 
2347cc577a4SJonathan Peyton   // finish bookkeeping
2357cc577a4SJonathan Peyton   task_stack->ts_top--;
2367cc577a4SJonathan Peyton   task_stack->ts_entries--;
2377cc577a4SJonathan Peyton 
2387cc577a4SJonathan Peyton   tied_task = *(task_stack->ts_top);
2397cc577a4SJonathan Peyton 
2407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task != NULL);
2417cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
2427cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task == ending_task); // If we built the stack correctly
2437cc577a4SJonathan Peyton 
2443041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_pop_task_stack(exit): GTID: %d; TASK: %p\n", gtid,
2453041982dSJonathan Peyton                 tied_task));
2467cc577a4SJonathan Peyton   return;
2477cc577a4SJonathan Peyton }
2487cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
2497cc577a4SJonathan Peyton 
250c3344345SAndrey Churbanov // returns 1 if new task is allowed to execute, 0 otherwise
251c3344345SAndrey Churbanov // checks Task Scheduling constraint (if requested) and
252c3344345SAndrey Churbanov // mutexinoutset dependencies if any
253c3344345SAndrey Churbanov static bool __kmp_task_is_allowed(int gtid, const kmp_int32 is_constrained,
254c3344345SAndrey Churbanov                                   const kmp_taskdata_t *tasknew,
255c3344345SAndrey Churbanov                                   const kmp_taskdata_t *taskcurr) {
256c3344345SAndrey Churbanov   if (is_constrained && (tasknew->td_flags.tiedness == TASK_TIED)) {
257c3344345SAndrey Churbanov     // Check if the candidate obeys the Task Scheduling Constraints (TSC)
258c3344345SAndrey Churbanov     // only descendant of all deferred tied tasks can be scheduled, checking
259c3344345SAndrey Churbanov     // the last one is enough, as it in turn is the descendant of all others
260c3344345SAndrey Churbanov     kmp_taskdata_t *current = taskcurr->td_last_tied;
261c3344345SAndrey Churbanov     KMP_DEBUG_ASSERT(current != NULL);
262c3344345SAndrey Churbanov     // check if the task is not suspended on barrier
263c3344345SAndrey Churbanov     if (current->td_flags.tasktype == TASK_EXPLICIT ||
264c3344345SAndrey Churbanov         current->td_taskwait_thread > 0) { // <= 0 on barrier
265c3344345SAndrey Churbanov       kmp_int32 level = current->td_level;
266c3344345SAndrey Churbanov       kmp_taskdata_t *parent = tasknew->td_parent;
267c3344345SAndrey Churbanov       while (parent != current && parent->td_level > level) {
268c3344345SAndrey Churbanov         // check generation up to the level of the current task
269c3344345SAndrey Churbanov         parent = parent->td_parent;
270c3344345SAndrey Churbanov         KMP_DEBUG_ASSERT(parent != NULL);
271c3344345SAndrey Churbanov       }
272c3344345SAndrey Churbanov       if (parent != current)
273c3344345SAndrey Churbanov         return false;
274c3344345SAndrey Churbanov     }
275c3344345SAndrey Churbanov   }
276c3344345SAndrey Churbanov   // Check mutexinoutset dependencies, acquire locks
277c3344345SAndrey Churbanov   kmp_depnode_t *node = tasknew->td_depnode;
2786bf84871SAndreyChurbanov   if (UNLIKELY(node && (node->dn.mtx_num_locks > 0))) {
279c3344345SAndrey Churbanov     for (int i = 0; i < node->dn.mtx_num_locks; ++i) {
280c3344345SAndrey Churbanov       KMP_DEBUG_ASSERT(node->dn.mtx_locks[i] != NULL);
281c3344345SAndrey Churbanov       if (__kmp_test_lock(node->dn.mtx_locks[i], gtid))
282c3344345SAndrey Churbanov         continue;
283c3344345SAndrey Churbanov       // could not get the lock, release previous locks
284c3344345SAndrey Churbanov       for (int j = i - 1; j >= 0; --j)
285c3344345SAndrey Churbanov         __kmp_release_lock(node->dn.mtx_locks[j], gtid);
286c3344345SAndrey Churbanov       return false;
287c3344345SAndrey Churbanov     }
288c3344345SAndrey Churbanov     // negative num_locks means all locks acquired successfully
289c3344345SAndrey Churbanov     node->dn.mtx_num_locks = -node->dn.mtx_num_locks;
290c3344345SAndrey Churbanov   }
291c3344345SAndrey Churbanov   return true;
292c3344345SAndrey Churbanov }
293c3344345SAndrey Churbanov 
294c3344345SAndrey Churbanov // __kmp_realloc_task_deque:
295c3344345SAndrey Churbanov // Re-allocates a task deque for a particular thread, copies the content from
296c3344345SAndrey Churbanov // the old deque and adjusts the necessary data structures relating to the
297c3344345SAndrey Churbanov // deque. This operation must be done with the deque_lock being held
298c3344345SAndrey Churbanov static void __kmp_realloc_task_deque(kmp_info_t *thread,
299c3344345SAndrey Churbanov                                      kmp_thread_data_t *thread_data) {
300c3344345SAndrey Churbanov   kmp_int32 size = TASK_DEQUE_SIZE(thread_data->td);
3013895148dSJoachim Protze   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == size);
302c3344345SAndrey Churbanov   kmp_int32 new_size = 2 * size;
303c3344345SAndrey Churbanov 
304c3344345SAndrey Churbanov   KE_TRACE(10, ("__kmp_realloc_task_deque: T#%d reallocating deque[from %d to "
305c3344345SAndrey Churbanov                 "%d] for thread_data %p\n",
306c3344345SAndrey Churbanov                 __kmp_gtid_from_thread(thread), size, new_size, thread_data));
307c3344345SAndrey Churbanov 
308c3344345SAndrey Churbanov   kmp_taskdata_t **new_deque =
309c3344345SAndrey Churbanov       (kmp_taskdata_t **)__kmp_allocate(new_size * sizeof(kmp_taskdata_t *));
310c3344345SAndrey Churbanov 
311c3344345SAndrey Churbanov   int i, j;
312c3344345SAndrey Churbanov   for (i = thread_data->td.td_deque_head, j = 0; j < size;
313c3344345SAndrey Churbanov        i = (i + 1) & TASK_DEQUE_MASK(thread_data->td), j++)
314c3344345SAndrey Churbanov     new_deque[j] = thread_data->td.td_deque[i];
315c3344345SAndrey Churbanov 
316c3344345SAndrey Churbanov   __kmp_free(thread_data->td.td_deque);
317c3344345SAndrey Churbanov 
318c3344345SAndrey Churbanov   thread_data->td.td_deque_head = 0;
319c3344345SAndrey Churbanov   thread_data->td.td_deque_tail = size;
320c3344345SAndrey Churbanov   thread_data->td.td_deque = new_deque;
321c3344345SAndrey Churbanov   thread_data->td.td_deque_size = new_size;
322c3344345SAndrey Churbanov }
323c3344345SAndrey Churbanov 
3247cc577a4SJonathan Peyton //  __kmp_push_task: Add a task to the thread's deque
3253041982dSJonathan Peyton static kmp_int32 __kmp_push_task(kmp_int32 gtid, kmp_task_t *task) {
3267cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
3277cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
3289d64275aSShilei Tian 
3299d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
3309d64275aSShilei Tian     gtid = KMP_GTID_TO_SHADOW_GTID(gtid);
3319d64275aSShilei Tian     thread = __kmp_threads[gtid];
3329d64275aSShilei Tian   }
3339d64275aSShilei Tian 
3347cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
3357cc577a4SJonathan Peyton   kmp_int32 tid = __kmp_tid_from_gtid(gtid);
3367cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
3377cc577a4SJonathan Peyton 
3383041982dSJonathan Peyton   KA_TRACE(20,
3393041982dSJonathan Peyton            ("__kmp_push_task: T#%d trying to push task %p.\n", gtid, taskdata));
3407cc577a4SJonathan Peyton 
3416bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
3423041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
3433041982dSJonathan Peyton     // freed prematurely
34437e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
345baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
3463041982dSJonathan Peyton     KA_TRACE(
3473041982dSJonathan Peyton         20,
3483041982dSJonathan Peyton         ("__kmp_push_task: T#%d untied_count (%d) incremented for task %p\n",
3497cc577a4SJonathan Peyton          gtid, counter, taskdata));
3507cc577a4SJonathan Peyton   }
3517cc577a4SJonathan Peyton 
3527cc577a4SJonathan Peyton   // The first check avoids building task_team thread data if serialized
3536bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.task_serial)) {
3543041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_push_task: T#%d team serialized; returning "
3553041982dSJonathan Peyton                   "TASK_NOT_PUSHED for task %p\n",
3567cc577a4SJonathan Peyton                   gtid, taskdata));
3577cc577a4SJonathan Peyton     return TASK_NOT_PUSHED;
3587cc577a4SJonathan Peyton   }
3597cc577a4SJonathan Peyton 
3603041982dSJonathan Peyton   // Now that serialized tasks have returned, we can assume that we are not in
3613041982dSJonathan Peyton   // immediate exec mode
3627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
3636bf84871SAndreyChurbanov   if (UNLIKELY(!KMP_TASKING_ENABLED(task_team))) {
3647cc577a4SJonathan Peyton     __kmp_enable_tasking(task_team, thread);
3657cc577a4SJonathan Peyton   }
3667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(task_team->tt.tt_found_tasks) == TRUE);
3677cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_PTR(task_team->tt.tt_threads_data) != NULL);
3687cc577a4SJonathan Peyton 
3697cc577a4SJonathan Peyton   // Find tasking deque specific to encountering thread
3707cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[tid];
3717cc577a4SJonathan Peyton 
3729d64275aSShilei Tian   // No lock needed since only owner can allocate. If the task is hidden_helper,
3739d64275aSShilei Tian   // we don't need it either because we have initialized the dequeue for hidden
3749d64275aSShilei Tian   // helper thread data.
3756bf84871SAndreyChurbanov   if (UNLIKELY(thread_data->td.td_deque == NULL)) {
3767cc577a4SJonathan Peyton     __kmp_alloc_task_deque(thread, thread_data);
3777cc577a4SJonathan Peyton   }
3787cc577a4SJonathan Peyton 
379c3344345SAndrey Churbanov   int locked = 0;
3807cc577a4SJonathan Peyton   // Check if deque is full
3813041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
3823041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
383a23806e6SAndrey Churbanov     if (__kmp_enable_task_throttling &&
384a23806e6SAndrey Churbanov         __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
385c3344345SAndrey Churbanov                               thread->th.th_current_task)) {
3863041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_push_task: T#%d deque is full; returning "
3873041982dSJonathan Peyton                     "TASK_NOT_PUSHED for task %p\n",
3887cc577a4SJonathan Peyton                     gtid, taskdata));
3897cc577a4SJonathan Peyton       return TASK_NOT_PUSHED;
390c3344345SAndrey Churbanov     } else {
3917cc577a4SJonathan Peyton       __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
392c3344345SAndrey Churbanov       locked = 1;
3933895148dSJoachim Protze       if (TCR_4(thread_data->td.td_deque_ntasks) >=
3943895148dSJoachim Protze           TASK_DEQUE_SIZE(thread_data->td)) {
395c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
396c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
397c3344345SAndrey Churbanov       }
398c3344345SAndrey Churbanov     }
3993895148dSJoachim Protze   }
400c3344345SAndrey Churbanov   // Lock the deque for the task push operation
401c3344345SAndrey Churbanov   if (!locked) {
402c3344345SAndrey Churbanov     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
403c3344345SAndrey Churbanov     // Need to recheck as we can get a proxy task from thread outside of OpenMP
4043041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
4053041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
406a23806e6SAndrey Churbanov       if (__kmp_enable_task_throttling &&
407a23806e6SAndrey Churbanov           __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
408c3344345SAndrey Churbanov                                 thread->th.th_current_task)) {
4097cc577a4SJonathan Peyton         __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
410c3344345SAndrey Churbanov         KA_TRACE(20, ("__kmp_push_task: T#%d deque is full on 2nd check; "
411c3344345SAndrey Churbanov                       "returning TASK_NOT_PUSHED for task %p\n",
4127cc577a4SJonathan Peyton                       gtid, taskdata));
4137cc577a4SJonathan Peyton         return TASK_NOT_PUSHED;
414c3344345SAndrey Churbanov       } else {
415c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
416c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
4177cc577a4SJonathan Peyton       }
418c3344345SAndrey Churbanov     }
419c3344345SAndrey Churbanov   }
4207cc577a4SJonathan Peyton   // Must have room since no thread can add tasks but calling thread
4213041982dSJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) <
4223041982dSJonathan Peyton                    TASK_DEQUE_SIZE(thread_data->td));
4237cc577a4SJonathan Peyton 
4243041982dSJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] =
4253041982dSJonathan Peyton       taskdata; // Push taskdata
4267cc577a4SJonathan Peyton   // Wrap index.
4273041982dSJonathan Peyton   thread_data->td.td_deque_tail =
4283041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
4293041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
4303041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1); // Adjust task count
431ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(thread->th.th_current_task); // releasing self
432ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(taskdata); // releasing child
4337cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_push_task: T#%d returning TASK_SUCCESSFULLY_PUSHED: "
4347cc577a4SJonathan Peyton                 "task=%p ntasks=%d head=%u tail=%u\n",
4357cc577a4SJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
4367cc577a4SJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
4377cc577a4SJonathan Peyton 
4387cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
4397cc577a4SJonathan Peyton 
4409d64275aSShilei Tian   // Signal one worker thread to execute the task
4419d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
4429d64275aSShilei Tian     // Wake hidden helper threads up if they're sleeping
4439d64275aSShilei Tian     __kmp_hidden_helper_worker_thread_signal();
4449d64275aSShilei Tian   }
4459d64275aSShilei Tian 
4467cc577a4SJonathan Peyton   return TASK_SUCCESSFULLY_PUSHED;
4477cc577a4SJonathan Peyton }
4487cc577a4SJonathan Peyton 
4493041982dSJonathan Peyton // __kmp_pop_current_task_from_thread: set up current task from called thread
4503041982dSJonathan Peyton // when team ends
4513041982dSJonathan Peyton //
4527cc577a4SJonathan Peyton // this_thr: thread structure to set current_task in.
4533041982dSJonathan Peyton void __kmp_pop_current_task_from_thread(kmp_info_t *this_thr) {
4543041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(enter): T#%d "
4553041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
4567cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
4577cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
4587cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
4597cc577a4SJonathan Peyton 
4607cc577a4SJonathan Peyton   this_thr->th.th_current_task = this_thr->th.th_current_task->td_parent;
4617cc577a4SJonathan Peyton 
4623041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(exit): T#%d "
4633041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
4647cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
4657cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
4667cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
4677cc577a4SJonathan Peyton }
4687cc577a4SJonathan Peyton 
4693041982dSJonathan Peyton // __kmp_push_current_task_to_thread: set up current task in called thread for a
4703041982dSJonathan Peyton // new team
4713041982dSJonathan Peyton //
4727cc577a4SJonathan Peyton // this_thr: thread structure to set up
4737cc577a4SJonathan Peyton // team: team for implicit task data
4747cc577a4SJonathan Peyton // tid: thread within team to set up
4753041982dSJonathan Peyton void __kmp_push_current_task_to_thread(kmp_info_t *this_thr, kmp_team_t *team,
4763041982dSJonathan Peyton                                        int tid) {
4773041982dSJonathan Peyton   // current task of the thread is a parent of the new just created implicit
4783041982dSJonathan Peyton   // tasks of new team
4793041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(enter): T#%d this_thread=%p "
4803041982dSJonathan Peyton                 "curtask=%p "
4817cc577a4SJonathan Peyton                 "parent_task=%p\n",
4827cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
4837cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
4847cc577a4SJonathan Peyton 
4857cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr != NULL);
4867cc577a4SJonathan Peyton 
4877cc577a4SJonathan Peyton   if (tid == 0) {
4887cc577a4SJonathan Peyton     if (this_thr->th.th_current_task != &team->t.t_implicit_task_taskdata[0]) {
4893041982dSJonathan Peyton       team->t.t_implicit_task_taskdata[0].td_parent =
4903041982dSJonathan Peyton           this_thr->th.th_current_task;
4917cc577a4SJonathan Peyton       this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[0];
4927cc577a4SJonathan Peyton     }
4937cc577a4SJonathan Peyton   } else {
4943041982dSJonathan Peyton     team->t.t_implicit_task_taskdata[tid].td_parent =
4953041982dSJonathan Peyton         team->t.t_implicit_task_taskdata[0].td_parent;
4967cc577a4SJonathan Peyton     this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[tid];
4977cc577a4SJonathan Peyton   }
4987cc577a4SJonathan Peyton 
4993041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(exit): T#%d this_thread=%p "
5003041982dSJonathan Peyton                 "curtask=%p "
5017cc577a4SJonathan Peyton                 "parent_task=%p\n",
5027cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
5037cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
5047cc577a4SJonathan Peyton }
5057cc577a4SJonathan Peyton 
5067cc577a4SJonathan Peyton // __kmp_task_start: bookkeeping for a task starting execution
5073041982dSJonathan Peyton //
5087cc577a4SJonathan Peyton // GTID: global thread id of calling thread
5097cc577a4SJonathan Peyton // task: task starting execution
5107cc577a4SJonathan Peyton // current_task: task suspending
5113041982dSJonathan Peyton static void __kmp_task_start(kmp_int32 gtid, kmp_task_t *task,
5123041982dSJonathan Peyton                              kmp_taskdata_t *current_task) {
5137cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
5147cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
5157cc577a4SJonathan Peyton 
5163041982dSJonathan Peyton   KA_TRACE(10,
5173041982dSJonathan Peyton            ("__kmp_task_start(enter): T#%d starting task %p: current_task=%p\n",
5187cc577a4SJonathan Peyton             gtid, taskdata, current_task));
5197cc577a4SJonathan Peyton 
5207cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
5217cc577a4SJonathan Peyton 
5227cc577a4SJonathan Peyton   // mark currently executing task as suspended
5237cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
5247cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( current_task -> td_flags.executing == 1 );
5257cc577a4SJonathan Peyton   current_task->td_flags.executing = 0;
5267cc577a4SJonathan Peyton 
5277cc577a4SJonathan Peyton // Add task to stack if tied
5287cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
5293041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
5307cc577a4SJonathan Peyton     __kmp_push_task_stack(gtid, thread, taskdata);
5317cc577a4SJonathan Peyton   }
5327cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
5337cc577a4SJonathan Peyton 
5347cc577a4SJonathan Peyton   // mark starting task as executing and as current task
5357cc577a4SJonathan Peyton   thread->th.th_current_task = taskdata;
5367cc577a4SJonathan Peyton 
5373041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 0 ||
5383041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
5393041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0 ||
5403041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
5417cc577a4SJonathan Peyton   taskdata->td_flags.started = 1;
5427cc577a4SJonathan Peyton   taskdata->td_flags.executing = 1;
5437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
5447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
5457cc577a4SJonathan Peyton 
5467cc577a4SJonathan Peyton   // GEH TODO: shouldn't we pass some sort of location identifier here?
5477cc577a4SJonathan Peyton   // APT: yes, we will pass location here.
5487cc577a4SJonathan Peyton   // need to store current thread state (in a thread or taskdata structure)
5497cc577a4SJonathan Peyton   // before setting work_state, otherwise wrong state is set after end of task
5507cc577a4SJonathan Peyton 
5513041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_start(exit): T#%d task=%p\n", gtid, taskdata));
5527cc577a4SJonathan Peyton 
5537cc577a4SJonathan Peyton   return;
5547cc577a4SJonathan Peyton }
5557cc577a4SJonathan Peyton 
55682e94a59SJoachim Protze #if OMPT_SUPPORT
55782e94a59SJoachim Protze //------------------------------------------------------------------------------
55882e94a59SJoachim Protze // __ompt_task_init:
55982e94a59SJoachim Protze //   Initialize OMPT fields maintained by a task. This will only be called after
56082e94a59SJoachim Protze //   ompt_start_tool, so we already know whether ompt is enabled or not.
56182e94a59SJoachim Protze 
56282e94a59SJoachim Protze static inline void __ompt_task_init(kmp_taskdata_t *task, int tid) {
56382e94a59SJoachim Protze   // The calls to __ompt_task_init already have the ompt_enabled condition.
56482e94a59SJoachim Protze   task->ompt_task_info.task_data.value = 0;
5650e0d6cddSJoachim Protze   task->ompt_task_info.frame.exit_frame = ompt_data_none;
5660e0d6cddSJoachim Protze   task->ompt_task_info.frame.enter_frame = ompt_data_none;
567*309b00a4SShilei Tian   task->ompt_task_info.frame.exit_frame_flags =
568*309b00a4SShilei Tian       ompt_frame_runtime | ompt_frame_framepointer;
569*309b00a4SShilei Tian   task->ompt_task_info.frame.enter_frame_flags =
570*309b00a4SShilei Tian       ompt_frame_runtime | ompt_frame_framepointer;
57182e94a59SJoachim Protze }
57282e94a59SJoachim Protze 
57382e94a59SJoachim Protze // __ompt_task_start:
57482e94a59SJoachim Protze //   Build and trigger task-begin event
57582e94a59SJoachim Protze static inline void __ompt_task_start(kmp_task_t *task,
57682e94a59SJoachim Protze                                      kmp_taskdata_t *current_task,
57782e94a59SJoachim Protze                                      kmp_int32 gtid) {
57882e94a59SJoachim Protze   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
579489cdb78SJoachim Protze   ompt_task_status_t status = ompt_task_switch;
58082e94a59SJoachim Protze   if (__kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded) {
58182e94a59SJoachim Protze     status = ompt_task_yield;
58282e94a59SJoachim Protze     __kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded = 0;
58382e94a59SJoachim Protze   }
58482e94a59SJoachim Protze   /* let OMPT know that we're about to run this task */
58582e94a59SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
58682e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
58782e94a59SJoachim Protze         &(current_task->ompt_task_info.task_data), status,
58882e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data));
58982e94a59SJoachim Protze   }
59082e94a59SJoachim Protze   taskdata->ompt_task_info.scheduling_parent = current_task;
59182e94a59SJoachim Protze }
59282e94a59SJoachim Protze 
59382e94a59SJoachim Protze // __ompt_task_finish:
59482e94a59SJoachim Protze //   Build and trigger final task-schedule event
59510995c77SJoachim Protze static inline void __ompt_task_finish(kmp_task_t *task,
59610995c77SJoachim Protze                                       kmp_taskdata_t *resumed_task,
59710995c77SJoachim Protze                                       ompt_task_status_t status) {
59810995c77SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
59982e94a59SJoachim Protze     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
60082e94a59SJoachim Protze     if (__kmp_omp_cancellation && taskdata->td_taskgroup &&
60182e94a59SJoachim Protze         taskdata->td_taskgroup->cancel_request == cancel_taskgroup) {
60282e94a59SJoachim Protze       status = ompt_task_cancel;
60382e94a59SJoachim Protze     }
60482e94a59SJoachim Protze 
60582e94a59SJoachim Protze     /* let OMPT know that we're returning to the callee task */
60682e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
60782e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data), status,
60810995c77SJoachim Protze         (resumed_task ? &(resumed_task->ompt_task_info.task_data) : NULL));
60982e94a59SJoachim Protze   }
61082e94a59SJoachim Protze }
61182e94a59SJoachim Protze #endif
61282e94a59SJoachim Protze 
61382e94a59SJoachim Protze template <bool ompt>
61482e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_template(ident_t *loc_ref, kmp_int32 gtid,
61582e94a59SJoachim Protze                                                kmp_task_t *task,
61682e94a59SJoachim Protze                                                void *frame_address,
61782e94a59SJoachim Protze                                                void *return_address) {
6187cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
6197cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
6207cc577a4SJonathan Peyton 
6213041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(enter): T#%d loc=%p task=%p "
6223041982dSJonathan Peyton                 "current_task=%p\n",
6237cc577a4SJonathan Peyton                 gtid, loc_ref, taskdata, current_task));
6247cc577a4SJonathan Peyton 
625838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
6263041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
6273041982dSJonathan Peyton     // freed prematurely
62837e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
629baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
6303041982dSJonathan Peyton     KA_TRACE(20, ("__kmpc_omp_task_begin_if0: T#%d untied_count (%d) "
6313041982dSJonathan Peyton                   "incremented for task %p\n",
6327cc577a4SJonathan Peyton                   gtid, counter, taskdata));
6337cc577a4SJonathan Peyton   }
6347cc577a4SJonathan Peyton 
6353041982dSJonathan Peyton   taskdata->td_flags.task_serial =
6363041982dSJonathan Peyton       1; // Execute this task immediately, not deferred.
6377cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
6387cc577a4SJonathan Peyton 
63982e94a59SJoachim Protze #if OMPT_SUPPORT
64082e94a59SJoachim Protze   if (ompt) {
6410e0d6cddSJoachim Protze     if (current_task->ompt_task_info.frame.enter_frame.ptr == NULL) {
6420e0d6cddSJoachim Protze       current_task->ompt_task_info.frame.enter_frame.ptr =
6430e0d6cddSJoachim Protze           taskdata->ompt_task_info.frame.exit_frame.ptr = frame_address;
6440e0d6cddSJoachim Protze       current_task->ompt_task_info.frame.enter_frame_flags =
645*309b00a4SShilei Tian           taskdata->ompt_task_info.frame.exit_frame_flags =
646*309b00a4SShilei Tian               ompt_frame_application | ompt_frame_framepointer;
64782e94a59SJoachim Protze     }
64882e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
64982e94a59SJoachim Protze       ompt_task_info_t *parent_info = &(current_task->ompt_task_info);
65082e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
65182e94a59SJoachim Protze           &(parent_info->task_data), &(parent_info->frame),
65282e94a59SJoachim Protze           &(taskdata->ompt_task_info.task_data),
65382e94a59SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(taskdata), 0,
65482e94a59SJoachim Protze           return_address);
65582e94a59SJoachim Protze     }
65682e94a59SJoachim Protze     __ompt_task_start(task, current_task, gtid);
65782e94a59SJoachim Protze   }
65882e94a59SJoachim Protze #endif // OMPT_SUPPORT
65982e94a59SJoachim Protze 
6603041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(exit): T#%d loc=%p task=%p,\n", gtid,
6613041982dSJonathan Peyton                 loc_ref, taskdata));
66282e94a59SJoachim Protze }
6637cc577a4SJonathan Peyton 
66482e94a59SJoachim Protze #if OMPT_SUPPORT
66582e94a59SJoachim Protze OMPT_NOINLINE
66682e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
66782e94a59SJoachim Protze                                            kmp_task_t *task,
66882e94a59SJoachim Protze                                            void *frame_address,
66982e94a59SJoachim Protze                                            void *return_address) {
670f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<true>(loc_ref, gtid, task, frame_address,
671f0a1c65fSJonas Hahnfeld                                            return_address);
67282e94a59SJoachim Protze }
67382e94a59SJoachim Protze #endif // OMPT_SUPPORT
67482e94a59SJoachim Protze 
67582e94a59SJoachim Protze // __kmpc_omp_task_begin_if0: report that a given serialized task has started
67682e94a59SJoachim Protze // execution
67782e94a59SJoachim Protze //
67882e94a59SJoachim Protze // loc_ref: source location information; points to beginning of task block.
67982e94a59SJoachim Protze // gtid: global thread number.
68082e94a59SJoachim Protze // task: task thunk for the started task.
68182e94a59SJoachim Protze void __kmpc_omp_task_begin_if0(ident_t *loc_ref, kmp_int32 gtid,
68282e94a59SJoachim Protze                                kmp_task_t *task) {
68382e94a59SJoachim Protze #if OMPT_SUPPORT
68482e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
68582e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
68682e94a59SJoachim Protze     __kmpc_omp_task_begin_if0_ompt(loc_ref, gtid, task,
68782e94a59SJoachim Protze                                    OMPT_GET_FRAME_ADDRESS(1),
68882e94a59SJoachim Protze                                    OMPT_LOAD_RETURN_ADDRESS(gtid));
6897cc577a4SJonathan Peyton     return;
6907cc577a4SJonathan Peyton   }
69182e94a59SJoachim Protze #endif
692f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<false>(loc_ref, gtid, task, NULL, NULL);
69382e94a59SJoachim Protze }
6947cc577a4SJonathan Peyton 
6957cc577a4SJonathan Peyton #ifdef TASK_UNUSED
6967cc577a4SJonathan Peyton // __kmpc_omp_task_begin: report that a given task has started execution
6977cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
6983041982dSJonathan Peyton void __kmpc_omp_task_begin(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task) {
6997cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
7007cc577a4SJonathan Peyton 
7013041982dSJonathan Peyton   KA_TRACE(
7023041982dSJonathan Peyton       10,
7033041982dSJonathan Peyton       ("__kmpc_omp_task_begin(enter): T#%d loc=%p task=%p current_task=%p\n",
7047cc577a4SJonathan Peyton        gtid, loc_ref, KMP_TASK_TO_TASKDATA(task), current_task));
7057cc577a4SJonathan Peyton 
7067cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
7077cc577a4SJonathan Peyton 
7083041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin(exit): T#%d loc=%p task=%p,\n", gtid,
7093041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
7107cc577a4SJonathan Peyton   return;
7117cc577a4SJonathan Peyton }
7127cc577a4SJonathan Peyton #endif // TASK_UNUSED
7137cc577a4SJonathan Peyton 
7147cc577a4SJonathan Peyton // __kmp_free_task: free the current task space and the space for shareds
7153041982dSJonathan Peyton //
7167cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
7177cc577a4SJonathan Peyton // taskdata: task to free
7187cc577a4SJonathan Peyton // thread: thread data structure of caller
7193041982dSJonathan Peyton static void __kmp_free_task(kmp_int32 gtid, kmp_taskdata_t *taskdata,
7203041982dSJonathan Peyton                             kmp_info_t *thread) {
7213041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_free_task: T#%d freeing data from task %p\n", gtid,
7223041982dSJonathan Peyton                 taskdata));
7237cc577a4SJonathan Peyton 
7247cc577a4SJonathan Peyton   // Check to make sure all flags and counters have the correct values
7257cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7267cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0);
7277cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 1);
7287cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
72937e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_allocated_child_tasks == 0 ||
7303041982dSJonathan Peyton                    taskdata->td_flags.task_serial == 1);
73137e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_incomplete_child_tasks == 0);
7327cc577a4SJonathan Peyton 
7337cc577a4SJonathan Peyton   taskdata->td_flags.freed = 1;
7347cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(taskdata);
7357cc577a4SJonathan Peyton // deallocate the taskdata and shared variable blocks associated with this task
7367cc577a4SJonathan Peyton #if USE_FAST_MEMORY
7377cc577a4SJonathan Peyton   __kmp_fast_free(thread, taskdata);
7387cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
7397cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskdata);
7407cc577a4SJonathan Peyton #endif
7413041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_free_task: T#%d freed task %p\n", gtid, taskdata));
7427cc577a4SJonathan Peyton }
7437cc577a4SJonathan Peyton 
7443041982dSJonathan Peyton // __kmp_free_task_and_ancestors: free the current task and ancestors without
7453041982dSJonathan Peyton // children
7467cc577a4SJonathan Peyton //
7477cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
7487cc577a4SJonathan Peyton // taskdata: task to free
7497cc577a4SJonathan Peyton // thread: thread data structure of caller
7503041982dSJonathan Peyton static void __kmp_free_task_and_ancestors(kmp_int32 gtid,
7513041982dSJonathan Peyton                                           kmp_taskdata_t *taskdata,
7523041982dSJonathan Peyton                                           kmp_info_t *thread) {
7537cc577a4SJonathan Peyton   // Proxy tasks must always be allowed to free their parents
7547cc577a4SJonathan Peyton   // because they can be run in background even in serial mode.
7553041982dSJonathan Peyton   kmp_int32 team_serial =
7563041982dSJonathan Peyton       (taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) &&
7573041982dSJonathan Peyton       !taskdata->td_flags.proxy;
7587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7597cc577a4SJonathan Peyton 
76037e2ef54SJonathan Peyton   kmp_int32 children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
7617cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
7627cc577a4SJonathan Peyton 
7637cc577a4SJonathan Peyton   // Now, go up the ancestor tree to see if any ancestors can now be freed.
7643041982dSJonathan Peyton   while (children == 0) {
7657cc577a4SJonathan Peyton     kmp_taskdata_t *parent_taskdata = taskdata->td_parent;
7667cc577a4SJonathan Peyton 
7677cc577a4SJonathan Peyton     KA_TRACE(20, ("__kmp_free_task_and_ancestors(enter): T#%d task %p complete "
7683041982dSJonathan Peyton                   "and freeing itself\n",
7693041982dSJonathan Peyton                   gtid, taskdata));
7707cc577a4SJonathan Peyton 
7717cc577a4SJonathan Peyton     // --- Deallocate my ancestor task ---
7727cc577a4SJonathan Peyton     __kmp_free_task(gtid, taskdata, thread);
7737cc577a4SJonathan Peyton 
7747cc577a4SJonathan Peyton     taskdata = parent_taskdata;
7757cc577a4SJonathan Peyton 
776c3344345SAndrey Churbanov     if (team_serial)
777c3344345SAndrey Churbanov       return;
7783041982dSJonathan Peyton     // Stop checking ancestors at implicit task instead of walking up ancestor
7793041982dSJonathan Peyton     // tree to avoid premature deallocation of ancestors.
780c3344345SAndrey Churbanov     if (taskdata->td_flags.tasktype == TASK_IMPLICIT) {
781c3344345SAndrey Churbanov       if (taskdata->td_dephash) { // do we need to cleanup dephash?
782c3344345SAndrey Churbanov         int children = KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks);
783c3344345SAndrey Churbanov         kmp_tasking_flags_t flags_old = taskdata->td_flags;
784c3344345SAndrey Churbanov         if (children == 0 && flags_old.complete == 1) {
785c3344345SAndrey Churbanov           kmp_tasking_flags_t flags_new = flags_old;
786c3344345SAndrey Churbanov           flags_new.complete = 0;
787c3344345SAndrey Churbanov           if (KMP_COMPARE_AND_STORE_ACQ32(
788c3344345SAndrey Churbanov                   RCAST(kmp_int32 *, &taskdata->td_flags),
789c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_old),
790c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_new))) {
791c3344345SAndrey Churbanov             KA_TRACE(100, ("__kmp_free_task_and_ancestors: T#%d cleans "
792c3344345SAndrey Churbanov                            "dephash of implicit task %p\n",
793c3344345SAndrey Churbanov                            gtid, taskdata));
794c3344345SAndrey Churbanov             // cleanup dephash of finished implicit task
795c3344345SAndrey Churbanov             __kmp_dephash_free_entries(thread, taskdata->td_dephash);
796c3344345SAndrey Churbanov           }
797c3344345SAndrey Churbanov         }
798c3344345SAndrey Churbanov       }
7997cc577a4SJonathan Peyton       return;
800c3344345SAndrey Churbanov     }
8017cc577a4SJonathan Peyton     // Predecrement simulated by "- 1" calculation
80237e2ef54SJonathan Peyton     children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
8037cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(children >= 0);
8047cc577a4SJonathan Peyton   }
8057cc577a4SJonathan Peyton 
8063041982dSJonathan Peyton   KA_TRACE(
8073041982dSJonathan Peyton       20, ("__kmp_free_task_and_ancestors(exit): T#%d task %p has %d children; "
8083041982dSJonathan Peyton            "not freeing it yet\n",
8093041982dSJonathan Peyton            gtid, taskdata, children));
8107cc577a4SJonathan Peyton }
8117cc577a4SJonathan Peyton 
8127cc577a4SJonathan Peyton // __kmp_task_finish: bookkeeping to do when a task finishes execution
8133041982dSJonathan Peyton //
8147cc577a4SJonathan Peyton // gtid: global thread ID for calling thread
8157cc577a4SJonathan Peyton // task: task to be finished
8167cc577a4SJonathan Peyton // resumed_task: task to be resumed.  (may be NULL if task is serialized)
81710995c77SJoachim Protze //
81810995c77SJoachim Protze // template<ompt>: effectively ompt_enabled.enabled!=0
81910995c77SJoachim Protze // the version with ompt=false is inlined, allowing to optimize away all ompt
82010995c77SJoachim Protze // code in this case
82186ed6aa6SJoachim Protze template <bool ompt>
8223041982dSJonathan Peyton static void __kmp_task_finish(kmp_int32 gtid, kmp_task_t *task,
8233041982dSJonathan Peyton                               kmp_taskdata_t *resumed_task) {
8247cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
8257cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
8263041982dSJonathan Peyton   kmp_task_team_t *task_team =
8273041982dSJonathan Peyton       thread->th.th_task_team; // might be NULL for serial teams...
8287cc577a4SJonathan Peyton   kmp_int32 children = 0;
8297cc577a4SJonathan Peyton 
8303041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_finish(enter): T#%d finishing task %p and resuming "
8313041982dSJonathan Peyton                 "task %p\n",
8327cc577a4SJonathan Peyton                 gtid, taskdata, resumed_task));
8337cc577a4SJonathan Peyton 
8347cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
8357cc577a4SJonathan Peyton 
8367cc577a4SJonathan Peyton // Pop task from stack if tied
8377cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
8383041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
8397cc577a4SJonathan Peyton     __kmp_pop_task_stack(gtid, thread, taskdata);
8407cc577a4SJonathan Peyton   }
8417cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
8427cc577a4SJonathan Peyton 
8436bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
8443041982dSJonathan Peyton     // untied task needs to check the counter so that the task structure is not
8453041982dSJonathan Peyton     // freed prematurely
84637e2ef54SJonathan Peyton     kmp_int32 counter = KMP_ATOMIC_DEC(&taskdata->td_untied_count) - 1;
8473041982dSJonathan Peyton     KA_TRACE(
8483041982dSJonathan Peyton         20,
8493041982dSJonathan Peyton         ("__kmp_task_finish: T#%d untied_count (%d) decremented for task %p\n",
8507cc577a4SJonathan Peyton          gtid, counter, taskdata));
8517cc577a4SJonathan Peyton     if (counter > 0) {
8523041982dSJonathan Peyton       // untied task is not done, to be continued possibly by other thread, do
8533041982dSJonathan Peyton       // not free it now
8547cc577a4SJonathan Peyton       if (resumed_task == NULL) {
8557cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(taskdata->td_flags.task_serial);
8563041982dSJonathan Peyton         resumed_task = taskdata->td_parent; // In a serialized task, the resumed
8573041982dSJonathan Peyton         // task is the parent
8587cc577a4SJonathan Peyton       }
8597cc577a4SJonathan Peyton       thread->th.th_current_task = resumed_task; // restore current_task
8607cc577a4SJonathan Peyton       resumed_task->td_flags.executing = 1; // resume previous task
8613041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_task_finish(exit): T#%d partially done task %p, "
8623041982dSJonathan Peyton                     "resuming task %p\n",
8637cc577a4SJonathan Peyton                     gtid, taskdata, resumed_task));
8647cc577a4SJonathan Peyton       return;
8657cc577a4SJonathan Peyton     }
8667cc577a4SJonathan Peyton   }
8677cc577a4SJonathan Peyton 
868d23131a3SJoachim Protze   // bookkeeping for resuming task:
869d23131a3SJoachim Protze   // GEH - note tasking_ser => task_serial
870d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(
871d23131a3SJoachim Protze       (taskdata->td_flags.tasking_ser || taskdata->td_flags.task_serial) ==
872d23131a3SJoachim Protze       taskdata->td_flags.task_serial);
873d23131a3SJoachim Protze   if (taskdata->td_flags.task_serial) {
874d23131a3SJoachim Protze     if (resumed_task == NULL) {
875d23131a3SJoachim Protze       resumed_task = taskdata->td_parent; // In a serialized task, the resumed
876d23131a3SJoachim Protze       // task is the parent
877d23131a3SJoachim Protze     }
878d23131a3SJoachim Protze   } else {
879d23131a3SJoachim Protze     KMP_DEBUG_ASSERT(resumed_task !=
880d23131a3SJoachim Protze                      NULL); // verify that resumed task is passed as argument
881d23131a3SJoachim Protze   }
882d23131a3SJoachim Protze 
883d23131a3SJoachim Protze   /* If the tasks' destructor thunk flag has been set, we need to invoke the
884d23131a3SJoachim Protze      destructor thunk that has been generated by the compiler. The code is
885d23131a3SJoachim Protze      placed here, since at this point other tasks might have been released
886d23131a3SJoachim Protze      hence overlapping the destructor invocations with some other work in the
887d23131a3SJoachim Protze      released tasks.  The OpenMP spec is not specific on when the destructors
888d23131a3SJoachim Protze      are invoked, so we should be free to choose. */
889838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.destructors_thunk)) {
890d23131a3SJoachim Protze     kmp_routine_entry_t destr_thunk = task->data1.destructors;
891d23131a3SJoachim Protze     KMP_ASSERT(destr_thunk);
892d23131a3SJoachim Protze     destr_thunk(gtid, task);
893d23131a3SJoachim Protze   }
894d23131a3SJoachim Protze 
8957cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
896d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 1);
897d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
898d23131a3SJoachim Protze 
899405037c4SAndrey Churbanov   bool detach = false;
900838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.detachable == TASK_DETACHABLE)) {
901405037c4SAndrey Churbanov     if (taskdata->td_allow_completion_event.type ==
902405037c4SAndrey Churbanov         KMP_EVENT_ALLOW_COMPLETION) {
903405037c4SAndrey Churbanov       // event hasn't been fulfilled yet. Try to detach task.
904405037c4SAndrey Churbanov       __kmp_acquire_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
905405037c4SAndrey Churbanov       if (taskdata->td_allow_completion_event.type ==
906405037c4SAndrey Churbanov           KMP_EVENT_ALLOW_COMPLETION) {
907d23131a3SJoachim Protze         // task finished execution
908d23131a3SJoachim Protze         KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
909d23131a3SJoachim Protze         taskdata->td_flags.executing = 0; // suspend the finishing task
91010995c77SJoachim Protze 
91110995c77SJoachim Protze #if OMPT_SUPPORT
91210995c77SJoachim Protze         // For a detached task, which is not completed, we switch back
91310995c77SJoachim Protze         // the omp_fulfill_event signals completion
91410995c77SJoachim Protze         // locking is necessary to avoid a race with ompt_task_late_fulfill
91510995c77SJoachim Protze         if (ompt)
91610995c77SJoachim Protze           __ompt_task_finish(task, resumed_task, ompt_task_detach);
91710995c77SJoachim Protze #endif
91810995c77SJoachim Protze 
919d23131a3SJoachim Protze         // no access to taskdata after this point!
920d23131a3SJoachim Protze         // __kmp_fulfill_event might free taskdata at any time from now
92110995c77SJoachim Protze 
922405037c4SAndrey Churbanov         taskdata->td_flags.proxy = TASK_PROXY; // proxify!
923405037c4SAndrey Churbanov         detach = true;
924405037c4SAndrey Churbanov       }
925405037c4SAndrey Churbanov       __kmp_release_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
926405037c4SAndrey Churbanov     }
927405037c4SAndrey Churbanov   }
9287cc577a4SJonathan Peyton 
929405037c4SAndrey Churbanov   if (!detach) {
930405037c4SAndrey Churbanov     taskdata->td_flags.complete = 1; // mark the task as completed
931405037c4SAndrey Churbanov 
93210995c77SJoachim Protze #if OMPT_SUPPORT
93310995c77SJoachim Protze     // This is not a detached task, we are done here
93410995c77SJoachim Protze     if (ompt)
93510995c77SJoachim Protze       __ompt_task_finish(task, resumed_task, ompt_task_complete);
93610995c77SJoachim Protze #endif
93710995c77SJoachim Protze 
9383041982dSJonathan Peyton     // Only need to keep track of count if team parallel and tasking not
93957d8b8d6SAndreyChurbanov     // serialized, or task is detachable and event has already been fulfilled
94057d8b8d6SAndreyChurbanov     if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) ||
9419d64275aSShilei Tian         taskdata->td_flags.detachable == TASK_DETACHABLE ||
9429d64275aSShilei Tian         taskdata->td_flags.hidden_helper) {
9437cc577a4SJonathan Peyton       // Predecrement simulated by "- 1" calculation
9443041982dSJonathan Peyton       children =
94537e2ef54SJonathan Peyton           KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
9467cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(children >= 0);
9477cc577a4SJonathan Peyton       if (taskdata->td_taskgroup)
94837e2ef54SJonathan Peyton         KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
949cf27e31bSJonathan Peyton       __kmp_release_deps(gtid, taskdata);
950cf27e31bSJonathan Peyton     } else if (task_team && task_team->tt.tt_found_proxy_tasks) {
9517cc577a4SJonathan Peyton       // if we found proxy tasks there could exist a dependency chain
9527cc577a4SJonathan Peyton       // with the proxy task as origin
9537cc577a4SJonathan Peyton       __kmp_release_deps(gtid, taskdata);
9547cc577a4SJonathan Peyton     }
9553041982dSJonathan Peyton     // td_flags.executing must be marked as 0 after __kmp_release_deps has been
956d23131a3SJoachim Protze     // called. Othertwise, if a task is executed immediately from the
957d23131a3SJoachim Protze     // release_deps code, the flag will be reset to 1 again by this same
958d23131a3SJoachim Protze     // function
9597cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
9607cc577a4SJonathan Peyton     taskdata->td_flags.executing = 0; // suspend the finishing task
961d23131a3SJoachim Protze   }
962d23131a3SJoachim Protze 
9633041982dSJonathan Peyton   KA_TRACE(
9643041982dSJonathan Peyton       20, ("__kmp_task_finish: T#%d finished task %p, %d incomplete children\n",
9657cc577a4SJonathan Peyton            gtid, taskdata, children));
9667cc577a4SJonathan Peyton 
9677cc577a4SJonathan Peyton   // Free this task and then ancestor tasks if they have no children.
9687cc577a4SJonathan Peyton   // Restore th_current_task first as suggested by John:
9697cc577a4SJonathan Peyton   // johnmc: if an asynchronous inquiry peers into the runtime system
9707cc577a4SJonathan Peyton   // it doesn't see the freed task as the current task.
9717cc577a4SJonathan Peyton   thread->th.th_current_task = resumed_task;
972405037c4SAndrey Churbanov   if (!detach)
9737cc577a4SJonathan Peyton     __kmp_free_task_and_ancestors(gtid, taskdata, thread);
9747cc577a4SJonathan Peyton 
9757cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
9767cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( resumed_task->td_flags.executing == 0 );
9777cc577a4SJonathan Peyton   resumed_task->td_flags.executing = 1; // resume previous task
9787cc577a4SJonathan Peyton 
9793041982dSJonathan Peyton   KA_TRACE(
9803041982dSJonathan Peyton       10, ("__kmp_task_finish(exit): T#%d finished task %p, resuming task %p\n",
9817cc577a4SJonathan Peyton            gtid, taskdata, resumed_task));
9827cc577a4SJonathan Peyton 
9837cc577a4SJonathan Peyton   return;
9847cc577a4SJonathan Peyton }
9857cc577a4SJonathan Peyton 
98682e94a59SJoachim Protze template <bool ompt>
98782e94a59SJoachim Protze static void __kmpc_omp_task_complete_if0_template(ident_t *loc_ref,
98882e94a59SJoachim Protze                                                   kmp_int32 gtid,
9893041982dSJonathan Peyton                                                   kmp_task_t *task) {
9907cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(enter): T#%d loc=%p task=%p\n",
9917cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
992838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
9933041982dSJonathan Peyton   // this routine will provide task to resume
99486ed6aa6SJoachim Protze   __kmp_task_finish<ompt>(gtid, task, NULL);
9957cc577a4SJonathan Peyton 
9967cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(exit): T#%d loc=%p task=%p\n",
9977cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
99882e94a59SJoachim Protze 
99982e94a59SJoachim Protze #if OMPT_SUPPORT
100082e94a59SJoachim Protze   if (ompt) {
10010e0d6cddSJoachim Protze     ompt_frame_t *ompt_frame;
100282e94a59SJoachim Protze     __ompt_get_task_info_internal(0, NULL, NULL, &ompt_frame, NULL, NULL);
10030e0d6cddSJoachim Protze     ompt_frame->enter_frame = ompt_data_none;
1004*309b00a4SShilei Tian     ompt_frame->enter_frame_flags =
1005*309b00a4SShilei Tian         ompt_frame_runtime | ompt_frame_framepointer;
100682e94a59SJoachim Protze   }
100782e94a59SJoachim Protze #endif
100882e94a59SJoachim Protze 
10097cc577a4SJonathan Peyton   return;
10107cc577a4SJonathan Peyton }
10117cc577a4SJonathan Peyton 
101282e94a59SJoachim Protze #if OMPT_SUPPORT
101382e94a59SJoachim Protze OMPT_NOINLINE
101482e94a59SJoachim Protze void __kmpc_omp_task_complete_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
101582e94a59SJoachim Protze                                        kmp_task_t *task) {
101682e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<true>(loc_ref, gtid, task);
101782e94a59SJoachim Protze }
101882e94a59SJoachim Protze #endif // OMPT_SUPPORT
101982e94a59SJoachim Protze 
102082e94a59SJoachim Protze // __kmpc_omp_task_complete_if0: report that a task has completed execution
102182e94a59SJoachim Protze //
102282e94a59SJoachim Protze // loc_ref: source location information; points to end of task block.
102382e94a59SJoachim Protze // gtid: global thread number.
102482e94a59SJoachim Protze // task: task thunk for the completed task.
102582e94a59SJoachim Protze void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
102682e94a59SJoachim Protze                                   kmp_task_t *task) {
102782e94a59SJoachim Protze #if OMPT_SUPPORT
102882e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
102982e94a59SJoachim Protze     __kmpc_omp_task_complete_if0_ompt(loc_ref, gtid, task);
103082e94a59SJoachim Protze     return;
103182e94a59SJoachim Protze   }
103282e94a59SJoachim Protze #endif
103382e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<false>(loc_ref, gtid, task);
103482e94a59SJoachim Protze }
103582e94a59SJoachim Protze 
10367cc577a4SJonathan Peyton #ifdef TASK_UNUSED
10377cc577a4SJonathan Peyton // __kmpc_omp_task_complete: report that a task has completed execution
10387cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
10393041982dSJonathan Peyton void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
10403041982dSJonathan Peyton                               kmp_task_t *task) {
10413041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(enter): T#%d loc=%p task=%p\n", gtid,
10423041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10437cc577a4SJonathan Peyton 
104486ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task,
104586ed6aa6SJoachim Protze                            NULL); // Not sure how to find task to resume
10467cc577a4SJonathan Peyton 
10473041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(exit): T#%d loc=%p task=%p\n", gtid,
10483041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10497cc577a4SJonathan Peyton   return;
10507cc577a4SJonathan Peyton }
10517cc577a4SJonathan Peyton #endif // TASK_UNUSED
10527cc577a4SJonathan Peyton 
10533041982dSJonathan Peyton // __kmp_init_implicit_task: Initialize the appropriate fields in the implicit
10543041982dSJonathan Peyton // task for a given thread
10557cc577a4SJonathan Peyton //
10567cc577a4SJonathan Peyton // loc_ref:  reference to source location of parallel region
10577cc577a4SJonathan Peyton // this_thr:  thread data structure corresponding to implicit task
10587cc577a4SJonathan Peyton // team: team for this_thr
10597cc577a4SJonathan Peyton // tid: thread id of given thread within team
10607cc577a4SJonathan Peyton // set_curr_task: TRUE if need to push current task to thread
10613041982dSJonathan Peyton // NOTE: Routine does not set up the implicit task ICVS.  This is assumed to
10623041982dSJonathan Peyton // have already been done elsewhere.
10637cc577a4SJonathan Peyton // TODO: Get better loc_ref.  Value passed in may be NULL
10643041982dSJonathan Peyton void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
10653041982dSJonathan Peyton                               kmp_team_t *team, int tid, int set_curr_task) {
10667cc577a4SJonathan Peyton   kmp_taskdata_t *task = &team->t.t_implicit_task_taskdata[tid];
10677cc577a4SJonathan Peyton 
10683041982dSJonathan Peyton   KF_TRACE(
10693041982dSJonathan Peyton       10,
10703041982dSJonathan Peyton       ("__kmp_init_implicit_task(enter): T#:%d team=%p task=%p, reinit=%s\n",
10717cc577a4SJonathan Peyton        tid, team, task, set_curr_task ? "TRUE" : "FALSE"));
10727cc577a4SJonathan Peyton 
10737cc577a4SJonathan Peyton   task->td_task_id = KMP_GEN_TASK_ID();
10747cc577a4SJonathan Peyton   task->td_team = team;
10753041982dSJonathan Peyton   //    task->td_parent   = NULL;  // fix for CQ230101 (broken parent task info
10763041982dSJonathan Peyton   //    in debugger)
10777cc577a4SJonathan Peyton   task->td_ident = loc_ref;
10787cc577a4SJonathan Peyton   task->td_taskwait_ident = NULL;
10797cc577a4SJonathan Peyton   task->td_taskwait_counter = 0;
10807cc577a4SJonathan Peyton   task->td_taskwait_thread = 0;
10817cc577a4SJonathan Peyton 
10827cc577a4SJonathan Peyton   task->td_flags.tiedness = TASK_TIED;
10837cc577a4SJonathan Peyton   task->td_flags.tasktype = TASK_IMPLICIT;
10847cc577a4SJonathan Peyton   task->td_flags.proxy = TASK_FULL;
10857cc577a4SJonathan Peyton 
10867cc577a4SJonathan Peyton   // All implicit tasks are executed immediately, not deferred
10877cc577a4SJonathan Peyton   task->td_flags.task_serial = 1;
10887cc577a4SJonathan Peyton   task->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
10897cc577a4SJonathan Peyton   task->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
10907cc577a4SJonathan Peyton 
10917cc577a4SJonathan Peyton   task->td_flags.started = 1;
10927cc577a4SJonathan Peyton   task->td_flags.executing = 1;
10937cc577a4SJonathan Peyton   task->td_flags.complete = 0;
10947cc577a4SJonathan Peyton   task->td_flags.freed = 0;
10957cc577a4SJonathan Peyton 
10967cc577a4SJonathan Peyton   task->td_depnode = NULL;
1097a756cb24SAndrey Churbanov   task->td_last_tied = task;
1098405037c4SAndrey Churbanov   task->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
10997cc577a4SJonathan Peyton 
11003041982dSJonathan Peyton   if (set_curr_task) { // only do this init first time thread is created
110137e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_incomplete_child_tasks, 0);
1102642688b6SJonathan Peyton     // Not used: don't need to deallocate implicit task
110337e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_allocated_child_tasks, 0);
11047cc577a4SJonathan Peyton     task->td_taskgroup = NULL; // An implicit task does not have taskgroup
11057cc577a4SJonathan Peyton     task->td_dephash = NULL;
11067cc577a4SJonathan Peyton     __kmp_push_current_task_to_thread(this_thr, team, tid);
11077cc577a4SJonathan Peyton   } else {
11087cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_incomplete_child_tasks == 0);
11097cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_allocated_child_tasks == 0);
11107cc577a4SJonathan Peyton   }
11117cc577a4SJonathan Peyton 
11127cc577a4SJonathan Peyton #if OMPT_SUPPORT
1113f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
111482e94a59SJoachim Protze     __ompt_task_init(task, tid);
11157cc577a4SJonathan Peyton #endif
11167cc577a4SJonathan Peyton 
11173041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_init_implicit_task(exit): T#:%d team=%p task=%p\n", tid,
11183041982dSJonathan Peyton                 team, task));
11197cc577a4SJonathan Peyton }
11207cc577a4SJonathan Peyton 
11213041982dSJonathan Peyton // __kmp_finish_implicit_task: Release resources associated to implicit tasks
11223041982dSJonathan Peyton // at the end of parallel regions. Some resources are kept for reuse in the next
11233041982dSJonathan Peyton // parallel region.
11247cc577a4SJonathan Peyton //
11253041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11263041982dSJonathan Peyton void __kmp_finish_implicit_task(kmp_info_t *thread) {
11277cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1128c3344345SAndrey Churbanov   if (task->td_dephash) {
1129c3344345SAndrey Churbanov     int children;
1130c3344345SAndrey Churbanov     task->td_flags.complete = 1;
1131c3344345SAndrey Churbanov     children = KMP_ATOMIC_LD_ACQ(&task->td_incomplete_child_tasks);
1132c3344345SAndrey Churbanov     kmp_tasking_flags_t flags_old = task->td_flags;
1133c3344345SAndrey Churbanov     if (children == 0 && flags_old.complete == 1) {
1134c3344345SAndrey Churbanov       kmp_tasking_flags_t flags_new = flags_old;
1135c3344345SAndrey Churbanov       flags_new.complete = 0;
1136c3344345SAndrey Churbanov       if (KMP_COMPARE_AND_STORE_ACQ32(RCAST(kmp_int32 *, &task->td_flags),
1137c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_old),
1138c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_new))) {
1139c3344345SAndrey Churbanov         KA_TRACE(100, ("__kmp_finish_implicit_task: T#%d cleans "
1140c3344345SAndrey Churbanov                        "dephash of implicit task %p\n",
1141c3344345SAndrey Churbanov                        thread->th.th_info.ds.ds_gtid, task));
11427cc577a4SJonathan Peyton         __kmp_dephash_free_entries(thread, task->td_dephash);
11437cc577a4SJonathan Peyton       }
1144c3344345SAndrey Churbanov     }
1145c3344345SAndrey Churbanov   }
1146c3344345SAndrey Churbanov }
11477cc577a4SJonathan Peyton 
11483041982dSJonathan Peyton // __kmp_free_implicit_task: Release resources associated to implicit tasks
11493041982dSJonathan Peyton // when these are destroyed regions
11507cc577a4SJonathan Peyton //
11513041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11523041982dSJonathan Peyton void __kmp_free_implicit_task(kmp_info_t *thread) {
11537cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1154bff8ded9SJonathan Peyton   if (task && task->td_dephash) {
11557cc577a4SJonathan Peyton     __kmp_dephash_free(thread, task->td_dephash);
11567cc577a4SJonathan Peyton     task->td_dephash = NULL;
11577cc577a4SJonathan Peyton   }
1158bff8ded9SJonathan Peyton }
11597cc577a4SJonathan Peyton 
11603041982dSJonathan Peyton // Round up a size to a power of two specified by val: Used to insert padding
11613041982dSJonathan Peyton // between structures co-allocated using a single malloc() call
11623041982dSJonathan Peyton static size_t __kmp_round_up_to_val(size_t size, size_t val) {
11637cc577a4SJonathan Peyton   if (size & (val - 1)) {
11647cc577a4SJonathan Peyton     size &= ~(val - 1);
11657cc577a4SJonathan Peyton     if (size <= KMP_SIZE_T_MAX - val) {
11667cc577a4SJonathan Peyton       size += val; // Round up if there is no overflow.
1167bd3a7633SJonathan Peyton     }
1168bd3a7633SJonathan Peyton   }
11697cc577a4SJonathan Peyton   return size;
11707cc577a4SJonathan Peyton } // __kmp_round_up_to_va
11717cc577a4SJonathan Peyton 
11727cc577a4SJonathan Peyton // __kmp_task_alloc: Allocate the taskdata and task data structures for a task
11737cc577a4SJonathan Peyton //
11747cc577a4SJonathan Peyton // loc_ref: source location information
11757cc577a4SJonathan Peyton // gtid: global thread number.
11763041982dSJonathan Peyton // flags: include tiedness & task type (explicit vs. implicit) of the ''new''
11773041982dSJonathan Peyton // task encountered. Converted from kmp_int32 to kmp_tasking_flags_t in routine.
11783041982dSJonathan Peyton // sizeof_kmp_task_t:  Size in bytes of kmp_task_t data structure including
11793041982dSJonathan Peyton // private vars accessed in task.
11803041982dSJonathan Peyton // sizeof_shareds:  Size in bytes of array of pointers to shared vars accessed
11813041982dSJonathan Peyton // in task.
11827cc577a4SJonathan Peyton // task_entry: Pointer to task code entry point generated by compiler.
11837cc577a4SJonathan Peyton // returns: a pointer to the allocated kmp_task_t structure (task).
11843041982dSJonathan Peyton kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
11853041982dSJonathan Peyton                              kmp_tasking_flags_t *flags,
11867cc577a4SJonathan Peyton                              size_t sizeof_kmp_task_t, size_t sizeof_shareds,
11873041982dSJonathan Peyton                              kmp_routine_entry_t task_entry) {
11887cc577a4SJonathan Peyton   kmp_task_t *task;
11897cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
11907cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
11919d64275aSShilei Tian   kmp_info_t *encountering_thread = thread;
11927cc577a4SJonathan Peyton   kmp_team_t *team = thread->th.th_team;
11937cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
11947cc577a4SJonathan Peyton   size_t shareds_offset;
11957cc577a4SJonathan Peyton 
11966bf84871SAndreyChurbanov   if (UNLIKELY(!TCR_4(__kmp_init_middle)))
119728226e7dSJonathan Peyton     __kmp_middle_initialize();
119828226e7dSJonathan Peyton 
11999d64275aSShilei Tian   if (flags->hidden_helper) {
12009d64275aSShilei Tian     if (__kmp_enable_hidden_helper) {
12019d64275aSShilei Tian       if (!TCR_4(__kmp_init_hidden_helper))
12029d64275aSShilei Tian         __kmp_hidden_helper_initialize();
12039d64275aSShilei Tian 
12049d64275aSShilei Tian       // For a hidden helper task encountered by a regular thread, we will push
12059d64275aSShilei Tian       // the task to the (gtid%__kmp_hidden_helper_threads_num)-th hidden helper
12069d64275aSShilei Tian       // thread.
12079d64275aSShilei Tian       if (!KMP_HIDDEN_HELPER_THREAD(gtid)) {
12089d64275aSShilei Tian         thread = __kmp_threads[KMP_GTID_TO_SHADOW_GTID(gtid)];
12099d64275aSShilei Tian         // We don't change the parent-child relation for hidden helper task as
12109d64275aSShilei Tian         // we need that to do per-task-region synchronization.
12119d64275aSShilei Tian       }
12129d64275aSShilei Tian     } else {
12139d64275aSShilei Tian       // If the hidden helper task is not enabled, reset the flag to FALSE.
12149d64275aSShilei Tian       flags->hidden_helper = FALSE;
12159d64275aSShilei Tian     }
12169d64275aSShilei Tian   }
12179d64275aSShilei Tian 
12187cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_task_alloc(enter): T#%d loc=%p, flags=(0x%x) "
12197cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12207cc577a4SJonathan Peyton                 gtid, loc_ref, *((kmp_int32 *)flags), sizeof_kmp_task_t,
12217cc577a4SJonathan Peyton                 sizeof_shareds, task_entry));
12227cc577a4SJonathan Peyton 
12237cc577a4SJonathan Peyton   if (parent_task->td_flags.final) {
12247cc577a4SJonathan Peyton     if (flags->merged_if0) {
12257cc577a4SJonathan Peyton     }
12267cc577a4SJonathan Peyton     flags->final = 1;
12277cc577a4SJonathan Peyton   }
12289d64275aSShilei Tian 
1229a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED && !team->t.t_serialized) {
1230a756cb24SAndrey Churbanov     // Untied task encountered causes the TSC algorithm to check entire deque of
1231a756cb24SAndrey Churbanov     // the victim thread. If no untied task encountered, then checking the head
1232a756cb24SAndrey Churbanov     // of the deque should be enough.
12339d64275aSShilei Tian     KMP_CHECK_UPDATE(
12349d64275aSShilei Tian         encountering_thread->th.th_task_team->tt.tt_untied_task_encountered, 1);
1235a756cb24SAndrey Churbanov   }
12367cc577a4SJonathan Peyton 
1237405037c4SAndrey Churbanov   // Detachable tasks are not proxy tasks yet but could be in the future. Doing
1238405037c4SAndrey Churbanov   // the tasking setup
1239405037c4SAndrey Churbanov   // when that happens is too late.
1240838dcdb5SAndreyChurbanov   if (UNLIKELY(flags->proxy == TASK_PROXY ||
1241838dcdb5SAndreyChurbanov                flags->detachable == TASK_DETACHABLE || flags->hidden_helper)) {
12427cc577a4SJonathan Peyton     if (flags->proxy == TASK_PROXY) {
12437cc577a4SJonathan Peyton       flags->tiedness = TASK_UNTIED;
12447cc577a4SJonathan Peyton       flags->merged_if0 = 1;
1245405037c4SAndrey Churbanov     }
12463041982dSJonathan Peyton     /* are we running in a sequential parallel or tskm_immediate_exec... we need
12473041982dSJonathan Peyton        tasking support enabled */
12489d64275aSShilei Tian     if ((encountering_thread->th.th_task_team) == NULL) {
12497cc577a4SJonathan Peyton       /* This should only happen if the team is serialized
12503041982dSJonathan Peyton           setup a task team and propagate it to the thread */
12517cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(team->t.t_serialized);
12523041982dSJonathan Peyton       KA_TRACE(30,
12533041982dSJonathan Peyton                ("T#%d creating task team in __kmp_task_alloc for proxy task\n",
12543041982dSJonathan Peyton                 gtid));
12553041982dSJonathan Peyton       __kmp_task_team_setup(
12569d64275aSShilei Tian           encountering_thread, team,
12573041982dSJonathan Peyton           1); // 1 indicates setup the current team regardless of nthreads
12589d64275aSShilei Tian       encountering_thread->th.th_task_team =
12599d64275aSShilei Tian           team->t.t_task_team[encountering_thread->th.th_task_state];
12607cc577a4SJonathan Peyton     }
12619d64275aSShilei Tian     kmp_task_team_t *task_team = encountering_thread->th.th_task_team;
12627cc577a4SJonathan Peyton 
12637cc577a4SJonathan Peyton     /* tasking must be enabled now as the task might not be pushed */
12647cc577a4SJonathan Peyton     if (!KMP_TASKING_ENABLED(task_team)) {
12653041982dSJonathan Peyton       KA_TRACE(
12663041982dSJonathan Peyton           30,
12673041982dSJonathan Peyton           ("T#%d enabling tasking in __kmp_task_alloc for proxy task\n", gtid));
12689d64275aSShilei Tian       __kmp_enable_tasking(task_team, encountering_thread);
12699d64275aSShilei Tian       kmp_int32 tid = encountering_thread->th.th_info.ds.ds_tid;
12707cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
12717cc577a4SJonathan Peyton       // No lock needed since only owner can allocate
12727cc577a4SJonathan Peyton       if (thread_data->td.td_deque == NULL) {
12739d64275aSShilei Tian         __kmp_alloc_task_deque(encountering_thread, thread_data);
12747cc577a4SJonathan Peyton       }
12757cc577a4SJonathan Peyton     }
12767cc577a4SJonathan Peyton 
12773c31b784SShilei Tian     if ((flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE) &&
12789d64275aSShilei Tian         task_team->tt.tt_found_proxy_tasks == FALSE)
12797cc577a4SJonathan Peyton       TCW_4(task_team->tt.tt_found_proxy_tasks, TRUE);
12809d64275aSShilei Tian     if (flags->hidden_helper &&
12819d64275aSShilei Tian         task_team->tt.tt_hidden_helper_task_encountered == FALSE)
12829d64275aSShilei Tian       TCW_4(task_team->tt.tt_hidden_helper_task_encountered, TRUE);
12837cc577a4SJonathan Peyton   }
12847cc577a4SJonathan Peyton 
12857cc577a4SJonathan Peyton   // Calculate shared structure offset including padding after kmp_task_t struct
12867cc577a4SJonathan Peyton   // to align pointers in shared struct
12877cc577a4SJonathan Peyton   shareds_offset = sizeof(kmp_taskdata_t) + sizeof_kmp_task_t;
12887cc577a4SJonathan Peyton   shareds_offset = __kmp_round_up_to_val(shareds_offset, sizeof(void *));
12897cc577a4SJonathan Peyton 
12907cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
12913041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d First malloc size: %ld\n", gtid,
12923041982dSJonathan Peyton                 shareds_offset));
12933041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d Second malloc size: %ld\n", gtid,
12943041982dSJonathan Peyton                 sizeof_shareds));
12957cc577a4SJonathan Peyton 
12967cc577a4SJonathan Peyton   // Avoid double allocation here by combining shareds with taskdata
12977cc577a4SJonathan Peyton #if USE_FAST_MEMORY
12989d64275aSShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(
12999d64275aSShilei Tian       encountering_thread, shareds_offset + sizeof_shareds);
13007cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
13019d64275aSShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(
13029d64275aSShilei Tian       encountering_thread, shareds_offset + sizeof_shareds);
13037cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
13047cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_AFTER(taskdata);
13057cc577a4SJonathan Peyton 
13067cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
13077cc577a4SJonathan Peyton 
13087cc577a4SJonathan Peyton // Make sure task & taskdata are aligned appropriately
13097cc577a4SJonathan Peyton #if KMP_ARCH_X86 || KMP_ARCH_PPC64 || !KMP_HAVE_QUAD
13107cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(double) - 1)) == 0);
13117cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(double) - 1)) == 0);
13127cc577a4SJonathan Peyton #else
13137cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(_Quad) - 1)) == 0);
13147cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(_Quad) - 1)) == 0);
13157cc577a4SJonathan Peyton #endif
13167cc577a4SJonathan Peyton   if (sizeof_shareds > 0) {
13177cc577a4SJonathan Peyton     // Avoid double allocation here by combining shareds with taskdata
13187cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
13197cc577a4SJonathan Peyton     // Make sure shareds struct is aligned to pointer size
13203041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
13213041982dSJonathan Peyton                      0);
13227cc577a4SJonathan Peyton   } else {
13237cc577a4SJonathan Peyton     task->shareds = NULL;
13247cc577a4SJonathan Peyton   }
13257cc577a4SJonathan Peyton   task->routine = task_entry;
13267cc577a4SJonathan Peyton   task->part_id = 0; // AC: Always start with 0 part id
13277cc577a4SJonathan Peyton 
13287cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
13299d64275aSShilei Tian   taskdata->td_team = thread->th.th_team;
13309d64275aSShilei Tian   taskdata->td_alloc_thread = encountering_thread;
13317cc577a4SJonathan Peyton   taskdata->td_parent = parent_task;
13327cc577a4SJonathan Peyton   taskdata->td_level = parent_task->td_level + 1; // increment nesting level
133337e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_untied_count, 0);
13347cc577a4SJonathan Peyton   taskdata->td_ident = loc_ref;
13357cc577a4SJonathan Peyton   taskdata->td_taskwait_ident = NULL;
13367cc577a4SJonathan Peyton   taskdata->td_taskwait_counter = 0;
13377cc577a4SJonathan Peyton   taskdata->td_taskwait_thread = 0;
13387cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_parent != NULL);
13397cc577a4SJonathan Peyton   // avoid copying icvs for proxy tasks
13407cc577a4SJonathan Peyton   if (flags->proxy == TASK_FULL)
13417cc577a4SJonathan Peyton     copy_icvs(&taskdata->td_icvs, &taskdata->td_parent->td_icvs);
13427cc577a4SJonathan Peyton 
13437cc577a4SJonathan Peyton   taskdata->td_flags.tiedness = flags->tiedness;
13447cc577a4SJonathan Peyton   taskdata->td_flags.final = flags->final;
13457cc577a4SJonathan Peyton   taskdata->td_flags.merged_if0 = flags->merged_if0;
13467cc577a4SJonathan Peyton   taskdata->td_flags.destructors_thunk = flags->destructors_thunk;
13477cc577a4SJonathan Peyton   taskdata->td_flags.proxy = flags->proxy;
1348405037c4SAndrey Churbanov   taskdata->td_flags.detachable = flags->detachable;
13499d64275aSShilei Tian   taskdata->td_flags.hidden_helper = flags->hidden_helper;
13509d64275aSShilei Tian   taskdata->encountering_gtid = gtid;
13517cc577a4SJonathan Peyton   taskdata->td_task_team = thread->th.th_task_team;
13527cc577a4SJonathan Peyton   taskdata->td_size_alloc = shareds_offset + sizeof_shareds;
13537cc577a4SJonathan Peyton   taskdata->td_flags.tasktype = TASK_EXPLICIT;
13547cc577a4SJonathan Peyton 
13557cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of tasking_ser flag
13567cc577a4SJonathan Peyton   taskdata->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
13577cc577a4SJonathan Peyton 
13587cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of team_serial flag
13597cc577a4SJonathan Peyton   taskdata->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
13607cc577a4SJonathan Peyton 
13613041982dSJonathan Peyton   // GEH - Note we serialize the task if the team is serialized to make sure
13623041982dSJonathan Peyton   // implicit parallel region tasks are not left until program termination to
13633041982dSJonathan Peyton   // execute. Also, it helps locality to execute immediately.
13643041982dSJonathan Peyton 
13653041982dSJonathan Peyton   taskdata->td_flags.task_serial =
13663041982dSJonathan Peyton       (parent_task->td_flags.final || taskdata->td_flags.team_serial ||
1367add8d90cSJoachim Protze        taskdata->td_flags.tasking_ser || flags->merged_if0);
13687cc577a4SJonathan Peyton 
13697cc577a4SJonathan Peyton   taskdata->td_flags.started = 0;
13707cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0;
13717cc577a4SJonathan Peyton   taskdata->td_flags.complete = 0;
13727cc577a4SJonathan Peyton   taskdata->td_flags.freed = 0;
13737cc577a4SJonathan Peyton 
13747cc577a4SJonathan Peyton   taskdata->td_flags.native = flags->native;
13757cc577a4SJonathan Peyton 
137637e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_incomplete_child_tasks, 0);
137737e2ef54SJonathan Peyton   // start at one because counts current task and children
137837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_allocated_child_tasks, 1);
13793041982dSJonathan Peyton   taskdata->td_taskgroup =
13803041982dSJonathan Peyton       parent_task->td_taskgroup; // task inherits taskgroup from the parent task
13817cc577a4SJonathan Peyton   taskdata->td_dephash = NULL;
13827cc577a4SJonathan Peyton   taskdata->td_depnode = NULL;
1383a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED)
1384a756cb24SAndrey Churbanov     taskdata->td_last_tied = NULL; // will be set when the task is scheduled
1385a756cb24SAndrey Churbanov   else
1386a756cb24SAndrey Churbanov     taskdata->td_last_tied = taskdata;
1387405037c4SAndrey Churbanov   taskdata->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
138886ed6aa6SJoachim Protze #if OMPT_SUPPORT
138986ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled))
139086ed6aa6SJoachim Protze     __ompt_task_init(taskdata, gtid);
139186ed6aa6SJoachim Protze #endif
13929d64275aSShilei Tian   // Only need to keep track of child task counts if team parallel and tasking
13939d64275aSShilei Tian   // not serialized or if it is a proxy or detachable or hidden helper task
13949d64275aSShilei Tian   if (flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE ||
13959d64275aSShilei Tian       flags->hidden_helper ||
13969d64275aSShilei Tian       !(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
139737e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
13987cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
139937e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
14003041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
14013041982dSJonathan Peyton     // implicit not deallocated
14027cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT) {
140337e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
14047cc577a4SJonathan Peyton     }
14057cc577a4SJonathan Peyton   }
14067cc577a4SJonathan Peyton 
14079d64275aSShilei Tian   if (flags->hidden_helper) {
14089d64275aSShilei Tian     taskdata->td_flags.task_serial = FALSE;
14099d64275aSShilei Tian     // Increment the number of hidden helper tasks to be executed
14109d64275aSShilei Tian     KMP_ATOMIC_INC(&__kmp_unexecuted_hidden_helper_tasks);
14119d64275aSShilei Tian   }
14129d64275aSShilei Tian 
14137cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_task_alloc(exit): T#%d created task %p parent=%p\n",
14147cc577a4SJonathan Peyton                 gtid, taskdata, taskdata->td_parent));
14157cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(task);
14167cc577a4SJonathan Peyton 
14177cc577a4SJonathan Peyton   return task;
14187cc577a4SJonathan Peyton }
14197cc577a4SJonathan Peyton 
14203041982dSJonathan Peyton kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
14213041982dSJonathan Peyton                                   kmp_int32 flags, size_t sizeof_kmp_task_t,
14223041982dSJonathan Peyton                                   size_t sizeof_shareds,
14233041982dSJonathan Peyton                                   kmp_routine_entry_t task_entry) {
14247cc577a4SJonathan Peyton   kmp_task_t *retval;
14257cc577a4SJonathan Peyton   kmp_tasking_flags_t *input_flags = (kmp_tasking_flags_t *)&flags;
1426787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
14277cc577a4SJonathan Peyton   input_flags->native = FALSE;
14287cc577a4SJonathan Peyton   // __kmp_task_alloc() sets up all other runtime flags
1429405037c4SAndrey Churbanov   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s %s %s) "
1430405037c4SAndrey Churbanov                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
1431405037c4SAndrey Churbanov                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
1432405037c4SAndrey Churbanov                 input_flags->proxy ? "proxy" : "",
1433405037c4SAndrey Churbanov                 input_flags->detachable ? "detachable" : "", sizeof_kmp_task_t,
1434405037c4SAndrey Churbanov                 sizeof_shareds, task_entry));
14357cc577a4SJonathan Peyton 
14367cc577a4SJonathan Peyton   retval = __kmp_task_alloc(loc_ref, gtid, input_flags, sizeof_kmp_task_t,
14377cc577a4SJonathan Peyton                             sizeof_shareds, task_entry);
14387cc577a4SJonathan Peyton 
14397cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmpc_omp_task_alloc(exit): T#%d retval %p\n", gtid, retval));
14407cc577a4SJonathan Peyton 
14417cc577a4SJonathan Peyton   return retval;
14427cc577a4SJonathan Peyton }
14437cc577a4SJonathan Peyton 
1444b48e44a6SGheorghe-Teodor Bercea kmp_task_t *__kmpc_omp_target_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
1445b48e44a6SGheorghe-Teodor Bercea                                          kmp_int32 flags,
1446b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_kmp_task_t,
1447b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_shareds,
1448b48e44a6SGheorghe-Teodor Bercea                                          kmp_routine_entry_t task_entry,
1449b48e44a6SGheorghe-Teodor Bercea                                          kmp_int64 device_id) {
14509d64275aSShilei Tian   if (__kmp_enable_hidden_helper) {
14519d64275aSShilei Tian     auto &input_flags = reinterpret_cast<kmp_tasking_flags_t &>(flags);
14529d64275aSShilei Tian     input_flags.hidden_helper = TRUE;
14539d64275aSShilei Tian   }
14549d64275aSShilei Tian 
1455b48e44a6SGheorghe-Teodor Bercea   return __kmpc_omp_task_alloc(loc_ref, gtid, flags, sizeof_kmp_task_t,
1456b48e44a6SGheorghe-Teodor Bercea                                sizeof_shareds, task_entry);
1457b48e44a6SGheorghe-Teodor Bercea }
1458b48e44a6SGheorghe-Teodor Bercea 
1459b04f7d68SJonathan Peyton /*!
1460b04f7d68SJonathan Peyton @ingroup TASKING
1461b04f7d68SJonathan Peyton @param loc_ref location of the original task directive
1462b04f7d68SJonathan Peyton @param gtid Global Thread ID of encountering thread
1463b04f7d68SJonathan Peyton @param new_task task thunk allocated by __kmpc_omp_task_alloc() for the ''new
1464b04f7d68SJonathan Peyton task''
1465b04f7d68SJonathan Peyton @param naffins Number of affinity items
1466b04f7d68SJonathan Peyton @param affin_list List of affinity items
1467b04f7d68SJonathan Peyton @return Returns non-zero if registering affinity information was not successful.
1468b04f7d68SJonathan Peyton  Returns 0 if registration was successful
1469b04f7d68SJonathan Peyton This entry registers the affinity information attached to a task with the task
1470b04f7d68SJonathan Peyton thunk structure kmp_taskdata_t.
1471b04f7d68SJonathan Peyton */
1472b04f7d68SJonathan Peyton kmp_int32
1473b04f7d68SJonathan Peyton __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref, kmp_int32 gtid,
1474b04f7d68SJonathan Peyton                                   kmp_task_t *new_task, kmp_int32 naffins,
1475b04f7d68SJonathan Peyton                                   kmp_task_affinity_info_t *affin_list) {
1476b04f7d68SJonathan Peyton   return 0;
1477b04f7d68SJonathan Peyton }
1478b04f7d68SJonathan Peyton 
14797cc577a4SJonathan Peyton //  __kmp_invoke_task: invoke the specified task
14807cc577a4SJonathan Peyton //
14817cc577a4SJonathan Peyton // gtid: global thread ID of caller
14827cc577a4SJonathan Peyton // task: the task to invoke
148342016791SKazuaki Ishizaki // current_task: the task to resume after task invocation
14843041982dSJonathan Peyton static void __kmp_invoke_task(kmp_int32 gtid, kmp_task_t *task,
14853041982dSJonathan Peyton                               kmp_taskdata_t *current_task) {
14867cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
1487b1b221c8SJonathan Peyton   kmp_info_t *thread;
14887cc577a4SJonathan Peyton   int discard = 0 /* false */;
14893041982dSJonathan Peyton   KA_TRACE(
14903041982dSJonathan Peyton       30, ("__kmp_invoke_task(enter): T#%d invoking task %p, current_task=%p\n",
14917cc577a4SJonathan Peyton            gtid, taskdata, current_task));
14927cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task);
14936bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.proxy == TASK_PROXY &&
14946bf84871SAndreyChurbanov                taskdata->td_flags.complete == 1)) {
14957cc577a4SJonathan Peyton     // This is a proxy task that was already completed but it needs to run
14967cc577a4SJonathan Peyton     // its bottom-half finish
14973041982dSJonathan Peyton     KA_TRACE(
14983041982dSJonathan Peyton         30,
14993041982dSJonathan Peyton         ("__kmp_invoke_task: T#%d running bottom finish for proxy task %p\n",
15007cc577a4SJonathan Peyton          gtid, taskdata));
15017cc577a4SJonathan Peyton 
15027cc577a4SJonathan Peyton     __kmp_bottom_half_finish_proxy(gtid, task);
15037cc577a4SJonathan Peyton 
15043041982dSJonathan Peyton     KA_TRACE(30, ("__kmp_invoke_task(exit): T#%d completed bottom finish for "
15053041982dSJonathan Peyton                   "proxy task %p, resuming task %p\n",
15063041982dSJonathan Peyton                   gtid, taskdata, current_task));
15077cc577a4SJonathan Peyton 
15087cc577a4SJonathan Peyton     return;
15097cc577a4SJonathan Peyton   }
15107cc577a4SJonathan Peyton 
15117cc577a4SJonathan Peyton #if OMPT_SUPPORT
151286ed6aa6SJoachim Protze   // For untied tasks, the first task executed only calls __kmpc_omp_task and
151386ed6aa6SJoachim Protze   // does not execute code.
15147cc577a4SJonathan Peyton   ompt_thread_info_t oldInfo;
1515f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
15167cc577a4SJonathan Peyton     // Store the threads states and restore them after the task
15177cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
15187cc577a4SJonathan Peyton     oldInfo = thread->th.ompt_thread_info;
15197cc577a4SJonathan Peyton     thread->th.ompt_thread_info.wait_id = 0;
152082e94a59SJoachim Protze     thread->th.ompt_thread_info.state = (thread->th.th_team_serialized)
15210e0d6cddSJoachim Protze                                             ? ompt_state_work_serial
15220e0d6cddSJoachim Protze                                             : ompt_state_work_parallel;
15230e0d6cddSJoachim Protze     taskdata->ompt_task_info.frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
15247cc577a4SJonathan Peyton   }
15257cc577a4SJonathan Peyton #endif
15267cc577a4SJonathan Peyton 
15279d64275aSShilei Tian   // Decreament the counter of hidden helper tasks to be executed
15289d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
15299d64275aSShilei Tian     // Hidden helper tasks can only be executed by hidden helper threads
15309d64275aSShilei Tian     KMP_ASSERT(KMP_HIDDEN_HELPER_THREAD(gtid));
15319d64275aSShilei Tian     KMP_ATOMIC_DEC(&__kmp_unexecuted_hidden_helper_tasks);
15329d64275aSShilei Tian   }
15339d64275aSShilei Tian 
153486ed6aa6SJoachim Protze   // Proxy tasks are not handled by the runtime
153586ed6aa6SJoachim Protze   if (taskdata->td_flags.proxy != TASK_PROXY) {
153686ed6aa6SJoachim Protze     ANNOTATE_HAPPENS_AFTER(task);
153786ed6aa6SJoachim Protze     __kmp_task_start(gtid, task, current_task); // OMPT only if not discarded
153886ed6aa6SJoachim Protze   }
153986ed6aa6SJoachim Protze 
15407cc577a4SJonathan Peyton   // TODO: cancel tasks if the parallel region has also been cancelled
15417cc577a4SJonathan Peyton   // TODO: check if this sequence can be hoisted above __kmp_task_start
15427cc577a4SJonathan Peyton   // if cancellation has been enabled for this run ...
15436bf84871SAndreyChurbanov   if (UNLIKELY(__kmp_omp_cancellation)) {
1544b1b221c8SJonathan Peyton     thread = __kmp_threads[gtid];
1545b1b221c8SJonathan Peyton     kmp_team_t *this_team = thread->th.th_team;
15467cc577a4SJonathan Peyton     kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
15473041982dSJonathan Peyton     if ((taskgroup && taskgroup->cancel_request) ||
15483041982dSJonathan Peyton         (this_team->t.t_cancel_request == cancel_parallel)) {
154982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
155082e94a59SJoachim Protze       ompt_data_t *task_data;
1551f0a1c65fSJonas Hahnfeld       if (UNLIKELY(ompt_enabled.ompt_callback_cancel)) {
155282e94a59SJoachim Protze         __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
155382e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_cancel)(
155482e94a59SJoachim Protze             task_data,
155582e94a59SJoachim Protze             ((taskgroup && taskgroup->cancel_request) ? ompt_cancel_taskgroup
155682e94a59SJoachim Protze                                                       : ompt_cancel_parallel) |
155782e94a59SJoachim Protze                 ompt_cancel_discarded_task,
155882e94a59SJoachim Protze             NULL);
155982e94a59SJoachim Protze       }
156082e94a59SJoachim Protze #endif
15617cc577a4SJonathan Peyton       KMP_COUNT_BLOCK(TASK_cancelled);
15627cc577a4SJonathan Peyton       // this task belongs to a task group and we need to cancel it
15637cc577a4SJonathan Peyton       discard = 1 /* true */;
15647cc577a4SJonathan Peyton     }
15657cc577a4SJonathan Peyton   }
15667cc577a4SJonathan Peyton 
15677cc577a4SJonathan Peyton   // Invoke the task routine and pass in relevant data.
15687cc577a4SJonathan Peyton   // Thunks generated by gcc take a different argument list.
15697cc577a4SJonathan Peyton   if (!discard) {
1570a756cb24SAndrey Churbanov     if (taskdata->td_flags.tiedness == TASK_UNTIED) {
1571a756cb24SAndrey Churbanov       taskdata->td_last_tied = current_task->td_last_tied;
1572a756cb24SAndrey Churbanov       KMP_DEBUG_ASSERT(taskdata->td_last_tied);
1573a756cb24SAndrey Churbanov     }
15747cc577a4SJonathan Peyton #if KMP_STATS_ENABLED
15757cc577a4SJonathan Peyton     KMP_COUNT_BLOCK(TASK_executed);
15767cc577a4SJonathan Peyton     switch (KMP_GET_THREAD_STATE()) {
15773041982dSJonathan Peyton     case FORK_JOIN_BARRIER:
15783041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_join_bar);
15793041982dSJonathan Peyton       break;
15803041982dSJonathan Peyton     case PLAIN_BARRIER:
15813041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_plain_bar);
15823041982dSJonathan Peyton       break;
15833041982dSJonathan Peyton     case TASKYIELD:
15843041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskyield);
15853041982dSJonathan Peyton       break;
15863041982dSJonathan Peyton     case TASKWAIT:
15873041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskwait);
15883041982dSJonathan Peyton       break;
15893041982dSJonathan Peyton     case TASKGROUP:
15903041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskgroup);
15913041982dSJonathan Peyton       break;
15923041982dSJonathan Peyton     default:
15933041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_immediate);
15943041982dSJonathan Peyton       break;
15957cc577a4SJonathan Peyton     }
15967cc577a4SJonathan Peyton #endif // KMP_STATS_ENABLED
15977cc577a4SJonathan Peyton 
159882e94a59SJoachim Protze // OMPT task begin
159982e94a59SJoachim Protze #if OMPT_SUPPORT
1600f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.enabled))
160182e94a59SJoachim Protze       __ompt_task_start(task, current_task, gtid);
16027cc577a4SJonathan Peyton #endif
16037cc577a4SJonathan Peyton 
1604b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1605b1b221c8SJonathan Peyton     kmp_uint64 cur_time;
1606b1b221c8SJonathan Peyton     kmp_int32 kmp_itt_count_task =
1607b1b221c8SJonathan Peyton         __kmp_forkjoin_frames_mode == 3 && !taskdata->td_flags.task_serial &&
1608b1b221c8SJonathan Peyton         current_task->td_flags.tasktype == TASK_IMPLICIT;
1609b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1610b1b221c8SJonathan Peyton       thread = __kmp_threads[gtid];
1611b1b221c8SJonathan Peyton       // Time outer level explicit task on barrier for adjusting imbalance time
1612b1b221c8SJonathan Peyton       if (thread->th.th_bar_arrive_time)
1613b1b221c8SJonathan Peyton         cur_time = __itt_get_timestamp();
1614b1b221c8SJonathan Peyton       else
1615b1b221c8SJonathan Peyton         kmp_itt_count_task = 0; // thread is not on a barrier - skip timing
1616b1b221c8SJonathan Peyton     }
1617ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquired self (new task)
1618b1b221c8SJonathan Peyton #endif
1619b1b221c8SJonathan Peyton 
16207cc577a4SJonathan Peyton #ifdef KMP_GOMP_COMPAT
16217cc577a4SJonathan Peyton     if (taskdata->td_flags.native) {
16227cc577a4SJonathan Peyton       ((void (*)(void *))(*(task->routine)))(task->shareds);
16233041982dSJonathan Peyton     } else
16247cc577a4SJonathan Peyton #endif /* KMP_GOMP_COMPAT */
16257cc577a4SJonathan Peyton     {
16267cc577a4SJonathan Peyton       (*(task->routine))(gtid, task);
16277cc577a4SJonathan Peyton     }
16287cc577a4SJonathan Peyton     KMP_POP_PARTITIONED_TIMER();
16297cc577a4SJonathan Peyton 
1630b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1631b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1632b1b221c8SJonathan Peyton       // Barrier imbalance - adjust arrive time with the task duration
1633b1b221c8SJonathan Peyton       thread->th.th_bar_arrive_time += (__itt_get_timestamp() - cur_time);
1634b1b221c8SJonathan Peyton     }
1635ffd8f009SAndreyChurbanov     KMP_FSYNC_CANCEL(taskdata); // destroy self (just executed)
1636ffd8f009SAndreyChurbanov     KMP_FSYNC_RELEASING(taskdata->td_parent); // releasing parent
1637b1b221c8SJonathan Peyton #endif
16387cc577a4SJonathan Peyton   }
16397cc577a4SJonathan Peyton 
16407cc577a4SJonathan Peyton   // Proxy tasks are not handled by the runtime
16417cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy != TASK_PROXY) {
16427cc577a4SJonathan Peyton     ANNOTATE_HAPPENS_BEFORE(taskdata->td_parent);
164386ed6aa6SJoachim Protze #if OMPT_SUPPORT
164486ed6aa6SJoachim Protze     if (UNLIKELY(ompt_enabled.enabled)) {
164586ed6aa6SJoachim Protze       thread->th.ompt_thread_info = oldInfo;
164686ed6aa6SJoachim Protze       if (taskdata->td_flags.tiedness == TASK_TIED) {
16470e0d6cddSJoachim Protze         taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
164886ed6aa6SJoachim Protze       }
164986ed6aa6SJoachim Protze       __kmp_task_finish<true>(gtid, task, current_task);
165086ed6aa6SJoachim Protze     } else
165186ed6aa6SJoachim Protze #endif
165286ed6aa6SJoachim Protze       __kmp_task_finish<false>(gtid, task, current_task);
16537cc577a4SJonathan Peyton   }
16547cc577a4SJonathan Peyton 
16553041982dSJonathan Peyton   KA_TRACE(
16563041982dSJonathan Peyton       30,
16573041982dSJonathan Peyton       ("__kmp_invoke_task(exit): T#%d completed task %p, resuming task %p\n",
16587cc577a4SJonathan Peyton        gtid, taskdata, current_task));
16597cc577a4SJonathan Peyton   return;
16607cc577a4SJonathan Peyton }
16617cc577a4SJonathan Peyton 
16627cc577a4SJonathan Peyton // __kmpc_omp_task_parts: Schedule a thread-switchable task for execution
16637cc577a4SJonathan Peyton //
16647cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
16657cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
16667cc577a4SJonathan Peyton // new_task: task thunk allocated by __kmp_omp_task_alloc() for the ''new task''
16677cc577a4SJonathan Peyton // Returns:
16683041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
16693041982dSJonathan Peyton //    be resumed later.
16703041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
16713041982dSJonathan Peyton //    resumed later.
16723041982dSJonathan Peyton kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
16733041982dSJonathan Peyton                                 kmp_task_t *new_task) {
16747cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
16757cc577a4SJonathan Peyton 
16763041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_parts(enter): T#%d loc=%p task=%p\n", gtid,
16773041982dSJonathan Peyton                 loc_ref, new_taskdata));
16787cc577a4SJonathan Peyton 
167982e94a59SJoachim Protze #if OMPT_SUPPORT
168082e94a59SJoachim Protze   kmp_taskdata_t *parent;
1681f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
168282e94a59SJoachim Protze     parent = new_taskdata->td_parent;
168382e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
168482e94a59SJoachim Protze       ompt_data_t task_data = ompt_data_none;
168582e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
168682e94a59SJoachim Protze           parent ? &(parent->ompt_task_info.task_data) : &task_data,
168782e94a59SJoachim Protze           parent ? &(parent->ompt_task_info.frame) : NULL,
168882e94a59SJoachim Protze           &(new_taskdata->ompt_task_info.task_data), ompt_task_explicit, 0,
168982e94a59SJoachim Protze           OMPT_GET_RETURN_ADDRESS(0));
169082e94a59SJoachim Protze     }
169182e94a59SJoachim Protze   }
169282e94a59SJoachim Protze #endif
169382e94a59SJoachim Protze 
16943041982dSJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
16953041982dSJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
16967cc577a4SJonathan Peyton 
16977cc577a4SJonathan Peyton   if (__kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
16987cc577a4SJonathan Peyton   { // Execute this task immediately
16997cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
17007cc577a4SJonathan Peyton     new_taskdata->td_flags.task_serial = 1;
17017cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
17027cc577a4SJonathan Peyton   }
17037cc577a4SJonathan Peyton 
17043041982dSJonathan Peyton   KA_TRACE(
17053041982dSJonathan Peyton       10,
17063041982dSJonathan Peyton       ("__kmpc_omp_task_parts(exit): T#%d returning TASK_CURRENT_NOT_QUEUED: "
17073041982dSJonathan Peyton        "loc=%p task=%p, return: TASK_CURRENT_NOT_QUEUED\n",
17083041982dSJonathan Peyton        gtid, loc_ref, new_taskdata));
17097cc577a4SJonathan Peyton 
17107cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(new_task);
171182e94a59SJoachim Protze #if OMPT_SUPPORT
1712f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
17130e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
171482e94a59SJoachim Protze   }
171582e94a59SJoachim Protze #endif
17167cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17177cc577a4SJonathan Peyton }
17187cc577a4SJonathan Peyton 
17197cc577a4SJonathan Peyton // __kmp_omp_task: Schedule a non-thread-switchable task for execution
17203041982dSJonathan Peyton //
17217cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17227cc577a4SJonathan Peyton // new_task:non-thread-switchable task thunk allocated by __kmp_omp_task_alloc()
17233041982dSJonathan Peyton // serialize_immediate: if TRUE then if the task is executed immediately its
17243041982dSJonathan Peyton // execution will be serialized
17253041982dSJonathan Peyton // Returns:
17263041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17273041982dSJonathan Peyton //    be resumed later.
17283041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17293041982dSJonathan Peyton //    resumed later.
17303041982dSJonathan Peyton kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
17313041982dSJonathan Peyton                          bool serialize_immediate) {
17327cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17337cc577a4SJonathan Peyton 
1734e4b4f994SJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
1735e4b4f994SJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
17363041982dSJonathan Peyton   if (new_taskdata->td_flags.proxy == TASK_PROXY ||
17373041982dSJonathan Peyton       __kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
17387cc577a4SJonathan Peyton   { // Execute this task immediately
17397cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
17407cc577a4SJonathan Peyton     if (serialize_immediate)
17417cc577a4SJonathan Peyton       new_taskdata->td_flags.task_serial = 1;
17427cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
17437cc577a4SJonathan Peyton   }
17447cc577a4SJonathan Peyton 
17457cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(new_task);
17467cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17477cc577a4SJonathan Peyton }
17487cc577a4SJonathan Peyton 
17493041982dSJonathan Peyton // __kmpc_omp_task: Wrapper around __kmp_omp_task to schedule a
17503041982dSJonathan Peyton // non-thread-switchable task from the parent thread only!
17513041982dSJonathan Peyton //
17527cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
17537cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17543041982dSJonathan Peyton // new_task: non-thread-switchable task thunk allocated by
17553041982dSJonathan Peyton // __kmp_omp_task_alloc()
17563041982dSJonathan Peyton // Returns:
17573041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17583041982dSJonathan Peyton //    be resumed later.
17593041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17603041982dSJonathan Peyton //    resumed later.
17613041982dSJonathan Peyton kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
17623041982dSJonathan Peyton                           kmp_task_t *new_task) {
17637cc577a4SJonathan Peyton   kmp_int32 res;
17647cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
17657cc577a4SJonathan Peyton 
176682e94a59SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
17677cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17687cc577a4SJonathan Peyton #endif
17693041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
17703041982dSJonathan Peyton                 new_taskdata));
1771787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
17727cc577a4SJonathan Peyton 
177382e94a59SJoachim Protze #if OMPT_SUPPORT
177482e94a59SJoachim Protze   kmp_taskdata_t *parent = NULL;
177586ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
177686ed6aa6SJoachim Protze     if (!new_taskdata->td_flags.started) {
177782e94a59SJoachim Protze       OMPT_STORE_RETURN_ADDRESS(gtid);
177882e94a59SJoachim Protze       parent = new_taskdata->td_parent;
17790e0d6cddSJoachim Protze       if (!parent->ompt_task_info.frame.enter_frame.ptr) {
1780*309b00a4SShilei Tian         parent->ompt_task_info.frame.enter_frame.ptr =
1781*309b00a4SShilei Tian             OMPT_GET_FRAME_ADDRESS(0);
178286ed6aa6SJoachim Protze       }
178382e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_task_create) {
178482e94a59SJoachim Protze         ompt_data_t task_data = ompt_data_none;
178582e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_task_create)(
178682e94a59SJoachim Protze             parent ? &(parent->ompt_task_info.task_data) : &task_data,
178782e94a59SJoachim Protze             parent ? &(parent->ompt_task_info.frame) : NULL,
178882e94a59SJoachim Protze             &(new_taskdata->ompt_task_info.task_data),
178982e94a59SJoachim Protze             ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
179082e94a59SJoachim Protze             OMPT_LOAD_RETURN_ADDRESS(gtid));
179182e94a59SJoachim Protze       }
179286ed6aa6SJoachim Protze     } else {
179386ed6aa6SJoachim Protze       // We are scheduling the continuation of an UNTIED task.
179486ed6aa6SJoachim Protze       // Scheduling back to the parent task.
179586ed6aa6SJoachim Protze       __ompt_task_finish(new_task,
179686ed6aa6SJoachim Protze                          new_taskdata->ompt_task_info.scheduling_parent,
1797489cdb78SJoachim Protze                          ompt_task_switch);
17980e0d6cddSJoachim Protze       new_taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
179986ed6aa6SJoachim Protze     }
180082e94a59SJoachim Protze   }
180182e94a59SJoachim Protze #endif
180282e94a59SJoachim Protze 
18037cc577a4SJonathan Peyton   res = __kmp_omp_task(gtid, new_task, true);
18047cc577a4SJonathan Peyton 
18053041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
18063041982dSJonathan Peyton                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
18077cc577a4SJonathan Peyton                 gtid, loc_ref, new_taskdata));
180882e94a59SJoachim Protze #if OMPT_SUPPORT
1809f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18100e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
181182e94a59SJoachim Protze   }
181282e94a59SJoachim Protze #endif
18137cc577a4SJonathan Peyton   return res;
18147cc577a4SJonathan Peyton }
18157cc577a4SJonathan Peyton 
1816cdaefac5SJoachim Protze // __kmp_omp_taskloop_task: Wrapper around __kmp_omp_task to schedule
1817cdaefac5SJoachim Protze // a taskloop task with the correct OMPT return address
1818cdaefac5SJoachim Protze //
1819cdaefac5SJoachim Protze // loc_ref: location of original task pragma (ignored)
1820cdaefac5SJoachim Protze // gtid: Global Thread ID of encountering thread
1821cdaefac5SJoachim Protze // new_task: non-thread-switchable task thunk allocated by
1822cdaefac5SJoachim Protze // __kmp_omp_task_alloc()
1823cdaefac5SJoachim Protze // codeptr_ra: return address for OMPT callback
1824cdaefac5SJoachim Protze // Returns:
1825cdaefac5SJoachim Protze //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
1826cdaefac5SJoachim Protze //    be resumed later.
1827cdaefac5SJoachim Protze //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
1828cdaefac5SJoachim Protze //    resumed later.
1829cdaefac5SJoachim Protze kmp_int32 __kmp_omp_taskloop_task(ident_t *loc_ref, kmp_int32 gtid,
1830cdaefac5SJoachim Protze                                   kmp_task_t *new_task, void *codeptr_ra) {
1831cdaefac5SJoachim Protze   kmp_int32 res;
1832cdaefac5SJoachim Protze   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
1833cdaefac5SJoachim Protze 
1834cdaefac5SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
1835cdaefac5SJoachim Protze   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
1836cdaefac5SJoachim Protze #endif
1837cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
1838cdaefac5SJoachim Protze                 new_taskdata));
1839cdaefac5SJoachim Protze 
1840cdaefac5SJoachim Protze #if OMPT_SUPPORT
1841cdaefac5SJoachim Protze   kmp_taskdata_t *parent = NULL;
1842cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && !new_taskdata->td_flags.started)) {
1843cdaefac5SJoachim Protze     parent = new_taskdata->td_parent;
18440e0d6cddSJoachim Protze     if (!parent->ompt_task_info.frame.enter_frame.ptr)
18450e0d6cddSJoachim Protze       parent->ompt_task_info.frame.enter_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
1846cdaefac5SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
1847cdaefac5SJoachim Protze       ompt_data_t task_data = ompt_data_none;
1848cdaefac5SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1849cdaefac5SJoachim Protze           parent ? &(parent->ompt_task_info.task_data) : &task_data,
1850cdaefac5SJoachim Protze           parent ? &(parent->ompt_task_info.frame) : NULL,
1851cdaefac5SJoachim Protze           &(new_taskdata->ompt_task_info.task_data),
1852cdaefac5SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
1853cdaefac5SJoachim Protze           codeptr_ra);
1854cdaefac5SJoachim Protze     }
1855cdaefac5SJoachim Protze   }
1856cdaefac5SJoachim Protze #endif
1857cdaefac5SJoachim Protze 
1858cdaefac5SJoachim Protze   res = __kmp_omp_task(gtid, new_task, true);
1859cdaefac5SJoachim Protze 
1860cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
1861cdaefac5SJoachim Protze                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
1862cdaefac5SJoachim Protze                 gtid, loc_ref, new_taskdata));
1863cdaefac5SJoachim Protze #if OMPT_SUPPORT
1864cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18650e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
1866cdaefac5SJoachim Protze   }
1867cdaefac5SJoachim Protze #endif
1868cdaefac5SJoachim Protze   return res;
1869cdaefac5SJoachim Protze }
1870cdaefac5SJoachim Protze 
187182e94a59SJoachim Protze template <bool ompt>
187282e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_template(ident_t *loc_ref, kmp_int32 gtid,
187382e94a59SJoachim Protze                                               void *frame_address,
187482e94a59SJoachim Protze                                               void *return_address) {
18757cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
18767cc577a4SJonathan Peyton   kmp_info_t *thread;
18777cc577a4SJonathan Peyton   int thread_finished = FALSE;
18787cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKWAIT);
18797cc577a4SJonathan Peyton 
18807cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(enter): T#%d loc=%p\n", gtid, loc_ref));
1881838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
18827cc577a4SJonathan Peyton 
18837cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
18847cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
18857cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
18867cc577a4SJonathan Peyton 
188782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
188882e94a59SJoachim Protze     ompt_data_t *my_task_data;
188982e94a59SJoachim Protze     ompt_data_t *my_parallel_data;
18907cc577a4SJonathan Peyton 
189182e94a59SJoachim Protze     if (ompt) {
189282e94a59SJoachim Protze       my_task_data = &(taskdata->ompt_task_info.task_data);
189382e94a59SJoachim Protze       my_parallel_data = OMPT_CUR_TEAM_DATA(thread);
189482e94a59SJoachim Protze 
18950e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame.ptr = frame_address;
189682e94a59SJoachim Protze 
189782e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
189882e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
189982e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
190082e94a59SJoachim Protze             my_task_data, return_address);
190182e94a59SJoachim Protze       }
190282e94a59SJoachim Protze 
190382e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
190482e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
190582e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
190682e94a59SJoachim Protze             my_task_data, return_address);
19077cc577a4SJonathan Peyton       }
19087cc577a4SJonathan Peyton     }
190982e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
19107cc577a4SJonathan Peyton 
19113041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
19123041982dSJonathan Peyton // taskwait.
19137cc577a4SJonathan Peyton #if USE_ITT_BUILD
19147cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
19157cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19167cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
19177cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
19187cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
19197cc577a4SJonathan Peyton 
19207cc577a4SJonathan Peyton #if USE_ITT_BUILD
1921838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
1922838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
1923838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
1924838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
19257cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19267cc577a4SJonathan Peyton 
19273041982dSJonathan Peyton     bool must_wait =
19283041982dSJonathan Peyton         !taskdata->td_flags.team_serial && !taskdata->td_flags.final;
19297cc577a4SJonathan Peyton 
19303041982dSJonathan Peyton     must_wait = must_wait || (thread->th.th_task_team != NULL &&
19313041982dSJonathan Peyton                               thread->th.th_task_team->tt.tt_found_proxy_tasks);
19329d64275aSShilei Tian     // If hidden helper thread is encountered, we must enable wait here.
19339d64275aSShilei Tian     must_wait =
19349d64275aSShilei Tian         must_wait ||
19359d64275aSShilei Tian         (__kmp_enable_hidden_helper && thread->th.th_task_team != NULL &&
19369d64275aSShilei Tian          thread->th.th_task_team->tt.tt_hidden_helper_task_encountered);
19379d64275aSShilei Tian 
19383041982dSJonathan Peyton     if (must_wait) {
1939e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
1940e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
194137e2ef54SJonathan Peyton                 &(taskdata->td_incomplete_child_tasks)),
1942c47afcd9SAndrey Churbanov           0U);
194337e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) != 0) {
19443041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
19453041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
19463041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
19477cc577a4SJonathan Peyton       }
19487cc577a4SJonathan Peyton     }
19497cc577a4SJonathan Peyton #if USE_ITT_BUILD
1950838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
1951ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with children
19527cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19537cc577a4SJonathan Peyton 
19543041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
19553041982dSJonathan Peyton     // negated.
19567cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
19577cc577a4SJonathan Peyton 
195882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
195982e94a59SJoachim Protze     if (ompt) {
196082e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
196182e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
196282e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
196382e94a59SJoachim Protze             my_task_data, return_address);
196482e94a59SJoachim Protze       }
196582e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
196682e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
196782e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
196882e94a59SJoachim Protze             my_task_data, return_address);
19697cc577a4SJonathan Peyton       }
19700e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = ompt_data_none;
19717cc577a4SJonathan Peyton     }
197282e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
197382e94a59SJoachim Protze 
19747cc577a4SJonathan Peyton     ANNOTATE_HAPPENS_AFTER(taskdata);
19757cc577a4SJonathan Peyton   }
19767cc577a4SJonathan Peyton 
19777cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(exit): T#%d task %p finished waiting, "
19783041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
19793041982dSJonathan Peyton                 gtid, taskdata));
19807cc577a4SJonathan Peyton 
19817cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
19827cc577a4SJonathan Peyton }
19837cc577a4SJonathan Peyton 
1984489cdb78SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
198582e94a59SJoachim Protze OMPT_NOINLINE
198682e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_ompt(ident_t *loc_ref, kmp_int32 gtid,
198782e94a59SJoachim Protze                                           void *frame_address,
198882e94a59SJoachim Protze                                           void *return_address) {
198982e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<true>(loc_ref, gtid, frame_address,
199082e94a59SJoachim Protze                                             return_address);
199182e94a59SJoachim Protze }
1992489cdb78SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
199382e94a59SJoachim Protze 
199482e94a59SJoachim Protze // __kmpc_omp_taskwait: Wait until all tasks generated by the current task are
199582e94a59SJoachim Protze // complete
199682e94a59SJoachim Protze kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid) {
199782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
199882e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
199982e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
20000e0d6cddSJoachim Protze     return __kmpc_omp_taskwait_ompt(loc_ref, gtid, OMPT_GET_FRAME_ADDRESS(0),
200182e94a59SJoachim Protze                                     OMPT_LOAD_RETURN_ADDRESS(gtid));
200282e94a59SJoachim Protze   }
200382e94a59SJoachim Protze #endif
200482e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<false>(loc_ref, gtid, NULL, NULL);
200582e94a59SJoachim Protze }
200682e94a59SJoachim Protze 
20077cc577a4SJonathan Peyton // __kmpc_omp_taskyield: switch to a different task
20083041982dSJonathan Peyton kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid, int end_part) {
20097cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
20107cc577a4SJonathan Peyton   kmp_info_t *thread;
20117cc577a4SJonathan Peyton   int thread_finished = FALSE;
20127cc577a4SJonathan Peyton 
20137cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKYIELD);
20147cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKYIELD);
20157cc577a4SJonathan Peyton 
20167cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(enter): T#%d loc=%p end_part = %d\n",
20177cc577a4SJonathan Peyton                 gtid, loc_ref, end_part));
2018787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
20197cc577a4SJonathan Peyton 
20207cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec && __kmp_init_parallel) {
20217cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
20227cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
20237cc577a4SJonathan Peyton // Should we model this as a task wait or not?
20243041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
20253041982dSJonathan Peyton // taskwait.
20267cc577a4SJonathan Peyton #if USE_ITT_BUILD
20277cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
20287cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20297cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
20307cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
20317cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
20327cc577a4SJonathan Peyton 
20337cc577a4SJonathan Peyton #if USE_ITT_BUILD
2034838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2035838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2036838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2037838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
20387cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20397cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial) {
20407cc577a4SJonathan Peyton       kmp_task_team_t *task_team = thread->th.th_task_team;
20417cc577a4SJonathan Peyton       if (task_team != NULL) {
20427cc577a4SJonathan Peyton         if (KMP_TASKING_ENABLED(task_team)) {
204382e94a59SJoachim Protze #if OMPT_SUPPORT
2044f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
204582e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 1;
204682e94a59SJoachim Protze #endif
20473041982dSJonathan Peyton           __kmp_execute_tasks_32(
2048e0665a90STerry Wilmarth               thread, gtid, (kmp_flag_32<> *)NULL, FALSE,
20493041982dSJonathan Peyton               &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
20503041982dSJonathan Peyton               __kmp_task_stealing_constraint);
205182e94a59SJoachim Protze #if OMPT_SUPPORT
2052f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
205382e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 0;
205482e94a59SJoachim Protze #endif
20557cc577a4SJonathan Peyton         }
20567cc577a4SJonathan Peyton       }
20577cc577a4SJonathan Peyton     }
20587cc577a4SJonathan Peyton #if USE_ITT_BUILD
2059838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
20607cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20617cc577a4SJonathan Peyton 
20623041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
20633041982dSJonathan Peyton     // negated.
20647cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
20657cc577a4SJonathan Peyton   }
20667cc577a4SJonathan Peyton 
20677cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(exit): T#%d task %p resuming, "
20683041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
20693041982dSJonathan Peyton                 gtid, taskdata));
20707cc577a4SJonathan Peyton 
20717cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
20727cc577a4SJonathan Peyton }
20737cc577a4SJonathan Peyton 
207472ba2109SAndrey Churbanov // Task Reduction implementation
2075a8426ac8SJonathan Peyton //
2076a8426ac8SJonathan Peyton // Note: initial implementation didn't take into account the possibility
2077a8426ac8SJonathan Peyton // to specify omp_orig for initializer of the UDR (user defined reduction).
2078a8426ac8SJonathan Peyton // Corrected implementation takes into account the omp_orig object.
2079a8426ac8SJonathan Peyton // Compiler is free to use old implementation if omp_orig is not specified.
208072ba2109SAndrey Churbanov 
2081a8426ac8SJonathan Peyton /*!
2082a8426ac8SJonathan Peyton @ingroup BASIC_TYPES
2083a8426ac8SJonathan Peyton @{
2084a8426ac8SJonathan Peyton */
2085a8426ac8SJonathan Peyton 
2086a8426ac8SJonathan Peyton /*!
2087a8426ac8SJonathan Peyton Flags for special info per task reduction item.
2088a8426ac8SJonathan Peyton */
2089a8426ac8SJonathan Peyton typedef struct kmp_taskred_flags {
2090a8426ac8SJonathan Peyton   /*! 1 - use lazy alloc/init (e.g. big objects, #tasks < #threads) */
2091a8426ac8SJonathan Peyton   unsigned lazy_priv : 1;
209272ba2109SAndrey Churbanov   unsigned reserved31 : 31;
2093a8426ac8SJonathan Peyton } kmp_taskred_flags_t;
209472ba2109SAndrey Churbanov 
2095a8426ac8SJonathan Peyton /*!
2096a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2097a8426ac8SJonathan Peyton */
209872ba2109SAndrey Churbanov typedef struct kmp_task_red_input {
2099a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2100a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item in bytes */
2101a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2102a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (single parameter) */
2103a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2104a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2105a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
210672ba2109SAndrey Churbanov } kmp_task_red_input_t;
210772ba2109SAndrey Churbanov 
210872ba2109SAndrey Churbanov /*!
2109a8426ac8SJonathan Peyton Internal struct for reduction data item related info saved by the library.
211072ba2109SAndrey Churbanov */
2111a8426ac8SJonathan Peyton typedef struct kmp_taskred_data {
2112a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2113a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2114a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2115a8426ac8SJonathan Peyton   void *reduce_priv; /**< array of thread specific items */
2116a8426ac8SJonathan Peyton   void *reduce_pend; /**< end of private data for faster comparison op */
2117a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2118a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2119a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2120a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2121a8426ac8SJonathan Peyton   void *reduce_orig; /**< original item (can be used in UDR initializer) */
2122a8426ac8SJonathan Peyton } kmp_taskred_data_t;
2123a8426ac8SJonathan Peyton 
2124a8426ac8SJonathan Peyton /*!
2125a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2126a8426ac8SJonathan Peyton 
2127a8426ac8SJonathan Peyton New interface: added reduce_orig field to provide omp_orig for UDR initializer.
2128a8426ac8SJonathan Peyton */
2129a8426ac8SJonathan Peyton typedef struct kmp_taskred_input {
2130a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2131a8426ac8SJonathan Peyton   void *reduce_orig; /**< original reduction item used for initialization */
2132a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2133a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2134a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2135a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2136a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2137a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2138a8426ac8SJonathan Peyton } kmp_taskred_input_t;
2139a8426ac8SJonathan Peyton /*!
2140a8426ac8SJonathan Peyton @}
2141a8426ac8SJonathan Peyton */
2142a8426ac8SJonathan Peyton 
2143a8426ac8SJonathan Peyton template <typename T> void __kmp_assign_orig(kmp_taskred_data_t &item, T &src);
2144a8426ac8SJonathan Peyton template <>
2145a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_task_red_input_t>(kmp_taskred_data_t &item,
2146a8426ac8SJonathan Peyton                                              kmp_task_red_input_t &src) {
2147a8426ac8SJonathan Peyton   item.reduce_orig = NULL;
2148a8426ac8SJonathan Peyton }
2149a8426ac8SJonathan Peyton template <>
2150a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_taskred_input_t>(kmp_taskred_data_t &item,
2151a8426ac8SJonathan Peyton                                             kmp_taskred_input_t &src) {
2152a8426ac8SJonathan Peyton   if (src.reduce_orig != NULL) {
2153a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_orig;
2154a8426ac8SJonathan Peyton   } else {
2155a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_shar;
2156a8426ac8SJonathan Peyton   } // non-NULL reduce_orig means new interface used
2157a8426ac8SJonathan Peyton }
2158a8426ac8SJonathan Peyton 
21596b316febSTerry Wilmarth template <typename T> void __kmp_call_init(kmp_taskred_data_t &item, size_t j);
2160a8426ac8SJonathan Peyton template <>
2161a8426ac8SJonathan Peyton void __kmp_call_init<kmp_task_red_input_t>(kmp_taskred_data_t &item,
21626b316febSTerry Wilmarth                                            size_t offset) {
2163a8426ac8SJonathan Peyton   ((void (*)(void *))item.reduce_init)((char *)(item.reduce_priv) + offset);
2164a8426ac8SJonathan Peyton }
2165a8426ac8SJonathan Peyton template <>
2166a8426ac8SJonathan Peyton void __kmp_call_init<kmp_taskred_input_t>(kmp_taskred_data_t &item,
21676b316febSTerry Wilmarth                                           size_t offset) {
2168a8426ac8SJonathan Peyton   ((void (*)(void *, void *))item.reduce_init)(
2169a8426ac8SJonathan Peyton       (char *)(item.reduce_priv) + offset, item.reduce_orig);
2170a8426ac8SJonathan Peyton }
2171a8426ac8SJonathan Peyton 
2172a8426ac8SJonathan Peyton template <typename T>
2173a8426ac8SJonathan Peyton void *__kmp_task_reduction_init(int gtid, int num, T *data) {
2174787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
217572ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
217672ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = thread->th.th_current_task->td_taskgroup;
21776b316febSTerry Wilmarth   kmp_uint32 nth = thread->th.th_team_nproc;
2178a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
217972ba2109SAndrey Churbanov 
218072ba2109SAndrey Churbanov   // check input data just in case
218172ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
218272ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
218372ba2109SAndrey Churbanov   KMP_ASSERT(num > 0);
218472ba2109SAndrey Churbanov   if (nth == 1) {
218572ba2109SAndrey Churbanov     KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, tg %p, exiting nth=1\n",
218672ba2109SAndrey Churbanov                   gtid, tg));
218772ba2109SAndrey Churbanov     return (void *)tg;
218872ba2109SAndrey Churbanov   }
218972ba2109SAndrey Churbanov   KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, taskgroup %p, #items %d\n",
219072ba2109SAndrey Churbanov                 gtid, tg, num));
2191a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2192a8426ac8SJonathan Peyton       thread, num * sizeof(kmp_taskred_data_t));
219372ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
2194a8426ac8SJonathan Peyton     size_t size = data[i].reduce_size - 1;
219572ba2109SAndrey Churbanov     // round the size up to cache line per thread-specific item
219672ba2109SAndrey Churbanov     size += CACHE_LINE - size % CACHE_LINE;
2197a8426ac8SJonathan Peyton     KMP_ASSERT(data[i].reduce_comb != NULL); // combiner is mandatory
2198a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar;
219972ba2109SAndrey Churbanov     arr[i].reduce_size = size;
2200a8426ac8SJonathan Peyton     arr[i].flags = data[i].flags;
2201a8426ac8SJonathan Peyton     arr[i].reduce_comb = data[i].reduce_comb;
2202a8426ac8SJonathan Peyton     arr[i].reduce_init = data[i].reduce_init;
2203a8426ac8SJonathan Peyton     arr[i].reduce_fini = data[i].reduce_fini;
2204a8426ac8SJonathan Peyton     __kmp_assign_orig<T>(arr[i], data[i]);
2205a8426ac8SJonathan Peyton     if (!arr[i].flags.lazy_priv) {
220672ba2109SAndrey Churbanov       // allocate cache-line aligned block and fill it with zeros
220772ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * size);
220872ba2109SAndrey Churbanov       arr[i].reduce_pend = (char *)(arr[i].reduce_priv) + nth * size;
2209a8426ac8SJonathan Peyton       if (arr[i].reduce_init != NULL) {
2210a8426ac8SJonathan Peyton         // initialize all thread-specific items
22116b316febSTerry Wilmarth         for (size_t j = 0; j < nth; ++j) {
2212a8426ac8SJonathan Peyton           __kmp_call_init<T>(arr[i], j * size);
221372ba2109SAndrey Churbanov         }
221472ba2109SAndrey Churbanov       }
221572ba2109SAndrey Churbanov     } else {
221672ba2109SAndrey Churbanov       // only allocate space for pointers now,
2217a8426ac8SJonathan Peyton       // objects will be lazily allocated/initialized if/when requested
2218a8426ac8SJonathan Peyton       // note that __kmp_allocate zeroes the allocated memory
221972ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * sizeof(void *));
222072ba2109SAndrey Churbanov     }
222172ba2109SAndrey Churbanov   }
222272ba2109SAndrey Churbanov   tg->reduce_data = (void *)arr;
222372ba2109SAndrey Churbanov   tg->reduce_num_data = num;
222472ba2109SAndrey Churbanov   return (void *)tg;
222572ba2109SAndrey Churbanov }
222672ba2109SAndrey Churbanov 
222772ba2109SAndrey Churbanov /*!
222872ba2109SAndrey Churbanov @ingroup TASKING
222972ba2109SAndrey Churbanov @param gtid      Global thread ID
2230a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2231a8426ac8SJonathan Peyton @param data      Array of data for reduction
2232a8426ac8SJonathan Peyton @return The taskgroup identifier
2233a8426ac8SJonathan Peyton 
2234a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2235a8426ac8SJonathan Peyton 
2236a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2237a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2238a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2239a8426ac8SJonathan Peyton without help of the runtime library.
2240a8426ac8SJonathan Peyton */
2241a8426ac8SJonathan Peyton void *__kmpc_task_reduction_init(int gtid, int num, void *data) {
2242a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_task_red_input_t *)data);
2243a8426ac8SJonathan Peyton }
2244a8426ac8SJonathan Peyton 
2245a8426ac8SJonathan Peyton /*!
2246a8426ac8SJonathan Peyton @ingroup TASKING
2247a8426ac8SJonathan Peyton @param gtid      Global thread ID
2248a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2249a8426ac8SJonathan Peyton @param data      Array of data for reduction
2250a8426ac8SJonathan Peyton @return The taskgroup identifier
2251a8426ac8SJonathan Peyton 
2252a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2253a8426ac8SJonathan Peyton 
2254a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2255a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2256a8426ac8SJonathan Peyton */
2257a8426ac8SJonathan Peyton void *__kmpc_taskred_init(int gtid, int num, void *data) {
2258a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_taskred_input_t *)data);
2259a8426ac8SJonathan Peyton }
2260a8426ac8SJonathan Peyton 
2261a8426ac8SJonathan Peyton // Copy task reduction data (except for shared pointers).
2262a8426ac8SJonathan Peyton template <typename T>
2263a8426ac8SJonathan Peyton void __kmp_task_reduction_init_copy(kmp_info_t *thr, int num, T *data,
2264a8426ac8SJonathan Peyton                                     kmp_taskgroup_t *tg, void *reduce_data) {
2265a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
2266a8426ac8SJonathan Peyton   KA_TRACE(20, ("__kmp_task_reduction_init_copy: Th %p, init taskgroup %p,"
2267a8426ac8SJonathan Peyton                 " from data %p\n",
2268a8426ac8SJonathan Peyton                 thr, tg, reduce_data));
2269a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2270a8426ac8SJonathan Peyton       thr, num * sizeof(kmp_taskred_data_t));
2271a8426ac8SJonathan Peyton   // threads will share private copies, thunk routines, sizes, flags, etc.:
2272a8426ac8SJonathan Peyton   KMP_MEMCPY(arr, reduce_data, num * sizeof(kmp_taskred_data_t));
2273a8426ac8SJonathan Peyton   for (int i = 0; i < num; ++i) {
2274a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar; // init unique shared pointers
2275a8426ac8SJonathan Peyton   }
2276a8426ac8SJonathan Peyton   tg->reduce_data = (void *)arr;
2277a8426ac8SJonathan Peyton   tg->reduce_num_data = num;
2278a8426ac8SJonathan Peyton }
2279a8426ac8SJonathan Peyton 
2280a8426ac8SJonathan Peyton /*!
2281a8426ac8SJonathan Peyton @ingroup TASKING
2282a8426ac8SJonathan Peyton @param gtid    Global thread ID
228372ba2109SAndrey Churbanov @param tskgrp  The taskgroup ID (optional)
228472ba2109SAndrey Churbanov @param data    Shared location of the item
228572ba2109SAndrey Churbanov @return The pointer to per-thread data
228672ba2109SAndrey Churbanov 
228772ba2109SAndrey Churbanov Get thread-specific location of data item
228872ba2109SAndrey Churbanov */
22893041982dSJonathan Peyton void *__kmpc_task_reduction_get_th_data(int gtid, void *tskgrp, void *data) {
2290787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
229172ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
229272ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
229372ba2109SAndrey Churbanov   if (nth == 1)
229472ba2109SAndrey Churbanov     return data; // nothing to do
229572ba2109SAndrey Churbanov 
229672ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = (kmp_taskgroup_t *)tskgrp;
229772ba2109SAndrey Churbanov   if (tg == NULL)
229872ba2109SAndrey Churbanov     tg = thread->th.th_current_task->td_taskgroup;
229972ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
2300a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)(tg->reduce_data);
230172ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
230272ba2109SAndrey Churbanov   kmp_int32 tid = thread->th.th_info.ds.ds_tid;
230372ba2109SAndrey Churbanov 
230472ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
230572ba2109SAndrey Churbanov   while (tg != NULL) {
230672ba2109SAndrey Churbanov     for (int i = 0; i < num; ++i) {
230772ba2109SAndrey Churbanov       if (!arr[i].flags.lazy_priv) {
230872ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar ||
230972ba2109SAndrey Churbanov             (data >= arr[i].reduce_priv && data < arr[i].reduce_pend))
231072ba2109SAndrey Churbanov           return (char *)(arr[i].reduce_priv) + tid * arr[i].reduce_size;
231172ba2109SAndrey Churbanov       } else {
231272ba2109SAndrey Churbanov         // check shared location first
231372ba2109SAndrey Churbanov         void **p_priv = (void **)(arr[i].reduce_priv);
231472ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar)
231572ba2109SAndrey Churbanov           goto found;
231672ba2109SAndrey Churbanov         // check if we get some thread specific location as parameter
231772ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j)
231872ba2109SAndrey Churbanov           if (data == p_priv[j])
231972ba2109SAndrey Churbanov             goto found;
232072ba2109SAndrey Churbanov         continue; // not found, continue search
232172ba2109SAndrey Churbanov       found:
232272ba2109SAndrey Churbanov         if (p_priv[tid] == NULL) {
232372ba2109SAndrey Churbanov           // allocate thread specific object lazily
232472ba2109SAndrey Churbanov           p_priv[tid] = __kmp_allocate(arr[i].reduce_size);
2325a8426ac8SJonathan Peyton           if (arr[i].reduce_init != NULL) {
2326a8426ac8SJonathan Peyton             if (arr[i].reduce_orig != NULL) { // new interface
2327a8426ac8SJonathan Peyton               ((void (*)(void *, void *))arr[i].reduce_init)(
2328a8426ac8SJonathan Peyton                   p_priv[tid], arr[i].reduce_orig);
2329a8426ac8SJonathan Peyton             } else { // old interface (single parameter)
2330a8426ac8SJonathan Peyton               ((void (*)(void *))arr[i].reduce_init)(p_priv[tid]);
2331a8426ac8SJonathan Peyton             }
233272ba2109SAndrey Churbanov           }
233372ba2109SAndrey Churbanov         }
233472ba2109SAndrey Churbanov         return p_priv[tid];
233572ba2109SAndrey Churbanov       }
233672ba2109SAndrey Churbanov     }
233772ba2109SAndrey Churbanov     tg = tg->parent;
2338a8426ac8SJonathan Peyton     arr = (kmp_taskred_data_t *)(tg->reduce_data);
233972ba2109SAndrey Churbanov     num = tg->reduce_num_data;
234072ba2109SAndrey Churbanov   }
234172ba2109SAndrey Churbanov   KMP_ASSERT2(0, "Unknown task reduction item");
234272ba2109SAndrey Churbanov   return NULL; // ERROR, this line never executed
234372ba2109SAndrey Churbanov }
234472ba2109SAndrey Churbanov 
234572ba2109SAndrey Churbanov // Finalize task reduction.
234672ba2109SAndrey Churbanov // Called from __kmpc_end_taskgroup()
23473041982dSJonathan Peyton static void __kmp_task_reduction_fini(kmp_info_t *th, kmp_taskgroup_t *tg) {
234872ba2109SAndrey Churbanov   kmp_int32 nth = th->th.th_team_nproc;
234972ba2109SAndrey Churbanov   KMP_DEBUG_ASSERT(nth > 1); // should not be called if nth == 1
2350a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)tg->reduce_data;
235172ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
235272ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
235372ba2109SAndrey Churbanov     void *sh_data = arr[i].reduce_shar;
235472ba2109SAndrey Churbanov     void (*f_fini)(void *) = (void (*)(void *))(arr[i].reduce_fini);
23553041982dSJonathan Peyton     void (*f_comb)(void *, void *) =
23563041982dSJonathan Peyton         (void (*)(void *, void *))(arr[i].reduce_comb);
235772ba2109SAndrey Churbanov     if (!arr[i].flags.lazy_priv) {
235872ba2109SAndrey Churbanov       void *pr_data = arr[i].reduce_priv;
235972ba2109SAndrey Churbanov       size_t size = arr[i].reduce_size;
236072ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
236172ba2109SAndrey Churbanov         void *priv_data = (char *)pr_data + j * size;
236272ba2109SAndrey Churbanov         f_comb(sh_data, priv_data); // combine results
236372ba2109SAndrey Churbanov         if (f_fini)
236472ba2109SAndrey Churbanov           f_fini(priv_data); // finalize if needed
236572ba2109SAndrey Churbanov       }
236672ba2109SAndrey Churbanov     } else {
236772ba2109SAndrey Churbanov       void **pr_data = (void **)(arr[i].reduce_priv);
236872ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
236972ba2109SAndrey Churbanov         if (pr_data[j] != NULL) {
237072ba2109SAndrey Churbanov           f_comb(sh_data, pr_data[j]); // combine results
237172ba2109SAndrey Churbanov           if (f_fini)
237272ba2109SAndrey Churbanov             f_fini(pr_data[j]); // finalize if needed
237372ba2109SAndrey Churbanov           __kmp_free(pr_data[j]);
237472ba2109SAndrey Churbanov         }
237572ba2109SAndrey Churbanov       }
237672ba2109SAndrey Churbanov     }
237772ba2109SAndrey Churbanov     __kmp_free(arr[i].reduce_priv);
237872ba2109SAndrey Churbanov   }
237972ba2109SAndrey Churbanov   __kmp_thread_free(th, arr);
238072ba2109SAndrey Churbanov   tg->reduce_data = NULL;
238172ba2109SAndrey Churbanov   tg->reduce_num_data = 0;
238272ba2109SAndrey Churbanov }
2383a8426ac8SJonathan Peyton 
2384a8426ac8SJonathan Peyton // Cleanup task reduction data for parallel or worksharing,
2385a8426ac8SJonathan Peyton // do not touch task private data other threads still working with.
2386a8426ac8SJonathan Peyton // Called from __kmpc_end_taskgroup()
2387a8426ac8SJonathan Peyton static void __kmp_task_reduction_clean(kmp_info_t *th, kmp_taskgroup_t *tg) {
2388a8426ac8SJonathan Peyton   __kmp_thread_free(th, tg->reduce_data);
2389a8426ac8SJonathan Peyton   tg->reduce_data = NULL;
2390a8426ac8SJonathan Peyton   tg->reduce_num_data = 0;
2391a8426ac8SJonathan Peyton }
2392a8426ac8SJonathan Peyton 
2393a8426ac8SJonathan Peyton template <typename T>
2394a8426ac8SJonathan Peyton void *__kmp_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2395a8426ac8SJonathan Peyton                                          int num, T *data) {
2396787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
2397a8426ac8SJonathan Peyton   kmp_info_t *thr = __kmp_threads[gtid];
2398a8426ac8SJonathan Peyton   kmp_int32 nth = thr->th.th_team_nproc;
2399a8426ac8SJonathan Peyton   __kmpc_taskgroup(loc, gtid); // form new taskgroup first
2400a8426ac8SJonathan Peyton   if (nth == 1) {
2401a8426ac8SJonathan Peyton     KA_TRACE(10,
2402a8426ac8SJonathan Peyton              ("__kmpc_reduction_modifier_init: T#%d, tg %p, exiting nth=1\n",
2403a8426ac8SJonathan Peyton               gtid, thr->th.th_current_task->td_taskgroup));
2404a8426ac8SJonathan Peyton     return (void *)thr->th.th_current_task->td_taskgroup;
2405a8426ac8SJonathan Peyton   }
2406a8426ac8SJonathan Peyton   kmp_team_t *team = thr->th.th_team;
2407a8426ac8SJonathan Peyton   void *reduce_data;
2408a8426ac8SJonathan Peyton   kmp_taskgroup_t *tg;
2409a8426ac8SJonathan Peyton   reduce_data = KMP_ATOMIC_LD_RLX(&team->t.t_tg_reduce_data[is_ws]);
2410a8426ac8SJonathan Peyton   if (reduce_data == NULL &&
2411a8426ac8SJonathan Peyton       __kmp_atomic_compare_store(&team->t.t_tg_reduce_data[is_ws], reduce_data,
2412a8426ac8SJonathan Peyton                                  (void *)1)) {
2413a8426ac8SJonathan Peyton     // single thread enters this block to initialize common reduction data
2414a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data == NULL);
2415a8426ac8SJonathan Peyton     // first initialize own data, then make a copy other threads can use
2416a8426ac8SJonathan Peyton     tg = (kmp_taskgroup_t *)__kmp_task_reduction_init<T>(gtid, num, data);
2417a8426ac8SJonathan Peyton     reduce_data = __kmp_thread_malloc(thr, num * sizeof(kmp_taskred_data_t));
2418a8426ac8SJonathan Peyton     KMP_MEMCPY(reduce_data, tg->reduce_data, num * sizeof(kmp_taskred_data_t));
2419a8426ac8SJonathan Peyton     // fini counters should be 0 at this point
2420a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[0]) == 0);
2421a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[1]) == 0);
2422a8426ac8SJonathan Peyton     KMP_ATOMIC_ST_REL(&team->t.t_tg_reduce_data[is_ws], reduce_data);
2423a8426ac8SJonathan Peyton   } else {
2424a8426ac8SJonathan Peyton     while (
2425a8426ac8SJonathan Peyton         (reduce_data = KMP_ATOMIC_LD_ACQ(&team->t.t_tg_reduce_data[is_ws])) ==
2426a8426ac8SJonathan Peyton         (void *)1) { // wait for task reduction initialization
2427a8426ac8SJonathan Peyton       KMP_CPU_PAUSE();
2428a8426ac8SJonathan Peyton     }
2429a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data > (void *)1); // should be valid pointer here
2430a8426ac8SJonathan Peyton     tg = thr->th.th_current_task->td_taskgroup;
2431a8426ac8SJonathan Peyton     __kmp_task_reduction_init_copy<T>(thr, num, data, tg, reduce_data);
2432a8426ac8SJonathan Peyton   }
2433a8426ac8SJonathan Peyton   return tg;
2434a8426ac8SJonathan Peyton }
2435a8426ac8SJonathan Peyton 
2436a8426ac8SJonathan Peyton /*!
2437a8426ac8SJonathan Peyton @ingroup TASKING
2438a8426ac8SJonathan Peyton @param loc       Source location info
2439a8426ac8SJonathan Peyton @param gtid      Global thread ID
2440a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2441a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2442a8426ac8SJonathan Peyton @param data      Array of data for reduction
2443a8426ac8SJonathan Peyton @return The taskgroup identifier
2444a8426ac8SJonathan Peyton 
2445a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2446a8426ac8SJonathan Peyton 
2447a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2448a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2449a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2450a8426ac8SJonathan Peyton without help of the runtime library.
2451a8426ac8SJonathan Peyton */
2452a8426ac8SJonathan Peyton void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2453a8426ac8SJonathan Peyton                                           int num, void *data) {
2454a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2455a8426ac8SJonathan Peyton                                             (kmp_task_red_input_t *)data);
2456a8426ac8SJonathan Peyton }
2457a8426ac8SJonathan Peyton 
2458a8426ac8SJonathan Peyton /*!
2459a8426ac8SJonathan Peyton @ingroup TASKING
2460a8426ac8SJonathan Peyton @param loc       Source location info
2461a8426ac8SJonathan Peyton @param gtid      Global thread ID
2462a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2463a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2464a8426ac8SJonathan Peyton @param data      Array of data for reduction
2465a8426ac8SJonathan Peyton @return The taskgroup identifier
2466a8426ac8SJonathan Peyton 
2467a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2468a8426ac8SJonathan Peyton 
2469a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2470a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2471a8426ac8SJonathan Peyton */
2472a8426ac8SJonathan Peyton void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num,
2473a8426ac8SJonathan Peyton                                    void *data) {
2474a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2475a8426ac8SJonathan Peyton                                             (kmp_taskred_input_t *)data);
2476a8426ac8SJonathan Peyton }
2477a8426ac8SJonathan Peyton 
2478a8426ac8SJonathan Peyton /*!
2479a8426ac8SJonathan Peyton @ingroup TASKING
2480a8426ac8SJonathan Peyton @param loc       Source location info
2481a8426ac8SJonathan Peyton @param gtid      Global thread ID
2482a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2483a8426ac8SJonathan Peyton 
2484a8426ac8SJonathan Peyton Finalize task reduction for a parallel or worksharing.
2485a8426ac8SJonathan Peyton */
2486a8426ac8SJonathan Peyton void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid, int is_ws) {
2487a8426ac8SJonathan Peyton   __kmpc_end_taskgroup(loc, gtid);
2488a8426ac8SJonathan Peyton }
24897cc577a4SJonathan Peyton 
24907cc577a4SJonathan Peyton // __kmpc_taskgroup: Start a new taskgroup
24913041982dSJonathan Peyton void __kmpc_taskgroup(ident_t *loc, int gtid) {
2492787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
24937cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
24947cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
24957cc577a4SJonathan Peyton   kmp_taskgroup_t *tg_new =
24967cc577a4SJonathan Peyton       (kmp_taskgroup_t *)__kmp_thread_malloc(thread, sizeof(kmp_taskgroup_t));
24977cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_taskgroup: T#%d loc=%p group=%p\n", gtid, loc, tg_new));
249837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->count, 0);
249937e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->cancel_request, cancel_noreq);
25007cc577a4SJonathan Peyton   tg_new->parent = taskdata->td_taskgroup;
250172ba2109SAndrey Churbanov   tg_new->reduce_data = NULL;
250272ba2109SAndrey Churbanov   tg_new->reduce_num_data = 0;
25037cc577a4SJonathan Peyton   taskdata->td_taskgroup = tg_new;
250482e94a59SJoachim Protze 
250582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2506f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
250782e94a59SJoachim Protze     void *codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
250882e94a59SJoachim Protze     if (!codeptr)
250982e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
251082e94a59SJoachim Protze     kmp_team_t *team = thread->th.th_team;
251182e94a59SJoachim Protze     ompt_data_t my_task_data = taskdata->ompt_task_info.task_data;
251282e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
251382e94a59SJoachim Protze     ompt_data_t my_parallel_data = team->t.ompt_team_info.parallel_data;
251482e94a59SJoachim Protze 
251582e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
251682e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
251782e94a59SJoachim Protze         &(my_task_data), codeptr);
251882e94a59SJoachim Protze   }
251982e94a59SJoachim Protze #endif
25207cc577a4SJonathan Peyton }
25217cc577a4SJonathan Peyton 
25227cc577a4SJonathan Peyton // __kmpc_end_taskgroup: Wait until all tasks generated by the current task
25237cc577a4SJonathan Peyton //                       and its descendants are complete
25243041982dSJonathan Peyton void __kmpc_end_taskgroup(ident_t *loc, int gtid) {
2525787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
25267cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
25277cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
25287cc577a4SJonathan Peyton   kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
25297cc577a4SJonathan Peyton   int thread_finished = FALSE;
25307cc577a4SJonathan Peyton 
253182e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
253282e94a59SJoachim Protze   kmp_team_t *team;
253382e94a59SJoachim Protze   ompt_data_t my_task_data;
253482e94a59SJoachim Protze   ompt_data_t my_parallel_data;
253582e94a59SJoachim Protze   void *codeptr;
2536f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
253782e94a59SJoachim Protze     team = thread->th.th_team;
253882e94a59SJoachim Protze     my_task_data = taskdata->ompt_task_info.task_data;
253982e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
254082e94a59SJoachim Protze     my_parallel_data = team->t.ompt_team_info.parallel_data;
254182e94a59SJoachim Protze     codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
254282e94a59SJoachim Protze     if (!codeptr)
254382e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
254482e94a59SJoachim Protze   }
254582e94a59SJoachim Protze #endif
254682e94a59SJoachim Protze 
25477cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(enter): T#%d loc=%p\n", gtid, loc));
25487cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup != NULL);
25497cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKGROUP);
25507cc577a4SJonathan Peyton 
25517cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
2552a756cb24SAndrey Churbanov     // mark task as waiting not on a barrier
2553a756cb24SAndrey Churbanov     taskdata->td_taskwait_counter += 1;
2554a756cb24SAndrey Churbanov     taskdata->td_taskwait_ident = loc;
2555a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = gtid + 1;
25567cc577a4SJonathan Peyton #if USE_ITT_BUILD
25573041982dSJonathan Peyton     // For ITT the taskgroup wait is similar to taskwait until we need to
25583041982dSJonathan Peyton     // distinguish them
2559838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2560838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2561838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2562838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
25637cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25647cc577a4SJonathan Peyton 
256582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2566f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
256782e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
256882e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
256982e94a59SJoachim Protze           &(my_task_data), codeptr);
257082e94a59SJoachim Protze     }
257182e94a59SJoachim Protze #endif
257282e94a59SJoachim Protze 
25733041982dSJonathan Peyton     if (!taskdata->td_flags.team_serial ||
25743041982dSJonathan Peyton         (thread->th.th_task_team != NULL &&
2575e4b4f994SJonathan Peyton          thread->th.th_task_team->tt.tt_found_proxy_tasks)) {
2576e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
2577e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *, &(taskgroup->count)), 0U);
257837e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskgroup->count) != 0) {
25793041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
25803041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
25813041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
25827cc577a4SJonathan Peyton       }
25837cc577a4SJonathan Peyton     }
2584a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread; // end waiting
25857cc577a4SJonathan Peyton 
258682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2587f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
258882e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
258982e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
259082e94a59SJoachim Protze           &(my_task_data), codeptr);
259182e94a59SJoachim Protze     }
259282e94a59SJoachim Protze #endif
259382e94a59SJoachim Protze 
25947cc577a4SJonathan Peyton #if USE_ITT_BUILD
2595838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
2596ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with descendants
25977cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25987cc577a4SJonathan Peyton   }
25997cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup->count == 0);
26007cc577a4SJonathan Peyton 
2601a8426ac8SJonathan Peyton   if (taskgroup->reduce_data != NULL) { // need to reduce?
2602a8426ac8SJonathan Peyton     int cnt;
2603a8426ac8SJonathan Peyton     void *reduce_data;
2604a8426ac8SJonathan Peyton     kmp_team_t *t = thread->th.th_team;
2605a8426ac8SJonathan Peyton     kmp_taskred_data_t *arr = (kmp_taskred_data_t *)taskgroup->reduce_data;
2606a8426ac8SJonathan Peyton     // check if <priv> data of the first reduction variable shared for the team
2607a8426ac8SJonathan Peyton     void *priv0 = arr[0].reduce_priv;
2608a8426ac8SJonathan Peyton     if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[0])) != NULL &&
2609a8426ac8SJonathan Peyton         ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2610a8426ac8SJonathan Peyton       // finishing task reduction on parallel
2611a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[0]);
2612a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2613a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2614a8426ac8SJonathan Peyton         // finalize task reduction:
261572ba2109SAndrey Churbanov         __kmp_task_reduction_fini(thread, taskgroup);
2616a8426ac8SJonathan Peyton         // cleanup fields in the team structure:
2617a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2618a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2619a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[0], NULL);
2620a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[0], 0);
2621a8426ac8SJonathan Peyton       } else {
2622a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2623a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2624a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2625a8426ac8SJonathan Peyton       }
2626a8426ac8SJonathan Peyton     } else if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[1])) !=
2627a8426ac8SJonathan Peyton                    NULL &&
2628a8426ac8SJonathan Peyton                ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2629a8426ac8SJonathan Peyton       // finishing task reduction on worksharing
2630a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[1]);
2631a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2632a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2633a8426ac8SJonathan Peyton         __kmp_task_reduction_fini(thread, taskgroup);
2634a8426ac8SJonathan Peyton         // cleanup fields in team structure:
2635a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2636a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2637a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[1], NULL);
2638a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[1], 0);
2639a8426ac8SJonathan Peyton       } else {
2640a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2641a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2642a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2643a8426ac8SJonathan Peyton       }
2644a8426ac8SJonathan Peyton     } else {
2645a8426ac8SJonathan Peyton       // finishing task reduction on taskgroup
2646a8426ac8SJonathan Peyton       __kmp_task_reduction_fini(thread, taskgroup);
2647a8426ac8SJonathan Peyton     }
2648a8426ac8SJonathan Peyton   }
26497cc577a4SJonathan Peyton   // Restore parent taskgroup for the current task
26507cc577a4SJonathan Peyton   taskdata->td_taskgroup = taskgroup->parent;
26517cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskgroup);
26527cc577a4SJonathan Peyton 
26533041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(exit): T#%d task %p finished waiting\n",
26543041982dSJonathan Peyton                 gtid, taskdata));
26557cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_AFTER(taskdata);
265682e94a59SJoachim Protze 
265782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2658f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
265982e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
266082e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
266182e94a59SJoachim Protze         &(my_task_data), codeptr);
266282e94a59SJoachim Protze   }
266382e94a59SJoachim Protze #endif
26647cc577a4SJonathan Peyton }
26657cc577a4SJonathan Peyton 
26667cc577a4SJonathan Peyton // __kmp_remove_my_task: remove a task from my own deque
26673041982dSJonathan Peyton static kmp_task_t *__kmp_remove_my_task(kmp_info_t *thread, kmp_int32 gtid,
26683041982dSJonathan Peyton                                         kmp_task_team_t *task_team,
26693041982dSJonathan Peyton                                         kmp_int32 is_constrained) {
26707cc577a4SJonathan Peyton   kmp_task_t *task;
26717cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
26727cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
26737cc577a4SJonathan Peyton   kmp_uint32 tail;
26747cc577a4SJonathan Peyton 
26757cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
26763041982dSJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_threads_data !=
26773041982dSJonathan Peyton                    NULL); // Caller should check this condition
26787cc577a4SJonathan Peyton 
26797cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
26807cc577a4SJonathan Peyton 
26817cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(enter): T#%d ntasks=%d head=%u tail=%u\n",
26823041982dSJonathan Peyton                 gtid, thread_data->td.td_deque_ntasks,
26833041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26847cc577a4SJonathan Peyton 
26857cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26863041982dSJonathan Peyton     KA_TRACE(10,
26873041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #1): T#%d No tasks to remove: "
26883041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26893041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26903041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26917cc577a4SJonathan Peyton     return NULL;
26927cc577a4SJonathan Peyton   }
26937cc577a4SJonathan Peyton 
26947cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
26957cc577a4SJonathan Peyton 
26967cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26977cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
26983041982dSJonathan Peyton     KA_TRACE(10,
26993041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
27003041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27013041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
27023041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27037cc577a4SJonathan Peyton     return NULL;
27047cc577a4SJonathan Peyton   }
27057cc577a4SJonathan Peyton 
27063041982dSJonathan Peyton   tail = (thread_data->td.td_deque_tail - 1) &
27073041982dSJonathan Peyton          TASK_DEQUE_MASK(thread_data->td); // Wrap index.
27087cc577a4SJonathan Peyton   taskdata = thread_data->td.td_deque[tail];
27097cc577a4SJonathan Peyton 
2710c3344345SAndrey Churbanov   if (!__kmp_task_is_allowed(gtid, is_constrained, taskdata,
2711c3344345SAndrey Churbanov                              thread->th.th_current_task)) {
2712a756cb24SAndrey Churbanov     // The TSC does not allow to steal victim task
27137cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
2714c3344345SAndrey Churbanov     KA_TRACE(10,
2715c3344345SAndrey Churbanov              ("__kmp_remove_my_task(exit #3): T#%d TSC blocks tail task: "
27163041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27173041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
2718c3344345SAndrey Churbanov               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27197cc577a4SJonathan Peyton     return NULL;
27207cc577a4SJonathan Peyton   }
27217cc577a4SJonathan Peyton 
27227cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = tail;
27237cc577a4SJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks, thread_data->td.td_deque_ntasks - 1);
27247cc577a4SJonathan Peyton 
27257cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
27267cc577a4SJonathan Peyton 
2727c3344345SAndrey Churbanov   KA_TRACE(10, ("__kmp_remove_my_task(exit #4): T#%d task %p removed: "
27283041982dSJonathan Peyton                 "ntasks=%d head=%u tail=%u\n",
27293041982dSJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
27303041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27317cc577a4SJonathan Peyton 
27327cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
27337cc577a4SJonathan Peyton   return task;
27347cc577a4SJonathan Peyton }
27357cc577a4SJonathan Peyton 
27367cc577a4SJonathan Peyton // __kmp_steal_task: remove a task from another thread's deque
27377cc577a4SJonathan Peyton // Assume that calling thread has already checked existence of
27387cc577a4SJonathan Peyton // task_team thread_data before calling this routine.
2739a756cb24SAndrey Churbanov static kmp_task_t *__kmp_steal_task(kmp_info_t *victim_thr, kmp_int32 gtid,
2740c47afcd9SAndrey Churbanov                                     kmp_task_team_t *task_team,
274137e2ef54SJonathan Peyton                                     std::atomic<kmp_int32> *unfinished_threads,
2742c47afcd9SAndrey Churbanov                                     int *thread_finished,
2743c47afcd9SAndrey Churbanov                                     kmp_int32 is_constrained) {
27447cc577a4SJonathan Peyton   kmp_task_t *task;
27457cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
2746a756cb24SAndrey Churbanov   kmp_taskdata_t *current;
27477cc577a4SJonathan Peyton   kmp_thread_data_t *victim_td, *threads_data;
2748c3344345SAndrey Churbanov   kmp_int32 target;
27497cc577a4SJonathan Peyton   kmp_int32 victim_tid;
27507cc577a4SJonathan Peyton 
27517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
27527cc577a4SJonathan Peyton 
27537cc577a4SJonathan Peyton   threads_data = task_team->tt.tt_threads_data;
27547cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL); // Caller should check this condition
27557cc577a4SJonathan Peyton 
2756a756cb24SAndrey Churbanov   victim_tid = victim_thr->th.th_info.ds.ds_tid;
27577cc577a4SJonathan Peyton   victim_td = &threads_data[victim_tid];
27587cc577a4SJonathan Peyton 
27593041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_steal_task(enter): T#%d try to steal from T#%d: "
2760a756cb24SAndrey Churbanov                 "task_team=%p ntasks=%d head=%u tail=%u\n",
2761a756cb24SAndrey Churbanov                 gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27623041982dSJonathan Peyton                 victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27633041982dSJonathan Peyton                 victim_td->td.td_deque_tail));
27647cc577a4SJonathan Peyton 
2765a756cb24SAndrey Churbanov   if (TCR_4(victim_td->td.td_deque_ntasks) == 0) {
27663041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #1): T#%d could not steal from T#%d: "
2767a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2768a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27693041982dSJonathan Peyton                   victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27703041982dSJonathan Peyton                   victim_td->td.td_deque_tail));
27717cc577a4SJonathan Peyton     return NULL;
27727cc577a4SJonathan Peyton   }
27737cc577a4SJonathan Peyton 
27747cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&victim_td->td.td_deque_lock);
27757cc577a4SJonathan Peyton 
2776a756cb24SAndrey Churbanov   int ntasks = TCR_4(victim_td->td.td_deque_ntasks);
27777cc577a4SJonathan Peyton   // Check again after we acquire the lock
2778a756cb24SAndrey Churbanov   if (ntasks == 0) {
27797cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
27803041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #2): T#%d could not steal from T#%d: "
2781a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2782a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2783a756cb24SAndrey Churbanov                   victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27847cc577a4SJonathan Peyton     return NULL;
27857cc577a4SJonathan Peyton   }
27867cc577a4SJonathan Peyton 
27877cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(victim_td->td.td_deque != NULL);
2788c3344345SAndrey Churbanov   current = __kmp_threads[gtid]->th.th_current_task;
27897cc577a4SJonathan Peyton   taskdata = victim_td->td.td_deque[victim_td->td.td_deque_head];
2790c3344345SAndrey Churbanov   if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2791c3344345SAndrey Churbanov     // Bump head pointer and Wrap.
2792c3344345SAndrey Churbanov     victim_td->td.td_deque_head =
2793c3344345SAndrey Churbanov         (victim_td->td.td_deque_head + 1) & TASK_DEQUE_MASK(victim_td->td);
2794c3344345SAndrey Churbanov   } else {
2795a756cb24SAndrey Churbanov     if (!task_team->tt.tt_untied_task_encountered) {
2796a756cb24SAndrey Churbanov       // The TSC does not allow to steal victim task
27977cc577a4SJonathan Peyton       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2798c3344345SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #3): T#%d could not steal from "
2799a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2800a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
28017cc577a4SJonathan Peyton                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28027cc577a4SJonathan Peyton       return NULL;
28037cc577a4SJonathan Peyton     }
2804a756cb24SAndrey Churbanov     int i;
2805a756cb24SAndrey Churbanov     // walk through victim's deque trying to steal any task
2806a756cb24SAndrey Churbanov     target = victim_td->td.td_deque_head;
2807c3344345SAndrey Churbanov     taskdata = NULL;
2808a756cb24SAndrey Churbanov     for (i = 1; i < ntasks; ++i) {
2809a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2810a756cb24SAndrey Churbanov       taskdata = victim_td->td.td_deque[target];
2811c3344345SAndrey Churbanov       if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2812c3344345SAndrey Churbanov         break; // found victim task
2813c3344345SAndrey Churbanov       } else {
2814a756cb24SAndrey Churbanov         taskdata = NULL;
2815a756cb24SAndrey Churbanov       }
2816a756cb24SAndrey Churbanov     }
2817a756cb24SAndrey Churbanov     if (taskdata == NULL) {
2818a756cb24SAndrey Churbanov       // No appropriate candidate to steal found
2819a756cb24SAndrey Churbanov       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2820a756cb24SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #4): T#%d could not steal from "
2821a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2822a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2823a756cb24SAndrey Churbanov                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
2824a756cb24SAndrey Churbanov       return NULL;
2825a756cb24SAndrey Churbanov     }
2826a756cb24SAndrey Churbanov     int prev = target;
2827a756cb24SAndrey Churbanov     for (i = i + 1; i < ntasks; ++i) {
2828a756cb24SAndrey Churbanov       // shift remaining tasks in the deque left by 1
2829a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2830a756cb24SAndrey Churbanov       victim_td->td.td_deque[prev] = victim_td->td.td_deque[target];
2831a756cb24SAndrey Churbanov       prev = target;
2832a756cb24SAndrey Churbanov     }
2833baad3f60SJonathan Peyton     KMP_DEBUG_ASSERT(
2834baad3f60SJonathan Peyton         victim_td->td.td_deque_tail ==
2835baad3f60SJonathan Peyton         (kmp_uint32)((target + 1) & TASK_DEQUE_MASK(victim_td->td)));
2836a756cb24SAndrey Churbanov     victim_td->td.td_deque_tail = target; // tail -= 1 (wrapped))
2837a756cb24SAndrey Churbanov   }
28387cc577a4SJonathan Peyton   if (*thread_finished) {
28393041982dSJonathan Peyton     // We need to un-mark this victim as a finished victim.  This must be done
28403041982dSJonathan Peyton     // before releasing the lock, or else other threads (starting with the
28413041982dSJonathan Peyton     // master victim) might be prematurely released from the barrier!!!
2842c47afcd9SAndrey Churbanov     kmp_int32 count;
28437cc577a4SJonathan Peyton 
284437e2ef54SJonathan Peyton     count = KMP_ATOMIC_INC(unfinished_threads);
28457cc577a4SJonathan Peyton 
28463041982dSJonathan Peyton     KA_TRACE(
28473041982dSJonathan Peyton         20,
28483041982dSJonathan Peyton         ("__kmp_steal_task: T#%d inc unfinished_threads to %d: task_team=%p\n",
28497cc577a4SJonathan Peyton          gtid, count + 1, task_team));
28507cc577a4SJonathan Peyton 
28517cc577a4SJonathan Peyton     *thread_finished = FALSE;
28527cc577a4SJonathan Peyton   }
2853a756cb24SAndrey Churbanov   TCW_4(victim_td->td.td_deque_ntasks, ntasks - 1);
28543041982dSJonathan Peyton 
28557cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
28567cc577a4SJonathan Peyton 
28577cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(TASK_stolen);
2858a756cb24SAndrey Churbanov   KA_TRACE(10,
2859a756cb24SAndrey Churbanov            ("__kmp_steal_task(exit #5): T#%d stole task %p from T#%d: "
2860a756cb24SAndrey Churbanov             "task_team=%p ntasks=%d head=%u tail=%u\n",
2861a756cb24SAndrey Churbanov             gtid, taskdata, __kmp_gtid_from_thread(victim_thr), task_team,
2862a756cb24SAndrey Churbanov             ntasks, victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28637cc577a4SJonathan Peyton 
28647cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
28657cc577a4SJonathan Peyton   return task;
28667cc577a4SJonathan Peyton }
28677cc577a4SJonathan Peyton 
28683041982dSJonathan Peyton // __kmp_execute_tasks_template: Choose and execute tasks until either the
28693041982dSJonathan Peyton // condition is statisfied (return true) or there are none left (return false).
28703041982dSJonathan Peyton //
28717cc577a4SJonathan Peyton // final_spin is TRUE if this is the spin at the release barrier.
28727cc577a4SJonathan Peyton // thread_finished indicates whether the thread is finished executing all
28737cc577a4SJonathan Peyton // the tasks it has on its deque, and is at the release barrier.
28747cc577a4SJonathan Peyton // spinner is the location on which to spin.
28757cc577a4SJonathan Peyton // spinner == NULL means only execute a single task and return.
28767cc577a4SJonathan Peyton // checker is the value to check to terminate the spin.
28777cc577a4SJonathan Peyton template <class C>
28783041982dSJonathan Peyton static inline int __kmp_execute_tasks_template(
28793041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, C *flag, int final_spin,
28803041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
28813041982dSJonathan Peyton     kmp_int32 is_constrained) {
28827cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
28837cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
28847cc577a4SJonathan Peyton   kmp_task_t *task;
28857cc577a4SJonathan Peyton   kmp_info_t *other_thread;
28867cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
288737e2ef54SJonathan Peyton   std::atomic<kmp_int32> *unfinished_threads;
2888a756cb24SAndrey Churbanov   kmp_int32 nthreads, victim_tid = -2, use_own_tasks = 1, new_victim = 0,
28893041982dSJonathan Peyton                       tid = thread->th.th_info.ds.ds_tid;
28907cc577a4SJonathan Peyton 
28917cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
28927cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread == __kmp_threads[gtid]);
28937cc577a4SJonathan Peyton 
2894a4a9c48cSJonathan Peyton   if (task_team == NULL || current_task == NULL)
28953041982dSJonathan Peyton     return FALSE;
28967cc577a4SJonathan Peyton 
28973041982dSJonathan Peyton   KA_TRACE(15, ("__kmp_execute_tasks_template(enter): T#%d final_spin=%d "
28983041982dSJonathan Peyton                 "*thread_finished=%d\n",
28997cc577a4SJonathan Peyton                 gtid, final_spin, *thread_finished));
29007cc577a4SJonathan Peyton 
2901581490e7SAndrey Churbanov   thread->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
29027cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
29039d64275aSShilei Tian 
29047cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
29057cc577a4SJonathan Peyton 
29067cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
29077cc577a4SJonathan Peyton   unfinished_threads = &(task_team->tt.tt_unfinished_threads);
29089d64275aSShilei Tian   KMP_DEBUG_ASSERT(nthreads > 1 || task_team->tt.tt_found_proxy_tasks ||
29099d64275aSShilei Tian                    task_team->tt.tt_hidden_helper_task_encountered);
291037e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(*unfinished_threads >= 0);
29117cc577a4SJonathan Peyton 
29123041982dSJonathan Peyton   while (1) { // Outer loop keeps trying to find tasks in case of single thread
29133041982dSJonathan Peyton     // getting tasks from target constructs
29147cc577a4SJonathan Peyton     while (1) { // Inner loop to find a task and execute it
29157cc577a4SJonathan Peyton       task = NULL;
29167cc577a4SJonathan Peyton       if (use_own_tasks) { // check on own queue first
29177cc577a4SJonathan Peyton         task = __kmp_remove_my_task(thread, gtid, task_team, is_constrained);
29187cc577a4SJonathan Peyton       }
29197cc577a4SJonathan Peyton       if ((task == NULL) && (nthreads > 1)) { // Steal a task
29207cc577a4SJonathan Peyton         int asleep = 1;
29217cc577a4SJonathan Peyton         use_own_tasks = 0;
29227cc577a4SJonathan Peyton         // Try to steal from the last place I stole from successfully.
2923a756cb24SAndrey Churbanov         if (victim_tid == -2) { // haven't stolen anything yet
2924a756cb24SAndrey Churbanov           victim_tid = threads_data[tid].td.td_deque_last_stolen;
2925a756cb24SAndrey Churbanov           if (victim_tid !=
29263041982dSJonathan Peyton               -1) // if we have a last stolen from victim, get the thread
2927a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29287cc577a4SJonathan Peyton         }
2929a756cb24SAndrey Churbanov         if (victim_tid != -1) { // found last victim
29307cc577a4SJonathan Peyton           asleep = 0;
29313041982dSJonathan Peyton         } else if (!new_victim) { // no recent steals and we haven't already
29323041982dSJonathan Peyton           // used a new victim; select a random thread
29337cc577a4SJonathan Peyton           do { // Find a different thread to steal work from.
29343041982dSJonathan Peyton             // Pick a random thread. Initial plan was to cycle through all the
29353041982dSJonathan Peyton             // threads, and only return if we tried to steal from every thread,
29363041982dSJonathan Peyton             // and failed.  Arch says that's not such a great idea.
2937a756cb24SAndrey Churbanov             victim_tid = __kmp_get_random(thread) % (nthreads - 1);
2938a756cb24SAndrey Churbanov             if (victim_tid >= tid) {
2939a756cb24SAndrey Churbanov               ++victim_tid; // Adjusts random distribution to exclude self
29407cc577a4SJonathan Peyton             }
29417cc577a4SJonathan Peyton             // Found a potential victim
2942a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29433041982dSJonathan Peyton             // There is a slight chance that __kmp_enable_tasking() did not wake
29443041982dSJonathan Peyton             // up all threads waiting at the barrier.  If victim is sleeping,
29453041982dSJonathan Peyton             // then wake it up. Since we were going to pay the cache miss
29463041982dSJonathan Peyton             // penalty for referencing another thread's kmp_info_t struct
29473041982dSJonathan Peyton             // anyway,
29483041982dSJonathan Peyton             // the check shouldn't cost too much performance at this point. In
29493041982dSJonathan Peyton             // extra barrier mode, tasks do not sleep at the separate tasking
29503041982dSJonathan Peyton             // barrier, so this isn't a problem.
29517cc577a4SJonathan Peyton             asleep = 0;
29527cc577a4SJonathan Peyton             if ((__kmp_tasking_mode == tskm_task_teams) &&
29537cc577a4SJonathan Peyton                 (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) &&
2954c47afcd9SAndrey Churbanov                 (TCR_PTR(CCAST(void *, other_thread->th.th_sleep_loc)) !=
2955c47afcd9SAndrey Churbanov                  NULL)) {
29567cc577a4SJonathan Peyton               asleep = 1;
29573041982dSJonathan Peyton               __kmp_null_resume_wrapper(__kmp_gtid_from_thread(other_thread),
29583041982dSJonathan Peyton                                         other_thread->th.th_sleep_loc);
29593041982dSJonathan Peyton               // A sleeping thread should not have any tasks on it's queue.
29603041982dSJonathan Peyton               // There is a slight possibility that it resumes, steals a task
29613041982dSJonathan Peyton               // from another thread, which spawns more tasks, all in the time
29623041982dSJonathan Peyton               // that it takes this thread to check => don't write an assertion
29633041982dSJonathan Peyton               // that the victim's queue is empty.  Try stealing from a
29643041982dSJonathan Peyton               // different thread.
29657cc577a4SJonathan Peyton             }
29667cc577a4SJonathan Peyton           } while (asleep);
29677cc577a4SJonathan Peyton         }
29687cc577a4SJonathan Peyton 
29697cc577a4SJonathan Peyton         if (!asleep) {
29707cc577a4SJonathan Peyton           // We have a victim to try to steal from
29713041982dSJonathan Peyton           task = __kmp_steal_task(other_thread, gtid, task_team,
29723041982dSJonathan Peyton                                   unfinished_threads, thread_finished,
29733041982dSJonathan Peyton                                   is_constrained);
29747cc577a4SJonathan Peyton         }
29757cc577a4SJonathan Peyton         if (task != NULL) { // set last stolen to victim
2976a756cb24SAndrey Churbanov           if (threads_data[tid].td.td_deque_last_stolen != victim_tid) {
2977a756cb24SAndrey Churbanov             threads_data[tid].td.td_deque_last_stolen = victim_tid;
29783041982dSJonathan Peyton             // The pre-refactored code did not try more than 1 successful new
29793041982dSJonathan Peyton             // vicitm, unless the last one generated more local tasks;
29803041982dSJonathan Peyton             // new_victim keeps track of this
29817cc577a4SJonathan Peyton             new_victim = 1;
29827cc577a4SJonathan Peyton           }
29833041982dSJonathan Peyton         } else { // No tasks found; unset last_stolen
29847cc577a4SJonathan Peyton           KMP_CHECK_UPDATE(threads_data[tid].td.td_deque_last_stolen, -1);
2985a756cb24SAndrey Churbanov           victim_tid = -2; // no successful victim found
29867cc577a4SJonathan Peyton         }
29877cc577a4SJonathan Peyton       }
29887cc577a4SJonathan Peyton 
29899d64275aSShilei Tian       if (task == NULL)
29909d64275aSShilei Tian         break; // break out of tasking loop
29917cc577a4SJonathan Peyton 
29927cc577a4SJonathan Peyton // Found a task; execute it
29937cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
29947cc577a4SJonathan Peyton       if (__itt_sync_create_ptr || KMP_ITT_DEBUG) {
29953041982dSJonathan Peyton         if (itt_sync_obj == NULL) { // we are at fork barrier where we could not
29963041982dSJonathan Peyton           // get the object reliably
29977cc577a4SJonathan Peyton           itt_sync_obj = __kmp_itt_barrier_object(gtid, bs_forkjoin_barrier);
29987cc577a4SJonathan Peyton         }
29997cc577a4SJonathan Peyton         __kmp_itt_task_starting(itt_sync_obj);
30007cc577a4SJonathan Peyton       }
30017cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY */
30027cc577a4SJonathan Peyton       __kmp_invoke_task(gtid, task, current_task);
30037cc577a4SJonathan Peyton #if USE_ITT_BUILD
30043041982dSJonathan Peyton       if (itt_sync_obj != NULL)
30053041982dSJonathan Peyton         __kmp_itt_task_finished(itt_sync_obj);
30067cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
30073041982dSJonathan Peyton       // If this thread is only partway through the barrier and the condition is
30083041982dSJonathan Peyton       // met, then return now, so that the barrier gather/release pattern can
30093041982dSJonathan Peyton       // proceed. If this thread is in the last spin loop in the barrier,
30103041982dSJonathan Peyton       // waiting to be released, we know that the termination condition will not
301142016791SKazuaki Ishizaki       // be satisfied, so don't waste any cycles checking it.
30127cc577a4SJonathan Peyton       if (flag == NULL || (!final_spin && flag->done_check())) {
30133041982dSJonathan Peyton         KA_TRACE(
30143041982dSJonathan Peyton             15,
30153041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30163041982dSJonathan Peyton              gtid));
30177cc577a4SJonathan Peyton         return TRUE;
30187cc577a4SJonathan Peyton       }
30197cc577a4SJonathan Peyton       if (thread->th.th_task_team == NULL) {
30207cc577a4SJonathan Peyton         break;
30217cc577a4SJonathan Peyton       }
3022e47d32f1SJonathan Peyton       KMP_YIELD(__kmp_library == library_throughput); // Yield before next task
30233041982dSJonathan Peyton       // If execution of a stolen task results in more tasks being placed on our
30243041982dSJonathan Peyton       // run queue, reset use_own_tasks
30257cc577a4SJonathan Peyton       if (!use_own_tasks && TCR_4(threads_data[tid].td.td_deque_ntasks) != 0) {
30263041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d stolen task spawned "
30273041982dSJonathan Peyton                       "other tasks, restart\n",
30283041982dSJonathan Peyton                       gtid));
30297cc577a4SJonathan Peyton         use_own_tasks = 1;
30307cc577a4SJonathan Peyton         new_victim = 0;
30317cc577a4SJonathan Peyton       }
30327cc577a4SJonathan Peyton     }
30337cc577a4SJonathan Peyton 
3034e4b4f994SJonathan Peyton     // The task source has been exhausted. If in final spin loop of barrier,
3035e4b4f994SJonathan Peyton     // check if termination condition is satisfied. The work queue may be empty
3036e4b4f994SJonathan Peyton     // but there might be proxy tasks still executing.
303737e2ef54SJonathan Peyton     if (final_spin &&
3038e4b4f994SJonathan Peyton         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks) == 0) {
30393041982dSJonathan Peyton       // First, decrement the #unfinished threads, if that has not already been
30403041982dSJonathan Peyton       // done.  This decrement might be to the spin location, and result in the
30413041982dSJonathan Peyton       // termination condition being satisfied.
30427cc577a4SJonathan Peyton       if (!*thread_finished) {
3043c47afcd9SAndrey Churbanov         kmp_int32 count;
30447cc577a4SJonathan Peyton 
304537e2ef54SJonathan Peyton         count = KMP_ATOMIC_DEC(unfinished_threads) - 1;
30463041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d dec "
30473041982dSJonathan Peyton                       "unfinished_threads to %d task_team=%p\n",
30487cc577a4SJonathan Peyton                       gtid, count, task_team));
30497cc577a4SJonathan Peyton         *thread_finished = TRUE;
30507cc577a4SJonathan Peyton       }
30517cc577a4SJonathan Peyton 
30527cc577a4SJonathan Peyton       // It is now unsafe to reference thread->th.th_team !!!
30533041982dSJonathan Peyton       // Decrementing task_team->tt.tt_unfinished_threads can allow the master
30543041982dSJonathan Peyton       // thread to pass through the barrier, where it might reset each thread's
30553041982dSJonathan Peyton       // th.th_team field for the next parallel region. If we can steal more
30563041982dSJonathan Peyton       // work, we know that this has not happened yet.
30577cc577a4SJonathan Peyton       if (flag != NULL && flag->done_check()) {
30583041982dSJonathan Peyton         KA_TRACE(
30593041982dSJonathan Peyton             15,
30603041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30613041982dSJonathan Peyton              gtid));
30627cc577a4SJonathan Peyton         return TRUE;
30637cc577a4SJonathan Peyton       }
30647cc577a4SJonathan Peyton     }
30657cc577a4SJonathan Peyton 
30663041982dSJonathan Peyton     // If this thread's task team is NULL, master has recognized that there are
30673041982dSJonathan Peyton     // no more tasks; bail out
30687cc577a4SJonathan Peyton     if (thread->th.th_task_team == NULL) {
30693041982dSJonathan Peyton       KA_TRACE(15,
30703041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d no more tasks\n", gtid));
30717cc577a4SJonathan Peyton       return FALSE;
30727cc577a4SJonathan Peyton     }
30737cc577a4SJonathan Peyton 
30743041982dSJonathan Peyton     // We could be getting tasks from target constructs; if this is the only
30753041982dSJonathan Peyton     // thread, keep trying to execute tasks from own queue
30769d64275aSShilei Tian     if (nthreads == 1 &&
30779d64275aSShilei Tian         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks))
30787cc577a4SJonathan Peyton       use_own_tasks = 1;
3079e4b4f994SJonathan Peyton     else {
30803041982dSJonathan Peyton       KA_TRACE(15,
30813041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d can't find work\n", gtid));
30827cc577a4SJonathan Peyton       return FALSE;
30837cc577a4SJonathan Peyton     }
30847cc577a4SJonathan Peyton   }
30857cc577a4SJonathan Peyton }
30867cc577a4SJonathan Peyton 
3087e0665a90STerry Wilmarth template <bool C, bool S>
30883041982dSJonathan Peyton int __kmp_execute_tasks_32(
3089e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32<C, S> *flag, int final_spin,
30903041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30913041982dSJonathan Peyton     kmp_int32 is_constrained) {
30923041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30933041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30943041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30957cc577a4SJonathan Peyton }
30967cc577a4SJonathan Peyton 
3097e0665a90STerry Wilmarth template <bool C, bool S>
30983041982dSJonathan Peyton int __kmp_execute_tasks_64(
3099e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64<C, S> *flag, int final_spin,
31003041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31013041982dSJonathan Peyton     kmp_int32 is_constrained) {
31023041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31033041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31043041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31057cc577a4SJonathan Peyton }
31067cc577a4SJonathan Peyton 
31073041982dSJonathan Peyton int __kmp_execute_tasks_oncore(
31083041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
31093041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31103041982dSJonathan Peyton     kmp_int32 is_constrained) {
31113041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31123041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31133041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31147cc577a4SJonathan Peyton }
31157cc577a4SJonathan Peyton 
3116e0665a90STerry Wilmarth template int
3117e0665a90STerry Wilmarth __kmp_execute_tasks_32<false, false>(kmp_info_t *, kmp_int32,
3118e0665a90STerry Wilmarth                                      kmp_flag_32<false, false> *, int,
3119e0665a90STerry Wilmarth                                      int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3120e0665a90STerry Wilmarth 
3121e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<false, true>(kmp_info_t *, kmp_int32,
3122e0665a90STerry Wilmarth                                                  kmp_flag_64<false, true> *,
3123e0665a90STerry Wilmarth                                                  int,
3124e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3125e0665a90STerry Wilmarth                                                  kmp_int32);
3126e0665a90STerry Wilmarth 
3127e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<true, false>(kmp_info_t *, kmp_int32,
3128e0665a90STerry Wilmarth                                                  kmp_flag_64<true, false> *,
3129e0665a90STerry Wilmarth                                                  int,
3130e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3131e0665a90STerry Wilmarth                                                  kmp_int32);
3132e0665a90STerry Wilmarth 
31337cc577a4SJonathan Peyton // __kmp_enable_tasking: Allocate task team and resume threads sleeping at the
31347cc577a4SJonathan Peyton // next barrier so they can assist in executing enqueued tasks.
31357cc577a4SJonathan Peyton // First thread in allocates the task team atomically.
31363041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
31373041982dSJonathan Peyton                                  kmp_info_t *this_thr) {
31387cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
31397cc577a4SJonathan Peyton   int nthreads, i, is_init_thread;
31407cc577a4SJonathan Peyton 
31417cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(enter): T#%d\n",
31427cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31437cc577a4SJonathan Peyton 
31447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
31457cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr->th.th_team != NULL);
31467cc577a4SJonathan Peyton 
31477cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
31487cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 0);
31497cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads == this_thr->th.th_team->t.t_nproc);
31507cc577a4SJonathan Peyton 
31517cc577a4SJonathan Peyton   // Allocate or increase the size of threads_data if necessary
31527cc577a4SJonathan Peyton   is_init_thread = __kmp_realloc_task_threads_data(this_thr, task_team);
31537cc577a4SJonathan Peyton 
31547cc577a4SJonathan Peyton   if (!is_init_thread) {
31557cc577a4SJonathan Peyton     // Some other thread already set up the array.
31563041982dSJonathan Peyton     KA_TRACE(
31573041982dSJonathan Peyton         20,
31583041982dSJonathan Peyton         ("__kmp_enable_tasking(exit): T#%d: threads array already set up.\n",
31597cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr)));
31607cc577a4SJonathan Peyton     return;
31617cc577a4SJonathan Peyton   }
31627cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
31637cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
31647cc577a4SJonathan Peyton 
31659b8bb323SJonathan Peyton   if (__kmp_tasking_mode == tskm_task_teams &&
31663041982dSJonathan Peyton       (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME)) {
31677cc577a4SJonathan Peyton     // Release any threads sleeping at the barrier, so that they can steal
31687cc577a4SJonathan Peyton     // tasks and execute them.  In extra barrier mode, tasks do not sleep
31697cc577a4SJonathan Peyton     // at the separate tasking barrier, so this isn't a problem.
31707cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
31717cc577a4SJonathan Peyton       volatile void *sleep_loc;
31727cc577a4SJonathan Peyton       kmp_info_t *thread = threads_data[i].td.td_thr;
31737cc577a4SJonathan Peyton 
31747cc577a4SJonathan Peyton       if (i == this_thr->th.th_info.ds.ds_tid) {
31757cc577a4SJonathan Peyton         continue;
31767cc577a4SJonathan Peyton       }
31777cc577a4SJonathan Peyton       // Since we haven't locked the thread's suspend mutex lock at this
31787cc577a4SJonathan Peyton       // point, there is a small window where a thread might be putting
31797cc577a4SJonathan Peyton       // itself to sleep, but hasn't set the th_sleep_loc field yet.
31807cc577a4SJonathan Peyton       // To work around this, __kmp_execute_tasks_template() periodically checks
31813041982dSJonathan Peyton       // see if other threads are sleeping (using the same random mechanism that
31823041982dSJonathan Peyton       // is used for task stealing) and awakens them if they are.
3183c47afcd9SAndrey Churbanov       if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3184c47afcd9SAndrey Churbanov           NULL) {
31857cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d waking up thread T#%d\n",
31867cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31877cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31887cc577a4SJonathan Peyton         __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
31893041982dSJonathan Peyton       } else {
31907cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d don't wake up thread T#%d\n",
31917cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31927cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31937cc577a4SJonathan Peyton       }
31947cc577a4SJonathan Peyton     }
31957cc577a4SJonathan Peyton   }
31967cc577a4SJonathan Peyton 
31977cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(exit): T#%d\n",
31987cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31997cc577a4SJonathan Peyton }
32007cc577a4SJonathan Peyton 
32017cc577a4SJonathan Peyton /* // TODO: Check the comment consistency
32027cc577a4SJonathan Peyton  * Utility routines for "task teams".  A task team (kmp_task_t) is kind of
32037cc577a4SJonathan Peyton  * like a shadow of the kmp_team_t data struct, with a different lifetime.
32047cc577a4SJonathan Peyton  * After a child * thread checks into a barrier and calls __kmp_release() from
32057cc577a4SJonathan Peyton  * the particular variant of __kmp_<barrier_kind>_barrier_gather(), it can no
32067cc577a4SJonathan Peyton  * longer assume that the kmp_team_t structure is intact (at any moment, the
32077cc577a4SJonathan Peyton  * master thread may exit the barrier code and free the team data structure,
32087cc577a4SJonathan Peyton  * and return the threads to the thread pool).
32097cc577a4SJonathan Peyton  *
3210ed5fe645SKelvin Li  * This does not work with the tasking code, as the thread is still
32117cc577a4SJonathan Peyton  * expected to participate in the execution of any tasks that may have been
32127cc577a4SJonathan Peyton  * spawned my a member of the team, and the thread still needs access to all
32137cc577a4SJonathan Peyton  * to each thread in the team, so that it can steal work from it.
32147cc577a4SJonathan Peyton  *
32157cc577a4SJonathan Peyton  * Enter the existence of the kmp_task_team_t struct.  It employs a reference
321642016791SKazuaki Ishizaki  * counting mechanism, and is allocated by the master thread before calling
32177cc577a4SJonathan Peyton  * __kmp_<barrier_kind>_release, and then is release by the last thread to
32187cc577a4SJonathan Peyton  * exit __kmp_<barrier_kind>_release at the next barrier.  I.e. the lifetimes
32197cc577a4SJonathan Peyton  * of the kmp_task_team_t structs for consecutive barriers can overlap
32207cc577a4SJonathan Peyton  * (and will, unless the master thread is the last thread to exit the barrier
3221e4b4f994SJonathan Peyton  * release phase, which is not typical). The existence of such a struct is
3222e4b4f994SJonathan Peyton  * useful outside the context of tasking.
32237cc577a4SJonathan Peyton  *
32247cc577a4SJonathan Peyton  * We currently use the existence of the threads array as an indicator that
32257cc577a4SJonathan Peyton  * tasks were spawned since the last barrier.  If the structure is to be
32267cc577a4SJonathan Peyton  * useful outside the context of tasking, then this will have to change, but
322742016791SKazuaki Ishizaki  * not setting the field minimizes the performance impact of tasking on
32287cc577a4SJonathan Peyton  * barriers, when no explicit tasks were spawned (pushed, actually).
32297cc577a4SJonathan Peyton  */
32307cc577a4SJonathan Peyton 
32313041982dSJonathan Peyton static kmp_task_team_t *__kmp_free_task_teams =
32323041982dSJonathan Peyton     NULL; // Free list for task_team data structures
32337cc577a4SJonathan Peyton // Lock for task team data structures
3234eaa9e40cSJonathan Peyton kmp_bootstrap_lock_t __kmp_task_team_lock =
32353041982dSJonathan Peyton     KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_task_team_lock);
32367cc577a4SJonathan Peyton 
32377cc577a4SJonathan Peyton // __kmp_alloc_task_deque:
32387cc577a4SJonathan Peyton // Allocates a task deque for a particular thread, and initialize the necessary
32397cc577a4SJonathan Peyton // data structures relating to the deque.  This only happens once per thread
32403041982dSJonathan Peyton // per task team since task teams are recycled. No lock is needed during
32413041982dSJonathan Peyton // allocation since each thread allocates its own deque.
32423041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
32433041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data) {
32447cc577a4SJonathan Peyton   __kmp_init_bootstrap_lock(&thread_data->td.td_deque_lock);
32457cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque == NULL);
32467cc577a4SJonathan Peyton 
32477cc577a4SJonathan Peyton   // Initialize last stolen task field to "none"
32487cc577a4SJonathan Peyton   thread_data->td.td_deque_last_stolen = -1;
32497cc577a4SJonathan Peyton 
32507cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == 0);
32517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_head == 0);
32527cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_tail == 0);
32537cc577a4SJonathan Peyton 
32543041982dSJonathan Peyton   KE_TRACE(
32553041982dSJonathan Peyton       10,
32563041982dSJonathan Peyton       ("__kmp_alloc_task_deque: T#%d allocating deque[%d] for thread_data %p\n",
32577cc577a4SJonathan Peyton        __kmp_gtid_from_thread(thread), INITIAL_TASK_DEQUE_SIZE, thread_data));
32587cc577a4SJonathan Peyton   // Allocate space for task deque, and zero the deque
32597cc577a4SJonathan Peyton   // Cannot use __kmp_thread_calloc() because threads not around for
32607cc577a4SJonathan Peyton   // kmp_reap_task_team( ).
32613041982dSJonathan Peyton   thread_data->td.td_deque = (kmp_taskdata_t **)__kmp_allocate(
32623041982dSJonathan Peyton       INITIAL_TASK_DEQUE_SIZE * sizeof(kmp_taskdata_t *));
32637cc577a4SJonathan Peyton   thread_data->td.td_deque_size = INITIAL_TASK_DEQUE_SIZE;
32647cc577a4SJonathan Peyton }
32657cc577a4SJonathan Peyton 
32667cc577a4SJonathan Peyton // __kmp_free_task_deque:
32673041982dSJonathan Peyton // Deallocates a task deque for a particular thread. Happens at library
32683041982dSJonathan Peyton // deallocation so don't need to reset all thread data fields.
32693041982dSJonathan Peyton static void __kmp_free_task_deque(kmp_thread_data_t *thread_data) {
32707cc577a4SJonathan Peyton   if (thread_data->td.td_deque != NULL) {
32711b536724SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
32727cc577a4SJonathan Peyton     TCW_4(thread_data->td.td_deque_ntasks, 0);
32737cc577a4SJonathan Peyton     __kmp_free(thread_data->td.td_deque);
32747cc577a4SJonathan Peyton     thread_data->td.td_deque = NULL;
32757cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
32761b536724SJonathan Peyton   }
32777cc577a4SJonathan Peyton 
32787cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
32797cc577a4SJonathan Peyton   // GEH: Figure out what to do here for td_susp_tied_tasks
32807cc577a4SJonathan Peyton   if (thread_data->td.td_susp_tied_tasks.ts_entries != TASK_STACK_EMPTY) {
32817cc577a4SJonathan Peyton     __kmp_free_task_stack(__kmp_thread_from_gtid(gtid), thread_data);
32827cc577a4SJonathan Peyton   }
32837cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
32847cc577a4SJonathan Peyton }
32857cc577a4SJonathan Peyton 
32867cc577a4SJonathan Peyton // __kmp_realloc_task_threads_data:
32873041982dSJonathan Peyton // Allocates a threads_data array for a task team, either by allocating an
32883041982dSJonathan Peyton // initial array or enlarging an existing array.  Only the first thread to get
32894c6a098aSKazuaki Ishizaki // the lock allocs or enlarges the array and re-initializes the array elements.
32907cc577a4SJonathan Peyton // That thread returns "TRUE", the rest return "FALSE".
32917cc577a4SJonathan Peyton // Assumes that the new array size is given by task_team -> tt.tt_nproc.
32927cc577a4SJonathan Peyton // The current size is given by task_team -> tt.tt_max_threads.
32933041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
32943041982dSJonathan Peyton                                            kmp_task_team_t *task_team) {
32957cc577a4SJonathan Peyton   kmp_thread_data_t **threads_data_p;
32967cc577a4SJonathan Peyton   kmp_int32 nthreads, maxthreads;
32977cc577a4SJonathan Peyton   int is_init_thread = FALSE;
32987cc577a4SJonathan Peyton 
32997cc577a4SJonathan Peyton   if (TCR_4(task_team->tt.tt_found_tasks)) {
33007cc577a4SJonathan Peyton     // Already reallocated and initialized.
33017cc577a4SJonathan Peyton     return FALSE;
33027cc577a4SJonathan Peyton   }
33037cc577a4SJonathan Peyton 
33047cc577a4SJonathan Peyton   threads_data_p = &task_team->tt.tt_threads_data;
33057cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
33067cc577a4SJonathan Peyton   maxthreads = task_team->tt.tt_max_threads;
33077cc577a4SJonathan Peyton 
33083041982dSJonathan Peyton   // All threads must lock when they encounter the first task of the implicit
33093041982dSJonathan Peyton   // task region to make sure threads_data fields are (re)initialized before
33103041982dSJonathan Peyton   // used.
33117cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
33127cc577a4SJonathan Peyton 
33137cc577a4SJonathan Peyton   if (!TCR_4(task_team->tt.tt_found_tasks)) {
33147cc577a4SJonathan Peyton     // first thread to enable tasking
33157cc577a4SJonathan Peyton     kmp_team_t *team = thread->th.th_team;
33167cc577a4SJonathan Peyton     int i;
33177cc577a4SJonathan Peyton 
33187cc577a4SJonathan Peyton     is_init_thread = TRUE;
33197cc577a4SJonathan Peyton     if (maxthreads < nthreads) {
33207cc577a4SJonathan Peyton 
33217cc577a4SJonathan Peyton       if (*threads_data_p != NULL) {
33227cc577a4SJonathan Peyton         kmp_thread_data_t *old_data = *threads_data_p;
33237cc577a4SJonathan Peyton         kmp_thread_data_t *new_data = NULL;
33247cc577a4SJonathan Peyton 
33253041982dSJonathan Peyton         KE_TRACE(
33263041982dSJonathan Peyton             10,
33273041982dSJonathan Peyton             ("__kmp_realloc_task_threads_data: T#%d reallocating "
33287cc577a4SJonathan Peyton              "threads data for task_team %p, new_size = %d, old_size = %d\n",
33293041982dSJonathan Peyton              __kmp_gtid_from_thread(thread), task_team, nthreads, maxthreads));
33307cc577a4SJonathan Peyton         // Reallocate threads_data to have more elements than current array
33317cc577a4SJonathan Peyton         // Cannot use __kmp_thread_realloc() because threads not around for
33327cc577a4SJonathan Peyton         // kmp_reap_task_team( ).  Note all new array entries are initialized
33337cc577a4SJonathan Peyton         // to zero by __kmp_allocate().
33343041982dSJonathan Peyton         new_data = (kmp_thread_data_t *)__kmp_allocate(
33353041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33367cc577a4SJonathan Peyton         // copy old data to new data
33377cc577a4SJonathan Peyton         KMP_MEMCPY_S((void *)new_data, nthreads * sizeof(kmp_thread_data_t),
333871483f2dSAndrey Churbanov                      (void *)old_data, maxthreads * sizeof(kmp_thread_data_t));
33397cc577a4SJonathan Peyton 
33407cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33417cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33427cc577a4SJonathan Peyton         for (i = maxthreads; i < nthreads; i++) {
33437cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33447cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33457cc577a4SJonathan Peyton         }
33467cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33477cc577a4SJonathan Peyton        // Install the new data and free the old data
33487cc577a4SJonathan Peyton         (*threads_data_p) = new_data;
33497cc577a4SJonathan Peyton         __kmp_free(old_data);
33503041982dSJonathan Peyton       } else {
33517cc577a4SJonathan Peyton         KE_TRACE(10, ("__kmp_realloc_task_threads_data: T#%d allocating "
33527cc577a4SJonathan Peyton                       "threads data for task_team %p, size = %d\n",
33537cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread), task_team, nthreads));
33547cc577a4SJonathan Peyton         // Make the initial allocate for threads_data array, and zero entries
33557cc577a4SJonathan Peyton         // Cannot use __kmp_thread_calloc() because threads not around for
33567cc577a4SJonathan Peyton         // kmp_reap_task_team( ).
33577cc577a4SJonathan Peyton         ANNOTATE_IGNORE_WRITES_BEGIN();
33583041982dSJonathan Peyton         *threads_data_p = (kmp_thread_data_t *)__kmp_allocate(
33593041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33607cc577a4SJonathan Peyton         ANNOTATE_IGNORE_WRITES_END();
33617cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33627cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33637cc577a4SJonathan Peyton         for (i = 0; i < nthreads; i++) {
33647cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33657cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33667cc577a4SJonathan Peyton         }
33677cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33687cc577a4SJonathan Peyton       }
33697cc577a4SJonathan Peyton       task_team->tt.tt_max_threads = nthreads;
33703041982dSJonathan Peyton     } else {
33717cc577a4SJonathan Peyton       // If array has (more than) enough elements, go ahead and use it
33727cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(*threads_data_p != NULL);
33737cc577a4SJonathan Peyton     }
33747cc577a4SJonathan Peyton 
33757cc577a4SJonathan Peyton     // initialize threads_data pointers back to thread_info structures
33767cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
33777cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33787cc577a4SJonathan Peyton       thread_data->td.td_thr = team->t.t_threads[i];
33797cc577a4SJonathan Peyton 
33807cc577a4SJonathan Peyton       if (thread_data->td.td_deque_last_stolen >= nthreads) {
33817cc577a4SJonathan Peyton         // The last stolen field survives across teams / barrier, and the number
33827cc577a4SJonathan Peyton         // of threads may have changed.  It's possible (likely?) that a new
33833041982dSJonathan Peyton         // parallel region will exhibit the same behavior as previous region.
33847cc577a4SJonathan Peyton         thread_data->td.td_deque_last_stolen = -1;
33857cc577a4SJonathan Peyton       }
33867cc577a4SJonathan Peyton     }
33877cc577a4SJonathan Peyton 
33887cc577a4SJonathan Peyton     KMP_MB();
33897cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_tasks, TRUE);
33907cc577a4SJonathan Peyton   }
33917cc577a4SJonathan Peyton 
33927cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
33937cc577a4SJonathan Peyton   return is_init_thread;
33947cc577a4SJonathan Peyton }
33957cc577a4SJonathan Peyton 
33967cc577a4SJonathan Peyton // __kmp_free_task_threads_data:
33977cc577a4SJonathan Peyton // Deallocates a threads_data array for a task team, including any attached
33987cc577a4SJonathan Peyton // tasking deques.  Only occurs at library shutdown.
33993041982dSJonathan Peyton static void __kmp_free_task_threads_data(kmp_task_team_t *task_team) {
34007cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
34017cc577a4SJonathan Peyton   if (task_team->tt.tt_threads_data != NULL) {
34027cc577a4SJonathan Peyton     int i;
34037cc577a4SJonathan Peyton     for (i = 0; i < task_team->tt.tt_max_threads; i++) {
34047cc577a4SJonathan Peyton       __kmp_free_task_deque(&task_team->tt.tt_threads_data[i]);
34057cc577a4SJonathan Peyton     }
34067cc577a4SJonathan Peyton     __kmp_free(task_team->tt.tt_threads_data);
34077cc577a4SJonathan Peyton     task_team->tt.tt_threads_data = NULL;
34087cc577a4SJonathan Peyton   }
34097cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
34107cc577a4SJonathan Peyton }
34117cc577a4SJonathan Peyton 
34127cc577a4SJonathan Peyton // __kmp_allocate_task_team:
34137cc577a4SJonathan Peyton // Allocates a task team associated with a specific team, taking it from
34143041982dSJonathan Peyton // the global task team free list if possible.  Also initializes data
34153041982dSJonathan Peyton // structures.
34163041982dSJonathan Peyton static kmp_task_team_t *__kmp_allocate_task_team(kmp_info_t *thread,
34173041982dSJonathan Peyton                                                  kmp_team_t *team) {
34187cc577a4SJonathan Peyton   kmp_task_team_t *task_team = NULL;
34197cc577a4SJonathan Peyton   int nthreads;
34207cc577a4SJonathan Peyton 
34217cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d entering; team = %p\n",
34227cc577a4SJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), team));
34237cc577a4SJonathan Peyton 
34247cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
34257cc577a4SJonathan Peyton     // Take a task team from the task team pool
34267cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34277cc577a4SJonathan Peyton     if (__kmp_free_task_teams != NULL) {
34287cc577a4SJonathan Peyton       task_team = __kmp_free_task_teams;
34297cc577a4SJonathan Peyton       TCW_PTR(__kmp_free_task_teams, task_team->tt.tt_next);
34307cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
34317cc577a4SJonathan Peyton     }
34327cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34337cc577a4SJonathan Peyton   }
34347cc577a4SJonathan Peyton 
34357cc577a4SJonathan Peyton   if (task_team == NULL) {
34367cc577a4SJonathan Peyton     KE_TRACE(10, ("__kmp_allocate_task_team: T#%d allocating "
34377cc577a4SJonathan Peyton                   "task team for team %p\n",
34387cc577a4SJonathan Peyton                   __kmp_gtid_from_thread(thread), team));
3439ffd8f009SAndreyChurbanov     // Allocate a new task team if one is not available. Cannot use
3440ffd8f009SAndreyChurbanov     // __kmp_thread_malloc because threads not around for kmp_reap_task_team.
34417cc577a4SJonathan Peyton     task_team = (kmp_task_team_t *)__kmp_allocate(sizeof(kmp_task_team_t));
34427cc577a4SJonathan Peyton     __kmp_init_bootstrap_lock(&task_team->tt.tt_threads_lock);
3443ffd8f009SAndreyChurbanov #if USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG
3444ffd8f009SAndreyChurbanov     // suppress race conditions detection on synchronization flags in debug mode
3445ffd8f009SAndreyChurbanov     // this helps to analyze library internals eliminating false positives
3446ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(
3447ffd8f009SAndreyChurbanov         __itt_suppress_range, __itt_suppress_threading_errors,
3448ffd8f009SAndreyChurbanov         &task_team->tt.tt_found_tasks, sizeof(task_team->tt.tt_found_tasks));
3449ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(__itt_suppress_range,
3450ffd8f009SAndreyChurbanov                               __itt_suppress_threading_errors,
3451ffd8f009SAndreyChurbanov                               CCAST(kmp_uint32 *, &task_team->tt.tt_active),
3452ffd8f009SAndreyChurbanov                               sizeof(task_team->tt.tt_active));
3453ffd8f009SAndreyChurbanov #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG */
3454ffd8f009SAndreyChurbanov     // Note: __kmp_allocate zeroes returned memory, othewise we would need:
34553041982dSJonathan Peyton     // task_team->tt.tt_threads_data = NULL;
34567cc577a4SJonathan Peyton     // task_team->tt.tt_max_threads = 0;
34577cc577a4SJonathan Peyton     // task_team->tt.tt_next = NULL;
34587cc577a4SJonathan Peyton   }
34597cc577a4SJonathan Peyton 
34607cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_tasks, FALSE);
34617cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
34627cc577a4SJonathan Peyton   task_team->tt.tt_nproc = nthreads = team->t.t_nproc;
34637cc577a4SJonathan Peyton 
346437e2ef54SJonathan Peyton   KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads, nthreads);
34659d64275aSShilei Tian   TCW_4(task_team->tt.tt_hidden_helper_task_encountered, FALSE);
34667cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_active, TRUE);
34677cc577a4SJonathan Peyton 
34683041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d exiting; task_team = %p "
34693041982dSJonathan Peyton                 "unfinished_threads init'd to %d\n",
34703041982dSJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), task_team,
347137e2ef54SJonathan Peyton                 KMP_ATOMIC_LD_RLX(&task_team->tt.tt_unfinished_threads)));
34727cc577a4SJonathan Peyton   return task_team;
34737cc577a4SJonathan Peyton }
34747cc577a4SJonathan Peyton 
34757cc577a4SJonathan Peyton // __kmp_free_task_team:
34767cc577a4SJonathan Peyton // Frees the task team associated with a specific thread, and adds it
34777cc577a4SJonathan Peyton // to the global task team free list.
34783041982dSJonathan Peyton void __kmp_free_task_team(kmp_info_t *thread, kmp_task_team_t *task_team) {
34797cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_free_task_team: T#%d task_team = %p\n",
34807cc577a4SJonathan Peyton                 thread ? __kmp_gtid_from_thread(thread) : -1, task_team));
34817cc577a4SJonathan Peyton 
34827cc577a4SJonathan Peyton   // Put task team back on free list
34837cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34847cc577a4SJonathan Peyton 
34857cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_next == NULL);
34867cc577a4SJonathan Peyton   task_team->tt.tt_next = __kmp_free_task_teams;
34877cc577a4SJonathan Peyton   TCW_PTR(__kmp_free_task_teams, task_team);
34887cc577a4SJonathan Peyton 
34897cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34907cc577a4SJonathan Peyton }
34917cc577a4SJonathan Peyton 
34927cc577a4SJonathan Peyton // __kmp_reap_task_teams:
34937cc577a4SJonathan Peyton // Free all the task teams on the task team free list.
34947cc577a4SJonathan Peyton // Should only be done during library shutdown.
34953041982dSJonathan Peyton // Cannot do anything that needs a thread structure or gtid since they are
34963041982dSJonathan Peyton // already gone.
34973041982dSJonathan Peyton void __kmp_reap_task_teams(void) {
34987cc577a4SJonathan Peyton   kmp_task_team_t *task_team;
34997cc577a4SJonathan Peyton 
35007cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
35017cc577a4SJonathan Peyton     // Free all task_teams on the free list
35027cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
35037cc577a4SJonathan Peyton     while ((task_team = __kmp_free_task_teams) != NULL) {
35047cc577a4SJonathan Peyton       __kmp_free_task_teams = task_team->tt.tt_next;
35057cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
35067cc577a4SJonathan Peyton 
35077cc577a4SJonathan Peyton       // Free threads_data if necessary
35087cc577a4SJonathan Peyton       if (task_team->tt.tt_threads_data != NULL) {
35097cc577a4SJonathan Peyton         __kmp_free_task_threads_data(task_team);
35107cc577a4SJonathan Peyton       }
35117cc577a4SJonathan Peyton       __kmp_free(task_team);
35127cc577a4SJonathan Peyton     }
35137cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
35147cc577a4SJonathan Peyton   }
35157cc577a4SJonathan Peyton }
35167cc577a4SJonathan Peyton 
35177cc577a4SJonathan Peyton // __kmp_wait_to_unref_task_teams:
35187cc577a4SJonathan Peyton // Some threads could still be in the fork barrier release code, possibly
35197cc577a4SJonathan Peyton // trying to steal tasks.  Wait for each thread to unreference its task team.
35203041982dSJonathan Peyton void __kmp_wait_to_unref_task_teams(void) {
35217cc577a4SJonathan Peyton   kmp_info_t *thread;
35227cc577a4SJonathan Peyton   kmp_uint32 spins;
35237cc577a4SJonathan Peyton   int done;
35247cc577a4SJonathan Peyton 
35257cc577a4SJonathan Peyton   KMP_INIT_YIELD(spins);
35267cc577a4SJonathan Peyton 
35277cc577a4SJonathan Peyton   for (;;) {
35287cc577a4SJonathan Peyton     done = TRUE;
35297cc577a4SJonathan Peyton 
35307cc577a4SJonathan Peyton     // TODO: GEH - this may be is wrong because some sync would be necessary
35313041982dSJonathan Peyton     // in case threads are added to the pool during the traversal. Need to
35323041982dSJonathan Peyton     // verify that lock for thread pool is held when calling this routine.
3533c47afcd9SAndrey Churbanov     for (thread = CCAST(kmp_info_t *, __kmp_thread_pool); thread != NULL;
35343041982dSJonathan Peyton          thread = thread->th.th_next_pool) {
35357cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35367cc577a4SJonathan Peyton       DWORD exit_val;
35377cc577a4SJonathan Peyton #endif
35387cc577a4SJonathan Peyton       if (TCR_PTR(thread->th.th_task_team) == NULL) {
35397cc577a4SJonathan Peyton         KA_TRACE(10, ("__kmp_wait_to_unref_task_team: T#%d task_team == NULL\n",
35407cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
35417cc577a4SJonathan Peyton         continue;
35427cc577a4SJonathan Peyton       }
35437cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35447cc577a4SJonathan Peyton       // TODO: GEH - add this check for Linux* OS / OS X* as well?
35457cc577a4SJonathan Peyton       if (!__kmp_is_thread_alive(thread, &exit_val)) {
35467cc577a4SJonathan Peyton         thread->th.th_task_team = NULL;
35477cc577a4SJonathan Peyton         continue;
35487cc577a4SJonathan Peyton       }
35497cc577a4SJonathan Peyton #endif
35507cc577a4SJonathan Peyton 
35517cc577a4SJonathan Peyton       done = FALSE; // Because th_task_team pointer is not NULL for this thread
35527cc577a4SJonathan Peyton 
35533041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_wait_to_unref_task_team: Waiting for T#%d to "
35543041982dSJonathan Peyton                     "unreference task_team\n",
35557cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(thread)));
35567cc577a4SJonathan Peyton 
35577cc577a4SJonathan Peyton       if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
35587cc577a4SJonathan Peyton         volatile void *sleep_loc;
35597cc577a4SJonathan Peyton         // If the thread is sleeping, awaken it.
3560c47afcd9SAndrey Churbanov         if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3561c47afcd9SAndrey Churbanov             NULL) {
35623041982dSJonathan Peyton           KA_TRACE(
35633041982dSJonathan Peyton               10,
35643041982dSJonathan Peyton               ("__kmp_wait_to_unref_task_team: T#%d waking up thread T#%d\n",
35657cc577a4SJonathan Peyton                __kmp_gtid_from_thread(thread), __kmp_gtid_from_thread(thread)));
35667cc577a4SJonathan Peyton           __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
35677cc577a4SJonathan Peyton         }
35687cc577a4SJonathan Peyton       }
35697cc577a4SJonathan Peyton     }
35707cc577a4SJonathan Peyton     if (done) {
35717cc577a4SJonathan Peyton       break;
35727cc577a4SJonathan Peyton     }
35737cc577a4SJonathan Peyton 
3574e47d32f1SJonathan Peyton     // If oversubscribed or have waited a bit, yield.
3575e47d32f1SJonathan Peyton     KMP_YIELD_OVERSUB_ELSE_SPIN(spins);
35767cc577a4SJonathan Peyton   }
35777cc577a4SJonathan Peyton }
35787cc577a4SJonathan Peyton 
35797cc577a4SJonathan Peyton // __kmp_task_team_setup:  Create a task_team for the current team, but use
35807cc577a4SJonathan Peyton // an already created, unused one if it already exists.
35813041982dSJonathan Peyton void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team, int always) {
35827cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
35837cc577a4SJonathan Peyton 
35843041982dSJonathan Peyton   // If this task_team hasn't been created yet, allocate it. It will be used in
35853041982dSJonathan Peyton   // the region after the next.
35863041982dSJonathan Peyton   // If it exists, it is the current task team and shouldn't be touched yet as
35873041982dSJonathan Peyton   // it may still be in use.
35883041982dSJonathan Peyton   if (team->t.t_task_team[this_thr->th.th_task_state] == NULL &&
35893041982dSJonathan Peyton       (always || team->t.t_nproc > 1)) {
35903041982dSJonathan Peyton     team->t.t_task_team[this_thr->th.th_task_state] =
35913041982dSJonathan Peyton         __kmp_allocate_task_team(this_thr, team);
35923041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_task_team_setup: Master T#%d created new task_team %p "
35933041982dSJonathan Peyton                   "for team %d at parity=%d\n",
35943041982dSJonathan Peyton                   __kmp_gtid_from_thread(this_thr),
35953041982dSJonathan Peyton                   team->t.t_task_team[this_thr->th.th_task_state],
35963041982dSJonathan Peyton                   ((team != NULL) ? team->t.t_id : -1),
35973041982dSJonathan Peyton                   this_thr->th.th_task_state));
35987cc577a4SJonathan Peyton   }
35997cc577a4SJonathan Peyton 
36003041982dSJonathan Peyton   // After threads exit the release, they will call sync, and then point to this
36013041982dSJonathan Peyton   // other task_team; make sure it is allocated and properly initialized. As
36023041982dSJonathan Peyton   // threads spin in the barrier release phase, they will continue to use the
36033041982dSJonathan Peyton   // previous task_team struct(above), until they receive the signal to stop
36043041982dSJonathan Peyton   // checking for tasks (they can't safely reference the kmp_team_t struct,
36053041982dSJonathan Peyton   // which could be reallocated by the master thread). No task teams are formed
36063041982dSJonathan Peyton   // for serialized teams.
36077cc577a4SJonathan Peyton   if (team->t.t_nproc > 1) {
36087cc577a4SJonathan Peyton     int other_team = 1 - this_thr->th.th_task_state;
36097cc577a4SJonathan Peyton     if (team->t.t_task_team[other_team] == NULL) { // setup other team as well
36103041982dSJonathan Peyton       team->t.t_task_team[other_team] =
36113041982dSJonathan Peyton           __kmp_allocate_task_team(this_thr, team);
36123041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_task_team_setup: Master T#%d created second new "
36133041982dSJonathan Peyton                     "task_team %p for team %d at parity=%d\n",
36143041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
36153041982dSJonathan Peyton                     team->t.t_task_team[other_team],
36167cc577a4SJonathan Peyton                     ((team != NULL) ? team->t.t_id : -1), other_team));
36173041982dSJonathan Peyton     } else { // Leave the old task team struct in place for the upcoming region;
36183041982dSJonathan Peyton       // adjust as needed
36197cc577a4SJonathan Peyton       kmp_task_team_t *task_team = team->t.t_task_team[other_team];
36203041982dSJonathan Peyton       if (!task_team->tt.tt_active ||
36213041982dSJonathan Peyton           team->t.t_nproc != task_team->tt.tt_nproc) {
36227cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_nproc, team->t.t_nproc);
36237cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_tasks, FALSE);
36247cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
362537e2ef54SJonathan Peyton         KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads,
362637e2ef54SJonathan Peyton                           team->t.t_nproc);
36277cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_active, TRUE);
36287cc577a4SJonathan Peyton       }
36293041982dSJonathan Peyton       // if team size has changed, the first thread to enable tasking will
36303041982dSJonathan Peyton       // realloc threads_data if necessary
36313041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_task_team_setup: Master T#%d reset next task_team "
36323041982dSJonathan Peyton                     "%p for team %d at parity=%d\n",
36333041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
36343041982dSJonathan Peyton                     team->t.t_task_team[other_team],
36357cc577a4SJonathan Peyton                     ((team != NULL) ? team->t.t_id : -1), other_team));
36367cc577a4SJonathan Peyton     }
36377cc577a4SJonathan Peyton   }
36389d64275aSShilei Tian 
36399d64275aSShilei Tian   // For regular thread, task enabling should be called when the task is going
36409d64275aSShilei Tian   // to be pushed to a dequeue. However, for the hidden helper thread, we need
36419d64275aSShilei Tian   // it ahead of time so that some operations can be performed without race
36429d64275aSShilei Tian   // condition.
36439d64275aSShilei Tian   if (this_thr == __kmp_hidden_helper_main_thread) {
36449d64275aSShilei Tian     for (int i = 0; i < 2; ++i) {
36459d64275aSShilei Tian       kmp_task_team_t *task_team = team->t.t_task_team[i];
36469d64275aSShilei Tian       if (KMP_TASKING_ENABLED(task_team)) {
36479d64275aSShilei Tian         continue;
36489d64275aSShilei Tian       }
36499d64275aSShilei Tian       __kmp_enable_tasking(task_team, this_thr);
36509d64275aSShilei Tian       for (int j = 0; j < task_team->tt.tt_nproc; ++j) {
36519d64275aSShilei Tian         kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[j];
36529d64275aSShilei Tian         if (thread_data->td.td_deque == NULL) {
36539d64275aSShilei Tian           __kmp_alloc_task_deque(__kmp_hidden_helper_threads[j], thread_data);
36549d64275aSShilei Tian         }
36559d64275aSShilei Tian       }
36569d64275aSShilei Tian     }
36579d64275aSShilei Tian   }
36587cc577a4SJonathan Peyton }
36597cc577a4SJonathan Peyton 
36607cc577a4SJonathan Peyton // __kmp_task_team_sync: Propagation of task team data from team to threads
36617cc577a4SJonathan Peyton // which happens just after the release phase of a team barrier.  This may be
36627cc577a4SJonathan Peyton // called by any thread, but only for teams with # threads > 1.
36633041982dSJonathan Peyton void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team) {
36647cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36657cc577a4SJonathan Peyton 
36663041982dSJonathan Peyton   // Toggle the th_task_state field, to switch which task_team this thread
36673041982dSJonathan Peyton   // refers to
36686b316febSTerry Wilmarth   this_thr->th.th_task_state = (kmp_uint8)(1 - this_thr->th.th_task_state);
36696b316febSTerry Wilmarth 
36703041982dSJonathan Peyton   // It is now safe to propagate the task team pointer from the team struct to
36713041982dSJonathan Peyton   // the current thread.
36723041982dSJonathan Peyton   TCW_PTR(this_thr->th.th_task_team,
36733041982dSJonathan Peyton           team->t.t_task_team[this_thr->th.th_task_state]);
36743041982dSJonathan Peyton   KA_TRACE(20,
36753041982dSJonathan Peyton            ("__kmp_task_team_sync: Thread T#%d task team switched to task_team "
36763041982dSJonathan Peyton             "%p from Team #%d (parity=%d)\n",
36777cc577a4SJonathan Peyton             __kmp_gtid_from_thread(this_thr), this_thr->th.th_task_team,
36787cc577a4SJonathan Peyton             ((team != NULL) ? team->t.t_id : -1), this_thr->th.th_task_state));
36797cc577a4SJonathan Peyton }
36807cc577a4SJonathan Peyton 
36813041982dSJonathan Peyton // __kmp_task_team_wait: Master thread waits for outstanding tasks after the
36823041982dSJonathan Peyton // barrier gather phase. Only called by master thread if #threads in team > 1 or
36833041982dSJonathan Peyton // if proxy tasks were created.
36843041982dSJonathan Peyton //
36853041982dSJonathan Peyton // wait is a flag that defaults to 1 (see kmp.h), but waiting can be turned off
36863041982dSJonathan Peyton // by passing in 0 optionally as the last argument. When wait is zero, master
36873041982dSJonathan Peyton // thread does not wait for unfinished_threads to reach 0.
36883041982dSJonathan Peyton void __kmp_task_team_wait(
36893041982dSJonathan Peyton     kmp_info_t *this_thr,
36903041982dSJonathan Peyton     kmp_team_t *team USE_ITT_BUILD_ARG(void *itt_sync_obj), int wait) {
36917cc577a4SJonathan Peyton   kmp_task_team_t *task_team = team->t.t_task_team[this_thr->th.th_task_state];
36927cc577a4SJonathan Peyton 
36937cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36947cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team == this_thr->th.th_task_team);
36957cc577a4SJonathan Peyton 
36967cc577a4SJonathan Peyton   if ((task_team != NULL) && KMP_TASKING_ENABLED(task_team)) {
36977cc577a4SJonathan Peyton     if (wait) {
36983041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_task_team_wait: Master T#%d waiting for all tasks "
36993041982dSJonathan Peyton                     "(for unfinished_threads to reach 0) on task_team = %p\n",
37007cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(this_thr), task_team));
37013041982dSJonathan Peyton       // Worker threads may have dropped through to release phase, but could
37023041982dSJonathan Peyton       // still be executing tasks. Wait here for tasks to complete. To avoid
37033041982dSJonathan Peyton       // memory contention, only master thread checks termination condition.
3704e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
3705e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
370637e2ef54SJonathan Peyton                 &task_team->tt.tt_unfinished_threads),
3707c47afcd9SAndrey Churbanov           0U);
37083041982dSJonathan Peyton       flag.wait(this_thr, TRUE USE_ITT_BUILD_ARG(itt_sync_obj));
37097cc577a4SJonathan Peyton     }
37103041982dSJonathan Peyton     // Deactivate the old task team, so that the worker threads will stop
37113041982dSJonathan Peyton     // referencing it while spinning.
37123041982dSJonathan Peyton     KA_TRACE(
37133041982dSJonathan Peyton         20,
37143041982dSJonathan Peyton         ("__kmp_task_team_wait: Master T#%d deactivating task_team %p: "
37157cc577a4SJonathan Peyton          "setting active to false, setting local and team's pointer to NULL\n",
37167cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr), task_team));
37173041982dSJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1 ||
37183041982dSJonathan Peyton                      task_team->tt.tt_found_proxy_tasks == TRUE);
37197cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_proxy_tasks, FALSE);
3720a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(task_team->tt.tt_untied_task_encountered, 0);
37217cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_active, FALSE);
37227cc577a4SJonathan Peyton     KMP_MB();
37237cc577a4SJonathan Peyton 
37247cc577a4SJonathan Peyton     TCW_PTR(this_thr->th.th_task_team, NULL);
37257cc577a4SJonathan Peyton   }
37267cc577a4SJonathan Peyton }
37277cc577a4SJonathan Peyton 
37287cc577a4SJonathan Peyton // __kmp_tasking_barrier:
3729e0665a90STerry Wilmarth // This routine is called only when __kmp_tasking_mode == tskm_extra_barrier.
37303041982dSJonathan Peyton // Internal function to execute all tasks prior to a regular barrier or a join
37313041982dSJonathan Peyton // barrier. It is a full barrier itself, which unfortunately turns regular
37323041982dSJonathan Peyton // barriers into double barriers and join barriers into 1 1/2 barriers.
37333041982dSJonathan Peyton void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread, int gtid) {
373437e2ef54SJonathan Peyton   std::atomic<kmp_uint32> *spin = RCAST(
373537e2ef54SJonathan Peyton       std::atomic<kmp_uint32> *,
3736c47afcd9SAndrey Churbanov       &team->t.t_task_team[thread->th.th_task_state]->tt.tt_unfinished_threads);
37377cc577a4SJonathan Peyton   int flag = FALSE;
37387cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode == tskm_extra_barrier);
37397cc577a4SJonathan Peyton 
37407cc577a4SJonathan Peyton #if USE_ITT_BUILD
374137e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_INIT(spin, NULL);
37427cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
3743e0665a90STerry Wilmarth   kmp_flag_32<false, false> spin_flag(spin, 0U);
37443041982dSJonathan Peyton   while (!spin_flag.execute_tasks(thread, gtid, TRUE,
37453041982dSJonathan Peyton                                   &flag USE_ITT_BUILD_ARG(NULL), 0)) {
37467cc577a4SJonathan Peyton #if USE_ITT_BUILD
37477cc577a4SJonathan Peyton     // TODO: What about itt_sync_obj??
374837e2ef54SJonathan Peyton     KMP_FSYNC_SPIN_PREPARE(RCAST(void *, spin));
37497cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37507cc577a4SJonathan Peyton 
37517cc577a4SJonathan Peyton     if (TCR_4(__kmp_global.g.g_done)) {
37527cc577a4SJonathan Peyton       if (__kmp_global.g.g_abort)
37537cc577a4SJonathan Peyton         __kmp_abort_thread();
37547cc577a4SJonathan Peyton       break;
37557cc577a4SJonathan Peyton     }
3756e47d32f1SJonathan Peyton     KMP_YIELD(TRUE);
37577cc577a4SJonathan Peyton   }
37587cc577a4SJonathan Peyton #if USE_ITT_BUILD
375937e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_ACQUIRED(RCAST(void *, spin));
37607cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37617cc577a4SJonathan Peyton }
37627cc577a4SJonathan Peyton 
37633041982dSJonathan Peyton // __kmp_give_task puts a task into a given thread queue if:
37643041982dSJonathan Peyton //  - the queue for that thread was created
37653041982dSJonathan Peyton //  - there's space in that queue
37663041982dSJonathan Peyton // Because of this, __kmp_push_task needs to check if there's space after
37673041982dSJonathan Peyton // getting the lock
37683041982dSJonathan Peyton static bool __kmp_give_task(kmp_info_t *thread, kmp_int32 tid, kmp_task_t *task,
37693041982dSJonathan Peyton                             kmp_int32 pass) {
37707cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
37717cc577a4SJonathan Peyton   kmp_task_team_t *task_team = taskdata->td_task_team;
37727cc577a4SJonathan Peyton 
37733041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_give_task: trying to give task %p to thread %d.\n",
37743041982dSJonathan Peyton                 taskdata, tid));
37757cc577a4SJonathan Peyton 
37767cc577a4SJonathan Peyton   // If task_team is NULL something went really bad...
37777cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
37787cc577a4SJonathan Peyton 
37797cc577a4SJonathan Peyton   bool result = false;
37807cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
37817cc577a4SJonathan Peyton 
37827cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
37837cc577a4SJonathan Peyton     // There's no queue in this thread, go find another one
37847cc577a4SJonathan Peyton     // We're guaranteed that at least one thread has a queue
37853041982dSJonathan Peyton     KA_TRACE(30,
37863041982dSJonathan Peyton              ("__kmp_give_task: thread %d has no queue while giving task %p.\n",
37873041982dSJonathan Peyton               tid, taskdata));
37887cc577a4SJonathan Peyton     return result;
37897cc577a4SJonathan Peyton   }
37907cc577a4SJonathan Peyton 
37913041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
37923041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
37933041982dSJonathan Peyton     KA_TRACE(
37943041982dSJonathan Peyton         30,
37953041982dSJonathan Peyton         ("__kmp_give_task: queue is full while giving task %p to thread %d.\n",
37963041982dSJonathan Peyton          taskdata, tid));
37977cc577a4SJonathan Peyton 
37983041982dSJonathan Peyton     // if this deque is bigger than the pass ratio give a chance to another
37993041982dSJonathan Peyton     // thread
38003041982dSJonathan Peyton     if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38013041982dSJonathan Peyton       return result;
38027cc577a4SJonathan Peyton 
38037cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38043895148dSJoachim Protze     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38053895148dSJoachim Protze         TASK_DEQUE_SIZE(thread_data->td)) {
38063895148dSJoachim Protze       // expand deque to push the task which is not allowed to execute
38077cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38083895148dSJoachim Protze     }
38097cc577a4SJonathan Peyton 
38107cc577a4SJonathan Peyton   } else {
38117cc577a4SJonathan Peyton 
38127cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38137cc577a4SJonathan Peyton 
38143041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38153041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
38163041982dSJonathan Peyton       KA_TRACE(30, ("__kmp_give_task: queue is full while giving task %p to "
38173041982dSJonathan Peyton                     "thread %d.\n",
38183041982dSJonathan Peyton                     taskdata, tid));
38197cc577a4SJonathan Peyton 
38203041982dSJonathan Peyton       // if this deque is bigger than the pass ratio give a chance to another
38213041982dSJonathan Peyton       // thread
38227cc577a4SJonathan Peyton       if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38237cc577a4SJonathan Peyton         goto release_and_exit;
38247cc577a4SJonathan Peyton 
38257cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38267cc577a4SJonathan Peyton     }
38277cc577a4SJonathan Peyton   }
38287cc577a4SJonathan Peyton 
38297cc577a4SJonathan Peyton   // lock is held here, and there is space in the deque
38307cc577a4SJonathan Peyton 
38317cc577a4SJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] = taskdata;
38327cc577a4SJonathan Peyton   // Wrap index.
38333041982dSJonathan Peyton   thread_data->td.td_deque_tail =
38343041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
38353041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
38363041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1);
38377cc577a4SJonathan Peyton 
38387cc577a4SJonathan Peyton   result = true;
38393041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_give_task: successfully gave task %p to thread %d.\n",
38403041982dSJonathan Peyton                 taskdata, tid));
38417cc577a4SJonathan Peyton 
38427cc577a4SJonathan Peyton release_and_exit:
38437cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
38447cc577a4SJonathan Peyton 
38457cc577a4SJonathan Peyton   return result;
38467cc577a4SJonathan Peyton }
38477cc577a4SJonathan Peyton 
38483041982dSJonathan Peyton /* The finish of the proxy tasks is divided in two pieces:
38497cc577a4SJonathan Peyton     - the top half is the one that can be done from a thread outside the team
3850c3344345SAndrey Churbanov     - the bottom half must be run from a thread within the team
38517cc577a4SJonathan Peyton 
38523041982dSJonathan Peyton    In order to run the bottom half the task gets queued back into one of the
38533041982dSJonathan Peyton    threads of the team. Once the td_incomplete_child_task counter of the parent
38543041982dSJonathan Peyton    is decremented the threads can leave the barriers. So, the bottom half needs
38553041982dSJonathan Peyton    to be queued before the counter is decremented. The top half is therefore
38563041982dSJonathan Peyton    divided in two parts:
38577cc577a4SJonathan Peyton     - things that can be run before queuing the bottom half
38587cc577a4SJonathan Peyton     - things that must be run after queuing the bottom half
38597cc577a4SJonathan Peyton 
38603041982dSJonathan Peyton    This creates a second race as the bottom half can free the task before the
38613041982dSJonathan Peyton    second top half is executed. To avoid this we use the
38623041982dSJonathan Peyton    td_incomplete_child_task of the proxy task to synchronize the top and bottom
38633041982dSJonathan Peyton    half. */
38643041982dSJonathan Peyton static void __kmp_first_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38657cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
38667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38677cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
38687cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
38697cc577a4SJonathan Peyton 
38707cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
38717cc577a4SJonathan Peyton 
38727cc577a4SJonathan Peyton   if (taskdata->td_taskgroup)
387337e2ef54SJonathan Peyton     KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
38747cc577a4SJonathan Peyton 
38753041982dSJonathan Peyton   // Create an imaginary children for this task so the bottom half cannot
38763041982dSJonathan Peyton   // release the task before we have completed the second top half
387737e2ef54SJonathan Peyton   KMP_ATOMIC_INC(&taskdata->td_incomplete_child_tasks);
38787cc577a4SJonathan Peyton }
38797cc577a4SJonathan Peyton 
38803041982dSJonathan Peyton static void __kmp_second_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38817cc577a4SJonathan Peyton   kmp_int32 children = 0;
38827cc577a4SJonathan Peyton 
38837cc577a4SJonathan Peyton   // Predecrement simulated by "- 1" calculation
38843041982dSJonathan Peyton   children =
388537e2ef54SJonathan Peyton       KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
38867cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
38877cc577a4SJonathan Peyton 
38887cc577a4SJonathan Peyton   // Remove the imaginary children
388937e2ef54SJonathan Peyton   KMP_ATOMIC_DEC(&taskdata->td_incomplete_child_tasks);
38907cc577a4SJonathan Peyton }
38917cc577a4SJonathan Peyton 
38923041982dSJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask) {
38937cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
38947cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
38957cc577a4SJonathan Peyton 
38967cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38973041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete ==
38983041982dSJonathan Peyton                    1); // top half must run before bottom half
38997cc577a4SJonathan Peyton 
39007cc577a4SJonathan Peyton   // We need to wait to make sure the top half is finished
39017cc577a4SJonathan Peyton   // Spinning here should be ok as this should happen quickly
390237e2ef54SJonathan Peyton   while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) > 0)
39033041982dSJonathan Peyton     ;
39047cc577a4SJonathan Peyton 
39057cc577a4SJonathan Peyton   __kmp_release_deps(gtid, taskdata);
39067cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
39077cc577a4SJonathan Peyton }
39087cc577a4SJonathan Peyton 
39097cc577a4SJonathan Peyton /*!
39107cc577a4SJonathan Peyton @ingroup TASKING
39117cc577a4SJonathan Peyton @param gtid Global Thread ID of encountering thread
39127cc577a4SJonathan Peyton @param ptask Task which execution is completed
39137cc577a4SJonathan Peyton 
3914ed5fe645SKelvin Li Execute the completion of a proxy task from a thread of that is part of the
39153041982dSJonathan Peyton team. Run first and bottom halves directly.
39167cc577a4SJonathan Peyton */
39173041982dSJonathan Peyton void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask) {
39187cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39197cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39203041982dSJonathan Peyton   KA_TRACE(
39213041982dSJonathan Peyton       10, ("__kmp_proxy_task_completed(enter): T#%d proxy task %p completing\n",
39223041982dSJonathan Peyton            gtid, taskdata));
3923787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
39247cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39257cc577a4SJonathan Peyton 
39267cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39277cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39287cc577a4SJonathan Peyton   __kmp_bottom_half_finish_proxy(gtid, ptask);
39297cc577a4SJonathan Peyton 
39303041982dSJonathan Peyton   KA_TRACE(10,
39313041982dSJonathan Peyton            ("__kmp_proxy_task_completed(exit): T#%d proxy task %p completing\n",
39323041982dSJonathan Peyton             gtid, taskdata));
39337cc577a4SJonathan Peyton }
39347cc577a4SJonathan Peyton 
39357cc577a4SJonathan Peyton /*!
39367cc577a4SJonathan Peyton @ingroup TASKING
39377cc577a4SJonathan Peyton @param ptask Task which execution is completed
39387cc577a4SJonathan Peyton 
3939ed5fe645SKelvin Li Execute the completion of a proxy task from a thread that could not belong to
39403041982dSJonathan Peyton the team.
39417cc577a4SJonathan Peyton */
39423041982dSJonathan Peyton void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask) {
39437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39447cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39457cc577a4SJonathan Peyton 
39463041982dSJonathan Peyton   KA_TRACE(
39473041982dSJonathan Peyton       10,
39483041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(enter): proxy task completing ooo %p\n",
39493041982dSJonathan Peyton        taskdata));
39507cc577a4SJonathan Peyton 
39517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39527cc577a4SJonathan Peyton 
39537cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39547cc577a4SJonathan Peyton 
39553041982dSJonathan Peyton   // Enqueue task to complete bottom half completion from a thread within the
39563041982dSJonathan Peyton   // corresponding team
39577cc577a4SJonathan Peyton   kmp_team_t *team = taskdata->td_team;
39587cc577a4SJonathan Peyton   kmp_int32 nthreads = team->t.t_nproc;
39597cc577a4SJonathan Peyton   kmp_info_t *thread;
39607cc577a4SJonathan Peyton 
39613041982dSJonathan Peyton   // This should be similar to start_k = __kmp_get_random( thread ) % nthreads
39623041982dSJonathan Peyton   // but we cannot use __kmp_get_random here
39637cc577a4SJonathan Peyton   kmp_int32 start_k = 0;
39647cc577a4SJonathan Peyton   kmp_int32 pass = 1;
39657cc577a4SJonathan Peyton   kmp_int32 k = start_k;
39667cc577a4SJonathan Peyton 
39677cc577a4SJonathan Peyton   do {
39687cc577a4SJonathan Peyton     // For now we're just linearly trying to find a thread
39697cc577a4SJonathan Peyton     thread = team->t.t_threads[k];
39707cc577a4SJonathan Peyton     k = (k + 1) % nthreads;
39717cc577a4SJonathan Peyton 
39727cc577a4SJonathan Peyton     // we did a full pass through all the threads
39733041982dSJonathan Peyton     if (k == start_k)
39743041982dSJonathan Peyton       pass = pass << 1;
39757cc577a4SJonathan Peyton 
39767cc577a4SJonathan Peyton   } while (!__kmp_give_task(thread, k, ptask, pass));
39777cc577a4SJonathan Peyton 
39787cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39797cc577a4SJonathan Peyton 
39803041982dSJonathan Peyton   KA_TRACE(
39813041982dSJonathan Peyton       10,
39823041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(exit): proxy task completing ooo %p\n",
39833041982dSJonathan Peyton        taskdata));
39847cc577a4SJonathan Peyton }
39857cc577a4SJonathan Peyton 
3986405037c4SAndrey Churbanov kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref, int gtid,
3987405037c4SAndrey Churbanov                                                 kmp_task_t *task) {
3988405037c4SAndrey Churbanov   kmp_taskdata_t *td = KMP_TASK_TO_TASKDATA(task);
3989405037c4SAndrey Churbanov   if (td->td_allow_completion_event.type == KMP_EVENT_UNINITIALIZED) {
3990405037c4SAndrey Churbanov     td->td_allow_completion_event.type = KMP_EVENT_ALLOW_COMPLETION;
3991405037c4SAndrey Churbanov     td->td_allow_completion_event.ed.task = task;
3992405037c4SAndrey Churbanov     __kmp_init_tas_lock(&td->td_allow_completion_event.lock);
3993405037c4SAndrey Churbanov   }
3994405037c4SAndrey Churbanov   return &td->td_allow_completion_event;
3995405037c4SAndrey Churbanov }
3996405037c4SAndrey Churbanov 
3997405037c4SAndrey Churbanov void __kmp_fulfill_event(kmp_event_t *event) {
3998405037c4SAndrey Churbanov   if (event->type == KMP_EVENT_ALLOW_COMPLETION) {
3999405037c4SAndrey Churbanov     kmp_task_t *ptask = event->ed.task;
4000405037c4SAndrey Churbanov     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
4001405037c4SAndrey Churbanov     bool detached = false;
4002405037c4SAndrey Churbanov     int gtid = __kmp_get_gtid();
4003405037c4SAndrey Churbanov 
4004d23131a3SJoachim Protze     // The associated task might have completed or could be completing at this
4005405037c4SAndrey Churbanov     // point.
4006405037c4SAndrey Churbanov     // We need to take the lock to avoid races
4007405037c4SAndrey Churbanov     __kmp_acquire_tas_lock(&event->lock, gtid);
400810995c77SJoachim Protze     if (taskdata->td_flags.proxy == TASK_PROXY) {
4009405037c4SAndrey Churbanov       detached = true;
401010995c77SJoachim Protze     } else {
401110995c77SJoachim Protze #if OMPT_SUPPORT
401210995c77SJoachim Protze       // The OMPT event must occur under mutual exclusion,
401310995c77SJoachim Protze       // otherwise the tool might access ptask after free
401410995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
401510995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_early_fulfill);
401610995c77SJoachim Protze #endif
401710995c77SJoachim Protze     }
4018405037c4SAndrey Churbanov     event->type = KMP_EVENT_UNINITIALIZED;
4019405037c4SAndrey Churbanov     __kmp_release_tas_lock(&event->lock, gtid);
4020405037c4SAndrey Churbanov 
4021405037c4SAndrey Churbanov     if (detached) {
402210995c77SJoachim Protze #if OMPT_SUPPORT
402310995c77SJoachim Protze       // We free ptask afterwards and know the task is finished,
402410995c77SJoachim Protze       // so locking is not necessary
402510995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
402610995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_late_fulfill);
402710995c77SJoachim Protze #endif
4028405037c4SAndrey Churbanov       // If the task detached complete the proxy task
4029405037c4SAndrey Churbanov       if (gtid >= 0) {
4030405037c4SAndrey Churbanov         kmp_team_t *team = taskdata->td_team;
4031405037c4SAndrey Churbanov         kmp_info_t *thread = __kmp_get_thread();
4032405037c4SAndrey Churbanov         if (thread->th.th_team == team) {
4033405037c4SAndrey Churbanov           __kmpc_proxy_task_completed(gtid, ptask);
4034405037c4SAndrey Churbanov           return;
4035405037c4SAndrey Churbanov         }
4036405037c4SAndrey Churbanov       }
4037405037c4SAndrey Churbanov 
4038405037c4SAndrey Churbanov       // fallback
4039405037c4SAndrey Churbanov       __kmpc_proxy_task_completed_ooo(ptask);
4040405037c4SAndrey Churbanov     }
4041405037c4SAndrey Churbanov   }
4042405037c4SAndrey Churbanov }
4043405037c4SAndrey Churbanov 
40443041982dSJonathan Peyton // __kmp_task_dup_alloc: Allocate the taskdata and make a copy of source task
40453041982dSJonathan Peyton // for taskloop
40467cc577a4SJonathan Peyton //
40477cc577a4SJonathan Peyton // thread:   allocating thread
40487cc577a4SJonathan Peyton // task_src: pointer to source task to be duplicated
40497cc577a4SJonathan Peyton // returns:  a pointer to the allocated kmp_task_t structure (task).
40503041982dSJonathan Peyton kmp_task_t *__kmp_task_dup_alloc(kmp_info_t *thread, kmp_task_t *task_src) {
40517cc577a4SJonathan Peyton   kmp_task_t *task;
40527cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
40535e111c5dSAndreyChurbanov   kmp_taskdata_t *taskdata_src = KMP_TASK_TO_TASKDATA(task_src);
40545e111c5dSAndreyChurbanov   kmp_taskdata_t *parent_task = taskdata_src->td_parent; // same parent task
40557cc577a4SJonathan Peyton   size_t shareds_offset;
40567cc577a4SJonathan Peyton   size_t task_size;
40577cc577a4SJonathan Peyton 
40583041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_dup_alloc(enter): Th %p, source task %p\n", thread,
40593041982dSJonathan Peyton                 task_src));
40603041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.proxy ==
40613041982dSJonathan Peyton                    TASK_FULL); // it should not be proxy task
40627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.tasktype == TASK_EXPLICIT);
40637cc577a4SJonathan Peyton   task_size = taskdata_src->td_size_alloc;
40647cc577a4SJonathan Peyton 
40657cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
40663041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_dup_alloc: Th %p, malloc size %ld\n", thread,
40673041982dSJonathan Peyton                 task_size));
40687cc577a4SJonathan Peyton #if USE_FAST_MEMORY
40697cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, task_size);
40707cc577a4SJonathan Peyton #else
40717cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, task_size);
40727cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
40737cc577a4SJonathan Peyton   KMP_MEMCPY(taskdata, taskdata_src, task_size);
40747cc577a4SJonathan Peyton 
40757cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
40767cc577a4SJonathan Peyton 
40777cc577a4SJonathan Peyton   // Initialize new task (only specific fields not affected by memcpy)
40787cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
40797cc577a4SJonathan Peyton   if (task->shareds != NULL) { // need setup shareds pointer
40807cc577a4SJonathan Peyton     shareds_offset = (char *)task_src->shareds - (char *)taskdata_src;
40817cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
40823041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
40833041982dSJonathan Peyton                      0);
40847cc577a4SJonathan Peyton   }
40857cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
408693e17cfeSJonathan Peyton   taskdata->td_parent = parent_task;
4087ae044467SAndreyChurbanov   // task inherits the taskgroup from the parent task
4088ae044467SAndreyChurbanov   taskdata->td_taskgroup = parent_task->td_taskgroup;
4089ae044467SAndreyChurbanov   // tied task needs to initialize the td_last_tied at creation,
4090ae044467SAndreyChurbanov   // untied one does this when it is scheduled for execution
4091ae044467SAndreyChurbanov   if (taskdata->td_flags.tiedness == TASK_TIED)
4092ae044467SAndreyChurbanov     taskdata->td_last_tied = taskdata;
40937cc577a4SJonathan Peyton 
40943041982dSJonathan Peyton   // Only need to keep track of child task counts if team parallel and tasking
40953041982dSJonathan Peyton   // not serialized
40967cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
409737e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
40987cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
409937e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
41003041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
41013041982dSJonathan Peyton     // implicit not deallocated
41027cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT)
410337e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
41047cc577a4SJonathan Peyton   }
41057cc577a4SJonathan Peyton 
41063041982dSJonathan Peyton   KA_TRACE(20,
41073041982dSJonathan Peyton            ("__kmp_task_dup_alloc(exit): Th %p, created task %p, parent=%p\n",
41087cc577a4SJonathan Peyton             thread, taskdata, taskdata->td_parent));
41097cc577a4SJonathan Peyton #if OMPT_SUPPORT
4110f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
411182e94a59SJoachim Protze     __ompt_task_init(taskdata, thread->th.th_info.ds.ds_gtid);
41127cc577a4SJonathan Peyton #endif
41137cc577a4SJonathan Peyton   return task;
41147cc577a4SJonathan Peyton }
41157cc577a4SJonathan Peyton 
41167cc577a4SJonathan Peyton // Routine optionally generated by the compiler for setting the lastprivate flag
41177cc577a4SJonathan Peyton // and calling needed constructors for private/firstprivate objects
41187cc577a4SJonathan Peyton // (used to form taskloop tasks from pattern task)
411993e17cfeSJonathan Peyton // Parameters: dest task, src task, lastprivate flag.
41207cc577a4SJonathan Peyton typedef void (*p_task_dup_t)(kmp_task_t *, kmp_task_t *, kmp_int32);
41217cc577a4SJonathan Peyton 
412227a677fcSJonathan Peyton KMP_BUILD_ASSERT(sizeof(long) == 4 || sizeof(long) == 8);
412327a677fcSJonathan Peyton 
412427a677fcSJonathan Peyton // class to encapsulate manipulating loop bounds in a taskloop task.
412527a677fcSJonathan Peyton // this abstracts away the Intel vs GOMP taskloop interface for setting/getting
412627a677fcSJonathan Peyton // the loop bound variables.
412727a677fcSJonathan Peyton class kmp_taskloop_bounds_t {
412827a677fcSJonathan Peyton   kmp_task_t *task;
412927a677fcSJonathan Peyton   const kmp_taskdata_t *taskdata;
413027a677fcSJonathan Peyton   size_t lower_offset;
413127a677fcSJonathan Peyton   size_t upper_offset;
413227a677fcSJonathan Peyton 
413327a677fcSJonathan Peyton public:
413427a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, kmp_uint64 *lb, kmp_uint64 *ub)
413527a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(task)),
413627a677fcSJonathan Peyton         lower_offset((char *)lb - (char *)task),
413727a677fcSJonathan Peyton         upper_offset((char *)ub - (char *)task) {
413827a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)lb > (char *)_task);
413927a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)ub > (char *)_task);
414027a677fcSJonathan Peyton   }
414127a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, const kmp_taskloop_bounds_t &bounds)
414227a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(_task)),
414327a677fcSJonathan Peyton         lower_offset(bounds.lower_offset), upper_offset(bounds.upper_offset) {}
414427a677fcSJonathan Peyton   size_t get_lower_offset() const { return lower_offset; }
414527a677fcSJonathan Peyton   size_t get_upper_offset() const { return upper_offset; }
414627a677fcSJonathan Peyton   kmp_uint64 get_lb() const {
414727a677fcSJonathan Peyton     kmp_int64 retval;
414827a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
414927a677fcSJonathan Peyton     // Intel task just returns the lower bound normally
415027a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
415127a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + lower_offset);
415227a677fcSJonathan Peyton     } else {
415327a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
415427a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
415527a677fcSJonathan Peyton         kmp_int32 *lb = RCAST(kmp_int32 *, task->shareds);
415627a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
415727a677fcSJonathan Peyton       } else {
415827a677fcSJonathan Peyton         kmp_int64 *lb = RCAST(kmp_int64 *, task->shareds);
415927a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
416027a677fcSJonathan Peyton       }
416127a677fcSJonathan Peyton     }
416227a677fcSJonathan Peyton #else
4163b3d84790SMartin Storsjö     (void)taskdata;
416427a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + lower_offset);
416527a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
416627a677fcSJonathan Peyton     return retval;
416727a677fcSJonathan Peyton   }
416827a677fcSJonathan Peyton   kmp_uint64 get_ub() const {
416927a677fcSJonathan Peyton     kmp_int64 retval;
417027a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
417127a677fcSJonathan Peyton     // Intel task just returns the upper bound normally
417227a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
417327a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + upper_offset);
417427a677fcSJonathan Peyton     } else {
417527a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
417627a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
417727a677fcSJonathan Peyton         kmp_int32 *ub = RCAST(kmp_int32 *, task->shareds) + 1;
417827a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
417927a677fcSJonathan Peyton       } else {
418027a677fcSJonathan Peyton         kmp_int64 *ub = RCAST(kmp_int64 *, task->shareds) + 1;
418127a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
418227a677fcSJonathan Peyton       }
418327a677fcSJonathan Peyton     }
418427a677fcSJonathan Peyton #else
418527a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + upper_offset);
418627a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
418727a677fcSJonathan Peyton     return retval;
418827a677fcSJonathan Peyton   }
418927a677fcSJonathan Peyton   void set_lb(kmp_uint64 lb) {
419027a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
419127a677fcSJonathan Peyton     // Intel task just sets the lower bound normally
419227a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
419327a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + lower_offset) = lb;
419427a677fcSJonathan Peyton     } else {
419527a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
419627a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
419727a677fcSJonathan Peyton         kmp_uint32 *lower = RCAST(kmp_uint32 *, task->shareds);
419827a677fcSJonathan Peyton         *lower = (kmp_uint32)lb;
419927a677fcSJonathan Peyton       } else {
420027a677fcSJonathan Peyton         kmp_uint64 *lower = RCAST(kmp_uint64 *, task->shareds);
420127a677fcSJonathan Peyton         *lower = (kmp_uint64)lb;
420227a677fcSJonathan Peyton       }
420327a677fcSJonathan Peyton     }
420427a677fcSJonathan Peyton #else
420527a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + lower_offset) = lb;
420627a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
420727a677fcSJonathan Peyton   }
420827a677fcSJonathan Peyton   void set_ub(kmp_uint64 ub) {
420927a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
421027a677fcSJonathan Peyton     // Intel task just sets the upper bound normally
421127a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
421227a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + upper_offset) = ub;
421327a677fcSJonathan Peyton     } else {
421427a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
421527a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
421627a677fcSJonathan Peyton         kmp_uint32 *upper = RCAST(kmp_uint32 *, task->shareds) + 1;
421727a677fcSJonathan Peyton         *upper = (kmp_uint32)ub;
421827a677fcSJonathan Peyton       } else {
421927a677fcSJonathan Peyton         kmp_uint64 *upper = RCAST(kmp_uint64 *, task->shareds) + 1;
422027a677fcSJonathan Peyton         *upper = (kmp_uint64)ub;
422127a677fcSJonathan Peyton       }
422227a677fcSJonathan Peyton     }
422327a677fcSJonathan Peyton #else
422427a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + upper_offset) = ub;
422527a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
422627a677fcSJonathan Peyton   }
422727a677fcSJonathan Peyton };
422827a677fcSJonathan Peyton 
42297cc577a4SJonathan Peyton // __kmp_taskloop_linear: Start tasks of the taskloop linearly
42307cc577a4SJonathan Peyton //
42317cc577a4SJonathan Peyton // loc        Source location information
42327cc577a4SJonathan Peyton // gtid       Global thread ID
423393e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
423493e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
423593e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
42367cc577a4SJonathan Peyton // st         Loop stride
423793e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
423893e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
423993e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
424093e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4241540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
424293e17cfeSJonathan Peyton // tc         Iterations count
42437cc577a4SJonathan Peyton // task_dup   Tasks duplication routine
4244cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
42453041982dSJonathan Peyton void __kmp_taskloop_linear(ident_t *loc, int gtid, kmp_task_t *task,
42467cc577a4SJonathan Peyton                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
424793e17cfeSJonathan Peyton                            kmp_uint64 ub_glob, kmp_uint64 num_tasks,
424893e17cfeSJonathan Peyton                            kmp_uint64 grainsize, kmp_uint64 extras,
4249540007b4SNawrin Sultana                            kmp_int64 last_chunk, kmp_uint64 tc,
4250cdaefac5SJoachim Protze #if OMPT_SUPPORT
4251cdaefac5SJoachim Protze                            void *codeptr_ra,
4252cdaefac5SJoachim Protze #endif
4253cdaefac5SJoachim Protze                            void *task_dup) {
42547cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKLOOP);
42557cc577a4SJonathan Peyton   KMP_TIME_PARTITIONED_BLOCK(OMP_taskloop_scheduling);
42567cc577a4SJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
425727a677fcSJonathan Peyton   // compiler provides global bounds here
425827a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
425927a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
426027a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
426193e17cfeSJonathan Peyton   kmp_uint64 i;
42627cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
42637cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
42647cc577a4SJonathan Peyton   kmp_task_t *next_task;
42657cc577a4SJonathan Peyton   kmp_int32 lastpriv = 0;
42667cc577a4SJonathan Peyton 
4267*309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4268*309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
426993e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
427093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
427193e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_linear: T#%d: %lld tasks, grainsize %lld, "
4272540007b4SNawrin Sultana                 "extras %lld, last_chunk %lld, i=%lld,%lld(%d)%lld, dup %p\n",
4273540007b4SNawrin Sultana                 gtid, num_tasks, grainsize, extras, last_chunk, lower, upper,
4274540007b4SNawrin Sultana                 ub_glob, st, task_dup));
427593e17cfeSJonathan Peyton 
427693e17cfeSJonathan Peyton   // Launch num_tasks tasks, assign grainsize iterations each task
427793e17cfeSJonathan Peyton   for (i = 0; i < num_tasks; ++i) {
427893e17cfeSJonathan Peyton     kmp_uint64 chunk_minus_1;
427993e17cfeSJonathan Peyton     if (extras == 0) {
428093e17cfeSJonathan Peyton       chunk_minus_1 = grainsize - 1;
428193e17cfeSJonathan Peyton     } else {
428293e17cfeSJonathan Peyton       chunk_minus_1 = grainsize;
428393e17cfeSJonathan Peyton       --extras; // first extras iterations get bigger chunk (grainsize+1)
428493e17cfeSJonathan Peyton     }
428593e17cfeSJonathan Peyton     upper = lower + st * chunk_minus_1;
4286540007b4SNawrin Sultana     if (upper > *ub) {
4287540007b4SNawrin Sultana       upper = *ub;
4288540007b4SNawrin Sultana     }
428993e17cfeSJonathan Peyton     if (i == num_tasks - 1) {
429093e17cfeSJonathan Peyton       // schedule the last task, set lastprivate flag if needed
429193e17cfeSJonathan Peyton       if (st == 1) { // most common case
429293e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper == *ub);
429393e17cfeSJonathan Peyton         if (upper == ub_glob)
429493e17cfeSJonathan Peyton           lastpriv = 1;
429593e17cfeSJonathan Peyton       } else if (st > 0) { // positive loop stride
429693e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT((kmp_uint64)st > *ub - upper);
429793e17cfeSJonathan Peyton         if ((kmp_uint64)st > ub_glob - upper)
429893e17cfeSJonathan Peyton           lastpriv = 1;
429993e17cfeSJonathan Peyton       } else { // negative loop stride
430093e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper + st < *ub);
430193e17cfeSJonathan Peyton         if (upper - ub_glob < (kmp_uint64)(-st))
430293e17cfeSJonathan Peyton           lastpriv = 1;
430393e17cfeSJonathan Peyton       }
430493e17cfeSJonathan Peyton     }
430593e17cfeSJonathan Peyton     next_task = __kmp_task_dup_alloc(thread, task); // allocate new task
430627a677fcSJonathan Peyton     kmp_taskdata_t *next_taskdata = KMP_TASK_TO_TASKDATA(next_task);
430727a677fcSJonathan Peyton     kmp_taskloop_bounds_t next_task_bounds =
430827a677fcSJonathan Peyton         kmp_taskloop_bounds_t(next_task, task_bounds);
430927a677fcSJonathan Peyton 
431093e17cfeSJonathan Peyton     // adjust task-specific bounds
431127a677fcSJonathan Peyton     next_task_bounds.set_lb(lower);
431227a677fcSJonathan Peyton     if (next_taskdata->td_flags.native) {
431327a677fcSJonathan Peyton       next_task_bounds.set_ub(upper + (st > 0 ? 1 : -1));
431427a677fcSJonathan Peyton     } else {
431527a677fcSJonathan Peyton       next_task_bounds.set_ub(upper);
431627a677fcSJonathan Peyton     }
43174c6a098aSKazuaki Ishizaki     if (ptask_dup != NULL) // set lastprivate flag, construct firstprivates,
43184c6a098aSKazuaki Ishizaki                            // etc.
431993e17cfeSJonathan Peyton       ptask_dup(next_task, task, lastpriv);
432027a677fcSJonathan Peyton     KA_TRACE(40,
432127a677fcSJonathan Peyton              ("__kmp_taskloop_linear: T#%d; task #%llu: task %p: lower %lld, "
432227a677fcSJonathan Peyton               "upper %lld stride %lld, (offsets %p %p)\n",
432327a677fcSJonathan Peyton               gtid, i, next_task, lower, upper, st,
432427a677fcSJonathan Peyton               next_task_bounds.get_lower_offset(),
432527a677fcSJonathan Peyton               next_task_bounds.get_upper_offset()));
4326cdaefac5SJoachim Protze #if OMPT_SUPPORT
4327cdaefac5SJoachim Protze     __kmp_omp_taskloop_task(NULL, gtid, next_task,
4328cdaefac5SJoachim Protze                             codeptr_ra); // schedule new task
4329cdaefac5SJoachim Protze #else
433093e17cfeSJonathan Peyton     __kmp_omp_task(gtid, next_task, true); // schedule new task
4331cdaefac5SJoachim Protze #endif
433293e17cfeSJonathan Peyton     lower = upper + st; // adjust lower bound for the next iteration
433393e17cfeSJonathan Peyton   }
433493e17cfeSJonathan Peyton   // free the pattern task and exit
433593e17cfeSJonathan Peyton   __kmp_task_start(gtid, task, current_task); // make internal bookkeeping
433693e17cfeSJonathan Peyton   // do not execute the pattern task, just do internal bookkeeping
433786ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task, current_task);
433893e17cfeSJonathan Peyton }
433993e17cfeSJonathan Peyton 
434093e17cfeSJonathan Peyton // Structure to keep taskloop parameters for auxiliary task
434193e17cfeSJonathan Peyton // kept in the shareds of the task structure.
434293e17cfeSJonathan Peyton typedef struct __taskloop_params {
434393e17cfeSJonathan Peyton   kmp_task_t *task;
434493e17cfeSJonathan Peyton   kmp_uint64 *lb;
434593e17cfeSJonathan Peyton   kmp_uint64 *ub;
434693e17cfeSJonathan Peyton   void *task_dup;
434793e17cfeSJonathan Peyton   kmp_int64 st;
434893e17cfeSJonathan Peyton   kmp_uint64 ub_glob;
434993e17cfeSJonathan Peyton   kmp_uint64 num_tasks;
435093e17cfeSJonathan Peyton   kmp_uint64 grainsize;
435193e17cfeSJonathan Peyton   kmp_uint64 extras;
4352540007b4SNawrin Sultana   kmp_int64 last_chunk;
435393e17cfeSJonathan Peyton   kmp_uint64 tc;
435493e17cfeSJonathan Peyton   kmp_uint64 num_t_min;
4355cdaefac5SJoachim Protze #if OMPT_SUPPORT
4356cdaefac5SJoachim Protze   void *codeptr_ra;
4357cdaefac5SJoachim Protze #endif
435893e17cfeSJonathan Peyton } __taskloop_params_t;
435993e17cfeSJonathan Peyton 
436093e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *, int, kmp_task_t *, kmp_uint64 *,
436193e17cfeSJonathan Peyton                           kmp_uint64 *, kmp_int64, kmp_uint64, kmp_uint64,
4362540007b4SNawrin Sultana                           kmp_uint64, kmp_uint64, kmp_int64, kmp_uint64,
4363540007b4SNawrin Sultana                           kmp_uint64,
4364cdaefac5SJoachim Protze #if OMPT_SUPPORT
4365cdaefac5SJoachim Protze                           void *,
4366cdaefac5SJoachim Protze #endif
436793e17cfeSJonathan Peyton                           void *);
436893e17cfeSJonathan Peyton 
4369ed5fe645SKelvin Li // Execute part of the taskloop submitted as a task.
437093e17cfeSJonathan Peyton int __kmp_taskloop_task(int gtid, void *ptask) {
4371d74d8902SJonathan Peyton   __taskloop_params_t *p =
4372d74d8902SJonathan Peyton       (__taskloop_params_t *)((kmp_task_t *)ptask)->shareds;
437393e17cfeSJonathan Peyton   kmp_task_t *task = p->task;
437493e17cfeSJonathan Peyton   kmp_uint64 *lb = p->lb;
437593e17cfeSJonathan Peyton   kmp_uint64 *ub = p->ub;
437693e17cfeSJonathan Peyton   void *task_dup = p->task_dup;
437793e17cfeSJonathan Peyton   //  p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
437893e17cfeSJonathan Peyton   kmp_int64 st = p->st;
437993e17cfeSJonathan Peyton   kmp_uint64 ub_glob = p->ub_glob;
438093e17cfeSJonathan Peyton   kmp_uint64 num_tasks = p->num_tasks;
438193e17cfeSJonathan Peyton   kmp_uint64 grainsize = p->grainsize;
438293e17cfeSJonathan Peyton   kmp_uint64 extras = p->extras;
4383540007b4SNawrin Sultana   kmp_int64 last_chunk = p->last_chunk;
438493e17cfeSJonathan Peyton   kmp_uint64 tc = p->tc;
438593e17cfeSJonathan Peyton   kmp_uint64 num_t_min = p->num_t_min;
4386cdaefac5SJoachim Protze #if OMPT_SUPPORT
4387cdaefac5SJoachim Protze   void *codeptr_ra = p->codeptr_ra;
4388cdaefac5SJoachim Protze #endif
438993e17cfeSJonathan Peyton #if KMP_DEBUG
439093e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
439193e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
4392540007b4SNawrin Sultana   KA_TRACE(20,
4393540007b4SNawrin Sultana            ("__kmp_taskloop_task: T#%d, task %p: %lld tasks, grainsize"
4394540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4395540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4396540007b4SNawrin Sultana             st, task_dup));
439793e17cfeSJonathan Peyton #endif
439893e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks * 2 + 1 > num_t_min);
439993e17cfeSJonathan Peyton   if (num_tasks > num_t_min)
440093e17cfeSJonathan Peyton     __kmp_taskloop_recur(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4401540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_t_min,
4402cdaefac5SJoachim Protze #if OMPT_SUPPORT
4403cdaefac5SJoachim Protze                          codeptr_ra,
4404cdaefac5SJoachim Protze #endif
4405cdaefac5SJoachim Protze                          task_dup);
440693e17cfeSJonathan Peyton   else
440793e17cfeSJonathan Peyton     __kmp_taskloop_linear(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4408540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4409cdaefac5SJoachim Protze #if OMPT_SUPPORT
4410cdaefac5SJoachim Protze                           codeptr_ra,
4411cdaefac5SJoachim Protze #endif
4412cdaefac5SJoachim Protze                           task_dup);
441393e17cfeSJonathan Peyton 
441493e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmp_taskloop_task(exit): T#%d\n", gtid));
441593e17cfeSJonathan Peyton   return 0;
441693e17cfeSJonathan Peyton }
441793e17cfeSJonathan Peyton 
4418ed5fe645SKelvin Li // Schedule part of the taskloop as a task,
4419ed5fe645SKelvin Li // execute the rest of the taskloop.
442093e17cfeSJonathan Peyton //
442193e17cfeSJonathan Peyton // loc        Source location information
442293e17cfeSJonathan Peyton // gtid       Global thread ID
442393e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
442493e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
442593e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
442693e17cfeSJonathan Peyton // st         Loop stride
442793e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
442893e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
442993e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
443093e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4431540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
443293e17cfeSJonathan Peyton // tc         Iterations count
443342016791SKazuaki Ishizaki // num_t_min  Threshold to launch tasks recursively
443493e17cfeSJonathan Peyton // task_dup   Tasks duplication routine
4435cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
443693e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *loc, int gtid, kmp_task_t *task,
443793e17cfeSJonathan Peyton                           kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
443893e17cfeSJonathan Peyton                           kmp_uint64 ub_glob, kmp_uint64 num_tasks,
443993e17cfeSJonathan Peyton                           kmp_uint64 grainsize, kmp_uint64 extras,
4440540007b4SNawrin Sultana                           kmp_int64 last_chunk, kmp_uint64 tc,
4441540007b4SNawrin Sultana                           kmp_uint64 num_t_min,
4442cdaefac5SJoachim Protze #if OMPT_SUPPORT
4443cdaefac5SJoachim Protze                           void *codeptr_ra,
4444cdaefac5SJoachim Protze #endif
4445cdaefac5SJoachim Protze                           void *task_dup) {
444693e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
444793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
444893e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > num_t_min);
4449540007b4SNawrin Sultana   KA_TRACE(20,
4450540007b4SNawrin Sultana            ("__kmp_taskloop_recur: T#%d, task %p: %lld tasks, grainsize"
4451540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4452540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4453540007b4SNawrin Sultana             st, task_dup));
445493e17cfeSJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
445593e17cfeSJonathan Peyton   kmp_uint64 lower = *lb;
445693e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
445793e17cfeSJonathan Peyton   //  kmp_taskdata_t *current_task = thread->th.th_current_task;
445893e17cfeSJonathan Peyton   kmp_task_t *next_task;
445993e17cfeSJonathan Peyton   size_t lower_offset =
446093e17cfeSJonathan Peyton       (char *)lb - (char *)task; // remember offset of lb in the task structure
446193e17cfeSJonathan Peyton   size_t upper_offset =
446293e17cfeSJonathan Peyton       (char *)ub - (char *)task; // remember offset of ub in the task structure
446393e17cfeSJonathan Peyton 
4464*309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4465*309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
446693e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
446793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
446893e17cfeSJonathan Peyton 
446993e17cfeSJonathan Peyton   // split the loop in two halves
447093e17cfeSJonathan Peyton   kmp_uint64 lb1, ub0, tc0, tc1, ext0, ext1;
4471540007b4SNawrin Sultana   kmp_int64 last_chunk0 = 0, last_chunk1 = 0;
447293e17cfeSJonathan Peyton   kmp_uint64 gr_size0 = grainsize;
447393e17cfeSJonathan Peyton   kmp_uint64 n_tsk0 = num_tasks >> 1; // num_tasks/2 to execute
447493e17cfeSJonathan Peyton   kmp_uint64 n_tsk1 = num_tasks - n_tsk0; // to schedule as a task
4475540007b4SNawrin Sultana   if (last_chunk < 0) {
4476540007b4SNawrin Sultana     ext0 = ext1 = 0;
4477540007b4SNawrin Sultana     last_chunk1 = last_chunk;
4478540007b4SNawrin Sultana     tc0 = grainsize * n_tsk0;
4479540007b4SNawrin Sultana     tc1 = tc - tc0;
4480540007b4SNawrin Sultana   } else if (n_tsk0 <= extras) {
448193e17cfeSJonathan Peyton     gr_size0++; // integrate extras into grainsize
448293e17cfeSJonathan Peyton     ext0 = 0; // no extra iters in 1st half
448393e17cfeSJonathan Peyton     ext1 = extras - n_tsk0; // remaining extras
448493e17cfeSJonathan Peyton     tc0 = gr_size0 * n_tsk0;
448593e17cfeSJonathan Peyton     tc1 = tc - tc0;
448693e17cfeSJonathan Peyton   } else { // n_tsk0 > extras
448793e17cfeSJonathan Peyton     ext1 = 0; // no extra iters in 2nd half
448893e17cfeSJonathan Peyton     ext0 = extras;
448993e17cfeSJonathan Peyton     tc1 = grainsize * n_tsk1;
449093e17cfeSJonathan Peyton     tc0 = tc - tc1;
449193e17cfeSJonathan Peyton   }
449293e17cfeSJonathan Peyton   ub0 = lower + st * (tc0 - 1);
449393e17cfeSJonathan Peyton   lb1 = ub0 + st;
449493e17cfeSJonathan Peyton 
449593e17cfeSJonathan Peyton   // create pattern task for 2nd half of the loop
449693e17cfeSJonathan Peyton   next_task = __kmp_task_dup_alloc(thread, task); // duplicate the task
449793e17cfeSJonathan Peyton   // adjust lower bound (upper bound is not changed) for the 2nd half
449893e17cfeSJonathan Peyton   *(kmp_uint64 *)((char *)next_task + lower_offset) = lb1;
44994c6a098aSKazuaki Ishizaki   if (ptask_dup != NULL) // construct firstprivates, etc.
450093e17cfeSJonathan Peyton     ptask_dup(next_task, task, 0);
450193e17cfeSJonathan Peyton   *ub = ub0; // adjust upper bound for the 1st half
450293e17cfeSJonathan Peyton 
450393e17cfeSJonathan Peyton   // create auxiliary task for 2nd half of the loop
45045e111c5dSAndreyChurbanov   // make sure new task has same parent task as the pattern task
45055e111c5dSAndreyChurbanov   kmp_taskdata_t *current_task = thread->th.th_current_task;
45065e111c5dSAndreyChurbanov   thread->th.th_current_task = taskdata->td_parent;
450793e17cfeSJonathan Peyton   kmp_task_t *new_task =
450893e17cfeSJonathan Peyton       __kmpc_omp_task_alloc(loc, gtid, 1, 3 * sizeof(void *),
450993e17cfeSJonathan Peyton                             sizeof(__taskloop_params_t), &__kmp_taskloop_task);
45105e111c5dSAndreyChurbanov   // restore current task
45115e111c5dSAndreyChurbanov   thread->th.th_current_task = current_task;
451293e17cfeSJonathan Peyton   __taskloop_params_t *p = (__taskloop_params_t *)new_task->shareds;
451393e17cfeSJonathan Peyton   p->task = next_task;
451493e17cfeSJonathan Peyton   p->lb = (kmp_uint64 *)((char *)next_task + lower_offset);
451593e17cfeSJonathan Peyton   p->ub = (kmp_uint64 *)((char *)next_task + upper_offset);
451693e17cfeSJonathan Peyton   p->task_dup = task_dup;
451793e17cfeSJonathan Peyton   p->st = st;
451893e17cfeSJonathan Peyton   p->ub_glob = ub_glob;
451993e17cfeSJonathan Peyton   p->num_tasks = n_tsk1;
452093e17cfeSJonathan Peyton   p->grainsize = grainsize;
452193e17cfeSJonathan Peyton   p->extras = ext1;
4522540007b4SNawrin Sultana   p->last_chunk = last_chunk1;
452393e17cfeSJonathan Peyton   p->tc = tc1;
452493e17cfeSJonathan Peyton   p->num_t_min = num_t_min;
4525cdaefac5SJoachim Protze #if OMPT_SUPPORT
4526cdaefac5SJoachim Protze   p->codeptr_ra = codeptr_ra;
4527cdaefac5SJoachim Protze #endif
4528cdaefac5SJoachim Protze 
4529cdaefac5SJoachim Protze #if OMPT_SUPPORT
4530cdaefac5SJoachim Protze   // schedule new task with correct return address for OMPT events
4531cdaefac5SJoachim Protze   __kmp_omp_taskloop_task(NULL, gtid, new_task, codeptr_ra);
4532cdaefac5SJoachim Protze #else
4533f729df82SGheorghe-Teodor Bercea   __kmp_omp_task(gtid, new_task, true); // schedule new task
4534cdaefac5SJoachim Protze #endif
453593e17cfeSJonathan Peyton 
453693e17cfeSJonathan Peyton   // execute the 1st half of current subrange
453793e17cfeSJonathan Peyton   if (n_tsk0 > num_t_min)
4538d74d8902SJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0, gr_size0,
4539540007b4SNawrin Sultana                          ext0, last_chunk0, tc0, num_t_min,
4540cdaefac5SJoachim Protze #if OMPT_SUPPORT
4541cdaefac5SJoachim Protze                          codeptr_ra,
4542cdaefac5SJoachim Protze #endif
4543cdaefac5SJoachim Protze                          task_dup);
454493e17cfeSJonathan Peyton   else
454593e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0,
4546540007b4SNawrin Sultana                           gr_size0, ext0, last_chunk0, tc0,
4547cdaefac5SJoachim Protze #if OMPT_SUPPORT
4548cdaefac5SJoachim Protze                           codeptr_ra,
4549cdaefac5SJoachim Protze #endif
4550cdaefac5SJoachim Protze                           task_dup);
455193e17cfeSJonathan Peyton 
4552540007b4SNawrin Sultana   KA_TRACE(40, ("__kmp_taskloop_recur(exit): T#%d\n", gtid));
455393e17cfeSJonathan Peyton }
455493e17cfeSJonathan Peyton 
4555540007b4SNawrin Sultana static void __kmp_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4556540007b4SNawrin Sultana                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4557540007b4SNawrin Sultana                            int nogroup, int sched, kmp_uint64 grainsize,
4558540007b4SNawrin Sultana                            int modifier, void *task_dup) {
455993e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
456093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
456182e94a59SJoachim Protze   if (nogroup == 0) {
456282e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
456382e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
456482e94a59SJoachim Protze #endif
456593e17cfeSJonathan Peyton     __kmpc_taskgroup(loc, gtid);
456682e94a59SJoachim Protze   }
456793e17cfeSJonathan Peyton 
456893e17cfeSJonathan Peyton   // =========================================================================
456993e17cfeSJonathan Peyton   // calculate loop parameters
457027a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
457193e17cfeSJonathan Peyton   kmp_uint64 tc;
457227a677fcSJonathan Peyton   // compiler provides global bounds here
457327a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
457427a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
457593e17cfeSJonathan Peyton   kmp_uint64 ub_glob = upper; // global upper used to calc lastprivate flag
457693e17cfeSJonathan Peyton   kmp_uint64 num_tasks = 0, extras = 0;
4577540007b4SNawrin Sultana   kmp_int64 last_chunk =
4578540007b4SNawrin Sultana       0; // reduce grainsize of last task by last_chunk in strict mode
457993e17cfeSJonathan Peyton   kmp_uint64 num_tasks_min = __kmp_taskloop_min_tasks;
458093e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
458193e17cfeSJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
458293e17cfeSJonathan Peyton 
4583540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop: T#%d, task %p, lb %lld, ub %lld, st %lld, "
4584540007b4SNawrin Sultana                 "grain %llu(%d, %d), dup %p\n",
4585540007b4SNawrin Sultana                 gtid, taskdata, lower, upper, st, grainsize, sched, modifier,
4586540007b4SNawrin Sultana                 task_dup));
458727a677fcSJonathan Peyton 
45887cc577a4SJonathan Peyton   // compute trip count
45897cc577a4SJonathan Peyton   if (st == 1) { // most common case
45907cc577a4SJonathan Peyton     tc = upper - lower + 1;
45917cc577a4SJonathan Peyton   } else if (st < 0) {
45927cc577a4SJonathan Peyton     tc = (lower - upper) / (-st) + 1;
45937cc577a4SJonathan Peyton   } else { // st > 0
45947cc577a4SJonathan Peyton     tc = (upper - lower) / st + 1;
45957cc577a4SJonathan Peyton   }
45967cc577a4SJonathan Peyton   if (tc == 0) {
4597540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop(exit): T#%d zero-trip loop\n", gtid));
45987cc577a4SJonathan Peyton     // free the pattern task and exit
45997cc577a4SJonathan Peyton     __kmp_task_start(gtid, task, current_task);
46007cc577a4SJonathan Peyton     // do not execute anything for zero-trip loop
460186ed6aa6SJoachim Protze     __kmp_task_finish<false>(gtid, task, current_task);
46027cc577a4SJonathan Peyton     return;
46037cc577a4SJonathan Peyton   }
4604cdaefac5SJoachim Protze 
4605cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4606cdaefac5SJoachim Protze   ompt_team_info_t *team_info = __ompt_get_teaminfo(0, NULL);
4607cdaefac5SJoachim Protze   ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
4608cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4609cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4610cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_begin, &(team_info->parallel_data),
4611cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4612cdaefac5SJoachim Protze   }
4613cdaefac5SJoachim Protze #endif
4614cdaefac5SJoachim Protze 
461593e17cfeSJonathan Peyton   if (num_tasks_min == 0)
461693e17cfeSJonathan Peyton     // TODO: can we choose better default heuristic?
4617d74d8902SJonathan Peyton     num_tasks_min =
4618d74d8902SJonathan Peyton         KMP_MIN(thread->th.th_team_nproc * 10, INITIAL_TASK_DEQUE_SIZE);
46197cc577a4SJonathan Peyton 
46207cc577a4SJonathan Peyton   // compute num_tasks/grainsize based on the input provided
46217cc577a4SJonathan Peyton   switch (sched) {
46227cc577a4SJonathan Peyton   case 0: // no schedule clause specified, we can choose the default
46237cc577a4SJonathan Peyton     // let's try to schedule (team_size*10) tasks
46247cc577a4SJonathan Peyton     grainsize = thread->th.th_team_nproc * 10;
46250c599c38SJoachim Protze     KMP_FALLTHROUGH();
46267cc577a4SJonathan Peyton   case 2: // num_tasks provided
46277cc577a4SJonathan Peyton     if (grainsize > tc) {
46287cc577a4SJonathan Peyton       num_tasks = tc; // too big num_tasks requested, adjust values
46297cc577a4SJonathan Peyton       grainsize = 1;
46307cc577a4SJonathan Peyton       extras = 0;
46317cc577a4SJonathan Peyton     } else {
46327cc577a4SJonathan Peyton       num_tasks = grainsize;
46337cc577a4SJonathan Peyton       grainsize = tc / num_tasks;
46347cc577a4SJonathan Peyton       extras = tc % num_tasks;
46357cc577a4SJonathan Peyton     }
46367cc577a4SJonathan Peyton     break;
46377cc577a4SJonathan Peyton   case 1: // grainsize provided
46387cc577a4SJonathan Peyton     if (grainsize > tc) {
4639540007b4SNawrin Sultana       num_tasks = 1;
4640540007b4SNawrin Sultana       grainsize = tc; // too big grainsize requested, adjust values
4641540007b4SNawrin Sultana       extras = 0;
4642540007b4SNawrin Sultana     } else {
4643540007b4SNawrin Sultana       if (modifier) {
4644540007b4SNawrin Sultana         num_tasks = (tc + grainsize - 1) / grainsize;
4645540007b4SNawrin Sultana         last_chunk = tc - (num_tasks * grainsize);
46467cc577a4SJonathan Peyton         extras = 0;
46477cc577a4SJonathan Peyton       } else {
46487cc577a4SJonathan Peyton         num_tasks = tc / grainsize;
464993e17cfeSJonathan Peyton         // adjust grainsize for balanced distribution of iterations
465093e17cfeSJonathan Peyton         grainsize = tc / num_tasks;
46517cc577a4SJonathan Peyton         extras = tc % num_tasks;
46527cc577a4SJonathan Peyton       }
4653540007b4SNawrin Sultana     }
46547cc577a4SJonathan Peyton     break;
46557cc577a4SJonathan Peyton   default:
46567cc577a4SJonathan Peyton     KMP_ASSERT2(0, "unknown scheduling of taskloop");
46577cc577a4SJonathan Peyton   }
4658540007b4SNawrin Sultana 
4659*309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4660*309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
46617cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
46627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
466393e17cfeSJonathan Peyton   // =========================================================================
46647cc577a4SJonathan Peyton 
46657cc577a4SJonathan Peyton   // check if clause value first
466627a677fcSJonathan Peyton   // Also require GOMP_taskloop to reduce to linear (taskdata->td_flags.native)
46677cc577a4SJonathan Peyton   if (if_val == 0) { // if(0) specified, mark task as serial
46687cc577a4SJonathan Peyton     taskdata->td_flags.task_serial = 1;
46697cc577a4SJonathan Peyton     taskdata->td_flags.tiedness = TASK_TIED; // AC: serial task cannot be untied
467093e17cfeSJonathan Peyton     // always start serial tasks linearly
467193e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4672540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4673cdaefac5SJoachim Protze #if OMPT_SUPPORT
4674cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4675cdaefac5SJoachim Protze #endif
4676cdaefac5SJoachim Protze                           task_dup);
467727a677fcSJonathan Peyton     // !taskdata->td_flags.native => currently force linear spawning of tasks
467827a677fcSJonathan Peyton     // for GOMP_taskloop
467927a677fcSJonathan Peyton   } else if (num_tasks > num_tasks_min && !taskdata->td_flags.native) {
4680540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go recursive: tc %llu, #tasks %llu"
4681540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4682540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4683540007b4SNawrin Sultana                   last_chunk));
468493e17cfeSJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4685540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_tasks_min,
4686cdaefac5SJoachim Protze #if OMPT_SUPPORT
4687cdaefac5SJoachim Protze                          OMPT_GET_RETURN_ADDRESS(0),
4688cdaefac5SJoachim Protze #endif
4689cdaefac5SJoachim Protze                          task_dup);
469093e17cfeSJonathan Peyton   } else {
4691540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go linear: tc %llu, #tasks %llu"
4692540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4693540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4694540007b4SNawrin Sultana                   last_chunk));
469593e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4696540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4697cdaefac5SJoachim Protze #if OMPT_SUPPORT
4698cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4699cdaefac5SJoachim Protze #endif
4700cdaefac5SJoachim Protze                           task_dup);
47017cc577a4SJonathan Peyton   }
47027cc577a4SJonathan Peyton 
4703cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4704cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4705cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4706cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_end, &(team_info->parallel_data),
4707cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4708cdaefac5SJoachim Protze   }
4709cdaefac5SJoachim Protze #endif
4710cdaefac5SJoachim Protze 
471182e94a59SJoachim Protze   if (nogroup == 0) {
471282e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
471382e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
471482e94a59SJoachim Protze #endif
47157cc577a4SJonathan Peyton     __kmpc_end_taskgroup(loc, gtid);
471682e94a59SJoachim Protze   }
4717540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop(exit): T#%d\n", gtid));
4718540007b4SNawrin Sultana }
4719540007b4SNawrin Sultana 
4720540007b4SNawrin Sultana /*!
4721540007b4SNawrin Sultana @ingroup TASKING
4722540007b4SNawrin Sultana @param loc       Source location information
4723540007b4SNawrin Sultana @param gtid      Global thread ID
4724540007b4SNawrin Sultana @param task      Task structure
4725540007b4SNawrin Sultana @param if_val    Value of the if clause
4726540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4727540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4728540007b4SNawrin Sultana @param st        Loop stride
4729540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4730540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4731540007b4SNawrin Sultana @param grainsize Schedule value if specified
4732540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4733540007b4SNawrin Sultana 
4734540007b4SNawrin Sultana Execute the taskloop construct.
4735540007b4SNawrin Sultana */
4736540007b4SNawrin Sultana void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4737540007b4SNawrin Sultana                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,
4738540007b4SNawrin Sultana                      int sched, kmp_uint64 grainsize, void *task_dup) {
4739540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4740540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop(enter): T#%d\n", gtid));
4741540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4742540007b4SNawrin Sultana                  0, task_dup);
474393e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d\n", gtid));
47447cc577a4SJonathan Peyton }
4745540007b4SNawrin Sultana 
4746540007b4SNawrin Sultana /*!
4747540007b4SNawrin Sultana @ingroup TASKING
4748540007b4SNawrin Sultana @param loc       Source location information
4749540007b4SNawrin Sultana @param gtid      Global thread ID
4750540007b4SNawrin Sultana @param task      Task structure
4751540007b4SNawrin Sultana @param if_val    Value of the if clause
4752540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4753540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4754540007b4SNawrin Sultana @param st        Loop stride
4755540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4756540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4757540007b4SNawrin Sultana @param grainsize Schedule value if specified
4758540007b4SNawrin Sultana @param modifer   Modifier 'strict' for sched, 1 if present, 0 otherwise
4759540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4760540007b4SNawrin Sultana 
4761540007b4SNawrin Sultana Execute the taskloop construct.
4762540007b4SNawrin Sultana */
4763540007b4SNawrin Sultana void __kmpc_taskloop_5(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4764540007b4SNawrin Sultana                        kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4765540007b4SNawrin Sultana                        int nogroup, int sched, kmp_uint64 grainsize,
4766540007b4SNawrin Sultana                        int modifier, void *task_dup) {
4767540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4768540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(enter): T#%d\n", gtid));
4769540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4770540007b4SNawrin Sultana                  modifier, task_dup);
4771540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(exit): T#%d\n", gtid));
4772540007b4SNawrin Sultana }
4773