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 /* forward declaration */
253041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
263041982dSJonathan Peyton                                  kmp_info_t *this_thr);
273041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
283041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data);
293041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
303041982dSJonathan Peyton                                            kmp_task_team_t *task_team);
317cc577a4SJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask);
327cc577a4SJonathan Peyton 
337cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
347cc577a4SJonathan Peyton 
357cc577a4SJonathan Peyton //  __kmp_trace_task_stack: print the tied tasks from the task stack in order
367cc577a4SJonathan Peyton //  from top do bottom
377cc577a4SJonathan Peyton //
387cc577a4SJonathan Peyton //  gtid: global thread identifier for thread containing stack
397cc577a4SJonathan Peyton //  thread_data: thread data for task team thread containing stack
407cc577a4SJonathan Peyton //  threshold: value above which the trace statement triggers
417cc577a4SJonathan Peyton //  location: string identifying call site of this function (for trace)
423041982dSJonathan Peyton static void __kmp_trace_task_stack(kmp_int32 gtid,
433041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data,
443041982dSJonathan Peyton                                    int threshold, char *location) {
457cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
467cc577a4SJonathan Peyton   kmp_taskdata_t **stack_top = task_stack->ts_top;
477cc577a4SJonathan Peyton   kmp_int32 entries = task_stack->ts_entries;
487cc577a4SJonathan Peyton   kmp_taskdata_t *tied_task;
497cc577a4SJonathan Peyton 
503041982dSJonathan Peyton   KA_TRACE(
513041982dSJonathan Peyton       threshold,
523041982dSJonathan Peyton       ("__kmp_trace_task_stack(start): location = %s, gtid = %d, entries = %d, "
537cc577a4SJonathan Peyton        "first_block = %p, stack_top = %p \n",
547cc577a4SJonathan Peyton        location, gtid, entries, task_stack->ts_first_block, stack_top));
557cc577a4SJonathan Peyton 
567cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(stack_top != NULL);
577cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(entries > 0);
587cc577a4SJonathan Peyton 
593041982dSJonathan Peyton   while (entries != 0) {
607cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(stack_top != &task_stack->ts_first_block.sb_block[0]);
617cc577a4SJonathan Peyton     // fix up ts_top if we need to pop from previous block
623041982dSJonathan Peyton     if (entries & TASK_STACK_INDEX_MASK == 0) {
637cc577a4SJonathan Peyton       kmp_stack_block_t *stack_block = (kmp_stack_block_t *)(stack_top);
647cc577a4SJonathan Peyton 
657cc577a4SJonathan Peyton       stack_block = stack_block->sb_prev;
667cc577a4SJonathan Peyton       stack_top = &stack_block->sb_block[TASK_STACK_BLOCK_SIZE];
677cc577a4SJonathan Peyton     }
687cc577a4SJonathan Peyton 
697cc577a4SJonathan Peyton     // finish bookkeeping
707cc577a4SJonathan Peyton     stack_top--;
717cc577a4SJonathan Peyton     entries--;
727cc577a4SJonathan Peyton 
737cc577a4SJonathan Peyton     tied_task = *stack_top;
747cc577a4SJonathan Peyton 
757cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(tied_task != NULL);
767cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
777cc577a4SJonathan Peyton 
783041982dSJonathan Peyton     KA_TRACE(threshold,
793041982dSJonathan Peyton              ("__kmp_trace_task_stack(%s):             gtid=%d, entry=%d, "
807cc577a4SJonathan Peyton               "stack_top=%p, tied_task=%p\n",
817cc577a4SJonathan Peyton               location, gtid, entries, stack_top, tied_task));
827cc577a4SJonathan Peyton   }
837cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(stack_top == &task_stack->ts_first_block.sb_block[0]);
847cc577a4SJonathan Peyton 
853041982dSJonathan Peyton   KA_TRACE(threshold,
863041982dSJonathan Peyton            ("__kmp_trace_task_stack(exit): location = %s, gtid = %d\n",
877cc577a4SJonathan Peyton             location, gtid));
887cc577a4SJonathan Peyton }
897cc577a4SJonathan Peyton 
907cc577a4SJonathan Peyton //  __kmp_init_task_stack: initialize the task stack for the first time
917cc577a4SJonathan Peyton //  after a thread_data structure is created.
927cc577a4SJonathan Peyton //  It should not be necessary to do this again (assuming the stack works).
937cc577a4SJonathan Peyton //
947cc577a4SJonathan Peyton //  gtid: global thread identifier of calling thread
957cc577a4SJonathan Peyton //  thread_data: thread data for task team thread containing stack
963041982dSJonathan Peyton static void __kmp_init_task_stack(kmp_int32 gtid,
973041982dSJonathan Peyton                                   kmp_thread_data_t *thread_data) {
987cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
997cc577a4SJonathan Peyton   kmp_stack_block_t *first_block;
1007cc577a4SJonathan Peyton 
1017cc577a4SJonathan Peyton   // set up the first block of the stack
1027cc577a4SJonathan Peyton   first_block = &task_stack->ts_first_block;
1037cc577a4SJonathan Peyton   task_stack->ts_top = (kmp_taskdata_t **)first_block;
1043041982dSJonathan Peyton   memset((void *)first_block, '\0',
1053041982dSJonathan Peyton          TASK_STACK_BLOCK_SIZE * sizeof(kmp_taskdata_t *));
1067cc577a4SJonathan Peyton 
1077cc577a4SJonathan Peyton   // initialize the stack to be empty
1087cc577a4SJonathan Peyton   task_stack->ts_entries = TASK_STACK_EMPTY;
1097cc577a4SJonathan Peyton   first_block->sb_next = NULL;
1107cc577a4SJonathan Peyton   first_block->sb_prev = NULL;
1117cc577a4SJonathan Peyton }
1127cc577a4SJonathan Peyton 
1137cc577a4SJonathan Peyton //  __kmp_free_task_stack: free the task stack when thread_data is destroyed.
1147cc577a4SJonathan Peyton //
1157cc577a4SJonathan Peyton //  gtid: global thread identifier for calling thread
1167cc577a4SJonathan Peyton //  thread_data: thread info for thread containing stack
1173041982dSJonathan Peyton static void __kmp_free_task_stack(kmp_int32 gtid,
1183041982dSJonathan Peyton                                   kmp_thread_data_t *thread_data) {
1197cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1207cc577a4SJonathan Peyton   kmp_stack_block_t *stack_block = &task_stack->ts_first_block;
1217cc577a4SJonathan Peyton 
1227cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_entries == TASK_STACK_EMPTY);
1237cc577a4SJonathan Peyton   // free from the second block of the stack
1247cc577a4SJonathan Peyton   while (stack_block != NULL) {
1257cc577a4SJonathan Peyton     kmp_stack_block_t *next_block = (stack_block) ? stack_block->sb_next : NULL;
1267cc577a4SJonathan Peyton 
1277cc577a4SJonathan Peyton     stack_block->sb_next = NULL;
1287cc577a4SJonathan Peyton     stack_block->sb_prev = NULL;
1297cc577a4SJonathan Peyton     if (stack_block != &task_stack->ts_first_block) {
1303041982dSJonathan Peyton       __kmp_thread_free(thread,
1313041982dSJonathan Peyton                         stack_block); // free the block, if not the first
1327cc577a4SJonathan Peyton     }
1337cc577a4SJonathan Peyton     stack_block = next_block;
1347cc577a4SJonathan Peyton   }
1357cc577a4SJonathan Peyton   // initialize the stack to be empty
1367cc577a4SJonathan Peyton   task_stack->ts_entries = 0;
1377cc577a4SJonathan Peyton   task_stack->ts_top = NULL;
1387cc577a4SJonathan Peyton }
1397cc577a4SJonathan Peyton 
1407cc577a4SJonathan Peyton //  __kmp_push_task_stack: Push the tied task onto the task stack.
1417cc577a4SJonathan Peyton //     Grow the stack if necessary by allocating another block.
1427cc577a4SJonathan Peyton //
1437cc577a4SJonathan Peyton //  gtid: global thread identifier for calling thread
1447cc577a4SJonathan Peyton //  thread: thread info for thread containing stack
1457cc577a4SJonathan Peyton //  tied_task: the task to push on the stack
1463041982dSJonathan Peyton static void __kmp_push_task_stack(kmp_int32 gtid, kmp_info_t *thread,
1473041982dSJonathan Peyton                                   kmp_taskdata_t *tied_task) {
1487cc577a4SJonathan Peyton   // GEH - need to consider what to do if tt_threads_data not allocated yet
1493041982dSJonathan Peyton   kmp_thread_data_t *thread_data =
1503041982dSJonathan Peyton       &thread->th.th_task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
1517cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1527cc577a4SJonathan Peyton 
1537cc577a4SJonathan Peyton   if (tied_task->td_flags.team_serial || tied_task->td_flags.tasking_ser) {
1547cc577a4SJonathan Peyton     return; // Don't push anything on stack if team or team tasks are serialized
1557cc577a4SJonathan Peyton   }
1567cc577a4SJonathan Peyton 
1577cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
1587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_top != NULL);
1597cc577a4SJonathan Peyton 
1603041982dSJonathan Peyton   KA_TRACE(20,
1613041982dSJonathan Peyton            ("__kmp_push_task_stack(enter): GTID: %d; THREAD: %p; TASK: %p\n",
1627cc577a4SJonathan Peyton             gtid, thread, tied_task));
1637cc577a4SJonathan Peyton   // Store entry
1647cc577a4SJonathan Peyton   *(task_stack->ts_top) = tied_task;
1657cc577a4SJonathan Peyton 
1667cc577a4SJonathan Peyton   // Do bookkeeping for next push
1677cc577a4SJonathan Peyton   task_stack->ts_top++;
1687cc577a4SJonathan Peyton   task_stack->ts_entries++;
1697cc577a4SJonathan Peyton 
1703041982dSJonathan Peyton   if (task_stack->ts_entries & TASK_STACK_INDEX_MASK == 0) {
1717cc577a4SJonathan Peyton     // Find beginning of this task block
1727cc577a4SJonathan Peyton     kmp_stack_block_t *stack_block =
1737cc577a4SJonathan Peyton         (kmp_stack_block_t *)(task_stack->ts_top - TASK_STACK_BLOCK_SIZE);
1747cc577a4SJonathan Peyton 
1757cc577a4SJonathan Peyton     // Check if we already have a block
1763041982dSJonathan Peyton     if (stack_block->sb_next !=
1773041982dSJonathan Peyton         NULL) { // reset ts_top to beginning of next block
1787cc577a4SJonathan Peyton       task_stack->ts_top = &stack_block->sb_next->sb_block[0];
1793041982dSJonathan Peyton     } else { // Alloc new block and link it up
1803041982dSJonathan Peyton       kmp_stack_block_t *new_block = (kmp_stack_block_t *)__kmp_thread_calloc(
1813041982dSJonathan Peyton           thread, sizeof(kmp_stack_block_t));
1827cc577a4SJonathan Peyton 
1837cc577a4SJonathan Peyton       task_stack->ts_top = &new_block->sb_block[0];
1847cc577a4SJonathan Peyton       stack_block->sb_next = new_block;
1857cc577a4SJonathan Peyton       new_block->sb_prev = stack_block;
1867cc577a4SJonathan Peyton       new_block->sb_next = NULL;
1877cc577a4SJonathan Peyton 
1883041982dSJonathan Peyton       KA_TRACE(
1893041982dSJonathan Peyton           30,
1903041982dSJonathan Peyton           ("__kmp_push_task_stack(): GTID: %d; TASK: %p; Alloc new block: %p\n",
1917cc577a4SJonathan Peyton            gtid, tied_task, new_block));
1927cc577a4SJonathan Peyton     }
1937cc577a4SJonathan Peyton   }
1943041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_push_task_stack(exit): GTID: %d; TASK: %p\n", gtid,
1953041982dSJonathan Peyton                 tied_task));
1967cc577a4SJonathan Peyton }
1977cc577a4SJonathan Peyton 
1987cc577a4SJonathan Peyton //  __kmp_pop_task_stack: Pop the tied task from the task stack.  Don't return
1997cc577a4SJonathan Peyton //  the task, just check to make sure it matches the ending task passed in.
2007cc577a4SJonathan Peyton //
2017cc577a4SJonathan Peyton //  gtid: global thread identifier for the calling thread
2027cc577a4SJonathan Peyton //  thread: thread info structure containing stack
2037cc577a4SJonathan Peyton //  tied_task: the task popped off the stack
2047cc577a4SJonathan Peyton //  ending_task: the task that is ending (should match popped task)
2053041982dSJonathan Peyton static void __kmp_pop_task_stack(kmp_int32 gtid, kmp_info_t *thread,
2063041982dSJonathan Peyton                                  kmp_taskdata_t *ending_task) {
2077cc577a4SJonathan Peyton   // GEH - need to consider what to do if tt_threads_data not allocated yet
2083041982dSJonathan Peyton   kmp_thread_data_t *thread_data =
2093041982dSJonathan Peyton       &thread->th.th_task_team->tt_threads_data[__kmp_tid_from_gtid(gtid)];
2107cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
2117cc577a4SJonathan Peyton   kmp_taskdata_t *tied_task;
2127cc577a4SJonathan Peyton 
2137cc577a4SJonathan Peyton   if (ending_task->td_flags.team_serial || ending_task->td_flags.tasking_ser) {
2143041982dSJonathan Peyton     // Don't pop anything from stack if team or team tasks are serialized
2153041982dSJonathan Peyton     return;
2167cc577a4SJonathan Peyton   }
2177cc577a4SJonathan Peyton 
2187cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_top != NULL);
2197cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_entries > 0);
2207cc577a4SJonathan Peyton 
2213041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_pop_task_stack(enter): GTID: %d; THREAD: %p\n", gtid,
2223041982dSJonathan Peyton                 thread));
2237cc577a4SJonathan Peyton 
2247cc577a4SJonathan Peyton   // fix up ts_top if we need to pop from previous block
2253041982dSJonathan Peyton   if (task_stack->ts_entries & TASK_STACK_INDEX_MASK == 0) {
2263041982dSJonathan Peyton     kmp_stack_block_t *stack_block = (kmp_stack_block_t *)(task_stack->ts_top);
2277cc577a4SJonathan Peyton 
2287cc577a4SJonathan Peyton     stack_block = stack_block->sb_prev;
2297cc577a4SJonathan Peyton     task_stack->ts_top = &stack_block->sb_block[TASK_STACK_BLOCK_SIZE];
2307cc577a4SJonathan Peyton   }
2317cc577a4SJonathan Peyton 
2327cc577a4SJonathan Peyton   // finish bookkeeping
2337cc577a4SJonathan Peyton   task_stack->ts_top--;
2347cc577a4SJonathan Peyton   task_stack->ts_entries--;
2357cc577a4SJonathan Peyton 
2367cc577a4SJonathan Peyton   tied_task = *(task_stack->ts_top);
2377cc577a4SJonathan Peyton 
2387cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task != NULL);
2397cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
2407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task == ending_task); // If we built the stack correctly
2417cc577a4SJonathan Peyton 
2423041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_pop_task_stack(exit): GTID: %d; TASK: %p\n", gtid,
2433041982dSJonathan Peyton                 tied_task));
2447cc577a4SJonathan Peyton   return;
2457cc577a4SJonathan Peyton }
2467cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
2477cc577a4SJonathan Peyton 
248c3344345SAndrey Churbanov // returns 1 if new task is allowed to execute, 0 otherwise
249c3344345SAndrey Churbanov // checks Task Scheduling constraint (if requested) and
250c3344345SAndrey Churbanov // mutexinoutset dependencies if any
251c3344345SAndrey Churbanov static bool __kmp_task_is_allowed(int gtid, const kmp_int32 is_constrained,
252c3344345SAndrey Churbanov                                   const kmp_taskdata_t *tasknew,
253c3344345SAndrey Churbanov                                   const kmp_taskdata_t *taskcurr) {
254c3344345SAndrey Churbanov   if (is_constrained && (tasknew->td_flags.tiedness == TASK_TIED)) {
255c3344345SAndrey Churbanov     // Check if the candidate obeys the Task Scheduling Constraints (TSC)
256c3344345SAndrey Churbanov     // only descendant of all deferred tied tasks can be scheduled, checking
257c3344345SAndrey Churbanov     // the last one is enough, as it in turn is the descendant of all others
258c3344345SAndrey Churbanov     kmp_taskdata_t *current = taskcurr->td_last_tied;
259c3344345SAndrey Churbanov     KMP_DEBUG_ASSERT(current != NULL);
260c3344345SAndrey Churbanov     // check if the task is not suspended on barrier
261c3344345SAndrey Churbanov     if (current->td_flags.tasktype == TASK_EXPLICIT ||
262c3344345SAndrey Churbanov         current->td_taskwait_thread > 0) { // <= 0 on barrier
263c3344345SAndrey Churbanov       kmp_int32 level = current->td_level;
264c3344345SAndrey Churbanov       kmp_taskdata_t *parent = tasknew->td_parent;
265c3344345SAndrey Churbanov       while (parent != current && parent->td_level > level) {
266c3344345SAndrey Churbanov         // check generation up to the level of the current task
267c3344345SAndrey Churbanov         parent = parent->td_parent;
268c3344345SAndrey Churbanov         KMP_DEBUG_ASSERT(parent != NULL);
269c3344345SAndrey Churbanov       }
270c3344345SAndrey Churbanov       if (parent != current)
271c3344345SAndrey Churbanov         return false;
272c3344345SAndrey Churbanov     }
273c3344345SAndrey Churbanov   }
274c3344345SAndrey Churbanov   // Check mutexinoutset dependencies, acquire locks
275c3344345SAndrey Churbanov   kmp_depnode_t *node = tasknew->td_depnode;
2766bf84871SAndreyChurbanov   if (UNLIKELY(node && (node->dn.mtx_num_locks > 0))) {
277c3344345SAndrey Churbanov     for (int i = 0; i < node->dn.mtx_num_locks; ++i) {
278c3344345SAndrey Churbanov       KMP_DEBUG_ASSERT(node->dn.mtx_locks[i] != NULL);
279c3344345SAndrey Churbanov       if (__kmp_test_lock(node->dn.mtx_locks[i], gtid))
280c3344345SAndrey Churbanov         continue;
281c3344345SAndrey Churbanov       // could not get the lock, release previous locks
282c3344345SAndrey Churbanov       for (int j = i - 1; j >= 0; --j)
283c3344345SAndrey Churbanov         __kmp_release_lock(node->dn.mtx_locks[j], gtid);
284c3344345SAndrey Churbanov       return false;
285c3344345SAndrey Churbanov     }
286c3344345SAndrey Churbanov     // negative num_locks means all locks acquired successfully
287c3344345SAndrey Churbanov     node->dn.mtx_num_locks = -node->dn.mtx_num_locks;
288c3344345SAndrey Churbanov   }
289c3344345SAndrey Churbanov   return true;
290c3344345SAndrey Churbanov }
291c3344345SAndrey Churbanov 
292c3344345SAndrey Churbanov // __kmp_realloc_task_deque:
293c3344345SAndrey Churbanov // Re-allocates a task deque for a particular thread, copies the content from
294c3344345SAndrey Churbanov // the old deque and adjusts the necessary data structures relating to the
295c3344345SAndrey Churbanov // deque. This operation must be done with the deque_lock being held
296c3344345SAndrey Churbanov static void __kmp_realloc_task_deque(kmp_info_t *thread,
297c3344345SAndrey Churbanov                                      kmp_thread_data_t *thread_data) {
298c3344345SAndrey Churbanov   kmp_int32 size = TASK_DEQUE_SIZE(thread_data->td);
2993895148dSJoachim Protze   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == size);
300c3344345SAndrey Churbanov   kmp_int32 new_size = 2 * size;
301c3344345SAndrey Churbanov 
302c3344345SAndrey Churbanov   KE_TRACE(10, ("__kmp_realloc_task_deque: T#%d reallocating deque[from %d to "
303c3344345SAndrey Churbanov                 "%d] for thread_data %p\n",
304c3344345SAndrey Churbanov                 __kmp_gtid_from_thread(thread), size, new_size, thread_data));
305c3344345SAndrey Churbanov 
306c3344345SAndrey Churbanov   kmp_taskdata_t **new_deque =
307c3344345SAndrey Churbanov       (kmp_taskdata_t **)__kmp_allocate(new_size * sizeof(kmp_taskdata_t *));
308c3344345SAndrey Churbanov 
309c3344345SAndrey Churbanov   int i, j;
310c3344345SAndrey Churbanov   for (i = thread_data->td.td_deque_head, j = 0; j < size;
311c3344345SAndrey Churbanov        i = (i + 1) & TASK_DEQUE_MASK(thread_data->td), j++)
312c3344345SAndrey Churbanov     new_deque[j] = thread_data->td.td_deque[i];
313c3344345SAndrey Churbanov 
314c3344345SAndrey Churbanov   __kmp_free(thread_data->td.td_deque);
315c3344345SAndrey Churbanov 
316c3344345SAndrey Churbanov   thread_data->td.td_deque_head = 0;
317c3344345SAndrey Churbanov   thread_data->td.td_deque_tail = size;
318c3344345SAndrey Churbanov   thread_data->td.td_deque = new_deque;
319c3344345SAndrey Churbanov   thread_data->td.td_deque_size = new_size;
320c3344345SAndrey Churbanov }
321c3344345SAndrey Churbanov 
3227cc577a4SJonathan Peyton //  __kmp_push_task: Add a task to the thread's deque
3233041982dSJonathan Peyton static kmp_int32 __kmp_push_task(kmp_int32 gtid, kmp_task_t *task) {
3247cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
3257cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
3269d64275aSShilei Tian 
327e5da63d5SShilei Tian   // We don't need to map to shadow gtid if it is already hidden helper thread
328e5da63d5SShilei Tian   if (taskdata->td_flags.hidden_helper && !KMP_HIDDEN_HELPER_THREAD(gtid)) {
3299d64275aSShilei Tian     gtid = KMP_GTID_TO_SHADOW_GTID(gtid);
3309d64275aSShilei Tian     thread = __kmp_threads[gtid];
3319d64275aSShilei Tian   }
3329d64275aSShilei Tian 
3337cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
3347cc577a4SJonathan Peyton   kmp_int32 tid = __kmp_tid_from_gtid(gtid);
3357cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
3367cc577a4SJonathan Peyton 
3373041982dSJonathan Peyton   KA_TRACE(20,
3383041982dSJonathan Peyton            ("__kmp_push_task: T#%d trying to push task %p.\n", gtid, taskdata));
3397cc577a4SJonathan Peyton 
3406bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
3413041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
3423041982dSJonathan Peyton     // freed prematurely
34337e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
344baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
3453041982dSJonathan Peyton     KA_TRACE(
3463041982dSJonathan Peyton         20,
3473041982dSJonathan Peyton         ("__kmp_push_task: T#%d untied_count (%d) incremented for task %p\n",
3487cc577a4SJonathan Peyton          gtid, counter, taskdata));
3497cc577a4SJonathan Peyton   }
3507cc577a4SJonathan Peyton 
3517cc577a4SJonathan Peyton   // The first check avoids building task_team thread data if serialized
3526bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.task_serial)) {
3533041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_push_task: T#%d team serialized; returning "
3543041982dSJonathan Peyton                   "TASK_NOT_PUSHED for task %p\n",
3557cc577a4SJonathan Peyton                   gtid, taskdata));
3567cc577a4SJonathan Peyton     return TASK_NOT_PUSHED;
3577cc577a4SJonathan Peyton   }
3587cc577a4SJonathan Peyton 
3593041982dSJonathan Peyton   // Now that serialized tasks have returned, we can assume that we are not in
3603041982dSJonathan Peyton   // immediate exec mode
3617cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
3626bf84871SAndreyChurbanov   if (UNLIKELY(!KMP_TASKING_ENABLED(task_team))) {
3637cc577a4SJonathan Peyton     __kmp_enable_tasking(task_team, thread);
3647cc577a4SJonathan Peyton   }
3657cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(task_team->tt.tt_found_tasks) == TRUE);
3667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_PTR(task_team->tt.tt_threads_data) != NULL);
3677cc577a4SJonathan Peyton 
3687cc577a4SJonathan Peyton   // Find tasking deque specific to encountering thread
3697cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[tid];
3707cc577a4SJonathan Peyton 
3719d64275aSShilei Tian   // No lock needed since only owner can allocate. If the task is hidden_helper,
3729d64275aSShilei Tian   // we don't need it either because we have initialized the dequeue for hidden
3739d64275aSShilei Tian   // helper thread data.
3746bf84871SAndreyChurbanov   if (UNLIKELY(thread_data->td.td_deque == NULL)) {
3757cc577a4SJonathan Peyton     __kmp_alloc_task_deque(thread, thread_data);
3767cc577a4SJonathan Peyton   }
3777cc577a4SJonathan Peyton 
378c3344345SAndrey Churbanov   int locked = 0;
3797cc577a4SJonathan Peyton   // Check if deque is full
3803041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
3813041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
382a23806e6SAndrey Churbanov     if (__kmp_enable_task_throttling &&
383a23806e6SAndrey Churbanov         __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
384c3344345SAndrey Churbanov                               thread->th.th_current_task)) {
3853041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_push_task: T#%d deque is full; returning "
3863041982dSJonathan Peyton                     "TASK_NOT_PUSHED for task %p\n",
3877cc577a4SJonathan Peyton                     gtid, taskdata));
3887cc577a4SJonathan Peyton       return TASK_NOT_PUSHED;
389c3344345SAndrey Churbanov     } else {
3907cc577a4SJonathan Peyton       __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
391c3344345SAndrey Churbanov       locked = 1;
3923895148dSJoachim Protze       if (TCR_4(thread_data->td.td_deque_ntasks) >=
3933895148dSJoachim Protze           TASK_DEQUE_SIZE(thread_data->td)) {
394c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
395c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
396c3344345SAndrey Churbanov       }
397c3344345SAndrey Churbanov     }
3983895148dSJoachim Protze   }
399c3344345SAndrey Churbanov   // Lock the deque for the task push operation
400c3344345SAndrey Churbanov   if (!locked) {
401c3344345SAndrey Churbanov     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
402c3344345SAndrey Churbanov     // Need to recheck as we can get a proxy task from thread outside of OpenMP
4033041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
4043041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
405a23806e6SAndrey Churbanov       if (__kmp_enable_task_throttling &&
406a23806e6SAndrey Churbanov           __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
407c3344345SAndrey Churbanov                                 thread->th.th_current_task)) {
4087cc577a4SJonathan Peyton         __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
409c3344345SAndrey Churbanov         KA_TRACE(20, ("__kmp_push_task: T#%d deque is full on 2nd check; "
410c3344345SAndrey Churbanov                       "returning TASK_NOT_PUSHED for task %p\n",
4117cc577a4SJonathan Peyton                       gtid, taskdata));
4127cc577a4SJonathan Peyton         return TASK_NOT_PUSHED;
413c3344345SAndrey Churbanov       } else {
414c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
415c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
4167cc577a4SJonathan Peyton       }
417c3344345SAndrey Churbanov     }
418c3344345SAndrey Churbanov   }
4197cc577a4SJonathan Peyton   // Must have room since no thread can add tasks but calling thread
4203041982dSJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) <
4213041982dSJonathan Peyton                    TASK_DEQUE_SIZE(thread_data->td));
4227cc577a4SJonathan Peyton 
4233041982dSJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] =
4243041982dSJonathan Peyton       taskdata; // Push taskdata
4257cc577a4SJonathan Peyton   // Wrap index.
4263041982dSJonathan Peyton   thread_data->td.td_deque_tail =
4273041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
4283041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
4293041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1); // Adjust task count
430ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(thread->th.th_current_task); // releasing self
431ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(taskdata); // releasing child
4327cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_push_task: T#%d returning TASK_SUCCESSFULLY_PUSHED: "
4337cc577a4SJonathan Peyton                 "task=%p ntasks=%d head=%u tail=%u\n",
4347cc577a4SJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
4357cc577a4SJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
4367cc577a4SJonathan Peyton 
437f1b9ce27SHansang Bae   auto hidden_helper = taskdata->td_flags.hidden_helper;
438f1b9ce27SHansang Bae 
4397cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
4407cc577a4SJonathan Peyton 
4419d64275aSShilei Tian   // Signal one worker thread to execute the task
442f1b9ce27SHansang Bae   if (UNLIKELY(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 // deallocate the taskdata and shared variable blocks associated with this task
7367cc577a4SJonathan Peyton #if USE_FAST_MEMORY
7377cc577a4SJonathan Peyton   __kmp_fast_free(thread, taskdata);
7387cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
7397cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskdata);
7407cc577a4SJonathan Peyton #endif
7413041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_free_task: T#%d freed task %p\n", gtid, taskdata));
7427cc577a4SJonathan Peyton }
7437cc577a4SJonathan Peyton 
7443041982dSJonathan Peyton // __kmp_free_task_and_ancestors: free the current task and ancestors without
7453041982dSJonathan Peyton // children
7467cc577a4SJonathan Peyton //
7477cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
7487cc577a4SJonathan Peyton // taskdata: task to free
7497cc577a4SJonathan Peyton // thread: thread data structure of caller
7503041982dSJonathan Peyton static void __kmp_free_task_and_ancestors(kmp_int32 gtid,
7513041982dSJonathan Peyton                                           kmp_taskdata_t *taskdata,
7523041982dSJonathan Peyton                                           kmp_info_t *thread) {
7537cc577a4SJonathan Peyton   // Proxy tasks must always be allowed to free their parents
7547cc577a4SJonathan Peyton   // because they can be run in background even in serial mode.
7553041982dSJonathan Peyton   kmp_int32 team_serial =
7563041982dSJonathan Peyton       (taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) &&
7573041982dSJonathan Peyton       !taskdata->td_flags.proxy;
7587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7597cc577a4SJonathan Peyton 
76037e2ef54SJonathan Peyton   kmp_int32 children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
7617cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
7627cc577a4SJonathan Peyton 
7637cc577a4SJonathan Peyton   // Now, go up the ancestor tree to see if any ancestors can now be freed.
7643041982dSJonathan Peyton   while (children == 0) {
7657cc577a4SJonathan Peyton     kmp_taskdata_t *parent_taskdata = taskdata->td_parent;
7667cc577a4SJonathan Peyton 
7677cc577a4SJonathan Peyton     KA_TRACE(20, ("__kmp_free_task_and_ancestors(enter): T#%d task %p complete "
7683041982dSJonathan Peyton                   "and freeing itself\n",
7693041982dSJonathan Peyton                   gtid, taskdata));
7707cc577a4SJonathan Peyton 
7717cc577a4SJonathan Peyton     // --- Deallocate my ancestor task ---
7727cc577a4SJonathan Peyton     __kmp_free_task(gtid, taskdata, thread);
7737cc577a4SJonathan Peyton 
7747cc577a4SJonathan Peyton     taskdata = parent_taskdata;
7757cc577a4SJonathan Peyton 
776c3344345SAndrey Churbanov     if (team_serial)
777c3344345SAndrey Churbanov       return;
7783041982dSJonathan Peyton     // Stop checking ancestors at implicit task instead of walking up ancestor
7793041982dSJonathan Peyton     // tree to avoid premature deallocation of ancestors.
780c3344345SAndrey Churbanov     if (taskdata->td_flags.tasktype == TASK_IMPLICIT) {
781c3344345SAndrey Churbanov       if (taskdata->td_dephash) { // do we need to cleanup dephash?
782c3344345SAndrey Churbanov         int children = KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks);
783c3344345SAndrey Churbanov         kmp_tasking_flags_t flags_old = taskdata->td_flags;
784c3344345SAndrey Churbanov         if (children == 0 && flags_old.complete == 1) {
785c3344345SAndrey Churbanov           kmp_tasking_flags_t flags_new = flags_old;
786c3344345SAndrey Churbanov           flags_new.complete = 0;
787c3344345SAndrey Churbanov           if (KMP_COMPARE_AND_STORE_ACQ32(
788c3344345SAndrey Churbanov                   RCAST(kmp_int32 *, &taskdata->td_flags),
789c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_old),
790c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_new))) {
791c3344345SAndrey Churbanov             KA_TRACE(100, ("__kmp_free_task_and_ancestors: T#%d cleans "
792c3344345SAndrey Churbanov                            "dephash of implicit task %p\n",
793c3344345SAndrey Churbanov                            gtid, taskdata));
794c3344345SAndrey Churbanov             // cleanup dephash of finished implicit task
795c3344345SAndrey Churbanov             __kmp_dephash_free_entries(thread, taskdata->td_dephash);
796c3344345SAndrey Churbanov           }
797c3344345SAndrey Churbanov         }
798c3344345SAndrey Churbanov       }
7997cc577a4SJonathan Peyton       return;
800c3344345SAndrey Churbanov     }
8017cc577a4SJonathan Peyton     // Predecrement simulated by "- 1" calculation
80237e2ef54SJonathan Peyton     children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
8037cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(children >= 0);
8047cc577a4SJonathan Peyton   }
8057cc577a4SJonathan Peyton 
8063041982dSJonathan Peyton   KA_TRACE(
8073041982dSJonathan Peyton       20, ("__kmp_free_task_and_ancestors(exit): T#%d task %p has %d children; "
8083041982dSJonathan Peyton            "not freeing it yet\n",
8093041982dSJonathan Peyton            gtid, taskdata, children));
8107cc577a4SJonathan Peyton }
8117cc577a4SJonathan Peyton 
8127cc577a4SJonathan Peyton // __kmp_task_finish: bookkeeping to do when a task finishes execution
8133041982dSJonathan Peyton //
8147cc577a4SJonathan Peyton // gtid: global thread ID for calling thread
8157cc577a4SJonathan Peyton // task: task to be finished
8167cc577a4SJonathan Peyton // resumed_task: task to be resumed.  (may be NULL if task is serialized)
81710995c77SJoachim Protze //
81810995c77SJoachim Protze // template<ompt>: effectively ompt_enabled.enabled!=0
81910995c77SJoachim Protze // the version with ompt=false is inlined, allowing to optimize away all ompt
82010995c77SJoachim Protze // code in this case
82186ed6aa6SJoachim Protze template <bool ompt>
8223041982dSJonathan Peyton static void __kmp_task_finish(kmp_int32 gtid, kmp_task_t *task,
8233041982dSJonathan Peyton                               kmp_taskdata_t *resumed_task) {
8247cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
8257cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
8263041982dSJonathan Peyton   kmp_task_team_t *task_team =
8273041982dSJonathan Peyton       thread->th.th_task_team; // might be NULL for serial teams...
8287cc577a4SJonathan Peyton   kmp_int32 children = 0;
8297cc577a4SJonathan Peyton 
8303041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_finish(enter): T#%d finishing task %p and resuming "
8313041982dSJonathan Peyton                 "task %p\n",
8327cc577a4SJonathan Peyton                 gtid, taskdata, resumed_task));
8337cc577a4SJonathan Peyton 
8347cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
8357cc577a4SJonathan Peyton 
8367cc577a4SJonathan Peyton // Pop task from stack if tied
8377cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
8383041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
8397cc577a4SJonathan Peyton     __kmp_pop_task_stack(gtid, thread, taskdata);
8407cc577a4SJonathan Peyton   }
8417cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
8427cc577a4SJonathan Peyton 
8436bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
8443041982dSJonathan Peyton     // untied task needs to check the counter so that the task structure is not
8453041982dSJonathan Peyton     // freed prematurely
84637e2ef54SJonathan Peyton     kmp_int32 counter = KMP_ATOMIC_DEC(&taskdata->td_untied_count) - 1;
8473041982dSJonathan Peyton     KA_TRACE(
8483041982dSJonathan Peyton         20,
8493041982dSJonathan Peyton         ("__kmp_task_finish: T#%d untied_count (%d) decremented for task %p\n",
8507cc577a4SJonathan Peyton          gtid, counter, taskdata));
8517cc577a4SJonathan Peyton     if (counter > 0) {
8523041982dSJonathan Peyton       // untied task is not done, to be continued possibly by other thread, do
8533041982dSJonathan Peyton       // not free it now
8547cc577a4SJonathan Peyton       if (resumed_task == NULL) {
8557cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(taskdata->td_flags.task_serial);
8563041982dSJonathan Peyton         resumed_task = taskdata->td_parent; // In a serialized task, the resumed
8573041982dSJonathan Peyton         // task is the parent
8587cc577a4SJonathan Peyton       }
8597cc577a4SJonathan Peyton       thread->th.th_current_task = resumed_task; // restore current_task
8607cc577a4SJonathan Peyton       resumed_task->td_flags.executing = 1; // resume previous task
8613041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_task_finish(exit): T#%d partially done task %p, "
8623041982dSJonathan Peyton                     "resuming task %p\n",
8637cc577a4SJonathan Peyton                     gtid, taskdata, resumed_task));
8647cc577a4SJonathan Peyton       return;
8657cc577a4SJonathan Peyton     }
8667cc577a4SJonathan Peyton   }
8677cc577a4SJonathan Peyton 
868d23131a3SJoachim Protze   // bookkeeping for resuming task:
869d23131a3SJoachim Protze   // GEH - note tasking_ser => task_serial
870d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(
871d23131a3SJoachim Protze       (taskdata->td_flags.tasking_ser || taskdata->td_flags.task_serial) ==
872d23131a3SJoachim Protze       taskdata->td_flags.task_serial);
873d23131a3SJoachim Protze   if (taskdata->td_flags.task_serial) {
874d23131a3SJoachim Protze     if (resumed_task == NULL) {
875d23131a3SJoachim Protze       resumed_task = taskdata->td_parent; // In a serialized task, the resumed
876d23131a3SJoachim Protze       // task is the parent
877d23131a3SJoachim Protze     }
878d23131a3SJoachim Protze   } else {
879d23131a3SJoachim Protze     KMP_DEBUG_ASSERT(resumed_task !=
880d23131a3SJoachim Protze                      NULL); // verify that resumed task is passed as argument
881d23131a3SJoachim Protze   }
882d23131a3SJoachim Protze 
883d23131a3SJoachim Protze   /* If the tasks' destructor thunk flag has been set, we need to invoke the
884d23131a3SJoachim Protze      destructor thunk that has been generated by the compiler. The code is
885d23131a3SJoachim Protze      placed here, since at this point other tasks might have been released
886d23131a3SJoachim Protze      hence overlapping the destructor invocations with some other work in the
887d23131a3SJoachim Protze      released tasks.  The OpenMP spec is not specific on when the destructors
888d23131a3SJoachim Protze      are invoked, so we should be free to choose. */
889838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.destructors_thunk)) {
890d23131a3SJoachim Protze     kmp_routine_entry_t destr_thunk = task->data1.destructors;
891d23131a3SJoachim Protze     KMP_ASSERT(destr_thunk);
892d23131a3SJoachim Protze     destr_thunk(gtid, task);
893d23131a3SJoachim Protze   }
894d23131a3SJoachim Protze 
8957cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
896d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 1);
897d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
898d23131a3SJoachim Protze 
899405037c4SAndrey Churbanov   bool detach = false;
900838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.detachable == TASK_DETACHABLE)) {
901405037c4SAndrey Churbanov     if (taskdata->td_allow_completion_event.type ==
902405037c4SAndrey Churbanov         KMP_EVENT_ALLOW_COMPLETION) {
903405037c4SAndrey Churbanov       // event hasn't been fulfilled yet. Try to detach task.
904405037c4SAndrey Churbanov       __kmp_acquire_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
905405037c4SAndrey Churbanov       if (taskdata->td_allow_completion_event.type ==
906405037c4SAndrey Churbanov           KMP_EVENT_ALLOW_COMPLETION) {
907d23131a3SJoachim Protze         // task finished execution
908d23131a3SJoachim Protze         KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
909d23131a3SJoachim Protze         taskdata->td_flags.executing = 0; // suspend the finishing task
91010995c77SJoachim Protze 
91110995c77SJoachim Protze #if OMPT_SUPPORT
91210995c77SJoachim Protze         // For a detached task, which is not completed, we switch back
91310995c77SJoachim Protze         // the omp_fulfill_event signals completion
91410995c77SJoachim Protze         // locking is necessary to avoid a race with ompt_task_late_fulfill
91510995c77SJoachim Protze         if (ompt)
91610995c77SJoachim Protze           __ompt_task_finish(task, resumed_task, ompt_task_detach);
91710995c77SJoachim Protze #endif
91810995c77SJoachim Protze 
919d23131a3SJoachim Protze         // no access to taskdata after this point!
920d23131a3SJoachim Protze         // __kmp_fulfill_event might free taskdata at any time from now
92110995c77SJoachim Protze 
922405037c4SAndrey Churbanov         taskdata->td_flags.proxy = TASK_PROXY; // proxify!
923405037c4SAndrey Churbanov         detach = true;
924405037c4SAndrey Churbanov       }
925405037c4SAndrey Churbanov       __kmp_release_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
926405037c4SAndrey Churbanov     }
927405037c4SAndrey Churbanov   }
9287cc577a4SJonathan Peyton 
929405037c4SAndrey Churbanov   if (!detach) {
930405037c4SAndrey Churbanov     taskdata->td_flags.complete = 1; // mark the task as completed
931405037c4SAndrey Churbanov 
93210995c77SJoachim Protze #if OMPT_SUPPORT
93310995c77SJoachim Protze     // This is not a detached task, we are done here
93410995c77SJoachim Protze     if (ompt)
93510995c77SJoachim Protze       __ompt_task_finish(task, resumed_task, ompt_task_complete);
93610995c77SJoachim Protze #endif
93710995c77SJoachim Protze 
9383041982dSJonathan Peyton     // Only need to keep track of count if team parallel and tasking not
93957d8b8d6SAndreyChurbanov     // serialized, or task is detachable and event has already been fulfilled
94057d8b8d6SAndreyChurbanov     if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) ||
9419d64275aSShilei Tian         taskdata->td_flags.detachable == TASK_DETACHABLE ||
9429d64275aSShilei Tian         taskdata->td_flags.hidden_helper) {
9437cc577a4SJonathan Peyton       // Predecrement simulated by "- 1" calculation
9443041982dSJonathan Peyton       children =
94537e2ef54SJonathan Peyton           KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
9467cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(children >= 0);
9477cc577a4SJonathan Peyton       if (taskdata->td_taskgroup)
94837e2ef54SJonathan Peyton         KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
949cf27e31bSJonathan Peyton       __kmp_release_deps(gtid, taskdata);
950cf27e31bSJonathan Peyton     } else if (task_team && task_team->tt.tt_found_proxy_tasks) {
9517cc577a4SJonathan Peyton       // if we found proxy tasks there could exist a dependency chain
9527cc577a4SJonathan Peyton       // with the proxy task as origin
9537cc577a4SJonathan Peyton       __kmp_release_deps(gtid, taskdata);
9547cc577a4SJonathan Peyton     }
9553041982dSJonathan Peyton     // td_flags.executing must be marked as 0 after __kmp_release_deps has been
956d23131a3SJoachim Protze     // called. Othertwise, if a task is executed immediately from the
957d23131a3SJoachim Protze     // release_deps code, the flag will be reset to 1 again by this same
958d23131a3SJoachim Protze     // function
9597cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
9607cc577a4SJonathan Peyton     taskdata->td_flags.executing = 0; // suspend the finishing task
961d23131a3SJoachim Protze   }
962d23131a3SJoachim Protze 
9633041982dSJonathan Peyton   KA_TRACE(
9643041982dSJonathan Peyton       20, ("__kmp_task_finish: T#%d finished task %p, %d incomplete children\n",
9657cc577a4SJonathan Peyton            gtid, taskdata, children));
9667cc577a4SJonathan Peyton 
9677cc577a4SJonathan Peyton   // Free this task and then ancestor tasks if they have no children.
9687cc577a4SJonathan Peyton   // Restore th_current_task first as suggested by John:
9697cc577a4SJonathan Peyton   // johnmc: if an asynchronous inquiry peers into the runtime system
9707cc577a4SJonathan Peyton   // it doesn't see the freed task as the current task.
9717cc577a4SJonathan Peyton   thread->th.th_current_task = resumed_task;
972405037c4SAndrey Churbanov   if (!detach)
9737cc577a4SJonathan Peyton     __kmp_free_task_and_ancestors(gtid, taskdata, thread);
9747cc577a4SJonathan Peyton 
9757cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
9767cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( resumed_task->td_flags.executing == 0 );
9777cc577a4SJonathan Peyton   resumed_task->td_flags.executing = 1; // resume previous task
9787cc577a4SJonathan Peyton 
9793041982dSJonathan Peyton   KA_TRACE(
9803041982dSJonathan Peyton       10, ("__kmp_task_finish(exit): T#%d finished task %p, resuming task %p\n",
9817cc577a4SJonathan Peyton            gtid, taskdata, resumed_task));
9827cc577a4SJonathan Peyton 
9837cc577a4SJonathan Peyton   return;
9847cc577a4SJonathan Peyton }
9857cc577a4SJonathan Peyton 
98682e94a59SJoachim Protze template <bool ompt>
98782e94a59SJoachim Protze static void __kmpc_omp_task_complete_if0_template(ident_t *loc_ref,
98882e94a59SJoachim Protze                                                   kmp_int32 gtid,
9893041982dSJonathan Peyton                                                   kmp_task_t *task) {
9907cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(enter): T#%d loc=%p task=%p\n",
9917cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
992838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
9933041982dSJonathan Peyton   // this routine will provide task to resume
99486ed6aa6SJoachim Protze   __kmp_task_finish<ompt>(gtid, task, NULL);
9957cc577a4SJonathan Peyton 
9967cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(exit): T#%d loc=%p task=%p\n",
9977cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
99882e94a59SJoachim Protze 
99982e94a59SJoachim Protze #if OMPT_SUPPORT
100082e94a59SJoachim Protze   if (ompt) {
10010e0d6cddSJoachim Protze     ompt_frame_t *ompt_frame;
100282e94a59SJoachim Protze     __ompt_get_task_info_internal(0, NULL, NULL, &ompt_frame, NULL, NULL);
10030e0d6cddSJoachim Protze     ompt_frame->enter_frame = ompt_data_none;
1004309b00a4SShilei Tian     ompt_frame->enter_frame_flags =
1005309b00a4SShilei Tian         ompt_frame_runtime | ompt_frame_framepointer;
100682e94a59SJoachim Protze   }
100782e94a59SJoachim Protze #endif
100882e94a59SJoachim Protze 
10097cc577a4SJonathan Peyton   return;
10107cc577a4SJonathan Peyton }
10117cc577a4SJonathan Peyton 
101282e94a59SJoachim Protze #if OMPT_SUPPORT
101382e94a59SJoachim Protze OMPT_NOINLINE
101482e94a59SJoachim Protze void __kmpc_omp_task_complete_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
101582e94a59SJoachim Protze                                        kmp_task_t *task) {
101682e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<true>(loc_ref, gtid, task);
101782e94a59SJoachim Protze }
101882e94a59SJoachim Protze #endif // OMPT_SUPPORT
101982e94a59SJoachim Protze 
102082e94a59SJoachim Protze // __kmpc_omp_task_complete_if0: report that a task has completed execution
102182e94a59SJoachim Protze //
102282e94a59SJoachim Protze // loc_ref: source location information; points to end of task block.
102382e94a59SJoachim Protze // gtid: global thread number.
102482e94a59SJoachim Protze // task: task thunk for the completed task.
102582e94a59SJoachim Protze void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
102682e94a59SJoachim Protze                                   kmp_task_t *task) {
102782e94a59SJoachim Protze #if OMPT_SUPPORT
102882e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
102982e94a59SJoachim Protze     __kmpc_omp_task_complete_if0_ompt(loc_ref, gtid, task);
103082e94a59SJoachim Protze     return;
103182e94a59SJoachim Protze   }
103282e94a59SJoachim Protze #endif
103382e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<false>(loc_ref, gtid, task);
103482e94a59SJoachim Protze }
103582e94a59SJoachim Protze 
10367cc577a4SJonathan Peyton #ifdef TASK_UNUSED
10377cc577a4SJonathan Peyton // __kmpc_omp_task_complete: report that a task has completed execution
10387cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
10393041982dSJonathan Peyton void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
10403041982dSJonathan Peyton                               kmp_task_t *task) {
10413041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(enter): T#%d loc=%p task=%p\n", gtid,
10423041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10437cc577a4SJonathan Peyton 
104486ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task,
104586ed6aa6SJoachim Protze                            NULL); // Not sure how to find task to resume
10467cc577a4SJonathan Peyton 
10473041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(exit): T#%d loc=%p task=%p\n", gtid,
10483041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10497cc577a4SJonathan Peyton   return;
10507cc577a4SJonathan Peyton }
10517cc577a4SJonathan Peyton #endif // TASK_UNUSED
10527cc577a4SJonathan Peyton 
10533041982dSJonathan Peyton // __kmp_init_implicit_task: Initialize the appropriate fields in the implicit
10543041982dSJonathan Peyton // task for a given thread
10557cc577a4SJonathan Peyton //
10567cc577a4SJonathan Peyton // loc_ref:  reference to source location of parallel region
10577cc577a4SJonathan Peyton // this_thr:  thread data structure corresponding to implicit task
10587cc577a4SJonathan Peyton // team: team for this_thr
10597cc577a4SJonathan Peyton // tid: thread id of given thread within team
10607cc577a4SJonathan Peyton // set_curr_task: TRUE if need to push current task to thread
10613041982dSJonathan Peyton // NOTE: Routine does not set up the implicit task ICVS.  This is assumed to
10623041982dSJonathan Peyton // have already been done elsewhere.
10637cc577a4SJonathan Peyton // TODO: Get better loc_ref.  Value passed in may be NULL
10643041982dSJonathan Peyton void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
10653041982dSJonathan Peyton                               kmp_team_t *team, int tid, int set_curr_task) {
10667cc577a4SJonathan Peyton   kmp_taskdata_t *task = &team->t.t_implicit_task_taskdata[tid];
10677cc577a4SJonathan Peyton 
10683041982dSJonathan Peyton   KF_TRACE(
10693041982dSJonathan Peyton       10,
10703041982dSJonathan Peyton       ("__kmp_init_implicit_task(enter): T#:%d team=%p task=%p, reinit=%s\n",
10717cc577a4SJonathan Peyton        tid, team, task, set_curr_task ? "TRUE" : "FALSE"));
10727cc577a4SJonathan Peyton 
10737cc577a4SJonathan Peyton   task->td_task_id = KMP_GEN_TASK_ID();
10747cc577a4SJonathan Peyton   task->td_team = team;
10753041982dSJonathan Peyton   //    task->td_parent   = NULL;  // fix for CQ230101 (broken parent task info
10763041982dSJonathan Peyton   //    in debugger)
10777cc577a4SJonathan Peyton   task->td_ident = loc_ref;
10787cc577a4SJonathan Peyton   task->td_taskwait_ident = NULL;
10797cc577a4SJonathan Peyton   task->td_taskwait_counter = 0;
10807cc577a4SJonathan Peyton   task->td_taskwait_thread = 0;
10817cc577a4SJonathan Peyton 
10827cc577a4SJonathan Peyton   task->td_flags.tiedness = TASK_TIED;
10837cc577a4SJonathan Peyton   task->td_flags.tasktype = TASK_IMPLICIT;
10847cc577a4SJonathan Peyton   task->td_flags.proxy = TASK_FULL;
10857cc577a4SJonathan Peyton 
10867cc577a4SJonathan Peyton   // All implicit tasks are executed immediately, not deferred
10877cc577a4SJonathan Peyton   task->td_flags.task_serial = 1;
10887cc577a4SJonathan Peyton   task->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
10897cc577a4SJonathan Peyton   task->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
10907cc577a4SJonathan Peyton 
10917cc577a4SJonathan Peyton   task->td_flags.started = 1;
10927cc577a4SJonathan Peyton   task->td_flags.executing = 1;
10937cc577a4SJonathan Peyton   task->td_flags.complete = 0;
10947cc577a4SJonathan Peyton   task->td_flags.freed = 0;
10957cc577a4SJonathan Peyton 
10967cc577a4SJonathan Peyton   task->td_depnode = NULL;
1097a756cb24SAndrey Churbanov   task->td_last_tied = task;
1098405037c4SAndrey Churbanov   task->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
10997cc577a4SJonathan Peyton 
11003041982dSJonathan Peyton   if (set_curr_task) { // only do this init first time thread is created
110137e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_incomplete_child_tasks, 0);
1102642688b6SJonathan Peyton     // Not used: don't need to deallocate implicit task
110337e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_allocated_child_tasks, 0);
11047cc577a4SJonathan Peyton     task->td_taskgroup = NULL; // An implicit task does not have taskgroup
11057cc577a4SJonathan Peyton     task->td_dephash = NULL;
11067cc577a4SJonathan Peyton     __kmp_push_current_task_to_thread(this_thr, team, tid);
11077cc577a4SJonathan Peyton   } else {
11087cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_incomplete_child_tasks == 0);
11097cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_allocated_child_tasks == 0);
11107cc577a4SJonathan Peyton   }
11117cc577a4SJonathan Peyton 
11127cc577a4SJonathan Peyton #if OMPT_SUPPORT
1113f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
111482e94a59SJoachim Protze     __ompt_task_init(task, tid);
11157cc577a4SJonathan Peyton #endif
11167cc577a4SJonathan Peyton 
11173041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_init_implicit_task(exit): T#:%d team=%p task=%p\n", tid,
11183041982dSJonathan Peyton                 team, task));
11197cc577a4SJonathan Peyton }
11207cc577a4SJonathan Peyton 
11213041982dSJonathan Peyton // __kmp_finish_implicit_task: Release resources associated to implicit tasks
11223041982dSJonathan Peyton // at the end of parallel regions. Some resources are kept for reuse in the next
11233041982dSJonathan Peyton // parallel region.
11247cc577a4SJonathan Peyton //
11253041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11263041982dSJonathan Peyton void __kmp_finish_implicit_task(kmp_info_t *thread) {
11277cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1128c3344345SAndrey Churbanov   if (task->td_dephash) {
1129c3344345SAndrey Churbanov     int children;
1130c3344345SAndrey Churbanov     task->td_flags.complete = 1;
1131c3344345SAndrey Churbanov     children = KMP_ATOMIC_LD_ACQ(&task->td_incomplete_child_tasks);
1132c3344345SAndrey Churbanov     kmp_tasking_flags_t flags_old = task->td_flags;
1133c3344345SAndrey Churbanov     if (children == 0 && flags_old.complete == 1) {
1134c3344345SAndrey Churbanov       kmp_tasking_flags_t flags_new = flags_old;
1135c3344345SAndrey Churbanov       flags_new.complete = 0;
1136c3344345SAndrey Churbanov       if (KMP_COMPARE_AND_STORE_ACQ32(RCAST(kmp_int32 *, &task->td_flags),
1137c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_old),
1138c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_new))) {
1139c3344345SAndrey Churbanov         KA_TRACE(100, ("__kmp_finish_implicit_task: T#%d cleans "
1140c3344345SAndrey Churbanov                        "dephash of implicit task %p\n",
1141c3344345SAndrey Churbanov                        thread->th.th_info.ds.ds_gtid, task));
11427cc577a4SJonathan Peyton         __kmp_dephash_free_entries(thread, task->td_dephash);
11437cc577a4SJonathan Peyton       }
1144c3344345SAndrey Churbanov     }
1145c3344345SAndrey Churbanov   }
1146c3344345SAndrey Churbanov }
11477cc577a4SJonathan Peyton 
11483041982dSJonathan Peyton // __kmp_free_implicit_task: Release resources associated to implicit tasks
11493041982dSJonathan Peyton // when these are destroyed regions
11507cc577a4SJonathan Peyton //
11513041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11523041982dSJonathan Peyton void __kmp_free_implicit_task(kmp_info_t *thread) {
11537cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1154bff8ded9SJonathan Peyton   if (task && task->td_dephash) {
11557cc577a4SJonathan Peyton     __kmp_dephash_free(thread, task->td_dephash);
11567cc577a4SJonathan Peyton     task->td_dephash = NULL;
11577cc577a4SJonathan Peyton   }
1158bff8ded9SJonathan Peyton }
11597cc577a4SJonathan Peyton 
11603041982dSJonathan Peyton // Round up a size to a power of two specified by val: Used to insert padding
11613041982dSJonathan Peyton // between structures co-allocated using a single malloc() call
11623041982dSJonathan Peyton static size_t __kmp_round_up_to_val(size_t size, size_t val) {
11637cc577a4SJonathan Peyton   if (size & (val - 1)) {
11647cc577a4SJonathan Peyton     size &= ~(val - 1);
11657cc577a4SJonathan Peyton     if (size <= KMP_SIZE_T_MAX - val) {
11667cc577a4SJonathan Peyton       size += val; // Round up if there is no overflow.
1167bd3a7633SJonathan Peyton     }
1168bd3a7633SJonathan Peyton   }
11697cc577a4SJonathan Peyton   return size;
11707cc577a4SJonathan Peyton } // __kmp_round_up_to_va
11717cc577a4SJonathan Peyton 
11727cc577a4SJonathan Peyton // __kmp_task_alloc: Allocate the taskdata and task data structures for a task
11737cc577a4SJonathan Peyton //
11747cc577a4SJonathan Peyton // loc_ref: source location information
11757cc577a4SJonathan Peyton // gtid: global thread number.
11763041982dSJonathan Peyton // flags: include tiedness & task type (explicit vs. implicit) of the ''new''
11773041982dSJonathan Peyton // task encountered. Converted from kmp_int32 to kmp_tasking_flags_t in routine.
11783041982dSJonathan Peyton // sizeof_kmp_task_t:  Size in bytes of kmp_task_t data structure including
11793041982dSJonathan Peyton // private vars accessed in task.
11803041982dSJonathan Peyton // sizeof_shareds:  Size in bytes of array of pointers to shared vars accessed
11813041982dSJonathan Peyton // in task.
11827cc577a4SJonathan Peyton // task_entry: Pointer to task code entry point generated by compiler.
11837cc577a4SJonathan Peyton // returns: a pointer to the allocated kmp_task_t structure (task).
11843041982dSJonathan Peyton kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
11853041982dSJonathan Peyton                              kmp_tasking_flags_t *flags,
11867cc577a4SJonathan Peyton                              size_t sizeof_kmp_task_t, size_t sizeof_shareds,
11873041982dSJonathan Peyton                              kmp_routine_entry_t task_entry) {
11887cc577a4SJonathan Peyton   kmp_task_t *task;
11897cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
11907cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
11919d64275aSShilei Tian   kmp_info_t *encountering_thread = thread;
11927cc577a4SJonathan Peyton   kmp_team_t *team = thread->th.th_team;
11937cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
11947cc577a4SJonathan Peyton   size_t shareds_offset;
11957cc577a4SJonathan Peyton 
11966bf84871SAndreyChurbanov   if (UNLIKELY(!TCR_4(__kmp_init_middle)))
119728226e7dSJonathan Peyton     __kmp_middle_initialize();
119828226e7dSJonathan Peyton 
11999d64275aSShilei Tian   if (flags->hidden_helper) {
12009d64275aSShilei Tian     if (__kmp_enable_hidden_helper) {
12019d64275aSShilei Tian       if (!TCR_4(__kmp_init_hidden_helper))
12029d64275aSShilei Tian         __kmp_hidden_helper_initialize();
12039d64275aSShilei Tian 
12049d64275aSShilei Tian       // For a hidden helper task encountered by a regular thread, we will push
12059d64275aSShilei Tian       // the task to the (gtid%__kmp_hidden_helper_threads_num)-th hidden helper
12069d64275aSShilei Tian       // thread.
12079d64275aSShilei Tian       if (!KMP_HIDDEN_HELPER_THREAD(gtid)) {
12089d64275aSShilei Tian         thread = __kmp_threads[KMP_GTID_TO_SHADOW_GTID(gtid)];
12099d64275aSShilei Tian         // We don't change the parent-child relation for hidden helper task as
12109d64275aSShilei Tian         // we need that to do per-task-region synchronization.
12119d64275aSShilei Tian       }
12129d64275aSShilei Tian     } else {
12139d64275aSShilei Tian       // If the hidden helper task is not enabled, reset the flag to FALSE.
12149d64275aSShilei Tian       flags->hidden_helper = FALSE;
12159d64275aSShilei Tian     }
12169d64275aSShilei Tian   }
12179d64275aSShilei Tian 
12187cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_task_alloc(enter): T#%d loc=%p, flags=(0x%x) "
12197cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12207cc577a4SJonathan Peyton                 gtid, loc_ref, *((kmp_int32 *)flags), sizeof_kmp_task_t,
12217cc577a4SJonathan Peyton                 sizeof_shareds, task_entry));
12227cc577a4SJonathan Peyton 
1223467f3924SHansang Bae   KMP_DEBUG_ASSERT(parent_task);
12247cc577a4SJonathan Peyton   if (parent_task->td_flags.final) {
12257cc577a4SJonathan Peyton     if (flags->merged_if0) {
12267cc577a4SJonathan Peyton     }
12277cc577a4SJonathan Peyton     flags->final = 1;
12287cc577a4SJonathan Peyton   }
12299d64275aSShilei Tian 
1230a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED && !team->t.t_serialized) {
1231a756cb24SAndrey Churbanov     // Untied task encountered causes the TSC algorithm to check entire deque of
1232a756cb24SAndrey Churbanov     // the victim thread. If no untied task encountered, then checking the head
1233a756cb24SAndrey Churbanov     // of the deque should be enough.
12349d64275aSShilei Tian     KMP_CHECK_UPDATE(
12359d64275aSShilei Tian         encountering_thread->th.th_task_team->tt.tt_untied_task_encountered, 1);
1236a756cb24SAndrey Churbanov   }
12377cc577a4SJonathan Peyton 
1238405037c4SAndrey Churbanov   // Detachable tasks are not proxy tasks yet but could be in the future. Doing
1239405037c4SAndrey Churbanov   // the tasking setup
1240405037c4SAndrey Churbanov   // when that happens is too late.
1241838dcdb5SAndreyChurbanov   if (UNLIKELY(flags->proxy == TASK_PROXY ||
1242838dcdb5SAndreyChurbanov                flags->detachable == TASK_DETACHABLE || flags->hidden_helper)) {
12437cc577a4SJonathan Peyton     if (flags->proxy == TASK_PROXY) {
12447cc577a4SJonathan Peyton       flags->tiedness = TASK_UNTIED;
12457cc577a4SJonathan Peyton       flags->merged_if0 = 1;
1246405037c4SAndrey Churbanov     }
12473041982dSJonathan Peyton     /* are we running in a sequential parallel or tskm_immediate_exec... we need
12483041982dSJonathan Peyton        tasking support enabled */
12499d64275aSShilei Tian     if ((encountering_thread->th.th_task_team) == NULL) {
12507cc577a4SJonathan Peyton       /* This should only happen if the team is serialized
12513041982dSJonathan Peyton           setup a task team and propagate it to the thread */
12527cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(team->t.t_serialized);
12533041982dSJonathan Peyton       KA_TRACE(30,
12543041982dSJonathan Peyton                ("T#%d creating task team in __kmp_task_alloc for proxy task\n",
12553041982dSJonathan Peyton                 gtid));
12563041982dSJonathan Peyton       __kmp_task_team_setup(
12579d64275aSShilei Tian           encountering_thread, team,
12583041982dSJonathan Peyton           1); // 1 indicates setup the current team regardless of nthreads
12599d64275aSShilei Tian       encountering_thread->th.th_task_team =
12609d64275aSShilei Tian           team->t.t_task_team[encountering_thread->th.th_task_state];
12617cc577a4SJonathan Peyton     }
12629d64275aSShilei Tian     kmp_task_team_t *task_team = encountering_thread->th.th_task_team;
12637cc577a4SJonathan Peyton 
12647cc577a4SJonathan Peyton     /* tasking must be enabled now as the task might not be pushed */
12657cc577a4SJonathan Peyton     if (!KMP_TASKING_ENABLED(task_team)) {
12663041982dSJonathan Peyton       KA_TRACE(
12673041982dSJonathan Peyton           30,
12683041982dSJonathan Peyton           ("T#%d enabling tasking in __kmp_task_alloc for proxy task\n", gtid));
12699d64275aSShilei Tian       __kmp_enable_tasking(task_team, encountering_thread);
12709d64275aSShilei Tian       kmp_int32 tid = encountering_thread->th.th_info.ds.ds_tid;
12717cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
12727cc577a4SJonathan Peyton       // No lock needed since only owner can allocate
12737cc577a4SJonathan Peyton       if (thread_data->td.td_deque == NULL) {
12749d64275aSShilei Tian         __kmp_alloc_task_deque(encountering_thread, thread_data);
12757cc577a4SJonathan Peyton       }
12767cc577a4SJonathan Peyton     }
12777cc577a4SJonathan Peyton 
12783c31b784SShilei Tian     if ((flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE) &&
12799d64275aSShilei Tian         task_team->tt.tt_found_proxy_tasks == FALSE)
12807cc577a4SJonathan Peyton       TCW_4(task_team->tt.tt_found_proxy_tasks, TRUE);
12819d64275aSShilei Tian     if (flags->hidden_helper &&
12829d64275aSShilei Tian         task_team->tt.tt_hidden_helper_task_encountered == FALSE)
12839d64275aSShilei Tian       TCW_4(task_team->tt.tt_hidden_helper_task_encountered, TRUE);
12847cc577a4SJonathan Peyton   }
12857cc577a4SJonathan Peyton 
12867cc577a4SJonathan Peyton   // Calculate shared structure offset including padding after kmp_task_t struct
12877cc577a4SJonathan Peyton   // to align pointers in shared struct
12887cc577a4SJonathan Peyton   shareds_offset = sizeof(kmp_taskdata_t) + sizeof_kmp_task_t;
12897cc577a4SJonathan Peyton   shareds_offset = __kmp_round_up_to_val(shareds_offset, sizeof(void *));
12907cc577a4SJonathan Peyton 
12917cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
12923041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d First malloc size: %ld\n", gtid,
12933041982dSJonathan Peyton                 shareds_offset));
12943041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d Second malloc size: %ld\n", gtid,
12953041982dSJonathan Peyton                 sizeof_shareds));
12967cc577a4SJonathan Peyton 
12977cc577a4SJonathan Peyton   // Avoid double allocation here by combining shareds with taskdata
12987cc577a4SJonathan Peyton #if USE_FAST_MEMORY
12999d64275aSShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(
13009d64275aSShilei Tian       encountering_thread, shareds_offset + sizeof_shareds);
13017cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
13029d64275aSShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(
13039d64275aSShilei Tian       encountering_thread, shareds_offset + sizeof_shareds);
13047cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
13057cc577a4SJonathan Peyton 
13067cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
13077cc577a4SJonathan Peyton 
13087cc577a4SJonathan Peyton // Make sure task & taskdata are aligned appropriately
13097cc577a4SJonathan Peyton #if KMP_ARCH_X86 || KMP_ARCH_PPC64 || !KMP_HAVE_QUAD
13107cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(double) - 1)) == 0);
13117cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(double) - 1)) == 0);
13127cc577a4SJonathan Peyton #else
13137cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(_Quad) - 1)) == 0);
13147cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(_Quad) - 1)) == 0);
13157cc577a4SJonathan Peyton #endif
13167cc577a4SJonathan Peyton   if (sizeof_shareds > 0) {
13177cc577a4SJonathan Peyton     // Avoid double allocation here by combining shareds with taskdata
13187cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
13197cc577a4SJonathan Peyton     // Make sure shareds struct is aligned to pointer size
13203041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
13213041982dSJonathan Peyton                      0);
13227cc577a4SJonathan Peyton   } else {
13237cc577a4SJonathan Peyton     task->shareds = NULL;
13247cc577a4SJonathan Peyton   }
13257cc577a4SJonathan Peyton   task->routine = task_entry;
13267cc577a4SJonathan Peyton   task->part_id = 0; // AC: Always start with 0 part id
13277cc577a4SJonathan Peyton 
13287cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
13299d64275aSShilei Tian   taskdata->td_team = thread->th.th_team;
13309d64275aSShilei Tian   taskdata->td_alloc_thread = encountering_thread;
13317cc577a4SJonathan Peyton   taskdata->td_parent = parent_task;
13327cc577a4SJonathan Peyton   taskdata->td_level = parent_task->td_level + 1; // increment nesting level
133337e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_untied_count, 0);
13347cc577a4SJonathan Peyton   taskdata->td_ident = loc_ref;
13357cc577a4SJonathan Peyton   taskdata->td_taskwait_ident = NULL;
13367cc577a4SJonathan Peyton   taskdata->td_taskwait_counter = 0;
13377cc577a4SJonathan Peyton   taskdata->td_taskwait_thread = 0;
13387cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_parent != NULL);
13397cc577a4SJonathan Peyton   // avoid copying icvs for proxy tasks
13407cc577a4SJonathan Peyton   if (flags->proxy == TASK_FULL)
13417cc577a4SJonathan Peyton     copy_icvs(&taskdata->td_icvs, &taskdata->td_parent->td_icvs);
13427cc577a4SJonathan Peyton 
1343*db635a28SHansang Bae   taskdata->td_flags = *flags;
13449d64275aSShilei Tian   taskdata->encountering_gtid = gtid;
13457cc577a4SJonathan Peyton   taskdata->td_task_team = thread->th.th_task_team;
13467cc577a4SJonathan Peyton   taskdata->td_size_alloc = shareds_offset + sizeof_shareds;
13477cc577a4SJonathan Peyton   taskdata->td_flags.tasktype = TASK_EXPLICIT;
13487cc577a4SJonathan Peyton 
13497cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of tasking_ser flag
13507cc577a4SJonathan Peyton   taskdata->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
13517cc577a4SJonathan Peyton 
13527cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of team_serial flag
13537cc577a4SJonathan Peyton   taskdata->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
13547cc577a4SJonathan Peyton 
13553041982dSJonathan Peyton   // GEH - Note we serialize the task if the team is serialized to make sure
13563041982dSJonathan Peyton   // implicit parallel region tasks are not left until program termination to
13573041982dSJonathan Peyton   // execute. Also, it helps locality to execute immediately.
13583041982dSJonathan Peyton 
13593041982dSJonathan Peyton   taskdata->td_flags.task_serial =
13603041982dSJonathan Peyton       (parent_task->td_flags.final || taskdata->td_flags.team_serial ||
1361add8d90cSJoachim Protze        taskdata->td_flags.tasking_ser || flags->merged_if0);
13627cc577a4SJonathan Peyton 
13637cc577a4SJonathan Peyton   taskdata->td_flags.started = 0;
13647cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0;
13657cc577a4SJonathan Peyton   taskdata->td_flags.complete = 0;
13667cc577a4SJonathan Peyton   taskdata->td_flags.freed = 0;
13677cc577a4SJonathan Peyton 
136837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_incomplete_child_tasks, 0);
136937e2ef54SJonathan Peyton   // start at one because counts current task and children
137037e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_allocated_child_tasks, 1);
13713041982dSJonathan Peyton   taskdata->td_taskgroup =
13723041982dSJonathan Peyton       parent_task->td_taskgroup; // task inherits taskgroup from the parent task
13737cc577a4SJonathan Peyton   taskdata->td_dephash = NULL;
13747cc577a4SJonathan Peyton   taskdata->td_depnode = NULL;
1375a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED)
1376a756cb24SAndrey Churbanov     taskdata->td_last_tied = NULL; // will be set when the task is scheduled
1377a756cb24SAndrey Churbanov   else
1378a756cb24SAndrey Churbanov     taskdata->td_last_tied = taskdata;
1379405037c4SAndrey Churbanov   taskdata->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
138086ed6aa6SJoachim Protze #if OMPT_SUPPORT
138186ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled))
138286ed6aa6SJoachim Protze     __ompt_task_init(taskdata, gtid);
138386ed6aa6SJoachim Protze #endif
13849d64275aSShilei Tian   // Only need to keep track of child task counts if team parallel and tasking
13859d64275aSShilei Tian   // not serialized or if it is a proxy or detachable or hidden helper task
13869d64275aSShilei Tian   if (flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE ||
13879d64275aSShilei Tian       flags->hidden_helper ||
13889d64275aSShilei Tian       !(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
138937e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
13907cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
139137e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
13923041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
13933041982dSJonathan Peyton     // implicit not deallocated
13947cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT) {
139537e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
13967cc577a4SJonathan Peyton     }
13979d64275aSShilei Tian     if (flags->hidden_helper) {
13989d64275aSShilei Tian       taskdata->td_flags.task_serial = FALSE;
13999d64275aSShilei Tian       // Increment the number of hidden helper tasks to be executed
14009d64275aSShilei Tian       KMP_ATOMIC_INC(&__kmp_unexecuted_hidden_helper_tasks);
14019d64275aSShilei Tian     }
1402*db635a28SHansang Bae   }
14039d64275aSShilei Tian 
14047cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_task_alloc(exit): T#%d created task %p parent=%p\n",
14057cc577a4SJonathan Peyton                 gtid, taskdata, taskdata->td_parent));
14067cc577a4SJonathan Peyton 
14077cc577a4SJonathan Peyton   return task;
14087cc577a4SJonathan Peyton }
14097cc577a4SJonathan Peyton 
14103041982dSJonathan Peyton kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
14113041982dSJonathan Peyton                                   kmp_int32 flags, size_t sizeof_kmp_task_t,
14123041982dSJonathan Peyton                                   size_t sizeof_shareds,
14133041982dSJonathan Peyton                                   kmp_routine_entry_t task_entry) {
14147cc577a4SJonathan Peyton   kmp_task_t *retval;
14157cc577a4SJonathan Peyton   kmp_tasking_flags_t *input_flags = (kmp_tasking_flags_t *)&flags;
1416787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
14177cc577a4SJonathan Peyton   input_flags->native = FALSE;
14187cc577a4SJonathan Peyton   // __kmp_task_alloc() sets up all other runtime flags
1419405037c4SAndrey Churbanov   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s %s %s) "
1420405037c4SAndrey Churbanov                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
1421405037c4SAndrey Churbanov                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
1422405037c4SAndrey Churbanov                 input_flags->proxy ? "proxy" : "",
1423405037c4SAndrey Churbanov                 input_flags->detachable ? "detachable" : "", sizeof_kmp_task_t,
1424405037c4SAndrey Churbanov                 sizeof_shareds, task_entry));
14257cc577a4SJonathan Peyton 
14267cc577a4SJonathan Peyton   retval = __kmp_task_alloc(loc_ref, gtid, input_flags, sizeof_kmp_task_t,
14277cc577a4SJonathan Peyton                             sizeof_shareds, task_entry);
14287cc577a4SJonathan Peyton 
14297cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmpc_omp_task_alloc(exit): T#%d retval %p\n", gtid, retval));
14307cc577a4SJonathan Peyton 
14317cc577a4SJonathan Peyton   return retval;
14327cc577a4SJonathan Peyton }
14337cc577a4SJonathan Peyton 
1434b48e44a6SGheorghe-Teodor Bercea kmp_task_t *__kmpc_omp_target_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
1435b48e44a6SGheorghe-Teodor Bercea                                          kmp_int32 flags,
1436b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_kmp_task_t,
1437b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_shareds,
1438b48e44a6SGheorghe-Teodor Bercea                                          kmp_routine_entry_t task_entry,
1439b48e44a6SGheorghe-Teodor Bercea                                          kmp_int64 device_id) {
14409d64275aSShilei Tian   if (__kmp_enable_hidden_helper) {
14419d64275aSShilei Tian     auto &input_flags = reinterpret_cast<kmp_tasking_flags_t &>(flags);
14429d64275aSShilei Tian     input_flags.hidden_helper = TRUE;
14439d64275aSShilei Tian   }
14449d64275aSShilei Tian 
1445b48e44a6SGheorghe-Teodor Bercea   return __kmpc_omp_task_alloc(loc_ref, gtid, flags, sizeof_kmp_task_t,
1446b48e44a6SGheorghe-Teodor Bercea                                sizeof_shareds, task_entry);
1447b48e44a6SGheorghe-Teodor Bercea }
1448b48e44a6SGheorghe-Teodor Bercea 
1449b04f7d68SJonathan Peyton /*!
1450b04f7d68SJonathan Peyton @ingroup TASKING
1451b04f7d68SJonathan Peyton @param loc_ref location of the original task directive
1452b04f7d68SJonathan Peyton @param gtid Global Thread ID of encountering thread
1453b04f7d68SJonathan Peyton @param new_task task thunk allocated by __kmpc_omp_task_alloc() for the ''new
1454b04f7d68SJonathan Peyton task''
1455b04f7d68SJonathan Peyton @param naffins Number of affinity items
1456b04f7d68SJonathan Peyton @param affin_list List of affinity items
1457b04f7d68SJonathan Peyton @return Returns non-zero if registering affinity information was not successful.
1458b04f7d68SJonathan Peyton  Returns 0 if registration was successful
1459b04f7d68SJonathan Peyton This entry registers the affinity information attached to a task with the task
1460b04f7d68SJonathan Peyton thunk structure kmp_taskdata_t.
1461b04f7d68SJonathan Peyton */
1462b04f7d68SJonathan Peyton kmp_int32
1463b04f7d68SJonathan Peyton __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref, kmp_int32 gtid,
1464b04f7d68SJonathan Peyton                                   kmp_task_t *new_task, kmp_int32 naffins,
1465b04f7d68SJonathan Peyton                                   kmp_task_affinity_info_t *affin_list) {
1466b04f7d68SJonathan Peyton   return 0;
1467b04f7d68SJonathan Peyton }
1468b04f7d68SJonathan Peyton 
14697cc577a4SJonathan Peyton //  __kmp_invoke_task: invoke the specified task
14707cc577a4SJonathan Peyton //
14717cc577a4SJonathan Peyton // gtid: global thread ID of caller
14727cc577a4SJonathan Peyton // task: the task to invoke
147342016791SKazuaki Ishizaki // current_task: the task to resume after task invocation
14743041982dSJonathan Peyton static void __kmp_invoke_task(kmp_int32 gtid, kmp_task_t *task,
14753041982dSJonathan Peyton                               kmp_taskdata_t *current_task) {
14767cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
1477b1b221c8SJonathan Peyton   kmp_info_t *thread;
14787cc577a4SJonathan Peyton   int discard = 0 /* false */;
14793041982dSJonathan Peyton   KA_TRACE(
14803041982dSJonathan Peyton       30, ("__kmp_invoke_task(enter): T#%d invoking task %p, current_task=%p\n",
14817cc577a4SJonathan Peyton            gtid, taskdata, current_task));
14827cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task);
14836bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.proxy == TASK_PROXY &&
14846bf84871SAndreyChurbanov                taskdata->td_flags.complete == 1)) {
14857cc577a4SJonathan Peyton     // This is a proxy task that was already completed but it needs to run
14867cc577a4SJonathan Peyton     // its bottom-half finish
14873041982dSJonathan Peyton     KA_TRACE(
14883041982dSJonathan Peyton         30,
14893041982dSJonathan Peyton         ("__kmp_invoke_task: T#%d running bottom finish for proxy task %p\n",
14907cc577a4SJonathan Peyton          gtid, taskdata));
14917cc577a4SJonathan Peyton 
14927cc577a4SJonathan Peyton     __kmp_bottom_half_finish_proxy(gtid, task);
14937cc577a4SJonathan Peyton 
14943041982dSJonathan Peyton     KA_TRACE(30, ("__kmp_invoke_task(exit): T#%d completed bottom finish for "
14953041982dSJonathan Peyton                   "proxy task %p, resuming task %p\n",
14963041982dSJonathan Peyton                   gtid, taskdata, current_task));
14977cc577a4SJonathan Peyton 
14987cc577a4SJonathan Peyton     return;
14997cc577a4SJonathan Peyton   }
15007cc577a4SJonathan Peyton 
15017cc577a4SJonathan Peyton #if OMPT_SUPPORT
150286ed6aa6SJoachim Protze   // For untied tasks, the first task executed only calls __kmpc_omp_task and
150386ed6aa6SJoachim Protze   // does not execute code.
15047cc577a4SJonathan Peyton   ompt_thread_info_t oldInfo;
1505f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
15067cc577a4SJonathan Peyton     // Store the threads states and restore them after the task
15077cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
15087cc577a4SJonathan Peyton     oldInfo = thread->th.ompt_thread_info;
15097cc577a4SJonathan Peyton     thread->th.ompt_thread_info.wait_id = 0;
151082e94a59SJoachim Protze     thread->th.ompt_thread_info.state = (thread->th.th_team_serialized)
15110e0d6cddSJoachim Protze                                             ? ompt_state_work_serial
15120e0d6cddSJoachim Protze                                             : ompt_state_work_parallel;
15130e0d6cddSJoachim Protze     taskdata->ompt_task_info.frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
15147cc577a4SJonathan Peyton   }
15157cc577a4SJonathan Peyton #endif
15167cc577a4SJonathan Peyton 
15179d64275aSShilei Tian   // Decreament the counter of hidden helper tasks to be executed
15189d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
15199d64275aSShilei Tian     // Hidden helper tasks can only be executed by hidden helper threads
15209d64275aSShilei Tian     KMP_ASSERT(KMP_HIDDEN_HELPER_THREAD(gtid));
15219d64275aSShilei Tian     KMP_ATOMIC_DEC(&__kmp_unexecuted_hidden_helper_tasks);
15229d64275aSShilei Tian   }
15239d64275aSShilei Tian 
152486ed6aa6SJoachim Protze   // Proxy tasks are not handled by the runtime
152586ed6aa6SJoachim Protze   if (taskdata->td_flags.proxy != TASK_PROXY) {
152686ed6aa6SJoachim Protze     __kmp_task_start(gtid, task, current_task); // OMPT only if not discarded
152786ed6aa6SJoachim Protze   }
152886ed6aa6SJoachim Protze 
15297cc577a4SJonathan Peyton   // TODO: cancel tasks if the parallel region has also been cancelled
15307cc577a4SJonathan Peyton   // TODO: check if this sequence can be hoisted above __kmp_task_start
15317cc577a4SJonathan Peyton   // if cancellation has been enabled for this run ...
15326bf84871SAndreyChurbanov   if (UNLIKELY(__kmp_omp_cancellation)) {
1533b1b221c8SJonathan Peyton     thread = __kmp_threads[gtid];
1534b1b221c8SJonathan Peyton     kmp_team_t *this_team = thread->th.th_team;
15357cc577a4SJonathan Peyton     kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
15363041982dSJonathan Peyton     if ((taskgroup && taskgroup->cancel_request) ||
15373041982dSJonathan Peyton         (this_team->t.t_cancel_request == cancel_parallel)) {
153882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
153982e94a59SJoachim Protze       ompt_data_t *task_data;
1540f0a1c65fSJonas Hahnfeld       if (UNLIKELY(ompt_enabled.ompt_callback_cancel)) {
154182e94a59SJoachim Protze         __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
154282e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_cancel)(
154382e94a59SJoachim Protze             task_data,
154482e94a59SJoachim Protze             ((taskgroup && taskgroup->cancel_request) ? ompt_cancel_taskgroup
154582e94a59SJoachim Protze                                                       : ompt_cancel_parallel) |
154682e94a59SJoachim Protze                 ompt_cancel_discarded_task,
154782e94a59SJoachim Protze             NULL);
154882e94a59SJoachim Protze       }
154982e94a59SJoachim Protze #endif
15507cc577a4SJonathan Peyton       KMP_COUNT_BLOCK(TASK_cancelled);
15517cc577a4SJonathan Peyton       // this task belongs to a task group and we need to cancel it
15527cc577a4SJonathan Peyton       discard = 1 /* true */;
15537cc577a4SJonathan Peyton     }
15547cc577a4SJonathan Peyton   }
15557cc577a4SJonathan Peyton 
15567cc577a4SJonathan Peyton   // Invoke the task routine and pass in relevant data.
15577cc577a4SJonathan Peyton   // Thunks generated by gcc take a different argument list.
15587cc577a4SJonathan Peyton   if (!discard) {
1559a756cb24SAndrey Churbanov     if (taskdata->td_flags.tiedness == TASK_UNTIED) {
1560a756cb24SAndrey Churbanov       taskdata->td_last_tied = current_task->td_last_tied;
1561a756cb24SAndrey Churbanov       KMP_DEBUG_ASSERT(taskdata->td_last_tied);
1562a756cb24SAndrey Churbanov     }
15637cc577a4SJonathan Peyton #if KMP_STATS_ENABLED
15647cc577a4SJonathan Peyton     KMP_COUNT_BLOCK(TASK_executed);
15657cc577a4SJonathan Peyton     switch (KMP_GET_THREAD_STATE()) {
15663041982dSJonathan Peyton     case FORK_JOIN_BARRIER:
15673041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_join_bar);
15683041982dSJonathan Peyton       break;
15693041982dSJonathan Peyton     case PLAIN_BARRIER:
15703041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_plain_bar);
15713041982dSJonathan Peyton       break;
15723041982dSJonathan Peyton     case TASKYIELD:
15733041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskyield);
15743041982dSJonathan Peyton       break;
15753041982dSJonathan Peyton     case TASKWAIT:
15763041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskwait);
15773041982dSJonathan Peyton       break;
15783041982dSJonathan Peyton     case TASKGROUP:
15793041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskgroup);
15803041982dSJonathan Peyton       break;
15813041982dSJonathan Peyton     default:
15823041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_immediate);
15833041982dSJonathan Peyton       break;
15847cc577a4SJonathan Peyton     }
15857cc577a4SJonathan Peyton #endif // KMP_STATS_ENABLED
15867cc577a4SJonathan Peyton 
158782e94a59SJoachim Protze // OMPT task begin
158882e94a59SJoachim Protze #if OMPT_SUPPORT
1589f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.enabled))
159082e94a59SJoachim Protze       __ompt_task_start(task, current_task, gtid);
15917cc577a4SJonathan Peyton #endif
15927cc577a4SJonathan Peyton 
1593f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1594f61602b0SVignesh Balasubramanian     if (ompd_state & OMPD_ENABLE_BP)
1595f61602b0SVignesh Balasubramanian       ompd_bp_task_begin();
1596f61602b0SVignesh Balasubramanian #endif
1597f61602b0SVignesh Balasubramanian 
1598b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1599b1b221c8SJonathan Peyton     kmp_uint64 cur_time;
1600b1b221c8SJonathan Peyton     kmp_int32 kmp_itt_count_task =
1601b1b221c8SJonathan Peyton         __kmp_forkjoin_frames_mode == 3 && !taskdata->td_flags.task_serial &&
1602b1b221c8SJonathan Peyton         current_task->td_flags.tasktype == TASK_IMPLICIT;
1603b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1604b1b221c8SJonathan Peyton       thread = __kmp_threads[gtid];
1605b1b221c8SJonathan Peyton       // Time outer level explicit task on barrier for adjusting imbalance time
1606b1b221c8SJonathan Peyton       if (thread->th.th_bar_arrive_time)
1607b1b221c8SJonathan Peyton         cur_time = __itt_get_timestamp();
1608b1b221c8SJonathan Peyton       else
1609b1b221c8SJonathan Peyton         kmp_itt_count_task = 0; // thread is not on a barrier - skip timing
1610b1b221c8SJonathan Peyton     }
1611ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquired self (new task)
1612b1b221c8SJonathan Peyton #endif
1613b1b221c8SJonathan Peyton 
16147cc577a4SJonathan Peyton #ifdef KMP_GOMP_COMPAT
16157cc577a4SJonathan Peyton     if (taskdata->td_flags.native) {
16167cc577a4SJonathan Peyton       ((void (*)(void *))(*(task->routine)))(task->shareds);
16173041982dSJonathan Peyton     } else
16187cc577a4SJonathan Peyton #endif /* KMP_GOMP_COMPAT */
16197cc577a4SJonathan Peyton     {
16207cc577a4SJonathan Peyton       (*(task->routine))(gtid, task);
16217cc577a4SJonathan Peyton     }
16227cc577a4SJonathan Peyton     KMP_POP_PARTITIONED_TIMER();
16237cc577a4SJonathan Peyton 
1624b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1625b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1626b1b221c8SJonathan Peyton       // Barrier imbalance - adjust arrive time with the task duration
1627b1b221c8SJonathan Peyton       thread->th.th_bar_arrive_time += (__itt_get_timestamp() - cur_time);
1628b1b221c8SJonathan Peyton     }
1629ffd8f009SAndreyChurbanov     KMP_FSYNC_CANCEL(taskdata); // destroy self (just executed)
1630ffd8f009SAndreyChurbanov     KMP_FSYNC_RELEASING(taskdata->td_parent); // releasing parent
1631b1b221c8SJonathan Peyton #endif
16327cc577a4SJonathan Peyton   }
16337cc577a4SJonathan Peyton 
1634f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1635f61602b0SVignesh Balasubramanian   if (ompd_state & OMPD_ENABLE_BP)
1636f61602b0SVignesh Balasubramanian     ompd_bp_task_end();
1637f61602b0SVignesh Balasubramanian #endif
1638f61602b0SVignesh Balasubramanian 
16397cc577a4SJonathan Peyton   // Proxy tasks are not handled by the runtime
16407cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy != TASK_PROXY) {
164186ed6aa6SJoachim Protze #if OMPT_SUPPORT
164286ed6aa6SJoachim Protze     if (UNLIKELY(ompt_enabled.enabled)) {
164386ed6aa6SJoachim Protze       thread->th.ompt_thread_info = oldInfo;
164486ed6aa6SJoachim Protze       if (taskdata->td_flags.tiedness == TASK_TIED) {
16450e0d6cddSJoachim Protze         taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
164686ed6aa6SJoachim Protze       }
164786ed6aa6SJoachim Protze       __kmp_task_finish<true>(gtid, task, current_task);
164886ed6aa6SJoachim Protze     } else
164986ed6aa6SJoachim Protze #endif
165086ed6aa6SJoachim Protze       __kmp_task_finish<false>(gtid, task, current_task);
16517cc577a4SJonathan Peyton   }
16527cc577a4SJonathan Peyton 
16533041982dSJonathan Peyton   KA_TRACE(
16543041982dSJonathan Peyton       30,
16553041982dSJonathan Peyton       ("__kmp_invoke_task(exit): T#%d completed task %p, resuming task %p\n",
16567cc577a4SJonathan Peyton        gtid, taskdata, current_task));
16577cc577a4SJonathan Peyton   return;
16587cc577a4SJonathan Peyton }
16597cc577a4SJonathan Peyton 
16607cc577a4SJonathan Peyton // __kmpc_omp_task_parts: Schedule a thread-switchable task for execution
16617cc577a4SJonathan Peyton //
16627cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
16637cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
16647cc577a4SJonathan Peyton // new_task: task thunk allocated by __kmp_omp_task_alloc() for the ''new task''
16657cc577a4SJonathan Peyton // Returns:
16663041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
16673041982dSJonathan Peyton //    be resumed later.
16683041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
16693041982dSJonathan Peyton //    resumed later.
16703041982dSJonathan Peyton kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
16713041982dSJonathan Peyton                                 kmp_task_t *new_task) {
16727cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
16737cc577a4SJonathan Peyton 
16743041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_parts(enter): T#%d loc=%p task=%p\n", gtid,
16753041982dSJonathan Peyton                 loc_ref, new_taskdata));
16767cc577a4SJonathan Peyton 
167782e94a59SJoachim Protze #if OMPT_SUPPORT
167882e94a59SJoachim Protze   kmp_taskdata_t *parent;
1679f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
168082e94a59SJoachim Protze     parent = new_taskdata->td_parent;
168182e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
168282e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1683467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
168482e94a59SJoachim Protze           &(new_taskdata->ompt_task_info.task_data), ompt_task_explicit, 0,
168582e94a59SJoachim Protze           OMPT_GET_RETURN_ADDRESS(0));
168682e94a59SJoachim Protze     }
168782e94a59SJoachim Protze   }
168882e94a59SJoachim Protze #endif
168982e94a59SJoachim Protze 
16903041982dSJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
16913041982dSJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
16927cc577a4SJonathan Peyton 
16937cc577a4SJonathan Peyton   if (__kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
16947cc577a4SJonathan Peyton   { // Execute this task immediately
16957cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
16967cc577a4SJonathan Peyton     new_taskdata->td_flags.task_serial = 1;
16977cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
16987cc577a4SJonathan Peyton   }
16997cc577a4SJonathan Peyton 
17003041982dSJonathan Peyton   KA_TRACE(
17013041982dSJonathan Peyton       10,
17023041982dSJonathan Peyton       ("__kmpc_omp_task_parts(exit): T#%d returning TASK_CURRENT_NOT_QUEUED: "
17033041982dSJonathan Peyton        "loc=%p task=%p, return: TASK_CURRENT_NOT_QUEUED\n",
17043041982dSJonathan Peyton        gtid, loc_ref, new_taskdata));
17057cc577a4SJonathan Peyton 
170682e94a59SJoachim Protze #if OMPT_SUPPORT
1707f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
17080e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
170982e94a59SJoachim Protze   }
171082e94a59SJoachim Protze #endif
17117cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17127cc577a4SJonathan Peyton }
17137cc577a4SJonathan Peyton 
17147cc577a4SJonathan Peyton // __kmp_omp_task: Schedule a non-thread-switchable task for execution
17153041982dSJonathan Peyton //
17167cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17177cc577a4SJonathan Peyton // new_task:non-thread-switchable task thunk allocated by __kmp_omp_task_alloc()
17183041982dSJonathan Peyton // serialize_immediate: if TRUE then if the task is executed immediately its
17193041982dSJonathan Peyton // execution will be serialized
17203041982dSJonathan Peyton // Returns:
17213041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17223041982dSJonathan Peyton //    be resumed later.
17233041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17243041982dSJonathan Peyton //    resumed later.
17253041982dSJonathan Peyton kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
17263041982dSJonathan Peyton                          bool serialize_immediate) {
17277cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17287cc577a4SJonathan Peyton 
1729e4b4f994SJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
1730e4b4f994SJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
17313041982dSJonathan Peyton   if (new_taskdata->td_flags.proxy == TASK_PROXY ||
17323041982dSJonathan Peyton       __kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
17337cc577a4SJonathan Peyton   { // Execute this task immediately
17347cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
17357cc577a4SJonathan Peyton     if (serialize_immediate)
17367cc577a4SJonathan Peyton       new_taskdata->td_flags.task_serial = 1;
17377cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
17387cc577a4SJonathan Peyton   }
17397cc577a4SJonathan Peyton 
17407cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17417cc577a4SJonathan Peyton }
17427cc577a4SJonathan Peyton 
17433041982dSJonathan Peyton // __kmpc_omp_task: Wrapper around __kmp_omp_task to schedule a
17443041982dSJonathan Peyton // non-thread-switchable task from the parent thread only!
17453041982dSJonathan Peyton //
17467cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
17477cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17483041982dSJonathan Peyton // new_task: non-thread-switchable task thunk allocated by
17493041982dSJonathan Peyton // __kmp_omp_task_alloc()
17503041982dSJonathan Peyton // Returns:
17513041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17523041982dSJonathan Peyton //    be resumed later.
17533041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17543041982dSJonathan Peyton //    resumed later.
17553041982dSJonathan Peyton kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
17563041982dSJonathan Peyton                           kmp_task_t *new_task) {
17577cc577a4SJonathan Peyton   kmp_int32 res;
17587cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
17597cc577a4SJonathan Peyton 
176082e94a59SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
17617cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17627cc577a4SJonathan Peyton #endif
17633041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
17643041982dSJonathan Peyton                 new_taskdata));
1765787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
17667cc577a4SJonathan Peyton 
176782e94a59SJoachim Protze #if OMPT_SUPPORT
176882e94a59SJoachim Protze   kmp_taskdata_t *parent = NULL;
176986ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
177086ed6aa6SJoachim Protze     if (!new_taskdata->td_flags.started) {
177182e94a59SJoachim Protze       OMPT_STORE_RETURN_ADDRESS(gtid);
177282e94a59SJoachim Protze       parent = new_taskdata->td_parent;
17730e0d6cddSJoachim Protze       if (!parent->ompt_task_info.frame.enter_frame.ptr) {
1774309b00a4SShilei Tian         parent->ompt_task_info.frame.enter_frame.ptr =
1775309b00a4SShilei Tian             OMPT_GET_FRAME_ADDRESS(0);
177686ed6aa6SJoachim Protze       }
177782e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_task_create) {
177882e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1779467f3924SHansang Bae             &(parent->ompt_task_info.task_data),
1780467f3924SHansang Bae             &(parent->ompt_task_info.frame),
178182e94a59SJoachim Protze             &(new_taskdata->ompt_task_info.task_data),
178282e94a59SJoachim Protze             ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
178382e94a59SJoachim Protze             OMPT_LOAD_RETURN_ADDRESS(gtid));
178482e94a59SJoachim Protze       }
178586ed6aa6SJoachim Protze     } else {
178686ed6aa6SJoachim Protze       // We are scheduling the continuation of an UNTIED task.
178786ed6aa6SJoachim Protze       // Scheduling back to the parent task.
178886ed6aa6SJoachim Protze       __ompt_task_finish(new_task,
178986ed6aa6SJoachim Protze                          new_taskdata->ompt_task_info.scheduling_parent,
1790489cdb78SJoachim Protze                          ompt_task_switch);
17910e0d6cddSJoachim Protze       new_taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
179286ed6aa6SJoachim Protze     }
179382e94a59SJoachim Protze   }
179482e94a59SJoachim Protze #endif
179582e94a59SJoachim Protze 
17967cc577a4SJonathan Peyton   res = __kmp_omp_task(gtid, new_task, true);
17977cc577a4SJonathan Peyton 
17983041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
17993041982dSJonathan Peyton                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
18007cc577a4SJonathan Peyton                 gtid, loc_ref, new_taskdata));
180182e94a59SJoachim Protze #if OMPT_SUPPORT
1802f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18030e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
180482e94a59SJoachim Protze   }
180582e94a59SJoachim Protze #endif
18067cc577a4SJonathan Peyton   return res;
18077cc577a4SJonathan Peyton }
18087cc577a4SJonathan Peyton 
1809cdaefac5SJoachim Protze // __kmp_omp_taskloop_task: Wrapper around __kmp_omp_task to schedule
1810cdaefac5SJoachim Protze // a taskloop task with the correct OMPT return address
1811cdaefac5SJoachim Protze //
1812cdaefac5SJoachim Protze // loc_ref: location of original task pragma (ignored)
1813cdaefac5SJoachim Protze // gtid: Global Thread ID of encountering thread
1814cdaefac5SJoachim Protze // new_task: non-thread-switchable task thunk allocated by
1815cdaefac5SJoachim Protze // __kmp_omp_task_alloc()
1816cdaefac5SJoachim Protze // codeptr_ra: return address for OMPT callback
1817cdaefac5SJoachim Protze // Returns:
1818cdaefac5SJoachim Protze //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
1819cdaefac5SJoachim Protze //    be resumed later.
1820cdaefac5SJoachim Protze //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
1821cdaefac5SJoachim Protze //    resumed later.
1822cdaefac5SJoachim Protze kmp_int32 __kmp_omp_taskloop_task(ident_t *loc_ref, kmp_int32 gtid,
1823cdaefac5SJoachim Protze                                   kmp_task_t *new_task, void *codeptr_ra) {
1824cdaefac5SJoachim Protze   kmp_int32 res;
1825cdaefac5SJoachim Protze   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
1826cdaefac5SJoachim Protze 
1827cdaefac5SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
1828cdaefac5SJoachim Protze   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
1829cdaefac5SJoachim Protze #endif
1830cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
1831cdaefac5SJoachim Protze                 new_taskdata));
1832cdaefac5SJoachim Protze 
1833cdaefac5SJoachim Protze #if OMPT_SUPPORT
1834cdaefac5SJoachim Protze   kmp_taskdata_t *parent = NULL;
1835cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && !new_taskdata->td_flags.started)) {
1836cdaefac5SJoachim Protze     parent = new_taskdata->td_parent;
18370e0d6cddSJoachim Protze     if (!parent->ompt_task_info.frame.enter_frame.ptr)
18380e0d6cddSJoachim Protze       parent->ompt_task_info.frame.enter_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
1839cdaefac5SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
1840cdaefac5SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1841467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
1842cdaefac5SJoachim Protze           &(new_taskdata->ompt_task_info.task_data),
1843cdaefac5SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
1844cdaefac5SJoachim Protze           codeptr_ra);
1845cdaefac5SJoachim Protze     }
1846cdaefac5SJoachim Protze   }
1847cdaefac5SJoachim Protze #endif
1848cdaefac5SJoachim Protze 
1849cdaefac5SJoachim Protze   res = __kmp_omp_task(gtid, new_task, true);
1850cdaefac5SJoachim Protze 
1851cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
1852cdaefac5SJoachim Protze                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
1853cdaefac5SJoachim Protze                 gtid, loc_ref, new_taskdata));
1854cdaefac5SJoachim Protze #if OMPT_SUPPORT
1855cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18560e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
1857cdaefac5SJoachim Protze   }
1858cdaefac5SJoachim Protze #endif
1859cdaefac5SJoachim Protze   return res;
1860cdaefac5SJoachim Protze }
1861cdaefac5SJoachim Protze 
186282e94a59SJoachim Protze template <bool ompt>
186382e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_template(ident_t *loc_ref, kmp_int32 gtid,
186482e94a59SJoachim Protze                                               void *frame_address,
186582e94a59SJoachim Protze                                               void *return_address) {
1866467f3924SHansang Bae   kmp_taskdata_t *taskdata = nullptr;
18677cc577a4SJonathan Peyton   kmp_info_t *thread;
18687cc577a4SJonathan Peyton   int thread_finished = FALSE;
18697cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKWAIT);
18707cc577a4SJonathan Peyton 
18717cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(enter): T#%d loc=%p\n", gtid, loc_ref));
1872838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
18737cc577a4SJonathan Peyton 
18747cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
18757cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
18767cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
18777cc577a4SJonathan Peyton 
187882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
187982e94a59SJoachim Protze     ompt_data_t *my_task_data;
188082e94a59SJoachim Protze     ompt_data_t *my_parallel_data;
18817cc577a4SJonathan Peyton 
188282e94a59SJoachim Protze     if (ompt) {
188382e94a59SJoachim Protze       my_task_data = &(taskdata->ompt_task_info.task_data);
188482e94a59SJoachim Protze       my_parallel_data = OMPT_CUR_TEAM_DATA(thread);
188582e94a59SJoachim Protze 
18860e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame.ptr = frame_address;
188782e94a59SJoachim Protze 
188882e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
188982e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
189082e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
189182e94a59SJoachim Protze             my_task_data, return_address);
189282e94a59SJoachim Protze       }
189382e94a59SJoachim Protze 
189482e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
189582e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
189682e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
189782e94a59SJoachim Protze             my_task_data, return_address);
18987cc577a4SJonathan Peyton       }
18997cc577a4SJonathan Peyton     }
190082e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
19017cc577a4SJonathan Peyton 
19023041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
19033041982dSJonathan Peyton // taskwait.
19047cc577a4SJonathan Peyton #if USE_ITT_BUILD
19057cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
19067cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19077cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
19087cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
19097cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
19107cc577a4SJonathan Peyton 
19117cc577a4SJonathan Peyton #if USE_ITT_BUILD
1912838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
1913838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
1914838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
1915838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
19167cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19177cc577a4SJonathan Peyton 
19183041982dSJonathan Peyton     bool must_wait =
19193041982dSJonathan Peyton         !taskdata->td_flags.team_serial && !taskdata->td_flags.final;
19207cc577a4SJonathan Peyton 
19213041982dSJonathan Peyton     must_wait = must_wait || (thread->th.th_task_team != NULL &&
19223041982dSJonathan Peyton                               thread->th.th_task_team->tt.tt_found_proxy_tasks);
19239d64275aSShilei Tian     // If hidden helper thread is encountered, we must enable wait here.
19249d64275aSShilei Tian     must_wait =
19259d64275aSShilei Tian         must_wait ||
19269d64275aSShilei Tian         (__kmp_enable_hidden_helper && thread->th.th_task_team != NULL &&
19279d64275aSShilei Tian          thread->th.th_task_team->tt.tt_hidden_helper_task_encountered);
19289d64275aSShilei Tian 
19293041982dSJonathan Peyton     if (must_wait) {
1930e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
1931e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
193237e2ef54SJonathan Peyton                 &(taskdata->td_incomplete_child_tasks)),
1933c47afcd9SAndrey Churbanov           0U);
193437e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) != 0) {
19353041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
19363041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
19373041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
19387cc577a4SJonathan Peyton       }
19397cc577a4SJonathan Peyton     }
19407cc577a4SJonathan Peyton #if USE_ITT_BUILD
1941838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
1942ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with children
19437cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19447cc577a4SJonathan Peyton 
19453041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
19463041982dSJonathan Peyton     // negated.
19477cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
19487cc577a4SJonathan Peyton 
194982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
195082e94a59SJoachim Protze     if (ompt) {
195182e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
195282e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
195382e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
195482e94a59SJoachim Protze             my_task_data, return_address);
195582e94a59SJoachim Protze       }
195682e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
195782e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
195882e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
195982e94a59SJoachim Protze             my_task_data, return_address);
19607cc577a4SJonathan Peyton       }
19610e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = ompt_data_none;
19627cc577a4SJonathan Peyton     }
196382e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
196482e94a59SJoachim Protze 
19657cc577a4SJonathan Peyton   }
19667cc577a4SJonathan Peyton 
19677cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(exit): T#%d task %p finished waiting, "
19683041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
19693041982dSJonathan Peyton                 gtid, taskdata));
19707cc577a4SJonathan Peyton 
19717cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
19727cc577a4SJonathan Peyton }
19737cc577a4SJonathan Peyton 
1974489cdb78SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
197582e94a59SJoachim Protze OMPT_NOINLINE
197682e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_ompt(ident_t *loc_ref, kmp_int32 gtid,
197782e94a59SJoachim Protze                                           void *frame_address,
197882e94a59SJoachim Protze                                           void *return_address) {
197982e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<true>(loc_ref, gtid, frame_address,
198082e94a59SJoachim Protze                                             return_address);
198182e94a59SJoachim Protze }
1982489cdb78SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
198382e94a59SJoachim Protze 
198482e94a59SJoachim Protze // __kmpc_omp_taskwait: Wait until all tasks generated by the current task are
198582e94a59SJoachim Protze // complete
198682e94a59SJoachim Protze kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid) {
198782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
198882e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
198982e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
19900e0d6cddSJoachim Protze     return __kmpc_omp_taskwait_ompt(loc_ref, gtid, OMPT_GET_FRAME_ADDRESS(0),
199182e94a59SJoachim Protze                                     OMPT_LOAD_RETURN_ADDRESS(gtid));
199282e94a59SJoachim Protze   }
199382e94a59SJoachim Protze #endif
199482e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<false>(loc_ref, gtid, NULL, NULL);
199582e94a59SJoachim Protze }
199682e94a59SJoachim Protze 
19977cc577a4SJonathan Peyton // __kmpc_omp_taskyield: switch to a different task
19983041982dSJonathan Peyton kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid, int end_part) {
1999467f3924SHansang Bae   kmp_taskdata_t *taskdata = NULL;
20007cc577a4SJonathan Peyton   kmp_info_t *thread;
20017cc577a4SJonathan Peyton   int thread_finished = FALSE;
20027cc577a4SJonathan Peyton 
20037cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKYIELD);
20047cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKYIELD);
20057cc577a4SJonathan Peyton 
20067cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(enter): T#%d loc=%p end_part = %d\n",
20077cc577a4SJonathan Peyton                 gtid, loc_ref, end_part));
2008787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
20097cc577a4SJonathan Peyton 
20107cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec && __kmp_init_parallel) {
20117cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
20127cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
20137cc577a4SJonathan Peyton // Should we model this as a task wait or not?
20143041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
20153041982dSJonathan Peyton // taskwait.
20167cc577a4SJonathan Peyton #if USE_ITT_BUILD
20177cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
20187cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20197cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
20207cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
20217cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
20227cc577a4SJonathan Peyton 
20237cc577a4SJonathan Peyton #if USE_ITT_BUILD
2024838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2025838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2026838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2027838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
20287cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20297cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial) {
20307cc577a4SJonathan Peyton       kmp_task_team_t *task_team = thread->th.th_task_team;
20317cc577a4SJonathan Peyton       if (task_team != NULL) {
20327cc577a4SJonathan Peyton         if (KMP_TASKING_ENABLED(task_team)) {
203382e94a59SJoachim Protze #if OMPT_SUPPORT
2034f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
203582e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 1;
203682e94a59SJoachim Protze #endif
20373041982dSJonathan Peyton           __kmp_execute_tasks_32(
2038e0665a90STerry Wilmarth               thread, gtid, (kmp_flag_32<> *)NULL, FALSE,
20393041982dSJonathan Peyton               &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
20403041982dSJonathan Peyton               __kmp_task_stealing_constraint);
204182e94a59SJoachim Protze #if OMPT_SUPPORT
2042f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
204382e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 0;
204482e94a59SJoachim Protze #endif
20457cc577a4SJonathan Peyton         }
20467cc577a4SJonathan Peyton       }
20477cc577a4SJonathan Peyton     }
20487cc577a4SJonathan Peyton #if USE_ITT_BUILD
2049838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
20507cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20517cc577a4SJonathan Peyton 
20523041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
20533041982dSJonathan Peyton     // negated.
20547cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
20557cc577a4SJonathan Peyton   }
20567cc577a4SJonathan Peyton 
20577cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(exit): T#%d task %p resuming, "
20583041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
20593041982dSJonathan Peyton                 gtid, taskdata));
20607cc577a4SJonathan Peyton 
20617cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
20627cc577a4SJonathan Peyton }
20637cc577a4SJonathan Peyton 
206472ba2109SAndrey Churbanov // Task Reduction implementation
2065a8426ac8SJonathan Peyton //
2066a8426ac8SJonathan Peyton // Note: initial implementation didn't take into account the possibility
2067a8426ac8SJonathan Peyton // to specify omp_orig for initializer of the UDR (user defined reduction).
2068a8426ac8SJonathan Peyton // Corrected implementation takes into account the omp_orig object.
2069a8426ac8SJonathan Peyton // Compiler is free to use old implementation if omp_orig is not specified.
207072ba2109SAndrey Churbanov 
2071a8426ac8SJonathan Peyton /*!
2072a8426ac8SJonathan Peyton @ingroup BASIC_TYPES
2073a8426ac8SJonathan Peyton @{
2074a8426ac8SJonathan Peyton */
2075a8426ac8SJonathan Peyton 
2076a8426ac8SJonathan Peyton /*!
2077a8426ac8SJonathan Peyton Flags for special info per task reduction item.
2078a8426ac8SJonathan Peyton */
2079a8426ac8SJonathan Peyton typedef struct kmp_taskred_flags {
2080a8426ac8SJonathan Peyton   /*! 1 - use lazy alloc/init (e.g. big objects, #tasks < #threads) */
2081a8426ac8SJonathan Peyton   unsigned lazy_priv : 1;
208272ba2109SAndrey Churbanov   unsigned reserved31 : 31;
2083a8426ac8SJonathan Peyton } kmp_taskred_flags_t;
208472ba2109SAndrey Churbanov 
2085a8426ac8SJonathan Peyton /*!
2086a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2087a8426ac8SJonathan Peyton */
208872ba2109SAndrey Churbanov typedef struct kmp_task_red_input {
2089a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2090a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item in bytes */
2091a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2092a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (single parameter) */
2093a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2094a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2095a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
209672ba2109SAndrey Churbanov } kmp_task_red_input_t;
209772ba2109SAndrey Churbanov 
209872ba2109SAndrey Churbanov /*!
2099a8426ac8SJonathan Peyton Internal struct for reduction data item related info saved by the library.
210072ba2109SAndrey Churbanov */
2101a8426ac8SJonathan Peyton typedef struct kmp_taskred_data {
2102a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2103a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2104a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2105a8426ac8SJonathan Peyton   void *reduce_priv; /**< array of thread specific items */
2106a8426ac8SJonathan Peyton   void *reduce_pend; /**< end of private data for faster comparison op */
2107a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2108a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2109a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2110a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2111a8426ac8SJonathan Peyton   void *reduce_orig; /**< original item (can be used in UDR initializer) */
2112a8426ac8SJonathan Peyton } kmp_taskred_data_t;
2113a8426ac8SJonathan Peyton 
2114a8426ac8SJonathan Peyton /*!
2115a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2116a8426ac8SJonathan Peyton 
2117a8426ac8SJonathan Peyton New interface: added reduce_orig field to provide omp_orig for UDR initializer.
2118a8426ac8SJonathan Peyton */
2119a8426ac8SJonathan Peyton typedef struct kmp_taskred_input {
2120a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2121a8426ac8SJonathan Peyton   void *reduce_orig; /**< original reduction item used for initialization */
2122a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2123a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2124a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2125a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2126a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2127a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2128a8426ac8SJonathan Peyton } kmp_taskred_input_t;
2129a8426ac8SJonathan Peyton /*!
2130a8426ac8SJonathan Peyton @}
2131a8426ac8SJonathan Peyton */
2132a8426ac8SJonathan Peyton 
2133a8426ac8SJonathan Peyton template <typename T> void __kmp_assign_orig(kmp_taskred_data_t &item, T &src);
2134a8426ac8SJonathan Peyton template <>
2135a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_task_red_input_t>(kmp_taskred_data_t &item,
2136a8426ac8SJonathan Peyton                                              kmp_task_red_input_t &src) {
2137a8426ac8SJonathan Peyton   item.reduce_orig = NULL;
2138a8426ac8SJonathan Peyton }
2139a8426ac8SJonathan Peyton template <>
2140a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_taskred_input_t>(kmp_taskred_data_t &item,
2141a8426ac8SJonathan Peyton                                             kmp_taskred_input_t &src) {
2142a8426ac8SJonathan Peyton   if (src.reduce_orig != NULL) {
2143a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_orig;
2144a8426ac8SJonathan Peyton   } else {
2145a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_shar;
2146a8426ac8SJonathan Peyton   } // non-NULL reduce_orig means new interface used
2147a8426ac8SJonathan Peyton }
2148a8426ac8SJonathan Peyton 
21496b316febSTerry Wilmarth template <typename T> void __kmp_call_init(kmp_taskred_data_t &item, size_t j);
2150a8426ac8SJonathan Peyton template <>
2151a8426ac8SJonathan Peyton void __kmp_call_init<kmp_task_red_input_t>(kmp_taskred_data_t &item,
21526b316febSTerry Wilmarth                                            size_t offset) {
2153a8426ac8SJonathan Peyton   ((void (*)(void *))item.reduce_init)((char *)(item.reduce_priv) + offset);
2154a8426ac8SJonathan Peyton }
2155a8426ac8SJonathan Peyton template <>
2156a8426ac8SJonathan Peyton void __kmp_call_init<kmp_taskred_input_t>(kmp_taskred_data_t &item,
21576b316febSTerry Wilmarth                                           size_t offset) {
2158a8426ac8SJonathan Peyton   ((void (*)(void *, void *))item.reduce_init)(
2159a8426ac8SJonathan Peyton       (char *)(item.reduce_priv) + offset, item.reduce_orig);
2160a8426ac8SJonathan Peyton }
2161a8426ac8SJonathan Peyton 
2162a8426ac8SJonathan Peyton template <typename T>
2163a8426ac8SJonathan Peyton void *__kmp_task_reduction_init(int gtid, int num, T *data) {
2164787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
216572ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
216672ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = thread->th.th_current_task->td_taskgroup;
21676b316febSTerry Wilmarth   kmp_uint32 nth = thread->th.th_team_nproc;
2168a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
216972ba2109SAndrey Churbanov 
217072ba2109SAndrey Churbanov   // check input data just in case
217172ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
217272ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
217372ba2109SAndrey Churbanov   KMP_ASSERT(num > 0);
217472ba2109SAndrey Churbanov   if (nth == 1) {
217572ba2109SAndrey Churbanov     KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, tg %p, exiting nth=1\n",
217672ba2109SAndrey Churbanov                   gtid, tg));
217772ba2109SAndrey Churbanov     return (void *)tg;
217872ba2109SAndrey Churbanov   }
217972ba2109SAndrey Churbanov   KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, taskgroup %p, #items %d\n",
218072ba2109SAndrey Churbanov                 gtid, tg, num));
2181a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2182a8426ac8SJonathan Peyton       thread, num * sizeof(kmp_taskred_data_t));
218372ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
2184a8426ac8SJonathan Peyton     size_t size = data[i].reduce_size - 1;
218572ba2109SAndrey Churbanov     // round the size up to cache line per thread-specific item
218672ba2109SAndrey Churbanov     size += CACHE_LINE - size % CACHE_LINE;
2187a8426ac8SJonathan Peyton     KMP_ASSERT(data[i].reduce_comb != NULL); // combiner is mandatory
2188a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar;
218972ba2109SAndrey Churbanov     arr[i].reduce_size = size;
2190a8426ac8SJonathan Peyton     arr[i].flags = data[i].flags;
2191a8426ac8SJonathan Peyton     arr[i].reduce_comb = data[i].reduce_comb;
2192a8426ac8SJonathan Peyton     arr[i].reduce_init = data[i].reduce_init;
2193a8426ac8SJonathan Peyton     arr[i].reduce_fini = data[i].reduce_fini;
2194a8426ac8SJonathan Peyton     __kmp_assign_orig<T>(arr[i], data[i]);
2195a8426ac8SJonathan Peyton     if (!arr[i].flags.lazy_priv) {
219672ba2109SAndrey Churbanov       // allocate cache-line aligned block and fill it with zeros
219772ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * size);
219872ba2109SAndrey Churbanov       arr[i].reduce_pend = (char *)(arr[i].reduce_priv) + nth * size;
2199a8426ac8SJonathan Peyton       if (arr[i].reduce_init != NULL) {
2200a8426ac8SJonathan Peyton         // initialize all thread-specific items
22016b316febSTerry Wilmarth         for (size_t j = 0; j < nth; ++j) {
2202a8426ac8SJonathan Peyton           __kmp_call_init<T>(arr[i], j * size);
220372ba2109SAndrey Churbanov         }
220472ba2109SAndrey Churbanov       }
220572ba2109SAndrey Churbanov     } else {
220672ba2109SAndrey Churbanov       // only allocate space for pointers now,
2207a8426ac8SJonathan Peyton       // objects will be lazily allocated/initialized if/when requested
2208a8426ac8SJonathan Peyton       // note that __kmp_allocate zeroes the allocated memory
220972ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * sizeof(void *));
221072ba2109SAndrey Churbanov     }
221172ba2109SAndrey Churbanov   }
221272ba2109SAndrey Churbanov   tg->reduce_data = (void *)arr;
221372ba2109SAndrey Churbanov   tg->reduce_num_data = num;
221472ba2109SAndrey Churbanov   return (void *)tg;
221572ba2109SAndrey Churbanov }
221672ba2109SAndrey Churbanov 
221772ba2109SAndrey Churbanov /*!
221872ba2109SAndrey Churbanov @ingroup TASKING
221972ba2109SAndrey Churbanov @param gtid      Global thread ID
2220a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2221a8426ac8SJonathan Peyton @param data      Array of data for reduction
2222a8426ac8SJonathan Peyton @return The taskgroup identifier
2223a8426ac8SJonathan Peyton 
2224a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2225a8426ac8SJonathan Peyton 
2226a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2227a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2228a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2229a8426ac8SJonathan Peyton without help of the runtime library.
2230a8426ac8SJonathan Peyton */
2231a8426ac8SJonathan Peyton void *__kmpc_task_reduction_init(int gtid, int num, void *data) {
2232a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_task_red_input_t *)data);
2233a8426ac8SJonathan Peyton }
2234a8426ac8SJonathan Peyton 
2235a8426ac8SJonathan Peyton /*!
2236a8426ac8SJonathan Peyton @ingroup TASKING
2237a8426ac8SJonathan Peyton @param gtid      Global thread ID
2238a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2239a8426ac8SJonathan Peyton @param data      Array of data for reduction
2240a8426ac8SJonathan Peyton @return The taskgroup identifier
2241a8426ac8SJonathan Peyton 
2242a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2243a8426ac8SJonathan Peyton 
2244a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2245a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2246a8426ac8SJonathan Peyton */
2247a8426ac8SJonathan Peyton void *__kmpc_taskred_init(int gtid, int num, void *data) {
2248a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_taskred_input_t *)data);
2249a8426ac8SJonathan Peyton }
2250a8426ac8SJonathan Peyton 
2251a8426ac8SJonathan Peyton // Copy task reduction data (except for shared pointers).
2252a8426ac8SJonathan Peyton template <typename T>
2253a8426ac8SJonathan Peyton void __kmp_task_reduction_init_copy(kmp_info_t *thr, int num, T *data,
2254a8426ac8SJonathan Peyton                                     kmp_taskgroup_t *tg, void *reduce_data) {
2255a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
2256a8426ac8SJonathan Peyton   KA_TRACE(20, ("__kmp_task_reduction_init_copy: Th %p, init taskgroup %p,"
2257a8426ac8SJonathan Peyton                 " from data %p\n",
2258a8426ac8SJonathan Peyton                 thr, tg, reduce_data));
2259a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2260a8426ac8SJonathan Peyton       thr, num * sizeof(kmp_taskred_data_t));
2261a8426ac8SJonathan Peyton   // threads will share private copies, thunk routines, sizes, flags, etc.:
2262a8426ac8SJonathan Peyton   KMP_MEMCPY(arr, reduce_data, num * sizeof(kmp_taskred_data_t));
2263a8426ac8SJonathan Peyton   for (int i = 0; i < num; ++i) {
2264a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar; // init unique shared pointers
2265a8426ac8SJonathan Peyton   }
2266a8426ac8SJonathan Peyton   tg->reduce_data = (void *)arr;
2267a8426ac8SJonathan Peyton   tg->reduce_num_data = num;
2268a8426ac8SJonathan Peyton }
2269a8426ac8SJonathan Peyton 
2270a8426ac8SJonathan Peyton /*!
2271a8426ac8SJonathan Peyton @ingroup TASKING
2272a8426ac8SJonathan Peyton @param gtid    Global thread ID
227372ba2109SAndrey Churbanov @param tskgrp  The taskgroup ID (optional)
227472ba2109SAndrey Churbanov @param data    Shared location of the item
227572ba2109SAndrey Churbanov @return The pointer to per-thread data
227672ba2109SAndrey Churbanov 
227772ba2109SAndrey Churbanov Get thread-specific location of data item
227872ba2109SAndrey Churbanov */
22793041982dSJonathan Peyton void *__kmpc_task_reduction_get_th_data(int gtid, void *tskgrp, void *data) {
2280787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
228172ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
228272ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
228372ba2109SAndrey Churbanov   if (nth == 1)
228472ba2109SAndrey Churbanov     return data; // nothing to do
228572ba2109SAndrey Churbanov 
228672ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = (kmp_taskgroup_t *)tskgrp;
228772ba2109SAndrey Churbanov   if (tg == NULL)
228872ba2109SAndrey Churbanov     tg = thread->th.th_current_task->td_taskgroup;
228972ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
2290a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)(tg->reduce_data);
229172ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
229272ba2109SAndrey Churbanov   kmp_int32 tid = thread->th.th_info.ds.ds_tid;
229372ba2109SAndrey Churbanov 
229472ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
229572ba2109SAndrey Churbanov   while (tg != NULL) {
229672ba2109SAndrey Churbanov     for (int i = 0; i < num; ++i) {
229772ba2109SAndrey Churbanov       if (!arr[i].flags.lazy_priv) {
229872ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar ||
229972ba2109SAndrey Churbanov             (data >= arr[i].reduce_priv && data < arr[i].reduce_pend))
230072ba2109SAndrey Churbanov           return (char *)(arr[i].reduce_priv) + tid * arr[i].reduce_size;
230172ba2109SAndrey Churbanov       } else {
230272ba2109SAndrey Churbanov         // check shared location first
230372ba2109SAndrey Churbanov         void **p_priv = (void **)(arr[i].reduce_priv);
230472ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar)
230572ba2109SAndrey Churbanov           goto found;
230672ba2109SAndrey Churbanov         // check if we get some thread specific location as parameter
230772ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j)
230872ba2109SAndrey Churbanov           if (data == p_priv[j])
230972ba2109SAndrey Churbanov             goto found;
231072ba2109SAndrey Churbanov         continue; // not found, continue search
231172ba2109SAndrey Churbanov       found:
231272ba2109SAndrey Churbanov         if (p_priv[tid] == NULL) {
231372ba2109SAndrey Churbanov           // allocate thread specific object lazily
231472ba2109SAndrey Churbanov           p_priv[tid] = __kmp_allocate(arr[i].reduce_size);
2315a8426ac8SJonathan Peyton           if (arr[i].reduce_init != NULL) {
2316a8426ac8SJonathan Peyton             if (arr[i].reduce_orig != NULL) { // new interface
2317a8426ac8SJonathan Peyton               ((void (*)(void *, void *))arr[i].reduce_init)(
2318a8426ac8SJonathan Peyton                   p_priv[tid], arr[i].reduce_orig);
2319a8426ac8SJonathan Peyton             } else { // old interface (single parameter)
2320a8426ac8SJonathan Peyton               ((void (*)(void *))arr[i].reduce_init)(p_priv[tid]);
2321a8426ac8SJonathan Peyton             }
232272ba2109SAndrey Churbanov           }
232372ba2109SAndrey Churbanov         }
232472ba2109SAndrey Churbanov         return p_priv[tid];
232572ba2109SAndrey Churbanov       }
232672ba2109SAndrey Churbanov     }
232772ba2109SAndrey Churbanov     tg = tg->parent;
2328a8426ac8SJonathan Peyton     arr = (kmp_taskred_data_t *)(tg->reduce_data);
232972ba2109SAndrey Churbanov     num = tg->reduce_num_data;
233072ba2109SAndrey Churbanov   }
233172ba2109SAndrey Churbanov   KMP_ASSERT2(0, "Unknown task reduction item");
233272ba2109SAndrey Churbanov   return NULL; // ERROR, this line never executed
233372ba2109SAndrey Churbanov }
233472ba2109SAndrey Churbanov 
233572ba2109SAndrey Churbanov // Finalize task reduction.
233672ba2109SAndrey Churbanov // Called from __kmpc_end_taskgroup()
23373041982dSJonathan Peyton static void __kmp_task_reduction_fini(kmp_info_t *th, kmp_taskgroup_t *tg) {
233872ba2109SAndrey Churbanov   kmp_int32 nth = th->th.th_team_nproc;
233972ba2109SAndrey Churbanov   KMP_DEBUG_ASSERT(nth > 1); // should not be called if nth == 1
2340a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)tg->reduce_data;
234172ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
234272ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
234372ba2109SAndrey Churbanov     void *sh_data = arr[i].reduce_shar;
234472ba2109SAndrey Churbanov     void (*f_fini)(void *) = (void (*)(void *))(arr[i].reduce_fini);
23453041982dSJonathan Peyton     void (*f_comb)(void *, void *) =
23463041982dSJonathan Peyton         (void (*)(void *, void *))(arr[i].reduce_comb);
234772ba2109SAndrey Churbanov     if (!arr[i].flags.lazy_priv) {
234872ba2109SAndrey Churbanov       void *pr_data = arr[i].reduce_priv;
234972ba2109SAndrey Churbanov       size_t size = arr[i].reduce_size;
235072ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
235172ba2109SAndrey Churbanov         void *priv_data = (char *)pr_data + j * size;
235272ba2109SAndrey Churbanov         f_comb(sh_data, priv_data); // combine results
235372ba2109SAndrey Churbanov         if (f_fini)
235472ba2109SAndrey Churbanov           f_fini(priv_data); // finalize if needed
235572ba2109SAndrey Churbanov       }
235672ba2109SAndrey Churbanov     } else {
235772ba2109SAndrey Churbanov       void **pr_data = (void **)(arr[i].reduce_priv);
235872ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
235972ba2109SAndrey Churbanov         if (pr_data[j] != NULL) {
236072ba2109SAndrey Churbanov           f_comb(sh_data, pr_data[j]); // combine results
236172ba2109SAndrey Churbanov           if (f_fini)
236272ba2109SAndrey Churbanov             f_fini(pr_data[j]); // finalize if needed
236372ba2109SAndrey Churbanov           __kmp_free(pr_data[j]);
236472ba2109SAndrey Churbanov         }
236572ba2109SAndrey Churbanov       }
236672ba2109SAndrey Churbanov     }
236772ba2109SAndrey Churbanov     __kmp_free(arr[i].reduce_priv);
236872ba2109SAndrey Churbanov   }
236972ba2109SAndrey Churbanov   __kmp_thread_free(th, arr);
237072ba2109SAndrey Churbanov   tg->reduce_data = NULL;
237172ba2109SAndrey Churbanov   tg->reduce_num_data = 0;
237272ba2109SAndrey Churbanov }
2373a8426ac8SJonathan Peyton 
2374a8426ac8SJonathan Peyton // Cleanup task reduction data for parallel or worksharing,
2375a8426ac8SJonathan Peyton // do not touch task private data other threads still working with.
2376a8426ac8SJonathan Peyton // Called from __kmpc_end_taskgroup()
2377a8426ac8SJonathan Peyton static void __kmp_task_reduction_clean(kmp_info_t *th, kmp_taskgroup_t *tg) {
2378a8426ac8SJonathan Peyton   __kmp_thread_free(th, tg->reduce_data);
2379a8426ac8SJonathan Peyton   tg->reduce_data = NULL;
2380a8426ac8SJonathan Peyton   tg->reduce_num_data = 0;
2381a8426ac8SJonathan Peyton }
2382a8426ac8SJonathan Peyton 
2383a8426ac8SJonathan Peyton template <typename T>
2384a8426ac8SJonathan Peyton void *__kmp_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2385a8426ac8SJonathan Peyton                                          int num, T *data) {
2386787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
2387a8426ac8SJonathan Peyton   kmp_info_t *thr = __kmp_threads[gtid];
2388a8426ac8SJonathan Peyton   kmp_int32 nth = thr->th.th_team_nproc;
2389a8426ac8SJonathan Peyton   __kmpc_taskgroup(loc, gtid); // form new taskgroup first
2390a8426ac8SJonathan Peyton   if (nth == 1) {
2391a8426ac8SJonathan Peyton     KA_TRACE(10,
2392a8426ac8SJonathan Peyton              ("__kmpc_reduction_modifier_init: T#%d, tg %p, exiting nth=1\n",
2393a8426ac8SJonathan Peyton               gtid, thr->th.th_current_task->td_taskgroup));
2394a8426ac8SJonathan Peyton     return (void *)thr->th.th_current_task->td_taskgroup;
2395a8426ac8SJonathan Peyton   }
2396a8426ac8SJonathan Peyton   kmp_team_t *team = thr->th.th_team;
2397a8426ac8SJonathan Peyton   void *reduce_data;
2398a8426ac8SJonathan Peyton   kmp_taskgroup_t *tg;
2399a8426ac8SJonathan Peyton   reduce_data = KMP_ATOMIC_LD_RLX(&team->t.t_tg_reduce_data[is_ws]);
2400a8426ac8SJonathan Peyton   if (reduce_data == NULL &&
2401a8426ac8SJonathan Peyton       __kmp_atomic_compare_store(&team->t.t_tg_reduce_data[is_ws], reduce_data,
2402a8426ac8SJonathan Peyton                                  (void *)1)) {
2403a8426ac8SJonathan Peyton     // single thread enters this block to initialize common reduction data
2404a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data == NULL);
2405a8426ac8SJonathan Peyton     // first initialize own data, then make a copy other threads can use
2406a8426ac8SJonathan Peyton     tg = (kmp_taskgroup_t *)__kmp_task_reduction_init<T>(gtid, num, data);
2407a8426ac8SJonathan Peyton     reduce_data = __kmp_thread_malloc(thr, num * sizeof(kmp_taskred_data_t));
2408a8426ac8SJonathan Peyton     KMP_MEMCPY(reduce_data, tg->reduce_data, num * sizeof(kmp_taskred_data_t));
2409a8426ac8SJonathan Peyton     // fini counters should be 0 at this point
2410a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[0]) == 0);
2411a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[1]) == 0);
2412a8426ac8SJonathan Peyton     KMP_ATOMIC_ST_REL(&team->t.t_tg_reduce_data[is_ws], reduce_data);
2413a8426ac8SJonathan Peyton   } else {
2414a8426ac8SJonathan Peyton     while (
2415a8426ac8SJonathan Peyton         (reduce_data = KMP_ATOMIC_LD_ACQ(&team->t.t_tg_reduce_data[is_ws])) ==
2416a8426ac8SJonathan Peyton         (void *)1) { // wait for task reduction initialization
2417a8426ac8SJonathan Peyton       KMP_CPU_PAUSE();
2418a8426ac8SJonathan Peyton     }
2419a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data > (void *)1); // should be valid pointer here
2420a8426ac8SJonathan Peyton     tg = thr->th.th_current_task->td_taskgroup;
2421a8426ac8SJonathan Peyton     __kmp_task_reduction_init_copy<T>(thr, num, data, tg, reduce_data);
2422a8426ac8SJonathan Peyton   }
2423a8426ac8SJonathan Peyton   return tg;
2424a8426ac8SJonathan Peyton }
2425a8426ac8SJonathan Peyton 
2426a8426ac8SJonathan Peyton /*!
2427a8426ac8SJonathan Peyton @ingroup TASKING
2428a8426ac8SJonathan Peyton @param loc       Source location info
2429a8426ac8SJonathan Peyton @param gtid      Global thread ID
2430a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2431a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2432a8426ac8SJonathan Peyton @param data      Array of data for reduction
2433a8426ac8SJonathan Peyton @return The taskgroup identifier
2434a8426ac8SJonathan Peyton 
2435a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2436a8426ac8SJonathan Peyton 
2437a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2438a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2439a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2440a8426ac8SJonathan Peyton without help of the runtime library.
2441a8426ac8SJonathan Peyton */
2442a8426ac8SJonathan Peyton void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2443a8426ac8SJonathan Peyton                                           int num, void *data) {
2444a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2445a8426ac8SJonathan Peyton                                             (kmp_task_red_input_t *)data);
2446a8426ac8SJonathan Peyton }
2447a8426ac8SJonathan Peyton 
2448a8426ac8SJonathan Peyton /*!
2449a8426ac8SJonathan Peyton @ingroup TASKING
2450a8426ac8SJonathan Peyton @param loc       Source location info
2451a8426ac8SJonathan Peyton @param gtid      Global thread ID
2452a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2453a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2454a8426ac8SJonathan Peyton @param data      Array of data for reduction
2455a8426ac8SJonathan Peyton @return The taskgroup identifier
2456a8426ac8SJonathan Peyton 
2457a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2458a8426ac8SJonathan Peyton 
2459a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2460a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2461a8426ac8SJonathan Peyton */
2462a8426ac8SJonathan Peyton void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num,
2463a8426ac8SJonathan Peyton                                    void *data) {
2464a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2465a8426ac8SJonathan Peyton                                             (kmp_taskred_input_t *)data);
2466a8426ac8SJonathan Peyton }
2467a8426ac8SJonathan Peyton 
2468a8426ac8SJonathan Peyton /*!
2469a8426ac8SJonathan Peyton @ingroup TASKING
2470a8426ac8SJonathan Peyton @param loc       Source location info
2471a8426ac8SJonathan Peyton @param gtid      Global thread ID
2472a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2473a8426ac8SJonathan Peyton 
2474a8426ac8SJonathan Peyton Finalize task reduction for a parallel or worksharing.
2475a8426ac8SJonathan Peyton */
2476a8426ac8SJonathan Peyton void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid, int is_ws) {
2477a8426ac8SJonathan Peyton   __kmpc_end_taskgroup(loc, gtid);
2478a8426ac8SJonathan Peyton }
24797cc577a4SJonathan Peyton 
24807cc577a4SJonathan Peyton // __kmpc_taskgroup: Start a new taskgroup
24813041982dSJonathan Peyton void __kmpc_taskgroup(ident_t *loc, int gtid) {
2482787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
24837cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
24847cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
24857cc577a4SJonathan Peyton   kmp_taskgroup_t *tg_new =
24867cc577a4SJonathan Peyton       (kmp_taskgroup_t *)__kmp_thread_malloc(thread, sizeof(kmp_taskgroup_t));
24877cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_taskgroup: T#%d loc=%p group=%p\n", gtid, loc, tg_new));
248837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->count, 0);
248937e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->cancel_request, cancel_noreq);
24907cc577a4SJonathan Peyton   tg_new->parent = taskdata->td_taskgroup;
249172ba2109SAndrey Churbanov   tg_new->reduce_data = NULL;
249272ba2109SAndrey Churbanov   tg_new->reduce_num_data = 0;
249344575657SPeyton, Jonathan L   tg_new->gomp_data = NULL;
24947cc577a4SJonathan Peyton   taskdata->td_taskgroup = tg_new;
249582e94a59SJoachim Protze 
249682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2497f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
249882e94a59SJoachim Protze     void *codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
249982e94a59SJoachim Protze     if (!codeptr)
250082e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
250182e94a59SJoachim Protze     kmp_team_t *team = thread->th.th_team;
250282e94a59SJoachim Protze     ompt_data_t my_task_data = taskdata->ompt_task_info.task_data;
250382e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
250482e94a59SJoachim Protze     ompt_data_t my_parallel_data = team->t.ompt_team_info.parallel_data;
250582e94a59SJoachim Protze 
250682e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
250782e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
250882e94a59SJoachim Protze         &(my_task_data), codeptr);
250982e94a59SJoachim Protze   }
251082e94a59SJoachim Protze #endif
25117cc577a4SJonathan Peyton }
25127cc577a4SJonathan Peyton 
25137cc577a4SJonathan Peyton // __kmpc_end_taskgroup: Wait until all tasks generated by the current task
25147cc577a4SJonathan Peyton //                       and its descendants are complete
25153041982dSJonathan Peyton void __kmpc_end_taskgroup(ident_t *loc, int gtid) {
2516787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
25177cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
25187cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
25197cc577a4SJonathan Peyton   kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
25207cc577a4SJonathan Peyton   int thread_finished = FALSE;
25217cc577a4SJonathan Peyton 
252282e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
252382e94a59SJoachim Protze   kmp_team_t *team;
252482e94a59SJoachim Protze   ompt_data_t my_task_data;
252582e94a59SJoachim Protze   ompt_data_t my_parallel_data;
2526467f3924SHansang Bae   void *codeptr = nullptr;
2527f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
252882e94a59SJoachim Protze     team = thread->th.th_team;
252982e94a59SJoachim Protze     my_task_data = taskdata->ompt_task_info.task_data;
253082e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
253182e94a59SJoachim Protze     my_parallel_data = team->t.ompt_team_info.parallel_data;
253282e94a59SJoachim Protze     codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
253382e94a59SJoachim Protze     if (!codeptr)
253482e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
253582e94a59SJoachim Protze   }
253682e94a59SJoachim Protze #endif
253782e94a59SJoachim Protze 
25387cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(enter): T#%d loc=%p\n", gtid, loc));
25397cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup != NULL);
25407cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKGROUP);
25417cc577a4SJonathan Peyton 
25427cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
2543a756cb24SAndrey Churbanov     // mark task as waiting not on a barrier
2544a756cb24SAndrey Churbanov     taskdata->td_taskwait_counter += 1;
2545a756cb24SAndrey Churbanov     taskdata->td_taskwait_ident = loc;
2546a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = gtid + 1;
25477cc577a4SJonathan Peyton #if USE_ITT_BUILD
25483041982dSJonathan Peyton     // For ITT the taskgroup wait is similar to taskwait until we need to
25493041982dSJonathan Peyton     // distinguish them
2550838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2551838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2552838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2553838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
25547cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25557cc577a4SJonathan Peyton 
255682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2557f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
255882e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
255982e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
256082e94a59SJoachim Protze           &(my_task_data), codeptr);
256182e94a59SJoachim Protze     }
256282e94a59SJoachim Protze #endif
256382e94a59SJoachim Protze 
25643041982dSJonathan Peyton     if (!taskdata->td_flags.team_serial ||
25653041982dSJonathan Peyton         (thread->th.th_task_team != NULL &&
2566e4b4f994SJonathan Peyton          thread->th.th_task_team->tt.tt_found_proxy_tasks)) {
2567e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
2568e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *, &(taskgroup->count)), 0U);
256937e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskgroup->count) != 0) {
25703041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
25713041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
25723041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
25737cc577a4SJonathan Peyton       }
25747cc577a4SJonathan Peyton     }
2575a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread; // end waiting
25767cc577a4SJonathan Peyton 
257782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2578f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
257982e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
258082e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
258182e94a59SJoachim Protze           &(my_task_data), codeptr);
258282e94a59SJoachim Protze     }
258382e94a59SJoachim Protze #endif
258482e94a59SJoachim Protze 
25857cc577a4SJonathan Peyton #if USE_ITT_BUILD
2586838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
2587ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with descendants
25887cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25897cc577a4SJonathan Peyton   }
25907cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup->count == 0);
25917cc577a4SJonathan Peyton 
259244575657SPeyton, Jonathan L   if (taskgroup->reduce_data != NULL &&
259344575657SPeyton, Jonathan L       !taskgroup->gomp_data) { // need to reduce?
2594a8426ac8SJonathan Peyton     int cnt;
2595a8426ac8SJonathan Peyton     void *reduce_data;
2596a8426ac8SJonathan Peyton     kmp_team_t *t = thread->th.th_team;
2597a8426ac8SJonathan Peyton     kmp_taskred_data_t *arr = (kmp_taskred_data_t *)taskgroup->reduce_data;
2598a8426ac8SJonathan Peyton     // check if <priv> data of the first reduction variable shared for the team
2599a8426ac8SJonathan Peyton     void *priv0 = arr[0].reduce_priv;
2600a8426ac8SJonathan Peyton     if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[0])) != NULL &&
2601a8426ac8SJonathan Peyton         ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2602a8426ac8SJonathan Peyton       // finishing task reduction on parallel
2603a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[0]);
2604a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2605a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2606a8426ac8SJonathan Peyton         // finalize task reduction:
260772ba2109SAndrey Churbanov         __kmp_task_reduction_fini(thread, taskgroup);
2608a8426ac8SJonathan Peyton         // cleanup fields in the team structure:
2609a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2610a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2611a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[0], NULL);
2612a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[0], 0);
2613a8426ac8SJonathan Peyton       } else {
2614a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2615a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2616a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2617a8426ac8SJonathan Peyton       }
2618a8426ac8SJonathan Peyton     } else if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[1])) !=
2619a8426ac8SJonathan Peyton                    NULL &&
2620a8426ac8SJonathan Peyton                ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2621a8426ac8SJonathan Peyton       // finishing task reduction on worksharing
2622a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[1]);
2623a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2624a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2625a8426ac8SJonathan Peyton         __kmp_task_reduction_fini(thread, taskgroup);
2626a8426ac8SJonathan Peyton         // cleanup fields in team structure:
2627a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2628a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2629a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[1], NULL);
2630a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[1], 0);
2631a8426ac8SJonathan Peyton       } else {
2632a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2633a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2634a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2635a8426ac8SJonathan Peyton       }
2636a8426ac8SJonathan Peyton     } else {
2637a8426ac8SJonathan Peyton       // finishing task reduction on taskgroup
2638a8426ac8SJonathan Peyton       __kmp_task_reduction_fini(thread, taskgroup);
2639a8426ac8SJonathan Peyton     }
2640a8426ac8SJonathan Peyton   }
26417cc577a4SJonathan Peyton   // Restore parent taskgroup for the current task
26427cc577a4SJonathan Peyton   taskdata->td_taskgroup = taskgroup->parent;
26437cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskgroup);
26447cc577a4SJonathan Peyton 
26453041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(exit): T#%d task %p finished waiting\n",
26463041982dSJonathan Peyton                 gtid, taskdata));
264782e94a59SJoachim Protze 
264882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2649f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
265082e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
265182e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
265282e94a59SJoachim Protze         &(my_task_data), codeptr);
265382e94a59SJoachim Protze   }
265482e94a59SJoachim Protze #endif
26557cc577a4SJonathan Peyton }
26567cc577a4SJonathan Peyton 
26577cc577a4SJonathan Peyton // __kmp_remove_my_task: remove a task from my own deque
26583041982dSJonathan Peyton static kmp_task_t *__kmp_remove_my_task(kmp_info_t *thread, kmp_int32 gtid,
26593041982dSJonathan Peyton                                         kmp_task_team_t *task_team,
26603041982dSJonathan Peyton                                         kmp_int32 is_constrained) {
26617cc577a4SJonathan Peyton   kmp_task_t *task;
26627cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
26637cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
26647cc577a4SJonathan Peyton   kmp_uint32 tail;
26657cc577a4SJonathan Peyton 
26667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
26673041982dSJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_threads_data !=
26683041982dSJonathan Peyton                    NULL); // Caller should check this condition
26697cc577a4SJonathan Peyton 
26707cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
26717cc577a4SJonathan Peyton 
26727cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(enter): T#%d ntasks=%d head=%u tail=%u\n",
26733041982dSJonathan Peyton                 gtid, thread_data->td.td_deque_ntasks,
26743041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26757cc577a4SJonathan Peyton 
26767cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26773041982dSJonathan Peyton     KA_TRACE(10,
26783041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #1): T#%d No tasks to remove: "
26793041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26803041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26813041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26827cc577a4SJonathan Peyton     return NULL;
26837cc577a4SJonathan Peyton   }
26847cc577a4SJonathan Peyton 
26857cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
26867cc577a4SJonathan Peyton 
26877cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26887cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
26893041982dSJonathan Peyton     KA_TRACE(10,
26903041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
26913041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26923041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26933041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26947cc577a4SJonathan Peyton     return NULL;
26957cc577a4SJonathan Peyton   }
26967cc577a4SJonathan Peyton 
26973041982dSJonathan Peyton   tail = (thread_data->td.td_deque_tail - 1) &
26983041982dSJonathan Peyton          TASK_DEQUE_MASK(thread_data->td); // Wrap index.
26997cc577a4SJonathan Peyton   taskdata = thread_data->td.td_deque[tail];
27007cc577a4SJonathan Peyton 
2701c3344345SAndrey Churbanov   if (!__kmp_task_is_allowed(gtid, is_constrained, taskdata,
2702c3344345SAndrey Churbanov                              thread->th.th_current_task)) {
2703a756cb24SAndrey Churbanov     // The TSC does not allow to steal victim task
27047cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
2705c3344345SAndrey Churbanov     KA_TRACE(10,
2706c3344345SAndrey Churbanov              ("__kmp_remove_my_task(exit #3): T#%d TSC blocks tail task: "
27073041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27083041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
2709c3344345SAndrey Churbanov               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27107cc577a4SJonathan Peyton     return NULL;
27117cc577a4SJonathan Peyton   }
27127cc577a4SJonathan Peyton 
27137cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = tail;
27147cc577a4SJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks, thread_data->td.td_deque_ntasks - 1);
27157cc577a4SJonathan Peyton 
27167cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
27177cc577a4SJonathan Peyton 
2718c3344345SAndrey Churbanov   KA_TRACE(10, ("__kmp_remove_my_task(exit #4): T#%d task %p removed: "
27193041982dSJonathan Peyton                 "ntasks=%d head=%u tail=%u\n",
27203041982dSJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
27213041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27227cc577a4SJonathan Peyton 
27237cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
27247cc577a4SJonathan Peyton   return task;
27257cc577a4SJonathan Peyton }
27267cc577a4SJonathan Peyton 
27277cc577a4SJonathan Peyton // __kmp_steal_task: remove a task from another thread's deque
27287cc577a4SJonathan Peyton // Assume that calling thread has already checked existence of
27297cc577a4SJonathan Peyton // task_team thread_data before calling this routine.
2730a756cb24SAndrey Churbanov static kmp_task_t *__kmp_steal_task(kmp_info_t *victim_thr, kmp_int32 gtid,
2731c47afcd9SAndrey Churbanov                                     kmp_task_team_t *task_team,
273237e2ef54SJonathan Peyton                                     std::atomic<kmp_int32> *unfinished_threads,
2733c47afcd9SAndrey Churbanov                                     int *thread_finished,
2734c47afcd9SAndrey Churbanov                                     kmp_int32 is_constrained) {
27357cc577a4SJonathan Peyton   kmp_task_t *task;
27367cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
2737a756cb24SAndrey Churbanov   kmp_taskdata_t *current;
27387cc577a4SJonathan Peyton   kmp_thread_data_t *victim_td, *threads_data;
2739c3344345SAndrey Churbanov   kmp_int32 target;
27407cc577a4SJonathan Peyton   kmp_int32 victim_tid;
27417cc577a4SJonathan Peyton 
27427cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
27437cc577a4SJonathan Peyton 
27447cc577a4SJonathan Peyton   threads_data = task_team->tt.tt_threads_data;
27457cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL); // Caller should check this condition
27467cc577a4SJonathan Peyton 
2747a756cb24SAndrey Churbanov   victim_tid = victim_thr->th.th_info.ds.ds_tid;
27487cc577a4SJonathan Peyton   victim_td = &threads_data[victim_tid];
27497cc577a4SJonathan Peyton 
27503041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_steal_task(enter): T#%d try to steal from T#%d: "
2751a756cb24SAndrey Churbanov                 "task_team=%p ntasks=%d head=%u tail=%u\n",
2752a756cb24SAndrey Churbanov                 gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27533041982dSJonathan Peyton                 victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27543041982dSJonathan Peyton                 victim_td->td.td_deque_tail));
27557cc577a4SJonathan Peyton 
2756a756cb24SAndrey Churbanov   if (TCR_4(victim_td->td.td_deque_ntasks) == 0) {
27573041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #1): T#%d could not steal from T#%d: "
2758a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2759a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27603041982dSJonathan Peyton                   victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27613041982dSJonathan Peyton                   victim_td->td.td_deque_tail));
27627cc577a4SJonathan Peyton     return NULL;
27637cc577a4SJonathan Peyton   }
27647cc577a4SJonathan Peyton 
27657cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&victim_td->td.td_deque_lock);
27667cc577a4SJonathan Peyton 
2767a756cb24SAndrey Churbanov   int ntasks = TCR_4(victim_td->td.td_deque_ntasks);
27687cc577a4SJonathan Peyton   // Check again after we acquire the lock
2769a756cb24SAndrey Churbanov   if (ntasks == 0) {
27707cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
27713041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #2): T#%d could not steal from T#%d: "
2772a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2773a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2774a756cb24SAndrey Churbanov                   victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27757cc577a4SJonathan Peyton     return NULL;
27767cc577a4SJonathan Peyton   }
27777cc577a4SJonathan Peyton 
27787cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(victim_td->td.td_deque != NULL);
2779c3344345SAndrey Churbanov   current = __kmp_threads[gtid]->th.th_current_task;
27807cc577a4SJonathan Peyton   taskdata = victim_td->td.td_deque[victim_td->td.td_deque_head];
2781c3344345SAndrey Churbanov   if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2782c3344345SAndrey Churbanov     // Bump head pointer and Wrap.
2783c3344345SAndrey Churbanov     victim_td->td.td_deque_head =
2784c3344345SAndrey Churbanov         (victim_td->td.td_deque_head + 1) & TASK_DEQUE_MASK(victim_td->td);
2785c3344345SAndrey Churbanov   } else {
2786a756cb24SAndrey Churbanov     if (!task_team->tt.tt_untied_task_encountered) {
2787a756cb24SAndrey Churbanov       // The TSC does not allow to steal victim task
27887cc577a4SJonathan Peyton       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2789c3344345SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #3): T#%d could not steal from "
2790a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2791a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
27927cc577a4SJonathan Peyton                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27937cc577a4SJonathan Peyton       return NULL;
27947cc577a4SJonathan Peyton     }
2795a756cb24SAndrey Churbanov     int i;
2796a756cb24SAndrey Churbanov     // walk through victim's deque trying to steal any task
2797a756cb24SAndrey Churbanov     target = victim_td->td.td_deque_head;
2798c3344345SAndrey Churbanov     taskdata = NULL;
2799a756cb24SAndrey Churbanov     for (i = 1; i < ntasks; ++i) {
2800a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2801a756cb24SAndrey Churbanov       taskdata = victim_td->td.td_deque[target];
2802c3344345SAndrey Churbanov       if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2803c3344345SAndrey Churbanov         break; // found victim task
2804c3344345SAndrey Churbanov       } else {
2805a756cb24SAndrey Churbanov         taskdata = NULL;
2806a756cb24SAndrey Churbanov       }
2807a756cb24SAndrey Churbanov     }
2808a756cb24SAndrey Churbanov     if (taskdata == NULL) {
2809a756cb24SAndrey Churbanov       // No appropriate candidate to steal found
2810a756cb24SAndrey Churbanov       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2811a756cb24SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #4): T#%d could not steal from "
2812a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2813a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2814a756cb24SAndrey Churbanov                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
2815a756cb24SAndrey Churbanov       return NULL;
2816a756cb24SAndrey Churbanov     }
2817a756cb24SAndrey Churbanov     int prev = target;
2818a756cb24SAndrey Churbanov     for (i = i + 1; i < ntasks; ++i) {
2819a756cb24SAndrey Churbanov       // shift remaining tasks in the deque left by 1
2820a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2821a756cb24SAndrey Churbanov       victim_td->td.td_deque[prev] = victim_td->td.td_deque[target];
2822a756cb24SAndrey Churbanov       prev = target;
2823a756cb24SAndrey Churbanov     }
2824baad3f60SJonathan Peyton     KMP_DEBUG_ASSERT(
2825baad3f60SJonathan Peyton         victim_td->td.td_deque_tail ==
2826baad3f60SJonathan Peyton         (kmp_uint32)((target + 1) & TASK_DEQUE_MASK(victim_td->td)));
2827a756cb24SAndrey Churbanov     victim_td->td.td_deque_tail = target; // tail -= 1 (wrapped))
2828a756cb24SAndrey Churbanov   }
28297cc577a4SJonathan Peyton   if (*thread_finished) {
28303041982dSJonathan Peyton     // We need to un-mark this victim as a finished victim.  This must be done
28313041982dSJonathan Peyton     // before releasing the lock, or else other threads (starting with the
283297d000cfStlwilmar     // primary thread victim) might be prematurely released from the barrier!!!
2833c47afcd9SAndrey Churbanov     kmp_int32 count;
28347cc577a4SJonathan Peyton 
283537e2ef54SJonathan Peyton     count = KMP_ATOMIC_INC(unfinished_threads);
28367cc577a4SJonathan Peyton 
28373041982dSJonathan Peyton     KA_TRACE(
28383041982dSJonathan Peyton         20,
28393041982dSJonathan Peyton         ("__kmp_steal_task: T#%d inc unfinished_threads to %d: task_team=%p\n",
28407cc577a4SJonathan Peyton          gtid, count + 1, task_team));
28417cc577a4SJonathan Peyton 
28427cc577a4SJonathan Peyton     *thread_finished = FALSE;
28437cc577a4SJonathan Peyton   }
2844a756cb24SAndrey Churbanov   TCW_4(victim_td->td.td_deque_ntasks, ntasks - 1);
28453041982dSJonathan Peyton 
28467cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
28477cc577a4SJonathan Peyton 
28487cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(TASK_stolen);
2849a756cb24SAndrey Churbanov   KA_TRACE(10,
2850a756cb24SAndrey Churbanov            ("__kmp_steal_task(exit #5): T#%d stole task %p from T#%d: "
2851a756cb24SAndrey Churbanov             "task_team=%p ntasks=%d head=%u tail=%u\n",
2852a756cb24SAndrey Churbanov             gtid, taskdata, __kmp_gtid_from_thread(victim_thr), task_team,
2853a756cb24SAndrey Churbanov             ntasks, victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28547cc577a4SJonathan Peyton 
28557cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
28567cc577a4SJonathan Peyton   return task;
28577cc577a4SJonathan Peyton }
28587cc577a4SJonathan Peyton 
28593041982dSJonathan Peyton // __kmp_execute_tasks_template: Choose and execute tasks until either the
28603041982dSJonathan Peyton // condition is statisfied (return true) or there are none left (return false).
28613041982dSJonathan Peyton //
28627cc577a4SJonathan Peyton // final_spin is TRUE if this is the spin at the release barrier.
28637cc577a4SJonathan Peyton // thread_finished indicates whether the thread is finished executing all
28647cc577a4SJonathan Peyton // the tasks it has on its deque, and is at the release barrier.
28657cc577a4SJonathan Peyton // spinner is the location on which to spin.
28667cc577a4SJonathan Peyton // spinner == NULL means only execute a single task and return.
28677cc577a4SJonathan Peyton // checker is the value to check to terminate the spin.
28687cc577a4SJonathan Peyton template <class C>
28693041982dSJonathan Peyton static inline int __kmp_execute_tasks_template(
28703041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, C *flag, int final_spin,
28713041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
28723041982dSJonathan Peyton     kmp_int32 is_constrained) {
28737cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
28747cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
28757cc577a4SJonathan Peyton   kmp_task_t *task;
28767cc577a4SJonathan Peyton   kmp_info_t *other_thread;
28777cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
287837e2ef54SJonathan Peyton   std::atomic<kmp_int32> *unfinished_threads;
2879a756cb24SAndrey Churbanov   kmp_int32 nthreads, victim_tid = -2, use_own_tasks = 1, new_victim = 0,
28803041982dSJonathan Peyton                       tid = thread->th.th_info.ds.ds_tid;
28817cc577a4SJonathan Peyton 
28827cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
28837cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread == __kmp_threads[gtid]);
28847cc577a4SJonathan Peyton 
2885a4a9c48cSJonathan Peyton   if (task_team == NULL || current_task == NULL)
28863041982dSJonathan Peyton     return FALSE;
28877cc577a4SJonathan Peyton 
28883041982dSJonathan Peyton   KA_TRACE(15, ("__kmp_execute_tasks_template(enter): T#%d final_spin=%d "
28893041982dSJonathan Peyton                 "*thread_finished=%d\n",
28907cc577a4SJonathan Peyton                 gtid, final_spin, *thread_finished));
28917cc577a4SJonathan Peyton 
2892581490e7SAndrey Churbanov   thread->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
28937cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
28949d64275aSShilei Tian 
28957cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
28967cc577a4SJonathan Peyton 
28977cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
28987cc577a4SJonathan Peyton   unfinished_threads = &(task_team->tt.tt_unfinished_threads);
28999d64275aSShilei Tian   KMP_DEBUG_ASSERT(nthreads > 1 || task_team->tt.tt_found_proxy_tasks ||
29009d64275aSShilei Tian                    task_team->tt.tt_hidden_helper_task_encountered);
290137e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(*unfinished_threads >= 0);
29027cc577a4SJonathan Peyton 
29033041982dSJonathan Peyton   while (1) { // Outer loop keeps trying to find tasks in case of single thread
29043041982dSJonathan Peyton     // getting tasks from target constructs
29057cc577a4SJonathan Peyton     while (1) { // Inner loop to find a task and execute it
29067cc577a4SJonathan Peyton       task = NULL;
29077cc577a4SJonathan Peyton       if (use_own_tasks) { // check on own queue first
29087cc577a4SJonathan Peyton         task = __kmp_remove_my_task(thread, gtid, task_team, is_constrained);
29097cc577a4SJonathan Peyton       }
29107cc577a4SJonathan Peyton       if ((task == NULL) && (nthreads > 1)) { // Steal a task
29117cc577a4SJonathan Peyton         int asleep = 1;
29127cc577a4SJonathan Peyton         use_own_tasks = 0;
29137cc577a4SJonathan Peyton         // Try to steal from the last place I stole from successfully.
2914a756cb24SAndrey Churbanov         if (victim_tid == -2) { // haven't stolen anything yet
2915a756cb24SAndrey Churbanov           victim_tid = threads_data[tid].td.td_deque_last_stolen;
2916a756cb24SAndrey Churbanov           if (victim_tid !=
29173041982dSJonathan Peyton               -1) // if we have a last stolen from victim, get the thread
2918a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29197cc577a4SJonathan Peyton         }
2920a756cb24SAndrey Churbanov         if (victim_tid != -1) { // found last victim
29217cc577a4SJonathan Peyton           asleep = 0;
29223041982dSJonathan Peyton         } else if (!new_victim) { // no recent steals and we haven't already
29233041982dSJonathan Peyton           // used a new victim; select a random thread
29247cc577a4SJonathan Peyton           do { // Find a different thread to steal work from.
29253041982dSJonathan Peyton             // Pick a random thread. Initial plan was to cycle through all the
29263041982dSJonathan Peyton             // threads, and only return if we tried to steal from every thread,
29273041982dSJonathan Peyton             // and failed.  Arch says that's not such a great idea.
2928a756cb24SAndrey Churbanov             victim_tid = __kmp_get_random(thread) % (nthreads - 1);
2929a756cb24SAndrey Churbanov             if (victim_tid >= tid) {
2930a756cb24SAndrey Churbanov               ++victim_tid; // Adjusts random distribution to exclude self
29317cc577a4SJonathan Peyton             }
29327cc577a4SJonathan Peyton             // Found a potential victim
2933a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29343041982dSJonathan Peyton             // There is a slight chance that __kmp_enable_tasking() did not wake
29353041982dSJonathan Peyton             // up all threads waiting at the barrier.  If victim is sleeping,
29363041982dSJonathan Peyton             // then wake it up. Since we were going to pay the cache miss
29373041982dSJonathan Peyton             // penalty for referencing another thread's kmp_info_t struct
29383041982dSJonathan Peyton             // anyway,
29393041982dSJonathan Peyton             // the check shouldn't cost too much performance at this point. In
29403041982dSJonathan Peyton             // extra barrier mode, tasks do not sleep at the separate tasking
29413041982dSJonathan Peyton             // barrier, so this isn't a problem.
29427cc577a4SJonathan Peyton             asleep = 0;
29437cc577a4SJonathan Peyton             if ((__kmp_tasking_mode == tskm_task_teams) &&
29447cc577a4SJonathan Peyton                 (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) &&
2945c47afcd9SAndrey Churbanov                 (TCR_PTR(CCAST(void *, other_thread->th.th_sleep_loc)) !=
2946c47afcd9SAndrey Churbanov                  NULL)) {
29477cc577a4SJonathan Peyton               asleep = 1;
29484eb90e89SJohannes Doerfert               __kmp_null_resume_wrapper(__kmp_gtid_from_thread(other_thread),
29494eb90e89SJohannes Doerfert                                         other_thread->th.th_sleep_loc);
29503041982dSJonathan Peyton               // A sleeping thread should not have any tasks on it's queue.
29513041982dSJonathan Peyton               // There is a slight possibility that it resumes, steals a task
29523041982dSJonathan Peyton               // from another thread, which spawns more tasks, all in the time
29533041982dSJonathan Peyton               // that it takes this thread to check => don't write an assertion
29543041982dSJonathan Peyton               // that the victim's queue is empty.  Try stealing from a
29553041982dSJonathan Peyton               // different thread.
29567cc577a4SJonathan Peyton             }
29577cc577a4SJonathan Peyton           } while (asleep);
29587cc577a4SJonathan Peyton         }
29597cc577a4SJonathan Peyton 
29607cc577a4SJonathan Peyton         if (!asleep) {
29617cc577a4SJonathan Peyton           // We have a victim to try to steal from
29623041982dSJonathan Peyton           task = __kmp_steal_task(other_thread, gtid, task_team,
29633041982dSJonathan Peyton                                   unfinished_threads, thread_finished,
29643041982dSJonathan Peyton                                   is_constrained);
29657cc577a4SJonathan Peyton         }
29667cc577a4SJonathan Peyton         if (task != NULL) { // set last stolen to victim
2967a756cb24SAndrey Churbanov           if (threads_data[tid].td.td_deque_last_stolen != victim_tid) {
2968a756cb24SAndrey Churbanov             threads_data[tid].td.td_deque_last_stolen = victim_tid;
29693041982dSJonathan Peyton             // The pre-refactored code did not try more than 1 successful new
29703041982dSJonathan Peyton             // vicitm, unless the last one generated more local tasks;
29713041982dSJonathan Peyton             // new_victim keeps track of this
29727cc577a4SJonathan Peyton             new_victim = 1;
29737cc577a4SJonathan Peyton           }
29743041982dSJonathan Peyton         } else { // No tasks found; unset last_stolen
29757cc577a4SJonathan Peyton           KMP_CHECK_UPDATE(threads_data[tid].td.td_deque_last_stolen, -1);
2976a756cb24SAndrey Churbanov           victim_tid = -2; // no successful victim found
29777cc577a4SJonathan Peyton         }
29787cc577a4SJonathan Peyton       }
29797cc577a4SJonathan Peyton 
29809d64275aSShilei Tian       if (task == NULL)
29819d64275aSShilei Tian         break; // break out of tasking loop
29827cc577a4SJonathan Peyton 
29837cc577a4SJonathan Peyton // Found a task; execute it
29847cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
29857cc577a4SJonathan Peyton       if (__itt_sync_create_ptr || KMP_ITT_DEBUG) {
29863041982dSJonathan Peyton         if (itt_sync_obj == NULL) { // we are at fork barrier where we could not
29873041982dSJonathan Peyton           // get the object reliably
29887cc577a4SJonathan Peyton           itt_sync_obj = __kmp_itt_barrier_object(gtid, bs_forkjoin_barrier);
29897cc577a4SJonathan Peyton         }
29907cc577a4SJonathan Peyton         __kmp_itt_task_starting(itt_sync_obj);
29917cc577a4SJonathan Peyton       }
29927cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY */
29937cc577a4SJonathan Peyton       __kmp_invoke_task(gtid, task, current_task);
29947cc577a4SJonathan Peyton #if USE_ITT_BUILD
29953041982dSJonathan Peyton       if (itt_sync_obj != NULL)
29963041982dSJonathan Peyton         __kmp_itt_task_finished(itt_sync_obj);
29977cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
29983041982dSJonathan Peyton       // If this thread is only partway through the barrier and the condition is
29993041982dSJonathan Peyton       // met, then return now, so that the barrier gather/release pattern can
30003041982dSJonathan Peyton       // proceed. If this thread is in the last spin loop in the barrier,
30013041982dSJonathan Peyton       // waiting to be released, we know that the termination condition will not
300242016791SKazuaki Ishizaki       // be satisfied, so don't waste any cycles checking it.
30037cc577a4SJonathan Peyton       if (flag == NULL || (!final_spin && flag->done_check())) {
30043041982dSJonathan Peyton         KA_TRACE(
30053041982dSJonathan Peyton             15,
30063041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30073041982dSJonathan Peyton              gtid));
30087cc577a4SJonathan Peyton         return TRUE;
30097cc577a4SJonathan Peyton       }
30107cc577a4SJonathan Peyton       if (thread->th.th_task_team == NULL) {
30117cc577a4SJonathan Peyton         break;
30127cc577a4SJonathan Peyton       }
3013e47d32f1SJonathan Peyton       KMP_YIELD(__kmp_library == library_throughput); // Yield before next task
30143041982dSJonathan Peyton       // If execution of a stolen task results in more tasks being placed on our
30153041982dSJonathan Peyton       // run queue, reset use_own_tasks
30167cc577a4SJonathan Peyton       if (!use_own_tasks && TCR_4(threads_data[tid].td.td_deque_ntasks) != 0) {
30173041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d stolen task spawned "
30183041982dSJonathan Peyton                       "other tasks, restart\n",
30193041982dSJonathan Peyton                       gtid));
30207cc577a4SJonathan Peyton         use_own_tasks = 1;
30217cc577a4SJonathan Peyton         new_victim = 0;
30227cc577a4SJonathan Peyton       }
30237cc577a4SJonathan Peyton     }
30247cc577a4SJonathan Peyton 
3025e4b4f994SJonathan Peyton     // The task source has been exhausted. If in final spin loop of barrier,
3026e4b4f994SJonathan Peyton     // check if termination condition is satisfied. The work queue may be empty
3027e4b4f994SJonathan Peyton     // but there might be proxy tasks still executing.
302837e2ef54SJonathan Peyton     if (final_spin &&
3029e4b4f994SJonathan Peyton         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks) == 0) {
30303041982dSJonathan Peyton       // First, decrement the #unfinished threads, if that has not already been
30313041982dSJonathan Peyton       // done.  This decrement might be to the spin location, and result in the
30323041982dSJonathan Peyton       // termination condition being satisfied.
30337cc577a4SJonathan Peyton       if (!*thread_finished) {
3034c47afcd9SAndrey Churbanov         kmp_int32 count;
30357cc577a4SJonathan Peyton 
303637e2ef54SJonathan Peyton         count = KMP_ATOMIC_DEC(unfinished_threads) - 1;
30373041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d dec "
30383041982dSJonathan Peyton                       "unfinished_threads to %d task_team=%p\n",
30397cc577a4SJonathan Peyton                       gtid, count, task_team));
30407cc577a4SJonathan Peyton         *thread_finished = TRUE;
30417cc577a4SJonathan Peyton       }
30427cc577a4SJonathan Peyton 
30437cc577a4SJonathan Peyton       // It is now unsafe to reference thread->th.th_team !!!
304497d000cfStlwilmar       // Decrementing task_team->tt.tt_unfinished_threads can allow the primary
30453041982dSJonathan Peyton       // thread to pass through the barrier, where it might reset each thread's
30463041982dSJonathan Peyton       // th.th_team field for the next parallel region. If we can steal more
30473041982dSJonathan Peyton       // work, we know that this has not happened yet.
30487cc577a4SJonathan Peyton       if (flag != NULL && flag->done_check()) {
30493041982dSJonathan Peyton         KA_TRACE(
30503041982dSJonathan Peyton             15,
30513041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30523041982dSJonathan Peyton              gtid));
30537cc577a4SJonathan Peyton         return TRUE;
30547cc577a4SJonathan Peyton       }
30557cc577a4SJonathan Peyton     }
30567cc577a4SJonathan Peyton 
305797d000cfStlwilmar     // If this thread's task team is NULL, primary thread has recognized that
305897d000cfStlwilmar     // there are no more tasks; bail out
30597cc577a4SJonathan Peyton     if (thread->th.th_task_team == NULL) {
30603041982dSJonathan Peyton       KA_TRACE(15,
30613041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d no more tasks\n", gtid));
30627cc577a4SJonathan Peyton       return FALSE;
30637cc577a4SJonathan Peyton     }
30647cc577a4SJonathan Peyton 
30653041982dSJonathan Peyton     // We could be getting tasks from target constructs; if this is the only
30663041982dSJonathan Peyton     // thread, keep trying to execute tasks from own queue
30679d64275aSShilei Tian     if (nthreads == 1 &&
30689d64275aSShilei Tian         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks))
30697cc577a4SJonathan Peyton       use_own_tasks = 1;
3070e4b4f994SJonathan Peyton     else {
30713041982dSJonathan Peyton       KA_TRACE(15,
30723041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d can't find work\n", gtid));
30737cc577a4SJonathan Peyton       return FALSE;
30747cc577a4SJonathan Peyton     }
30757cc577a4SJonathan Peyton   }
30767cc577a4SJonathan Peyton }
30777cc577a4SJonathan Peyton 
3078e0665a90STerry Wilmarth template <bool C, bool S>
30793041982dSJonathan Peyton int __kmp_execute_tasks_32(
3080e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32<C, S> *flag, int final_spin,
30813041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30823041982dSJonathan Peyton     kmp_int32 is_constrained) {
30833041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30843041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30853041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30867cc577a4SJonathan Peyton }
30877cc577a4SJonathan Peyton 
3088e0665a90STerry Wilmarth template <bool C, bool S>
30893041982dSJonathan Peyton int __kmp_execute_tasks_64(
3090e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64<C, S> *flag, int final_spin,
30913041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30923041982dSJonathan Peyton     kmp_int32 is_constrained) {
30933041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30943041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30953041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30967cc577a4SJonathan Peyton }
30977cc577a4SJonathan Peyton 
30983041982dSJonathan Peyton int __kmp_execute_tasks_oncore(
30993041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
31003041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31013041982dSJonathan Peyton     kmp_int32 is_constrained) {
31023041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31033041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31043041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31057cc577a4SJonathan Peyton }
31067cc577a4SJonathan Peyton 
3107e0665a90STerry Wilmarth template int
3108e0665a90STerry Wilmarth __kmp_execute_tasks_32<false, false>(kmp_info_t *, kmp_int32,
3109e0665a90STerry Wilmarth                                      kmp_flag_32<false, false> *, int,
3110e0665a90STerry Wilmarth                                      int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3111e0665a90STerry Wilmarth 
3112e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<false, true>(kmp_info_t *, kmp_int32,
3113e0665a90STerry Wilmarth                                                  kmp_flag_64<false, true> *,
3114e0665a90STerry Wilmarth                                                  int,
3115e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3116e0665a90STerry Wilmarth                                                  kmp_int32);
3117e0665a90STerry Wilmarth 
3118e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<true, false>(kmp_info_t *, kmp_int32,
3119e0665a90STerry Wilmarth                                                  kmp_flag_64<true, false> *,
3120e0665a90STerry Wilmarth                                                  int,
3121e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3122e0665a90STerry Wilmarth                                                  kmp_int32);
3123e0665a90STerry Wilmarth 
31247cc577a4SJonathan Peyton // __kmp_enable_tasking: Allocate task team and resume threads sleeping at the
31257cc577a4SJonathan Peyton // next barrier so they can assist in executing enqueued tasks.
31267cc577a4SJonathan Peyton // First thread in allocates the task team atomically.
31273041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
31283041982dSJonathan Peyton                                  kmp_info_t *this_thr) {
31297cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
31307cc577a4SJonathan Peyton   int nthreads, i, is_init_thread;
31317cc577a4SJonathan Peyton 
31327cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(enter): T#%d\n",
31337cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31347cc577a4SJonathan Peyton 
31357cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
31367cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr->th.th_team != NULL);
31377cc577a4SJonathan Peyton 
31387cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
31397cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 0);
31407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads == this_thr->th.th_team->t.t_nproc);
31417cc577a4SJonathan Peyton 
31427cc577a4SJonathan Peyton   // Allocate or increase the size of threads_data if necessary
31437cc577a4SJonathan Peyton   is_init_thread = __kmp_realloc_task_threads_data(this_thr, task_team);
31447cc577a4SJonathan Peyton 
31457cc577a4SJonathan Peyton   if (!is_init_thread) {
31467cc577a4SJonathan Peyton     // Some other thread already set up the array.
31473041982dSJonathan Peyton     KA_TRACE(
31483041982dSJonathan Peyton         20,
31493041982dSJonathan Peyton         ("__kmp_enable_tasking(exit): T#%d: threads array already set up.\n",
31507cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr)));
31517cc577a4SJonathan Peyton     return;
31527cc577a4SJonathan Peyton   }
31537cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
31547cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
31557cc577a4SJonathan Peyton 
31569b8bb323SJonathan Peyton   if (__kmp_tasking_mode == tskm_task_teams &&
31573041982dSJonathan Peyton       (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME)) {
31587cc577a4SJonathan Peyton     // Release any threads sleeping at the barrier, so that they can steal
31597cc577a4SJonathan Peyton     // tasks and execute them.  In extra barrier mode, tasks do not sleep
31607cc577a4SJonathan Peyton     // at the separate tasking barrier, so this isn't a problem.
31617cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
31624eb90e89SJohannes Doerfert       volatile void *sleep_loc;
31637cc577a4SJonathan Peyton       kmp_info_t *thread = threads_data[i].td.td_thr;
31647cc577a4SJonathan Peyton 
31657cc577a4SJonathan Peyton       if (i == this_thr->th.th_info.ds.ds_tid) {
31667cc577a4SJonathan Peyton         continue;
31677cc577a4SJonathan Peyton       }
31687cc577a4SJonathan Peyton       // Since we haven't locked the thread's suspend mutex lock at this
31697cc577a4SJonathan Peyton       // point, there is a small window where a thread might be putting
31707cc577a4SJonathan Peyton       // itself to sleep, but hasn't set the th_sleep_loc field yet.
31717cc577a4SJonathan Peyton       // To work around this, __kmp_execute_tasks_template() periodically checks
31723041982dSJonathan Peyton       // see if other threads are sleeping (using the same random mechanism that
31733041982dSJonathan Peyton       // is used for task stealing) and awakens them if they are.
3174c47afcd9SAndrey Churbanov       if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3175c47afcd9SAndrey Churbanov           NULL) {
31767cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d waking up thread T#%d\n",
31777cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31787cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31794eb90e89SJohannes Doerfert         __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
31803041982dSJonathan Peyton       } else {
31817cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d don't wake up thread T#%d\n",
31827cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31837cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31847cc577a4SJonathan Peyton       }
31857cc577a4SJonathan Peyton     }
31867cc577a4SJonathan Peyton   }
31877cc577a4SJonathan Peyton 
31887cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(exit): T#%d\n",
31897cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31907cc577a4SJonathan Peyton }
31917cc577a4SJonathan Peyton 
31927cc577a4SJonathan Peyton /* // TODO: Check the comment consistency
31937cc577a4SJonathan Peyton  * Utility routines for "task teams".  A task team (kmp_task_t) is kind of
31947cc577a4SJonathan Peyton  * like a shadow of the kmp_team_t data struct, with a different lifetime.
31957cc577a4SJonathan Peyton  * After a child * thread checks into a barrier and calls __kmp_release() from
31967cc577a4SJonathan Peyton  * the particular variant of __kmp_<barrier_kind>_barrier_gather(), it can no
31977cc577a4SJonathan Peyton  * longer assume that the kmp_team_t structure is intact (at any moment, the
319897d000cfStlwilmar  * primary thread may exit the barrier code and free the team data structure,
31997cc577a4SJonathan Peyton  * and return the threads to the thread pool).
32007cc577a4SJonathan Peyton  *
3201ed5fe645SKelvin Li  * This does not work with the tasking code, as the thread is still
32027cc577a4SJonathan Peyton  * expected to participate in the execution of any tasks that may have been
32037cc577a4SJonathan Peyton  * spawned my a member of the team, and the thread still needs access to all
32047cc577a4SJonathan Peyton  * to each thread in the team, so that it can steal work from it.
32057cc577a4SJonathan Peyton  *
32067cc577a4SJonathan Peyton  * Enter the existence of the kmp_task_team_t struct.  It employs a reference
320797d000cfStlwilmar  * counting mechanism, and is allocated by the primary thread before calling
32087cc577a4SJonathan Peyton  * __kmp_<barrier_kind>_release, and then is release by the last thread to
32097cc577a4SJonathan Peyton  * exit __kmp_<barrier_kind>_release at the next barrier.  I.e. the lifetimes
32107cc577a4SJonathan Peyton  * of the kmp_task_team_t structs for consecutive barriers can overlap
321197d000cfStlwilmar  * (and will, unless the primary thread is the last thread to exit the barrier
3212e4b4f994SJonathan Peyton  * release phase, which is not typical). The existence of such a struct is
3213e4b4f994SJonathan Peyton  * useful outside the context of tasking.
32147cc577a4SJonathan Peyton  *
32157cc577a4SJonathan Peyton  * We currently use the existence of the threads array as an indicator that
32167cc577a4SJonathan Peyton  * tasks were spawned since the last barrier.  If the structure is to be
32177cc577a4SJonathan Peyton  * useful outside the context of tasking, then this will have to change, but
321842016791SKazuaki Ishizaki  * not setting the field minimizes the performance impact of tasking on
32197cc577a4SJonathan Peyton  * barriers, when no explicit tasks were spawned (pushed, actually).
32207cc577a4SJonathan Peyton  */
32217cc577a4SJonathan Peyton 
32223041982dSJonathan Peyton static kmp_task_team_t *__kmp_free_task_teams =
32233041982dSJonathan Peyton     NULL; // Free list for task_team data structures
32247cc577a4SJonathan Peyton // Lock for task team data structures
3225eaa9e40cSJonathan Peyton kmp_bootstrap_lock_t __kmp_task_team_lock =
32263041982dSJonathan Peyton     KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_task_team_lock);
32277cc577a4SJonathan Peyton 
32287cc577a4SJonathan Peyton // __kmp_alloc_task_deque:
32297cc577a4SJonathan Peyton // Allocates a task deque for a particular thread, and initialize the necessary
32307cc577a4SJonathan Peyton // data structures relating to the deque.  This only happens once per thread
32313041982dSJonathan Peyton // per task team since task teams are recycled. No lock is needed during
32323041982dSJonathan Peyton // allocation since each thread allocates its own deque.
32333041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
32343041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data) {
32357cc577a4SJonathan Peyton   __kmp_init_bootstrap_lock(&thread_data->td.td_deque_lock);
32367cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque == NULL);
32377cc577a4SJonathan Peyton 
32387cc577a4SJonathan Peyton   // Initialize last stolen task field to "none"
32397cc577a4SJonathan Peyton   thread_data->td.td_deque_last_stolen = -1;
32407cc577a4SJonathan Peyton 
32417cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == 0);
32427cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_head == 0);
32437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_tail == 0);
32447cc577a4SJonathan Peyton 
32453041982dSJonathan Peyton   KE_TRACE(
32463041982dSJonathan Peyton       10,
32473041982dSJonathan Peyton       ("__kmp_alloc_task_deque: T#%d allocating deque[%d] for thread_data %p\n",
32487cc577a4SJonathan Peyton        __kmp_gtid_from_thread(thread), INITIAL_TASK_DEQUE_SIZE, thread_data));
32497cc577a4SJonathan Peyton   // Allocate space for task deque, and zero the deque
32507cc577a4SJonathan Peyton   // Cannot use __kmp_thread_calloc() because threads not around for
32517cc577a4SJonathan Peyton   // kmp_reap_task_team( ).
32523041982dSJonathan Peyton   thread_data->td.td_deque = (kmp_taskdata_t **)__kmp_allocate(
32533041982dSJonathan Peyton       INITIAL_TASK_DEQUE_SIZE * sizeof(kmp_taskdata_t *));
32547cc577a4SJonathan Peyton   thread_data->td.td_deque_size = INITIAL_TASK_DEQUE_SIZE;
32557cc577a4SJonathan Peyton }
32567cc577a4SJonathan Peyton 
32577cc577a4SJonathan Peyton // __kmp_free_task_deque:
32583041982dSJonathan Peyton // Deallocates a task deque for a particular thread. Happens at library
32593041982dSJonathan Peyton // deallocation so don't need to reset all thread data fields.
32603041982dSJonathan Peyton static void __kmp_free_task_deque(kmp_thread_data_t *thread_data) {
32617cc577a4SJonathan Peyton   if (thread_data->td.td_deque != NULL) {
32621b536724SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
32637cc577a4SJonathan Peyton     TCW_4(thread_data->td.td_deque_ntasks, 0);
32647cc577a4SJonathan Peyton     __kmp_free(thread_data->td.td_deque);
32657cc577a4SJonathan Peyton     thread_data->td.td_deque = NULL;
32667cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
32671b536724SJonathan Peyton   }
32687cc577a4SJonathan Peyton 
32697cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
32707cc577a4SJonathan Peyton   // GEH: Figure out what to do here for td_susp_tied_tasks
32717cc577a4SJonathan Peyton   if (thread_data->td.td_susp_tied_tasks.ts_entries != TASK_STACK_EMPTY) {
32727cc577a4SJonathan Peyton     __kmp_free_task_stack(__kmp_thread_from_gtid(gtid), thread_data);
32737cc577a4SJonathan Peyton   }
32747cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
32757cc577a4SJonathan Peyton }
32767cc577a4SJonathan Peyton 
32777cc577a4SJonathan Peyton // __kmp_realloc_task_threads_data:
32783041982dSJonathan Peyton // Allocates a threads_data array for a task team, either by allocating an
32793041982dSJonathan Peyton // initial array or enlarging an existing array.  Only the first thread to get
32804c6a098aSKazuaki Ishizaki // the lock allocs or enlarges the array and re-initializes the array elements.
32817cc577a4SJonathan Peyton // That thread returns "TRUE", the rest return "FALSE".
32827cc577a4SJonathan Peyton // Assumes that the new array size is given by task_team -> tt.tt_nproc.
32837cc577a4SJonathan Peyton // The current size is given by task_team -> tt.tt_max_threads.
32843041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
32853041982dSJonathan Peyton                                            kmp_task_team_t *task_team) {
32867cc577a4SJonathan Peyton   kmp_thread_data_t **threads_data_p;
32877cc577a4SJonathan Peyton   kmp_int32 nthreads, maxthreads;
32887cc577a4SJonathan Peyton   int is_init_thread = FALSE;
32897cc577a4SJonathan Peyton 
32907cc577a4SJonathan Peyton   if (TCR_4(task_team->tt.tt_found_tasks)) {
32917cc577a4SJonathan Peyton     // Already reallocated and initialized.
32927cc577a4SJonathan Peyton     return FALSE;
32937cc577a4SJonathan Peyton   }
32947cc577a4SJonathan Peyton 
32957cc577a4SJonathan Peyton   threads_data_p = &task_team->tt.tt_threads_data;
32967cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
32977cc577a4SJonathan Peyton   maxthreads = task_team->tt.tt_max_threads;
32987cc577a4SJonathan Peyton 
32993041982dSJonathan Peyton   // All threads must lock when they encounter the first task of the implicit
33003041982dSJonathan Peyton   // task region to make sure threads_data fields are (re)initialized before
33013041982dSJonathan Peyton   // used.
33027cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
33037cc577a4SJonathan Peyton 
33047cc577a4SJonathan Peyton   if (!TCR_4(task_team->tt.tt_found_tasks)) {
33057cc577a4SJonathan Peyton     // first thread to enable tasking
33067cc577a4SJonathan Peyton     kmp_team_t *team = thread->th.th_team;
33077cc577a4SJonathan Peyton     int i;
33087cc577a4SJonathan Peyton 
33097cc577a4SJonathan Peyton     is_init_thread = TRUE;
33107cc577a4SJonathan Peyton     if (maxthreads < nthreads) {
33117cc577a4SJonathan Peyton 
33127cc577a4SJonathan Peyton       if (*threads_data_p != NULL) {
33137cc577a4SJonathan Peyton         kmp_thread_data_t *old_data = *threads_data_p;
33147cc577a4SJonathan Peyton         kmp_thread_data_t *new_data = NULL;
33157cc577a4SJonathan Peyton 
33163041982dSJonathan Peyton         KE_TRACE(
33173041982dSJonathan Peyton             10,
33183041982dSJonathan Peyton             ("__kmp_realloc_task_threads_data: T#%d reallocating "
33197cc577a4SJonathan Peyton              "threads data for task_team %p, new_size = %d, old_size = %d\n",
33203041982dSJonathan Peyton              __kmp_gtid_from_thread(thread), task_team, nthreads, maxthreads));
33217cc577a4SJonathan Peyton         // Reallocate threads_data to have more elements than current array
33227cc577a4SJonathan Peyton         // Cannot use __kmp_thread_realloc() because threads not around for
33237cc577a4SJonathan Peyton         // kmp_reap_task_team( ).  Note all new array entries are initialized
33247cc577a4SJonathan Peyton         // to zero by __kmp_allocate().
33253041982dSJonathan Peyton         new_data = (kmp_thread_data_t *)__kmp_allocate(
33263041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33277cc577a4SJonathan Peyton         // copy old data to new data
33287cc577a4SJonathan Peyton         KMP_MEMCPY_S((void *)new_data, nthreads * sizeof(kmp_thread_data_t),
332971483f2dSAndrey Churbanov                      (void *)old_data, maxthreads * sizeof(kmp_thread_data_t));
33307cc577a4SJonathan Peyton 
33317cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33327cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33337cc577a4SJonathan Peyton         for (i = maxthreads; i < nthreads; i++) {
33347cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33357cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33367cc577a4SJonathan Peyton         }
33377cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33387cc577a4SJonathan Peyton        // Install the new data and free the old data
33397cc577a4SJonathan Peyton         (*threads_data_p) = new_data;
33407cc577a4SJonathan Peyton         __kmp_free(old_data);
33413041982dSJonathan Peyton       } else {
33427cc577a4SJonathan Peyton         KE_TRACE(10, ("__kmp_realloc_task_threads_data: T#%d allocating "
33437cc577a4SJonathan Peyton                       "threads data for task_team %p, size = %d\n",
33447cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread), task_team, nthreads));
33457cc577a4SJonathan Peyton         // Make the initial allocate for threads_data array, and zero entries
33467cc577a4SJonathan Peyton         // Cannot use __kmp_thread_calloc() because threads not around for
33477cc577a4SJonathan Peyton         // kmp_reap_task_team( ).
33483041982dSJonathan Peyton         *threads_data_p = (kmp_thread_data_t *)__kmp_allocate(
33493041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33507cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33517cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33527cc577a4SJonathan Peyton         for (i = 0; i < nthreads; i++) {
33537cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33547cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33557cc577a4SJonathan Peyton         }
33567cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33577cc577a4SJonathan Peyton       }
33587cc577a4SJonathan Peyton       task_team->tt.tt_max_threads = nthreads;
33593041982dSJonathan Peyton     } else {
33607cc577a4SJonathan Peyton       // If array has (more than) enough elements, go ahead and use it
33617cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(*threads_data_p != NULL);
33627cc577a4SJonathan Peyton     }
33637cc577a4SJonathan Peyton 
33647cc577a4SJonathan Peyton     // initialize threads_data pointers back to thread_info structures
33657cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
33667cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33677cc577a4SJonathan Peyton       thread_data->td.td_thr = team->t.t_threads[i];
33687cc577a4SJonathan Peyton 
33697cc577a4SJonathan Peyton       if (thread_data->td.td_deque_last_stolen >= nthreads) {
33707cc577a4SJonathan Peyton         // The last stolen field survives across teams / barrier, and the number
33717cc577a4SJonathan Peyton         // of threads may have changed.  It's possible (likely?) that a new
33723041982dSJonathan Peyton         // parallel region will exhibit the same behavior as previous region.
33737cc577a4SJonathan Peyton         thread_data->td.td_deque_last_stolen = -1;
33747cc577a4SJonathan Peyton       }
33757cc577a4SJonathan Peyton     }
33767cc577a4SJonathan Peyton 
33777cc577a4SJonathan Peyton     KMP_MB();
33787cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_tasks, TRUE);
33797cc577a4SJonathan Peyton   }
33807cc577a4SJonathan Peyton 
33817cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
33827cc577a4SJonathan Peyton   return is_init_thread;
33837cc577a4SJonathan Peyton }
33847cc577a4SJonathan Peyton 
33857cc577a4SJonathan Peyton // __kmp_free_task_threads_data:
33867cc577a4SJonathan Peyton // Deallocates a threads_data array for a task team, including any attached
33877cc577a4SJonathan Peyton // tasking deques.  Only occurs at library shutdown.
33883041982dSJonathan Peyton static void __kmp_free_task_threads_data(kmp_task_team_t *task_team) {
33897cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
33907cc577a4SJonathan Peyton   if (task_team->tt.tt_threads_data != NULL) {
33917cc577a4SJonathan Peyton     int i;
33927cc577a4SJonathan Peyton     for (i = 0; i < task_team->tt.tt_max_threads; i++) {
33937cc577a4SJonathan Peyton       __kmp_free_task_deque(&task_team->tt.tt_threads_data[i]);
33947cc577a4SJonathan Peyton     }
33957cc577a4SJonathan Peyton     __kmp_free(task_team->tt.tt_threads_data);
33967cc577a4SJonathan Peyton     task_team->tt.tt_threads_data = NULL;
33977cc577a4SJonathan Peyton   }
33987cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
33997cc577a4SJonathan Peyton }
34007cc577a4SJonathan Peyton 
34017cc577a4SJonathan Peyton // __kmp_allocate_task_team:
34027cc577a4SJonathan Peyton // Allocates a task team associated with a specific team, taking it from
34033041982dSJonathan Peyton // the global task team free list if possible.  Also initializes data
34043041982dSJonathan Peyton // structures.
34053041982dSJonathan Peyton static kmp_task_team_t *__kmp_allocate_task_team(kmp_info_t *thread,
34063041982dSJonathan Peyton                                                  kmp_team_t *team) {
34077cc577a4SJonathan Peyton   kmp_task_team_t *task_team = NULL;
34087cc577a4SJonathan Peyton   int nthreads;
34097cc577a4SJonathan Peyton 
34107cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d entering; team = %p\n",
34117cc577a4SJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), team));
34127cc577a4SJonathan Peyton 
34137cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
34147cc577a4SJonathan Peyton     // Take a task team from the task team pool
34157cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34167cc577a4SJonathan Peyton     if (__kmp_free_task_teams != NULL) {
34177cc577a4SJonathan Peyton       task_team = __kmp_free_task_teams;
34187cc577a4SJonathan Peyton       TCW_PTR(__kmp_free_task_teams, task_team->tt.tt_next);
34197cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
34207cc577a4SJonathan Peyton     }
34217cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34227cc577a4SJonathan Peyton   }
34237cc577a4SJonathan Peyton 
34247cc577a4SJonathan Peyton   if (task_team == NULL) {
34257cc577a4SJonathan Peyton     KE_TRACE(10, ("__kmp_allocate_task_team: T#%d allocating "
34267cc577a4SJonathan Peyton                   "task team for team %p\n",
34277cc577a4SJonathan Peyton                   __kmp_gtid_from_thread(thread), team));
3428ffd8f009SAndreyChurbanov     // Allocate a new task team if one is not available. Cannot use
3429ffd8f009SAndreyChurbanov     // __kmp_thread_malloc because threads not around for kmp_reap_task_team.
34307cc577a4SJonathan Peyton     task_team = (kmp_task_team_t *)__kmp_allocate(sizeof(kmp_task_team_t));
34317cc577a4SJonathan Peyton     __kmp_init_bootstrap_lock(&task_team->tt.tt_threads_lock);
3432ffd8f009SAndreyChurbanov #if USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG
3433ffd8f009SAndreyChurbanov     // suppress race conditions detection on synchronization flags in debug mode
3434ffd8f009SAndreyChurbanov     // this helps to analyze library internals eliminating false positives
3435ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(
3436ffd8f009SAndreyChurbanov         __itt_suppress_range, __itt_suppress_threading_errors,
3437ffd8f009SAndreyChurbanov         &task_team->tt.tt_found_tasks, sizeof(task_team->tt.tt_found_tasks));
3438ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(__itt_suppress_range,
3439ffd8f009SAndreyChurbanov                               __itt_suppress_threading_errors,
3440ffd8f009SAndreyChurbanov                               CCAST(kmp_uint32 *, &task_team->tt.tt_active),
3441ffd8f009SAndreyChurbanov                               sizeof(task_team->tt.tt_active));
3442ffd8f009SAndreyChurbanov #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG */
3443ffd8f009SAndreyChurbanov     // Note: __kmp_allocate zeroes returned memory, othewise we would need:
34443041982dSJonathan Peyton     // task_team->tt.tt_threads_data = NULL;
34457cc577a4SJonathan Peyton     // task_team->tt.tt_max_threads = 0;
34467cc577a4SJonathan Peyton     // task_team->tt.tt_next = NULL;
34477cc577a4SJonathan Peyton   }
34487cc577a4SJonathan Peyton 
34497cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_tasks, FALSE);
34507cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
34517cc577a4SJonathan Peyton   task_team->tt.tt_nproc = nthreads = team->t.t_nproc;
34527cc577a4SJonathan Peyton 
345337e2ef54SJonathan Peyton   KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads, nthreads);
34549d64275aSShilei Tian   TCW_4(task_team->tt.tt_hidden_helper_task_encountered, FALSE);
34557cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_active, TRUE);
34567cc577a4SJonathan Peyton 
34573041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d exiting; task_team = %p "
34583041982dSJonathan Peyton                 "unfinished_threads init'd to %d\n",
34593041982dSJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), task_team,
346037e2ef54SJonathan Peyton                 KMP_ATOMIC_LD_RLX(&task_team->tt.tt_unfinished_threads)));
34617cc577a4SJonathan Peyton   return task_team;
34627cc577a4SJonathan Peyton }
34637cc577a4SJonathan Peyton 
34647cc577a4SJonathan Peyton // __kmp_free_task_team:
34657cc577a4SJonathan Peyton // Frees the task team associated with a specific thread, and adds it
34667cc577a4SJonathan Peyton // to the global task team free list.
34673041982dSJonathan Peyton void __kmp_free_task_team(kmp_info_t *thread, kmp_task_team_t *task_team) {
34687cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_free_task_team: T#%d task_team = %p\n",
34697cc577a4SJonathan Peyton                 thread ? __kmp_gtid_from_thread(thread) : -1, task_team));
34707cc577a4SJonathan Peyton 
34717cc577a4SJonathan Peyton   // Put task team back on free list
34727cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34737cc577a4SJonathan Peyton 
34747cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_next == NULL);
34757cc577a4SJonathan Peyton   task_team->tt.tt_next = __kmp_free_task_teams;
34767cc577a4SJonathan Peyton   TCW_PTR(__kmp_free_task_teams, task_team);
34777cc577a4SJonathan Peyton 
34787cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34797cc577a4SJonathan Peyton }
34807cc577a4SJonathan Peyton 
34817cc577a4SJonathan Peyton // __kmp_reap_task_teams:
34827cc577a4SJonathan Peyton // Free all the task teams on the task team free list.
34837cc577a4SJonathan Peyton // Should only be done during library shutdown.
34843041982dSJonathan Peyton // Cannot do anything that needs a thread structure or gtid since they are
34853041982dSJonathan Peyton // already gone.
34863041982dSJonathan Peyton void __kmp_reap_task_teams(void) {
34877cc577a4SJonathan Peyton   kmp_task_team_t *task_team;
34887cc577a4SJonathan Peyton 
34897cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
34907cc577a4SJonathan Peyton     // Free all task_teams on the free list
34917cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34927cc577a4SJonathan Peyton     while ((task_team = __kmp_free_task_teams) != NULL) {
34937cc577a4SJonathan Peyton       __kmp_free_task_teams = task_team->tt.tt_next;
34947cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
34957cc577a4SJonathan Peyton 
34967cc577a4SJonathan Peyton       // Free threads_data if necessary
34977cc577a4SJonathan Peyton       if (task_team->tt.tt_threads_data != NULL) {
34987cc577a4SJonathan Peyton         __kmp_free_task_threads_data(task_team);
34997cc577a4SJonathan Peyton       }
35007cc577a4SJonathan Peyton       __kmp_free(task_team);
35017cc577a4SJonathan Peyton     }
35027cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
35037cc577a4SJonathan Peyton   }
35047cc577a4SJonathan Peyton }
35057cc577a4SJonathan Peyton 
35067cc577a4SJonathan Peyton // __kmp_wait_to_unref_task_teams:
35077cc577a4SJonathan Peyton // Some threads could still be in the fork barrier release code, possibly
35087cc577a4SJonathan Peyton // trying to steal tasks.  Wait for each thread to unreference its task team.
35093041982dSJonathan Peyton void __kmp_wait_to_unref_task_teams(void) {
35107cc577a4SJonathan Peyton   kmp_info_t *thread;
35117cc577a4SJonathan Peyton   kmp_uint32 spins;
35127cc577a4SJonathan Peyton   int done;
35137cc577a4SJonathan Peyton 
35147cc577a4SJonathan Peyton   KMP_INIT_YIELD(spins);
35157cc577a4SJonathan Peyton 
35167cc577a4SJonathan Peyton   for (;;) {
35177cc577a4SJonathan Peyton     done = TRUE;
35187cc577a4SJonathan Peyton 
35197cc577a4SJonathan Peyton     // TODO: GEH - this may be is wrong because some sync would be necessary
35203041982dSJonathan Peyton     // in case threads are added to the pool during the traversal. Need to
35213041982dSJonathan Peyton     // verify that lock for thread pool is held when calling this routine.
3522c47afcd9SAndrey Churbanov     for (thread = CCAST(kmp_info_t *, __kmp_thread_pool); thread != NULL;
35233041982dSJonathan Peyton          thread = thread->th.th_next_pool) {
35247cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35257cc577a4SJonathan Peyton       DWORD exit_val;
35267cc577a4SJonathan Peyton #endif
35277cc577a4SJonathan Peyton       if (TCR_PTR(thread->th.th_task_team) == NULL) {
35287cc577a4SJonathan Peyton         KA_TRACE(10, ("__kmp_wait_to_unref_task_team: T#%d task_team == NULL\n",
35297cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
35307cc577a4SJonathan Peyton         continue;
35317cc577a4SJonathan Peyton       }
35327cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35337cc577a4SJonathan Peyton       // TODO: GEH - add this check for Linux* OS / OS X* as well?
35347cc577a4SJonathan Peyton       if (!__kmp_is_thread_alive(thread, &exit_val)) {
35357cc577a4SJonathan Peyton         thread->th.th_task_team = NULL;
35367cc577a4SJonathan Peyton         continue;
35377cc577a4SJonathan Peyton       }
35387cc577a4SJonathan Peyton #endif
35397cc577a4SJonathan Peyton 
35407cc577a4SJonathan Peyton       done = FALSE; // Because th_task_team pointer is not NULL for this thread
35417cc577a4SJonathan Peyton 
35423041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_wait_to_unref_task_team: Waiting for T#%d to "
35433041982dSJonathan Peyton                     "unreference task_team\n",
35447cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(thread)));
35457cc577a4SJonathan Peyton 
35467cc577a4SJonathan Peyton       if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
35474eb90e89SJohannes Doerfert         volatile void *sleep_loc;
35487cc577a4SJonathan Peyton         // If the thread is sleeping, awaken it.
3549c47afcd9SAndrey Churbanov         if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3550c47afcd9SAndrey Churbanov             NULL) {
35513041982dSJonathan Peyton           KA_TRACE(
35523041982dSJonathan Peyton               10,
35533041982dSJonathan Peyton               ("__kmp_wait_to_unref_task_team: T#%d waking up thread T#%d\n",
35547cc577a4SJonathan Peyton                __kmp_gtid_from_thread(thread), __kmp_gtid_from_thread(thread)));
35554eb90e89SJohannes Doerfert           __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
35567cc577a4SJonathan Peyton         }
35577cc577a4SJonathan Peyton       }
35587cc577a4SJonathan Peyton     }
35597cc577a4SJonathan Peyton     if (done) {
35607cc577a4SJonathan Peyton       break;
35617cc577a4SJonathan Peyton     }
35627cc577a4SJonathan Peyton 
3563e47d32f1SJonathan Peyton     // If oversubscribed or have waited a bit, yield.
3564e47d32f1SJonathan Peyton     KMP_YIELD_OVERSUB_ELSE_SPIN(spins);
35657cc577a4SJonathan Peyton   }
35667cc577a4SJonathan Peyton }
35677cc577a4SJonathan Peyton 
35687cc577a4SJonathan Peyton // __kmp_task_team_setup:  Create a task_team for the current team, but use
35697cc577a4SJonathan Peyton // an already created, unused one if it already exists.
35703041982dSJonathan Peyton void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team, int always) {
35717cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
35727cc577a4SJonathan Peyton 
35733041982dSJonathan Peyton   // If this task_team hasn't been created yet, allocate it. It will be used in
35743041982dSJonathan Peyton   // the region after the next.
35753041982dSJonathan Peyton   // If it exists, it is the current task team and shouldn't be touched yet as
35763041982dSJonathan Peyton   // it may still be in use.
35773041982dSJonathan Peyton   if (team->t.t_task_team[this_thr->th.th_task_state] == NULL &&
35783041982dSJonathan Peyton       (always || team->t.t_nproc > 1)) {
35793041982dSJonathan Peyton     team->t.t_task_team[this_thr->th.th_task_state] =
35803041982dSJonathan Peyton         __kmp_allocate_task_team(this_thr, team);
358197d000cfStlwilmar     KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created new task_team %p"
35823041982dSJonathan Peyton                   " for team %d at parity=%d\n",
35833041982dSJonathan Peyton                   __kmp_gtid_from_thread(this_thr),
3584467f3924SHansang Bae                   team->t.t_task_team[this_thr->th.th_task_state], team->t.t_id,
35853041982dSJonathan Peyton                   this_thr->th.th_task_state));
35867cc577a4SJonathan Peyton   }
35877cc577a4SJonathan Peyton 
35883041982dSJonathan Peyton   // After threads exit the release, they will call sync, and then point to this
35893041982dSJonathan Peyton   // other task_team; make sure it is allocated and properly initialized. As
35903041982dSJonathan Peyton   // threads spin in the barrier release phase, they will continue to use the
35913041982dSJonathan Peyton   // previous task_team struct(above), until they receive the signal to stop
35923041982dSJonathan Peyton   // checking for tasks (they can't safely reference the kmp_team_t struct,
359397d000cfStlwilmar   // which could be reallocated by the primary thread). No task teams are formed
35943041982dSJonathan Peyton   // for serialized teams.
35957cc577a4SJonathan Peyton   if (team->t.t_nproc > 1) {
35967cc577a4SJonathan Peyton     int other_team = 1 - this_thr->th.th_task_state;
3597467f3924SHansang Bae     KMP_DEBUG_ASSERT(other_team >= 0 && other_team < 2);
35987cc577a4SJonathan Peyton     if (team->t.t_task_team[other_team] == NULL) { // setup other team as well
35993041982dSJonathan Peyton       team->t.t_task_team[other_team] =
36003041982dSJonathan Peyton           __kmp_allocate_task_team(this_thr, team);
360197d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created second new "
36023041982dSJonathan Peyton                     "task_team %p for team %d at parity=%d\n",
36033041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3604467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36053041982dSJonathan Peyton     } else { // Leave the old task team struct in place for the upcoming region;
36063041982dSJonathan Peyton       // adjust as needed
36077cc577a4SJonathan Peyton       kmp_task_team_t *task_team = team->t.t_task_team[other_team];
36083041982dSJonathan Peyton       if (!task_team->tt.tt_active ||
36093041982dSJonathan Peyton           team->t.t_nproc != task_team->tt.tt_nproc) {
36107cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_nproc, team->t.t_nproc);
36117cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_tasks, FALSE);
36127cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
361337e2ef54SJonathan Peyton         KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads,
361437e2ef54SJonathan Peyton                           team->t.t_nproc);
36157cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_active, TRUE);
36167cc577a4SJonathan Peyton       }
36173041982dSJonathan Peyton       // if team size has changed, the first thread to enable tasking will
36183041982dSJonathan Peyton       // realloc threads_data if necessary
361997d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d reset next task_team "
36203041982dSJonathan Peyton                     "%p for team %d at parity=%d\n",
36213041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3622467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36237cc577a4SJonathan Peyton     }
36247cc577a4SJonathan Peyton   }
36259d64275aSShilei Tian 
36269d64275aSShilei Tian   // For regular thread, task enabling should be called when the task is going
36279d64275aSShilei Tian   // to be pushed to a dequeue. However, for the hidden helper thread, we need
36289d64275aSShilei Tian   // it ahead of time so that some operations can be performed without race
36299d64275aSShilei Tian   // condition.
36309d64275aSShilei Tian   if (this_thr == __kmp_hidden_helper_main_thread) {
36319d64275aSShilei Tian     for (int i = 0; i < 2; ++i) {
36329d64275aSShilei Tian       kmp_task_team_t *task_team = team->t.t_task_team[i];
36339d64275aSShilei Tian       if (KMP_TASKING_ENABLED(task_team)) {
36349d64275aSShilei Tian         continue;
36359d64275aSShilei Tian       }
36369d64275aSShilei Tian       __kmp_enable_tasking(task_team, this_thr);
36379d64275aSShilei Tian       for (int j = 0; j < task_team->tt.tt_nproc; ++j) {
36389d64275aSShilei Tian         kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[j];
36399d64275aSShilei Tian         if (thread_data->td.td_deque == NULL) {
36409d64275aSShilei Tian           __kmp_alloc_task_deque(__kmp_hidden_helper_threads[j], thread_data);
36419d64275aSShilei Tian         }
36429d64275aSShilei Tian       }
36439d64275aSShilei Tian     }
36449d64275aSShilei Tian   }
36457cc577a4SJonathan Peyton }
36467cc577a4SJonathan Peyton 
36477cc577a4SJonathan Peyton // __kmp_task_team_sync: Propagation of task team data from team to threads
36487cc577a4SJonathan Peyton // which happens just after the release phase of a team barrier.  This may be
36497cc577a4SJonathan Peyton // called by any thread, but only for teams with # threads > 1.
36503041982dSJonathan Peyton void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team) {
36517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36527cc577a4SJonathan Peyton 
36533041982dSJonathan Peyton   // Toggle the th_task_state field, to switch which task_team this thread
36543041982dSJonathan Peyton   // refers to
36556b316febSTerry Wilmarth   this_thr->th.th_task_state = (kmp_uint8)(1 - this_thr->th.th_task_state);
36566b316febSTerry Wilmarth 
36573041982dSJonathan Peyton   // It is now safe to propagate the task team pointer from the team struct to
36583041982dSJonathan Peyton   // the current thread.
36593041982dSJonathan Peyton   TCW_PTR(this_thr->th.th_task_team,
36603041982dSJonathan Peyton           team->t.t_task_team[this_thr->th.th_task_state]);
36613041982dSJonathan Peyton   KA_TRACE(20,
36623041982dSJonathan Peyton            ("__kmp_task_team_sync: Thread T#%d task team switched to task_team "
36633041982dSJonathan Peyton             "%p from Team #%d (parity=%d)\n",
36647cc577a4SJonathan Peyton             __kmp_gtid_from_thread(this_thr), this_thr->th.th_task_team,
3665467f3924SHansang Bae             team->t.t_id, this_thr->th.th_task_state));
36667cc577a4SJonathan Peyton }
36677cc577a4SJonathan Peyton 
366897d000cfStlwilmar // __kmp_task_team_wait: Primary thread waits for outstanding tasks after the
366997d000cfStlwilmar // barrier gather phase. Only called by primary thread if #threads in team > 1
367097d000cfStlwilmar // or if proxy tasks were created.
36713041982dSJonathan Peyton //
36723041982dSJonathan Peyton // wait is a flag that defaults to 1 (see kmp.h), but waiting can be turned off
367397d000cfStlwilmar // by passing in 0 optionally as the last argument. When wait is zero, primary
36743041982dSJonathan Peyton // thread does not wait for unfinished_threads to reach 0.
36753041982dSJonathan Peyton void __kmp_task_team_wait(
36763041982dSJonathan Peyton     kmp_info_t *this_thr,
36773041982dSJonathan Peyton     kmp_team_t *team USE_ITT_BUILD_ARG(void *itt_sync_obj), int wait) {
36787cc577a4SJonathan Peyton   kmp_task_team_t *task_team = team->t.t_task_team[this_thr->th.th_task_state];
36797cc577a4SJonathan Peyton 
36807cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36817cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team == this_thr->th.th_task_team);
36827cc577a4SJonathan Peyton 
36837cc577a4SJonathan Peyton   if ((task_team != NULL) && KMP_TASKING_ENABLED(task_team)) {
36847cc577a4SJonathan Peyton     if (wait) {
368597d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_wait: Primary T#%d waiting for all tasks "
36863041982dSJonathan Peyton                     "(for unfinished_threads to reach 0) on task_team = %p\n",
36877cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(this_thr), task_team));
36883041982dSJonathan Peyton       // Worker threads may have dropped through to release phase, but could
36893041982dSJonathan Peyton       // still be executing tasks. Wait here for tasks to complete. To avoid
369097d000cfStlwilmar       // memory contention, only primary thread checks termination condition.
3691e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
3692e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
369337e2ef54SJonathan Peyton                 &task_team->tt.tt_unfinished_threads),
3694c47afcd9SAndrey Churbanov           0U);
36953041982dSJonathan Peyton       flag.wait(this_thr, TRUE USE_ITT_BUILD_ARG(itt_sync_obj));
36967cc577a4SJonathan Peyton     }
36973041982dSJonathan Peyton     // Deactivate the old task team, so that the worker threads will stop
36983041982dSJonathan Peyton     // referencing it while spinning.
36993041982dSJonathan Peyton     KA_TRACE(
37003041982dSJonathan Peyton         20,
370197d000cfStlwilmar         ("__kmp_task_team_wait: Primary T#%d deactivating task_team %p: "
37027cc577a4SJonathan Peyton          "setting active to false, setting local and team's pointer to NULL\n",
37037cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr), task_team));
37043041982dSJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1 ||
37053041982dSJonathan Peyton                      task_team->tt.tt_found_proxy_tasks == TRUE);
37067cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_proxy_tasks, FALSE);
3707a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(task_team->tt.tt_untied_task_encountered, 0);
37087cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_active, FALSE);
37097cc577a4SJonathan Peyton     KMP_MB();
37107cc577a4SJonathan Peyton 
37117cc577a4SJonathan Peyton     TCW_PTR(this_thr->th.th_task_team, NULL);
37127cc577a4SJonathan Peyton   }
37137cc577a4SJonathan Peyton }
37147cc577a4SJonathan Peyton 
37157cc577a4SJonathan Peyton // __kmp_tasking_barrier:
3716e0665a90STerry Wilmarth // This routine is called only when __kmp_tasking_mode == tskm_extra_barrier.
37173041982dSJonathan Peyton // Internal function to execute all tasks prior to a regular barrier or a join
37183041982dSJonathan Peyton // barrier. It is a full barrier itself, which unfortunately turns regular
37193041982dSJonathan Peyton // barriers into double barriers and join barriers into 1 1/2 barriers.
37203041982dSJonathan Peyton void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread, int gtid) {
372137e2ef54SJonathan Peyton   std::atomic<kmp_uint32> *spin = RCAST(
372237e2ef54SJonathan Peyton       std::atomic<kmp_uint32> *,
3723c47afcd9SAndrey Churbanov       &team->t.t_task_team[thread->th.th_task_state]->tt.tt_unfinished_threads);
37247cc577a4SJonathan Peyton   int flag = FALSE;
37257cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode == tskm_extra_barrier);
37267cc577a4SJonathan Peyton 
37277cc577a4SJonathan Peyton #if USE_ITT_BUILD
372837e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_INIT(spin, NULL);
37297cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
3730e0665a90STerry Wilmarth   kmp_flag_32<false, false> spin_flag(spin, 0U);
37313041982dSJonathan Peyton   while (!spin_flag.execute_tasks(thread, gtid, TRUE,
37323041982dSJonathan Peyton                                   &flag USE_ITT_BUILD_ARG(NULL), 0)) {
37337cc577a4SJonathan Peyton #if USE_ITT_BUILD
37347cc577a4SJonathan Peyton     // TODO: What about itt_sync_obj??
373537e2ef54SJonathan Peyton     KMP_FSYNC_SPIN_PREPARE(RCAST(void *, spin));
37367cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37377cc577a4SJonathan Peyton 
37387cc577a4SJonathan Peyton     if (TCR_4(__kmp_global.g.g_done)) {
37397cc577a4SJonathan Peyton       if (__kmp_global.g.g_abort)
37407cc577a4SJonathan Peyton         __kmp_abort_thread();
37417cc577a4SJonathan Peyton       break;
37427cc577a4SJonathan Peyton     }
3743e47d32f1SJonathan Peyton     KMP_YIELD(TRUE);
37447cc577a4SJonathan Peyton   }
37457cc577a4SJonathan Peyton #if USE_ITT_BUILD
374637e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_ACQUIRED(RCAST(void *, spin));
37477cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37487cc577a4SJonathan Peyton }
37497cc577a4SJonathan Peyton 
37503041982dSJonathan Peyton // __kmp_give_task puts a task into a given thread queue if:
37513041982dSJonathan Peyton //  - the queue for that thread was created
37523041982dSJonathan Peyton //  - there's space in that queue
37533041982dSJonathan Peyton // Because of this, __kmp_push_task needs to check if there's space after
37543041982dSJonathan Peyton // getting the lock
37553041982dSJonathan Peyton static bool __kmp_give_task(kmp_info_t *thread, kmp_int32 tid, kmp_task_t *task,
37563041982dSJonathan Peyton                             kmp_int32 pass) {
37577cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
37587cc577a4SJonathan Peyton   kmp_task_team_t *task_team = taskdata->td_task_team;
37597cc577a4SJonathan Peyton 
37603041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_give_task: trying to give task %p to thread %d.\n",
37613041982dSJonathan Peyton                 taskdata, tid));
37627cc577a4SJonathan Peyton 
37637cc577a4SJonathan Peyton   // If task_team is NULL something went really bad...
37647cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
37657cc577a4SJonathan Peyton 
37667cc577a4SJonathan Peyton   bool result = false;
37677cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
37687cc577a4SJonathan Peyton 
37697cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
37707cc577a4SJonathan Peyton     // There's no queue in this thread, go find another one
37717cc577a4SJonathan Peyton     // We're guaranteed that at least one thread has a queue
37723041982dSJonathan Peyton     KA_TRACE(30,
37733041982dSJonathan Peyton              ("__kmp_give_task: thread %d has no queue while giving task %p.\n",
37743041982dSJonathan Peyton               tid, taskdata));
37757cc577a4SJonathan Peyton     return result;
37767cc577a4SJonathan Peyton   }
37777cc577a4SJonathan Peyton 
37783041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
37793041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
37803041982dSJonathan Peyton     KA_TRACE(
37813041982dSJonathan Peyton         30,
37823041982dSJonathan Peyton         ("__kmp_give_task: queue is full while giving task %p to thread %d.\n",
37833041982dSJonathan Peyton          taskdata, tid));
37847cc577a4SJonathan Peyton 
37853041982dSJonathan Peyton     // if this deque is bigger than the pass ratio give a chance to another
37863041982dSJonathan Peyton     // thread
37873041982dSJonathan Peyton     if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
37883041982dSJonathan Peyton       return result;
37897cc577a4SJonathan Peyton 
37907cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
37913895148dSJoachim Protze     if (TCR_4(thread_data->td.td_deque_ntasks) >=
37923895148dSJoachim Protze         TASK_DEQUE_SIZE(thread_data->td)) {
37933895148dSJoachim Protze       // expand deque to push the task which is not allowed to execute
37947cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
37953895148dSJoachim Protze     }
37967cc577a4SJonathan Peyton 
37977cc577a4SJonathan Peyton   } else {
37987cc577a4SJonathan Peyton 
37997cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38007cc577a4SJonathan Peyton 
38013041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38023041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
38033041982dSJonathan Peyton       KA_TRACE(30, ("__kmp_give_task: queue is full while giving task %p to "
38043041982dSJonathan Peyton                     "thread %d.\n",
38053041982dSJonathan Peyton                     taskdata, tid));
38067cc577a4SJonathan Peyton 
38073041982dSJonathan Peyton       // if this deque is bigger than the pass ratio give a chance to another
38083041982dSJonathan Peyton       // thread
38097cc577a4SJonathan Peyton       if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38107cc577a4SJonathan Peyton         goto release_and_exit;
38117cc577a4SJonathan Peyton 
38127cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38137cc577a4SJonathan Peyton     }
38147cc577a4SJonathan Peyton   }
38157cc577a4SJonathan Peyton 
38167cc577a4SJonathan Peyton   // lock is held here, and there is space in the deque
38177cc577a4SJonathan Peyton 
38187cc577a4SJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] = taskdata;
38197cc577a4SJonathan Peyton   // Wrap index.
38203041982dSJonathan Peyton   thread_data->td.td_deque_tail =
38213041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
38223041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
38233041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1);
38247cc577a4SJonathan Peyton 
38257cc577a4SJonathan Peyton   result = true;
38263041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_give_task: successfully gave task %p to thread %d.\n",
38273041982dSJonathan Peyton                 taskdata, tid));
38287cc577a4SJonathan Peyton 
38297cc577a4SJonathan Peyton release_and_exit:
38307cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
38317cc577a4SJonathan Peyton 
38327cc577a4SJonathan Peyton   return result;
38337cc577a4SJonathan Peyton }
38347cc577a4SJonathan Peyton 
38353041982dSJonathan Peyton /* The finish of the proxy tasks is divided in two pieces:
38367cc577a4SJonathan Peyton     - the top half is the one that can be done from a thread outside the team
3837c3344345SAndrey Churbanov     - the bottom half must be run from a thread within the team
38387cc577a4SJonathan Peyton 
38393041982dSJonathan Peyton    In order to run the bottom half the task gets queued back into one of the
38403041982dSJonathan Peyton    threads of the team. Once the td_incomplete_child_task counter of the parent
38413041982dSJonathan Peyton    is decremented the threads can leave the barriers. So, the bottom half needs
38423041982dSJonathan Peyton    to be queued before the counter is decremented. The top half is therefore
38433041982dSJonathan Peyton    divided in two parts:
38447cc577a4SJonathan Peyton     - things that can be run before queuing the bottom half
38457cc577a4SJonathan Peyton     - things that must be run after queuing the bottom half
38467cc577a4SJonathan Peyton 
38473041982dSJonathan Peyton    This creates a second race as the bottom half can free the task before the
38483041982dSJonathan Peyton    second top half is executed. To avoid this we use the
38493041982dSJonathan Peyton    td_incomplete_child_task of the proxy task to synchronize the top and bottom
38503041982dSJonathan Peyton    half. */
38513041982dSJonathan Peyton static void __kmp_first_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38527cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
38537cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38547cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
38557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
38567cc577a4SJonathan Peyton 
38577cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
38587cc577a4SJonathan Peyton 
38597cc577a4SJonathan Peyton   if (taskdata->td_taskgroup)
386037e2ef54SJonathan Peyton     KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
38617cc577a4SJonathan Peyton 
38623041982dSJonathan Peyton   // Create an imaginary children for this task so the bottom half cannot
38633041982dSJonathan Peyton   // release the task before we have completed the second top half
386437e2ef54SJonathan Peyton   KMP_ATOMIC_INC(&taskdata->td_incomplete_child_tasks);
38657cc577a4SJonathan Peyton }
38667cc577a4SJonathan Peyton 
38673041982dSJonathan Peyton static void __kmp_second_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38687cc577a4SJonathan Peyton   kmp_int32 children = 0;
38697cc577a4SJonathan Peyton 
38707cc577a4SJonathan Peyton   // Predecrement simulated by "- 1" calculation
38713041982dSJonathan Peyton   children =
387237e2ef54SJonathan Peyton       KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
38737cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
38747cc577a4SJonathan Peyton 
38757cc577a4SJonathan Peyton   // Remove the imaginary children
387637e2ef54SJonathan Peyton   KMP_ATOMIC_DEC(&taskdata->td_incomplete_child_tasks);
38777cc577a4SJonathan Peyton }
38787cc577a4SJonathan Peyton 
38793041982dSJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask) {
38807cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
38817cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
38827cc577a4SJonathan Peyton 
38837cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38843041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete ==
38853041982dSJonathan Peyton                    1); // top half must run before bottom half
38867cc577a4SJonathan Peyton 
38877cc577a4SJonathan Peyton   // We need to wait to make sure the top half is finished
38887cc577a4SJonathan Peyton   // Spinning here should be ok as this should happen quickly
388937e2ef54SJonathan Peyton   while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) > 0)
38903041982dSJonathan Peyton     ;
38917cc577a4SJonathan Peyton 
38927cc577a4SJonathan Peyton   __kmp_release_deps(gtid, taskdata);
38937cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
38947cc577a4SJonathan Peyton }
38957cc577a4SJonathan Peyton 
38967cc577a4SJonathan Peyton /*!
38977cc577a4SJonathan Peyton @ingroup TASKING
38987cc577a4SJonathan Peyton @param gtid Global Thread ID of encountering thread
38997cc577a4SJonathan Peyton @param ptask Task which execution is completed
39007cc577a4SJonathan Peyton 
3901ed5fe645SKelvin Li Execute the completion of a proxy task from a thread of that is part of the
39023041982dSJonathan Peyton team. Run first and bottom halves directly.
39037cc577a4SJonathan Peyton */
39043041982dSJonathan Peyton void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask) {
39057cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39067cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39073041982dSJonathan Peyton   KA_TRACE(
39083041982dSJonathan Peyton       10, ("__kmp_proxy_task_completed(enter): T#%d proxy task %p completing\n",
39093041982dSJonathan Peyton            gtid, taskdata));
3910787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
39117cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39127cc577a4SJonathan Peyton 
39137cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39147cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39157cc577a4SJonathan Peyton   __kmp_bottom_half_finish_proxy(gtid, ptask);
39167cc577a4SJonathan Peyton 
39173041982dSJonathan Peyton   KA_TRACE(10,
39183041982dSJonathan Peyton            ("__kmp_proxy_task_completed(exit): T#%d proxy task %p completing\n",
39193041982dSJonathan Peyton             gtid, taskdata));
39207cc577a4SJonathan Peyton }
39217cc577a4SJonathan Peyton 
39227cc577a4SJonathan Peyton /*!
39237cc577a4SJonathan Peyton @ingroup TASKING
39247cc577a4SJonathan Peyton @param ptask Task which execution is completed
39257cc577a4SJonathan Peyton 
3926ed5fe645SKelvin Li Execute the completion of a proxy task from a thread that could not belong to
39273041982dSJonathan Peyton the team.
39287cc577a4SJonathan Peyton */
39293041982dSJonathan Peyton void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask) {
39307cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39317cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39327cc577a4SJonathan Peyton 
39333041982dSJonathan Peyton   KA_TRACE(
39343041982dSJonathan Peyton       10,
39353041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(enter): proxy task completing ooo %p\n",
39363041982dSJonathan Peyton        taskdata));
39377cc577a4SJonathan Peyton 
39387cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39397cc577a4SJonathan Peyton 
39407cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39417cc577a4SJonathan Peyton 
39423041982dSJonathan Peyton   // Enqueue task to complete bottom half completion from a thread within the
39433041982dSJonathan Peyton   // corresponding team
39447cc577a4SJonathan Peyton   kmp_team_t *team = taskdata->td_team;
39457cc577a4SJonathan Peyton   kmp_int32 nthreads = team->t.t_nproc;
39467cc577a4SJonathan Peyton   kmp_info_t *thread;
39477cc577a4SJonathan Peyton 
39483041982dSJonathan Peyton   // This should be similar to start_k = __kmp_get_random( thread ) % nthreads
39493041982dSJonathan Peyton   // but we cannot use __kmp_get_random here
39507cc577a4SJonathan Peyton   kmp_int32 start_k = 0;
39517cc577a4SJonathan Peyton   kmp_int32 pass = 1;
39527cc577a4SJonathan Peyton   kmp_int32 k = start_k;
39537cc577a4SJonathan Peyton 
39547cc577a4SJonathan Peyton   do {
39557cc577a4SJonathan Peyton     // For now we're just linearly trying to find a thread
39567cc577a4SJonathan Peyton     thread = team->t.t_threads[k];
39577cc577a4SJonathan Peyton     k = (k + 1) % nthreads;
39587cc577a4SJonathan Peyton 
39597cc577a4SJonathan Peyton     // we did a full pass through all the threads
39603041982dSJonathan Peyton     if (k == start_k)
39613041982dSJonathan Peyton       pass = pass << 1;
39627cc577a4SJonathan Peyton 
39637cc577a4SJonathan Peyton   } while (!__kmp_give_task(thread, k, ptask, pass));
39647cc577a4SJonathan Peyton 
39657cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39667cc577a4SJonathan Peyton 
39673041982dSJonathan Peyton   KA_TRACE(
39683041982dSJonathan Peyton       10,
39693041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(exit): proxy task completing ooo %p\n",
39703041982dSJonathan Peyton        taskdata));
39717cc577a4SJonathan Peyton }
39727cc577a4SJonathan Peyton 
3973405037c4SAndrey Churbanov kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref, int gtid,
3974405037c4SAndrey Churbanov                                                 kmp_task_t *task) {
3975405037c4SAndrey Churbanov   kmp_taskdata_t *td = KMP_TASK_TO_TASKDATA(task);
3976405037c4SAndrey Churbanov   if (td->td_allow_completion_event.type == KMP_EVENT_UNINITIALIZED) {
3977405037c4SAndrey Churbanov     td->td_allow_completion_event.type = KMP_EVENT_ALLOW_COMPLETION;
3978405037c4SAndrey Churbanov     td->td_allow_completion_event.ed.task = task;
3979405037c4SAndrey Churbanov     __kmp_init_tas_lock(&td->td_allow_completion_event.lock);
3980405037c4SAndrey Churbanov   }
3981405037c4SAndrey Churbanov   return &td->td_allow_completion_event;
3982405037c4SAndrey Churbanov }
3983405037c4SAndrey Churbanov 
3984405037c4SAndrey Churbanov void __kmp_fulfill_event(kmp_event_t *event) {
3985405037c4SAndrey Churbanov   if (event->type == KMP_EVENT_ALLOW_COMPLETION) {
3986405037c4SAndrey Churbanov     kmp_task_t *ptask = event->ed.task;
3987405037c4SAndrey Churbanov     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
3988405037c4SAndrey Churbanov     bool detached = false;
3989405037c4SAndrey Churbanov     int gtid = __kmp_get_gtid();
3990405037c4SAndrey Churbanov 
3991d23131a3SJoachim Protze     // The associated task might have completed or could be completing at this
3992405037c4SAndrey Churbanov     // point.
3993405037c4SAndrey Churbanov     // We need to take the lock to avoid races
3994405037c4SAndrey Churbanov     __kmp_acquire_tas_lock(&event->lock, gtid);
399510995c77SJoachim Protze     if (taskdata->td_flags.proxy == TASK_PROXY) {
3996405037c4SAndrey Churbanov       detached = true;
399710995c77SJoachim Protze     } else {
399810995c77SJoachim Protze #if OMPT_SUPPORT
399910995c77SJoachim Protze       // The OMPT event must occur under mutual exclusion,
400010995c77SJoachim Protze       // otherwise the tool might access ptask after free
400110995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
400210995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_early_fulfill);
400310995c77SJoachim Protze #endif
400410995c77SJoachim Protze     }
4005405037c4SAndrey Churbanov     event->type = KMP_EVENT_UNINITIALIZED;
4006405037c4SAndrey Churbanov     __kmp_release_tas_lock(&event->lock, gtid);
4007405037c4SAndrey Churbanov 
4008405037c4SAndrey Churbanov     if (detached) {
400910995c77SJoachim Protze #if OMPT_SUPPORT
401010995c77SJoachim Protze       // We free ptask afterwards and know the task is finished,
401110995c77SJoachim Protze       // so locking is not necessary
401210995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
401310995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_late_fulfill);
401410995c77SJoachim Protze #endif
4015405037c4SAndrey Churbanov       // If the task detached complete the proxy task
4016405037c4SAndrey Churbanov       if (gtid >= 0) {
4017405037c4SAndrey Churbanov         kmp_team_t *team = taskdata->td_team;
4018405037c4SAndrey Churbanov         kmp_info_t *thread = __kmp_get_thread();
4019405037c4SAndrey Churbanov         if (thread->th.th_team == team) {
4020405037c4SAndrey Churbanov           __kmpc_proxy_task_completed(gtid, ptask);
4021405037c4SAndrey Churbanov           return;
4022405037c4SAndrey Churbanov         }
4023405037c4SAndrey Churbanov       }
4024405037c4SAndrey Churbanov 
4025405037c4SAndrey Churbanov       // fallback
4026405037c4SAndrey Churbanov       __kmpc_proxy_task_completed_ooo(ptask);
4027405037c4SAndrey Churbanov     }
4028405037c4SAndrey Churbanov   }
4029405037c4SAndrey Churbanov }
4030405037c4SAndrey Churbanov 
40313041982dSJonathan Peyton // __kmp_task_dup_alloc: Allocate the taskdata and make a copy of source task
40323041982dSJonathan Peyton // for taskloop
40337cc577a4SJonathan Peyton //
40347cc577a4SJonathan Peyton // thread:   allocating thread
40357cc577a4SJonathan Peyton // task_src: pointer to source task to be duplicated
40367cc577a4SJonathan Peyton // returns:  a pointer to the allocated kmp_task_t structure (task).
40373041982dSJonathan Peyton kmp_task_t *__kmp_task_dup_alloc(kmp_info_t *thread, kmp_task_t *task_src) {
40387cc577a4SJonathan Peyton   kmp_task_t *task;
40397cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
40405e111c5dSAndreyChurbanov   kmp_taskdata_t *taskdata_src = KMP_TASK_TO_TASKDATA(task_src);
40415e111c5dSAndreyChurbanov   kmp_taskdata_t *parent_task = taskdata_src->td_parent; // same parent task
40427cc577a4SJonathan Peyton   size_t shareds_offset;
40437cc577a4SJonathan Peyton   size_t task_size;
40447cc577a4SJonathan Peyton 
40453041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_dup_alloc(enter): Th %p, source task %p\n", thread,
40463041982dSJonathan Peyton                 task_src));
40473041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.proxy ==
40483041982dSJonathan Peyton                    TASK_FULL); // it should not be proxy task
40497cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.tasktype == TASK_EXPLICIT);
40507cc577a4SJonathan Peyton   task_size = taskdata_src->td_size_alloc;
40517cc577a4SJonathan Peyton 
40527cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
40533041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_dup_alloc: Th %p, malloc size %ld\n", thread,
40543041982dSJonathan Peyton                 task_size));
40557cc577a4SJonathan Peyton #if USE_FAST_MEMORY
40567cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, task_size);
40577cc577a4SJonathan Peyton #else
40587cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, task_size);
40597cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
40607cc577a4SJonathan Peyton   KMP_MEMCPY(taskdata, taskdata_src, task_size);
40617cc577a4SJonathan Peyton 
40627cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
40637cc577a4SJonathan Peyton 
40647cc577a4SJonathan Peyton   // Initialize new task (only specific fields not affected by memcpy)
40657cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
40667cc577a4SJonathan Peyton   if (task->shareds != NULL) { // need setup shareds pointer
40677cc577a4SJonathan Peyton     shareds_offset = (char *)task_src->shareds - (char *)taskdata_src;
40687cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
40693041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
40703041982dSJonathan Peyton                      0);
40717cc577a4SJonathan Peyton   }
40727cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
407393e17cfeSJonathan Peyton   taskdata->td_parent = parent_task;
4074ae044467SAndreyChurbanov   // task inherits the taskgroup from the parent task
4075ae044467SAndreyChurbanov   taskdata->td_taskgroup = parent_task->td_taskgroup;
4076ae044467SAndreyChurbanov   // tied task needs to initialize the td_last_tied at creation,
4077ae044467SAndreyChurbanov   // untied one does this when it is scheduled for execution
4078ae044467SAndreyChurbanov   if (taskdata->td_flags.tiedness == TASK_TIED)
4079ae044467SAndreyChurbanov     taskdata->td_last_tied = taskdata;
40807cc577a4SJonathan Peyton 
40813041982dSJonathan Peyton   // Only need to keep track of child task counts if team parallel and tasking
40823041982dSJonathan Peyton   // not serialized
40837cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
408437e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
40857cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
408637e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
40873041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
40883041982dSJonathan Peyton     // implicit not deallocated
40897cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT)
409037e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
40917cc577a4SJonathan Peyton   }
40927cc577a4SJonathan Peyton 
40933041982dSJonathan Peyton   KA_TRACE(20,
40943041982dSJonathan Peyton            ("__kmp_task_dup_alloc(exit): Th %p, created task %p, parent=%p\n",
40957cc577a4SJonathan Peyton             thread, taskdata, taskdata->td_parent));
40967cc577a4SJonathan Peyton #if OMPT_SUPPORT
4097f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
409882e94a59SJoachim Protze     __ompt_task_init(taskdata, thread->th.th_info.ds.ds_gtid);
40997cc577a4SJonathan Peyton #endif
41007cc577a4SJonathan Peyton   return task;
41017cc577a4SJonathan Peyton }
41027cc577a4SJonathan Peyton 
41037cc577a4SJonathan Peyton // Routine optionally generated by the compiler for setting the lastprivate flag
41047cc577a4SJonathan Peyton // and calling needed constructors for private/firstprivate objects
41057cc577a4SJonathan Peyton // (used to form taskloop tasks from pattern task)
410693e17cfeSJonathan Peyton // Parameters: dest task, src task, lastprivate flag.
41077cc577a4SJonathan Peyton typedef void (*p_task_dup_t)(kmp_task_t *, kmp_task_t *, kmp_int32);
41087cc577a4SJonathan Peyton 
410927a677fcSJonathan Peyton KMP_BUILD_ASSERT(sizeof(long) == 4 || sizeof(long) == 8);
411027a677fcSJonathan Peyton 
411127a677fcSJonathan Peyton // class to encapsulate manipulating loop bounds in a taskloop task.
411227a677fcSJonathan Peyton // this abstracts away the Intel vs GOMP taskloop interface for setting/getting
411327a677fcSJonathan Peyton // the loop bound variables.
411427a677fcSJonathan Peyton class kmp_taskloop_bounds_t {
411527a677fcSJonathan Peyton   kmp_task_t *task;
411627a677fcSJonathan Peyton   const kmp_taskdata_t *taskdata;
411727a677fcSJonathan Peyton   size_t lower_offset;
411827a677fcSJonathan Peyton   size_t upper_offset;
411927a677fcSJonathan Peyton 
412027a677fcSJonathan Peyton public:
412127a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, kmp_uint64 *lb, kmp_uint64 *ub)
412227a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(task)),
412327a677fcSJonathan Peyton         lower_offset((char *)lb - (char *)task),
412427a677fcSJonathan Peyton         upper_offset((char *)ub - (char *)task) {
412527a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)lb > (char *)_task);
412627a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)ub > (char *)_task);
412727a677fcSJonathan Peyton   }
412827a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, const kmp_taskloop_bounds_t &bounds)
412927a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(_task)),
413027a677fcSJonathan Peyton         lower_offset(bounds.lower_offset), upper_offset(bounds.upper_offset) {}
413127a677fcSJonathan Peyton   size_t get_lower_offset() const { return lower_offset; }
413227a677fcSJonathan Peyton   size_t get_upper_offset() const { return upper_offset; }
413327a677fcSJonathan Peyton   kmp_uint64 get_lb() const {
413427a677fcSJonathan Peyton     kmp_int64 retval;
413527a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
413627a677fcSJonathan Peyton     // Intel task just returns the lower bound normally
413727a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
413827a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + lower_offset);
413927a677fcSJonathan Peyton     } else {
414027a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
414127a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
414227a677fcSJonathan Peyton         kmp_int32 *lb = RCAST(kmp_int32 *, task->shareds);
414327a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
414427a677fcSJonathan Peyton       } else {
414527a677fcSJonathan Peyton         kmp_int64 *lb = RCAST(kmp_int64 *, task->shareds);
414627a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
414727a677fcSJonathan Peyton       }
414827a677fcSJonathan Peyton     }
414927a677fcSJonathan Peyton #else
4150b3d84790SMartin Storsjö     (void)taskdata;
415127a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + lower_offset);
415227a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
415327a677fcSJonathan Peyton     return retval;
415427a677fcSJonathan Peyton   }
415527a677fcSJonathan Peyton   kmp_uint64 get_ub() const {
415627a677fcSJonathan Peyton     kmp_int64 retval;
415727a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
415827a677fcSJonathan Peyton     // Intel task just returns the upper bound normally
415927a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
416027a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + upper_offset);
416127a677fcSJonathan Peyton     } else {
416227a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
416327a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
416427a677fcSJonathan Peyton         kmp_int32 *ub = RCAST(kmp_int32 *, task->shareds) + 1;
416527a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
416627a677fcSJonathan Peyton       } else {
416727a677fcSJonathan Peyton         kmp_int64 *ub = RCAST(kmp_int64 *, task->shareds) + 1;
416827a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
416927a677fcSJonathan Peyton       }
417027a677fcSJonathan Peyton     }
417127a677fcSJonathan Peyton #else
417227a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + upper_offset);
417327a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
417427a677fcSJonathan Peyton     return retval;
417527a677fcSJonathan Peyton   }
417627a677fcSJonathan Peyton   void set_lb(kmp_uint64 lb) {
417727a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
417827a677fcSJonathan Peyton     // Intel task just sets the lower bound normally
417927a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
418027a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + lower_offset) = lb;
418127a677fcSJonathan Peyton     } else {
418227a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
418327a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
418427a677fcSJonathan Peyton         kmp_uint32 *lower = RCAST(kmp_uint32 *, task->shareds);
418527a677fcSJonathan Peyton         *lower = (kmp_uint32)lb;
418627a677fcSJonathan Peyton       } else {
418727a677fcSJonathan Peyton         kmp_uint64 *lower = RCAST(kmp_uint64 *, task->shareds);
418827a677fcSJonathan Peyton         *lower = (kmp_uint64)lb;
418927a677fcSJonathan Peyton       }
419027a677fcSJonathan Peyton     }
419127a677fcSJonathan Peyton #else
419227a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + lower_offset) = lb;
419327a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
419427a677fcSJonathan Peyton   }
419527a677fcSJonathan Peyton   void set_ub(kmp_uint64 ub) {
419627a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
419727a677fcSJonathan Peyton     // Intel task just sets the upper bound normally
419827a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
419927a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + upper_offset) = ub;
420027a677fcSJonathan Peyton     } else {
420127a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
420227a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
420327a677fcSJonathan Peyton         kmp_uint32 *upper = RCAST(kmp_uint32 *, task->shareds) + 1;
420427a677fcSJonathan Peyton         *upper = (kmp_uint32)ub;
420527a677fcSJonathan Peyton       } else {
420627a677fcSJonathan Peyton         kmp_uint64 *upper = RCAST(kmp_uint64 *, task->shareds) + 1;
420727a677fcSJonathan Peyton         *upper = (kmp_uint64)ub;
420827a677fcSJonathan Peyton       }
420927a677fcSJonathan Peyton     }
421027a677fcSJonathan Peyton #else
421127a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + upper_offset) = ub;
421227a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
421327a677fcSJonathan Peyton   }
421427a677fcSJonathan Peyton };
421527a677fcSJonathan Peyton 
42167cc577a4SJonathan Peyton // __kmp_taskloop_linear: Start tasks of the taskloop linearly
42177cc577a4SJonathan Peyton //
42187cc577a4SJonathan Peyton // loc        Source location information
42197cc577a4SJonathan Peyton // gtid       Global thread ID
422093e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
422193e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
422293e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
42237cc577a4SJonathan Peyton // st         Loop stride
422493e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
422593e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
422693e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
422793e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4228540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
422993e17cfeSJonathan Peyton // tc         Iterations count
42307cc577a4SJonathan Peyton // task_dup   Tasks duplication routine
4231cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
42323041982dSJonathan Peyton void __kmp_taskloop_linear(ident_t *loc, int gtid, kmp_task_t *task,
42337cc577a4SJonathan Peyton                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
423493e17cfeSJonathan Peyton                            kmp_uint64 ub_glob, kmp_uint64 num_tasks,
423593e17cfeSJonathan Peyton                            kmp_uint64 grainsize, kmp_uint64 extras,
4236540007b4SNawrin Sultana                            kmp_int64 last_chunk, kmp_uint64 tc,
4237cdaefac5SJoachim Protze #if OMPT_SUPPORT
4238cdaefac5SJoachim Protze                            void *codeptr_ra,
4239cdaefac5SJoachim Protze #endif
4240cdaefac5SJoachim Protze                            void *task_dup) {
42417cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKLOOP);
42427cc577a4SJonathan Peyton   KMP_TIME_PARTITIONED_BLOCK(OMP_taskloop_scheduling);
42437cc577a4SJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
424427a677fcSJonathan Peyton   // compiler provides global bounds here
424527a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
424627a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
424727a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
424893e17cfeSJonathan Peyton   kmp_uint64 i;
42497cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
42507cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
42517cc577a4SJonathan Peyton   kmp_task_t *next_task;
42527cc577a4SJonathan Peyton   kmp_int32 lastpriv = 0;
42537cc577a4SJonathan Peyton 
4254309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4255309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
425693e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
425793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
425893e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_linear: T#%d: %lld tasks, grainsize %lld, "
4259540007b4SNawrin Sultana                 "extras %lld, last_chunk %lld, i=%lld,%lld(%d)%lld, dup %p\n",
4260540007b4SNawrin Sultana                 gtid, num_tasks, grainsize, extras, last_chunk, lower, upper,
4261540007b4SNawrin Sultana                 ub_glob, st, task_dup));
426293e17cfeSJonathan Peyton 
426393e17cfeSJonathan Peyton   // Launch num_tasks tasks, assign grainsize iterations each task
426493e17cfeSJonathan Peyton   for (i = 0; i < num_tasks; ++i) {
426593e17cfeSJonathan Peyton     kmp_uint64 chunk_minus_1;
426693e17cfeSJonathan Peyton     if (extras == 0) {
426793e17cfeSJonathan Peyton       chunk_minus_1 = grainsize - 1;
426893e17cfeSJonathan Peyton     } else {
426993e17cfeSJonathan Peyton       chunk_minus_1 = grainsize;
427093e17cfeSJonathan Peyton       --extras; // first extras iterations get bigger chunk (grainsize+1)
427193e17cfeSJonathan Peyton     }
427293e17cfeSJonathan Peyton     upper = lower + st * chunk_minus_1;
4273540007b4SNawrin Sultana     if (upper > *ub) {
4274540007b4SNawrin Sultana       upper = *ub;
4275540007b4SNawrin Sultana     }
427693e17cfeSJonathan Peyton     if (i == num_tasks - 1) {
427793e17cfeSJonathan Peyton       // schedule the last task, set lastprivate flag if needed
427893e17cfeSJonathan Peyton       if (st == 1) { // most common case
427993e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper == *ub);
428093e17cfeSJonathan Peyton         if (upper == ub_glob)
428193e17cfeSJonathan Peyton           lastpriv = 1;
428293e17cfeSJonathan Peyton       } else if (st > 0) { // positive loop stride
428393e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT((kmp_uint64)st > *ub - upper);
428493e17cfeSJonathan Peyton         if ((kmp_uint64)st > ub_glob - upper)
428593e17cfeSJonathan Peyton           lastpriv = 1;
428693e17cfeSJonathan Peyton       } else { // negative loop stride
428793e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper + st < *ub);
428893e17cfeSJonathan Peyton         if (upper - ub_glob < (kmp_uint64)(-st))
428993e17cfeSJonathan Peyton           lastpriv = 1;
429093e17cfeSJonathan Peyton       }
429193e17cfeSJonathan Peyton     }
429293e17cfeSJonathan Peyton     next_task = __kmp_task_dup_alloc(thread, task); // allocate new task
429327a677fcSJonathan Peyton     kmp_taskdata_t *next_taskdata = KMP_TASK_TO_TASKDATA(next_task);
429427a677fcSJonathan Peyton     kmp_taskloop_bounds_t next_task_bounds =
429527a677fcSJonathan Peyton         kmp_taskloop_bounds_t(next_task, task_bounds);
429627a677fcSJonathan Peyton 
429793e17cfeSJonathan Peyton     // adjust task-specific bounds
429827a677fcSJonathan Peyton     next_task_bounds.set_lb(lower);
429927a677fcSJonathan Peyton     if (next_taskdata->td_flags.native) {
430027a677fcSJonathan Peyton       next_task_bounds.set_ub(upper + (st > 0 ? 1 : -1));
430127a677fcSJonathan Peyton     } else {
430227a677fcSJonathan Peyton       next_task_bounds.set_ub(upper);
430327a677fcSJonathan Peyton     }
43044c6a098aSKazuaki Ishizaki     if (ptask_dup != NULL) // set lastprivate flag, construct firstprivates,
43054c6a098aSKazuaki Ishizaki                            // etc.
430693e17cfeSJonathan Peyton       ptask_dup(next_task, task, lastpriv);
430727a677fcSJonathan Peyton     KA_TRACE(40,
430827a677fcSJonathan Peyton              ("__kmp_taskloop_linear: T#%d; task #%llu: task %p: lower %lld, "
430927a677fcSJonathan Peyton               "upper %lld stride %lld, (offsets %p %p)\n",
431027a677fcSJonathan Peyton               gtid, i, next_task, lower, upper, st,
431127a677fcSJonathan Peyton               next_task_bounds.get_lower_offset(),
431227a677fcSJonathan Peyton               next_task_bounds.get_upper_offset()));
4313cdaefac5SJoachim Protze #if OMPT_SUPPORT
4314cdaefac5SJoachim Protze     __kmp_omp_taskloop_task(NULL, gtid, next_task,
4315cdaefac5SJoachim Protze                             codeptr_ra); // schedule new task
4316cdaefac5SJoachim Protze #else
431793e17cfeSJonathan Peyton     __kmp_omp_task(gtid, next_task, true); // schedule new task
4318cdaefac5SJoachim Protze #endif
431993e17cfeSJonathan Peyton     lower = upper + st; // adjust lower bound for the next iteration
432093e17cfeSJonathan Peyton   }
432193e17cfeSJonathan Peyton   // free the pattern task and exit
432293e17cfeSJonathan Peyton   __kmp_task_start(gtid, task, current_task); // make internal bookkeeping
432393e17cfeSJonathan Peyton   // do not execute the pattern task, just do internal bookkeeping
432486ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task, current_task);
432593e17cfeSJonathan Peyton }
432693e17cfeSJonathan Peyton 
432793e17cfeSJonathan Peyton // Structure to keep taskloop parameters for auxiliary task
432893e17cfeSJonathan Peyton // kept in the shareds of the task structure.
432993e17cfeSJonathan Peyton typedef struct __taskloop_params {
433093e17cfeSJonathan Peyton   kmp_task_t *task;
433193e17cfeSJonathan Peyton   kmp_uint64 *lb;
433293e17cfeSJonathan Peyton   kmp_uint64 *ub;
433393e17cfeSJonathan Peyton   void *task_dup;
433493e17cfeSJonathan Peyton   kmp_int64 st;
433593e17cfeSJonathan Peyton   kmp_uint64 ub_glob;
433693e17cfeSJonathan Peyton   kmp_uint64 num_tasks;
433793e17cfeSJonathan Peyton   kmp_uint64 grainsize;
433893e17cfeSJonathan Peyton   kmp_uint64 extras;
4339540007b4SNawrin Sultana   kmp_int64 last_chunk;
434093e17cfeSJonathan Peyton   kmp_uint64 tc;
434193e17cfeSJonathan Peyton   kmp_uint64 num_t_min;
4342cdaefac5SJoachim Protze #if OMPT_SUPPORT
4343cdaefac5SJoachim Protze   void *codeptr_ra;
4344cdaefac5SJoachim Protze #endif
434593e17cfeSJonathan Peyton } __taskloop_params_t;
434693e17cfeSJonathan Peyton 
434793e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *, int, kmp_task_t *, kmp_uint64 *,
434893e17cfeSJonathan Peyton                           kmp_uint64 *, kmp_int64, kmp_uint64, kmp_uint64,
4349540007b4SNawrin Sultana                           kmp_uint64, kmp_uint64, kmp_int64, kmp_uint64,
4350540007b4SNawrin Sultana                           kmp_uint64,
4351cdaefac5SJoachim Protze #if OMPT_SUPPORT
4352cdaefac5SJoachim Protze                           void *,
4353cdaefac5SJoachim Protze #endif
435493e17cfeSJonathan Peyton                           void *);
435593e17cfeSJonathan Peyton 
4356ed5fe645SKelvin Li // Execute part of the taskloop submitted as a task.
435793e17cfeSJonathan Peyton int __kmp_taskloop_task(int gtid, void *ptask) {
4358d74d8902SJonathan Peyton   __taskloop_params_t *p =
4359d74d8902SJonathan Peyton       (__taskloop_params_t *)((kmp_task_t *)ptask)->shareds;
436093e17cfeSJonathan Peyton   kmp_task_t *task = p->task;
436193e17cfeSJonathan Peyton   kmp_uint64 *lb = p->lb;
436293e17cfeSJonathan Peyton   kmp_uint64 *ub = p->ub;
436393e17cfeSJonathan Peyton   void *task_dup = p->task_dup;
436493e17cfeSJonathan Peyton   //  p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
436593e17cfeSJonathan Peyton   kmp_int64 st = p->st;
436693e17cfeSJonathan Peyton   kmp_uint64 ub_glob = p->ub_glob;
436793e17cfeSJonathan Peyton   kmp_uint64 num_tasks = p->num_tasks;
436893e17cfeSJonathan Peyton   kmp_uint64 grainsize = p->grainsize;
436993e17cfeSJonathan Peyton   kmp_uint64 extras = p->extras;
4370540007b4SNawrin Sultana   kmp_int64 last_chunk = p->last_chunk;
437193e17cfeSJonathan Peyton   kmp_uint64 tc = p->tc;
437293e17cfeSJonathan Peyton   kmp_uint64 num_t_min = p->num_t_min;
4373cdaefac5SJoachim Protze #if OMPT_SUPPORT
4374cdaefac5SJoachim Protze   void *codeptr_ra = p->codeptr_ra;
4375cdaefac5SJoachim Protze #endif
437693e17cfeSJonathan Peyton #if KMP_DEBUG
437793e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
437893e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
4379540007b4SNawrin Sultana   KA_TRACE(20,
4380540007b4SNawrin Sultana            ("__kmp_taskloop_task: T#%d, task %p: %lld tasks, grainsize"
4381540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4382540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4383540007b4SNawrin Sultana             st, task_dup));
438493e17cfeSJonathan Peyton #endif
438593e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks * 2 + 1 > num_t_min);
438693e17cfeSJonathan Peyton   if (num_tasks > num_t_min)
438793e17cfeSJonathan Peyton     __kmp_taskloop_recur(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4388540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_t_min,
4389cdaefac5SJoachim Protze #if OMPT_SUPPORT
4390cdaefac5SJoachim Protze                          codeptr_ra,
4391cdaefac5SJoachim Protze #endif
4392cdaefac5SJoachim Protze                          task_dup);
439393e17cfeSJonathan Peyton   else
439493e17cfeSJonathan Peyton     __kmp_taskloop_linear(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4395540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4396cdaefac5SJoachim Protze #if OMPT_SUPPORT
4397cdaefac5SJoachim Protze                           codeptr_ra,
4398cdaefac5SJoachim Protze #endif
4399cdaefac5SJoachim Protze                           task_dup);
440093e17cfeSJonathan Peyton 
440193e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmp_taskloop_task(exit): T#%d\n", gtid));
440293e17cfeSJonathan Peyton   return 0;
440393e17cfeSJonathan Peyton }
440493e17cfeSJonathan Peyton 
4405ed5fe645SKelvin Li // Schedule part of the taskloop as a task,
4406ed5fe645SKelvin Li // execute the rest of the taskloop.
440793e17cfeSJonathan Peyton //
440893e17cfeSJonathan Peyton // loc        Source location information
440993e17cfeSJonathan Peyton // gtid       Global thread ID
441093e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
441193e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
441293e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
441393e17cfeSJonathan Peyton // st         Loop stride
441493e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
441593e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
441693e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
441793e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4418540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
441993e17cfeSJonathan Peyton // tc         Iterations count
442042016791SKazuaki Ishizaki // num_t_min  Threshold to launch tasks recursively
442193e17cfeSJonathan Peyton // task_dup   Tasks duplication routine
4422cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
442393e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *loc, int gtid, kmp_task_t *task,
442493e17cfeSJonathan Peyton                           kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
442593e17cfeSJonathan Peyton                           kmp_uint64 ub_glob, kmp_uint64 num_tasks,
442693e17cfeSJonathan Peyton                           kmp_uint64 grainsize, kmp_uint64 extras,
4427540007b4SNawrin Sultana                           kmp_int64 last_chunk, kmp_uint64 tc,
4428540007b4SNawrin Sultana                           kmp_uint64 num_t_min,
4429cdaefac5SJoachim Protze #if OMPT_SUPPORT
4430cdaefac5SJoachim Protze                           void *codeptr_ra,
4431cdaefac5SJoachim Protze #endif
4432cdaefac5SJoachim Protze                           void *task_dup) {
443393e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
443493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
443593e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > num_t_min);
4436540007b4SNawrin Sultana   KA_TRACE(20,
4437540007b4SNawrin Sultana            ("__kmp_taskloop_recur: T#%d, task %p: %lld tasks, grainsize"
4438540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4439540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4440540007b4SNawrin Sultana             st, task_dup));
444193e17cfeSJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
444293e17cfeSJonathan Peyton   kmp_uint64 lower = *lb;
444393e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
444493e17cfeSJonathan Peyton   //  kmp_taskdata_t *current_task = thread->th.th_current_task;
444593e17cfeSJonathan Peyton   kmp_task_t *next_task;
444693e17cfeSJonathan Peyton   size_t lower_offset =
444793e17cfeSJonathan Peyton       (char *)lb - (char *)task; // remember offset of lb in the task structure
444893e17cfeSJonathan Peyton   size_t upper_offset =
444993e17cfeSJonathan Peyton       (char *)ub - (char *)task; // remember offset of ub in the task structure
445093e17cfeSJonathan Peyton 
4451309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4452309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
445393e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
445493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
445593e17cfeSJonathan Peyton 
445693e17cfeSJonathan Peyton   // split the loop in two halves
445793e17cfeSJonathan Peyton   kmp_uint64 lb1, ub0, tc0, tc1, ext0, ext1;
4458540007b4SNawrin Sultana   kmp_int64 last_chunk0 = 0, last_chunk1 = 0;
445993e17cfeSJonathan Peyton   kmp_uint64 gr_size0 = grainsize;
446093e17cfeSJonathan Peyton   kmp_uint64 n_tsk0 = num_tasks >> 1; // num_tasks/2 to execute
446193e17cfeSJonathan Peyton   kmp_uint64 n_tsk1 = num_tasks - n_tsk0; // to schedule as a task
4462540007b4SNawrin Sultana   if (last_chunk < 0) {
4463540007b4SNawrin Sultana     ext0 = ext1 = 0;
4464540007b4SNawrin Sultana     last_chunk1 = last_chunk;
4465540007b4SNawrin Sultana     tc0 = grainsize * n_tsk0;
4466540007b4SNawrin Sultana     tc1 = tc - tc0;
4467540007b4SNawrin Sultana   } else if (n_tsk0 <= extras) {
446893e17cfeSJonathan Peyton     gr_size0++; // integrate extras into grainsize
446993e17cfeSJonathan Peyton     ext0 = 0; // no extra iters in 1st half
447093e17cfeSJonathan Peyton     ext1 = extras - n_tsk0; // remaining extras
447193e17cfeSJonathan Peyton     tc0 = gr_size0 * n_tsk0;
447293e17cfeSJonathan Peyton     tc1 = tc - tc0;
447393e17cfeSJonathan Peyton   } else { // n_tsk0 > extras
447493e17cfeSJonathan Peyton     ext1 = 0; // no extra iters in 2nd half
447593e17cfeSJonathan Peyton     ext0 = extras;
447693e17cfeSJonathan Peyton     tc1 = grainsize * n_tsk1;
447793e17cfeSJonathan Peyton     tc0 = tc - tc1;
447893e17cfeSJonathan Peyton   }
447993e17cfeSJonathan Peyton   ub0 = lower + st * (tc0 - 1);
448093e17cfeSJonathan Peyton   lb1 = ub0 + st;
448193e17cfeSJonathan Peyton 
448293e17cfeSJonathan Peyton   // create pattern task for 2nd half of the loop
448393e17cfeSJonathan Peyton   next_task = __kmp_task_dup_alloc(thread, task); // duplicate the task
448493e17cfeSJonathan Peyton   // adjust lower bound (upper bound is not changed) for the 2nd half
448593e17cfeSJonathan Peyton   *(kmp_uint64 *)((char *)next_task + lower_offset) = lb1;
44864c6a098aSKazuaki Ishizaki   if (ptask_dup != NULL) // construct firstprivates, etc.
448793e17cfeSJonathan Peyton     ptask_dup(next_task, task, 0);
448893e17cfeSJonathan Peyton   *ub = ub0; // adjust upper bound for the 1st half
448993e17cfeSJonathan Peyton 
449093e17cfeSJonathan Peyton   // create auxiliary task for 2nd half of the loop
44915e111c5dSAndreyChurbanov   // make sure new task has same parent task as the pattern task
44925e111c5dSAndreyChurbanov   kmp_taskdata_t *current_task = thread->th.th_current_task;
44935e111c5dSAndreyChurbanov   thread->th.th_current_task = taskdata->td_parent;
449493e17cfeSJonathan Peyton   kmp_task_t *new_task =
449593e17cfeSJonathan Peyton       __kmpc_omp_task_alloc(loc, gtid, 1, 3 * sizeof(void *),
449693e17cfeSJonathan Peyton                             sizeof(__taskloop_params_t), &__kmp_taskloop_task);
44975e111c5dSAndreyChurbanov   // restore current task
44985e111c5dSAndreyChurbanov   thread->th.th_current_task = current_task;
449993e17cfeSJonathan Peyton   __taskloop_params_t *p = (__taskloop_params_t *)new_task->shareds;
450093e17cfeSJonathan Peyton   p->task = next_task;
450193e17cfeSJonathan Peyton   p->lb = (kmp_uint64 *)((char *)next_task + lower_offset);
450293e17cfeSJonathan Peyton   p->ub = (kmp_uint64 *)((char *)next_task + upper_offset);
450393e17cfeSJonathan Peyton   p->task_dup = task_dup;
450493e17cfeSJonathan Peyton   p->st = st;
450593e17cfeSJonathan Peyton   p->ub_glob = ub_glob;
450693e17cfeSJonathan Peyton   p->num_tasks = n_tsk1;
450793e17cfeSJonathan Peyton   p->grainsize = grainsize;
450893e17cfeSJonathan Peyton   p->extras = ext1;
4509540007b4SNawrin Sultana   p->last_chunk = last_chunk1;
451093e17cfeSJonathan Peyton   p->tc = tc1;
451193e17cfeSJonathan Peyton   p->num_t_min = num_t_min;
4512cdaefac5SJoachim Protze #if OMPT_SUPPORT
4513cdaefac5SJoachim Protze   p->codeptr_ra = codeptr_ra;
4514cdaefac5SJoachim Protze #endif
4515cdaefac5SJoachim Protze 
4516cdaefac5SJoachim Protze #if OMPT_SUPPORT
4517cdaefac5SJoachim Protze   // schedule new task with correct return address for OMPT events
4518cdaefac5SJoachim Protze   __kmp_omp_taskloop_task(NULL, gtid, new_task, codeptr_ra);
4519cdaefac5SJoachim Protze #else
4520f729df82SGheorghe-Teodor Bercea   __kmp_omp_task(gtid, new_task, true); // schedule new task
4521cdaefac5SJoachim Protze #endif
452293e17cfeSJonathan Peyton 
452393e17cfeSJonathan Peyton   // execute the 1st half of current subrange
452493e17cfeSJonathan Peyton   if (n_tsk0 > num_t_min)
4525d74d8902SJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0, gr_size0,
4526540007b4SNawrin Sultana                          ext0, last_chunk0, tc0, num_t_min,
4527cdaefac5SJoachim Protze #if OMPT_SUPPORT
4528cdaefac5SJoachim Protze                          codeptr_ra,
4529cdaefac5SJoachim Protze #endif
4530cdaefac5SJoachim Protze                          task_dup);
453193e17cfeSJonathan Peyton   else
453293e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0,
4533540007b4SNawrin Sultana                           gr_size0, ext0, last_chunk0, tc0,
4534cdaefac5SJoachim Protze #if OMPT_SUPPORT
4535cdaefac5SJoachim Protze                           codeptr_ra,
4536cdaefac5SJoachim Protze #endif
4537cdaefac5SJoachim Protze                           task_dup);
453893e17cfeSJonathan Peyton 
4539540007b4SNawrin Sultana   KA_TRACE(40, ("__kmp_taskloop_recur(exit): T#%d\n", gtid));
454093e17cfeSJonathan Peyton }
454193e17cfeSJonathan Peyton 
4542540007b4SNawrin Sultana static void __kmp_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4543540007b4SNawrin Sultana                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4544540007b4SNawrin Sultana                            int nogroup, int sched, kmp_uint64 grainsize,
4545540007b4SNawrin Sultana                            int modifier, void *task_dup) {
454693e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
454793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
454882e94a59SJoachim Protze   if (nogroup == 0) {
454982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
455082e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
455182e94a59SJoachim Protze #endif
455293e17cfeSJonathan Peyton     __kmpc_taskgroup(loc, gtid);
455382e94a59SJoachim Protze   }
455493e17cfeSJonathan Peyton 
455593e17cfeSJonathan Peyton   // =========================================================================
455693e17cfeSJonathan Peyton   // calculate loop parameters
455727a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
455893e17cfeSJonathan Peyton   kmp_uint64 tc;
455927a677fcSJonathan Peyton   // compiler provides global bounds here
456027a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
456127a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
456293e17cfeSJonathan Peyton   kmp_uint64 ub_glob = upper; // global upper used to calc lastprivate flag
456393e17cfeSJonathan Peyton   kmp_uint64 num_tasks = 0, extras = 0;
4564540007b4SNawrin Sultana   kmp_int64 last_chunk =
4565540007b4SNawrin Sultana       0; // reduce grainsize of last task by last_chunk in strict mode
456693e17cfeSJonathan Peyton   kmp_uint64 num_tasks_min = __kmp_taskloop_min_tasks;
456793e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
456893e17cfeSJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
456993e17cfeSJonathan Peyton 
4570540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop: T#%d, task %p, lb %lld, ub %lld, st %lld, "
4571540007b4SNawrin Sultana                 "grain %llu(%d, %d), dup %p\n",
4572540007b4SNawrin Sultana                 gtid, taskdata, lower, upper, st, grainsize, sched, modifier,
4573540007b4SNawrin Sultana                 task_dup));
457427a677fcSJonathan Peyton 
45757cc577a4SJonathan Peyton   // compute trip count
45767cc577a4SJonathan Peyton   if (st == 1) { // most common case
45777cc577a4SJonathan Peyton     tc = upper - lower + 1;
45787cc577a4SJonathan Peyton   } else if (st < 0) {
45797cc577a4SJonathan Peyton     tc = (lower - upper) / (-st) + 1;
45807cc577a4SJonathan Peyton   } else { // st > 0
45817cc577a4SJonathan Peyton     tc = (upper - lower) / st + 1;
45827cc577a4SJonathan Peyton   }
45837cc577a4SJonathan Peyton   if (tc == 0) {
4584540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop(exit): T#%d zero-trip loop\n", gtid));
45857cc577a4SJonathan Peyton     // free the pattern task and exit
45867cc577a4SJonathan Peyton     __kmp_task_start(gtid, task, current_task);
45877cc577a4SJonathan Peyton     // do not execute anything for zero-trip loop
458886ed6aa6SJoachim Protze     __kmp_task_finish<false>(gtid, task, current_task);
45897cc577a4SJonathan Peyton     return;
45907cc577a4SJonathan Peyton   }
4591cdaefac5SJoachim Protze 
4592cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4593cdaefac5SJoachim Protze   ompt_team_info_t *team_info = __ompt_get_teaminfo(0, NULL);
4594cdaefac5SJoachim Protze   ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
4595cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4596cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4597cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_begin, &(team_info->parallel_data),
4598cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4599cdaefac5SJoachim Protze   }
4600cdaefac5SJoachim Protze #endif
4601cdaefac5SJoachim Protze 
460293e17cfeSJonathan Peyton   if (num_tasks_min == 0)
460393e17cfeSJonathan Peyton     // TODO: can we choose better default heuristic?
4604d74d8902SJonathan Peyton     num_tasks_min =
4605d74d8902SJonathan Peyton         KMP_MIN(thread->th.th_team_nproc * 10, INITIAL_TASK_DEQUE_SIZE);
46067cc577a4SJonathan Peyton 
46077cc577a4SJonathan Peyton   // compute num_tasks/grainsize based on the input provided
46087cc577a4SJonathan Peyton   switch (sched) {
46097cc577a4SJonathan Peyton   case 0: // no schedule clause specified, we can choose the default
46107cc577a4SJonathan Peyton     // let's try to schedule (team_size*10) tasks
46117cc577a4SJonathan Peyton     grainsize = thread->th.th_team_nproc * 10;
46120c599c38SJoachim Protze     KMP_FALLTHROUGH();
46137cc577a4SJonathan Peyton   case 2: // num_tasks provided
46147cc577a4SJonathan Peyton     if (grainsize > tc) {
46157cc577a4SJonathan Peyton       num_tasks = tc; // too big num_tasks requested, adjust values
46167cc577a4SJonathan Peyton       grainsize = 1;
46177cc577a4SJonathan Peyton       extras = 0;
46187cc577a4SJonathan Peyton     } else {
46197cc577a4SJonathan Peyton       num_tasks = grainsize;
46207cc577a4SJonathan Peyton       grainsize = tc / num_tasks;
46217cc577a4SJonathan Peyton       extras = tc % num_tasks;
46227cc577a4SJonathan Peyton     }
46237cc577a4SJonathan Peyton     break;
46247cc577a4SJonathan Peyton   case 1: // grainsize provided
46257cc577a4SJonathan Peyton     if (grainsize > tc) {
4626540007b4SNawrin Sultana       num_tasks = 1;
4627540007b4SNawrin Sultana       grainsize = tc; // too big grainsize requested, adjust values
4628540007b4SNawrin Sultana       extras = 0;
4629540007b4SNawrin Sultana     } else {
4630540007b4SNawrin Sultana       if (modifier) {
4631540007b4SNawrin Sultana         num_tasks = (tc + grainsize - 1) / grainsize;
4632540007b4SNawrin Sultana         last_chunk = tc - (num_tasks * grainsize);
46337cc577a4SJonathan Peyton         extras = 0;
46347cc577a4SJonathan Peyton       } else {
46357cc577a4SJonathan Peyton         num_tasks = tc / grainsize;
463693e17cfeSJonathan Peyton         // adjust grainsize for balanced distribution of iterations
463793e17cfeSJonathan Peyton         grainsize = tc / num_tasks;
46387cc577a4SJonathan Peyton         extras = tc % num_tasks;
46397cc577a4SJonathan Peyton       }
4640540007b4SNawrin Sultana     }
46417cc577a4SJonathan Peyton     break;
46427cc577a4SJonathan Peyton   default:
46437cc577a4SJonathan Peyton     KMP_ASSERT2(0, "unknown scheduling of taskloop");
46447cc577a4SJonathan Peyton   }
4645540007b4SNawrin Sultana 
4646309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4647309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
46487cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
46497cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
465093e17cfeSJonathan Peyton   // =========================================================================
46517cc577a4SJonathan Peyton 
46527cc577a4SJonathan Peyton   // check if clause value first
465327a677fcSJonathan Peyton   // Also require GOMP_taskloop to reduce to linear (taskdata->td_flags.native)
46547cc577a4SJonathan Peyton   if (if_val == 0) { // if(0) specified, mark task as serial
46557cc577a4SJonathan Peyton     taskdata->td_flags.task_serial = 1;
46567cc577a4SJonathan Peyton     taskdata->td_flags.tiedness = TASK_TIED; // AC: serial task cannot be untied
465793e17cfeSJonathan Peyton     // always start serial tasks linearly
465893e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4659540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4660cdaefac5SJoachim Protze #if OMPT_SUPPORT
4661cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4662cdaefac5SJoachim Protze #endif
4663cdaefac5SJoachim Protze                           task_dup);
466427a677fcSJonathan Peyton     // !taskdata->td_flags.native => currently force linear spawning of tasks
466527a677fcSJonathan Peyton     // for GOMP_taskloop
466627a677fcSJonathan Peyton   } else if (num_tasks > num_tasks_min && !taskdata->td_flags.native) {
4667540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go recursive: tc %llu, #tasks %llu"
4668540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4669540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4670540007b4SNawrin Sultana                   last_chunk));
467193e17cfeSJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4672540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_tasks_min,
4673cdaefac5SJoachim Protze #if OMPT_SUPPORT
4674cdaefac5SJoachim Protze                          OMPT_GET_RETURN_ADDRESS(0),
4675cdaefac5SJoachim Protze #endif
4676cdaefac5SJoachim Protze                          task_dup);
467793e17cfeSJonathan Peyton   } else {
4678540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go linear: tc %llu, #tasks %llu"
4679540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4680540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4681540007b4SNawrin Sultana                   last_chunk));
468293e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4683540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4684cdaefac5SJoachim Protze #if OMPT_SUPPORT
4685cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4686cdaefac5SJoachim Protze #endif
4687cdaefac5SJoachim Protze                           task_dup);
46887cc577a4SJonathan Peyton   }
46897cc577a4SJonathan Peyton 
4690cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4691cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4692cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4693cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_end, &(team_info->parallel_data),
4694cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4695cdaefac5SJoachim Protze   }
4696cdaefac5SJoachim Protze #endif
4697cdaefac5SJoachim Protze 
469882e94a59SJoachim Protze   if (nogroup == 0) {
469982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
470082e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
470182e94a59SJoachim Protze #endif
47027cc577a4SJonathan Peyton     __kmpc_end_taskgroup(loc, gtid);
470382e94a59SJoachim Protze   }
4704540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop(exit): T#%d\n", gtid));
4705540007b4SNawrin Sultana }
4706540007b4SNawrin Sultana 
4707540007b4SNawrin Sultana /*!
4708540007b4SNawrin Sultana @ingroup TASKING
4709540007b4SNawrin Sultana @param loc       Source location information
4710540007b4SNawrin Sultana @param gtid      Global thread ID
4711540007b4SNawrin Sultana @param task      Task structure
4712540007b4SNawrin Sultana @param if_val    Value of the if clause
4713540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4714540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4715540007b4SNawrin Sultana @param st        Loop stride
4716540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4717540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4718540007b4SNawrin Sultana @param grainsize Schedule value if specified
4719540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4720540007b4SNawrin Sultana 
4721540007b4SNawrin Sultana Execute the taskloop construct.
4722540007b4SNawrin Sultana */
4723540007b4SNawrin Sultana void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4724540007b4SNawrin Sultana                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,
4725540007b4SNawrin Sultana                      int sched, kmp_uint64 grainsize, void *task_dup) {
4726540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4727540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop(enter): T#%d\n", gtid));
4728540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4729540007b4SNawrin Sultana                  0, task_dup);
473093e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d\n", gtid));
47317cc577a4SJonathan Peyton }
4732540007b4SNawrin Sultana 
4733540007b4SNawrin Sultana /*!
4734540007b4SNawrin Sultana @ingroup TASKING
4735540007b4SNawrin Sultana @param loc       Source location information
4736540007b4SNawrin Sultana @param gtid      Global thread ID
4737540007b4SNawrin Sultana @param task      Task structure
4738540007b4SNawrin Sultana @param if_val    Value of the if clause
4739540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4740540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4741540007b4SNawrin Sultana @param st        Loop stride
4742540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4743540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4744540007b4SNawrin Sultana @param grainsize Schedule value if specified
4745540007b4SNawrin Sultana @param modifer   Modifier 'strict' for sched, 1 if present, 0 otherwise
4746540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4747540007b4SNawrin Sultana 
4748540007b4SNawrin Sultana Execute the taskloop construct.
4749540007b4SNawrin Sultana */
4750540007b4SNawrin Sultana void __kmpc_taskloop_5(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4751540007b4SNawrin Sultana                        kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4752540007b4SNawrin Sultana                        int nogroup, int sched, kmp_uint64 grainsize,
4753540007b4SNawrin Sultana                        int modifier, void *task_dup) {
4754540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4755540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(enter): T#%d\n", gtid));
4756540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4757540007b4SNawrin Sultana                  modifier, task_dup);
4758540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(exit): T#%d\n", gtid));
4759540007b4SNawrin Sultana }
4760