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 
329e5da63d5SShilei Tian   // We don't need to map to shadow gtid if it is already hidden helper thread
330e5da63d5SShilei Tian   if (taskdata->td_flags.hidden_helper && !KMP_HIDDEN_HELPER_THREAD(gtid)) {
3319d64275aSShilei Tian     gtid = KMP_GTID_TO_SHADOW_GTID(gtid);
3329d64275aSShilei Tian     thread = __kmp_threads[gtid];
3339d64275aSShilei Tian   }
3349d64275aSShilei Tian 
3357cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
3367cc577a4SJonathan Peyton   kmp_int32 tid = __kmp_tid_from_gtid(gtid);
3377cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
3387cc577a4SJonathan Peyton 
3393041982dSJonathan Peyton   KA_TRACE(20,
3403041982dSJonathan Peyton            ("__kmp_push_task: T#%d trying to push task %p.\n", gtid, taskdata));
3417cc577a4SJonathan Peyton 
3426bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
3433041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
3443041982dSJonathan Peyton     // freed prematurely
34537e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
346baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
3473041982dSJonathan Peyton     KA_TRACE(
3483041982dSJonathan Peyton         20,
3493041982dSJonathan Peyton         ("__kmp_push_task: T#%d untied_count (%d) incremented for task %p\n",
3507cc577a4SJonathan Peyton          gtid, counter, taskdata));
3517cc577a4SJonathan Peyton   }
3527cc577a4SJonathan Peyton 
3537cc577a4SJonathan Peyton   // The first check avoids building task_team thread data if serialized
3546bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.task_serial)) {
3553041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_push_task: T#%d team serialized; returning "
3563041982dSJonathan Peyton                   "TASK_NOT_PUSHED for task %p\n",
3577cc577a4SJonathan Peyton                   gtid, taskdata));
3587cc577a4SJonathan Peyton     return TASK_NOT_PUSHED;
3597cc577a4SJonathan Peyton   }
3607cc577a4SJonathan Peyton 
3613041982dSJonathan Peyton   // Now that serialized tasks have returned, we can assume that we are not in
3623041982dSJonathan Peyton   // immediate exec mode
3637cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
3646bf84871SAndreyChurbanov   if (UNLIKELY(!KMP_TASKING_ENABLED(task_team))) {
3657cc577a4SJonathan Peyton     __kmp_enable_tasking(task_team, thread);
3667cc577a4SJonathan Peyton   }
3677cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(task_team->tt.tt_found_tasks) == TRUE);
3687cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_PTR(task_team->tt.tt_threads_data) != NULL);
3697cc577a4SJonathan Peyton 
3707cc577a4SJonathan Peyton   // Find tasking deque specific to encountering thread
3717cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[tid];
3727cc577a4SJonathan Peyton 
3739d64275aSShilei Tian   // No lock needed since only owner can allocate. If the task is hidden_helper,
3749d64275aSShilei Tian   // we don't need it either because we have initialized the dequeue for hidden
3759d64275aSShilei Tian   // helper thread data.
3766bf84871SAndreyChurbanov   if (UNLIKELY(thread_data->td.td_deque == NULL)) {
3777cc577a4SJonathan Peyton     __kmp_alloc_task_deque(thread, thread_data);
3787cc577a4SJonathan Peyton   }
3797cc577a4SJonathan Peyton 
380c3344345SAndrey Churbanov   int locked = 0;
3817cc577a4SJonathan Peyton   // Check if deque is full
3823041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
3833041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
384a23806e6SAndrey Churbanov     if (__kmp_enable_task_throttling &&
385a23806e6SAndrey Churbanov         __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
386c3344345SAndrey Churbanov                               thread->th.th_current_task)) {
3873041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_push_task: T#%d deque is full; returning "
3883041982dSJonathan Peyton                     "TASK_NOT_PUSHED for task %p\n",
3897cc577a4SJonathan Peyton                     gtid, taskdata));
3907cc577a4SJonathan Peyton       return TASK_NOT_PUSHED;
391c3344345SAndrey Churbanov     } else {
3927cc577a4SJonathan Peyton       __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
393c3344345SAndrey Churbanov       locked = 1;
3943895148dSJoachim Protze       if (TCR_4(thread_data->td.td_deque_ntasks) >=
3953895148dSJoachim Protze           TASK_DEQUE_SIZE(thread_data->td)) {
396c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
397c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
398c3344345SAndrey Churbanov       }
399c3344345SAndrey Churbanov     }
4003895148dSJoachim Protze   }
401c3344345SAndrey Churbanov   // Lock the deque for the task push operation
402c3344345SAndrey Churbanov   if (!locked) {
403c3344345SAndrey Churbanov     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
404c3344345SAndrey Churbanov     // Need to recheck as we can get a proxy task from thread outside of OpenMP
4053041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
4063041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
407a23806e6SAndrey Churbanov       if (__kmp_enable_task_throttling &&
408a23806e6SAndrey Churbanov           __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
409c3344345SAndrey Churbanov                                 thread->th.th_current_task)) {
4107cc577a4SJonathan Peyton         __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
411c3344345SAndrey Churbanov         KA_TRACE(20, ("__kmp_push_task: T#%d deque is full on 2nd check; "
412c3344345SAndrey Churbanov                       "returning TASK_NOT_PUSHED for task %p\n",
4137cc577a4SJonathan Peyton                       gtid, taskdata));
4147cc577a4SJonathan Peyton         return TASK_NOT_PUSHED;
415c3344345SAndrey Churbanov       } else {
416c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
417c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
4187cc577a4SJonathan Peyton       }
419c3344345SAndrey Churbanov     }
420c3344345SAndrey Churbanov   }
4217cc577a4SJonathan Peyton   // Must have room since no thread can add tasks but calling thread
4223041982dSJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) <
4233041982dSJonathan Peyton                    TASK_DEQUE_SIZE(thread_data->td));
4247cc577a4SJonathan Peyton 
4253041982dSJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] =
4263041982dSJonathan Peyton       taskdata; // Push taskdata
4277cc577a4SJonathan Peyton   // Wrap index.
4283041982dSJonathan Peyton   thread_data->td.td_deque_tail =
4293041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
4303041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
4313041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1); // Adjust task count
432ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(thread->th.th_current_task); // releasing self
433ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(taskdata); // releasing child
4347cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_push_task: T#%d returning TASK_SUCCESSFULLY_PUSHED: "
4357cc577a4SJonathan Peyton                 "task=%p ntasks=%d head=%u tail=%u\n",
4367cc577a4SJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
4377cc577a4SJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
4387cc577a4SJonathan Peyton 
4397cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
4407cc577a4SJonathan Peyton 
4419d64275aSShilei Tian   // Signal one worker thread to execute the task
4429d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
4439d64275aSShilei Tian     // Wake hidden helper threads up if they're sleeping
4449d64275aSShilei Tian     __kmp_hidden_helper_worker_thread_signal();
4459d64275aSShilei Tian   }
4469d64275aSShilei Tian 
4477cc577a4SJonathan Peyton   return TASK_SUCCESSFULLY_PUSHED;
4487cc577a4SJonathan Peyton }
4497cc577a4SJonathan Peyton 
4503041982dSJonathan Peyton // __kmp_pop_current_task_from_thread: set up current task from called thread
4513041982dSJonathan Peyton // when team ends
4523041982dSJonathan Peyton //
4537cc577a4SJonathan Peyton // this_thr: thread structure to set current_task in.
4543041982dSJonathan Peyton void __kmp_pop_current_task_from_thread(kmp_info_t *this_thr) {
4553041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(enter): T#%d "
4563041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
4577cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
4587cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
4597cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
4607cc577a4SJonathan Peyton 
4617cc577a4SJonathan Peyton   this_thr->th.th_current_task = this_thr->th.th_current_task->td_parent;
4627cc577a4SJonathan Peyton 
4633041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(exit): T#%d "
4643041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
4657cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
4667cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
4677cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
4687cc577a4SJonathan Peyton }
4697cc577a4SJonathan Peyton 
4703041982dSJonathan Peyton // __kmp_push_current_task_to_thread: set up current task in called thread for a
4713041982dSJonathan Peyton // new team
4723041982dSJonathan Peyton //
4737cc577a4SJonathan Peyton // this_thr: thread structure to set up
4747cc577a4SJonathan Peyton // team: team for implicit task data
4757cc577a4SJonathan Peyton // tid: thread within team to set up
4763041982dSJonathan Peyton void __kmp_push_current_task_to_thread(kmp_info_t *this_thr, kmp_team_t *team,
4773041982dSJonathan Peyton                                        int tid) {
4783041982dSJonathan Peyton   // current task of the thread is a parent of the new just created implicit
4793041982dSJonathan Peyton   // tasks of new team
4803041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(enter): T#%d this_thread=%p "
4813041982dSJonathan Peyton                 "curtask=%p "
4827cc577a4SJonathan Peyton                 "parent_task=%p\n",
4837cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
4847cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
4857cc577a4SJonathan Peyton 
4867cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr != NULL);
4877cc577a4SJonathan Peyton 
4887cc577a4SJonathan Peyton   if (tid == 0) {
4897cc577a4SJonathan Peyton     if (this_thr->th.th_current_task != &team->t.t_implicit_task_taskdata[0]) {
4903041982dSJonathan Peyton       team->t.t_implicit_task_taskdata[0].td_parent =
4913041982dSJonathan Peyton           this_thr->th.th_current_task;
4927cc577a4SJonathan Peyton       this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[0];
4937cc577a4SJonathan Peyton     }
4947cc577a4SJonathan Peyton   } else {
4953041982dSJonathan Peyton     team->t.t_implicit_task_taskdata[tid].td_parent =
4963041982dSJonathan Peyton         team->t.t_implicit_task_taskdata[0].td_parent;
4977cc577a4SJonathan Peyton     this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[tid];
4987cc577a4SJonathan Peyton   }
4997cc577a4SJonathan Peyton 
5003041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(exit): T#%d this_thread=%p "
5013041982dSJonathan Peyton                 "curtask=%p "
5027cc577a4SJonathan Peyton                 "parent_task=%p\n",
5037cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
5047cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
5057cc577a4SJonathan Peyton }
5067cc577a4SJonathan Peyton 
5077cc577a4SJonathan Peyton // __kmp_task_start: bookkeeping for a task starting execution
5083041982dSJonathan Peyton //
5097cc577a4SJonathan Peyton // GTID: global thread id of calling thread
5107cc577a4SJonathan Peyton // task: task starting execution
5117cc577a4SJonathan Peyton // current_task: task suspending
5123041982dSJonathan Peyton static void __kmp_task_start(kmp_int32 gtid, kmp_task_t *task,
5133041982dSJonathan Peyton                              kmp_taskdata_t *current_task) {
5147cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
5157cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
5167cc577a4SJonathan Peyton 
5173041982dSJonathan Peyton   KA_TRACE(10,
5183041982dSJonathan Peyton            ("__kmp_task_start(enter): T#%d starting task %p: current_task=%p\n",
5197cc577a4SJonathan Peyton             gtid, taskdata, current_task));
5207cc577a4SJonathan Peyton 
5217cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
5227cc577a4SJonathan Peyton 
5237cc577a4SJonathan Peyton   // mark currently executing task as suspended
5247cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
5257cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( current_task -> td_flags.executing == 1 );
5267cc577a4SJonathan Peyton   current_task->td_flags.executing = 0;
5277cc577a4SJonathan Peyton 
5287cc577a4SJonathan Peyton // Add task to stack if tied
5297cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
5303041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
5317cc577a4SJonathan Peyton     __kmp_push_task_stack(gtid, thread, taskdata);
5327cc577a4SJonathan Peyton   }
5337cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
5347cc577a4SJonathan Peyton 
5357cc577a4SJonathan Peyton   // mark starting task as executing and as current task
5367cc577a4SJonathan Peyton   thread->th.th_current_task = taskdata;
5377cc577a4SJonathan Peyton 
5383041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 0 ||
5393041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
5403041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0 ||
5413041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
5427cc577a4SJonathan Peyton   taskdata->td_flags.started = 1;
5437cc577a4SJonathan Peyton   taskdata->td_flags.executing = 1;
5447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
5457cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
5467cc577a4SJonathan Peyton 
5477cc577a4SJonathan Peyton   // GEH TODO: shouldn't we pass some sort of location identifier here?
5487cc577a4SJonathan Peyton   // APT: yes, we will pass location here.
5497cc577a4SJonathan Peyton   // need to store current thread state (in a thread or taskdata structure)
5507cc577a4SJonathan Peyton   // before setting work_state, otherwise wrong state is set after end of task
5517cc577a4SJonathan Peyton 
5523041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_start(exit): T#%d task=%p\n", gtid, taskdata));
5537cc577a4SJonathan Peyton 
5547cc577a4SJonathan Peyton   return;
5557cc577a4SJonathan Peyton }
5567cc577a4SJonathan Peyton 
55782e94a59SJoachim Protze #if OMPT_SUPPORT
55882e94a59SJoachim Protze //------------------------------------------------------------------------------
55982e94a59SJoachim Protze // __ompt_task_init:
56082e94a59SJoachim Protze //   Initialize OMPT fields maintained by a task. This will only be called after
56182e94a59SJoachim Protze //   ompt_start_tool, so we already know whether ompt is enabled or not.
56282e94a59SJoachim Protze 
56382e94a59SJoachim Protze static inline void __ompt_task_init(kmp_taskdata_t *task, int tid) {
56482e94a59SJoachim Protze   // The calls to __ompt_task_init already have the ompt_enabled condition.
56582e94a59SJoachim Protze   task->ompt_task_info.task_data.value = 0;
5660e0d6cddSJoachim Protze   task->ompt_task_info.frame.exit_frame = ompt_data_none;
5670e0d6cddSJoachim Protze   task->ompt_task_info.frame.enter_frame = ompt_data_none;
568309b00a4SShilei Tian   task->ompt_task_info.frame.exit_frame_flags =
569309b00a4SShilei Tian       ompt_frame_runtime | ompt_frame_framepointer;
570309b00a4SShilei Tian   task->ompt_task_info.frame.enter_frame_flags =
571309b00a4SShilei Tian       ompt_frame_runtime | ompt_frame_framepointer;
57282e94a59SJoachim Protze }
57382e94a59SJoachim Protze 
57482e94a59SJoachim Protze // __ompt_task_start:
57582e94a59SJoachim Protze //   Build and trigger task-begin event
57682e94a59SJoachim Protze static inline void __ompt_task_start(kmp_task_t *task,
57782e94a59SJoachim Protze                                      kmp_taskdata_t *current_task,
57882e94a59SJoachim Protze                                      kmp_int32 gtid) {
57982e94a59SJoachim Protze   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
580489cdb78SJoachim Protze   ompt_task_status_t status = ompt_task_switch;
58182e94a59SJoachim Protze   if (__kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded) {
58282e94a59SJoachim Protze     status = ompt_task_yield;
58382e94a59SJoachim Protze     __kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded = 0;
58482e94a59SJoachim Protze   }
58582e94a59SJoachim Protze   /* let OMPT know that we're about to run this task */
58682e94a59SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
58782e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
58882e94a59SJoachim Protze         &(current_task->ompt_task_info.task_data), status,
58982e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data));
59082e94a59SJoachim Protze   }
59182e94a59SJoachim Protze   taskdata->ompt_task_info.scheduling_parent = current_task;
59282e94a59SJoachim Protze }
59382e94a59SJoachim Protze 
59482e94a59SJoachim Protze // __ompt_task_finish:
59582e94a59SJoachim Protze //   Build and trigger final task-schedule event
59610995c77SJoachim Protze static inline void __ompt_task_finish(kmp_task_t *task,
59710995c77SJoachim Protze                                       kmp_taskdata_t *resumed_task,
59810995c77SJoachim Protze                                       ompt_task_status_t status) {
59910995c77SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
60082e94a59SJoachim Protze     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
60182e94a59SJoachim Protze     if (__kmp_omp_cancellation && taskdata->td_taskgroup &&
60282e94a59SJoachim Protze         taskdata->td_taskgroup->cancel_request == cancel_taskgroup) {
60382e94a59SJoachim Protze       status = ompt_task_cancel;
60482e94a59SJoachim Protze     }
60582e94a59SJoachim Protze 
60682e94a59SJoachim Protze     /* let OMPT know that we're returning to the callee task */
60782e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
60882e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data), status,
60910995c77SJoachim Protze         (resumed_task ? &(resumed_task->ompt_task_info.task_data) : NULL));
61082e94a59SJoachim Protze   }
61182e94a59SJoachim Protze }
61282e94a59SJoachim Protze #endif
61382e94a59SJoachim Protze 
61482e94a59SJoachim Protze template <bool ompt>
61582e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_template(ident_t *loc_ref, kmp_int32 gtid,
61682e94a59SJoachim Protze                                                kmp_task_t *task,
61782e94a59SJoachim Protze                                                void *frame_address,
61882e94a59SJoachim Protze                                                void *return_address) {
6197cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
6207cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
6217cc577a4SJonathan Peyton 
6223041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(enter): T#%d loc=%p task=%p "
6233041982dSJonathan Peyton                 "current_task=%p\n",
6247cc577a4SJonathan Peyton                 gtid, loc_ref, taskdata, current_task));
6257cc577a4SJonathan Peyton 
626838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
6273041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
6283041982dSJonathan Peyton     // freed prematurely
62937e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
630baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
6313041982dSJonathan Peyton     KA_TRACE(20, ("__kmpc_omp_task_begin_if0: T#%d untied_count (%d) "
6323041982dSJonathan Peyton                   "incremented for task %p\n",
6337cc577a4SJonathan Peyton                   gtid, counter, taskdata));
6347cc577a4SJonathan Peyton   }
6357cc577a4SJonathan Peyton 
6363041982dSJonathan Peyton   taskdata->td_flags.task_serial =
6373041982dSJonathan Peyton       1; // Execute this task immediately, not deferred.
6387cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
6397cc577a4SJonathan Peyton 
64082e94a59SJoachim Protze #if OMPT_SUPPORT
64182e94a59SJoachim Protze   if (ompt) {
6420e0d6cddSJoachim Protze     if (current_task->ompt_task_info.frame.enter_frame.ptr == NULL) {
6430e0d6cddSJoachim Protze       current_task->ompt_task_info.frame.enter_frame.ptr =
6440e0d6cddSJoachim Protze           taskdata->ompt_task_info.frame.exit_frame.ptr = frame_address;
6450e0d6cddSJoachim Protze       current_task->ompt_task_info.frame.enter_frame_flags =
646309b00a4SShilei Tian           taskdata->ompt_task_info.frame.exit_frame_flags =
647309b00a4SShilei Tian               ompt_frame_application | ompt_frame_framepointer;
64882e94a59SJoachim Protze     }
64982e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
65082e94a59SJoachim Protze       ompt_task_info_t *parent_info = &(current_task->ompt_task_info);
65182e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
65282e94a59SJoachim Protze           &(parent_info->task_data), &(parent_info->frame),
65382e94a59SJoachim Protze           &(taskdata->ompt_task_info.task_data),
65482e94a59SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(taskdata), 0,
65582e94a59SJoachim Protze           return_address);
65682e94a59SJoachim Protze     }
65782e94a59SJoachim Protze     __ompt_task_start(task, current_task, gtid);
65882e94a59SJoachim Protze   }
65982e94a59SJoachim Protze #endif // OMPT_SUPPORT
66082e94a59SJoachim Protze 
6613041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(exit): T#%d loc=%p task=%p,\n", gtid,
6623041982dSJonathan Peyton                 loc_ref, taskdata));
66382e94a59SJoachim Protze }
6647cc577a4SJonathan Peyton 
66582e94a59SJoachim Protze #if OMPT_SUPPORT
66682e94a59SJoachim Protze OMPT_NOINLINE
66782e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
66882e94a59SJoachim Protze                                            kmp_task_t *task,
66982e94a59SJoachim Protze                                            void *frame_address,
67082e94a59SJoachim Protze                                            void *return_address) {
671f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<true>(loc_ref, gtid, task, frame_address,
672f0a1c65fSJonas Hahnfeld                                            return_address);
67382e94a59SJoachim Protze }
67482e94a59SJoachim Protze #endif // OMPT_SUPPORT
67582e94a59SJoachim Protze 
67682e94a59SJoachim Protze // __kmpc_omp_task_begin_if0: report that a given serialized task has started
67782e94a59SJoachim Protze // execution
67882e94a59SJoachim Protze //
67982e94a59SJoachim Protze // loc_ref: source location information; points to beginning of task block.
68082e94a59SJoachim Protze // gtid: global thread number.
68182e94a59SJoachim Protze // task: task thunk for the started task.
68282e94a59SJoachim Protze void __kmpc_omp_task_begin_if0(ident_t *loc_ref, kmp_int32 gtid,
68382e94a59SJoachim Protze                                kmp_task_t *task) {
68482e94a59SJoachim Protze #if OMPT_SUPPORT
68582e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
68682e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
68782e94a59SJoachim Protze     __kmpc_omp_task_begin_if0_ompt(loc_ref, gtid, task,
68882e94a59SJoachim Protze                                    OMPT_GET_FRAME_ADDRESS(1),
68982e94a59SJoachim Protze                                    OMPT_LOAD_RETURN_ADDRESS(gtid));
6907cc577a4SJonathan Peyton     return;
6917cc577a4SJonathan Peyton   }
69282e94a59SJoachim Protze #endif
693f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<false>(loc_ref, gtid, task, NULL, NULL);
69482e94a59SJoachim Protze }
6957cc577a4SJonathan Peyton 
6967cc577a4SJonathan Peyton #ifdef TASK_UNUSED
6977cc577a4SJonathan Peyton // __kmpc_omp_task_begin: report that a given task has started execution
6987cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
6993041982dSJonathan Peyton void __kmpc_omp_task_begin(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task) {
7007cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
7017cc577a4SJonathan Peyton 
7023041982dSJonathan Peyton   KA_TRACE(
7033041982dSJonathan Peyton       10,
7043041982dSJonathan Peyton       ("__kmpc_omp_task_begin(enter): T#%d loc=%p task=%p current_task=%p\n",
7057cc577a4SJonathan Peyton        gtid, loc_ref, KMP_TASK_TO_TASKDATA(task), current_task));
7067cc577a4SJonathan Peyton 
7077cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
7087cc577a4SJonathan Peyton 
7093041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin(exit): T#%d loc=%p task=%p,\n", gtid,
7103041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
7117cc577a4SJonathan Peyton   return;
7127cc577a4SJonathan Peyton }
7137cc577a4SJonathan Peyton #endif // TASK_UNUSED
7147cc577a4SJonathan Peyton 
7157cc577a4SJonathan Peyton // __kmp_free_task: free the current task space and the space for shareds
7163041982dSJonathan Peyton //
7177cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
7187cc577a4SJonathan Peyton // taskdata: task to free
7197cc577a4SJonathan Peyton // thread: thread data structure of caller
7203041982dSJonathan Peyton static void __kmp_free_task(kmp_int32 gtid, kmp_taskdata_t *taskdata,
7213041982dSJonathan Peyton                             kmp_info_t *thread) {
7223041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_free_task: T#%d freeing data from task %p\n", gtid,
7233041982dSJonathan Peyton                 taskdata));
7247cc577a4SJonathan Peyton 
7257cc577a4SJonathan Peyton   // Check to make sure all flags and counters have the correct values
7267cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7277cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0);
7287cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 1);
7297cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
73037e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_allocated_child_tasks == 0 ||
7313041982dSJonathan Peyton                    taskdata->td_flags.task_serial == 1);
73237e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_incomplete_child_tasks == 0);
7337cc577a4SJonathan Peyton 
7347cc577a4SJonathan Peyton   taskdata->td_flags.freed = 1;
7357cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(taskdata);
7367cc577a4SJonathan Peyton // deallocate the taskdata and shared variable blocks associated with this task
7377cc577a4SJonathan Peyton #if USE_FAST_MEMORY
7387cc577a4SJonathan Peyton   __kmp_fast_free(thread, taskdata);
7397cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
7407cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskdata);
7417cc577a4SJonathan Peyton #endif
7423041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_free_task: T#%d freed task %p\n", gtid, taskdata));
7437cc577a4SJonathan Peyton }
7447cc577a4SJonathan Peyton 
7453041982dSJonathan Peyton // __kmp_free_task_and_ancestors: free the current task and ancestors without
7463041982dSJonathan Peyton // children
7477cc577a4SJonathan Peyton //
7487cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
7497cc577a4SJonathan Peyton // taskdata: task to free
7507cc577a4SJonathan Peyton // thread: thread data structure of caller
7513041982dSJonathan Peyton static void __kmp_free_task_and_ancestors(kmp_int32 gtid,
7523041982dSJonathan Peyton                                           kmp_taskdata_t *taskdata,
7533041982dSJonathan Peyton                                           kmp_info_t *thread) {
7547cc577a4SJonathan Peyton   // Proxy tasks must always be allowed to free their parents
7557cc577a4SJonathan Peyton   // because they can be run in background even in serial mode.
7563041982dSJonathan Peyton   kmp_int32 team_serial =
7573041982dSJonathan Peyton       (taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) &&
7583041982dSJonathan Peyton       !taskdata->td_flags.proxy;
7597cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7607cc577a4SJonathan Peyton 
76137e2ef54SJonathan Peyton   kmp_int32 children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
7627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
7637cc577a4SJonathan Peyton 
7647cc577a4SJonathan Peyton   // Now, go up the ancestor tree to see if any ancestors can now be freed.
7653041982dSJonathan Peyton   while (children == 0) {
7667cc577a4SJonathan Peyton     kmp_taskdata_t *parent_taskdata = taskdata->td_parent;
7677cc577a4SJonathan Peyton 
7687cc577a4SJonathan Peyton     KA_TRACE(20, ("__kmp_free_task_and_ancestors(enter): T#%d task %p complete "
7693041982dSJonathan Peyton                   "and freeing itself\n",
7703041982dSJonathan Peyton                   gtid, taskdata));
7717cc577a4SJonathan Peyton 
7727cc577a4SJonathan Peyton     // --- Deallocate my ancestor task ---
7737cc577a4SJonathan Peyton     __kmp_free_task(gtid, taskdata, thread);
7747cc577a4SJonathan Peyton 
7757cc577a4SJonathan Peyton     taskdata = parent_taskdata;
7767cc577a4SJonathan Peyton 
777c3344345SAndrey Churbanov     if (team_serial)
778c3344345SAndrey Churbanov       return;
7793041982dSJonathan Peyton     // Stop checking ancestors at implicit task instead of walking up ancestor
7803041982dSJonathan Peyton     // tree to avoid premature deallocation of ancestors.
781c3344345SAndrey Churbanov     if (taskdata->td_flags.tasktype == TASK_IMPLICIT) {
782c3344345SAndrey Churbanov       if (taskdata->td_dephash) { // do we need to cleanup dephash?
783c3344345SAndrey Churbanov         int children = KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks);
784c3344345SAndrey Churbanov         kmp_tasking_flags_t flags_old = taskdata->td_flags;
785c3344345SAndrey Churbanov         if (children == 0 && flags_old.complete == 1) {
786c3344345SAndrey Churbanov           kmp_tasking_flags_t flags_new = flags_old;
787c3344345SAndrey Churbanov           flags_new.complete = 0;
788c3344345SAndrey Churbanov           if (KMP_COMPARE_AND_STORE_ACQ32(
789c3344345SAndrey Churbanov                   RCAST(kmp_int32 *, &taskdata->td_flags),
790c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_old),
791c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_new))) {
792c3344345SAndrey Churbanov             KA_TRACE(100, ("__kmp_free_task_and_ancestors: T#%d cleans "
793c3344345SAndrey Churbanov                            "dephash of implicit task %p\n",
794c3344345SAndrey Churbanov                            gtid, taskdata));
795c3344345SAndrey Churbanov             // cleanup dephash of finished implicit task
796c3344345SAndrey Churbanov             __kmp_dephash_free_entries(thread, taskdata->td_dephash);
797c3344345SAndrey Churbanov           }
798c3344345SAndrey Churbanov         }
799c3344345SAndrey Churbanov       }
8007cc577a4SJonathan Peyton       return;
801c3344345SAndrey Churbanov     }
8027cc577a4SJonathan Peyton     // Predecrement simulated by "- 1" calculation
80337e2ef54SJonathan Peyton     children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
8047cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(children >= 0);
8057cc577a4SJonathan Peyton   }
8067cc577a4SJonathan Peyton 
8073041982dSJonathan Peyton   KA_TRACE(
8083041982dSJonathan Peyton       20, ("__kmp_free_task_and_ancestors(exit): T#%d task %p has %d children; "
8093041982dSJonathan Peyton            "not freeing it yet\n",
8103041982dSJonathan Peyton            gtid, taskdata, children));
8117cc577a4SJonathan Peyton }
8127cc577a4SJonathan Peyton 
8137cc577a4SJonathan Peyton // __kmp_task_finish: bookkeeping to do when a task finishes execution
8143041982dSJonathan Peyton //
8157cc577a4SJonathan Peyton // gtid: global thread ID for calling thread
8167cc577a4SJonathan Peyton // task: task to be finished
8177cc577a4SJonathan Peyton // resumed_task: task to be resumed.  (may be NULL if task is serialized)
81810995c77SJoachim Protze //
81910995c77SJoachim Protze // template<ompt>: effectively ompt_enabled.enabled!=0
82010995c77SJoachim Protze // the version with ompt=false is inlined, allowing to optimize away all ompt
82110995c77SJoachim Protze // code in this case
82286ed6aa6SJoachim Protze template <bool ompt>
8233041982dSJonathan Peyton static void __kmp_task_finish(kmp_int32 gtid, kmp_task_t *task,
8243041982dSJonathan Peyton                               kmp_taskdata_t *resumed_task) {
8257cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
8267cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
8273041982dSJonathan Peyton   kmp_task_team_t *task_team =
8283041982dSJonathan Peyton       thread->th.th_task_team; // might be NULL for serial teams...
8297cc577a4SJonathan Peyton   kmp_int32 children = 0;
8307cc577a4SJonathan Peyton 
8313041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_finish(enter): T#%d finishing task %p and resuming "
8323041982dSJonathan Peyton                 "task %p\n",
8337cc577a4SJonathan Peyton                 gtid, taskdata, resumed_task));
8347cc577a4SJonathan Peyton 
8357cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
8367cc577a4SJonathan Peyton 
8377cc577a4SJonathan Peyton // Pop task from stack if tied
8387cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
8393041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
8407cc577a4SJonathan Peyton     __kmp_pop_task_stack(gtid, thread, taskdata);
8417cc577a4SJonathan Peyton   }
8427cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
8437cc577a4SJonathan Peyton 
8446bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
8453041982dSJonathan Peyton     // untied task needs to check the counter so that the task structure is not
8463041982dSJonathan Peyton     // freed prematurely
84737e2ef54SJonathan Peyton     kmp_int32 counter = KMP_ATOMIC_DEC(&taskdata->td_untied_count) - 1;
8483041982dSJonathan Peyton     KA_TRACE(
8493041982dSJonathan Peyton         20,
8503041982dSJonathan Peyton         ("__kmp_task_finish: T#%d untied_count (%d) decremented for task %p\n",
8517cc577a4SJonathan Peyton          gtid, counter, taskdata));
8527cc577a4SJonathan Peyton     if (counter > 0) {
8533041982dSJonathan Peyton       // untied task is not done, to be continued possibly by other thread, do
8543041982dSJonathan Peyton       // not free it now
8557cc577a4SJonathan Peyton       if (resumed_task == NULL) {
8567cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(taskdata->td_flags.task_serial);
8573041982dSJonathan Peyton         resumed_task = taskdata->td_parent; // In a serialized task, the resumed
8583041982dSJonathan Peyton         // task is the parent
8597cc577a4SJonathan Peyton       }
8607cc577a4SJonathan Peyton       thread->th.th_current_task = resumed_task; // restore current_task
8617cc577a4SJonathan Peyton       resumed_task->td_flags.executing = 1; // resume previous task
8623041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_task_finish(exit): T#%d partially done task %p, "
8633041982dSJonathan Peyton                     "resuming task %p\n",
8647cc577a4SJonathan Peyton                     gtid, taskdata, resumed_task));
8657cc577a4SJonathan Peyton       return;
8667cc577a4SJonathan Peyton     }
8677cc577a4SJonathan Peyton   }
8687cc577a4SJonathan Peyton 
869d23131a3SJoachim Protze   // bookkeeping for resuming task:
870d23131a3SJoachim Protze   // GEH - note tasking_ser => task_serial
871d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(
872d23131a3SJoachim Protze       (taskdata->td_flags.tasking_ser || taskdata->td_flags.task_serial) ==
873d23131a3SJoachim Protze       taskdata->td_flags.task_serial);
874d23131a3SJoachim Protze   if (taskdata->td_flags.task_serial) {
875d23131a3SJoachim Protze     if (resumed_task == NULL) {
876d23131a3SJoachim Protze       resumed_task = taskdata->td_parent; // In a serialized task, the resumed
877d23131a3SJoachim Protze       // task is the parent
878d23131a3SJoachim Protze     }
879d23131a3SJoachim Protze   } else {
880d23131a3SJoachim Protze     KMP_DEBUG_ASSERT(resumed_task !=
881d23131a3SJoachim Protze                      NULL); // verify that resumed task is passed as argument
882d23131a3SJoachim Protze   }
883d23131a3SJoachim Protze 
884d23131a3SJoachim Protze   /* If the tasks' destructor thunk flag has been set, we need to invoke the
885d23131a3SJoachim Protze      destructor thunk that has been generated by the compiler. The code is
886d23131a3SJoachim Protze      placed here, since at this point other tasks might have been released
887d23131a3SJoachim Protze      hence overlapping the destructor invocations with some other work in the
888d23131a3SJoachim Protze      released tasks.  The OpenMP spec is not specific on when the destructors
889d23131a3SJoachim Protze      are invoked, so we should be free to choose. */
890838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.destructors_thunk)) {
891d23131a3SJoachim Protze     kmp_routine_entry_t destr_thunk = task->data1.destructors;
892d23131a3SJoachim Protze     KMP_ASSERT(destr_thunk);
893d23131a3SJoachim Protze     destr_thunk(gtid, task);
894d23131a3SJoachim Protze   }
895d23131a3SJoachim Protze 
8967cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
897d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 1);
898d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
899d23131a3SJoachim Protze 
900405037c4SAndrey Churbanov   bool detach = false;
901838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.detachable == TASK_DETACHABLE)) {
902405037c4SAndrey Churbanov     if (taskdata->td_allow_completion_event.type ==
903405037c4SAndrey Churbanov         KMP_EVENT_ALLOW_COMPLETION) {
904405037c4SAndrey Churbanov       // event hasn't been fulfilled yet. Try to detach task.
905405037c4SAndrey Churbanov       __kmp_acquire_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
906405037c4SAndrey Churbanov       if (taskdata->td_allow_completion_event.type ==
907405037c4SAndrey Churbanov           KMP_EVENT_ALLOW_COMPLETION) {
908d23131a3SJoachim Protze         // task finished execution
909d23131a3SJoachim Protze         KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
910d23131a3SJoachim Protze         taskdata->td_flags.executing = 0; // suspend the finishing task
91110995c77SJoachim Protze 
91210995c77SJoachim Protze #if OMPT_SUPPORT
91310995c77SJoachim Protze         // For a detached task, which is not completed, we switch back
91410995c77SJoachim Protze         // the omp_fulfill_event signals completion
91510995c77SJoachim Protze         // locking is necessary to avoid a race with ompt_task_late_fulfill
91610995c77SJoachim Protze         if (ompt)
91710995c77SJoachim Protze           __ompt_task_finish(task, resumed_task, ompt_task_detach);
91810995c77SJoachim Protze #endif
91910995c77SJoachim Protze 
920d23131a3SJoachim Protze         // no access to taskdata after this point!
921d23131a3SJoachim Protze         // __kmp_fulfill_event might free taskdata at any time from now
92210995c77SJoachim Protze 
923405037c4SAndrey Churbanov         taskdata->td_flags.proxy = TASK_PROXY; // proxify!
924405037c4SAndrey Churbanov         detach = true;
925405037c4SAndrey Churbanov       }
926405037c4SAndrey Churbanov       __kmp_release_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
927405037c4SAndrey Churbanov     }
928405037c4SAndrey Churbanov   }
9297cc577a4SJonathan Peyton 
930405037c4SAndrey Churbanov   if (!detach) {
931405037c4SAndrey Churbanov     taskdata->td_flags.complete = 1; // mark the task as completed
932405037c4SAndrey Churbanov 
93310995c77SJoachim Protze #if OMPT_SUPPORT
93410995c77SJoachim Protze     // This is not a detached task, we are done here
93510995c77SJoachim Protze     if (ompt)
93610995c77SJoachim Protze       __ompt_task_finish(task, resumed_task, ompt_task_complete);
93710995c77SJoachim Protze #endif
93810995c77SJoachim Protze 
9393041982dSJonathan Peyton     // Only need to keep track of count if team parallel and tasking not
94057d8b8d6SAndreyChurbanov     // serialized, or task is detachable and event has already been fulfilled
94157d8b8d6SAndreyChurbanov     if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) ||
9429d64275aSShilei Tian         taskdata->td_flags.detachable == TASK_DETACHABLE ||
9439d64275aSShilei Tian         taskdata->td_flags.hidden_helper) {
9447cc577a4SJonathan Peyton       // Predecrement simulated by "- 1" calculation
9453041982dSJonathan Peyton       children =
94637e2ef54SJonathan Peyton           KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
9477cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(children >= 0);
9487cc577a4SJonathan Peyton       if (taskdata->td_taskgroup)
94937e2ef54SJonathan Peyton         KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
950cf27e31bSJonathan Peyton       __kmp_release_deps(gtid, taskdata);
951cf27e31bSJonathan Peyton     } else if (task_team && task_team->tt.tt_found_proxy_tasks) {
9527cc577a4SJonathan Peyton       // if we found proxy tasks there could exist a dependency chain
9537cc577a4SJonathan Peyton       // with the proxy task as origin
9547cc577a4SJonathan Peyton       __kmp_release_deps(gtid, taskdata);
9557cc577a4SJonathan Peyton     }
9563041982dSJonathan Peyton     // td_flags.executing must be marked as 0 after __kmp_release_deps has been
957d23131a3SJoachim Protze     // called. Othertwise, if a task is executed immediately from the
958d23131a3SJoachim Protze     // release_deps code, the flag will be reset to 1 again by this same
959d23131a3SJoachim Protze     // function
9607cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
9617cc577a4SJonathan Peyton     taskdata->td_flags.executing = 0; // suspend the finishing task
962d23131a3SJoachim Protze   }
963d23131a3SJoachim Protze 
9643041982dSJonathan Peyton   KA_TRACE(
9653041982dSJonathan Peyton       20, ("__kmp_task_finish: T#%d finished task %p, %d incomplete children\n",
9667cc577a4SJonathan Peyton            gtid, taskdata, children));
9677cc577a4SJonathan Peyton 
9687cc577a4SJonathan Peyton   // Free this task and then ancestor tasks if they have no children.
9697cc577a4SJonathan Peyton   // Restore th_current_task first as suggested by John:
9707cc577a4SJonathan Peyton   // johnmc: if an asynchronous inquiry peers into the runtime system
9717cc577a4SJonathan Peyton   // it doesn't see the freed task as the current task.
9727cc577a4SJonathan Peyton   thread->th.th_current_task = resumed_task;
973405037c4SAndrey Churbanov   if (!detach)
9747cc577a4SJonathan Peyton     __kmp_free_task_and_ancestors(gtid, taskdata, thread);
9757cc577a4SJonathan Peyton 
9767cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
9777cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( resumed_task->td_flags.executing == 0 );
9787cc577a4SJonathan Peyton   resumed_task->td_flags.executing = 1; // resume previous task
9797cc577a4SJonathan Peyton 
9803041982dSJonathan Peyton   KA_TRACE(
9813041982dSJonathan Peyton       10, ("__kmp_task_finish(exit): T#%d finished task %p, resuming task %p\n",
9827cc577a4SJonathan Peyton            gtid, taskdata, resumed_task));
9837cc577a4SJonathan Peyton 
9847cc577a4SJonathan Peyton   return;
9857cc577a4SJonathan Peyton }
9867cc577a4SJonathan Peyton 
98782e94a59SJoachim Protze template <bool ompt>
98882e94a59SJoachim Protze static void __kmpc_omp_task_complete_if0_template(ident_t *loc_ref,
98982e94a59SJoachim Protze                                                   kmp_int32 gtid,
9903041982dSJonathan Peyton                                                   kmp_task_t *task) {
9917cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(enter): T#%d loc=%p task=%p\n",
9927cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
993838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
9943041982dSJonathan Peyton   // this routine will provide task to resume
99586ed6aa6SJoachim Protze   __kmp_task_finish<ompt>(gtid, task, NULL);
9967cc577a4SJonathan Peyton 
9977cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(exit): T#%d loc=%p task=%p\n",
9987cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
99982e94a59SJoachim Protze 
100082e94a59SJoachim Protze #if OMPT_SUPPORT
100182e94a59SJoachim Protze   if (ompt) {
10020e0d6cddSJoachim Protze     ompt_frame_t *ompt_frame;
100382e94a59SJoachim Protze     __ompt_get_task_info_internal(0, NULL, NULL, &ompt_frame, NULL, NULL);
10040e0d6cddSJoachim Protze     ompt_frame->enter_frame = ompt_data_none;
1005309b00a4SShilei Tian     ompt_frame->enter_frame_flags =
1006309b00a4SShilei Tian         ompt_frame_runtime | ompt_frame_framepointer;
100782e94a59SJoachim Protze   }
100882e94a59SJoachim Protze #endif
100982e94a59SJoachim Protze 
10107cc577a4SJonathan Peyton   return;
10117cc577a4SJonathan Peyton }
10127cc577a4SJonathan Peyton 
101382e94a59SJoachim Protze #if OMPT_SUPPORT
101482e94a59SJoachim Protze OMPT_NOINLINE
101582e94a59SJoachim Protze void __kmpc_omp_task_complete_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
101682e94a59SJoachim Protze                                        kmp_task_t *task) {
101782e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<true>(loc_ref, gtid, task);
101882e94a59SJoachim Protze }
101982e94a59SJoachim Protze #endif // OMPT_SUPPORT
102082e94a59SJoachim Protze 
102182e94a59SJoachim Protze // __kmpc_omp_task_complete_if0: report that a task has completed execution
102282e94a59SJoachim Protze //
102382e94a59SJoachim Protze // loc_ref: source location information; points to end of task block.
102482e94a59SJoachim Protze // gtid: global thread number.
102582e94a59SJoachim Protze // task: task thunk for the completed task.
102682e94a59SJoachim Protze void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
102782e94a59SJoachim Protze                                   kmp_task_t *task) {
102882e94a59SJoachim Protze #if OMPT_SUPPORT
102982e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
103082e94a59SJoachim Protze     __kmpc_omp_task_complete_if0_ompt(loc_ref, gtid, task);
103182e94a59SJoachim Protze     return;
103282e94a59SJoachim Protze   }
103382e94a59SJoachim Protze #endif
103482e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<false>(loc_ref, gtid, task);
103582e94a59SJoachim Protze }
103682e94a59SJoachim Protze 
10377cc577a4SJonathan Peyton #ifdef TASK_UNUSED
10387cc577a4SJonathan Peyton // __kmpc_omp_task_complete: report that a task has completed execution
10397cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
10403041982dSJonathan Peyton void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
10413041982dSJonathan Peyton                               kmp_task_t *task) {
10423041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(enter): T#%d loc=%p task=%p\n", gtid,
10433041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10447cc577a4SJonathan Peyton 
104586ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task,
104686ed6aa6SJoachim Protze                            NULL); // Not sure how to find task to resume
10477cc577a4SJonathan Peyton 
10483041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(exit): T#%d loc=%p task=%p\n", gtid,
10493041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10507cc577a4SJonathan Peyton   return;
10517cc577a4SJonathan Peyton }
10527cc577a4SJonathan Peyton #endif // TASK_UNUSED
10537cc577a4SJonathan Peyton 
10543041982dSJonathan Peyton // __kmp_init_implicit_task: Initialize the appropriate fields in the implicit
10553041982dSJonathan Peyton // task for a given thread
10567cc577a4SJonathan Peyton //
10577cc577a4SJonathan Peyton // loc_ref:  reference to source location of parallel region
10587cc577a4SJonathan Peyton // this_thr:  thread data structure corresponding to implicit task
10597cc577a4SJonathan Peyton // team: team for this_thr
10607cc577a4SJonathan Peyton // tid: thread id of given thread within team
10617cc577a4SJonathan Peyton // set_curr_task: TRUE if need to push current task to thread
10623041982dSJonathan Peyton // NOTE: Routine does not set up the implicit task ICVS.  This is assumed to
10633041982dSJonathan Peyton // have already been done elsewhere.
10647cc577a4SJonathan Peyton // TODO: Get better loc_ref.  Value passed in may be NULL
10653041982dSJonathan Peyton void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
10663041982dSJonathan Peyton                               kmp_team_t *team, int tid, int set_curr_task) {
10677cc577a4SJonathan Peyton   kmp_taskdata_t *task = &team->t.t_implicit_task_taskdata[tid];
10687cc577a4SJonathan Peyton 
10693041982dSJonathan Peyton   KF_TRACE(
10703041982dSJonathan Peyton       10,
10713041982dSJonathan Peyton       ("__kmp_init_implicit_task(enter): T#:%d team=%p task=%p, reinit=%s\n",
10727cc577a4SJonathan Peyton        tid, team, task, set_curr_task ? "TRUE" : "FALSE"));
10737cc577a4SJonathan Peyton 
10747cc577a4SJonathan Peyton   task->td_task_id = KMP_GEN_TASK_ID();
10757cc577a4SJonathan Peyton   task->td_team = team;
10763041982dSJonathan Peyton   //    task->td_parent   = NULL;  // fix for CQ230101 (broken parent task info
10773041982dSJonathan Peyton   //    in debugger)
10787cc577a4SJonathan Peyton   task->td_ident = loc_ref;
10797cc577a4SJonathan Peyton   task->td_taskwait_ident = NULL;
10807cc577a4SJonathan Peyton   task->td_taskwait_counter = 0;
10817cc577a4SJonathan Peyton   task->td_taskwait_thread = 0;
10827cc577a4SJonathan Peyton 
10837cc577a4SJonathan Peyton   task->td_flags.tiedness = TASK_TIED;
10847cc577a4SJonathan Peyton   task->td_flags.tasktype = TASK_IMPLICIT;
10857cc577a4SJonathan Peyton   task->td_flags.proxy = TASK_FULL;
10867cc577a4SJonathan Peyton 
10877cc577a4SJonathan Peyton   // All implicit tasks are executed immediately, not deferred
10887cc577a4SJonathan Peyton   task->td_flags.task_serial = 1;
10897cc577a4SJonathan Peyton   task->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
10907cc577a4SJonathan Peyton   task->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
10917cc577a4SJonathan Peyton 
10927cc577a4SJonathan Peyton   task->td_flags.started = 1;
10937cc577a4SJonathan Peyton   task->td_flags.executing = 1;
10947cc577a4SJonathan Peyton   task->td_flags.complete = 0;
10957cc577a4SJonathan Peyton   task->td_flags.freed = 0;
10967cc577a4SJonathan Peyton 
10977cc577a4SJonathan Peyton   task->td_depnode = NULL;
1098a756cb24SAndrey Churbanov   task->td_last_tied = task;
1099405037c4SAndrey Churbanov   task->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
11007cc577a4SJonathan Peyton 
11013041982dSJonathan Peyton   if (set_curr_task) { // only do this init first time thread is created
110237e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_incomplete_child_tasks, 0);
1103642688b6SJonathan Peyton     // Not used: don't need to deallocate implicit task
110437e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_allocated_child_tasks, 0);
11057cc577a4SJonathan Peyton     task->td_taskgroup = NULL; // An implicit task does not have taskgroup
11067cc577a4SJonathan Peyton     task->td_dephash = NULL;
11077cc577a4SJonathan Peyton     __kmp_push_current_task_to_thread(this_thr, team, tid);
11087cc577a4SJonathan Peyton   } else {
11097cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_incomplete_child_tasks == 0);
11107cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_allocated_child_tasks == 0);
11117cc577a4SJonathan Peyton   }
11127cc577a4SJonathan Peyton 
11137cc577a4SJonathan Peyton #if OMPT_SUPPORT
1114f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
111582e94a59SJoachim Protze     __ompt_task_init(task, tid);
11167cc577a4SJonathan Peyton #endif
11177cc577a4SJonathan Peyton 
11183041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_init_implicit_task(exit): T#:%d team=%p task=%p\n", tid,
11193041982dSJonathan Peyton                 team, task));
11207cc577a4SJonathan Peyton }
11217cc577a4SJonathan Peyton 
11223041982dSJonathan Peyton // __kmp_finish_implicit_task: Release resources associated to implicit tasks
11233041982dSJonathan Peyton // at the end of parallel regions. Some resources are kept for reuse in the next
11243041982dSJonathan Peyton // parallel region.
11257cc577a4SJonathan Peyton //
11263041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11273041982dSJonathan Peyton void __kmp_finish_implicit_task(kmp_info_t *thread) {
11287cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1129c3344345SAndrey Churbanov   if (task->td_dephash) {
1130c3344345SAndrey Churbanov     int children;
1131c3344345SAndrey Churbanov     task->td_flags.complete = 1;
1132c3344345SAndrey Churbanov     children = KMP_ATOMIC_LD_ACQ(&task->td_incomplete_child_tasks);
1133c3344345SAndrey Churbanov     kmp_tasking_flags_t flags_old = task->td_flags;
1134c3344345SAndrey Churbanov     if (children == 0 && flags_old.complete == 1) {
1135c3344345SAndrey Churbanov       kmp_tasking_flags_t flags_new = flags_old;
1136c3344345SAndrey Churbanov       flags_new.complete = 0;
1137c3344345SAndrey Churbanov       if (KMP_COMPARE_AND_STORE_ACQ32(RCAST(kmp_int32 *, &task->td_flags),
1138c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_old),
1139c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_new))) {
1140c3344345SAndrey Churbanov         KA_TRACE(100, ("__kmp_finish_implicit_task: T#%d cleans "
1141c3344345SAndrey Churbanov                        "dephash of implicit task %p\n",
1142c3344345SAndrey Churbanov                        thread->th.th_info.ds.ds_gtid, task));
11437cc577a4SJonathan Peyton         __kmp_dephash_free_entries(thread, task->td_dephash);
11447cc577a4SJonathan Peyton       }
1145c3344345SAndrey Churbanov     }
1146c3344345SAndrey Churbanov   }
1147c3344345SAndrey Churbanov }
11487cc577a4SJonathan Peyton 
11493041982dSJonathan Peyton // __kmp_free_implicit_task: Release resources associated to implicit tasks
11503041982dSJonathan Peyton // when these are destroyed regions
11517cc577a4SJonathan Peyton //
11523041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11533041982dSJonathan Peyton void __kmp_free_implicit_task(kmp_info_t *thread) {
11547cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1155bff8ded9SJonathan Peyton   if (task && task->td_dephash) {
11567cc577a4SJonathan Peyton     __kmp_dephash_free(thread, task->td_dephash);
11577cc577a4SJonathan Peyton     task->td_dephash = NULL;
11587cc577a4SJonathan Peyton   }
1159bff8ded9SJonathan Peyton }
11607cc577a4SJonathan Peyton 
11613041982dSJonathan Peyton // Round up a size to a power of two specified by val: Used to insert padding
11623041982dSJonathan Peyton // between structures co-allocated using a single malloc() call
11633041982dSJonathan Peyton static size_t __kmp_round_up_to_val(size_t size, size_t val) {
11647cc577a4SJonathan Peyton   if (size & (val - 1)) {
11657cc577a4SJonathan Peyton     size &= ~(val - 1);
11667cc577a4SJonathan Peyton     if (size <= KMP_SIZE_T_MAX - val) {
11677cc577a4SJonathan Peyton       size += val; // Round up if there is no overflow.
1168bd3a7633SJonathan Peyton     }
1169bd3a7633SJonathan Peyton   }
11707cc577a4SJonathan Peyton   return size;
11717cc577a4SJonathan Peyton } // __kmp_round_up_to_va
11727cc577a4SJonathan Peyton 
11737cc577a4SJonathan Peyton // __kmp_task_alloc: Allocate the taskdata and task data structures for a task
11747cc577a4SJonathan Peyton //
11757cc577a4SJonathan Peyton // loc_ref: source location information
11767cc577a4SJonathan Peyton // gtid: global thread number.
11773041982dSJonathan Peyton // flags: include tiedness & task type (explicit vs. implicit) of the ''new''
11783041982dSJonathan Peyton // task encountered. Converted from kmp_int32 to kmp_tasking_flags_t in routine.
11793041982dSJonathan Peyton // sizeof_kmp_task_t:  Size in bytes of kmp_task_t data structure including
11803041982dSJonathan Peyton // private vars accessed in task.
11813041982dSJonathan Peyton // sizeof_shareds:  Size in bytes of array of pointers to shared vars accessed
11823041982dSJonathan Peyton // in task.
11837cc577a4SJonathan Peyton // task_entry: Pointer to task code entry point generated by compiler.
11847cc577a4SJonathan Peyton // returns: a pointer to the allocated kmp_task_t structure (task).
11853041982dSJonathan Peyton kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
11863041982dSJonathan Peyton                              kmp_tasking_flags_t *flags,
11877cc577a4SJonathan Peyton                              size_t sizeof_kmp_task_t, size_t sizeof_shareds,
11883041982dSJonathan Peyton                              kmp_routine_entry_t task_entry) {
11897cc577a4SJonathan Peyton   kmp_task_t *task;
11907cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
11917cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
11929d64275aSShilei Tian   kmp_info_t *encountering_thread = thread;
11937cc577a4SJonathan Peyton   kmp_team_t *team = thread->th.th_team;
11947cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
11957cc577a4SJonathan Peyton   size_t shareds_offset;
11967cc577a4SJonathan Peyton 
11976bf84871SAndreyChurbanov   if (UNLIKELY(!TCR_4(__kmp_init_middle)))
119828226e7dSJonathan Peyton     __kmp_middle_initialize();
119928226e7dSJonathan Peyton 
12009d64275aSShilei Tian   if (flags->hidden_helper) {
12019d64275aSShilei Tian     if (__kmp_enable_hidden_helper) {
12029d64275aSShilei Tian       if (!TCR_4(__kmp_init_hidden_helper))
12039d64275aSShilei Tian         __kmp_hidden_helper_initialize();
12049d64275aSShilei Tian 
12059d64275aSShilei Tian       // For a hidden helper task encountered by a regular thread, we will push
12069d64275aSShilei Tian       // the task to the (gtid%__kmp_hidden_helper_threads_num)-th hidden helper
12079d64275aSShilei Tian       // thread.
12089d64275aSShilei Tian       if (!KMP_HIDDEN_HELPER_THREAD(gtid)) {
12099d64275aSShilei Tian         thread = __kmp_threads[KMP_GTID_TO_SHADOW_GTID(gtid)];
12109d64275aSShilei Tian         // We don't change the parent-child relation for hidden helper task as
12119d64275aSShilei Tian         // we need that to do per-task-region synchronization.
12129d64275aSShilei Tian       }
12139d64275aSShilei Tian     } else {
12149d64275aSShilei Tian       // If the hidden helper task is not enabled, reset the flag to FALSE.
12159d64275aSShilei Tian       flags->hidden_helper = FALSE;
12169d64275aSShilei Tian     }
12179d64275aSShilei Tian   }
12189d64275aSShilei Tian 
12197cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_task_alloc(enter): T#%d loc=%p, flags=(0x%x) "
12207cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12217cc577a4SJonathan Peyton                 gtid, loc_ref, *((kmp_int32 *)flags), sizeof_kmp_task_t,
12227cc577a4SJonathan Peyton                 sizeof_shareds, task_entry));
12237cc577a4SJonathan Peyton 
1224467f3924SHansang Bae   KMP_DEBUG_ASSERT(parent_task);
12257cc577a4SJonathan Peyton   if (parent_task->td_flags.final) {
12267cc577a4SJonathan Peyton     if (flags->merged_if0) {
12277cc577a4SJonathan Peyton     }
12287cc577a4SJonathan Peyton     flags->final = 1;
12297cc577a4SJonathan Peyton   }
12309d64275aSShilei Tian 
1231a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED && !team->t.t_serialized) {
1232a756cb24SAndrey Churbanov     // Untied task encountered causes the TSC algorithm to check entire deque of
1233a756cb24SAndrey Churbanov     // the victim thread. If no untied task encountered, then checking the head
1234a756cb24SAndrey Churbanov     // of the deque should be enough.
12359d64275aSShilei Tian     KMP_CHECK_UPDATE(
12369d64275aSShilei Tian         encountering_thread->th.th_task_team->tt.tt_untied_task_encountered, 1);
1237a756cb24SAndrey Churbanov   }
12387cc577a4SJonathan Peyton 
1239405037c4SAndrey Churbanov   // Detachable tasks are not proxy tasks yet but could be in the future. Doing
1240405037c4SAndrey Churbanov   // the tasking setup
1241405037c4SAndrey Churbanov   // when that happens is too late.
1242838dcdb5SAndreyChurbanov   if (UNLIKELY(flags->proxy == TASK_PROXY ||
1243838dcdb5SAndreyChurbanov                flags->detachable == TASK_DETACHABLE || flags->hidden_helper)) {
12447cc577a4SJonathan Peyton     if (flags->proxy == TASK_PROXY) {
12457cc577a4SJonathan Peyton       flags->tiedness = TASK_UNTIED;
12467cc577a4SJonathan Peyton       flags->merged_if0 = 1;
1247405037c4SAndrey Churbanov     }
12483041982dSJonathan Peyton     /* are we running in a sequential parallel or tskm_immediate_exec... we need
12493041982dSJonathan Peyton        tasking support enabled */
12509d64275aSShilei Tian     if ((encountering_thread->th.th_task_team) == NULL) {
12517cc577a4SJonathan Peyton       /* This should only happen if the team is serialized
12523041982dSJonathan Peyton           setup a task team and propagate it to the thread */
12537cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(team->t.t_serialized);
12543041982dSJonathan Peyton       KA_TRACE(30,
12553041982dSJonathan Peyton                ("T#%d creating task team in __kmp_task_alloc for proxy task\n",
12563041982dSJonathan Peyton                 gtid));
12573041982dSJonathan Peyton       __kmp_task_team_setup(
12589d64275aSShilei Tian           encountering_thread, team,
12593041982dSJonathan Peyton           1); // 1 indicates setup the current team regardless of nthreads
12609d64275aSShilei Tian       encountering_thread->th.th_task_team =
12619d64275aSShilei Tian           team->t.t_task_team[encountering_thread->th.th_task_state];
12627cc577a4SJonathan Peyton     }
12639d64275aSShilei Tian     kmp_task_team_t *task_team = encountering_thread->th.th_task_team;
12647cc577a4SJonathan Peyton 
12657cc577a4SJonathan Peyton     /* tasking must be enabled now as the task might not be pushed */
12667cc577a4SJonathan Peyton     if (!KMP_TASKING_ENABLED(task_team)) {
12673041982dSJonathan Peyton       KA_TRACE(
12683041982dSJonathan Peyton           30,
12693041982dSJonathan Peyton           ("T#%d enabling tasking in __kmp_task_alloc for proxy task\n", gtid));
12709d64275aSShilei Tian       __kmp_enable_tasking(task_team, encountering_thread);
12719d64275aSShilei Tian       kmp_int32 tid = encountering_thread->th.th_info.ds.ds_tid;
12727cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
12737cc577a4SJonathan Peyton       // No lock needed since only owner can allocate
12747cc577a4SJonathan Peyton       if (thread_data->td.td_deque == NULL) {
12759d64275aSShilei Tian         __kmp_alloc_task_deque(encountering_thread, thread_data);
12767cc577a4SJonathan Peyton       }
12777cc577a4SJonathan Peyton     }
12787cc577a4SJonathan Peyton 
12793c31b784SShilei Tian     if ((flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE) &&
12809d64275aSShilei Tian         task_team->tt.tt_found_proxy_tasks == FALSE)
12817cc577a4SJonathan Peyton       TCW_4(task_team->tt.tt_found_proxy_tasks, TRUE);
12829d64275aSShilei Tian     if (flags->hidden_helper &&
12839d64275aSShilei Tian         task_team->tt.tt_hidden_helper_task_encountered == FALSE)
12849d64275aSShilei Tian       TCW_4(task_team->tt.tt_hidden_helper_task_encountered, TRUE);
12857cc577a4SJonathan Peyton   }
12867cc577a4SJonathan Peyton 
12877cc577a4SJonathan Peyton   // Calculate shared structure offset including padding after kmp_task_t struct
12887cc577a4SJonathan Peyton   // to align pointers in shared struct
12897cc577a4SJonathan Peyton   shareds_offset = sizeof(kmp_taskdata_t) + sizeof_kmp_task_t;
12907cc577a4SJonathan Peyton   shareds_offset = __kmp_round_up_to_val(shareds_offset, sizeof(void *));
12917cc577a4SJonathan Peyton 
12927cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
12933041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d First malloc size: %ld\n", gtid,
12943041982dSJonathan Peyton                 shareds_offset));
12953041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d Second malloc size: %ld\n", gtid,
12963041982dSJonathan Peyton                 sizeof_shareds));
12977cc577a4SJonathan Peyton 
12987cc577a4SJonathan Peyton   // Avoid double allocation here by combining shareds with taskdata
12997cc577a4SJonathan Peyton #if USE_FAST_MEMORY
13009d64275aSShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(
13019d64275aSShilei Tian       encountering_thread, shareds_offset + sizeof_shareds);
13027cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
13039d64275aSShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(
13049d64275aSShilei Tian       encountering_thread, shareds_offset + sizeof_shareds);
13057cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
13067cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_AFTER(taskdata);
13077cc577a4SJonathan Peyton 
13087cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
13097cc577a4SJonathan Peyton 
13107cc577a4SJonathan Peyton // Make sure task & taskdata are aligned appropriately
13117cc577a4SJonathan Peyton #if KMP_ARCH_X86 || KMP_ARCH_PPC64 || !KMP_HAVE_QUAD
13127cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(double) - 1)) == 0);
13137cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(double) - 1)) == 0);
13147cc577a4SJonathan Peyton #else
13157cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(_Quad) - 1)) == 0);
13167cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(_Quad) - 1)) == 0);
13177cc577a4SJonathan Peyton #endif
13187cc577a4SJonathan Peyton   if (sizeof_shareds > 0) {
13197cc577a4SJonathan Peyton     // Avoid double allocation here by combining shareds with taskdata
13207cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
13217cc577a4SJonathan Peyton     // Make sure shareds struct is aligned to pointer size
13223041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
13233041982dSJonathan Peyton                      0);
13247cc577a4SJonathan Peyton   } else {
13257cc577a4SJonathan Peyton     task->shareds = NULL;
13267cc577a4SJonathan Peyton   }
13277cc577a4SJonathan Peyton   task->routine = task_entry;
13287cc577a4SJonathan Peyton   task->part_id = 0; // AC: Always start with 0 part id
13297cc577a4SJonathan Peyton 
13307cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
13319d64275aSShilei Tian   taskdata->td_team = thread->th.th_team;
13329d64275aSShilei Tian   taskdata->td_alloc_thread = encountering_thread;
13337cc577a4SJonathan Peyton   taskdata->td_parent = parent_task;
13347cc577a4SJonathan Peyton   taskdata->td_level = parent_task->td_level + 1; // increment nesting level
133537e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_untied_count, 0);
13367cc577a4SJonathan Peyton   taskdata->td_ident = loc_ref;
13377cc577a4SJonathan Peyton   taskdata->td_taskwait_ident = NULL;
13387cc577a4SJonathan Peyton   taskdata->td_taskwait_counter = 0;
13397cc577a4SJonathan Peyton   taskdata->td_taskwait_thread = 0;
13407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_parent != NULL);
13417cc577a4SJonathan Peyton   // avoid copying icvs for proxy tasks
13427cc577a4SJonathan Peyton   if (flags->proxy == TASK_FULL)
13437cc577a4SJonathan Peyton     copy_icvs(&taskdata->td_icvs, &taskdata->td_parent->td_icvs);
13447cc577a4SJonathan Peyton 
13457cc577a4SJonathan Peyton   taskdata->td_flags.tiedness = flags->tiedness;
13467cc577a4SJonathan Peyton   taskdata->td_flags.final = flags->final;
13477cc577a4SJonathan Peyton   taskdata->td_flags.merged_if0 = flags->merged_if0;
13487cc577a4SJonathan Peyton   taskdata->td_flags.destructors_thunk = flags->destructors_thunk;
13497cc577a4SJonathan Peyton   taskdata->td_flags.proxy = flags->proxy;
1350405037c4SAndrey Churbanov   taskdata->td_flags.detachable = flags->detachable;
13519d64275aSShilei Tian   taskdata->td_flags.hidden_helper = flags->hidden_helper;
13529d64275aSShilei Tian   taskdata->encountering_gtid = gtid;
13537cc577a4SJonathan Peyton   taskdata->td_task_team = thread->th.th_task_team;
13547cc577a4SJonathan Peyton   taskdata->td_size_alloc = shareds_offset + sizeof_shareds;
13557cc577a4SJonathan Peyton   taskdata->td_flags.tasktype = TASK_EXPLICIT;
13567cc577a4SJonathan Peyton 
13577cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of tasking_ser flag
13587cc577a4SJonathan Peyton   taskdata->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
13597cc577a4SJonathan Peyton 
13607cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of team_serial flag
13617cc577a4SJonathan Peyton   taskdata->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
13627cc577a4SJonathan Peyton 
13633041982dSJonathan Peyton   // GEH - Note we serialize the task if the team is serialized to make sure
13643041982dSJonathan Peyton   // implicit parallel region tasks are not left until program termination to
13653041982dSJonathan Peyton   // execute. Also, it helps locality to execute immediately.
13663041982dSJonathan Peyton 
13673041982dSJonathan Peyton   taskdata->td_flags.task_serial =
13683041982dSJonathan Peyton       (parent_task->td_flags.final || taskdata->td_flags.team_serial ||
1369add8d90cSJoachim Protze        taskdata->td_flags.tasking_ser || flags->merged_if0);
13707cc577a4SJonathan Peyton 
13717cc577a4SJonathan Peyton   taskdata->td_flags.started = 0;
13727cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0;
13737cc577a4SJonathan Peyton   taskdata->td_flags.complete = 0;
13747cc577a4SJonathan Peyton   taskdata->td_flags.freed = 0;
13757cc577a4SJonathan Peyton 
13767cc577a4SJonathan Peyton   taskdata->td_flags.native = flags->native;
13777cc577a4SJonathan Peyton 
137837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_incomplete_child_tasks, 0);
137937e2ef54SJonathan Peyton   // start at one because counts current task and children
138037e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_allocated_child_tasks, 1);
13813041982dSJonathan Peyton   taskdata->td_taskgroup =
13823041982dSJonathan Peyton       parent_task->td_taskgroup; // task inherits taskgroup from the parent task
13837cc577a4SJonathan Peyton   taskdata->td_dephash = NULL;
13847cc577a4SJonathan Peyton   taskdata->td_depnode = NULL;
1385a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED)
1386a756cb24SAndrey Churbanov     taskdata->td_last_tied = NULL; // will be set when the task is scheduled
1387a756cb24SAndrey Churbanov   else
1388a756cb24SAndrey Churbanov     taskdata->td_last_tied = taskdata;
1389405037c4SAndrey Churbanov   taskdata->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
139086ed6aa6SJoachim Protze #if OMPT_SUPPORT
139186ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled))
139286ed6aa6SJoachim Protze     __ompt_task_init(taskdata, gtid);
139386ed6aa6SJoachim Protze #endif
13949d64275aSShilei Tian   // Only need to keep track of child task counts if team parallel and tasking
13959d64275aSShilei Tian   // not serialized or if it is a proxy or detachable or hidden helper task
13969d64275aSShilei Tian   if (flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE ||
13979d64275aSShilei Tian       flags->hidden_helper ||
13989d64275aSShilei Tian       !(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
139937e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
14007cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
140137e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
14023041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
14033041982dSJonathan Peyton     // implicit not deallocated
14047cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT) {
140537e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
14067cc577a4SJonathan Peyton     }
14077cc577a4SJonathan Peyton   }
14087cc577a4SJonathan Peyton 
14099d64275aSShilei Tian   if (flags->hidden_helper) {
14109d64275aSShilei Tian     taskdata->td_flags.task_serial = FALSE;
14119d64275aSShilei Tian     // Increment the number of hidden helper tasks to be executed
14129d64275aSShilei Tian     KMP_ATOMIC_INC(&__kmp_unexecuted_hidden_helper_tasks);
14139d64275aSShilei Tian   }
14149d64275aSShilei Tian 
14157cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_task_alloc(exit): T#%d created task %p parent=%p\n",
14167cc577a4SJonathan Peyton                 gtid, taskdata, taskdata->td_parent));
14177cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(task);
14187cc577a4SJonathan Peyton 
14197cc577a4SJonathan Peyton   return task;
14207cc577a4SJonathan Peyton }
14217cc577a4SJonathan Peyton 
14223041982dSJonathan Peyton kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
14233041982dSJonathan Peyton                                   kmp_int32 flags, size_t sizeof_kmp_task_t,
14243041982dSJonathan Peyton                                   size_t sizeof_shareds,
14253041982dSJonathan Peyton                                   kmp_routine_entry_t task_entry) {
14267cc577a4SJonathan Peyton   kmp_task_t *retval;
14277cc577a4SJonathan Peyton   kmp_tasking_flags_t *input_flags = (kmp_tasking_flags_t *)&flags;
1428787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
14297cc577a4SJonathan Peyton   input_flags->native = FALSE;
14307cc577a4SJonathan Peyton   // __kmp_task_alloc() sets up all other runtime flags
1431405037c4SAndrey Churbanov   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s %s %s) "
1432405037c4SAndrey Churbanov                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
1433405037c4SAndrey Churbanov                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
1434405037c4SAndrey Churbanov                 input_flags->proxy ? "proxy" : "",
1435405037c4SAndrey Churbanov                 input_flags->detachable ? "detachable" : "", sizeof_kmp_task_t,
1436405037c4SAndrey Churbanov                 sizeof_shareds, task_entry));
14377cc577a4SJonathan Peyton 
14387cc577a4SJonathan Peyton   retval = __kmp_task_alloc(loc_ref, gtid, input_flags, sizeof_kmp_task_t,
14397cc577a4SJonathan Peyton                             sizeof_shareds, task_entry);
14407cc577a4SJonathan Peyton 
14417cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmpc_omp_task_alloc(exit): T#%d retval %p\n", gtid, retval));
14427cc577a4SJonathan Peyton 
14437cc577a4SJonathan Peyton   return retval;
14447cc577a4SJonathan Peyton }
14457cc577a4SJonathan Peyton 
1446b48e44a6SGheorghe-Teodor Bercea kmp_task_t *__kmpc_omp_target_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
1447b48e44a6SGheorghe-Teodor Bercea                                          kmp_int32 flags,
1448b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_kmp_task_t,
1449b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_shareds,
1450b48e44a6SGheorghe-Teodor Bercea                                          kmp_routine_entry_t task_entry,
1451b48e44a6SGheorghe-Teodor Bercea                                          kmp_int64 device_id) {
14529d64275aSShilei Tian   if (__kmp_enable_hidden_helper) {
14539d64275aSShilei Tian     auto &input_flags = reinterpret_cast<kmp_tasking_flags_t &>(flags);
14549d64275aSShilei Tian     input_flags.hidden_helper = TRUE;
14559d64275aSShilei Tian   }
14569d64275aSShilei Tian 
1457b48e44a6SGheorghe-Teodor Bercea   return __kmpc_omp_task_alloc(loc_ref, gtid, flags, sizeof_kmp_task_t,
1458b48e44a6SGheorghe-Teodor Bercea                                sizeof_shareds, task_entry);
1459b48e44a6SGheorghe-Teodor Bercea }
1460b48e44a6SGheorghe-Teodor Bercea 
1461b04f7d68SJonathan Peyton /*!
1462b04f7d68SJonathan Peyton @ingroup TASKING
1463b04f7d68SJonathan Peyton @param loc_ref location of the original task directive
1464b04f7d68SJonathan Peyton @param gtid Global Thread ID of encountering thread
1465b04f7d68SJonathan Peyton @param new_task task thunk allocated by __kmpc_omp_task_alloc() for the ''new
1466b04f7d68SJonathan Peyton task''
1467b04f7d68SJonathan Peyton @param naffins Number of affinity items
1468b04f7d68SJonathan Peyton @param affin_list List of affinity items
1469b04f7d68SJonathan Peyton @return Returns non-zero if registering affinity information was not successful.
1470b04f7d68SJonathan Peyton  Returns 0 if registration was successful
1471b04f7d68SJonathan Peyton This entry registers the affinity information attached to a task with the task
1472b04f7d68SJonathan Peyton thunk structure kmp_taskdata_t.
1473b04f7d68SJonathan Peyton */
1474b04f7d68SJonathan Peyton kmp_int32
1475b04f7d68SJonathan Peyton __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref, kmp_int32 gtid,
1476b04f7d68SJonathan Peyton                                   kmp_task_t *new_task, kmp_int32 naffins,
1477b04f7d68SJonathan Peyton                                   kmp_task_affinity_info_t *affin_list) {
1478b04f7d68SJonathan Peyton   return 0;
1479b04f7d68SJonathan Peyton }
1480b04f7d68SJonathan Peyton 
14817cc577a4SJonathan Peyton //  __kmp_invoke_task: invoke the specified task
14827cc577a4SJonathan Peyton //
14837cc577a4SJonathan Peyton // gtid: global thread ID of caller
14847cc577a4SJonathan Peyton // task: the task to invoke
148542016791SKazuaki Ishizaki // current_task: the task to resume after task invocation
14863041982dSJonathan Peyton static void __kmp_invoke_task(kmp_int32 gtid, kmp_task_t *task,
14873041982dSJonathan Peyton                               kmp_taskdata_t *current_task) {
14887cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
1489b1b221c8SJonathan Peyton   kmp_info_t *thread;
14907cc577a4SJonathan Peyton   int discard = 0 /* false */;
14913041982dSJonathan Peyton   KA_TRACE(
14923041982dSJonathan Peyton       30, ("__kmp_invoke_task(enter): T#%d invoking task %p, current_task=%p\n",
14937cc577a4SJonathan Peyton            gtid, taskdata, current_task));
14947cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task);
14956bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.proxy == TASK_PROXY &&
14966bf84871SAndreyChurbanov                taskdata->td_flags.complete == 1)) {
14977cc577a4SJonathan Peyton     // This is a proxy task that was already completed but it needs to run
14987cc577a4SJonathan Peyton     // its bottom-half finish
14993041982dSJonathan Peyton     KA_TRACE(
15003041982dSJonathan Peyton         30,
15013041982dSJonathan Peyton         ("__kmp_invoke_task: T#%d running bottom finish for proxy task %p\n",
15027cc577a4SJonathan Peyton          gtid, taskdata));
15037cc577a4SJonathan Peyton 
15047cc577a4SJonathan Peyton     __kmp_bottom_half_finish_proxy(gtid, task);
15057cc577a4SJonathan Peyton 
15063041982dSJonathan Peyton     KA_TRACE(30, ("__kmp_invoke_task(exit): T#%d completed bottom finish for "
15073041982dSJonathan Peyton                   "proxy task %p, resuming task %p\n",
15083041982dSJonathan Peyton                   gtid, taskdata, current_task));
15097cc577a4SJonathan Peyton 
15107cc577a4SJonathan Peyton     return;
15117cc577a4SJonathan Peyton   }
15127cc577a4SJonathan Peyton 
15137cc577a4SJonathan Peyton #if OMPT_SUPPORT
151486ed6aa6SJoachim Protze   // For untied tasks, the first task executed only calls __kmpc_omp_task and
151586ed6aa6SJoachim Protze   // does not execute code.
15167cc577a4SJonathan Peyton   ompt_thread_info_t oldInfo;
1517f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
15187cc577a4SJonathan Peyton     // Store the threads states and restore them after the task
15197cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
15207cc577a4SJonathan Peyton     oldInfo = thread->th.ompt_thread_info;
15217cc577a4SJonathan Peyton     thread->th.ompt_thread_info.wait_id = 0;
152282e94a59SJoachim Protze     thread->th.ompt_thread_info.state = (thread->th.th_team_serialized)
15230e0d6cddSJoachim Protze                                             ? ompt_state_work_serial
15240e0d6cddSJoachim Protze                                             : ompt_state_work_parallel;
15250e0d6cddSJoachim Protze     taskdata->ompt_task_info.frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
15267cc577a4SJonathan Peyton   }
15277cc577a4SJonathan Peyton #endif
15287cc577a4SJonathan Peyton 
15299d64275aSShilei Tian   // Decreament the counter of hidden helper tasks to be executed
15309d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
15319d64275aSShilei Tian     // Hidden helper tasks can only be executed by hidden helper threads
15329d64275aSShilei Tian     KMP_ASSERT(KMP_HIDDEN_HELPER_THREAD(gtid));
15339d64275aSShilei Tian     KMP_ATOMIC_DEC(&__kmp_unexecuted_hidden_helper_tasks);
15349d64275aSShilei Tian   }
15359d64275aSShilei Tian 
153686ed6aa6SJoachim Protze   // Proxy tasks are not handled by the runtime
153786ed6aa6SJoachim Protze   if (taskdata->td_flags.proxy != TASK_PROXY) {
153886ed6aa6SJoachim Protze     ANNOTATE_HAPPENS_AFTER(task);
153986ed6aa6SJoachim Protze     __kmp_task_start(gtid, task, current_task); // OMPT only if not discarded
154086ed6aa6SJoachim Protze   }
154186ed6aa6SJoachim Protze 
15427cc577a4SJonathan Peyton   // TODO: cancel tasks if the parallel region has also been cancelled
15437cc577a4SJonathan Peyton   // TODO: check if this sequence can be hoisted above __kmp_task_start
15447cc577a4SJonathan Peyton   // if cancellation has been enabled for this run ...
15456bf84871SAndreyChurbanov   if (UNLIKELY(__kmp_omp_cancellation)) {
1546b1b221c8SJonathan Peyton     thread = __kmp_threads[gtid];
1547b1b221c8SJonathan Peyton     kmp_team_t *this_team = thread->th.th_team;
15487cc577a4SJonathan Peyton     kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
15493041982dSJonathan Peyton     if ((taskgroup && taskgroup->cancel_request) ||
15503041982dSJonathan Peyton         (this_team->t.t_cancel_request == cancel_parallel)) {
155182e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
155282e94a59SJoachim Protze       ompt_data_t *task_data;
1553f0a1c65fSJonas Hahnfeld       if (UNLIKELY(ompt_enabled.ompt_callback_cancel)) {
155482e94a59SJoachim Protze         __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
155582e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_cancel)(
155682e94a59SJoachim Protze             task_data,
155782e94a59SJoachim Protze             ((taskgroup && taskgroup->cancel_request) ? ompt_cancel_taskgroup
155882e94a59SJoachim Protze                                                       : ompt_cancel_parallel) |
155982e94a59SJoachim Protze                 ompt_cancel_discarded_task,
156082e94a59SJoachim Protze             NULL);
156182e94a59SJoachim Protze       }
156282e94a59SJoachim Protze #endif
15637cc577a4SJonathan Peyton       KMP_COUNT_BLOCK(TASK_cancelled);
15647cc577a4SJonathan Peyton       // this task belongs to a task group and we need to cancel it
15657cc577a4SJonathan Peyton       discard = 1 /* true */;
15667cc577a4SJonathan Peyton     }
15677cc577a4SJonathan Peyton   }
15687cc577a4SJonathan Peyton 
15697cc577a4SJonathan Peyton   // Invoke the task routine and pass in relevant data.
15707cc577a4SJonathan Peyton   // Thunks generated by gcc take a different argument list.
15717cc577a4SJonathan Peyton   if (!discard) {
1572a756cb24SAndrey Churbanov     if (taskdata->td_flags.tiedness == TASK_UNTIED) {
1573a756cb24SAndrey Churbanov       taskdata->td_last_tied = current_task->td_last_tied;
1574a756cb24SAndrey Churbanov       KMP_DEBUG_ASSERT(taskdata->td_last_tied);
1575a756cb24SAndrey Churbanov     }
15767cc577a4SJonathan Peyton #if KMP_STATS_ENABLED
15777cc577a4SJonathan Peyton     KMP_COUNT_BLOCK(TASK_executed);
15787cc577a4SJonathan Peyton     switch (KMP_GET_THREAD_STATE()) {
15793041982dSJonathan Peyton     case FORK_JOIN_BARRIER:
15803041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_join_bar);
15813041982dSJonathan Peyton       break;
15823041982dSJonathan Peyton     case PLAIN_BARRIER:
15833041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_plain_bar);
15843041982dSJonathan Peyton       break;
15853041982dSJonathan Peyton     case TASKYIELD:
15863041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskyield);
15873041982dSJonathan Peyton       break;
15883041982dSJonathan Peyton     case TASKWAIT:
15893041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskwait);
15903041982dSJonathan Peyton       break;
15913041982dSJonathan Peyton     case TASKGROUP:
15923041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskgroup);
15933041982dSJonathan Peyton       break;
15943041982dSJonathan Peyton     default:
15953041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_immediate);
15963041982dSJonathan Peyton       break;
15977cc577a4SJonathan Peyton     }
15987cc577a4SJonathan Peyton #endif // KMP_STATS_ENABLED
15997cc577a4SJonathan Peyton 
160082e94a59SJoachim Protze // OMPT task begin
160182e94a59SJoachim Protze #if OMPT_SUPPORT
1602f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.enabled))
160382e94a59SJoachim Protze       __ompt_task_start(task, current_task, gtid);
16047cc577a4SJonathan Peyton #endif
16057cc577a4SJonathan Peyton 
1606b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1607b1b221c8SJonathan Peyton     kmp_uint64 cur_time;
1608b1b221c8SJonathan Peyton     kmp_int32 kmp_itt_count_task =
1609b1b221c8SJonathan Peyton         __kmp_forkjoin_frames_mode == 3 && !taskdata->td_flags.task_serial &&
1610b1b221c8SJonathan Peyton         current_task->td_flags.tasktype == TASK_IMPLICIT;
1611b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1612b1b221c8SJonathan Peyton       thread = __kmp_threads[gtid];
1613b1b221c8SJonathan Peyton       // Time outer level explicit task on barrier for adjusting imbalance time
1614b1b221c8SJonathan Peyton       if (thread->th.th_bar_arrive_time)
1615b1b221c8SJonathan Peyton         cur_time = __itt_get_timestamp();
1616b1b221c8SJonathan Peyton       else
1617b1b221c8SJonathan Peyton         kmp_itt_count_task = 0; // thread is not on a barrier - skip timing
1618b1b221c8SJonathan Peyton     }
1619ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquired self (new task)
1620b1b221c8SJonathan Peyton #endif
1621b1b221c8SJonathan Peyton 
16227cc577a4SJonathan Peyton #ifdef KMP_GOMP_COMPAT
16237cc577a4SJonathan Peyton     if (taskdata->td_flags.native) {
16247cc577a4SJonathan Peyton       ((void (*)(void *))(*(task->routine)))(task->shareds);
16253041982dSJonathan Peyton     } else
16267cc577a4SJonathan Peyton #endif /* KMP_GOMP_COMPAT */
16277cc577a4SJonathan Peyton     {
16287cc577a4SJonathan Peyton       (*(task->routine))(gtid, task);
16297cc577a4SJonathan Peyton     }
16307cc577a4SJonathan Peyton     KMP_POP_PARTITIONED_TIMER();
16317cc577a4SJonathan Peyton 
1632b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1633b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1634b1b221c8SJonathan Peyton       // Barrier imbalance - adjust arrive time with the task duration
1635b1b221c8SJonathan Peyton       thread->th.th_bar_arrive_time += (__itt_get_timestamp() - cur_time);
1636b1b221c8SJonathan Peyton     }
1637ffd8f009SAndreyChurbanov     KMP_FSYNC_CANCEL(taskdata); // destroy self (just executed)
1638ffd8f009SAndreyChurbanov     KMP_FSYNC_RELEASING(taskdata->td_parent); // releasing parent
1639b1b221c8SJonathan Peyton #endif
16407cc577a4SJonathan Peyton   }
16417cc577a4SJonathan Peyton 
16427cc577a4SJonathan Peyton   // Proxy tasks are not handled by the runtime
16437cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy != TASK_PROXY) {
16447cc577a4SJonathan Peyton     ANNOTATE_HAPPENS_BEFORE(taskdata->td_parent);
164586ed6aa6SJoachim Protze #if OMPT_SUPPORT
164686ed6aa6SJoachim Protze     if (UNLIKELY(ompt_enabled.enabled)) {
164786ed6aa6SJoachim Protze       thread->th.ompt_thread_info = oldInfo;
164886ed6aa6SJoachim Protze       if (taskdata->td_flags.tiedness == TASK_TIED) {
16490e0d6cddSJoachim Protze         taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
165086ed6aa6SJoachim Protze       }
165186ed6aa6SJoachim Protze       __kmp_task_finish<true>(gtid, task, current_task);
165286ed6aa6SJoachim Protze     } else
165386ed6aa6SJoachim Protze #endif
165486ed6aa6SJoachim Protze       __kmp_task_finish<false>(gtid, task, current_task);
16557cc577a4SJonathan Peyton   }
16567cc577a4SJonathan Peyton 
16573041982dSJonathan Peyton   KA_TRACE(
16583041982dSJonathan Peyton       30,
16593041982dSJonathan Peyton       ("__kmp_invoke_task(exit): T#%d completed task %p, resuming task %p\n",
16607cc577a4SJonathan Peyton        gtid, taskdata, current_task));
16617cc577a4SJonathan Peyton   return;
16627cc577a4SJonathan Peyton }
16637cc577a4SJonathan Peyton 
16647cc577a4SJonathan Peyton // __kmpc_omp_task_parts: Schedule a thread-switchable task for execution
16657cc577a4SJonathan Peyton //
16667cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
16677cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
16687cc577a4SJonathan Peyton // new_task: task thunk allocated by __kmp_omp_task_alloc() for the ''new task''
16697cc577a4SJonathan Peyton // Returns:
16703041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
16713041982dSJonathan Peyton //    be resumed later.
16723041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
16733041982dSJonathan Peyton //    resumed later.
16743041982dSJonathan Peyton kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
16753041982dSJonathan Peyton                                 kmp_task_t *new_task) {
16767cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
16777cc577a4SJonathan Peyton 
16783041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_parts(enter): T#%d loc=%p task=%p\n", gtid,
16793041982dSJonathan Peyton                 loc_ref, new_taskdata));
16807cc577a4SJonathan Peyton 
168182e94a59SJoachim Protze #if OMPT_SUPPORT
168282e94a59SJoachim Protze   kmp_taskdata_t *parent;
1683f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
168482e94a59SJoachim Protze     parent = new_taskdata->td_parent;
168582e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
168682e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1687467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
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) {
1780309b00a4SShilei Tian         parent->ompt_task_info.frame.enter_frame.ptr =
1781309b00a4SShilei Tian             OMPT_GET_FRAME_ADDRESS(0);
178286ed6aa6SJoachim Protze       }
178382e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_task_create) {
178482e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1785467f3924SHansang Bae             &(parent->ompt_task_info.task_data),
1786467f3924SHansang Bae             &(parent->ompt_task_info.frame),
178782e94a59SJoachim Protze             &(new_taskdata->ompt_task_info.task_data),
178882e94a59SJoachim Protze             ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
178982e94a59SJoachim Protze             OMPT_LOAD_RETURN_ADDRESS(gtid));
179082e94a59SJoachim Protze       }
179186ed6aa6SJoachim Protze     } else {
179286ed6aa6SJoachim Protze       // We are scheduling the continuation of an UNTIED task.
179386ed6aa6SJoachim Protze       // Scheduling back to the parent task.
179486ed6aa6SJoachim Protze       __ompt_task_finish(new_task,
179586ed6aa6SJoachim Protze                          new_taskdata->ompt_task_info.scheduling_parent,
1796489cdb78SJoachim Protze                          ompt_task_switch);
17970e0d6cddSJoachim Protze       new_taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
179886ed6aa6SJoachim Protze     }
179982e94a59SJoachim Protze   }
180082e94a59SJoachim Protze #endif
180182e94a59SJoachim Protze 
18027cc577a4SJonathan Peyton   res = __kmp_omp_task(gtid, new_task, true);
18037cc577a4SJonathan Peyton 
18043041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
18053041982dSJonathan Peyton                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
18067cc577a4SJonathan Peyton                 gtid, loc_ref, new_taskdata));
180782e94a59SJoachim Protze #if OMPT_SUPPORT
1808f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18090e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
181082e94a59SJoachim Protze   }
181182e94a59SJoachim Protze #endif
18127cc577a4SJonathan Peyton   return res;
18137cc577a4SJonathan Peyton }
18147cc577a4SJonathan Peyton 
1815cdaefac5SJoachim Protze // __kmp_omp_taskloop_task: Wrapper around __kmp_omp_task to schedule
1816cdaefac5SJoachim Protze // a taskloop task with the correct OMPT return address
1817cdaefac5SJoachim Protze //
1818cdaefac5SJoachim Protze // loc_ref: location of original task pragma (ignored)
1819cdaefac5SJoachim Protze // gtid: Global Thread ID of encountering thread
1820cdaefac5SJoachim Protze // new_task: non-thread-switchable task thunk allocated by
1821cdaefac5SJoachim Protze // __kmp_omp_task_alloc()
1822cdaefac5SJoachim Protze // codeptr_ra: return address for OMPT callback
1823cdaefac5SJoachim Protze // Returns:
1824cdaefac5SJoachim Protze //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
1825cdaefac5SJoachim Protze //    be resumed later.
1826cdaefac5SJoachim Protze //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
1827cdaefac5SJoachim Protze //    resumed later.
1828cdaefac5SJoachim Protze kmp_int32 __kmp_omp_taskloop_task(ident_t *loc_ref, kmp_int32 gtid,
1829cdaefac5SJoachim Protze                                   kmp_task_t *new_task, void *codeptr_ra) {
1830cdaefac5SJoachim Protze   kmp_int32 res;
1831cdaefac5SJoachim Protze   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
1832cdaefac5SJoachim Protze 
1833cdaefac5SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
1834cdaefac5SJoachim Protze   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
1835cdaefac5SJoachim Protze #endif
1836cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
1837cdaefac5SJoachim Protze                 new_taskdata));
1838cdaefac5SJoachim Protze 
1839cdaefac5SJoachim Protze #if OMPT_SUPPORT
1840cdaefac5SJoachim Protze   kmp_taskdata_t *parent = NULL;
1841cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && !new_taskdata->td_flags.started)) {
1842cdaefac5SJoachim Protze     parent = new_taskdata->td_parent;
18430e0d6cddSJoachim Protze     if (!parent->ompt_task_info.frame.enter_frame.ptr)
18440e0d6cddSJoachim Protze       parent->ompt_task_info.frame.enter_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
1845cdaefac5SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
1846cdaefac5SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1847467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
1848cdaefac5SJoachim Protze           &(new_taskdata->ompt_task_info.task_data),
1849cdaefac5SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
1850cdaefac5SJoachim Protze           codeptr_ra);
1851cdaefac5SJoachim Protze     }
1852cdaefac5SJoachim Protze   }
1853cdaefac5SJoachim Protze #endif
1854cdaefac5SJoachim Protze 
1855cdaefac5SJoachim Protze   res = __kmp_omp_task(gtid, new_task, true);
1856cdaefac5SJoachim Protze 
1857cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
1858cdaefac5SJoachim Protze                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
1859cdaefac5SJoachim Protze                 gtid, loc_ref, new_taskdata));
1860cdaefac5SJoachim Protze #if OMPT_SUPPORT
1861cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18620e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
1863cdaefac5SJoachim Protze   }
1864cdaefac5SJoachim Protze #endif
1865cdaefac5SJoachim Protze   return res;
1866cdaefac5SJoachim Protze }
1867cdaefac5SJoachim Protze 
186882e94a59SJoachim Protze template <bool ompt>
186982e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_template(ident_t *loc_ref, kmp_int32 gtid,
187082e94a59SJoachim Protze                                               void *frame_address,
187182e94a59SJoachim Protze                                               void *return_address) {
1872467f3924SHansang Bae   kmp_taskdata_t *taskdata = nullptr;
18737cc577a4SJonathan Peyton   kmp_info_t *thread;
18747cc577a4SJonathan Peyton   int thread_finished = FALSE;
18757cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKWAIT);
18767cc577a4SJonathan Peyton 
18777cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(enter): T#%d loc=%p\n", gtid, loc_ref));
1878838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
18797cc577a4SJonathan Peyton 
18807cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
18817cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
18827cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
18837cc577a4SJonathan Peyton 
188482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
188582e94a59SJoachim Protze     ompt_data_t *my_task_data;
188682e94a59SJoachim Protze     ompt_data_t *my_parallel_data;
18877cc577a4SJonathan Peyton 
188882e94a59SJoachim Protze     if (ompt) {
188982e94a59SJoachim Protze       my_task_data = &(taskdata->ompt_task_info.task_data);
189082e94a59SJoachim Protze       my_parallel_data = OMPT_CUR_TEAM_DATA(thread);
189182e94a59SJoachim Protze 
18920e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame.ptr = frame_address;
189382e94a59SJoachim Protze 
189482e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
189582e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
189682e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
189782e94a59SJoachim Protze             my_task_data, return_address);
189882e94a59SJoachim Protze       }
189982e94a59SJoachim Protze 
190082e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
190182e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
190282e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
190382e94a59SJoachim Protze             my_task_data, return_address);
19047cc577a4SJonathan Peyton       }
19057cc577a4SJonathan Peyton     }
190682e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
19077cc577a4SJonathan Peyton 
19083041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
19093041982dSJonathan Peyton // taskwait.
19107cc577a4SJonathan Peyton #if USE_ITT_BUILD
19117cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
19127cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19137cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
19147cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
19157cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
19167cc577a4SJonathan Peyton 
19177cc577a4SJonathan Peyton #if USE_ITT_BUILD
1918838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
1919838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
1920838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
1921838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
19227cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19237cc577a4SJonathan Peyton 
19243041982dSJonathan Peyton     bool must_wait =
19253041982dSJonathan Peyton         !taskdata->td_flags.team_serial && !taskdata->td_flags.final;
19267cc577a4SJonathan Peyton 
19273041982dSJonathan Peyton     must_wait = must_wait || (thread->th.th_task_team != NULL &&
19283041982dSJonathan Peyton                               thread->th.th_task_team->tt.tt_found_proxy_tasks);
19299d64275aSShilei Tian     // If hidden helper thread is encountered, we must enable wait here.
19309d64275aSShilei Tian     must_wait =
19319d64275aSShilei Tian         must_wait ||
19329d64275aSShilei Tian         (__kmp_enable_hidden_helper && thread->th.th_task_team != NULL &&
19339d64275aSShilei Tian          thread->th.th_task_team->tt.tt_hidden_helper_task_encountered);
19349d64275aSShilei Tian 
19353041982dSJonathan Peyton     if (must_wait) {
1936e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
1937e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
193837e2ef54SJonathan Peyton                 &(taskdata->td_incomplete_child_tasks)),
1939c47afcd9SAndrey Churbanov           0U);
194037e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) != 0) {
19413041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
19423041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
19433041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
19447cc577a4SJonathan Peyton       }
19457cc577a4SJonathan Peyton     }
19467cc577a4SJonathan Peyton #if USE_ITT_BUILD
1947838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
1948ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with children
19497cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19507cc577a4SJonathan Peyton 
19513041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
19523041982dSJonathan Peyton     // negated.
19537cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
19547cc577a4SJonathan Peyton 
195582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
195682e94a59SJoachim Protze     if (ompt) {
195782e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
195882e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
195982e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
196082e94a59SJoachim Protze             my_task_data, return_address);
196182e94a59SJoachim Protze       }
196282e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
196382e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
196482e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
196582e94a59SJoachim Protze             my_task_data, return_address);
19667cc577a4SJonathan Peyton       }
19670e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = ompt_data_none;
19687cc577a4SJonathan Peyton     }
196982e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
197082e94a59SJoachim Protze 
19717cc577a4SJonathan Peyton     ANNOTATE_HAPPENS_AFTER(taskdata);
19727cc577a4SJonathan Peyton   }
19737cc577a4SJonathan Peyton 
19747cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(exit): T#%d task %p finished waiting, "
19753041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
19763041982dSJonathan Peyton                 gtid, taskdata));
19777cc577a4SJonathan Peyton 
19787cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
19797cc577a4SJonathan Peyton }
19807cc577a4SJonathan Peyton 
1981489cdb78SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
198282e94a59SJoachim Protze OMPT_NOINLINE
198382e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_ompt(ident_t *loc_ref, kmp_int32 gtid,
198482e94a59SJoachim Protze                                           void *frame_address,
198582e94a59SJoachim Protze                                           void *return_address) {
198682e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<true>(loc_ref, gtid, frame_address,
198782e94a59SJoachim Protze                                             return_address);
198882e94a59SJoachim Protze }
1989489cdb78SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
199082e94a59SJoachim Protze 
199182e94a59SJoachim Protze // __kmpc_omp_taskwait: Wait until all tasks generated by the current task are
199282e94a59SJoachim Protze // complete
199382e94a59SJoachim Protze kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid) {
199482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
199582e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
199682e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
19970e0d6cddSJoachim Protze     return __kmpc_omp_taskwait_ompt(loc_ref, gtid, OMPT_GET_FRAME_ADDRESS(0),
199882e94a59SJoachim Protze                                     OMPT_LOAD_RETURN_ADDRESS(gtid));
199982e94a59SJoachim Protze   }
200082e94a59SJoachim Protze #endif
200182e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<false>(loc_ref, gtid, NULL, NULL);
200282e94a59SJoachim Protze }
200382e94a59SJoachim Protze 
20047cc577a4SJonathan Peyton // __kmpc_omp_taskyield: switch to a different task
20053041982dSJonathan Peyton kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid, int end_part) {
2006467f3924SHansang Bae   kmp_taskdata_t *taskdata = NULL;
20077cc577a4SJonathan Peyton   kmp_info_t *thread;
20087cc577a4SJonathan Peyton   int thread_finished = FALSE;
20097cc577a4SJonathan Peyton 
20107cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKYIELD);
20117cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKYIELD);
20127cc577a4SJonathan Peyton 
20137cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(enter): T#%d loc=%p end_part = %d\n",
20147cc577a4SJonathan Peyton                 gtid, loc_ref, end_part));
2015787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
20167cc577a4SJonathan Peyton 
20177cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec && __kmp_init_parallel) {
20187cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
20197cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
20207cc577a4SJonathan Peyton // Should we model this as a task wait or not?
20213041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
20223041982dSJonathan Peyton // taskwait.
20237cc577a4SJonathan Peyton #if USE_ITT_BUILD
20247cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
20257cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20267cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
20277cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
20287cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
20297cc577a4SJonathan Peyton 
20307cc577a4SJonathan Peyton #if USE_ITT_BUILD
2031838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2032838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2033838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2034838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
20357cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20367cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial) {
20377cc577a4SJonathan Peyton       kmp_task_team_t *task_team = thread->th.th_task_team;
20387cc577a4SJonathan Peyton       if (task_team != NULL) {
20397cc577a4SJonathan Peyton         if (KMP_TASKING_ENABLED(task_team)) {
204082e94a59SJoachim Protze #if OMPT_SUPPORT
2041f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
204282e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 1;
204382e94a59SJoachim Protze #endif
20443041982dSJonathan Peyton           __kmp_execute_tasks_32(
2045e0665a90STerry Wilmarth               thread, gtid, (kmp_flag_32<> *)NULL, FALSE,
20463041982dSJonathan Peyton               &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
20473041982dSJonathan Peyton               __kmp_task_stealing_constraint);
204882e94a59SJoachim Protze #if OMPT_SUPPORT
2049f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
205082e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 0;
205182e94a59SJoachim Protze #endif
20527cc577a4SJonathan Peyton         }
20537cc577a4SJonathan Peyton       }
20547cc577a4SJonathan Peyton     }
20557cc577a4SJonathan Peyton #if USE_ITT_BUILD
2056838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
20577cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20587cc577a4SJonathan Peyton 
20593041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
20603041982dSJonathan Peyton     // negated.
20617cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
20627cc577a4SJonathan Peyton   }
20637cc577a4SJonathan Peyton 
20647cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(exit): T#%d task %p resuming, "
20653041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
20663041982dSJonathan Peyton                 gtid, taskdata));
20677cc577a4SJonathan Peyton 
20687cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
20697cc577a4SJonathan Peyton }
20707cc577a4SJonathan Peyton 
207172ba2109SAndrey Churbanov // Task Reduction implementation
2072a8426ac8SJonathan Peyton //
2073a8426ac8SJonathan Peyton // Note: initial implementation didn't take into account the possibility
2074a8426ac8SJonathan Peyton // to specify omp_orig for initializer of the UDR (user defined reduction).
2075a8426ac8SJonathan Peyton // Corrected implementation takes into account the omp_orig object.
2076a8426ac8SJonathan Peyton // Compiler is free to use old implementation if omp_orig is not specified.
207772ba2109SAndrey Churbanov 
2078a8426ac8SJonathan Peyton /*!
2079a8426ac8SJonathan Peyton @ingroup BASIC_TYPES
2080a8426ac8SJonathan Peyton @{
2081a8426ac8SJonathan Peyton */
2082a8426ac8SJonathan Peyton 
2083a8426ac8SJonathan Peyton /*!
2084a8426ac8SJonathan Peyton Flags for special info per task reduction item.
2085a8426ac8SJonathan Peyton */
2086a8426ac8SJonathan Peyton typedef struct kmp_taskred_flags {
2087a8426ac8SJonathan Peyton   /*! 1 - use lazy alloc/init (e.g. big objects, #tasks < #threads) */
2088a8426ac8SJonathan Peyton   unsigned lazy_priv : 1;
208972ba2109SAndrey Churbanov   unsigned reserved31 : 31;
2090a8426ac8SJonathan Peyton } kmp_taskred_flags_t;
209172ba2109SAndrey Churbanov 
2092a8426ac8SJonathan Peyton /*!
2093a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2094a8426ac8SJonathan Peyton */
209572ba2109SAndrey Churbanov typedef struct kmp_task_red_input {
2096a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2097a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item in bytes */
2098a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2099a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (single parameter) */
2100a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2101a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2102a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
210372ba2109SAndrey Churbanov } kmp_task_red_input_t;
210472ba2109SAndrey Churbanov 
210572ba2109SAndrey Churbanov /*!
2106a8426ac8SJonathan Peyton Internal struct for reduction data item related info saved by the library.
210772ba2109SAndrey Churbanov */
2108a8426ac8SJonathan Peyton typedef struct kmp_taskred_data {
2109a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2110a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2111a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2112a8426ac8SJonathan Peyton   void *reduce_priv; /**< array of thread specific items */
2113a8426ac8SJonathan Peyton   void *reduce_pend; /**< end of private data for faster comparison op */
2114a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2115a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2116a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2117a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2118a8426ac8SJonathan Peyton   void *reduce_orig; /**< original item (can be used in UDR initializer) */
2119a8426ac8SJonathan Peyton } kmp_taskred_data_t;
2120a8426ac8SJonathan Peyton 
2121a8426ac8SJonathan Peyton /*!
2122a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2123a8426ac8SJonathan Peyton 
2124a8426ac8SJonathan Peyton New interface: added reduce_orig field to provide omp_orig for UDR initializer.
2125a8426ac8SJonathan Peyton */
2126a8426ac8SJonathan Peyton typedef struct kmp_taskred_input {
2127a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2128a8426ac8SJonathan Peyton   void *reduce_orig; /**< original reduction item used for initialization */
2129a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2130a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2131a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2132a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2133a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2134a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2135a8426ac8SJonathan Peyton } kmp_taskred_input_t;
2136a8426ac8SJonathan Peyton /*!
2137a8426ac8SJonathan Peyton @}
2138a8426ac8SJonathan Peyton */
2139a8426ac8SJonathan Peyton 
2140a8426ac8SJonathan Peyton template <typename T> void __kmp_assign_orig(kmp_taskred_data_t &item, T &src);
2141a8426ac8SJonathan Peyton template <>
2142a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_task_red_input_t>(kmp_taskred_data_t &item,
2143a8426ac8SJonathan Peyton                                              kmp_task_red_input_t &src) {
2144a8426ac8SJonathan Peyton   item.reduce_orig = NULL;
2145a8426ac8SJonathan Peyton }
2146a8426ac8SJonathan Peyton template <>
2147a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_taskred_input_t>(kmp_taskred_data_t &item,
2148a8426ac8SJonathan Peyton                                             kmp_taskred_input_t &src) {
2149a8426ac8SJonathan Peyton   if (src.reduce_orig != NULL) {
2150a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_orig;
2151a8426ac8SJonathan Peyton   } else {
2152a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_shar;
2153a8426ac8SJonathan Peyton   } // non-NULL reduce_orig means new interface used
2154a8426ac8SJonathan Peyton }
2155a8426ac8SJonathan Peyton 
21566b316febSTerry Wilmarth template <typename T> void __kmp_call_init(kmp_taskred_data_t &item, size_t j);
2157a8426ac8SJonathan Peyton template <>
2158a8426ac8SJonathan Peyton void __kmp_call_init<kmp_task_red_input_t>(kmp_taskred_data_t &item,
21596b316febSTerry Wilmarth                                            size_t offset) {
2160a8426ac8SJonathan Peyton   ((void (*)(void *))item.reduce_init)((char *)(item.reduce_priv) + offset);
2161a8426ac8SJonathan Peyton }
2162a8426ac8SJonathan Peyton template <>
2163a8426ac8SJonathan Peyton void __kmp_call_init<kmp_taskred_input_t>(kmp_taskred_data_t &item,
21646b316febSTerry Wilmarth                                           size_t offset) {
2165a8426ac8SJonathan Peyton   ((void (*)(void *, void *))item.reduce_init)(
2166a8426ac8SJonathan Peyton       (char *)(item.reduce_priv) + offset, item.reduce_orig);
2167a8426ac8SJonathan Peyton }
2168a8426ac8SJonathan Peyton 
2169a8426ac8SJonathan Peyton template <typename T>
2170a8426ac8SJonathan Peyton void *__kmp_task_reduction_init(int gtid, int num, T *data) {
2171787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
217272ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
217372ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = thread->th.th_current_task->td_taskgroup;
21746b316febSTerry Wilmarth   kmp_uint32 nth = thread->th.th_team_nproc;
2175a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
217672ba2109SAndrey Churbanov 
217772ba2109SAndrey Churbanov   // check input data just in case
217872ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
217972ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
218072ba2109SAndrey Churbanov   KMP_ASSERT(num > 0);
218172ba2109SAndrey Churbanov   if (nth == 1) {
218272ba2109SAndrey Churbanov     KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, tg %p, exiting nth=1\n",
218372ba2109SAndrey Churbanov                   gtid, tg));
218472ba2109SAndrey Churbanov     return (void *)tg;
218572ba2109SAndrey Churbanov   }
218672ba2109SAndrey Churbanov   KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, taskgroup %p, #items %d\n",
218772ba2109SAndrey Churbanov                 gtid, tg, num));
2188a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2189a8426ac8SJonathan Peyton       thread, num * sizeof(kmp_taskred_data_t));
219072ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
2191a8426ac8SJonathan Peyton     size_t size = data[i].reduce_size - 1;
219272ba2109SAndrey Churbanov     // round the size up to cache line per thread-specific item
219372ba2109SAndrey Churbanov     size += CACHE_LINE - size % CACHE_LINE;
2194a8426ac8SJonathan Peyton     KMP_ASSERT(data[i].reduce_comb != NULL); // combiner is mandatory
2195a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar;
219672ba2109SAndrey Churbanov     arr[i].reduce_size = size;
2197a8426ac8SJonathan Peyton     arr[i].flags = data[i].flags;
2198a8426ac8SJonathan Peyton     arr[i].reduce_comb = data[i].reduce_comb;
2199a8426ac8SJonathan Peyton     arr[i].reduce_init = data[i].reduce_init;
2200a8426ac8SJonathan Peyton     arr[i].reduce_fini = data[i].reduce_fini;
2201a8426ac8SJonathan Peyton     __kmp_assign_orig<T>(arr[i], data[i]);
2202a8426ac8SJonathan Peyton     if (!arr[i].flags.lazy_priv) {
220372ba2109SAndrey Churbanov       // allocate cache-line aligned block and fill it with zeros
220472ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * size);
220572ba2109SAndrey Churbanov       arr[i].reduce_pend = (char *)(arr[i].reduce_priv) + nth * size;
2206a8426ac8SJonathan Peyton       if (arr[i].reduce_init != NULL) {
2207a8426ac8SJonathan Peyton         // initialize all thread-specific items
22086b316febSTerry Wilmarth         for (size_t j = 0; j < nth; ++j) {
2209a8426ac8SJonathan Peyton           __kmp_call_init<T>(arr[i], j * size);
221072ba2109SAndrey Churbanov         }
221172ba2109SAndrey Churbanov       }
221272ba2109SAndrey Churbanov     } else {
221372ba2109SAndrey Churbanov       // only allocate space for pointers now,
2214a8426ac8SJonathan Peyton       // objects will be lazily allocated/initialized if/when requested
2215a8426ac8SJonathan Peyton       // note that __kmp_allocate zeroes the allocated memory
221672ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * sizeof(void *));
221772ba2109SAndrey Churbanov     }
221872ba2109SAndrey Churbanov   }
221972ba2109SAndrey Churbanov   tg->reduce_data = (void *)arr;
222072ba2109SAndrey Churbanov   tg->reduce_num_data = num;
222172ba2109SAndrey Churbanov   return (void *)tg;
222272ba2109SAndrey Churbanov }
222372ba2109SAndrey Churbanov 
222472ba2109SAndrey Churbanov /*!
222572ba2109SAndrey Churbanov @ingroup TASKING
222672ba2109SAndrey Churbanov @param gtid      Global thread ID
2227a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2228a8426ac8SJonathan Peyton @param data      Array of data for reduction
2229a8426ac8SJonathan Peyton @return The taskgroup identifier
2230a8426ac8SJonathan Peyton 
2231a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2232a8426ac8SJonathan Peyton 
2233a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2234a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2235a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2236a8426ac8SJonathan Peyton without help of the runtime library.
2237a8426ac8SJonathan Peyton */
2238a8426ac8SJonathan Peyton void *__kmpc_task_reduction_init(int gtid, int num, void *data) {
2239a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_task_red_input_t *)data);
2240a8426ac8SJonathan Peyton }
2241a8426ac8SJonathan Peyton 
2242a8426ac8SJonathan Peyton /*!
2243a8426ac8SJonathan Peyton @ingroup TASKING
2244a8426ac8SJonathan Peyton @param gtid      Global thread ID
2245a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2246a8426ac8SJonathan Peyton @param data      Array of data for reduction
2247a8426ac8SJonathan Peyton @return The taskgroup identifier
2248a8426ac8SJonathan Peyton 
2249a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2250a8426ac8SJonathan Peyton 
2251a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2252a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2253a8426ac8SJonathan Peyton */
2254a8426ac8SJonathan Peyton void *__kmpc_taskred_init(int gtid, int num, void *data) {
2255a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_taskred_input_t *)data);
2256a8426ac8SJonathan Peyton }
2257a8426ac8SJonathan Peyton 
2258a8426ac8SJonathan Peyton // Copy task reduction data (except for shared pointers).
2259a8426ac8SJonathan Peyton template <typename T>
2260a8426ac8SJonathan Peyton void __kmp_task_reduction_init_copy(kmp_info_t *thr, int num, T *data,
2261a8426ac8SJonathan Peyton                                     kmp_taskgroup_t *tg, void *reduce_data) {
2262a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
2263a8426ac8SJonathan Peyton   KA_TRACE(20, ("__kmp_task_reduction_init_copy: Th %p, init taskgroup %p,"
2264a8426ac8SJonathan Peyton                 " from data %p\n",
2265a8426ac8SJonathan Peyton                 thr, tg, reduce_data));
2266a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2267a8426ac8SJonathan Peyton       thr, num * sizeof(kmp_taskred_data_t));
2268a8426ac8SJonathan Peyton   // threads will share private copies, thunk routines, sizes, flags, etc.:
2269a8426ac8SJonathan Peyton   KMP_MEMCPY(arr, reduce_data, num * sizeof(kmp_taskred_data_t));
2270a8426ac8SJonathan Peyton   for (int i = 0; i < num; ++i) {
2271a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar; // init unique shared pointers
2272a8426ac8SJonathan Peyton   }
2273a8426ac8SJonathan Peyton   tg->reduce_data = (void *)arr;
2274a8426ac8SJonathan Peyton   tg->reduce_num_data = num;
2275a8426ac8SJonathan Peyton }
2276a8426ac8SJonathan Peyton 
2277a8426ac8SJonathan Peyton /*!
2278a8426ac8SJonathan Peyton @ingroup TASKING
2279a8426ac8SJonathan Peyton @param gtid    Global thread ID
228072ba2109SAndrey Churbanov @param tskgrp  The taskgroup ID (optional)
228172ba2109SAndrey Churbanov @param data    Shared location of the item
228272ba2109SAndrey Churbanov @return The pointer to per-thread data
228372ba2109SAndrey Churbanov 
228472ba2109SAndrey Churbanov Get thread-specific location of data item
228572ba2109SAndrey Churbanov */
22863041982dSJonathan Peyton void *__kmpc_task_reduction_get_th_data(int gtid, void *tskgrp, void *data) {
2287787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
228872ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
228972ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
229072ba2109SAndrey Churbanov   if (nth == 1)
229172ba2109SAndrey Churbanov     return data; // nothing to do
229272ba2109SAndrey Churbanov 
229372ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = (kmp_taskgroup_t *)tskgrp;
229472ba2109SAndrey Churbanov   if (tg == NULL)
229572ba2109SAndrey Churbanov     tg = thread->th.th_current_task->td_taskgroup;
229672ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
2297a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)(tg->reduce_data);
229872ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
229972ba2109SAndrey Churbanov   kmp_int32 tid = thread->th.th_info.ds.ds_tid;
230072ba2109SAndrey Churbanov 
230172ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
230272ba2109SAndrey Churbanov   while (tg != NULL) {
230372ba2109SAndrey Churbanov     for (int i = 0; i < num; ++i) {
230472ba2109SAndrey Churbanov       if (!arr[i].flags.lazy_priv) {
230572ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar ||
230672ba2109SAndrey Churbanov             (data >= arr[i].reduce_priv && data < arr[i].reduce_pend))
230772ba2109SAndrey Churbanov           return (char *)(arr[i].reduce_priv) + tid * arr[i].reduce_size;
230872ba2109SAndrey Churbanov       } else {
230972ba2109SAndrey Churbanov         // check shared location first
231072ba2109SAndrey Churbanov         void **p_priv = (void **)(arr[i].reduce_priv);
231172ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar)
231272ba2109SAndrey Churbanov           goto found;
231372ba2109SAndrey Churbanov         // check if we get some thread specific location as parameter
231472ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j)
231572ba2109SAndrey Churbanov           if (data == p_priv[j])
231672ba2109SAndrey Churbanov             goto found;
231772ba2109SAndrey Churbanov         continue; // not found, continue search
231872ba2109SAndrey Churbanov       found:
231972ba2109SAndrey Churbanov         if (p_priv[tid] == NULL) {
232072ba2109SAndrey Churbanov           // allocate thread specific object lazily
232172ba2109SAndrey Churbanov           p_priv[tid] = __kmp_allocate(arr[i].reduce_size);
2322a8426ac8SJonathan Peyton           if (arr[i].reduce_init != NULL) {
2323a8426ac8SJonathan Peyton             if (arr[i].reduce_orig != NULL) { // new interface
2324a8426ac8SJonathan Peyton               ((void (*)(void *, void *))arr[i].reduce_init)(
2325a8426ac8SJonathan Peyton                   p_priv[tid], arr[i].reduce_orig);
2326a8426ac8SJonathan Peyton             } else { // old interface (single parameter)
2327a8426ac8SJonathan Peyton               ((void (*)(void *))arr[i].reduce_init)(p_priv[tid]);
2328a8426ac8SJonathan Peyton             }
232972ba2109SAndrey Churbanov           }
233072ba2109SAndrey Churbanov         }
233172ba2109SAndrey Churbanov         return p_priv[tid];
233272ba2109SAndrey Churbanov       }
233372ba2109SAndrey Churbanov     }
233472ba2109SAndrey Churbanov     tg = tg->parent;
2335a8426ac8SJonathan Peyton     arr = (kmp_taskred_data_t *)(tg->reduce_data);
233672ba2109SAndrey Churbanov     num = tg->reduce_num_data;
233772ba2109SAndrey Churbanov   }
233872ba2109SAndrey Churbanov   KMP_ASSERT2(0, "Unknown task reduction item");
233972ba2109SAndrey Churbanov   return NULL; // ERROR, this line never executed
234072ba2109SAndrey Churbanov }
234172ba2109SAndrey Churbanov 
234272ba2109SAndrey Churbanov // Finalize task reduction.
234372ba2109SAndrey Churbanov // Called from __kmpc_end_taskgroup()
23443041982dSJonathan Peyton static void __kmp_task_reduction_fini(kmp_info_t *th, kmp_taskgroup_t *tg) {
234572ba2109SAndrey Churbanov   kmp_int32 nth = th->th.th_team_nproc;
234672ba2109SAndrey Churbanov   KMP_DEBUG_ASSERT(nth > 1); // should not be called if nth == 1
2347a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)tg->reduce_data;
234872ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
234972ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
235072ba2109SAndrey Churbanov     void *sh_data = arr[i].reduce_shar;
235172ba2109SAndrey Churbanov     void (*f_fini)(void *) = (void (*)(void *))(arr[i].reduce_fini);
23523041982dSJonathan Peyton     void (*f_comb)(void *, void *) =
23533041982dSJonathan Peyton         (void (*)(void *, void *))(arr[i].reduce_comb);
235472ba2109SAndrey Churbanov     if (!arr[i].flags.lazy_priv) {
235572ba2109SAndrey Churbanov       void *pr_data = arr[i].reduce_priv;
235672ba2109SAndrey Churbanov       size_t size = arr[i].reduce_size;
235772ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
235872ba2109SAndrey Churbanov         void *priv_data = (char *)pr_data + j * size;
235972ba2109SAndrey Churbanov         f_comb(sh_data, priv_data); // combine results
236072ba2109SAndrey Churbanov         if (f_fini)
236172ba2109SAndrey Churbanov           f_fini(priv_data); // finalize if needed
236272ba2109SAndrey Churbanov       }
236372ba2109SAndrey Churbanov     } else {
236472ba2109SAndrey Churbanov       void **pr_data = (void **)(arr[i].reduce_priv);
236572ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
236672ba2109SAndrey Churbanov         if (pr_data[j] != NULL) {
236772ba2109SAndrey Churbanov           f_comb(sh_data, pr_data[j]); // combine results
236872ba2109SAndrey Churbanov           if (f_fini)
236972ba2109SAndrey Churbanov             f_fini(pr_data[j]); // finalize if needed
237072ba2109SAndrey Churbanov           __kmp_free(pr_data[j]);
237172ba2109SAndrey Churbanov         }
237272ba2109SAndrey Churbanov       }
237372ba2109SAndrey Churbanov     }
237472ba2109SAndrey Churbanov     __kmp_free(arr[i].reduce_priv);
237572ba2109SAndrey Churbanov   }
237672ba2109SAndrey Churbanov   __kmp_thread_free(th, arr);
237772ba2109SAndrey Churbanov   tg->reduce_data = NULL;
237872ba2109SAndrey Churbanov   tg->reduce_num_data = 0;
237972ba2109SAndrey Churbanov }
2380a8426ac8SJonathan Peyton 
2381a8426ac8SJonathan Peyton // Cleanup task reduction data for parallel or worksharing,
2382a8426ac8SJonathan Peyton // do not touch task private data other threads still working with.
2383a8426ac8SJonathan Peyton // Called from __kmpc_end_taskgroup()
2384a8426ac8SJonathan Peyton static void __kmp_task_reduction_clean(kmp_info_t *th, kmp_taskgroup_t *tg) {
2385a8426ac8SJonathan Peyton   __kmp_thread_free(th, tg->reduce_data);
2386a8426ac8SJonathan Peyton   tg->reduce_data = NULL;
2387a8426ac8SJonathan Peyton   tg->reduce_num_data = 0;
2388a8426ac8SJonathan Peyton }
2389a8426ac8SJonathan Peyton 
2390a8426ac8SJonathan Peyton template <typename T>
2391a8426ac8SJonathan Peyton void *__kmp_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2392a8426ac8SJonathan Peyton                                          int num, T *data) {
2393787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
2394a8426ac8SJonathan Peyton   kmp_info_t *thr = __kmp_threads[gtid];
2395a8426ac8SJonathan Peyton   kmp_int32 nth = thr->th.th_team_nproc;
2396a8426ac8SJonathan Peyton   __kmpc_taskgroup(loc, gtid); // form new taskgroup first
2397a8426ac8SJonathan Peyton   if (nth == 1) {
2398a8426ac8SJonathan Peyton     KA_TRACE(10,
2399a8426ac8SJonathan Peyton              ("__kmpc_reduction_modifier_init: T#%d, tg %p, exiting nth=1\n",
2400a8426ac8SJonathan Peyton               gtid, thr->th.th_current_task->td_taskgroup));
2401a8426ac8SJonathan Peyton     return (void *)thr->th.th_current_task->td_taskgroup;
2402a8426ac8SJonathan Peyton   }
2403a8426ac8SJonathan Peyton   kmp_team_t *team = thr->th.th_team;
2404a8426ac8SJonathan Peyton   void *reduce_data;
2405a8426ac8SJonathan Peyton   kmp_taskgroup_t *tg;
2406a8426ac8SJonathan Peyton   reduce_data = KMP_ATOMIC_LD_RLX(&team->t.t_tg_reduce_data[is_ws]);
2407a8426ac8SJonathan Peyton   if (reduce_data == NULL &&
2408a8426ac8SJonathan Peyton       __kmp_atomic_compare_store(&team->t.t_tg_reduce_data[is_ws], reduce_data,
2409a8426ac8SJonathan Peyton                                  (void *)1)) {
2410a8426ac8SJonathan Peyton     // single thread enters this block to initialize common reduction data
2411a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data == NULL);
2412a8426ac8SJonathan Peyton     // first initialize own data, then make a copy other threads can use
2413a8426ac8SJonathan Peyton     tg = (kmp_taskgroup_t *)__kmp_task_reduction_init<T>(gtid, num, data);
2414a8426ac8SJonathan Peyton     reduce_data = __kmp_thread_malloc(thr, num * sizeof(kmp_taskred_data_t));
2415a8426ac8SJonathan Peyton     KMP_MEMCPY(reduce_data, tg->reduce_data, num * sizeof(kmp_taskred_data_t));
2416a8426ac8SJonathan Peyton     // fini counters should be 0 at this point
2417a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[0]) == 0);
2418a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[1]) == 0);
2419a8426ac8SJonathan Peyton     KMP_ATOMIC_ST_REL(&team->t.t_tg_reduce_data[is_ws], reduce_data);
2420a8426ac8SJonathan Peyton   } else {
2421a8426ac8SJonathan Peyton     while (
2422a8426ac8SJonathan Peyton         (reduce_data = KMP_ATOMIC_LD_ACQ(&team->t.t_tg_reduce_data[is_ws])) ==
2423a8426ac8SJonathan Peyton         (void *)1) { // wait for task reduction initialization
2424a8426ac8SJonathan Peyton       KMP_CPU_PAUSE();
2425a8426ac8SJonathan Peyton     }
2426a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data > (void *)1); // should be valid pointer here
2427a8426ac8SJonathan Peyton     tg = thr->th.th_current_task->td_taskgroup;
2428a8426ac8SJonathan Peyton     __kmp_task_reduction_init_copy<T>(thr, num, data, tg, reduce_data);
2429a8426ac8SJonathan Peyton   }
2430a8426ac8SJonathan Peyton   return tg;
2431a8426ac8SJonathan Peyton }
2432a8426ac8SJonathan Peyton 
2433a8426ac8SJonathan Peyton /*!
2434a8426ac8SJonathan Peyton @ingroup TASKING
2435a8426ac8SJonathan Peyton @param loc       Source location info
2436a8426ac8SJonathan Peyton @param gtid      Global thread ID
2437a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2438a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2439a8426ac8SJonathan Peyton @param data      Array of data for reduction
2440a8426ac8SJonathan Peyton @return The taskgroup identifier
2441a8426ac8SJonathan Peyton 
2442a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2443a8426ac8SJonathan Peyton 
2444a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2445a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2446a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2447a8426ac8SJonathan Peyton without help of the runtime library.
2448a8426ac8SJonathan Peyton */
2449a8426ac8SJonathan Peyton void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2450a8426ac8SJonathan Peyton                                           int num, void *data) {
2451a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2452a8426ac8SJonathan Peyton                                             (kmp_task_red_input_t *)data);
2453a8426ac8SJonathan Peyton }
2454a8426ac8SJonathan Peyton 
2455a8426ac8SJonathan Peyton /*!
2456a8426ac8SJonathan Peyton @ingroup TASKING
2457a8426ac8SJonathan Peyton @param loc       Source location info
2458a8426ac8SJonathan Peyton @param gtid      Global thread ID
2459a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2460a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2461a8426ac8SJonathan Peyton @param data      Array of data for reduction
2462a8426ac8SJonathan Peyton @return The taskgroup identifier
2463a8426ac8SJonathan Peyton 
2464a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2465a8426ac8SJonathan Peyton 
2466a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2467a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2468a8426ac8SJonathan Peyton */
2469a8426ac8SJonathan Peyton void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num,
2470a8426ac8SJonathan Peyton                                    void *data) {
2471a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2472a8426ac8SJonathan Peyton                                             (kmp_taskred_input_t *)data);
2473a8426ac8SJonathan Peyton }
2474a8426ac8SJonathan Peyton 
2475a8426ac8SJonathan Peyton /*!
2476a8426ac8SJonathan Peyton @ingroup TASKING
2477a8426ac8SJonathan Peyton @param loc       Source location info
2478a8426ac8SJonathan Peyton @param gtid      Global thread ID
2479a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2480a8426ac8SJonathan Peyton 
2481a8426ac8SJonathan Peyton Finalize task reduction for a parallel or worksharing.
2482a8426ac8SJonathan Peyton */
2483a8426ac8SJonathan Peyton void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid, int is_ws) {
2484a8426ac8SJonathan Peyton   __kmpc_end_taskgroup(loc, gtid);
2485a8426ac8SJonathan Peyton }
24867cc577a4SJonathan Peyton 
24877cc577a4SJonathan Peyton // __kmpc_taskgroup: Start a new taskgroup
24883041982dSJonathan Peyton void __kmpc_taskgroup(ident_t *loc, int gtid) {
2489787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
24907cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
24917cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
24927cc577a4SJonathan Peyton   kmp_taskgroup_t *tg_new =
24937cc577a4SJonathan Peyton       (kmp_taskgroup_t *)__kmp_thread_malloc(thread, sizeof(kmp_taskgroup_t));
24947cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_taskgroup: T#%d loc=%p group=%p\n", gtid, loc, tg_new));
249537e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->count, 0);
249637e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->cancel_request, cancel_noreq);
24977cc577a4SJonathan Peyton   tg_new->parent = taskdata->td_taskgroup;
249872ba2109SAndrey Churbanov   tg_new->reduce_data = NULL;
249972ba2109SAndrey Churbanov   tg_new->reduce_num_data = 0;
2500*44575657SPeyton, Jonathan L   tg_new->gomp_data = NULL;
25017cc577a4SJonathan Peyton   taskdata->td_taskgroup = tg_new;
250282e94a59SJoachim Protze 
250382e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2504f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
250582e94a59SJoachim Protze     void *codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
250682e94a59SJoachim Protze     if (!codeptr)
250782e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
250882e94a59SJoachim Protze     kmp_team_t *team = thread->th.th_team;
250982e94a59SJoachim Protze     ompt_data_t my_task_data = taskdata->ompt_task_info.task_data;
251082e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
251182e94a59SJoachim Protze     ompt_data_t my_parallel_data = team->t.ompt_team_info.parallel_data;
251282e94a59SJoachim Protze 
251382e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
251482e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
251582e94a59SJoachim Protze         &(my_task_data), codeptr);
251682e94a59SJoachim Protze   }
251782e94a59SJoachim Protze #endif
25187cc577a4SJonathan Peyton }
25197cc577a4SJonathan Peyton 
25207cc577a4SJonathan Peyton // __kmpc_end_taskgroup: Wait until all tasks generated by the current task
25217cc577a4SJonathan Peyton //                       and its descendants are complete
25223041982dSJonathan Peyton void __kmpc_end_taskgroup(ident_t *loc, int gtid) {
2523787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
25247cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
25257cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
25267cc577a4SJonathan Peyton   kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
25277cc577a4SJonathan Peyton   int thread_finished = FALSE;
25287cc577a4SJonathan Peyton 
252982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
253082e94a59SJoachim Protze   kmp_team_t *team;
253182e94a59SJoachim Protze   ompt_data_t my_task_data;
253282e94a59SJoachim Protze   ompt_data_t my_parallel_data;
2533467f3924SHansang Bae   void *codeptr = nullptr;
2534f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
253582e94a59SJoachim Protze     team = thread->th.th_team;
253682e94a59SJoachim Protze     my_task_data = taskdata->ompt_task_info.task_data;
253782e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
253882e94a59SJoachim Protze     my_parallel_data = team->t.ompt_team_info.parallel_data;
253982e94a59SJoachim Protze     codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
254082e94a59SJoachim Protze     if (!codeptr)
254182e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
254282e94a59SJoachim Protze   }
254382e94a59SJoachim Protze #endif
254482e94a59SJoachim Protze 
25457cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(enter): T#%d loc=%p\n", gtid, loc));
25467cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup != NULL);
25477cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKGROUP);
25487cc577a4SJonathan Peyton 
25497cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
2550a756cb24SAndrey Churbanov     // mark task as waiting not on a barrier
2551a756cb24SAndrey Churbanov     taskdata->td_taskwait_counter += 1;
2552a756cb24SAndrey Churbanov     taskdata->td_taskwait_ident = loc;
2553a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = gtid + 1;
25547cc577a4SJonathan Peyton #if USE_ITT_BUILD
25553041982dSJonathan Peyton     // For ITT the taskgroup wait is similar to taskwait until we need to
25563041982dSJonathan Peyton     // distinguish them
2557838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2558838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2559838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2560838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
25617cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25627cc577a4SJonathan Peyton 
256382e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2564f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
256582e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
256682e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
256782e94a59SJoachim Protze           &(my_task_data), codeptr);
256882e94a59SJoachim Protze     }
256982e94a59SJoachim Protze #endif
257082e94a59SJoachim Protze 
25713041982dSJonathan Peyton     if (!taskdata->td_flags.team_serial ||
25723041982dSJonathan Peyton         (thread->th.th_task_team != NULL &&
2573e4b4f994SJonathan Peyton          thread->th.th_task_team->tt.tt_found_proxy_tasks)) {
2574e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
2575e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *, &(taskgroup->count)), 0U);
257637e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskgroup->count) != 0) {
25773041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
25783041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
25793041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
25807cc577a4SJonathan Peyton       }
25817cc577a4SJonathan Peyton     }
2582a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread; // end waiting
25837cc577a4SJonathan Peyton 
258482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2585f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
258682e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
258782e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
258882e94a59SJoachim Protze           &(my_task_data), codeptr);
258982e94a59SJoachim Protze     }
259082e94a59SJoachim Protze #endif
259182e94a59SJoachim Protze 
25927cc577a4SJonathan Peyton #if USE_ITT_BUILD
2593838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
2594ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with descendants
25957cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25967cc577a4SJonathan Peyton   }
25977cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup->count == 0);
25987cc577a4SJonathan Peyton 
2599*44575657SPeyton, Jonathan L   if (taskgroup->reduce_data != NULL &&
2600*44575657SPeyton, Jonathan L       !taskgroup->gomp_data) { // need to reduce?
2601a8426ac8SJonathan Peyton     int cnt;
2602a8426ac8SJonathan Peyton     void *reduce_data;
2603a8426ac8SJonathan Peyton     kmp_team_t *t = thread->th.th_team;
2604a8426ac8SJonathan Peyton     kmp_taskred_data_t *arr = (kmp_taskred_data_t *)taskgroup->reduce_data;
2605a8426ac8SJonathan Peyton     // check if <priv> data of the first reduction variable shared for the team
2606a8426ac8SJonathan Peyton     void *priv0 = arr[0].reduce_priv;
2607a8426ac8SJonathan Peyton     if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[0])) != NULL &&
2608a8426ac8SJonathan Peyton         ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2609a8426ac8SJonathan Peyton       // finishing task reduction on parallel
2610a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[0]);
2611a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2612a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2613a8426ac8SJonathan Peyton         // finalize task reduction:
261472ba2109SAndrey Churbanov         __kmp_task_reduction_fini(thread, taskgroup);
2615a8426ac8SJonathan Peyton         // cleanup fields in the team structure:
2616a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2617a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2618a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[0], NULL);
2619a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[0], 0);
2620a8426ac8SJonathan Peyton       } else {
2621a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2622a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2623a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2624a8426ac8SJonathan Peyton       }
2625a8426ac8SJonathan Peyton     } else if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[1])) !=
2626a8426ac8SJonathan Peyton                    NULL &&
2627a8426ac8SJonathan Peyton                ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2628a8426ac8SJonathan Peyton       // finishing task reduction on worksharing
2629a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[1]);
2630a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2631a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2632a8426ac8SJonathan Peyton         __kmp_task_reduction_fini(thread, taskgroup);
2633a8426ac8SJonathan Peyton         // cleanup fields in team structure:
2634a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2635a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2636a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[1], NULL);
2637a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[1], 0);
2638a8426ac8SJonathan Peyton       } else {
2639a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2640a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2641a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2642a8426ac8SJonathan Peyton       }
2643a8426ac8SJonathan Peyton     } else {
2644a8426ac8SJonathan Peyton       // finishing task reduction on taskgroup
2645a8426ac8SJonathan Peyton       __kmp_task_reduction_fini(thread, taskgroup);
2646a8426ac8SJonathan Peyton     }
2647a8426ac8SJonathan Peyton   }
26487cc577a4SJonathan Peyton   // Restore parent taskgroup for the current task
26497cc577a4SJonathan Peyton   taskdata->td_taskgroup = taskgroup->parent;
26507cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskgroup);
26517cc577a4SJonathan Peyton 
26523041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(exit): T#%d task %p finished waiting\n",
26533041982dSJonathan Peyton                 gtid, taskdata));
26547cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_AFTER(taskdata);
265582e94a59SJoachim Protze 
265682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2657f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
265882e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
265982e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
266082e94a59SJoachim Protze         &(my_task_data), codeptr);
266182e94a59SJoachim Protze   }
266282e94a59SJoachim Protze #endif
26637cc577a4SJonathan Peyton }
26647cc577a4SJonathan Peyton 
26657cc577a4SJonathan Peyton // __kmp_remove_my_task: remove a task from my own deque
26663041982dSJonathan Peyton static kmp_task_t *__kmp_remove_my_task(kmp_info_t *thread, kmp_int32 gtid,
26673041982dSJonathan Peyton                                         kmp_task_team_t *task_team,
26683041982dSJonathan Peyton                                         kmp_int32 is_constrained) {
26697cc577a4SJonathan Peyton   kmp_task_t *task;
26707cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
26717cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
26727cc577a4SJonathan Peyton   kmp_uint32 tail;
26737cc577a4SJonathan Peyton 
26747cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
26753041982dSJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_threads_data !=
26763041982dSJonathan Peyton                    NULL); // Caller should check this condition
26777cc577a4SJonathan Peyton 
26787cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
26797cc577a4SJonathan Peyton 
26807cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(enter): T#%d ntasks=%d head=%u tail=%u\n",
26813041982dSJonathan Peyton                 gtid, thread_data->td.td_deque_ntasks,
26823041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26837cc577a4SJonathan Peyton 
26847cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26853041982dSJonathan Peyton     KA_TRACE(10,
26863041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #1): T#%d No tasks to remove: "
26873041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26883041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26893041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26907cc577a4SJonathan Peyton     return NULL;
26917cc577a4SJonathan Peyton   }
26927cc577a4SJonathan Peyton 
26937cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
26947cc577a4SJonathan Peyton 
26957cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26967cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
26973041982dSJonathan Peyton     KA_TRACE(10,
26983041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
26993041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27003041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
27013041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27027cc577a4SJonathan Peyton     return NULL;
27037cc577a4SJonathan Peyton   }
27047cc577a4SJonathan Peyton 
27053041982dSJonathan Peyton   tail = (thread_data->td.td_deque_tail - 1) &
27063041982dSJonathan Peyton          TASK_DEQUE_MASK(thread_data->td); // Wrap index.
27077cc577a4SJonathan Peyton   taskdata = thread_data->td.td_deque[tail];
27087cc577a4SJonathan Peyton 
2709c3344345SAndrey Churbanov   if (!__kmp_task_is_allowed(gtid, is_constrained, taskdata,
2710c3344345SAndrey Churbanov                              thread->th.th_current_task)) {
2711a756cb24SAndrey Churbanov     // The TSC does not allow to steal victim task
27127cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
2713c3344345SAndrey Churbanov     KA_TRACE(10,
2714c3344345SAndrey Churbanov              ("__kmp_remove_my_task(exit #3): T#%d TSC blocks tail task: "
27153041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27163041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
2717c3344345SAndrey Churbanov               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27187cc577a4SJonathan Peyton     return NULL;
27197cc577a4SJonathan Peyton   }
27207cc577a4SJonathan Peyton 
27217cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = tail;
27227cc577a4SJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks, thread_data->td.td_deque_ntasks - 1);
27237cc577a4SJonathan Peyton 
27247cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
27257cc577a4SJonathan Peyton 
2726c3344345SAndrey Churbanov   KA_TRACE(10, ("__kmp_remove_my_task(exit #4): T#%d task %p removed: "
27273041982dSJonathan Peyton                 "ntasks=%d head=%u tail=%u\n",
27283041982dSJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
27293041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27307cc577a4SJonathan Peyton 
27317cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
27327cc577a4SJonathan Peyton   return task;
27337cc577a4SJonathan Peyton }
27347cc577a4SJonathan Peyton 
27357cc577a4SJonathan Peyton // __kmp_steal_task: remove a task from another thread's deque
27367cc577a4SJonathan Peyton // Assume that calling thread has already checked existence of
27377cc577a4SJonathan Peyton // task_team thread_data before calling this routine.
2738a756cb24SAndrey Churbanov static kmp_task_t *__kmp_steal_task(kmp_info_t *victim_thr, kmp_int32 gtid,
2739c47afcd9SAndrey Churbanov                                     kmp_task_team_t *task_team,
274037e2ef54SJonathan Peyton                                     std::atomic<kmp_int32> *unfinished_threads,
2741c47afcd9SAndrey Churbanov                                     int *thread_finished,
2742c47afcd9SAndrey Churbanov                                     kmp_int32 is_constrained) {
27437cc577a4SJonathan Peyton   kmp_task_t *task;
27447cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
2745a756cb24SAndrey Churbanov   kmp_taskdata_t *current;
27467cc577a4SJonathan Peyton   kmp_thread_data_t *victim_td, *threads_data;
2747c3344345SAndrey Churbanov   kmp_int32 target;
27487cc577a4SJonathan Peyton   kmp_int32 victim_tid;
27497cc577a4SJonathan Peyton 
27507cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
27517cc577a4SJonathan Peyton 
27527cc577a4SJonathan Peyton   threads_data = task_team->tt.tt_threads_data;
27537cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL); // Caller should check this condition
27547cc577a4SJonathan Peyton 
2755a756cb24SAndrey Churbanov   victim_tid = victim_thr->th.th_info.ds.ds_tid;
27567cc577a4SJonathan Peyton   victim_td = &threads_data[victim_tid];
27577cc577a4SJonathan Peyton 
27583041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_steal_task(enter): T#%d try to steal from T#%d: "
2759a756cb24SAndrey Churbanov                 "task_team=%p ntasks=%d head=%u tail=%u\n",
2760a756cb24SAndrey Churbanov                 gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27613041982dSJonathan Peyton                 victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27623041982dSJonathan Peyton                 victim_td->td.td_deque_tail));
27637cc577a4SJonathan Peyton 
2764a756cb24SAndrey Churbanov   if (TCR_4(victim_td->td.td_deque_ntasks) == 0) {
27653041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #1): T#%d could not steal from T#%d: "
2766a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2767a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27683041982dSJonathan Peyton                   victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27693041982dSJonathan Peyton                   victim_td->td.td_deque_tail));
27707cc577a4SJonathan Peyton     return NULL;
27717cc577a4SJonathan Peyton   }
27727cc577a4SJonathan Peyton 
27737cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&victim_td->td.td_deque_lock);
27747cc577a4SJonathan Peyton 
2775a756cb24SAndrey Churbanov   int ntasks = TCR_4(victim_td->td.td_deque_ntasks);
27767cc577a4SJonathan Peyton   // Check again after we acquire the lock
2777a756cb24SAndrey Churbanov   if (ntasks == 0) {
27787cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
27793041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #2): T#%d could not steal from T#%d: "
2780a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2781a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2782a756cb24SAndrey Churbanov                   victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27837cc577a4SJonathan Peyton     return NULL;
27847cc577a4SJonathan Peyton   }
27857cc577a4SJonathan Peyton 
27867cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(victim_td->td.td_deque != NULL);
2787c3344345SAndrey Churbanov   current = __kmp_threads[gtid]->th.th_current_task;
27887cc577a4SJonathan Peyton   taskdata = victim_td->td.td_deque[victim_td->td.td_deque_head];
2789c3344345SAndrey Churbanov   if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2790c3344345SAndrey Churbanov     // Bump head pointer and Wrap.
2791c3344345SAndrey Churbanov     victim_td->td.td_deque_head =
2792c3344345SAndrey Churbanov         (victim_td->td.td_deque_head + 1) & TASK_DEQUE_MASK(victim_td->td);
2793c3344345SAndrey Churbanov   } else {
2794a756cb24SAndrey Churbanov     if (!task_team->tt.tt_untied_task_encountered) {
2795a756cb24SAndrey Churbanov       // The TSC does not allow to steal victim task
27967cc577a4SJonathan Peyton       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2797c3344345SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #3): T#%d could not steal from "
2798a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2799a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
28007cc577a4SJonathan Peyton                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28017cc577a4SJonathan Peyton       return NULL;
28027cc577a4SJonathan Peyton     }
2803a756cb24SAndrey Churbanov     int i;
2804a756cb24SAndrey Churbanov     // walk through victim's deque trying to steal any task
2805a756cb24SAndrey Churbanov     target = victim_td->td.td_deque_head;
2806c3344345SAndrey Churbanov     taskdata = NULL;
2807a756cb24SAndrey Churbanov     for (i = 1; i < ntasks; ++i) {
2808a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2809a756cb24SAndrey Churbanov       taskdata = victim_td->td.td_deque[target];
2810c3344345SAndrey Churbanov       if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2811c3344345SAndrey Churbanov         break; // found victim task
2812c3344345SAndrey Churbanov       } else {
2813a756cb24SAndrey Churbanov         taskdata = NULL;
2814a756cb24SAndrey Churbanov       }
2815a756cb24SAndrey Churbanov     }
2816a756cb24SAndrey Churbanov     if (taskdata == NULL) {
2817a756cb24SAndrey Churbanov       // No appropriate candidate to steal found
2818a756cb24SAndrey Churbanov       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2819a756cb24SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #4): T#%d could not steal from "
2820a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2821a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2822a756cb24SAndrey Churbanov                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
2823a756cb24SAndrey Churbanov       return NULL;
2824a756cb24SAndrey Churbanov     }
2825a756cb24SAndrey Churbanov     int prev = target;
2826a756cb24SAndrey Churbanov     for (i = i + 1; i < ntasks; ++i) {
2827a756cb24SAndrey Churbanov       // shift remaining tasks in the deque left by 1
2828a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2829a756cb24SAndrey Churbanov       victim_td->td.td_deque[prev] = victim_td->td.td_deque[target];
2830a756cb24SAndrey Churbanov       prev = target;
2831a756cb24SAndrey Churbanov     }
2832baad3f60SJonathan Peyton     KMP_DEBUG_ASSERT(
2833baad3f60SJonathan Peyton         victim_td->td.td_deque_tail ==
2834baad3f60SJonathan Peyton         (kmp_uint32)((target + 1) & TASK_DEQUE_MASK(victim_td->td)));
2835a756cb24SAndrey Churbanov     victim_td->td.td_deque_tail = target; // tail -= 1 (wrapped))
2836a756cb24SAndrey Churbanov   }
28377cc577a4SJonathan Peyton   if (*thread_finished) {
28383041982dSJonathan Peyton     // We need to un-mark this victim as a finished victim.  This must be done
28393041982dSJonathan Peyton     // before releasing the lock, or else other threads (starting with the
284097d000cfStlwilmar     // primary thread victim) might be prematurely released from the barrier!!!
2841c47afcd9SAndrey Churbanov     kmp_int32 count;
28427cc577a4SJonathan Peyton 
284337e2ef54SJonathan Peyton     count = KMP_ATOMIC_INC(unfinished_threads);
28447cc577a4SJonathan Peyton 
28453041982dSJonathan Peyton     KA_TRACE(
28463041982dSJonathan Peyton         20,
28473041982dSJonathan Peyton         ("__kmp_steal_task: T#%d inc unfinished_threads to %d: task_team=%p\n",
28487cc577a4SJonathan Peyton          gtid, count + 1, task_team));
28497cc577a4SJonathan Peyton 
28507cc577a4SJonathan Peyton     *thread_finished = FALSE;
28517cc577a4SJonathan Peyton   }
2852a756cb24SAndrey Churbanov   TCW_4(victim_td->td.td_deque_ntasks, ntasks - 1);
28533041982dSJonathan Peyton 
28547cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
28557cc577a4SJonathan Peyton 
28567cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(TASK_stolen);
2857a756cb24SAndrey Churbanov   KA_TRACE(10,
2858a756cb24SAndrey Churbanov            ("__kmp_steal_task(exit #5): T#%d stole task %p from T#%d: "
2859a756cb24SAndrey Churbanov             "task_team=%p ntasks=%d head=%u tail=%u\n",
2860a756cb24SAndrey Churbanov             gtid, taskdata, __kmp_gtid_from_thread(victim_thr), task_team,
2861a756cb24SAndrey Churbanov             ntasks, victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28627cc577a4SJonathan Peyton 
28637cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
28647cc577a4SJonathan Peyton   return task;
28657cc577a4SJonathan Peyton }
28667cc577a4SJonathan Peyton 
28673041982dSJonathan Peyton // __kmp_execute_tasks_template: Choose and execute tasks until either the
28683041982dSJonathan Peyton // condition is statisfied (return true) or there are none left (return false).
28693041982dSJonathan Peyton //
28707cc577a4SJonathan Peyton // final_spin is TRUE if this is the spin at the release barrier.
28717cc577a4SJonathan Peyton // thread_finished indicates whether the thread is finished executing all
28727cc577a4SJonathan Peyton // the tasks it has on its deque, and is at the release barrier.
28737cc577a4SJonathan Peyton // spinner is the location on which to spin.
28747cc577a4SJonathan Peyton // spinner == NULL means only execute a single task and return.
28757cc577a4SJonathan Peyton // checker is the value to check to terminate the spin.
28767cc577a4SJonathan Peyton template <class C>
28773041982dSJonathan Peyton static inline int __kmp_execute_tasks_template(
28783041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, C *flag, int final_spin,
28793041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
28803041982dSJonathan Peyton     kmp_int32 is_constrained) {
28817cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
28827cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
28837cc577a4SJonathan Peyton   kmp_task_t *task;
28847cc577a4SJonathan Peyton   kmp_info_t *other_thread;
28857cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
288637e2ef54SJonathan Peyton   std::atomic<kmp_int32> *unfinished_threads;
2887a756cb24SAndrey Churbanov   kmp_int32 nthreads, victim_tid = -2, use_own_tasks = 1, new_victim = 0,
28883041982dSJonathan Peyton                       tid = thread->th.th_info.ds.ds_tid;
28897cc577a4SJonathan Peyton 
28907cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
28917cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread == __kmp_threads[gtid]);
28927cc577a4SJonathan Peyton 
2893a4a9c48cSJonathan Peyton   if (task_team == NULL || current_task == NULL)
28943041982dSJonathan Peyton     return FALSE;
28957cc577a4SJonathan Peyton 
28963041982dSJonathan Peyton   KA_TRACE(15, ("__kmp_execute_tasks_template(enter): T#%d final_spin=%d "
28973041982dSJonathan Peyton                 "*thread_finished=%d\n",
28987cc577a4SJonathan Peyton                 gtid, final_spin, *thread_finished));
28997cc577a4SJonathan Peyton 
2900581490e7SAndrey Churbanov   thread->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
29017cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
29029d64275aSShilei Tian 
29037cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
29047cc577a4SJonathan Peyton 
29057cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
29067cc577a4SJonathan Peyton   unfinished_threads = &(task_team->tt.tt_unfinished_threads);
29079d64275aSShilei Tian   KMP_DEBUG_ASSERT(nthreads > 1 || task_team->tt.tt_found_proxy_tasks ||
29089d64275aSShilei Tian                    task_team->tt.tt_hidden_helper_task_encountered);
290937e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(*unfinished_threads >= 0);
29107cc577a4SJonathan Peyton 
29113041982dSJonathan Peyton   while (1) { // Outer loop keeps trying to find tasks in case of single thread
29123041982dSJonathan Peyton     // getting tasks from target constructs
29137cc577a4SJonathan Peyton     while (1) { // Inner loop to find a task and execute it
29147cc577a4SJonathan Peyton       task = NULL;
29157cc577a4SJonathan Peyton       if (use_own_tasks) { // check on own queue first
29167cc577a4SJonathan Peyton         task = __kmp_remove_my_task(thread, gtid, task_team, is_constrained);
29177cc577a4SJonathan Peyton       }
29187cc577a4SJonathan Peyton       if ((task == NULL) && (nthreads > 1)) { // Steal a task
29197cc577a4SJonathan Peyton         int asleep = 1;
29207cc577a4SJonathan Peyton         use_own_tasks = 0;
29217cc577a4SJonathan Peyton         // Try to steal from the last place I stole from successfully.
2922a756cb24SAndrey Churbanov         if (victim_tid == -2) { // haven't stolen anything yet
2923a756cb24SAndrey Churbanov           victim_tid = threads_data[tid].td.td_deque_last_stolen;
2924a756cb24SAndrey Churbanov           if (victim_tid !=
29253041982dSJonathan Peyton               -1) // if we have a last stolen from victim, get the thread
2926a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29277cc577a4SJonathan Peyton         }
2928a756cb24SAndrey Churbanov         if (victim_tid != -1) { // found last victim
29297cc577a4SJonathan Peyton           asleep = 0;
29303041982dSJonathan Peyton         } else if (!new_victim) { // no recent steals and we haven't already
29313041982dSJonathan Peyton           // used a new victim; select a random thread
29327cc577a4SJonathan Peyton           do { // Find a different thread to steal work from.
29333041982dSJonathan Peyton             // Pick a random thread. Initial plan was to cycle through all the
29343041982dSJonathan Peyton             // threads, and only return if we tried to steal from every thread,
29353041982dSJonathan Peyton             // and failed.  Arch says that's not such a great idea.
2936a756cb24SAndrey Churbanov             victim_tid = __kmp_get_random(thread) % (nthreads - 1);
2937a756cb24SAndrey Churbanov             if (victim_tid >= tid) {
2938a756cb24SAndrey Churbanov               ++victim_tid; // Adjusts random distribution to exclude self
29397cc577a4SJonathan Peyton             }
29407cc577a4SJonathan Peyton             // Found a potential victim
2941a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29423041982dSJonathan Peyton             // There is a slight chance that __kmp_enable_tasking() did not wake
29433041982dSJonathan Peyton             // up all threads waiting at the barrier.  If victim is sleeping,
29443041982dSJonathan Peyton             // then wake it up. Since we were going to pay the cache miss
29453041982dSJonathan Peyton             // penalty for referencing another thread's kmp_info_t struct
29463041982dSJonathan Peyton             // anyway,
29473041982dSJonathan Peyton             // the check shouldn't cost too much performance at this point. In
29483041982dSJonathan Peyton             // extra barrier mode, tasks do not sleep at the separate tasking
29493041982dSJonathan Peyton             // barrier, so this isn't a problem.
29507cc577a4SJonathan Peyton             asleep = 0;
29517cc577a4SJonathan Peyton             if ((__kmp_tasking_mode == tskm_task_teams) &&
29527cc577a4SJonathan Peyton                 (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) &&
2953c47afcd9SAndrey Churbanov                 (TCR_PTR(CCAST(void *, other_thread->th.th_sleep_loc)) !=
2954c47afcd9SAndrey Churbanov                  NULL)) {
29557cc577a4SJonathan Peyton               asleep = 1;
29563041982dSJonathan Peyton               __kmp_null_resume_wrapper(__kmp_gtid_from_thread(other_thread),
29573041982dSJonathan Peyton                                         other_thread->th.th_sleep_loc);
29583041982dSJonathan Peyton               // A sleeping thread should not have any tasks on it's queue.
29593041982dSJonathan Peyton               // There is a slight possibility that it resumes, steals a task
29603041982dSJonathan Peyton               // from another thread, which spawns more tasks, all in the time
29613041982dSJonathan Peyton               // that it takes this thread to check => don't write an assertion
29623041982dSJonathan Peyton               // that the victim's queue is empty.  Try stealing from a
29633041982dSJonathan Peyton               // different thread.
29647cc577a4SJonathan Peyton             }
29657cc577a4SJonathan Peyton           } while (asleep);
29667cc577a4SJonathan Peyton         }
29677cc577a4SJonathan Peyton 
29687cc577a4SJonathan Peyton         if (!asleep) {
29697cc577a4SJonathan Peyton           // We have a victim to try to steal from
29703041982dSJonathan Peyton           task = __kmp_steal_task(other_thread, gtid, task_team,
29713041982dSJonathan Peyton                                   unfinished_threads, thread_finished,
29723041982dSJonathan Peyton                                   is_constrained);
29737cc577a4SJonathan Peyton         }
29747cc577a4SJonathan Peyton         if (task != NULL) { // set last stolen to victim
2975a756cb24SAndrey Churbanov           if (threads_data[tid].td.td_deque_last_stolen != victim_tid) {
2976a756cb24SAndrey Churbanov             threads_data[tid].td.td_deque_last_stolen = victim_tid;
29773041982dSJonathan Peyton             // The pre-refactored code did not try more than 1 successful new
29783041982dSJonathan Peyton             // vicitm, unless the last one generated more local tasks;
29793041982dSJonathan Peyton             // new_victim keeps track of this
29807cc577a4SJonathan Peyton             new_victim = 1;
29817cc577a4SJonathan Peyton           }
29823041982dSJonathan Peyton         } else { // No tasks found; unset last_stolen
29837cc577a4SJonathan Peyton           KMP_CHECK_UPDATE(threads_data[tid].td.td_deque_last_stolen, -1);
2984a756cb24SAndrey Churbanov           victim_tid = -2; // no successful victim found
29857cc577a4SJonathan Peyton         }
29867cc577a4SJonathan Peyton       }
29877cc577a4SJonathan Peyton 
29889d64275aSShilei Tian       if (task == NULL)
29899d64275aSShilei Tian         break; // break out of tasking loop
29907cc577a4SJonathan Peyton 
29917cc577a4SJonathan Peyton // Found a task; execute it
29927cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
29937cc577a4SJonathan Peyton       if (__itt_sync_create_ptr || KMP_ITT_DEBUG) {
29943041982dSJonathan Peyton         if (itt_sync_obj == NULL) { // we are at fork barrier where we could not
29953041982dSJonathan Peyton           // get the object reliably
29967cc577a4SJonathan Peyton           itt_sync_obj = __kmp_itt_barrier_object(gtid, bs_forkjoin_barrier);
29977cc577a4SJonathan Peyton         }
29987cc577a4SJonathan Peyton         __kmp_itt_task_starting(itt_sync_obj);
29997cc577a4SJonathan Peyton       }
30007cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY */
30017cc577a4SJonathan Peyton       __kmp_invoke_task(gtid, task, current_task);
30027cc577a4SJonathan Peyton #if USE_ITT_BUILD
30033041982dSJonathan Peyton       if (itt_sync_obj != NULL)
30043041982dSJonathan Peyton         __kmp_itt_task_finished(itt_sync_obj);
30057cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
30063041982dSJonathan Peyton       // If this thread is only partway through the barrier and the condition is
30073041982dSJonathan Peyton       // met, then return now, so that the barrier gather/release pattern can
30083041982dSJonathan Peyton       // proceed. If this thread is in the last spin loop in the barrier,
30093041982dSJonathan Peyton       // waiting to be released, we know that the termination condition will not
301042016791SKazuaki Ishizaki       // be satisfied, so don't waste any cycles checking it.
30117cc577a4SJonathan Peyton       if (flag == NULL || (!final_spin && flag->done_check())) {
30123041982dSJonathan Peyton         KA_TRACE(
30133041982dSJonathan Peyton             15,
30143041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30153041982dSJonathan Peyton              gtid));
30167cc577a4SJonathan Peyton         return TRUE;
30177cc577a4SJonathan Peyton       }
30187cc577a4SJonathan Peyton       if (thread->th.th_task_team == NULL) {
30197cc577a4SJonathan Peyton         break;
30207cc577a4SJonathan Peyton       }
3021e47d32f1SJonathan Peyton       KMP_YIELD(__kmp_library == library_throughput); // Yield before next task
30223041982dSJonathan Peyton       // If execution of a stolen task results in more tasks being placed on our
30233041982dSJonathan Peyton       // run queue, reset use_own_tasks
30247cc577a4SJonathan Peyton       if (!use_own_tasks && TCR_4(threads_data[tid].td.td_deque_ntasks) != 0) {
30253041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d stolen task spawned "
30263041982dSJonathan Peyton                       "other tasks, restart\n",
30273041982dSJonathan Peyton                       gtid));
30287cc577a4SJonathan Peyton         use_own_tasks = 1;
30297cc577a4SJonathan Peyton         new_victim = 0;
30307cc577a4SJonathan Peyton       }
30317cc577a4SJonathan Peyton     }
30327cc577a4SJonathan Peyton 
3033e4b4f994SJonathan Peyton     // The task source has been exhausted. If in final spin loop of barrier,
3034e4b4f994SJonathan Peyton     // check if termination condition is satisfied. The work queue may be empty
3035e4b4f994SJonathan Peyton     // but there might be proxy tasks still executing.
303637e2ef54SJonathan Peyton     if (final_spin &&
3037e4b4f994SJonathan Peyton         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks) == 0) {
30383041982dSJonathan Peyton       // First, decrement the #unfinished threads, if that has not already been
30393041982dSJonathan Peyton       // done.  This decrement might be to the spin location, and result in the
30403041982dSJonathan Peyton       // termination condition being satisfied.
30417cc577a4SJonathan Peyton       if (!*thread_finished) {
3042c47afcd9SAndrey Churbanov         kmp_int32 count;
30437cc577a4SJonathan Peyton 
304437e2ef54SJonathan Peyton         count = KMP_ATOMIC_DEC(unfinished_threads) - 1;
30453041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d dec "
30463041982dSJonathan Peyton                       "unfinished_threads to %d task_team=%p\n",
30477cc577a4SJonathan Peyton                       gtid, count, task_team));
30487cc577a4SJonathan Peyton         *thread_finished = TRUE;
30497cc577a4SJonathan Peyton       }
30507cc577a4SJonathan Peyton 
30517cc577a4SJonathan Peyton       // It is now unsafe to reference thread->th.th_team !!!
305297d000cfStlwilmar       // Decrementing task_team->tt.tt_unfinished_threads can allow the primary
30533041982dSJonathan Peyton       // thread to pass through the barrier, where it might reset each thread's
30543041982dSJonathan Peyton       // th.th_team field for the next parallel region. If we can steal more
30553041982dSJonathan Peyton       // work, we know that this has not happened yet.
30567cc577a4SJonathan Peyton       if (flag != NULL && flag->done_check()) {
30573041982dSJonathan Peyton         KA_TRACE(
30583041982dSJonathan Peyton             15,
30593041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30603041982dSJonathan Peyton              gtid));
30617cc577a4SJonathan Peyton         return TRUE;
30627cc577a4SJonathan Peyton       }
30637cc577a4SJonathan Peyton     }
30647cc577a4SJonathan Peyton 
306597d000cfStlwilmar     // If this thread's task team is NULL, primary thread has recognized that
306697d000cfStlwilmar     // there are no more tasks; bail out
30677cc577a4SJonathan Peyton     if (thread->th.th_task_team == NULL) {
30683041982dSJonathan Peyton       KA_TRACE(15,
30693041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d no more tasks\n", gtid));
30707cc577a4SJonathan Peyton       return FALSE;
30717cc577a4SJonathan Peyton     }
30727cc577a4SJonathan Peyton 
30733041982dSJonathan Peyton     // We could be getting tasks from target constructs; if this is the only
30743041982dSJonathan Peyton     // thread, keep trying to execute tasks from own queue
30759d64275aSShilei Tian     if (nthreads == 1 &&
30769d64275aSShilei Tian         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks))
30777cc577a4SJonathan Peyton       use_own_tasks = 1;
3078e4b4f994SJonathan Peyton     else {
30793041982dSJonathan Peyton       KA_TRACE(15,
30803041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d can't find work\n", gtid));
30817cc577a4SJonathan Peyton       return FALSE;
30827cc577a4SJonathan Peyton     }
30837cc577a4SJonathan Peyton   }
30847cc577a4SJonathan Peyton }
30857cc577a4SJonathan Peyton 
3086e0665a90STerry Wilmarth template <bool C, bool S>
30873041982dSJonathan Peyton int __kmp_execute_tasks_32(
3088e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32<C, S> *flag, int final_spin,
30893041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30903041982dSJonathan Peyton     kmp_int32 is_constrained) {
30913041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30923041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30933041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30947cc577a4SJonathan Peyton }
30957cc577a4SJonathan Peyton 
3096e0665a90STerry Wilmarth template <bool C, bool S>
30973041982dSJonathan Peyton int __kmp_execute_tasks_64(
3098e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64<C, S> *flag, int final_spin,
30993041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31003041982dSJonathan Peyton     kmp_int32 is_constrained) {
31013041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31023041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31033041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31047cc577a4SJonathan Peyton }
31057cc577a4SJonathan Peyton 
31063041982dSJonathan Peyton int __kmp_execute_tasks_oncore(
31073041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
31083041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31093041982dSJonathan Peyton     kmp_int32 is_constrained) {
31103041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31113041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31123041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31137cc577a4SJonathan Peyton }
31147cc577a4SJonathan Peyton 
3115e0665a90STerry Wilmarth template int
3116e0665a90STerry Wilmarth __kmp_execute_tasks_32<false, false>(kmp_info_t *, kmp_int32,
3117e0665a90STerry Wilmarth                                      kmp_flag_32<false, false> *, int,
3118e0665a90STerry Wilmarth                                      int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3119e0665a90STerry Wilmarth 
3120e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<false, true>(kmp_info_t *, kmp_int32,
3121e0665a90STerry Wilmarth                                                  kmp_flag_64<false, true> *,
3122e0665a90STerry Wilmarth                                                  int,
3123e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3124e0665a90STerry Wilmarth                                                  kmp_int32);
3125e0665a90STerry Wilmarth 
3126e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<true, false>(kmp_info_t *, kmp_int32,
3127e0665a90STerry Wilmarth                                                  kmp_flag_64<true, false> *,
3128e0665a90STerry Wilmarth                                                  int,
3129e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3130e0665a90STerry Wilmarth                                                  kmp_int32);
3131e0665a90STerry Wilmarth 
31327cc577a4SJonathan Peyton // __kmp_enable_tasking: Allocate task team and resume threads sleeping at the
31337cc577a4SJonathan Peyton // next barrier so they can assist in executing enqueued tasks.
31347cc577a4SJonathan Peyton // First thread in allocates the task team atomically.
31353041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
31363041982dSJonathan Peyton                                  kmp_info_t *this_thr) {
31377cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
31387cc577a4SJonathan Peyton   int nthreads, i, is_init_thread;
31397cc577a4SJonathan Peyton 
31407cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(enter): T#%d\n",
31417cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31427cc577a4SJonathan Peyton 
31437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
31447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr->th.th_team != NULL);
31457cc577a4SJonathan Peyton 
31467cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
31477cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 0);
31487cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads == this_thr->th.th_team->t.t_nproc);
31497cc577a4SJonathan Peyton 
31507cc577a4SJonathan Peyton   // Allocate or increase the size of threads_data if necessary
31517cc577a4SJonathan Peyton   is_init_thread = __kmp_realloc_task_threads_data(this_thr, task_team);
31527cc577a4SJonathan Peyton 
31537cc577a4SJonathan Peyton   if (!is_init_thread) {
31547cc577a4SJonathan Peyton     // Some other thread already set up the array.
31553041982dSJonathan Peyton     KA_TRACE(
31563041982dSJonathan Peyton         20,
31573041982dSJonathan Peyton         ("__kmp_enable_tasking(exit): T#%d: threads array already set up.\n",
31587cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr)));
31597cc577a4SJonathan Peyton     return;
31607cc577a4SJonathan Peyton   }
31617cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
31627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
31637cc577a4SJonathan Peyton 
31649b8bb323SJonathan Peyton   if (__kmp_tasking_mode == tskm_task_teams &&
31653041982dSJonathan Peyton       (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME)) {
31667cc577a4SJonathan Peyton     // Release any threads sleeping at the barrier, so that they can steal
31677cc577a4SJonathan Peyton     // tasks and execute them.  In extra barrier mode, tasks do not sleep
31687cc577a4SJonathan Peyton     // at the separate tasking barrier, so this isn't a problem.
31697cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
31707cc577a4SJonathan Peyton       volatile void *sleep_loc;
31717cc577a4SJonathan Peyton       kmp_info_t *thread = threads_data[i].td.td_thr;
31727cc577a4SJonathan Peyton 
31737cc577a4SJonathan Peyton       if (i == this_thr->th.th_info.ds.ds_tid) {
31747cc577a4SJonathan Peyton         continue;
31757cc577a4SJonathan Peyton       }
31767cc577a4SJonathan Peyton       // Since we haven't locked the thread's suspend mutex lock at this
31777cc577a4SJonathan Peyton       // point, there is a small window where a thread might be putting
31787cc577a4SJonathan Peyton       // itself to sleep, but hasn't set the th_sleep_loc field yet.
31797cc577a4SJonathan Peyton       // To work around this, __kmp_execute_tasks_template() periodically checks
31803041982dSJonathan Peyton       // see if other threads are sleeping (using the same random mechanism that
31813041982dSJonathan Peyton       // is used for task stealing) and awakens them if they are.
3182c47afcd9SAndrey Churbanov       if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3183c47afcd9SAndrey Churbanov           NULL) {
31847cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d waking up thread T#%d\n",
31857cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31867cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31877cc577a4SJonathan Peyton         __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
31883041982dSJonathan Peyton       } else {
31897cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d don't wake up thread T#%d\n",
31907cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31917cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31927cc577a4SJonathan Peyton       }
31937cc577a4SJonathan Peyton     }
31947cc577a4SJonathan Peyton   }
31957cc577a4SJonathan Peyton 
31967cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(exit): T#%d\n",
31977cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31987cc577a4SJonathan Peyton }
31997cc577a4SJonathan Peyton 
32007cc577a4SJonathan Peyton /* // TODO: Check the comment consistency
32017cc577a4SJonathan Peyton  * Utility routines for "task teams".  A task team (kmp_task_t) is kind of
32027cc577a4SJonathan Peyton  * like a shadow of the kmp_team_t data struct, with a different lifetime.
32037cc577a4SJonathan Peyton  * After a child * thread checks into a barrier and calls __kmp_release() from
32047cc577a4SJonathan Peyton  * the particular variant of __kmp_<barrier_kind>_barrier_gather(), it can no
32057cc577a4SJonathan Peyton  * longer assume that the kmp_team_t structure is intact (at any moment, the
320697d000cfStlwilmar  * primary thread may exit the barrier code and free the team data structure,
32077cc577a4SJonathan Peyton  * and return the threads to the thread pool).
32087cc577a4SJonathan Peyton  *
3209ed5fe645SKelvin Li  * This does not work with the tasking code, as the thread is still
32107cc577a4SJonathan Peyton  * expected to participate in the execution of any tasks that may have been
32117cc577a4SJonathan Peyton  * spawned my a member of the team, and the thread still needs access to all
32127cc577a4SJonathan Peyton  * to each thread in the team, so that it can steal work from it.
32137cc577a4SJonathan Peyton  *
32147cc577a4SJonathan Peyton  * Enter the existence of the kmp_task_team_t struct.  It employs a reference
321597d000cfStlwilmar  * counting mechanism, and is allocated by the primary thread before calling
32167cc577a4SJonathan Peyton  * __kmp_<barrier_kind>_release, and then is release by the last thread to
32177cc577a4SJonathan Peyton  * exit __kmp_<barrier_kind>_release at the next barrier.  I.e. the lifetimes
32187cc577a4SJonathan Peyton  * of the kmp_task_team_t structs for consecutive barriers can overlap
321997d000cfStlwilmar  * (and will, unless the primary thread is the last thread to exit the barrier
3220e4b4f994SJonathan Peyton  * release phase, which is not typical). The existence of such a struct is
3221e4b4f994SJonathan Peyton  * useful outside the context of tasking.
32227cc577a4SJonathan Peyton  *
32237cc577a4SJonathan Peyton  * We currently use the existence of the threads array as an indicator that
32247cc577a4SJonathan Peyton  * tasks were spawned since the last barrier.  If the structure is to be
32257cc577a4SJonathan Peyton  * useful outside the context of tasking, then this will have to change, but
322642016791SKazuaki Ishizaki  * not setting the field minimizes the performance impact of tasking on
32277cc577a4SJonathan Peyton  * barriers, when no explicit tasks were spawned (pushed, actually).
32287cc577a4SJonathan Peyton  */
32297cc577a4SJonathan Peyton 
32303041982dSJonathan Peyton static kmp_task_team_t *__kmp_free_task_teams =
32313041982dSJonathan Peyton     NULL; // Free list for task_team data structures
32327cc577a4SJonathan Peyton // Lock for task team data structures
3233eaa9e40cSJonathan Peyton kmp_bootstrap_lock_t __kmp_task_team_lock =
32343041982dSJonathan Peyton     KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_task_team_lock);
32357cc577a4SJonathan Peyton 
32367cc577a4SJonathan Peyton // __kmp_alloc_task_deque:
32377cc577a4SJonathan Peyton // Allocates a task deque for a particular thread, and initialize the necessary
32387cc577a4SJonathan Peyton // data structures relating to the deque.  This only happens once per thread
32393041982dSJonathan Peyton // per task team since task teams are recycled. No lock is needed during
32403041982dSJonathan Peyton // allocation since each thread allocates its own deque.
32413041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
32423041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data) {
32437cc577a4SJonathan Peyton   __kmp_init_bootstrap_lock(&thread_data->td.td_deque_lock);
32447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque == NULL);
32457cc577a4SJonathan Peyton 
32467cc577a4SJonathan Peyton   // Initialize last stolen task field to "none"
32477cc577a4SJonathan Peyton   thread_data->td.td_deque_last_stolen = -1;
32487cc577a4SJonathan Peyton 
32497cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == 0);
32507cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_head == 0);
32517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_tail == 0);
32527cc577a4SJonathan Peyton 
32533041982dSJonathan Peyton   KE_TRACE(
32543041982dSJonathan Peyton       10,
32553041982dSJonathan Peyton       ("__kmp_alloc_task_deque: T#%d allocating deque[%d] for thread_data %p\n",
32567cc577a4SJonathan Peyton        __kmp_gtid_from_thread(thread), INITIAL_TASK_DEQUE_SIZE, thread_data));
32577cc577a4SJonathan Peyton   // Allocate space for task deque, and zero the deque
32587cc577a4SJonathan Peyton   // Cannot use __kmp_thread_calloc() because threads not around for
32597cc577a4SJonathan Peyton   // kmp_reap_task_team( ).
32603041982dSJonathan Peyton   thread_data->td.td_deque = (kmp_taskdata_t **)__kmp_allocate(
32613041982dSJonathan Peyton       INITIAL_TASK_DEQUE_SIZE * sizeof(kmp_taskdata_t *));
32627cc577a4SJonathan Peyton   thread_data->td.td_deque_size = INITIAL_TASK_DEQUE_SIZE;
32637cc577a4SJonathan Peyton }
32647cc577a4SJonathan Peyton 
32657cc577a4SJonathan Peyton // __kmp_free_task_deque:
32663041982dSJonathan Peyton // Deallocates a task deque for a particular thread. Happens at library
32673041982dSJonathan Peyton // deallocation so don't need to reset all thread data fields.
32683041982dSJonathan Peyton static void __kmp_free_task_deque(kmp_thread_data_t *thread_data) {
32697cc577a4SJonathan Peyton   if (thread_data->td.td_deque != NULL) {
32701b536724SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
32717cc577a4SJonathan Peyton     TCW_4(thread_data->td.td_deque_ntasks, 0);
32727cc577a4SJonathan Peyton     __kmp_free(thread_data->td.td_deque);
32737cc577a4SJonathan Peyton     thread_data->td.td_deque = NULL;
32747cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
32751b536724SJonathan Peyton   }
32767cc577a4SJonathan Peyton 
32777cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
32787cc577a4SJonathan Peyton   // GEH: Figure out what to do here for td_susp_tied_tasks
32797cc577a4SJonathan Peyton   if (thread_data->td.td_susp_tied_tasks.ts_entries != TASK_STACK_EMPTY) {
32807cc577a4SJonathan Peyton     __kmp_free_task_stack(__kmp_thread_from_gtid(gtid), thread_data);
32817cc577a4SJonathan Peyton   }
32827cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
32837cc577a4SJonathan Peyton }
32847cc577a4SJonathan Peyton 
32857cc577a4SJonathan Peyton // __kmp_realloc_task_threads_data:
32863041982dSJonathan Peyton // Allocates a threads_data array for a task team, either by allocating an
32873041982dSJonathan Peyton // initial array or enlarging an existing array.  Only the first thread to get
32884c6a098aSKazuaki Ishizaki // the lock allocs or enlarges the array and re-initializes the array elements.
32897cc577a4SJonathan Peyton // That thread returns "TRUE", the rest return "FALSE".
32907cc577a4SJonathan Peyton // Assumes that the new array size is given by task_team -> tt.tt_nproc.
32917cc577a4SJonathan Peyton // The current size is given by task_team -> tt.tt_max_threads.
32923041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
32933041982dSJonathan Peyton                                            kmp_task_team_t *task_team) {
32947cc577a4SJonathan Peyton   kmp_thread_data_t **threads_data_p;
32957cc577a4SJonathan Peyton   kmp_int32 nthreads, maxthreads;
32967cc577a4SJonathan Peyton   int is_init_thread = FALSE;
32977cc577a4SJonathan Peyton 
32987cc577a4SJonathan Peyton   if (TCR_4(task_team->tt.tt_found_tasks)) {
32997cc577a4SJonathan Peyton     // Already reallocated and initialized.
33007cc577a4SJonathan Peyton     return FALSE;
33017cc577a4SJonathan Peyton   }
33027cc577a4SJonathan Peyton 
33037cc577a4SJonathan Peyton   threads_data_p = &task_team->tt.tt_threads_data;
33047cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
33057cc577a4SJonathan Peyton   maxthreads = task_team->tt.tt_max_threads;
33067cc577a4SJonathan Peyton 
33073041982dSJonathan Peyton   // All threads must lock when they encounter the first task of the implicit
33083041982dSJonathan Peyton   // task region to make sure threads_data fields are (re)initialized before
33093041982dSJonathan Peyton   // used.
33107cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
33117cc577a4SJonathan Peyton 
33127cc577a4SJonathan Peyton   if (!TCR_4(task_team->tt.tt_found_tasks)) {
33137cc577a4SJonathan Peyton     // first thread to enable tasking
33147cc577a4SJonathan Peyton     kmp_team_t *team = thread->th.th_team;
33157cc577a4SJonathan Peyton     int i;
33167cc577a4SJonathan Peyton 
33177cc577a4SJonathan Peyton     is_init_thread = TRUE;
33187cc577a4SJonathan Peyton     if (maxthreads < nthreads) {
33197cc577a4SJonathan Peyton 
33207cc577a4SJonathan Peyton       if (*threads_data_p != NULL) {
33217cc577a4SJonathan Peyton         kmp_thread_data_t *old_data = *threads_data_p;
33227cc577a4SJonathan Peyton         kmp_thread_data_t *new_data = NULL;
33237cc577a4SJonathan Peyton 
33243041982dSJonathan Peyton         KE_TRACE(
33253041982dSJonathan Peyton             10,
33263041982dSJonathan Peyton             ("__kmp_realloc_task_threads_data: T#%d reallocating "
33277cc577a4SJonathan Peyton              "threads data for task_team %p, new_size = %d, old_size = %d\n",
33283041982dSJonathan Peyton              __kmp_gtid_from_thread(thread), task_team, nthreads, maxthreads));
33297cc577a4SJonathan Peyton         // Reallocate threads_data to have more elements than current array
33307cc577a4SJonathan Peyton         // Cannot use __kmp_thread_realloc() because threads not around for
33317cc577a4SJonathan Peyton         // kmp_reap_task_team( ).  Note all new array entries are initialized
33327cc577a4SJonathan Peyton         // to zero by __kmp_allocate().
33333041982dSJonathan Peyton         new_data = (kmp_thread_data_t *)__kmp_allocate(
33343041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33357cc577a4SJonathan Peyton         // copy old data to new data
33367cc577a4SJonathan Peyton         KMP_MEMCPY_S((void *)new_data, nthreads * sizeof(kmp_thread_data_t),
333771483f2dSAndrey Churbanov                      (void *)old_data, maxthreads * sizeof(kmp_thread_data_t));
33387cc577a4SJonathan Peyton 
33397cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33407cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33417cc577a4SJonathan Peyton         for (i = maxthreads; i < nthreads; i++) {
33427cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33437cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33447cc577a4SJonathan Peyton         }
33457cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33467cc577a4SJonathan Peyton        // Install the new data and free the old data
33477cc577a4SJonathan Peyton         (*threads_data_p) = new_data;
33487cc577a4SJonathan Peyton         __kmp_free(old_data);
33493041982dSJonathan Peyton       } else {
33507cc577a4SJonathan Peyton         KE_TRACE(10, ("__kmp_realloc_task_threads_data: T#%d allocating "
33517cc577a4SJonathan Peyton                       "threads data for task_team %p, size = %d\n",
33527cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread), task_team, nthreads));
33537cc577a4SJonathan Peyton         // Make the initial allocate for threads_data array, and zero entries
33547cc577a4SJonathan Peyton         // Cannot use __kmp_thread_calloc() because threads not around for
33557cc577a4SJonathan Peyton         // kmp_reap_task_team( ).
33567cc577a4SJonathan Peyton         ANNOTATE_IGNORE_WRITES_BEGIN();
33573041982dSJonathan Peyton         *threads_data_p = (kmp_thread_data_t *)__kmp_allocate(
33583041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33597cc577a4SJonathan Peyton         ANNOTATE_IGNORE_WRITES_END();
33607cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33617cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33627cc577a4SJonathan Peyton         for (i = 0; i < nthreads; i++) {
33637cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33647cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33657cc577a4SJonathan Peyton         }
33667cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33677cc577a4SJonathan Peyton       }
33687cc577a4SJonathan Peyton       task_team->tt.tt_max_threads = nthreads;
33693041982dSJonathan Peyton     } else {
33707cc577a4SJonathan Peyton       // If array has (more than) enough elements, go ahead and use it
33717cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(*threads_data_p != NULL);
33727cc577a4SJonathan Peyton     }
33737cc577a4SJonathan Peyton 
33747cc577a4SJonathan Peyton     // initialize threads_data pointers back to thread_info structures
33757cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
33767cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33777cc577a4SJonathan Peyton       thread_data->td.td_thr = team->t.t_threads[i];
33787cc577a4SJonathan Peyton 
33797cc577a4SJonathan Peyton       if (thread_data->td.td_deque_last_stolen >= nthreads) {
33807cc577a4SJonathan Peyton         // The last stolen field survives across teams / barrier, and the number
33817cc577a4SJonathan Peyton         // of threads may have changed.  It's possible (likely?) that a new
33823041982dSJonathan Peyton         // parallel region will exhibit the same behavior as previous region.
33837cc577a4SJonathan Peyton         thread_data->td.td_deque_last_stolen = -1;
33847cc577a4SJonathan Peyton       }
33857cc577a4SJonathan Peyton     }
33867cc577a4SJonathan Peyton 
33877cc577a4SJonathan Peyton     KMP_MB();
33887cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_tasks, TRUE);
33897cc577a4SJonathan Peyton   }
33907cc577a4SJonathan Peyton 
33917cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
33927cc577a4SJonathan Peyton   return is_init_thread;
33937cc577a4SJonathan Peyton }
33947cc577a4SJonathan Peyton 
33957cc577a4SJonathan Peyton // __kmp_free_task_threads_data:
33967cc577a4SJonathan Peyton // Deallocates a threads_data array for a task team, including any attached
33977cc577a4SJonathan Peyton // tasking deques.  Only occurs at library shutdown.
33983041982dSJonathan Peyton static void __kmp_free_task_threads_data(kmp_task_team_t *task_team) {
33997cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
34007cc577a4SJonathan Peyton   if (task_team->tt.tt_threads_data != NULL) {
34017cc577a4SJonathan Peyton     int i;
34027cc577a4SJonathan Peyton     for (i = 0; i < task_team->tt.tt_max_threads; i++) {
34037cc577a4SJonathan Peyton       __kmp_free_task_deque(&task_team->tt.tt_threads_data[i]);
34047cc577a4SJonathan Peyton     }
34057cc577a4SJonathan Peyton     __kmp_free(task_team->tt.tt_threads_data);
34067cc577a4SJonathan Peyton     task_team->tt.tt_threads_data = NULL;
34077cc577a4SJonathan Peyton   }
34087cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
34097cc577a4SJonathan Peyton }
34107cc577a4SJonathan Peyton 
34117cc577a4SJonathan Peyton // __kmp_allocate_task_team:
34127cc577a4SJonathan Peyton // Allocates a task team associated with a specific team, taking it from
34133041982dSJonathan Peyton // the global task team free list if possible.  Also initializes data
34143041982dSJonathan Peyton // structures.
34153041982dSJonathan Peyton static kmp_task_team_t *__kmp_allocate_task_team(kmp_info_t *thread,
34163041982dSJonathan Peyton                                                  kmp_team_t *team) {
34177cc577a4SJonathan Peyton   kmp_task_team_t *task_team = NULL;
34187cc577a4SJonathan Peyton   int nthreads;
34197cc577a4SJonathan Peyton 
34207cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d entering; team = %p\n",
34217cc577a4SJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), team));
34227cc577a4SJonathan Peyton 
34237cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
34247cc577a4SJonathan Peyton     // Take a task team from the task team pool
34257cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34267cc577a4SJonathan Peyton     if (__kmp_free_task_teams != NULL) {
34277cc577a4SJonathan Peyton       task_team = __kmp_free_task_teams;
34287cc577a4SJonathan Peyton       TCW_PTR(__kmp_free_task_teams, task_team->tt.tt_next);
34297cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
34307cc577a4SJonathan Peyton     }
34317cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34327cc577a4SJonathan Peyton   }
34337cc577a4SJonathan Peyton 
34347cc577a4SJonathan Peyton   if (task_team == NULL) {
34357cc577a4SJonathan Peyton     KE_TRACE(10, ("__kmp_allocate_task_team: T#%d allocating "
34367cc577a4SJonathan Peyton                   "task team for team %p\n",
34377cc577a4SJonathan Peyton                   __kmp_gtid_from_thread(thread), team));
3438ffd8f009SAndreyChurbanov     // Allocate a new task team if one is not available. Cannot use
3439ffd8f009SAndreyChurbanov     // __kmp_thread_malloc because threads not around for kmp_reap_task_team.
34407cc577a4SJonathan Peyton     task_team = (kmp_task_team_t *)__kmp_allocate(sizeof(kmp_task_team_t));
34417cc577a4SJonathan Peyton     __kmp_init_bootstrap_lock(&task_team->tt.tt_threads_lock);
3442ffd8f009SAndreyChurbanov #if USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG
3443ffd8f009SAndreyChurbanov     // suppress race conditions detection on synchronization flags in debug mode
3444ffd8f009SAndreyChurbanov     // this helps to analyze library internals eliminating false positives
3445ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(
3446ffd8f009SAndreyChurbanov         __itt_suppress_range, __itt_suppress_threading_errors,
3447ffd8f009SAndreyChurbanov         &task_team->tt.tt_found_tasks, sizeof(task_team->tt.tt_found_tasks));
3448ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(__itt_suppress_range,
3449ffd8f009SAndreyChurbanov                               __itt_suppress_threading_errors,
3450ffd8f009SAndreyChurbanov                               CCAST(kmp_uint32 *, &task_team->tt.tt_active),
3451ffd8f009SAndreyChurbanov                               sizeof(task_team->tt.tt_active));
3452ffd8f009SAndreyChurbanov #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG */
3453ffd8f009SAndreyChurbanov     // Note: __kmp_allocate zeroes returned memory, othewise we would need:
34543041982dSJonathan Peyton     // task_team->tt.tt_threads_data = NULL;
34557cc577a4SJonathan Peyton     // task_team->tt.tt_max_threads = 0;
34567cc577a4SJonathan Peyton     // task_team->tt.tt_next = NULL;
34577cc577a4SJonathan Peyton   }
34587cc577a4SJonathan Peyton 
34597cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_tasks, FALSE);
34607cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
34617cc577a4SJonathan Peyton   task_team->tt.tt_nproc = nthreads = team->t.t_nproc;
34627cc577a4SJonathan Peyton 
346337e2ef54SJonathan Peyton   KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads, nthreads);
34649d64275aSShilei Tian   TCW_4(task_team->tt.tt_hidden_helper_task_encountered, FALSE);
34657cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_active, TRUE);
34667cc577a4SJonathan Peyton 
34673041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d exiting; task_team = %p "
34683041982dSJonathan Peyton                 "unfinished_threads init'd to %d\n",
34693041982dSJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), task_team,
347037e2ef54SJonathan Peyton                 KMP_ATOMIC_LD_RLX(&task_team->tt.tt_unfinished_threads)));
34717cc577a4SJonathan Peyton   return task_team;
34727cc577a4SJonathan Peyton }
34737cc577a4SJonathan Peyton 
34747cc577a4SJonathan Peyton // __kmp_free_task_team:
34757cc577a4SJonathan Peyton // Frees the task team associated with a specific thread, and adds it
34767cc577a4SJonathan Peyton // to the global task team free list.
34773041982dSJonathan Peyton void __kmp_free_task_team(kmp_info_t *thread, kmp_task_team_t *task_team) {
34787cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_free_task_team: T#%d task_team = %p\n",
34797cc577a4SJonathan Peyton                 thread ? __kmp_gtid_from_thread(thread) : -1, task_team));
34807cc577a4SJonathan Peyton 
34817cc577a4SJonathan Peyton   // Put task team back on free list
34827cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34837cc577a4SJonathan Peyton 
34847cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_next == NULL);
34857cc577a4SJonathan Peyton   task_team->tt.tt_next = __kmp_free_task_teams;
34867cc577a4SJonathan Peyton   TCW_PTR(__kmp_free_task_teams, task_team);
34877cc577a4SJonathan Peyton 
34887cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34897cc577a4SJonathan Peyton }
34907cc577a4SJonathan Peyton 
34917cc577a4SJonathan Peyton // __kmp_reap_task_teams:
34927cc577a4SJonathan Peyton // Free all the task teams on the task team free list.
34937cc577a4SJonathan Peyton // Should only be done during library shutdown.
34943041982dSJonathan Peyton // Cannot do anything that needs a thread structure or gtid since they are
34953041982dSJonathan Peyton // already gone.
34963041982dSJonathan Peyton void __kmp_reap_task_teams(void) {
34977cc577a4SJonathan Peyton   kmp_task_team_t *task_team;
34987cc577a4SJonathan Peyton 
34997cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
35007cc577a4SJonathan Peyton     // Free all task_teams on the free list
35017cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
35027cc577a4SJonathan Peyton     while ((task_team = __kmp_free_task_teams) != NULL) {
35037cc577a4SJonathan Peyton       __kmp_free_task_teams = task_team->tt.tt_next;
35047cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
35057cc577a4SJonathan Peyton 
35067cc577a4SJonathan Peyton       // Free threads_data if necessary
35077cc577a4SJonathan Peyton       if (task_team->tt.tt_threads_data != NULL) {
35087cc577a4SJonathan Peyton         __kmp_free_task_threads_data(task_team);
35097cc577a4SJonathan Peyton       }
35107cc577a4SJonathan Peyton       __kmp_free(task_team);
35117cc577a4SJonathan Peyton     }
35127cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
35137cc577a4SJonathan Peyton   }
35147cc577a4SJonathan Peyton }
35157cc577a4SJonathan Peyton 
35167cc577a4SJonathan Peyton // __kmp_wait_to_unref_task_teams:
35177cc577a4SJonathan Peyton // Some threads could still be in the fork barrier release code, possibly
35187cc577a4SJonathan Peyton // trying to steal tasks.  Wait for each thread to unreference its task team.
35193041982dSJonathan Peyton void __kmp_wait_to_unref_task_teams(void) {
35207cc577a4SJonathan Peyton   kmp_info_t *thread;
35217cc577a4SJonathan Peyton   kmp_uint32 spins;
35227cc577a4SJonathan Peyton   int done;
35237cc577a4SJonathan Peyton 
35247cc577a4SJonathan Peyton   KMP_INIT_YIELD(spins);
35257cc577a4SJonathan Peyton 
35267cc577a4SJonathan Peyton   for (;;) {
35277cc577a4SJonathan Peyton     done = TRUE;
35287cc577a4SJonathan Peyton 
35297cc577a4SJonathan Peyton     // TODO: GEH - this may be is wrong because some sync would be necessary
35303041982dSJonathan Peyton     // in case threads are added to the pool during the traversal. Need to
35313041982dSJonathan Peyton     // verify that lock for thread pool is held when calling this routine.
3532c47afcd9SAndrey Churbanov     for (thread = CCAST(kmp_info_t *, __kmp_thread_pool); thread != NULL;
35333041982dSJonathan Peyton          thread = thread->th.th_next_pool) {
35347cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35357cc577a4SJonathan Peyton       DWORD exit_val;
35367cc577a4SJonathan Peyton #endif
35377cc577a4SJonathan Peyton       if (TCR_PTR(thread->th.th_task_team) == NULL) {
35387cc577a4SJonathan Peyton         KA_TRACE(10, ("__kmp_wait_to_unref_task_team: T#%d task_team == NULL\n",
35397cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
35407cc577a4SJonathan Peyton         continue;
35417cc577a4SJonathan Peyton       }
35427cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35437cc577a4SJonathan Peyton       // TODO: GEH - add this check for Linux* OS / OS X* as well?
35447cc577a4SJonathan Peyton       if (!__kmp_is_thread_alive(thread, &exit_val)) {
35457cc577a4SJonathan Peyton         thread->th.th_task_team = NULL;
35467cc577a4SJonathan Peyton         continue;
35477cc577a4SJonathan Peyton       }
35487cc577a4SJonathan Peyton #endif
35497cc577a4SJonathan Peyton 
35507cc577a4SJonathan Peyton       done = FALSE; // Because th_task_team pointer is not NULL for this thread
35517cc577a4SJonathan Peyton 
35523041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_wait_to_unref_task_team: Waiting for T#%d to "
35533041982dSJonathan Peyton                     "unreference task_team\n",
35547cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(thread)));
35557cc577a4SJonathan Peyton 
35567cc577a4SJonathan Peyton       if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
35577cc577a4SJonathan Peyton         volatile void *sleep_loc;
35587cc577a4SJonathan Peyton         // If the thread is sleeping, awaken it.
3559c47afcd9SAndrey Churbanov         if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3560c47afcd9SAndrey Churbanov             NULL) {
35613041982dSJonathan Peyton           KA_TRACE(
35623041982dSJonathan Peyton               10,
35633041982dSJonathan Peyton               ("__kmp_wait_to_unref_task_team: T#%d waking up thread T#%d\n",
35647cc577a4SJonathan Peyton                __kmp_gtid_from_thread(thread), __kmp_gtid_from_thread(thread)));
35657cc577a4SJonathan Peyton           __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
35667cc577a4SJonathan Peyton         }
35677cc577a4SJonathan Peyton       }
35687cc577a4SJonathan Peyton     }
35697cc577a4SJonathan Peyton     if (done) {
35707cc577a4SJonathan Peyton       break;
35717cc577a4SJonathan Peyton     }
35727cc577a4SJonathan Peyton 
3573e47d32f1SJonathan Peyton     // If oversubscribed or have waited a bit, yield.
3574e47d32f1SJonathan Peyton     KMP_YIELD_OVERSUB_ELSE_SPIN(spins);
35757cc577a4SJonathan Peyton   }
35767cc577a4SJonathan Peyton }
35777cc577a4SJonathan Peyton 
35787cc577a4SJonathan Peyton // __kmp_task_team_setup:  Create a task_team for the current team, but use
35797cc577a4SJonathan Peyton // an already created, unused one if it already exists.
35803041982dSJonathan Peyton void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team, int always) {
35817cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
35827cc577a4SJonathan Peyton 
35833041982dSJonathan Peyton   // If this task_team hasn't been created yet, allocate it. It will be used in
35843041982dSJonathan Peyton   // the region after the next.
35853041982dSJonathan Peyton   // If it exists, it is the current task team and shouldn't be touched yet as
35863041982dSJonathan Peyton   // it may still be in use.
35873041982dSJonathan Peyton   if (team->t.t_task_team[this_thr->th.th_task_state] == NULL &&
35883041982dSJonathan Peyton       (always || team->t.t_nproc > 1)) {
35893041982dSJonathan Peyton     team->t.t_task_team[this_thr->th.th_task_state] =
35903041982dSJonathan Peyton         __kmp_allocate_task_team(this_thr, team);
359197d000cfStlwilmar     KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created new task_team %p"
35923041982dSJonathan Peyton                   " for team %d at parity=%d\n",
35933041982dSJonathan Peyton                   __kmp_gtid_from_thread(this_thr),
3594467f3924SHansang Bae                   team->t.t_task_team[this_thr->th.th_task_state], team->t.t_id,
35953041982dSJonathan Peyton                   this_thr->th.th_task_state));
35967cc577a4SJonathan Peyton   }
35977cc577a4SJonathan Peyton 
35983041982dSJonathan Peyton   // After threads exit the release, they will call sync, and then point to this
35993041982dSJonathan Peyton   // other task_team; make sure it is allocated and properly initialized. As
36003041982dSJonathan Peyton   // threads spin in the barrier release phase, they will continue to use the
36013041982dSJonathan Peyton   // previous task_team struct(above), until they receive the signal to stop
36023041982dSJonathan Peyton   // checking for tasks (they can't safely reference the kmp_team_t struct,
360397d000cfStlwilmar   // which could be reallocated by the primary thread). No task teams are formed
36043041982dSJonathan Peyton   // for serialized teams.
36057cc577a4SJonathan Peyton   if (team->t.t_nproc > 1) {
36067cc577a4SJonathan Peyton     int other_team = 1 - this_thr->th.th_task_state;
3607467f3924SHansang Bae     KMP_DEBUG_ASSERT(other_team >= 0 && other_team < 2);
36087cc577a4SJonathan Peyton     if (team->t.t_task_team[other_team] == NULL) { // setup other team as well
36093041982dSJonathan Peyton       team->t.t_task_team[other_team] =
36103041982dSJonathan Peyton           __kmp_allocate_task_team(this_thr, team);
361197d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created second new "
36123041982dSJonathan Peyton                     "task_team %p for team %d at parity=%d\n",
36133041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3614467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36153041982dSJonathan Peyton     } else { // Leave the old task team struct in place for the upcoming region;
36163041982dSJonathan Peyton       // adjust as needed
36177cc577a4SJonathan Peyton       kmp_task_team_t *task_team = team->t.t_task_team[other_team];
36183041982dSJonathan Peyton       if (!task_team->tt.tt_active ||
36193041982dSJonathan Peyton           team->t.t_nproc != task_team->tt.tt_nproc) {
36207cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_nproc, team->t.t_nproc);
36217cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_tasks, FALSE);
36227cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
362337e2ef54SJonathan Peyton         KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads,
362437e2ef54SJonathan Peyton                           team->t.t_nproc);
36257cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_active, TRUE);
36267cc577a4SJonathan Peyton       }
36273041982dSJonathan Peyton       // if team size has changed, the first thread to enable tasking will
36283041982dSJonathan Peyton       // realloc threads_data if necessary
362997d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d reset next task_team "
36303041982dSJonathan Peyton                     "%p for team %d at parity=%d\n",
36313041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3632467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36337cc577a4SJonathan Peyton     }
36347cc577a4SJonathan Peyton   }
36359d64275aSShilei Tian 
36369d64275aSShilei Tian   // For regular thread, task enabling should be called when the task is going
36379d64275aSShilei Tian   // to be pushed to a dequeue. However, for the hidden helper thread, we need
36389d64275aSShilei Tian   // it ahead of time so that some operations can be performed without race
36399d64275aSShilei Tian   // condition.
36409d64275aSShilei Tian   if (this_thr == __kmp_hidden_helper_main_thread) {
36419d64275aSShilei Tian     for (int i = 0; i < 2; ++i) {
36429d64275aSShilei Tian       kmp_task_team_t *task_team = team->t.t_task_team[i];
36439d64275aSShilei Tian       if (KMP_TASKING_ENABLED(task_team)) {
36449d64275aSShilei Tian         continue;
36459d64275aSShilei Tian       }
36469d64275aSShilei Tian       __kmp_enable_tasking(task_team, this_thr);
36479d64275aSShilei Tian       for (int j = 0; j < task_team->tt.tt_nproc; ++j) {
36489d64275aSShilei Tian         kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[j];
36499d64275aSShilei Tian         if (thread_data->td.td_deque == NULL) {
36509d64275aSShilei Tian           __kmp_alloc_task_deque(__kmp_hidden_helper_threads[j], thread_data);
36519d64275aSShilei Tian         }
36529d64275aSShilei Tian       }
36539d64275aSShilei Tian     }
36549d64275aSShilei Tian   }
36557cc577a4SJonathan Peyton }
36567cc577a4SJonathan Peyton 
36577cc577a4SJonathan Peyton // __kmp_task_team_sync: Propagation of task team data from team to threads
36587cc577a4SJonathan Peyton // which happens just after the release phase of a team barrier.  This may be
36597cc577a4SJonathan Peyton // called by any thread, but only for teams with # threads > 1.
36603041982dSJonathan Peyton void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team) {
36617cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36627cc577a4SJonathan Peyton 
36633041982dSJonathan Peyton   // Toggle the th_task_state field, to switch which task_team this thread
36643041982dSJonathan Peyton   // refers to
36656b316febSTerry Wilmarth   this_thr->th.th_task_state = (kmp_uint8)(1 - this_thr->th.th_task_state);
36666b316febSTerry Wilmarth 
36673041982dSJonathan Peyton   // It is now safe to propagate the task team pointer from the team struct to
36683041982dSJonathan Peyton   // the current thread.
36693041982dSJonathan Peyton   TCW_PTR(this_thr->th.th_task_team,
36703041982dSJonathan Peyton           team->t.t_task_team[this_thr->th.th_task_state]);
36713041982dSJonathan Peyton   KA_TRACE(20,
36723041982dSJonathan Peyton            ("__kmp_task_team_sync: Thread T#%d task team switched to task_team "
36733041982dSJonathan Peyton             "%p from Team #%d (parity=%d)\n",
36747cc577a4SJonathan Peyton             __kmp_gtid_from_thread(this_thr), this_thr->th.th_task_team,
3675467f3924SHansang Bae             team->t.t_id, this_thr->th.th_task_state));
36767cc577a4SJonathan Peyton }
36777cc577a4SJonathan Peyton 
367897d000cfStlwilmar // __kmp_task_team_wait: Primary thread waits for outstanding tasks after the
367997d000cfStlwilmar // barrier gather phase. Only called by primary thread if #threads in team > 1
368097d000cfStlwilmar // or if proxy tasks were created.
36813041982dSJonathan Peyton //
36823041982dSJonathan Peyton // wait is a flag that defaults to 1 (see kmp.h), but waiting can be turned off
368397d000cfStlwilmar // by passing in 0 optionally as the last argument. When wait is zero, primary
36843041982dSJonathan Peyton // thread does not wait for unfinished_threads to reach 0.
36853041982dSJonathan Peyton void __kmp_task_team_wait(
36863041982dSJonathan Peyton     kmp_info_t *this_thr,
36873041982dSJonathan Peyton     kmp_team_t *team USE_ITT_BUILD_ARG(void *itt_sync_obj), int wait) {
36887cc577a4SJonathan Peyton   kmp_task_team_t *task_team = team->t.t_task_team[this_thr->th.th_task_state];
36897cc577a4SJonathan Peyton 
36907cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36917cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team == this_thr->th.th_task_team);
36927cc577a4SJonathan Peyton 
36937cc577a4SJonathan Peyton   if ((task_team != NULL) && KMP_TASKING_ENABLED(task_team)) {
36947cc577a4SJonathan Peyton     if (wait) {
369597d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_wait: Primary T#%d waiting for all tasks "
36963041982dSJonathan Peyton                     "(for unfinished_threads to reach 0) on task_team = %p\n",
36977cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(this_thr), task_team));
36983041982dSJonathan Peyton       // Worker threads may have dropped through to release phase, but could
36993041982dSJonathan Peyton       // still be executing tasks. Wait here for tasks to complete. To avoid
370097d000cfStlwilmar       // memory contention, only primary thread checks termination condition.
3701e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
3702e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
370337e2ef54SJonathan Peyton                 &task_team->tt.tt_unfinished_threads),
3704c47afcd9SAndrey Churbanov           0U);
37053041982dSJonathan Peyton       flag.wait(this_thr, TRUE USE_ITT_BUILD_ARG(itt_sync_obj));
37067cc577a4SJonathan Peyton     }
37073041982dSJonathan Peyton     // Deactivate the old task team, so that the worker threads will stop
37083041982dSJonathan Peyton     // referencing it while spinning.
37093041982dSJonathan Peyton     KA_TRACE(
37103041982dSJonathan Peyton         20,
371197d000cfStlwilmar         ("__kmp_task_team_wait: Primary T#%d deactivating task_team %p: "
37127cc577a4SJonathan Peyton          "setting active to false, setting local and team's pointer to NULL\n",
37137cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr), task_team));
37143041982dSJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1 ||
37153041982dSJonathan Peyton                      task_team->tt.tt_found_proxy_tasks == TRUE);
37167cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_proxy_tasks, FALSE);
3717a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(task_team->tt.tt_untied_task_encountered, 0);
37187cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_active, FALSE);
37197cc577a4SJonathan Peyton     KMP_MB();
37207cc577a4SJonathan Peyton 
37217cc577a4SJonathan Peyton     TCW_PTR(this_thr->th.th_task_team, NULL);
37227cc577a4SJonathan Peyton   }
37237cc577a4SJonathan Peyton }
37247cc577a4SJonathan Peyton 
37257cc577a4SJonathan Peyton // __kmp_tasking_barrier:
3726e0665a90STerry Wilmarth // This routine is called only when __kmp_tasking_mode == tskm_extra_barrier.
37273041982dSJonathan Peyton // Internal function to execute all tasks prior to a regular barrier or a join
37283041982dSJonathan Peyton // barrier. It is a full barrier itself, which unfortunately turns regular
37293041982dSJonathan Peyton // barriers into double barriers and join barriers into 1 1/2 barriers.
37303041982dSJonathan Peyton void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread, int gtid) {
373137e2ef54SJonathan Peyton   std::atomic<kmp_uint32> *spin = RCAST(
373237e2ef54SJonathan Peyton       std::atomic<kmp_uint32> *,
3733c47afcd9SAndrey Churbanov       &team->t.t_task_team[thread->th.th_task_state]->tt.tt_unfinished_threads);
37347cc577a4SJonathan Peyton   int flag = FALSE;
37357cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode == tskm_extra_barrier);
37367cc577a4SJonathan Peyton 
37377cc577a4SJonathan Peyton #if USE_ITT_BUILD
373837e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_INIT(spin, NULL);
37397cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
3740e0665a90STerry Wilmarth   kmp_flag_32<false, false> spin_flag(spin, 0U);
37413041982dSJonathan Peyton   while (!spin_flag.execute_tasks(thread, gtid, TRUE,
37423041982dSJonathan Peyton                                   &flag USE_ITT_BUILD_ARG(NULL), 0)) {
37437cc577a4SJonathan Peyton #if USE_ITT_BUILD
37447cc577a4SJonathan Peyton     // TODO: What about itt_sync_obj??
374537e2ef54SJonathan Peyton     KMP_FSYNC_SPIN_PREPARE(RCAST(void *, spin));
37467cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37477cc577a4SJonathan Peyton 
37487cc577a4SJonathan Peyton     if (TCR_4(__kmp_global.g.g_done)) {
37497cc577a4SJonathan Peyton       if (__kmp_global.g.g_abort)
37507cc577a4SJonathan Peyton         __kmp_abort_thread();
37517cc577a4SJonathan Peyton       break;
37527cc577a4SJonathan Peyton     }
3753e47d32f1SJonathan Peyton     KMP_YIELD(TRUE);
37547cc577a4SJonathan Peyton   }
37557cc577a4SJonathan Peyton #if USE_ITT_BUILD
375637e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_ACQUIRED(RCAST(void *, spin));
37577cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37587cc577a4SJonathan Peyton }
37597cc577a4SJonathan Peyton 
37603041982dSJonathan Peyton // __kmp_give_task puts a task into a given thread queue if:
37613041982dSJonathan Peyton //  - the queue for that thread was created
37623041982dSJonathan Peyton //  - there's space in that queue
37633041982dSJonathan Peyton // Because of this, __kmp_push_task needs to check if there's space after
37643041982dSJonathan Peyton // getting the lock
37653041982dSJonathan Peyton static bool __kmp_give_task(kmp_info_t *thread, kmp_int32 tid, kmp_task_t *task,
37663041982dSJonathan Peyton                             kmp_int32 pass) {
37677cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
37687cc577a4SJonathan Peyton   kmp_task_team_t *task_team = taskdata->td_task_team;
37697cc577a4SJonathan Peyton 
37703041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_give_task: trying to give task %p to thread %d.\n",
37713041982dSJonathan Peyton                 taskdata, tid));
37727cc577a4SJonathan Peyton 
37737cc577a4SJonathan Peyton   // If task_team is NULL something went really bad...
37747cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
37757cc577a4SJonathan Peyton 
37767cc577a4SJonathan Peyton   bool result = false;
37777cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
37787cc577a4SJonathan Peyton 
37797cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
37807cc577a4SJonathan Peyton     // There's no queue in this thread, go find another one
37817cc577a4SJonathan Peyton     // We're guaranteed that at least one thread has a queue
37823041982dSJonathan Peyton     KA_TRACE(30,
37833041982dSJonathan Peyton              ("__kmp_give_task: thread %d has no queue while giving task %p.\n",
37843041982dSJonathan Peyton               tid, taskdata));
37857cc577a4SJonathan Peyton     return result;
37867cc577a4SJonathan Peyton   }
37877cc577a4SJonathan Peyton 
37883041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
37893041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
37903041982dSJonathan Peyton     KA_TRACE(
37913041982dSJonathan Peyton         30,
37923041982dSJonathan Peyton         ("__kmp_give_task: queue is full while giving task %p to thread %d.\n",
37933041982dSJonathan Peyton          taskdata, tid));
37947cc577a4SJonathan Peyton 
37953041982dSJonathan Peyton     // if this deque is bigger than the pass ratio give a chance to another
37963041982dSJonathan Peyton     // thread
37973041982dSJonathan Peyton     if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
37983041982dSJonathan Peyton       return result;
37997cc577a4SJonathan Peyton 
38007cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38013895148dSJoachim Protze     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38023895148dSJoachim Protze         TASK_DEQUE_SIZE(thread_data->td)) {
38033895148dSJoachim Protze       // expand deque to push the task which is not allowed to execute
38047cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38053895148dSJoachim Protze     }
38067cc577a4SJonathan Peyton 
38077cc577a4SJonathan Peyton   } else {
38087cc577a4SJonathan Peyton 
38097cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38107cc577a4SJonathan Peyton 
38113041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38123041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
38133041982dSJonathan Peyton       KA_TRACE(30, ("__kmp_give_task: queue is full while giving task %p to "
38143041982dSJonathan Peyton                     "thread %d.\n",
38153041982dSJonathan Peyton                     taskdata, tid));
38167cc577a4SJonathan Peyton 
38173041982dSJonathan Peyton       // if this deque is bigger than the pass ratio give a chance to another
38183041982dSJonathan Peyton       // thread
38197cc577a4SJonathan Peyton       if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38207cc577a4SJonathan Peyton         goto release_and_exit;
38217cc577a4SJonathan Peyton 
38227cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38237cc577a4SJonathan Peyton     }
38247cc577a4SJonathan Peyton   }
38257cc577a4SJonathan Peyton 
38267cc577a4SJonathan Peyton   // lock is held here, and there is space in the deque
38277cc577a4SJonathan Peyton 
38287cc577a4SJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] = taskdata;
38297cc577a4SJonathan Peyton   // Wrap index.
38303041982dSJonathan Peyton   thread_data->td.td_deque_tail =
38313041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
38323041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
38333041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1);
38347cc577a4SJonathan Peyton 
38357cc577a4SJonathan Peyton   result = true;
38363041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_give_task: successfully gave task %p to thread %d.\n",
38373041982dSJonathan Peyton                 taskdata, tid));
38387cc577a4SJonathan Peyton 
38397cc577a4SJonathan Peyton release_and_exit:
38407cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
38417cc577a4SJonathan Peyton 
38427cc577a4SJonathan Peyton   return result;
38437cc577a4SJonathan Peyton }
38447cc577a4SJonathan Peyton 
38453041982dSJonathan Peyton /* The finish of the proxy tasks is divided in two pieces:
38467cc577a4SJonathan Peyton     - the top half is the one that can be done from a thread outside the team
3847c3344345SAndrey Churbanov     - the bottom half must be run from a thread within the team
38487cc577a4SJonathan Peyton 
38493041982dSJonathan Peyton    In order to run the bottom half the task gets queued back into one of the
38503041982dSJonathan Peyton    threads of the team. Once the td_incomplete_child_task counter of the parent
38513041982dSJonathan Peyton    is decremented the threads can leave the barriers. So, the bottom half needs
38523041982dSJonathan Peyton    to be queued before the counter is decremented. The top half is therefore
38533041982dSJonathan Peyton    divided in two parts:
38547cc577a4SJonathan Peyton     - things that can be run before queuing the bottom half
38557cc577a4SJonathan Peyton     - things that must be run after queuing the bottom half
38567cc577a4SJonathan Peyton 
38573041982dSJonathan Peyton    This creates a second race as the bottom half can free the task before the
38583041982dSJonathan Peyton    second top half is executed. To avoid this we use the
38593041982dSJonathan Peyton    td_incomplete_child_task of the proxy task to synchronize the top and bottom
38603041982dSJonathan Peyton    half. */
38613041982dSJonathan Peyton static void __kmp_first_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
38637cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38647cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
38657cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
38667cc577a4SJonathan Peyton 
38677cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
38687cc577a4SJonathan Peyton 
38697cc577a4SJonathan Peyton   if (taskdata->td_taskgroup)
387037e2ef54SJonathan Peyton     KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
38717cc577a4SJonathan Peyton 
38723041982dSJonathan Peyton   // Create an imaginary children for this task so the bottom half cannot
38733041982dSJonathan Peyton   // release the task before we have completed the second top half
387437e2ef54SJonathan Peyton   KMP_ATOMIC_INC(&taskdata->td_incomplete_child_tasks);
38757cc577a4SJonathan Peyton }
38767cc577a4SJonathan Peyton 
38773041982dSJonathan Peyton static void __kmp_second_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38787cc577a4SJonathan Peyton   kmp_int32 children = 0;
38797cc577a4SJonathan Peyton 
38807cc577a4SJonathan Peyton   // Predecrement simulated by "- 1" calculation
38813041982dSJonathan Peyton   children =
388237e2ef54SJonathan Peyton       KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
38837cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
38847cc577a4SJonathan Peyton 
38857cc577a4SJonathan Peyton   // Remove the imaginary children
388637e2ef54SJonathan Peyton   KMP_ATOMIC_DEC(&taskdata->td_incomplete_child_tasks);
38877cc577a4SJonathan Peyton }
38887cc577a4SJonathan Peyton 
38893041982dSJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask) {
38907cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
38917cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
38927cc577a4SJonathan Peyton 
38937cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38943041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete ==
38953041982dSJonathan Peyton                    1); // top half must run before bottom half
38967cc577a4SJonathan Peyton 
38977cc577a4SJonathan Peyton   // We need to wait to make sure the top half is finished
38987cc577a4SJonathan Peyton   // Spinning here should be ok as this should happen quickly
389937e2ef54SJonathan Peyton   while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) > 0)
39003041982dSJonathan Peyton     ;
39017cc577a4SJonathan Peyton 
39027cc577a4SJonathan Peyton   __kmp_release_deps(gtid, taskdata);
39037cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
39047cc577a4SJonathan Peyton }
39057cc577a4SJonathan Peyton 
39067cc577a4SJonathan Peyton /*!
39077cc577a4SJonathan Peyton @ingroup TASKING
39087cc577a4SJonathan Peyton @param gtid Global Thread ID of encountering thread
39097cc577a4SJonathan Peyton @param ptask Task which execution is completed
39107cc577a4SJonathan Peyton 
3911ed5fe645SKelvin Li Execute the completion of a proxy task from a thread of that is part of the
39123041982dSJonathan Peyton team. Run first and bottom halves directly.
39137cc577a4SJonathan Peyton */
39143041982dSJonathan Peyton void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask) {
39157cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39167cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39173041982dSJonathan Peyton   KA_TRACE(
39183041982dSJonathan Peyton       10, ("__kmp_proxy_task_completed(enter): T#%d proxy task %p completing\n",
39193041982dSJonathan Peyton            gtid, taskdata));
3920787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
39217cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39227cc577a4SJonathan Peyton 
39237cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39247cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39257cc577a4SJonathan Peyton   __kmp_bottom_half_finish_proxy(gtid, ptask);
39267cc577a4SJonathan Peyton 
39273041982dSJonathan Peyton   KA_TRACE(10,
39283041982dSJonathan Peyton            ("__kmp_proxy_task_completed(exit): T#%d proxy task %p completing\n",
39293041982dSJonathan Peyton             gtid, taskdata));
39307cc577a4SJonathan Peyton }
39317cc577a4SJonathan Peyton 
39327cc577a4SJonathan Peyton /*!
39337cc577a4SJonathan Peyton @ingroup TASKING
39347cc577a4SJonathan Peyton @param ptask Task which execution is completed
39357cc577a4SJonathan Peyton 
3936ed5fe645SKelvin Li Execute the completion of a proxy task from a thread that could not belong to
39373041982dSJonathan Peyton the team.
39387cc577a4SJonathan Peyton */
39393041982dSJonathan Peyton void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask) {
39407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39417cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39427cc577a4SJonathan Peyton 
39433041982dSJonathan Peyton   KA_TRACE(
39443041982dSJonathan Peyton       10,
39453041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(enter): proxy task completing ooo %p\n",
39463041982dSJonathan Peyton        taskdata));
39477cc577a4SJonathan Peyton 
39487cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39497cc577a4SJonathan Peyton 
39507cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39517cc577a4SJonathan Peyton 
39523041982dSJonathan Peyton   // Enqueue task to complete bottom half completion from a thread within the
39533041982dSJonathan Peyton   // corresponding team
39547cc577a4SJonathan Peyton   kmp_team_t *team = taskdata->td_team;
39557cc577a4SJonathan Peyton   kmp_int32 nthreads = team->t.t_nproc;
39567cc577a4SJonathan Peyton   kmp_info_t *thread;
39577cc577a4SJonathan Peyton 
39583041982dSJonathan Peyton   // This should be similar to start_k = __kmp_get_random( thread ) % nthreads
39593041982dSJonathan Peyton   // but we cannot use __kmp_get_random here
39607cc577a4SJonathan Peyton   kmp_int32 start_k = 0;
39617cc577a4SJonathan Peyton   kmp_int32 pass = 1;
39627cc577a4SJonathan Peyton   kmp_int32 k = start_k;
39637cc577a4SJonathan Peyton 
39647cc577a4SJonathan Peyton   do {
39657cc577a4SJonathan Peyton     // For now we're just linearly trying to find a thread
39667cc577a4SJonathan Peyton     thread = team->t.t_threads[k];
39677cc577a4SJonathan Peyton     k = (k + 1) % nthreads;
39687cc577a4SJonathan Peyton 
39697cc577a4SJonathan Peyton     // we did a full pass through all the threads
39703041982dSJonathan Peyton     if (k == start_k)
39713041982dSJonathan Peyton       pass = pass << 1;
39727cc577a4SJonathan Peyton 
39737cc577a4SJonathan Peyton   } while (!__kmp_give_task(thread, k, ptask, pass));
39747cc577a4SJonathan Peyton 
39757cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39767cc577a4SJonathan Peyton 
39773041982dSJonathan Peyton   KA_TRACE(
39783041982dSJonathan Peyton       10,
39793041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(exit): proxy task completing ooo %p\n",
39803041982dSJonathan Peyton        taskdata));
39817cc577a4SJonathan Peyton }
39827cc577a4SJonathan Peyton 
3983405037c4SAndrey Churbanov kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref, int gtid,
3984405037c4SAndrey Churbanov                                                 kmp_task_t *task) {
3985405037c4SAndrey Churbanov   kmp_taskdata_t *td = KMP_TASK_TO_TASKDATA(task);
3986405037c4SAndrey Churbanov   if (td->td_allow_completion_event.type == KMP_EVENT_UNINITIALIZED) {
3987405037c4SAndrey Churbanov     td->td_allow_completion_event.type = KMP_EVENT_ALLOW_COMPLETION;
3988405037c4SAndrey Churbanov     td->td_allow_completion_event.ed.task = task;
3989405037c4SAndrey Churbanov     __kmp_init_tas_lock(&td->td_allow_completion_event.lock);
3990405037c4SAndrey Churbanov   }
3991405037c4SAndrey Churbanov   return &td->td_allow_completion_event;
3992405037c4SAndrey Churbanov }
3993405037c4SAndrey Churbanov 
3994405037c4SAndrey Churbanov void __kmp_fulfill_event(kmp_event_t *event) {
3995405037c4SAndrey Churbanov   if (event->type == KMP_EVENT_ALLOW_COMPLETION) {
3996405037c4SAndrey Churbanov     kmp_task_t *ptask = event->ed.task;
3997405037c4SAndrey Churbanov     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
3998405037c4SAndrey Churbanov     bool detached = false;
3999405037c4SAndrey Churbanov     int gtid = __kmp_get_gtid();
4000405037c4SAndrey Churbanov 
4001d23131a3SJoachim Protze     // The associated task might have completed or could be completing at this
4002405037c4SAndrey Churbanov     // point.
4003405037c4SAndrey Churbanov     // We need to take the lock to avoid races
4004405037c4SAndrey Churbanov     __kmp_acquire_tas_lock(&event->lock, gtid);
400510995c77SJoachim Protze     if (taskdata->td_flags.proxy == TASK_PROXY) {
4006405037c4SAndrey Churbanov       detached = true;
400710995c77SJoachim Protze     } else {
400810995c77SJoachim Protze #if OMPT_SUPPORT
400910995c77SJoachim Protze       // The OMPT event must occur under mutual exclusion,
401010995c77SJoachim Protze       // otherwise the tool might access ptask after free
401110995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
401210995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_early_fulfill);
401310995c77SJoachim Protze #endif
401410995c77SJoachim Protze     }
4015405037c4SAndrey Churbanov     event->type = KMP_EVENT_UNINITIALIZED;
4016405037c4SAndrey Churbanov     __kmp_release_tas_lock(&event->lock, gtid);
4017405037c4SAndrey Churbanov 
4018405037c4SAndrey Churbanov     if (detached) {
401910995c77SJoachim Protze #if OMPT_SUPPORT
402010995c77SJoachim Protze       // We free ptask afterwards and know the task is finished,
402110995c77SJoachim Protze       // so locking is not necessary
402210995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
402310995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_late_fulfill);
402410995c77SJoachim Protze #endif
4025405037c4SAndrey Churbanov       // If the task detached complete the proxy task
4026405037c4SAndrey Churbanov       if (gtid >= 0) {
4027405037c4SAndrey Churbanov         kmp_team_t *team = taskdata->td_team;
4028405037c4SAndrey Churbanov         kmp_info_t *thread = __kmp_get_thread();
4029405037c4SAndrey Churbanov         if (thread->th.th_team == team) {
4030405037c4SAndrey Churbanov           __kmpc_proxy_task_completed(gtid, ptask);
4031405037c4SAndrey Churbanov           return;
4032405037c4SAndrey Churbanov         }
4033405037c4SAndrey Churbanov       }
4034405037c4SAndrey Churbanov 
4035405037c4SAndrey Churbanov       // fallback
4036405037c4SAndrey Churbanov       __kmpc_proxy_task_completed_ooo(ptask);
4037405037c4SAndrey Churbanov     }
4038405037c4SAndrey Churbanov   }
4039405037c4SAndrey Churbanov }
4040405037c4SAndrey Churbanov 
40413041982dSJonathan Peyton // __kmp_task_dup_alloc: Allocate the taskdata and make a copy of source task
40423041982dSJonathan Peyton // for taskloop
40437cc577a4SJonathan Peyton //
40447cc577a4SJonathan Peyton // thread:   allocating thread
40457cc577a4SJonathan Peyton // task_src: pointer to source task to be duplicated
40467cc577a4SJonathan Peyton // returns:  a pointer to the allocated kmp_task_t structure (task).
40473041982dSJonathan Peyton kmp_task_t *__kmp_task_dup_alloc(kmp_info_t *thread, kmp_task_t *task_src) {
40487cc577a4SJonathan Peyton   kmp_task_t *task;
40497cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
40505e111c5dSAndreyChurbanov   kmp_taskdata_t *taskdata_src = KMP_TASK_TO_TASKDATA(task_src);
40515e111c5dSAndreyChurbanov   kmp_taskdata_t *parent_task = taskdata_src->td_parent; // same parent task
40527cc577a4SJonathan Peyton   size_t shareds_offset;
40537cc577a4SJonathan Peyton   size_t task_size;
40547cc577a4SJonathan Peyton 
40553041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_dup_alloc(enter): Th %p, source task %p\n", thread,
40563041982dSJonathan Peyton                 task_src));
40573041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.proxy ==
40583041982dSJonathan Peyton                    TASK_FULL); // it should not be proxy task
40597cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.tasktype == TASK_EXPLICIT);
40607cc577a4SJonathan Peyton   task_size = taskdata_src->td_size_alloc;
40617cc577a4SJonathan Peyton 
40627cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
40633041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_dup_alloc: Th %p, malloc size %ld\n", thread,
40643041982dSJonathan Peyton                 task_size));
40657cc577a4SJonathan Peyton #if USE_FAST_MEMORY
40667cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, task_size);
40677cc577a4SJonathan Peyton #else
40687cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, task_size);
40697cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
40707cc577a4SJonathan Peyton   KMP_MEMCPY(taskdata, taskdata_src, task_size);
40717cc577a4SJonathan Peyton 
40727cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
40737cc577a4SJonathan Peyton 
40747cc577a4SJonathan Peyton   // Initialize new task (only specific fields not affected by memcpy)
40757cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
40767cc577a4SJonathan Peyton   if (task->shareds != NULL) { // need setup shareds pointer
40777cc577a4SJonathan Peyton     shareds_offset = (char *)task_src->shareds - (char *)taskdata_src;
40787cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
40793041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
40803041982dSJonathan Peyton                      0);
40817cc577a4SJonathan Peyton   }
40827cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
408393e17cfeSJonathan Peyton   taskdata->td_parent = parent_task;
4084ae044467SAndreyChurbanov   // task inherits the taskgroup from the parent task
4085ae044467SAndreyChurbanov   taskdata->td_taskgroup = parent_task->td_taskgroup;
4086ae044467SAndreyChurbanov   // tied task needs to initialize the td_last_tied at creation,
4087ae044467SAndreyChurbanov   // untied one does this when it is scheduled for execution
4088ae044467SAndreyChurbanov   if (taskdata->td_flags.tiedness == TASK_TIED)
4089ae044467SAndreyChurbanov     taskdata->td_last_tied = taskdata;
40907cc577a4SJonathan Peyton 
40913041982dSJonathan Peyton   // Only need to keep track of child task counts if team parallel and tasking
40923041982dSJonathan Peyton   // not serialized
40937cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
409437e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
40957cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
409637e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
40973041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
40983041982dSJonathan Peyton     // implicit not deallocated
40997cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT)
410037e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
41017cc577a4SJonathan Peyton   }
41027cc577a4SJonathan Peyton 
41033041982dSJonathan Peyton   KA_TRACE(20,
41043041982dSJonathan Peyton            ("__kmp_task_dup_alloc(exit): Th %p, created task %p, parent=%p\n",
41057cc577a4SJonathan Peyton             thread, taskdata, taskdata->td_parent));
41067cc577a4SJonathan Peyton #if OMPT_SUPPORT
4107f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
410882e94a59SJoachim Protze     __ompt_task_init(taskdata, thread->th.th_info.ds.ds_gtid);
41097cc577a4SJonathan Peyton #endif
41107cc577a4SJonathan Peyton   return task;
41117cc577a4SJonathan Peyton }
41127cc577a4SJonathan Peyton 
41137cc577a4SJonathan Peyton // Routine optionally generated by the compiler for setting the lastprivate flag
41147cc577a4SJonathan Peyton // and calling needed constructors for private/firstprivate objects
41157cc577a4SJonathan Peyton // (used to form taskloop tasks from pattern task)
411693e17cfeSJonathan Peyton // Parameters: dest task, src task, lastprivate flag.
41177cc577a4SJonathan Peyton typedef void (*p_task_dup_t)(kmp_task_t *, kmp_task_t *, kmp_int32);
41187cc577a4SJonathan Peyton 
411927a677fcSJonathan Peyton KMP_BUILD_ASSERT(sizeof(long) == 4 || sizeof(long) == 8);
412027a677fcSJonathan Peyton 
412127a677fcSJonathan Peyton // class to encapsulate manipulating loop bounds in a taskloop task.
412227a677fcSJonathan Peyton // this abstracts away the Intel vs GOMP taskloop interface for setting/getting
412327a677fcSJonathan Peyton // the loop bound variables.
412427a677fcSJonathan Peyton class kmp_taskloop_bounds_t {
412527a677fcSJonathan Peyton   kmp_task_t *task;
412627a677fcSJonathan Peyton   const kmp_taskdata_t *taskdata;
412727a677fcSJonathan Peyton   size_t lower_offset;
412827a677fcSJonathan Peyton   size_t upper_offset;
412927a677fcSJonathan Peyton 
413027a677fcSJonathan Peyton public:
413127a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, kmp_uint64 *lb, kmp_uint64 *ub)
413227a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(task)),
413327a677fcSJonathan Peyton         lower_offset((char *)lb - (char *)task),
413427a677fcSJonathan Peyton         upper_offset((char *)ub - (char *)task) {
413527a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)lb > (char *)_task);
413627a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)ub > (char *)_task);
413727a677fcSJonathan Peyton   }
413827a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, const kmp_taskloop_bounds_t &bounds)
413927a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(_task)),
414027a677fcSJonathan Peyton         lower_offset(bounds.lower_offset), upper_offset(bounds.upper_offset) {}
414127a677fcSJonathan Peyton   size_t get_lower_offset() const { return lower_offset; }
414227a677fcSJonathan Peyton   size_t get_upper_offset() const { return upper_offset; }
414327a677fcSJonathan Peyton   kmp_uint64 get_lb() const {
414427a677fcSJonathan Peyton     kmp_int64 retval;
414527a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
414627a677fcSJonathan Peyton     // Intel task just returns the lower bound normally
414727a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
414827a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + lower_offset);
414927a677fcSJonathan Peyton     } else {
415027a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
415127a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
415227a677fcSJonathan Peyton         kmp_int32 *lb = RCAST(kmp_int32 *, task->shareds);
415327a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
415427a677fcSJonathan Peyton       } else {
415527a677fcSJonathan Peyton         kmp_int64 *lb = RCAST(kmp_int64 *, task->shareds);
415627a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
415727a677fcSJonathan Peyton       }
415827a677fcSJonathan Peyton     }
415927a677fcSJonathan Peyton #else
4160b3d84790SMartin Storsjö     (void)taskdata;
416127a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + lower_offset);
416227a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
416327a677fcSJonathan Peyton     return retval;
416427a677fcSJonathan Peyton   }
416527a677fcSJonathan Peyton   kmp_uint64 get_ub() const {
416627a677fcSJonathan Peyton     kmp_int64 retval;
416727a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
416827a677fcSJonathan Peyton     // Intel task just returns the upper bound normally
416927a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
417027a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + upper_offset);
417127a677fcSJonathan Peyton     } else {
417227a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
417327a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
417427a677fcSJonathan Peyton         kmp_int32 *ub = RCAST(kmp_int32 *, task->shareds) + 1;
417527a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
417627a677fcSJonathan Peyton       } else {
417727a677fcSJonathan Peyton         kmp_int64 *ub = RCAST(kmp_int64 *, task->shareds) + 1;
417827a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
417927a677fcSJonathan Peyton       }
418027a677fcSJonathan Peyton     }
418127a677fcSJonathan Peyton #else
418227a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + upper_offset);
418327a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
418427a677fcSJonathan Peyton     return retval;
418527a677fcSJonathan Peyton   }
418627a677fcSJonathan Peyton   void set_lb(kmp_uint64 lb) {
418727a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
418827a677fcSJonathan Peyton     // Intel task just sets the lower bound normally
418927a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
419027a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + lower_offset) = lb;
419127a677fcSJonathan Peyton     } else {
419227a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
419327a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
419427a677fcSJonathan Peyton         kmp_uint32 *lower = RCAST(kmp_uint32 *, task->shareds);
419527a677fcSJonathan Peyton         *lower = (kmp_uint32)lb;
419627a677fcSJonathan Peyton       } else {
419727a677fcSJonathan Peyton         kmp_uint64 *lower = RCAST(kmp_uint64 *, task->shareds);
419827a677fcSJonathan Peyton         *lower = (kmp_uint64)lb;
419927a677fcSJonathan Peyton       }
420027a677fcSJonathan Peyton     }
420127a677fcSJonathan Peyton #else
420227a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + lower_offset) = lb;
420327a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
420427a677fcSJonathan Peyton   }
420527a677fcSJonathan Peyton   void set_ub(kmp_uint64 ub) {
420627a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
420727a677fcSJonathan Peyton     // Intel task just sets the upper bound normally
420827a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
420927a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + upper_offset) = ub;
421027a677fcSJonathan Peyton     } else {
421127a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
421227a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
421327a677fcSJonathan Peyton         kmp_uint32 *upper = RCAST(kmp_uint32 *, task->shareds) + 1;
421427a677fcSJonathan Peyton         *upper = (kmp_uint32)ub;
421527a677fcSJonathan Peyton       } else {
421627a677fcSJonathan Peyton         kmp_uint64 *upper = RCAST(kmp_uint64 *, task->shareds) + 1;
421727a677fcSJonathan Peyton         *upper = (kmp_uint64)ub;
421827a677fcSJonathan Peyton       }
421927a677fcSJonathan Peyton     }
422027a677fcSJonathan Peyton #else
422127a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + upper_offset) = ub;
422227a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
422327a677fcSJonathan Peyton   }
422427a677fcSJonathan Peyton };
422527a677fcSJonathan Peyton 
42267cc577a4SJonathan Peyton // __kmp_taskloop_linear: Start tasks of the taskloop linearly
42277cc577a4SJonathan Peyton //
42287cc577a4SJonathan Peyton // loc        Source location information
42297cc577a4SJonathan Peyton // gtid       Global thread ID
423093e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
423193e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
423293e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
42337cc577a4SJonathan Peyton // st         Loop stride
423493e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
423593e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
423693e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
423793e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4238540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
423993e17cfeSJonathan Peyton // tc         Iterations count
42407cc577a4SJonathan Peyton // task_dup   Tasks duplication routine
4241cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
42423041982dSJonathan Peyton void __kmp_taskloop_linear(ident_t *loc, int gtid, kmp_task_t *task,
42437cc577a4SJonathan Peyton                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
424493e17cfeSJonathan Peyton                            kmp_uint64 ub_glob, kmp_uint64 num_tasks,
424593e17cfeSJonathan Peyton                            kmp_uint64 grainsize, kmp_uint64 extras,
4246540007b4SNawrin Sultana                            kmp_int64 last_chunk, kmp_uint64 tc,
4247cdaefac5SJoachim Protze #if OMPT_SUPPORT
4248cdaefac5SJoachim Protze                            void *codeptr_ra,
4249cdaefac5SJoachim Protze #endif
4250cdaefac5SJoachim Protze                            void *task_dup) {
42517cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKLOOP);
42527cc577a4SJonathan Peyton   KMP_TIME_PARTITIONED_BLOCK(OMP_taskloop_scheduling);
42537cc577a4SJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
425427a677fcSJonathan Peyton   // compiler provides global bounds here
425527a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
425627a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
425727a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
425893e17cfeSJonathan Peyton   kmp_uint64 i;
42597cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
42607cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
42617cc577a4SJonathan Peyton   kmp_task_t *next_task;
42627cc577a4SJonathan Peyton   kmp_int32 lastpriv = 0;
42637cc577a4SJonathan Peyton 
4264309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4265309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
426693e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
426793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
426893e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_linear: T#%d: %lld tasks, grainsize %lld, "
4269540007b4SNawrin Sultana                 "extras %lld, last_chunk %lld, i=%lld,%lld(%d)%lld, dup %p\n",
4270540007b4SNawrin Sultana                 gtid, num_tasks, grainsize, extras, last_chunk, lower, upper,
4271540007b4SNawrin Sultana                 ub_glob, st, task_dup));
427293e17cfeSJonathan Peyton 
427393e17cfeSJonathan Peyton   // Launch num_tasks tasks, assign grainsize iterations each task
427493e17cfeSJonathan Peyton   for (i = 0; i < num_tasks; ++i) {
427593e17cfeSJonathan Peyton     kmp_uint64 chunk_minus_1;
427693e17cfeSJonathan Peyton     if (extras == 0) {
427793e17cfeSJonathan Peyton       chunk_minus_1 = grainsize - 1;
427893e17cfeSJonathan Peyton     } else {
427993e17cfeSJonathan Peyton       chunk_minus_1 = grainsize;
428093e17cfeSJonathan Peyton       --extras; // first extras iterations get bigger chunk (grainsize+1)
428193e17cfeSJonathan Peyton     }
428293e17cfeSJonathan Peyton     upper = lower + st * chunk_minus_1;
4283540007b4SNawrin Sultana     if (upper > *ub) {
4284540007b4SNawrin Sultana       upper = *ub;
4285540007b4SNawrin Sultana     }
428693e17cfeSJonathan Peyton     if (i == num_tasks - 1) {
428793e17cfeSJonathan Peyton       // schedule the last task, set lastprivate flag if needed
428893e17cfeSJonathan Peyton       if (st == 1) { // most common case
428993e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper == *ub);
429093e17cfeSJonathan Peyton         if (upper == ub_glob)
429193e17cfeSJonathan Peyton           lastpriv = 1;
429293e17cfeSJonathan Peyton       } else if (st > 0) { // positive loop stride
429393e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT((kmp_uint64)st > *ub - upper);
429493e17cfeSJonathan Peyton         if ((kmp_uint64)st > ub_glob - upper)
429593e17cfeSJonathan Peyton           lastpriv = 1;
429693e17cfeSJonathan Peyton       } else { // negative loop stride
429793e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper + st < *ub);
429893e17cfeSJonathan Peyton         if (upper - ub_glob < (kmp_uint64)(-st))
429993e17cfeSJonathan Peyton           lastpriv = 1;
430093e17cfeSJonathan Peyton       }
430193e17cfeSJonathan Peyton     }
430293e17cfeSJonathan Peyton     next_task = __kmp_task_dup_alloc(thread, task); // allocate new task
430327a677fcSJonathan Peyton     kmp_taskdata_t *next_taskdata = KMP_TASK_TO_TASKDATA(next_task);
430427a677fcSJonathan Peyton     kmp_taskloop_bounds_t next_task_bounds =
430527a677fcSJonathan Peyton         kmp_taskloop_bounds_t(next_task, task_bounds);
430627a677fcSJonathan Peyton 
430793e17cfeSJonathan Peyton     // adjust task-specific bounds
430827a677fcSJonathan Peyton     next_task_bounds.set_lb(lower);
430927a677fcSJonathan Peyton     if (next_taskdata->td_flags.native) {
431027a677fcSJonathan Peyton       next_task_bounds.set_ub(upper + (st > 0 ? 1 : -1));
431127a677fcSJonathan Peyton     } else {
431227a677fcSJonathan Peyton       next_task_bounds.set_ub(upper);
431327a677fcSJonathan Peyton     }
43144c6a098aSKazuaki Ishizaki     if (ptask_dup != NULL) // set lastprivate flag, construct firstprivates,
43154c6a098aSKazuaki Ishizaki                            // etc.
431693e17cfeSJonathan Peyton       ptask_dup(next_task, task, lastpriv);
431727a677fcSJonathan Peyton     KA_TRACE(40,
431827a677fcSJonathan Peyton              ("__kmp_taskloop_linear: T#%d; task #%llu: task %p: lower %lld, "
431927a677fcSJonathan Peyton               "upper %lld stride %lld, (offsets %p %p)\n",
432027a677fcSJonathan Peyton               gtid, i, next_task, lower, upper, st,
432127a677fcSJonathan Peyton               next_task_bounds.get_lower_offset(),
432227a677fcSJonathan Peyton               next_task_bounds.get_upper_offset()));
4323cdaefac5SJoachim Protze #if OMPT_SUPPORT
4324cdaefac5SJoachim Protze     __kmp_omp_taskloop_task(NULL, gtid, next_task,
4325cdaefac5SJoachim Protze                             codeptr_ra); // schedule new task
4326cdaefac5SJoachim Protze #else
432793e17cfeSJonathan Peyton     __kmp_omp_task(gtid, next_task, true); // schedule new task
4328cdaefac5SJoachim Protze #endif
432993e17cfeSJonathan Peyton     lower = upper + st; // adjust lower bound for the next iteration
433093e17cfeSJonathan Peyton   }
433193e17cfeSJonathan Peyton   // free the pattern task and exit
433293e17cfeSJonathan Peyton   __kmp_task_start(gtid, task, current_task); // make internal bookkeeping
433393e17cfeSJonathan Peyton   // do not execute the pattern task, just do internal bookkeeping
433486ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task, current_task);
433593e17cfeSJonathan Peyton }
433693e17cfeSJonathan Peyton 
433793e17cfeSJonathan Peyton // Structure to keep taskloop parameters for auxiliary task
433893e17cfeSJonathan Peyton // kept in the shareds of the task structure.
433993e17cfeSJonathan Peyton typedef struct __taskloop_params {
434093e17cfeSJonathan Peyton   kmp_task_t *task;
434193e17cfeSJonathan Peyton   kmp_uint64 *lb;
434293e17cfeSJonathan Peyton   kmp_uint64 *ub;
434393e17cfeSJonathan Peyton   void *task_dup;
434493e17cfeSJonathan Peyton   kmp_int64 st;
434593e17cfeSJonathan Peyton   kmp_uint64 ub_glob;
434693e17cfeSJonathan Peyton   kmp_uint64 num_tasks;
434793e17cfeSJonathan Peyton   kmp_uint64 grainsize;
434893e17cfeSJonathan Peyton   kmp_uint64 extras;
4349540007b4SNawrin Sultana   kmp_int64 last_chunk;
435093e17cfeSJonathan Peyton   kmp_uint64 tc;
435193e17cfeSJonathan Peyton   kmp_uint64 num_t_min;
4352cdaefac5SJoachim Protze #if OMPT_SUPPORT
4353cdaefac5SJoachim Protze   void *codeptr_ra;
4354cdaefac5SJoachim Protze #endif
435593e17cfeSJonathan Peyton } __taskloop_params_t;
435693e17cfeSJonathan Peyton 
435793e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *, int, kmp_task_t *, kmp_uint64 *,
435893e17cfeSJonathan Peyton                           kmp_uint64 *, kmp_int64, kmp_uint64, kmp_uint64,
4359540007b4SNawrin Sultana                           kmp_uint64, kmp_uint64, kmp_int64, kmp_uint64,
4360540007b4SNawrin Sultana                           kmp_uint64,
4361cdaefac5SJoachim Protze #if OMPT_SUPPORT
4362cdaefac5SJoachim Protze                           void *,
4363cdaefac5SJoachim Protze #endif
436493e17cfeSJonathan Peyton                           void *);
436593e17cfeSJonathan Peyton 
4366ed5fe645SKelvin Li // Execute part of the taskloop submitted as a task.
436793e17cfeSJonathan Peyton int __kmp_taskloop_task(int gtid, void *ptask) {
4368d74d8902SJonathan Peyton   __taskloop_params_t *p =
4369d74d8902SJonathan Peyton       (__taskloop_params_t *)((kmp_task_t *)ptask)->shareds;
437093e17cfeSJonathan Peyton   kmp_task_t *task = p->task;
437193e17cfeSJonathan Peyton   kmp_uint64 *lb = p->lb;
437293e17cfeSJonathan Peyton   kmp_uint64 *ub = p->ub;
437393e17cfeSJonathan Peyton   void *task_dup = p->task_dup;
437493e17cfeSJonathan Peyton   //  p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
437593e17cfeSJonathan Peyton   kmp_int64 st = p->st;
437693e17cfeSJonathan Peyton   kmp_uint64 ub_glob = p->ub_glob;
437793e17cfeSJonathan Peyton   kmp_uint64 num_tasks = p->num_tasks;
437893e17cfeSJonathan Peyton   kmp_uint64 grainsize = p->grainsize;
437993e17cfeSJonathan Peyton   kmp_uint64 extras = p->extras;
4380540007b4SNawrin Sultana   kmp_int64 last_chunk = p->last_chunk;
438193e17cfeSJonathan Peyton   kmp_uint64 tc = p->tc;
438293e17cfeSJonathan Peyton   kmp_uint64 num_t_min = p->num_t_min;
4383cdaefac5SJoachim Protze #if OMPT_SUPPORT
4384cdaefac5SJoachim Protze   void *codeptr_ra = p->codeptr_ra;
4385cdaefac5SJoachim Protze #endif
438693e17cfeSJonathan Peyton #if KMP_DEBUG
438793e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
438893e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
4389540007b4SNawrin Sultana   KA_TRACE(20,
4390540007b4SNawrin Sultana            ("__kmp_taskloop_task: T#%d, task %p: %lld tasks, grainsize"
4391540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4392540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4393540007b4SNawrin Sultana             st, task_dup));
439493e17cfeSJonathan Peyton #endif
439593e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks * 2 + 1 > num_t_min);
439693e17cfeSJonathan Peyton   if (num_tasks > num_t_min)
439793e17cfeSJonathan Peyton     __kmp_taskloop_recur(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4398540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_t_min,
4399cdaefac5SJoachim Protze #if OMPT_SUPPORT
4400cdaefac5SJoachim Protze                          codeptr_ra,
4401cdaefac5SJoachim Protze #endif
4402cdaefac5SJoachim Protze                          task_dup);
440393e17cfeSJonathan Peyton   else
440493e17cfeSJonathan Peyton     __kmp_taskloop_linear(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4405540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4406cdaefac5SJoachim Protze #if OMPT_SUPPORT
4407cdaefac5SJoachim Protze                           codeptr_ra,
4408cdaefac5SJoachim Protze #endif
4409cdaefac5SJoachim Protze                           task_dup);
441093e17cfeSJonathan Peyton 
441193e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmp_taskloop_task(exit): T#%d\n", gtid));
441293e17cfeSJonathan Peyton   return 0;
441393e17cfeSJonathan Peyton }
441493e17cfeSJonathan Peyton 
4415ed5fe645SKelvin Li // Schedule part of the taskloop as a task,
4416ed5fe645SKelvin Li // execute the rest of the taskloop.
441793e17cfeSJonathan Peyton //
441893e17cfeSJonathan Peyton // loc        Source location information
441993e17cfeSJonathan Peyton // gtid       Global thread ID
442093e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
442193e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
442293e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
442393e17cfeSJonathan Peyton // st         Loop stride
442493e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
442593e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
442693e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
442793e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4428540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
442993e17cfeSJonathan Peyton // tc         Iterations count
443042016791SKazuaki Ishizaki // num_t_min  Threshold to launch tasks recursively
443193e17cfeSJonathan Peyton // task_dup   Tasks duplication routine
4432cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
443393e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *loc, int gtid, kmp_task_t *task,
443493e17cfeSJonathan Peyton                           kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
443593e17cfeSJonathan Peyton                           kmp_uint64 ub_glob, kmp_uint64 num_tasks,
443693e17cfeSJonathan Peyton                           kmp_uint64 grainsize, kmp_uint64 extras,
4437540007b4SNawrin Sultana                           kmp_int64 last_chunk, kmp_uint64 tc,
4438540007b4SNawrin Sultana                           kmp_uint64 num_t_min,
4439cdaefac5SJoachim Protze #if OMPT_SUPPORT
4440cdaefac5SJoachim Protze                           void *codeptr_ra,
4441cdaefac5SJoachim Protze #endif
4442cdaefac5SJoachim Protze                           void *task_dup) {
444393e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
444493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
444593e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > num_t_min);
4446540007b4SNawrin Sultana   KA_TRACE(20,
4447540007b4SNawrin Sultana            ("__kmp_taskloop_recur: T#%d, task %p: %lld tasks, grainsize"
4448540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4449540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4450540007b4SNawrin Sultana             st, task_dup));
445193e17cfeSJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
445293e17cfeSJonathan Peyton   kmp_uint64 lower = *lb;
445393e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
445493e17cfeSJonathan Peyton   //  kmp_taskdata_t *current_task = thread->th.th_current_task;
445593e17cfeSJonathan Peyton   kmp_task_t *next_task;
445693e17cfeSJonathan Peyton   size_t lower_offset =
445793e17cfeSJonathan Peyton       (char *)lb - (char *)task; // remember offset of lb in the task structure
445893e17cfeSJonathan Peyton   size_t upper_offset =
445993e17cfeSJonathan Peyton       (char *)ub - (char *)task; // remember offset of ub in the task structure
446093e17cfeSJonathan Peyton 
4461309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4462309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
446393e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
446493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
446593e17cfeSJonathan Peyton 
446693e17cfeSJonathan Peyton   // split the loop in two halves
446793e17cfeSJonathan Peyton   kmp_uint64 lb1, ub0, tc0, tc1, ext0, ext1;
4468540007b4SNawrin Sultana   kmp_int64 last_chunk0 = 0, last_chunk1 = 0;
446993e17cfeSJonathan Peyton   kmp_uint64 gr_size0 = grainsize;
447093e17cfeSJonathan Peyton   kmp_uint64 n_tsk0 = num_tasks >> 1; // num_tasks/2 to execute
447193e17cfeSJonathan Peyton   kmp_uint64 n_tsk1 = num_tasks - n_tsk0; // to schedule as a task
4472540007b4SNawrin Sultana   if (last_chunk < 0) {
4473540007b4SNawrin Sultana     ext0 = ext1 = 0;
4474540007b4SNawrin Sultana     last_chunk1 = last_chunk;
4475540007b4SNawrin Sultana     tc0 = grainsize * n_tsk0;
4476540007b4SNawrin Sultana     tc1 = tc - tc0;
4477540007b4SNawrin Sultana   } else if (n_tsk0 <= extras) {
447893e17cfeSJonathan Peyton     gr_size0++; // integrate extras into grainsize
447993e17cfeSJonathan Peyton     ext0 = 0; // no extra iters in 1st half
448093e17cfeSJonathan Peyton     ext1 = extras - n_tsk0; // remaining extras
448193e17cfeSJonathan Peyton     tc0 = gr_size0 * n_tsk0;
448293e17cfeSJonathan Peyton     tc1 = tc - tc0;
448393e17cfeSJonathan Peyton   } else { // n_tsk0 > extras
448493e17cfeSJonathan Peyton     ext1 = 0; // no extra iters in 2nd half
448593e17cfeSJonathan Peyton     ext0 = extras;
448693e17cfeSJonathan Peyton     tc1 = grainsize * n_tsk1;
448793e17cfeSJonathan Peyton     tc0 = tc - tc1;
448893e17cfeSJonathan Peyton   }
448993e17cfeSJonathan Peyton   ub0 = lower + st * (tc0 - 1);
449093e17cfeSJonathan Peyton   lb1 = ub0 + st;
449193e17cfeSJonathan Peyton 
449293e17cfeSJonathan Peyton   // create pattern task for 2nd half of the loop
449393e17cfeSJonathan Peyton   next_task = __kmp_task_dup_alloc(thread, task); // duplicate the task
449493e17cfeSJonathan Peyton   // adjust lower bound (upper bound is not changed) for the 2nd half
449593e17cfeSJonathan Peyton   *(kmp_uint64 *)((char *)next_task + lower_offset) = lb1;
44964c6a098aSKazuaki Ishizaki   if (ptask_dup != NULL) // construct firstprivates, etc.
449793e17cfeSJonathan Peyton     ptask_dup(next_task, task, 0);
449893e17cfeSJonathan Peyton   *ub = ub0; // adjust upper bound for the 1st half
449993e17cfeSJonathan Peyton 
450093e17cfeSJonathan Peyton   // create auxiliary task for 2nd half of the loop
45015e111c5dSAndreyChurbanov   // make sure new task has same parent task as the pattern task
45025e111c5dSAndreyChurbanov   kmp_taskdata_t *current_task = thread->th.th_current_task;
45035e111c5dSAndreyChurbanov   thread->th.th_current_task = taskdata->td_parent;
450493e17cfeSJonathan Peyton   kmp_task_t *new_task =
450593e17cfeSJonathan Peyton       __kmpc_omp_task_alloc(loc, gtid, 1, 3 * sizeof(void *),
450693e17cfeSJonathan Peyton                             sizeof(__taskloop_params_t), &__kmp_taskloop_task);
45075e111c5dSAndreyChurbanov   // restore current task
45085e111c5dSAndreyChurbanov   thread->th.th_current_task = current_task;
450993e17cfeSJonathan Peyton   __taskloop_params_t *p = (__taskloop_params_t *)new_task->shareds;
451093e17cfeSJonathan Peyton   p->task = next_task;
451193e17cfeSJonathan Peyton   p->lb = (kmp_uint64 *)((char *)next_task + lower_offset);
451293e17cfeSJonathan Peyton   p->ub = (kmp_uint64 *)((char *)next_task + upper_offset);
451393e17cfeSJonathan Peyton   p->task_dup = task_dup;
451493e17cfeSJonathan Peyton   p->st = st;
451593e17cfeSJonathan Peyton   p->ub_glob = ub_glob;
451693e17cfeSJonathan Peyton   p->num_tasks = n_tsk1;
451793e17cfeSJonathan Peyton   p->grainsize = grainsize;
451893e17cfeSJonathan Peyton   p->extras = ext1;
4519540007b4SNawrin Sultana   p->last_chunk = last_chunk1;
452093e17cfeSJonathan Peyton   p->tc = tc1;
452193e17cfeSJonathan Peyton   p->num_t_min = num_t_min;
4522cdaefac5SJoachim Protze #if OMPT_SUPPORT
4523cdaefac5SJoachim Protze   p->codeptr_ra = codeptr_ra;
4524cdaefac5SJoachim Protze #endif
4525cdaefac5SJoachim Protze 
4526cdaefac5SJoachim Protze #if OMPT_SUPPORT
4527cdaefac5SJoachim Protze   // schedule new task with correct return address for OMPT events
4528cdaefac5SJoachim Protze   __kmp_omp_taskloop_task(NULL, gtid, new_task, codeptr_ra);
4529cdaefac5SJoachim Protze #else
4530f729df82SGheorghe-Teodor Bercea   __kmp_omp_task(gtid, new_task, true); // schedule new task
4531cdaefac5SJoachim Protze #endif
453293e17cfeSJonathan Peyton 
453393e17cfeSJonathan Peyton   // execute the 1st half of current subrange
453493e17cfeSJonathan Peyton   if (n_tsk0 > num_t_min)
4535d74d8902SJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0, gr_size0,
4536540007b4SNawrin Sultana                          ext0, last_chunk0, tc0, num_t_min,
4537cdaefac5SJoachim Protze #if OMPT_SUPPORT
4538cdaefac5SJoachim Protze                          codeptr_ra,
4539cdaefac5SJoachim Protze #endif
4540cdaefac5SJoachim Protze                          task_dup);
454193e17cfeSJonathan Peyton   else
454293e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0,
4543540007b4SNawrin Sultana                           gr_size0, ext0, last_chunk0, tc0,
4544cdaefac5SJoachim Protze #if OMPT_SUPPORT
4545cdaefac5SJoachim Protze                           codeptr_ra,
4546cdaefac5SJoachim Protze #endif
4547cdaefac5SJoachim Protze                           task_dup);
454893e17cfeSJonathan Peyton 
4549540007b4SNawrin Sultana   KA_TRACE(40, ("__kmp_taskloop_recur(exit): T#%d\n", gtid));
455093e17cfeSJonathan Peyton }
455193e17cfeSJonathan Peyton 
4552540007b4SNawrin Sultana static void __kmp_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4553540007b4SNawrin Sultana                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4554540007b4SNawrin Sultana                            int nogroup, int sched, kmp_uint64 grainsize,
4555540007b4SNawrin Sultana                            int modifier, void *task_dup) {
455693e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
455793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
455882e94a59SJoachim Protze   if (nogroup == 0) {
455982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
456082e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
456182e94a59SJoachim Protze #endif
456293e17cfeSJonathan Peyton     __kmpc_taskgroup(loc, gtid);
456382e94a59SJoachim Protze   }
456493e17cfeSJonathan Peyton 
456593e17cfeSJonathan Peyton   // =========================================================================
456693e17cfeSJonathan Peyton   // calculate loop parameters
456727a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
456893e17cfeSJonathan Peyton   kmp_uint64 tc;
456927a677fcSJonathan Peyton   // compiler provides global bounds here
457027a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
457127a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
457293e17cfeSJonathan Peyton   kmp_uint64 ub_glob = upper; // global upper used to calc lastprivate flag
457393e17cfeSJonathan Peyton   kmp_uint64 num_tasks = 0, extras = 0;
4574540007b4SNawrin Sultana   kmp_int64 last_chunk =
4575540007b4SNawrin Sultana       0; // reduce grainsize of last task by last_chunk in strict mode
457693e17cfeSJonathan Peyton   kmp_uint64 num_tasks_min = __kmp_taskloop_min_tasks;
457793e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
457893e17cfeSJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
457993e17cfeSJonathan Peyton 
4580540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop: T#%d, task %p, lb %lld, ub %lld, st %lld, "
4581540007b4SNawrin Sultana                 "grain %llu(%d, %d), dup %p\n",
4582540007b4SNawrin Sultana                 gtid, taskdata, lower, upper, st, grainsize, sched, modifier,
4583540007b4SNawrin Sultana                 task_dup));
458427a677fcSJonathan Peyton 
45857cc577a4SJonathan Peyton   // compute trip count
45867cc577a4SJonathan Peyton   if (st == 1) { // most common case
45877cc577a4SJonathan Peyton     tc = upper - lower + 1;
45887cc577a4SJonathan Peyton   } else if (st < 0) {
45897cc577a4SJonathan Peyton     tc = (lower - upper) / (-st) + 1;
45907cc577a4SJonathan Peyton   } else { // st > 0
45917cc577a4SJonathan Peyton     tc = (upper - lower) / st + 1;
45927cc577a4SJonathan Peyton   }
45937cc577a4SJonathan Peyton   if (tc == 0) {
4594540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop(exit): T#%d zero-trip loop\n", gtid));
45957cc577a4SJonathan Peyton     // free the pattern task and exit
45967cc577a4SJonathan Peyton     __kmp_task_start(gtid, task, current_task);
45977cc577a4SJonathan Peyton     // do not execute anything for zero-trip loop
459886ed6aa6SJoachim Protze     __kmp_task_finish<false>(gtid, task, current_task);
45997cc577a4SJonathan Peyton     return;
46007cc577a4SJonathan Peyton   }
4601cdaefac5SJoachim Protze 
4602cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4603cdaefac5SJoachim Protze   ompt_team_info_t *team_info = __ompt_get_teaminfo(0, NULL);
4604cdaefac5SJoachim Protze   ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
4605cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4606cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4607cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_begin, &(team_info->parallel_data),
4608cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4609cdaefac5SJoachim Protze   }
4610cdaefac5SJoachim Protze #endif
4611cdaefac5SJoachim Protze 
461293e17cfeSJonathan Peyton   if (num_tasks_min == 0)
461393e17cfeSJonathan Peyton     // TODO: can we choose better default heuristic?
4614d74d8902SJonathan Peyton     num_tasks_min =
4615d74d8902SJonathan Peyton         KMP_MIN(thread->th.th_team_nproc * 10, INITIAL_TASK_DEQUE_SIZE);
46167cc577a4SJonathan Peyton 
46177cc577a4SJonathan Peyton   // compute num_tasks/grainsize based on the input provided
46187cc577a4SJonathan Peyton   switch (sched) {
46197cc577a4SJonathan Peyton   case 0: // no schedule clause specified, we can choose the default
46207cc577a4SJonathan Peyton     // let's try to schedule (team_size*10) tasks
46217cc577a4SJonathan Peyton     grainsize = thread->th.th_team_nproc * 10;
46220c599c38SJoachim Protze     KMP_FALLTHROUGH();
46237cc577a4SJonathan Peyton   case 2: // num_tasks provided
46247cc577a4SJonathan Peyton     if (grainsize > tc) {
46257cc577a4SJonathan Peyton       num_tasks = tc; // too big num_tasks requested, adjust values
46267cc577a4SJonathan Peyton       grainsize = 1;
46277cc577a4SJonathan Peyton       extras = 0;
46287cc577a4SJonathan Peyton     } else {
46297cc577a4SJonathan Peyton       num_tasks = grainsize;
46307cc577a4SJonathan Peyton       grainsize = tc / num_tasks;
46317cc577a4SJonathan Peyton       extras = tc % num_tasks;
46327cc577a4SJonathan Peyton     }
46337cc577a4SJonathan Peyton     break;
46347cc577a4SJonathan Peyton   case 1: // grainsize provided
46357cc577a4SJonathan Peyton     if (grainsize > tc) {
4636540007b4SNawrin Sultana       num_tasks = 1;
4637540007b4SNawrin Sultana       grainsize = tc; // too big grainsize requested, adjust values
4638540007b4SNawrin Sultana       extras = 0;
4639540007b4SNawrin Sultana     } else {
4640540007b4SNawrin Sultana       if (modifier) {
4641540007b4SNawrin Sultana         num_tasks = (tc + grainsize - 1) / grainsize;
4642540007b4SNawrin Sultana         last_chunk = tc - (num_tasks * grainsize);
46437cc577a4SJonathan Peyton         extras = 0;
46447cc577a4SJonathan Peyton       } else {
46457cc577a4SJonathan Peyton         num_tasks = tc / grainsize;
464693e17cfeSJonathan Peyton         // adjust grainsize for balanced distribution of iterations
464793e17cfeSJonathan Peyton         grainsize = tc / num_tasks;
46487cc577a4SJonathan Peyton         extras = tc % num_tasks;
46497cc577a4SJonathan Peyton       }
4650540007b4SNawrin Sultana     }
46517cc577a4SJonathan Peyton     break;
46527cc577a4SJonathan Peyton   default:
46537cc577a4SJonathan Peyton     KMP_ASSERT2(0, "unknown scheduling of taskloop");
46547cc577a4SJonathan Peyton   }
4655540007b4SNawrin Sultana 
4656309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4657309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
46587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
46597cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
466093e17cfeSJonathan Peyton   // =========================================================================
46617cc577a4SJonathan Peyton 
46627cc577a4SJonathan Peyton   // check if clause value first
466327a677fcSJonathan Peyton   // Also require GOMP_taskloop to reduce to linear (taskdata->td_flags.native)
46647cc577a4SJonathan Peyton   if (if_val == 0) { // if(0) specified, mark task as serial
46657cc577a4SJonathan Peyton     taskdata->td_flags.task_serial = 1;
46667cc577a4SJonathan Peyton     taskdata->td_flags.tiedness = TASK_TIED; // AC: serial task cannot be untied
466793e17cfeSJonathan Peyton     // always start serial tasks linearly
466893e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4669540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4670cdaefac5SJoachim Protze #if OMPT_SUPPORT
4671cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4672cdaefac5SJoachim Protze #endif
4673cdaefac5SJoachim Protze                           task_dup);
467427a677fcSJonathan Peyton     // !taskdata->td_flags.native => currently force linear spawning of tasks
467527a677fcSJonathan Peyton     // for GOMP_taskloop
467627a677fcSJonathan Peyton   } else if (num_tasks > num_tasks_min && !taskdata->td_flags.native) {
4677540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go recursive: tc %llu, #tasks %llu"
4678540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4679540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4680540007b4SNawrin Sultana                   last_chunk));
468193e17cfeSJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4682540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_tasks_min,
4683cdaefac5SJoachim Protze #if OMPT_SUPPORT
4684cdaefac5SJoachim Protze                          OMPT_GET_RETURN_ADDRESS(0),
4685cdaefac5SJoachim Protze #endif
4686cdaefac5SJoachim Protze                          task_dup);
468793e17cfeSJonathan Peyton   } else {
4688540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go linear: tc %llu, #tasks %llu"
4689540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4690540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4691540007b4SNawrin Sultana                   last_chunk));
469293e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4693540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4694cdaefac5SJoachim Protze #if OMPT_SUPPORT
4695cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4696cdaefac5SJoachim Protze #endif
4697cdaefac5SJoachim Protze                           task_dup);
46987cc577a4SJonathan Peyton   }
46997cc577a4SJonathan Peyton 
4700cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4701cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4702cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4703cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_end, &(team_info->parallel_data),
4704cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4705cdaefac5SJoachim Protze   }
4706cdaefac5SJoachim Protze #endif
4707cdaefac5SJoachim Protze 
470882e94a59SJoachim Protze   if (nogroup == 0) {
470982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
471082e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
471182e94a59SJoachim Protze #endif
47127cc577a4SJonathan Peyton     __kmpc_end_taskgroup(loc, gtid);
471382e94a59SJoachim Protze   }
4714540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop(exit): T#%d\n", gtid));
4715540007b4SNawrin Sultana }
4716540007b4SNawrin Sultana 
4717540007b4SNawrin Sultana /*!
4718540007b4SNawrin Sultana @ingroup TASKING
4719540007b4SNawrin Sultana @param loc       Source location information
4720540007b4SNawrin Sultana @param gtid      Global thread ID
4721540007b4SNawrin Sultana @param task      Task structure
4722540007b4SNawrin Sultana @param if_val    Value of the if clause
4723540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4724540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4725540007b4SNawrin Sultana @param st        Loop stride
4726540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4727540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4728540007b4SNawrin Sultana @param grainsize Schedule value if specified
4729540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4730540007b4SNawrin Sultana 
4731540007b4SNawrin Sultana Execute the taskloop construct.
4732540007b4SNawrin Sultana */
4733540007b4SNawrin Sultana void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4734540007b4SNawrin Sultana                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,
4735540007b4SNawrin Sultana                      int sched, kmp_uint64 grainsize, void *task_dup) {
4736540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4737540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop(enter): T#%d\n", gtid));
4738540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4739540007b4SNawrin Sultana                  0, task_dup);
474093e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d\n", gtid));
47417cc577a4SJonathan Peyton }
4742540007b4SNawrin Sultana 
4743540007b4SNawrin Sultana /*!
4744540007b4SNawrin Sultana @ingroup TASKING
4745540007b4SNawrin Sultana @param loc       Source location information
4746540007b4SNawrin Sultana @param gtid      Global thread ID
4747540007b4SNawrin Sultana @param task      Task structure
4748540007b4SNawrin Sultana @param if_val    Value of the if clause
4749540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4750540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4751540007b4SNawrin Sultana @param st        Loop stride
4752540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4753540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4754540007b4SNawrin Sultana @param grainsize Schedule value if specified
4755540007b4SNawrin Sultana @param modifer   Modifier 'strict' for sched, 1 if present, 0 otherwise
4756540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4757540007b4SNawrin Sultana 
4758540007b4SNawrin Sultana Execute the taskloop construct.
4759540007b4SNawrin Sultana */
4760540007b4SNawrin Sultana void __kmpc_taskloop_5(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4761540007b4SNawrin Sultana                        kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4762540007b4SNawrin Sultana                        int nogroup, int sched, kmp_uint64 grainsize,
4763540007b4SNawrin Sultana                        int modifier, void *task_dup) {
4764540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4765540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(enter): T#%d\n", gtid));
4766540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4767540007b4SNawrin Sultana                  modifier, task_dup);
4768540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(exit): T#%d\n", gtid));
4769540007b4SNawrin Sultana }
4770