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...
8288b81524cSAndreyChurbanov #if KMP_DEBUG
8297cc577a4SJonathan Peyton   kmp_int32 children = 0;
8308b81524cSAndreyChurbanov #endif
8313041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_finish(enter): T#%d finishing task %p and resuming "
8323041982dSJonathan Peyton                 "task %p\n",
8337cc577a4SJonathan Peyton                 gtid, taskdata, resumed_task));
8347cc577a4SJonathan Peyton 
8357cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
8367cc577a4SJonathan Peyton 
8377cc577a4SJonathan Peyton // Pop task from stack if tied
8387cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
8393041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
8407cc577a4SJonathan Peyton     __kmp_pop_task_stack(gtid, thread, taskdata);
8417cc577a4SJonathan Peyton   }
8427cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
8437cc577a4SJonathan Peyton 
8446bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
8453041982dSJonathan Peyton     // untied task needs to check the counter so that the task structure is not
8463041982dSJonathan Peyton     // freed prematurely
84737e2ef54SJonathan Peyton     kmp_int32 counter = KMP_ATOMIC_DEC(&taskdata->td_untied_count) - 1;
8483041982dSJonathan Peyton     KA_TRACE(
8493041982dSJonathan Peyton         20,
8503041982dSJonathan Peyton         ("__kmp_task_finish: T#%d untied_count (%d) decremented for task %p\n",
8517cc577a4SJonathan Peyton          gtid, counter, taskdata));
8527cc577a4SJonathan Peyton     if (counter > 0) {
8533041982dSJonathan Peyton       // untied task is not done, to be continued possibly by other thread, do
8543041982dSJonathan Peyton       // not free it now
8557cc577a4SJonathan Peyton       if (resumed_task == NULL) {
8567cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(taskdata->td_flags.task_serial);
8573041982dSJonathan Peyton         resumed_task = taskdata->td_parent; // In a serialized task, the resumed
8583041982dSJonathan Peyton         // task is the parent
8597cc577a4SJonathan Peyton       }
8607cc577a4SJonathan Peyton       thread->th.th_current_task = resumed_task; // restore current_task
8617cc577a4SJonathan Peyton       resumed_task->td_flags.executing = 1; // resume previous task
8623041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_task_finish(exit): T#%d partially done task %p, "
8633041982dSJonathan Peyton                     "resuming task %p\n",
8647cc577a4SJonathan Peyton                     gtid, taskdata, resumed_task));
8657cc577a4SJonathan Peyton       return;
8667cc577a4SJonathan Peyton     }
8677cc577a4SJonathan Peyton   }
8687cc577a4SJonathan Peyton 
869d23131a3SJoachim Protze   // bookkeeping for resuming task:
870d23131a3SJoachim Protze   // GEH - note tasking_ser => task_serial
871d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(
872d23131a3SJoachim Protze       (taskdata->td_flags.tasking_ser || taskdata->td_flags.task_serial) ==
873d23131a3SJoachim Protze       taskdata->td_flags.task_serial);
874d23131a3SJoachim Protze   if (taskdata->td_flags.task_serial) {
875d23131a3SJoachim Protze     if (resumed_task == NULL) {
876d23131a3SJoachim Protze       resumed_task = taskdata->td_parent; // In a serialized task, the resumed
877d23131a3SJoachim Protze       // task is the parent
878d23131a3SJoachim Protze     }
879d23131a3SJoachim Protze   } else {
880d23131a3SJoachim Protze     KMP_DEBUG_ASSERT(resumed_task !=
881d23131a3SJoachim Protze                      NULL); // verify that resumed task is passed as argument
882d23131a3SJoachim Protze   }
883d23131a3SJoachim Protze 
884d23131a3SJoachim Protze   /* If the tasks' destructor thunk flag has been set, we need to invoke the
885d23131a3SJoachim Protze      destructor thunk that has been generated by the compiler. The code is
886d23131a3SJoachim Protze      placed here, since at this point other tasks might have been released
887d23131a3SJoachim Protze      hence overlapping the destructor invocations with some other work in the
888d23131a3SJoachim Protze      released tasks.  The OpenMP spec is not specific on when the destructors
889d23131a3SJoachim Protze      are invoked, so we should be free to choose. */
890838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.destructors_thunk)) {
891d23131a3SJoachim Protze     kmp_routine_entry_t destr_thunk = task->data1.destructors;
892d23131a3SJoachim Protze     KMP_ASSERT(destr_thunk);
893d23131a3SJoachim Protze     destr_thunk(gtid, task);
894d23131a3SJoachim Protze   }
895d23131a3SJoachim Protze 
8967cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
897d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 1);
898d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
899d23131a3SJoachim Protze 
900405037c4SAndrey Churbanov   bool detach = false;
901838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.detachable == TASK_DETACHABLE)) {
902405037c4SAndrey Churbanov     if (taskdata->td_allow_completion_event.type ==
903405037c4SAndrey Churbanov         KMP_EVENT_ALLOW_COMPLETION) {
904405037c4SAndrey Churbanov       // event hasn't been fulfilled yet. Try to detach task.
905405037c4SAndrey Churbanov       __kmp_acquire_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
906405037c4SAndrey Churbanov       if (taskdata->td_allow_completion_event.type ==
907405037c4SAndrey Churbanov           KMP_EVENT_ALLOW_COMPLETION) {
908d23131a3SJoachim Protze         // task finished execution
909d23131a3SJoachim Protze         KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
910d23131a3SJoachim Protze         taskdata->td_flags.executing = 0; // suspend the finishing task
91110995c77SJoachim Protze 
91210995c77SJoachim Protze #if OMPT_SUPPORT
91310995c77SJoachim Protze         // For a detached task, which is not completed, we switch back
91410995c77SJoachim Protze         // the omp_fulfill_event signals completion
91510995c77SJoachim Protze         // locking is necessary to avoid a race with ompt_task_late_fulfill
91610995c77SJoachim Protze         if (ompt)
91710995c77SJoachim Protze           __ompt_task_finish(task, resumed_task, ompt_task_detach);
91810995c77SJoachim Protze #endif
91910995c77SJoachim Protze 
920d23131a3SJoachim Protze         // no access to taskdata after this point!
921d23131a3SJoachim Protze         // __kmp_fulfill_event might free taskdata at any time from now
92210995c77SJoachim Protze 
923405037c4SAndrey Churbanov         taskdata->td_flags.proxy = TASK_PROXY; // proxify!
924405037c4SAndrey Churbanov         detach = true;
925405037c4SAndrey Churbanov       }
926405037c4SAndrey Churbanov       __kmp_release_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
927405037c4SAndrey Churbanov     }
928405037c4SAndrey Churbanov   }
9297cc577a4SJonathan Peyton 
930405037c4SAndrey Churbanov   if (!detach) {
931405037c4SAndrey Churbanov     taskdata->td_flags.complete = 1; // mark the task as completed
932405037c4SAndrey Churbanov 
93310995c77SJoachim Protze #if OMPT_SUPPORT
93410995c77SJoachim Protze     // This is not a detached task, we are done here
93510995c77SJoachim Protze     if (ompt)
93610995c77SJoachim Protze       __ompt_task_finish(task, resumed_task, ompt_task_complete);
93710995c77SJoachim Protze #endif
93810995c77SJoachim Protze 
9393041982dSJonathan Peyton     // Only need to keep track of count if team parallel and tasking not
94057d8b8d6SAndreyChurbanov     // serialized, or task is detachable and event has already been fulfilled
94157d8b8d6SAndreyChurbanov     if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) ||
9429d64275aSShilei Tian         taskdata->td_flags.detachable == TASK_DETACHABLE ||
9439d64275aSShilei Tian         taskdata->td_flags.hidden_helper) {
944c2c43132SShilei Tian       __kmp_release_deps(gtid, taskdata);
9457cc577a4SJonathan Peyton       // Predecrement simulated by "- 1" calculation
9468b81524cSAndreyChurbanov #if KMP_DEBUG
9478b81524cSAndreyChurbanov       children = -1 +
9488b81524cSAndreyChurbanov #endif
9498b81524cSAndreyChurbanov           KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks);
9507cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(children >= 0);
9517cc577a4SJonathan Peyton       if (taskdata->td_taskgroup)
95237e2ef54SJonathan Peyton         KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
953c2c43132SShilei Tian     } else if (task_team && (task_team->tt.tt_found_proxy_tasks ||
954c2c43132SShilei Tian                              task_team->tt.tt_hidden_helper_task_encountered)) {
955c2c43132SShilei Tian       // if we found proxy or hidden helper tasks there could exist a dependency
956c2c43132SShilei Tian       // chain with the proxy task as origin
9577cc577a4SJonathan Peyton       __kmp_release_deps(gtid, taskdata);
9587cc577a4SJonathan Peyton     }
9593041982dSJonathan Peyton     // td_flags.executing must be marked as 0 after __kmp_release_deps has been
960d23131a3SJoachim Protze     // called. Othertwise, if a task is executed immediately from the
961d23131a3SJoachim Protze     // release_deps code, the flag will be reset to 1 again by this same
962d23131a3SJoachim Protze     // function
9637cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
9647cc577a4SJonathan Peyton     taskdata->td_flags.executing = 0; // suspend the finishing task
965d23131a3SJoachim Protze   }
966d23131a3SJoachim Protze 
9673041982dSJonathan Peyton   KA_TRACE(
9683041982dSJonathan Peyton       20, ("__kmp_task_finish: T#%d finished task %p, %d incomplete children\n",
9697cc577a4SJonathan Peyton            gtid, taskdata, children));
9707cc577a4SJonathan Peyton 
9717cc577a4SJonathan Peyton   // Free this task and then ancestor tasks if they have no children.
9727cc577a4SJonathan Peyton   // Restore th_current_task first as suggested by John:
9737cc577a4SJonathan Peyton   // johnmc: if an asynchronous inquiry peers into the runtime system
9747cc577a4SJonathan Peyton   // it doesn't see the freed task as the current task.
9757cc577a4SJonathan Peyton   thread->th.th_current_task = resumed_task;
976405037c4SAndrey Churbanov   if (!detach)
9777cc577a4SJonathan Peyton     __kmp_free_task_and_ancestors(gtid, taskdata, thread);
9787cc577a4SJonathan Peyton 
9797cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
9807cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( resumed_task->td_flags.executing == 0 );
9817cc577a4SJonathan Peyton   resumed_task->td_flags.executing = 1; // resume previous task
9827cc577a4SJonathan Peyton 
9833041982dSJonathan Peyton   KA_TRACE(
9843041982dSJonathan Peyton       10, ("__kmp_task_finish(exit): T#%d finished task %p, resuming task %p\n",
9857cc577a4SJonathan Peyton            gtid, taskdata, resumed_task));
9867cc577a4SJonathan Peyton 
9877cc577a4SJonathan Peyton   return;
9887cc577a4SJonathan Peyton }
9897cc577a4SJonathan Peyton 
99082e94a59SJoachim Protze template <bool ompt>
99182e94a59SJoachim Protze static void __kmpc_omp_task_complete_if0_template(ident_t *loc_ref,
99282e94a59SJoachim Protze                                                   kmp_int32 gtid,
9933041982dSJonathan Peyton                                                   kmp_task_t *task) {
9947cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(enter): T#%d loc=%p task=%p\n",
9957cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
996838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
9973041982dSJonathan Peyton   // this routine will provide task to resume
99886ed6aa6SJoachim Protze   __kmp_task_finish<ompt>(gtid, task, NULL);
9997cc577a4SJonathan Peyton 
10007cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(exit): T#%d loc=%p task=%p\n",
10017cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
100282e94a59SJoachim Protze 
100382e94a59SJoachim Protze #if OMPT_SUPPORT
100482e94a59SJoachim Protze   if (ompt) {
10050e0d6cddSJoachim Protze     ompt_frame_t *ompt_frame;
100682e94a59SJoachim Protze     __ompt_get_task_info_internal(0, NULL, NULL, &ompt_frame, NULL, NULL);
10070e0d6cddSJoachim Protze     ompt_frame->enter_frame = ompt_data_none;
1008309b00a4SShilei Tian     ompt_frame->enter_frame_flags =
1009309b00a4SShilei Tian         ompt_frame_runtime | ompt_frame_framepointer;
101082e94a59SJoachim Protze   }
101182e94a59SJoachim Protze #endif
101282e94a59SJoachim Protze 
10137cc577a4SJonathan Peyton   return;
10147cc577a4SJonathan Peyton }
10157cc577a4SJonathan Peyton 
101682e94a59SJoachim Protze #if OMPT_SUPPORT
101782e94a59SJoachim Protze OMPT_NOINLINE
101882e94a59SJoachim Protze void __kmpc_omp_task_complete_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
101982e94a59SJoachim Protze                                        kmp_task_t *task) {
102082e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<true>(loc_ref, gtid, task);
102182e94a59SJoachim Protze }
102282e94a59SJoachim Protze #endif // OMPT_SUPPORT
102382e94a59SJoachim Protze 
102482e94a59SJoachim Protze // __kmpc_omp_task_complete_if0: report that a task has completed execution
102582e94a59SJoachim Protze //
102682e94a59SJoachim Protze // loc_ref: source location information; points to end of task block.
102782e94a59SJoachim Protze // gtid: global thread number.
102882e94a59SJoachim Protze // task: task thunk for the completed task.
102982e94a59SJoachim Protze void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
103082e94a59SJoachim Protze                                   kmp_task_t *task) {
103182e94a59SJoachim Protze #if OMPT_SUPPORT
103282e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
103382e94a59SJoachim Protze     __kmpc_omp_task_complete_if0_ompt(loc_ref, gtid, task);
103482e94a59SJoachim Protze     return;
103582e94a59SJoachim Protze   }
103682e94a59SJoachim Protze #endif
103782e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<false>(loc_ref, gtid, task);
103882e94a59SJoachim Protze }
103982e94a59SJoachim Protze 
10407cc577a4SJonathan Peyton #ifdef TASK_UNUSED
10417cc577a4SJonathan Peyton // __kmpc_omp_task_complete: report that a task has completed execution
10427cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
10433041982dSJonathan Peyton void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
10443041982dSJonathan Peyton                               kmp_task_t *task) {
10453041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(enter): T#%d loc=%p task=%p\n", gtid,
10463041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10477cc577a4SJonathan Peyton 
104886ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task,
104986ed6aa6SJoachim Protze                            NULL); // Not sure how to find task to resume
10507cc577a4SJonathan Peyton 
10513041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(exit): T#%d loc=%p task=%p\n", gtid,
10523041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10537cc577a4SJonathan Peyton   return;
10547cc577a4SJonathan Peyton }
10557cc577a4SJonathan Peyton #endif // TASK_UNUSED
10567cc577a4SJonathan Peyton 
10573041982dSJonathan Peyton // __kmp_init_implicit_task: Initialize the appropriate fields in the implicit
10583041982dSJonathan Peyton // task for a given thread
10597cc577a4SJonathan Peyton //
10607cc577a4SJonathan Peyton // loc_ref:  reference to source location of parallel region
10617cc577a4SJonathan Peyton // this_thr:  thread data structure corresponding to implicit task
10627cc577a4SJonathan Peyton // team: team for this_thr
10637cc577a4SJonathan Peyton // tid: thread id of given thread within team
10647cc577a4SJonathan Peyton // set_curr_task: TRUE if need to push current task to thread
10653041982dSJonathan Peyton // NOTE: Routine does not set up the implicit task ICVS.  This is assumed to
10663041982dSJonathan Peyton // have already been done elsewhere.
10677cc577a4SJonathan Peyton // TODO: Get better loc_ref.  Value passed in may be NULL
10683041982dSJonathan Peyton void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
10693041982dSJonathan Peyton                               kmp_team_t *team, int tid, int set_curr_task) {
10707cc577a4SJonathan Peyton   kmp_taskdata_t *task = &team->t.t_implicit_task_taskdata[tid];
10717cc577a4SJonathan Peyton 
10723041982dSJonathan Peyton   KF_TRACE(
10733041982dSJonathan Peyton       10,
10743041982dSJonathan Peyton       ("__kmp_init_implicit_task(enter): T#:%d team=%p task=%p, reinit=%s\n",
10757cc577a4SJonathan Peyton        tid, team, task, set_curr_task ? "TRUE" : "FALSE"));
10767cc577a4SJonathan Peyton 
10777cc577a4SJonathan Peyton   task->td_task_id = KMP_GEN_TASK_ID();
10787cc577a4SJonathan Peyton   task->td_team = team;
10793041982dSJonathan Peyton   //    task->td_parent   = NULL;  // fix for CQ230101 (broken parent task info
10803041982dSJonathan Peyton   //    in debugger)
10817cc577a4SJonathan Peyton   task->td_ident = loc_ref;
10827cc577a4SJonathan Peyton   task->td_taskwait_ident = NULL;
10837cc577a4SJonathan Peyton   task->td_taskwait_counter = 0;
10847cc577a4SJonathan Peyton   task->td_taskwait_thread = 0;
10857cc577a4SJonathan Peyton 
10867cc577a4SJonathan Peyton   task->td_flags.tiedness = TASK_TIED;
10877cc577a4SJonathan Peyton   task->td_flags.tasktype = TASK_IMPLICIT;
10887cc577a4SJonathan Peyton   task->td_flags.proxy = TASK_FULL;
10897cc577a4SJonathan Peyton 
10907cc577a4SJonathan Peyton   // All implicit tasks are executed immediately, not deferred
10917cc577a4SJonathan Peyton   task->td_flags.task_serial = 1;
10927cc577a4SJonathan Peyton   task->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
10937cc577a4SJonathan Peyton   task->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
10947cc577a4SJonathan Peyton 
10957cc577a4SJonathan Peyton   task->td_flags.started = 1;
10967cc577a4SJonathan Peyton   task->td_flags.executing = 1;
10977cc577a4SJonathan Peyton   task->td_flags.complete = 0;
10987cc577a4SJonathan Peyton   task->td_flags.freed = 0;
10997cc577a4SJonathan Peyton 
11007cc577a4SJonathan Peyton   task->td_depnode = NULL;
1101a756cb24SAndrey Churbanov   task->td_last_tied = task;
1102405037c4SAndrey Churbanov   task->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
11037cc577a4SJonathan Peyton 
11043041982dSJonathan Peyton   if (set_curr_task) { // only do this init first time thread is created
110537e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_incomplete_child_tasks, 0);
1106642688b6SJonathan Peyton     // Not used: don't need to deallocate implicit task
110737e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_allocated_child_tasks, 0);
11087cc577a4SJonathan Peyton     task->td_taskgroup = NULL; // An implicit task does not have taskgroup
11097cc577a4SJonathan Peyton     task->td_dephash = NULL;
11107cc577a4SJonathan Peyton     __kmp_push_current_task_to_thread(this_thr, team, tid);
11117cc577a4SJonathan Peyton   } else {
11127cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_incomplete_child_tasks == 0);
11137cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_allocated_child_tasks == 0);
11147cc577a4SJonathan Peyton   }
11157cc577a4SJonathan Peyton 
11167cc577a4SJonathan Peyton #if OMPT_SUPPORT
1117f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
111882e94a59SJoachim Protze     __ompt_task_init(task, tid);
11197cc577a4SJonathan Peyton #endif
11207cc577a4SJonathan Peyton 
11213041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_init_implicit_task(exit): T#:%d team=%p task=%p\n", tid,
11223041982dSJonathan Peyton                 team, task));
11237cc577a4SJonathan Peyton }
11247cc577a4SJonathan Peyton 
11253041982dSJonathan Peyton // __kmp_finish_implicit_task: Release resources associated to implicit tasks
11263041982dSJonathan Peyton // at the end of parallel regions. Some resources are kept for reuse in the next
11273041982dSJonathan Peyton // parallel region.
11287cc577a4SJonathan Peyton //
11293041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11303041982dSJonathan Peyton void __kmp_finish_implicit_task(kmp_info_t *thread) {
11317cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1132c3344345SAndrey Churbanov   if (task->td_dephash) {
1133c3344345SAndrey Churbanov     int children;
1134c3344345SAndrey Churbanov     task->td_flags.complete = 1;
1135c3344345SAndrey Churbanov     children = KMP_ATOMIC_LD_ACQ(&task->td_incomplete_child_tasks);
1136c3344345SAndrey Churbanov     kmp_tasking_flags_t flags_old = task->td_flags;
1137c3344345SAndrey Churbanov     if (children == 0 && flags_old.complete == 1) {
1138c3344345SAndrey Churbanov       kmp_tasking_flags_t flags_new = flags_old;
1139c3344345SAndrey Churbanov       flags_new.complete = 0;
1140c3344345SAndrey Churbanov       if (KMP_COMPARE_AND_STORE_ACQ32(RCAST(kmp_int32 *, &task->td_flags),
1141c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_old),
1142c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_new))) {
1143c3344345SAndrey Churbanov         KA_TRACE(100, ("__kmp_finish_implicit_task: T#%d cleans "
1144c3344345SAndrey Churbanov                        "dephash of implicit task %p\n",
1145c3344345SAndrey Churbanov                        thread->th.th_info.ds.ds_gtid, task));
11467cc577a4SJonathan Peyton         __kmp_dephash_free_entries(thread, task->td_dephash);
11477cc577a4SJonathan Peyton       }
1148c3344345SAndrey Churbanov     }
1149c3344345SAndrey Churbanov   }
1150c3344345SAndrey Churbanov }
11517cc577a4SJonathan Peyton 
11523041982dSJonathan Peyton // __kmp_free_implicit_task: Release resources associated to implicit tasks
11533041982dSJonathan Peyton // when these are destroyed regions
11547cc577a4SJonathan Peyton //
11553041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11563041982dSJonathan Peyton void __kmp_free_implicit_task(kmp_info_t *thread) {
11577cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1158bff8ded9SJonathan Peyton   if (task && task->td_dephash) {
11597cc577a4SJonathan Peyton     __kmp_dephash_free(thread, task->td_dephash);
11607cc577a4SJonathan Peyton     task->td_dephash = NULL;
11617cc577a4SJonathan Peyton   }
1162bff8ded9SJonathan Peyton }
11637cc577a4SJonathan Peyton 
11643041982dSJonathan Peyton // Round up a size to a power of two specified by val: Used to insert padding
11653041982dSJonathan Peyton // between structures co-allocated using a single malloc() call
11663041982dSJonathan Peyton static size_t __kmp_round_up_to_val(size_t size, size_t val) {
11677cc577a4SJonathan Peyton   if (size & (val - 1)) {
11687cc577a4SJonathan Peyton     size &= ~(val - 1);
11697cc577a4SJonathan Peyton     if (size <= KMP_SIZE_T_MAX - val) {
11707cc577a4SJonathan Peyton       size += val; // Round up if there is no overflow.
1171bd3a7633SJonathan Peyton     }
1172bd3a7633SJonathan Peyton   }
11737cc577a4SJonathan Peyton   return size;
11747cc577a4SJonathan Peyton } // __kmp_round_up_to_va
11757cc577a4SJonathan Peyton 
11767cc577a4SJonathan Peyton // __kmp_task_alloc: Allocate the taskdata and task data structures for a task
11777cc577a4SJonathan Peyton //
11787cc577a4SJonathan Peyton // loc_ref: source location information
11797cc577a4SJonathan Peyton // gtid: global thread number.
11803041982dSJonathan Peyton // flags: include tiedness & task type (explicit vs. implicit) of the ''new''
11813041982dSJonathan Peyton // task encountered. Converted from kmp_int32 to kmp_tasking_flags_t in routine.
11823041982dSJonathan Peyton // sizeof_kmp_task_t:  Size in bytes of kmp_task_t data structure including
11833041982dSJonathan Peyton // private vars accessed in task.
11843041982dSJonathan Peyton // sizeof_shareds:  Size in bytes of array of pointers to shared vars accessed
11853041982dSJonathan Peyton // in task.
11867cc577a4SJonathan Peyton // task_entry: Pointer to task code entry point generated by compiler.
11877cc577a4SJonathan Peyton // returns: a pointer to the allocated kmp_task_t structure (task).
11883041982dSJonathan Peyton kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
11893041982dSJonathan Peyton                              kmp_tasking_flags_t *flags,
11907cc577a4SJonathan Peyton                              size_t sizeof_kmp_task_t, size_t sizeof_shareds,
11913041982dSJonathan Peyton                              kmp_routine_entry_t task_entry) {
11927cc577a4SJonathan Peyton   kmp_task_t *task;
11937cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
11947cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
11957cc577a4SJonathan Peyton   kmp_team_t *team = thread->th.th_team;
11967cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
11977cc577a4SJonathan Peyton   size_t shareds_offset;
11987cc577a4SJonathan Peyton 
11996bf84871SAndreyChurbanov   if (UNLIKELY(!TCR_4(__kmp_init_middle)))
120028226e7dSJonathan Peyton     __kmp_middle_initialize();
120128226e7dSJonathan Peyton 
12029d64275aSShilei Tian   if (flags->hidden_helper) {
12039d64275aSShilei Tian     if (__kmp_enable_hidden_helper) {
12049d64275aSShilei Tian       if (!TCR_4(__kmp_init_hidden_helper))
12059d64275aSShilei Tian         __kmp_hidden_helper_initialize();
12069d64275aSShilei Tian     } else {
12079d64275aSShilei Tian       // If the hidden helper task is not enabled, reset the flag to FALSE.
12089d64275aSShilei Tian       flags->hidden_helper = FALSE;
12099d64275aSShilei Tian     }
12109d64275aSShilei Tian   }
12119d64275aSShilei Tian 
12127cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_task_alloc(enter): T#%d loc=%p, flags=(0x%x) "
12137cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12147cc577a4SJonathan Peyton                 gtid, loc_ref, *((kmp_int32 *)flags), sizeof_kmp_task_t,
12157cc577a4SJonathan Peyton                 sizeof_shareds, task_entry));
12167cc577a4SJonathan Peyton 
1217467f3924SHansang Bae   KMP_DEBUG_ASSERT(parent_task);
12187cc577a4SJonathan Peyton   if (parent_task->td_flags.final) {
12197cc577a4SJonathan Peyton     if (flags->merged_if0) {
12207cc577a4SJonathan Peyton     }
12217cc577a4SJonathan Peyton     flags->final = 1;
12227cc577a4SJonathan Peyton   }
12239d64275aSShilei Tian 
1224a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED && !team->t.t_serialized) {
1225a756cb24SAndrey Churbanov     // Untied task encountered causes the TSC algorithm to check entire deque of
1226a756cb24SAndrey Churbanov     // the victim thread. If no untied task encountered, then checking the head
1227a756cb24SAndrey Churbanov     // of the deque should be enough.
1228*680c71b1SShilei Tian     KMP_CHECK_UPDATE(thread->th.th_task_team->tt.tt_untied_task_encountered, 1);
1229a756cb24SAndrey Churbanov   }
12307cc577a4SJonathan Peyton 
1231405037c4SAndrey Churbanov   // Detachable tasks are not proxy tasks yet but could be in the future. Doing
1232405037c4SAndrey Churbanov   // the tasking setup
1233405037c4SAndrey Churbanov   // when that happens is too late.
1234838dcdb5SAndreyChurbanov   if (UNLIKELY(flags->proxy == TASK_PROXY ||
1235838dcdb5SAndreyChurbanov                flags->detachable == TASK_DETACHABLE || flags->hidden_helper)) {
12367cc577a4SJonathan Peyton     if (flags->proxy == TASK_PROXY) {
12377cc577a4SJonathan Peyton       flags->tiedness = TASK_UNTIED;
12387cc577a4SJonathan Peyton       flags->merged_if0 = 1;
1239405037c4SAndrey Churbanov     }
12403041982dSJonathan Peyton     /* are we running in a sequential parallel or tskm_immediate_exec... we need
12413041982dSJonathan Peyton        tasking support enabled */
1242*680c71b1SShilei Tian     if ((thread->th.th_task_team) == NULL) {
12437cc577a4SJonathan Peyton       /* This should only happen if the team is serialized
12443041982dSJonathan Peyton           setup a task team and propagate it to the thread */
12457cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(team->t.t_serialized);
12463041982dSJonathan Peyton       KA_TRACE(30,
12473041982dSJonathan Peyton                ("T#%d creating task team in __kmp_task_alloc for proxy task\n",
12483041982dSJonathan Peyton                 gtid));
1249*680c71b1SShilei Tian       // 1 indicates setup the current team regardless of nthreads
1250*680c71b1SShilei Tian       __kmp_task_team_setup(thread, team, 1);
1251*680c71b1SShilei Tian       thread->th.th_task_team = team->t.t_task_team[thread->th.th_task_state];
12527cc577a4SJonathan Peyton     }
1253*680c71b1SShilei Tian     kmp_task_team_t *task_team = thread->th.th_task_team;
12547cc577a4SJonathan Peyton 
12557cc577a4SJonathan Peyton     /* tasking must be enabled now as the task might not be pushed */
12567cc577a4SJonathan Peyton     if (!KMP_TASKING_ENABLED(task_team)) {
12573041982dSJonathan Peyton       KA_TRACE(
12583041982dSJonathan Peyton           30,
12593041982dSJonathan Peyton           ("T#%d enabling tasking in __kmp_task_alloc for proxy task\n", gtid));
1260*680c71b1SShilei Tian       __kmp_enable_tasking(task_team, thread);
1261*680c71b1SShilei Tian       kmp_int32 tid = thread->th.th_info.ds.ds_tid;
12627cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
12637cc577a4SJonathan Peyton       // No lock needed since only owner can allocate
12647cc577a4SJonathan Peyton       if (thread_data->td.td_deque == NULL) {
1265*680c71b1SShilei Tian         __kmp_alloc_task_deque(thread, thread_data);
12667cc577a4SJonathan Peyton       }
12677cc577a4SJonathan Peyton     }
12687cc577a4SJonathan Peyton 
12693c31b784SShilei Tian     if ((flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE) &&
12709d64275aSShilei Tian         task_team->tt.tt_found_proxy_tasks == FALSE)
12717cc577a4SJonathan Peyton       TCW_4(task_team->tt.tt_found_proxy_tasks, TRUE);
12729d64275aSShilei Tian     if (flags->hidden_helper &&
12739d64275aSShilei Tian         task_team->tt.tt_hidden_helper_task_encountered == FALSE)
12749d64275aSShilei Tian       TCW_4(task_team->tt.tt_hidden_helper_task_encountered, TRUE);
12757cc577a4SJonathan Peyton   }
12767cc577a4SJonathan Peyton 
12777cc577a4SJonathan Peyton   // Calculate shared structure offset including padding after kmp_task_t struct
12787cc577a4SJonathan Peyton   // to align pointers in shared struct
12797cc577a4SJonathan Peyton   shareds_offset = sizeof(kmp_taskdata_t) + sizeof_kmp_task_t;
12807cc577a4SJonathan Peyton   shareds_offset = __kmp_round_up_to_val(shareds_offset, sizeof(void *));
12817cc577a4SJonathan Peyton 
12827cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
12833041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d First malloc size: %ld\n", gtid,
12843041982dSJonathan Peyton                 shareds_offset));
12853041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d Second malloc size: %ld\n", gtid,
12863041982dSJonathan Peyton                 sizeof_shareds));
12877cc577a4SJonathan Peyton 
12887cc577a4SJonathan Peyton   // Avoid double allocation here by combining shareds with taskdata
12897cc577a4SJonathan Peyton #if USE_FAST_MEMORY
1290*680c71b1SShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, shareds_offset +
1291*680c71b1SShilei Tian                                                                sizeof_shareds);
12927cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
1293*680c71b1SShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, shareds_offset +
1294*680c71b1SShilei Tian                                                                sizeof_shareds);
12957cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
12967cc577a4SJonathan Peyton 
12977cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
12987cc577a4SJonathan Peyton 
12997cc577a4SJonathan Peyton // Make sure task & taskdata are aligned appropriately
13007cc577a4SJonathan Peyton #if KMP_ARCH_X86 || KMP_ARCH_PPC64 || !KMP_HAVE_QUAD
13017cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(double) - 1)) == 0);
13027cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(double) - 1)) == 0);
13037cc577a4SJonathan Peyton #else
13047cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(_Quad) - 1)) == 0);
13057cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(_Quad) - 1)) == 0);
13067cc577a4SJonathan Peyton #endif
13077cc577a4SJonathan Peyton   if (sizeof_shareds > 0) {
13087cc577a4SJonathan Peyton     // Avoid double allocation here by combining shareds with taskdata
13097cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
13107cc577a4SJonathan Peyton     // Make sure shareds struct is aligned to pointer size
13113041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
13123041982dSJonathan Peyton                      0);
13137cc577a4SJonathan Peyton   } else {
13147cc577a4SJonathan Peyton     task->shareds = NULL;
13157cc577a4SJonathan Peyton   }
13167cc577a4SJonathan Peyton   task->routine = task_entry;
13177cc577a4SJonathan Peyton   task->part_id = 0; // AC: Always start with 0 part id
13187cc577a4SJonathan Peyton 
13197cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
13209d64275aSShilei Tian   taskdata->td_team = thread->th.th_team;
1321*680c71b1SShilei Tian   taskdata->td_alloc_thread = thread;
13227cc577a4SJonathan Peyton   taskdata->td_parent = parent_task;
13237cc577a4SJonathan Peyton   taskdata->td_level = parent_task->td_level + 1; // increment nesting level
132437e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_untied_count, 0);
13257cc577a4SJonathan Peyton   taskdata->td_ident = loc_ref;
13267cc577a4SJonathan Peyton   taskdata->td_taskwait_ident = NULL;
13277cc577a4SJonathan Peyton   taskdata->td_taskwait_counter = 0;
13287cc577a4SJonathan Peyton   taskdata->td_taskwait_thread = 0;
13297cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_parent != NULL);
13307cc577a4SJonathan Peyton   // avoid copying icvs for proxy tasks
13317cc577a4SJonathan Peyton   if (flags->proxy == TASK_FULL)
13327cc577a4SJonathan Peyton     copy_icvs(&taskdata->td_icvs, &taskdata->td_parent->td_icvs);
13337cc577a4SJonathan Peyton 
1334db635a28SHansang Bae   taskdata->td_flags = *flags;
13357cc577a4SJonathan Peyton   taskdata->td_task_team = thread->th.th_task_team;
13367cc577a4SJonathan Peyton   taskdata->td_size_alloc = shareds_offset + sizeof_shareds;
13377cc577a4SJonathan Peyton   taskdata->td_flags.tasktype = TASK_EXPLICIT;
1338*680c71b1SShilei Tian   // If it is hidden helper task, we need to set the team and task team
1339*680c71b1SShilei Tian   // correspondingly.
1340*680c71b1SShilei Tian   if (flags->hidden_helper) {
1341*680c71b1SShilei Tian     kmp_info_t *shadow_thread = __kmp_threads[KMP_GTID_TO_SHADOW_GTID(gtid)];
1342*680c71b1SShilei Tian     taskdata->td_team = shadow_thread->th.th_team;
1343*680c71b1SShilei Tian     taskdata->td_task_team = shadow_thread->th.th_task_team;
1344*680c71b1SShilei Tian   }
13457cc577a4SJonathan Peyton 
13467cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of tasking_ser flag
13477cc577a4SJonathan Peyton   taskdata->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
13487cc577a4SJonathan Peyton 
13497cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of team_serial flag
13507cc577a4SJonathan Peyton   taskdata->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
13517cc577a4SJonathan Peyton 
13523041982dSJonathan Peyton   // GEH - Note we serialize the task if the team is serialized to make sure
13533041982dSJonathan Peyton   // implicit parallel region tasks are not left until program termination to
13543041982dSJonathan Peyton   // execute. Also, it helps locality to execute immediately.
13553041982dSJonathan Peyton 
13563041982dSJonathan Peyton   taskdata->td_flags.task_serial =
13573041982dSJonathan Peyton       (parent_task->td_flags.final || taskdata->td_flags.team_serial ||
1358add8d90cSJoachim Protze        taskdata->td_flags.tasking_ser || flags->merged_if0);
13597cc577a4SJonathan Peyton 
13607cc577a4SJonathan Peyton   taskdata->td_flags.started = 0;
13617cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0;
13627cc577a4SJonathan Peyton   taskdata->td_flags.complete = 0;
13637cc577a4SJonathan Peyton   taskdata->td_flags.freed = 0;
13647cc577a4SJonathan Peyton 
136537e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_incomplete_child_tasks, 0);
136637e2ef54SJonathan Peyton   // start at one because counts current task and children
136737e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_allocated_child_tasks, 1);
13683041982dSJonathan Peyton   taskdata->td_taskgroup =
13693041982dSJonathan Peyton       parent_task->td_taskgroup; // task inherits taskgroup from the parent task
13707cc577a4SJonathan Peyton   taskdata->td_dephash = NULL;
13717cc577a4SJonathan Peyton   taskdata->td_depnode = NULL;
1372a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED)
1373a756cb24SAndrey Churbanov     taskdata->td_last_tied = NULL; // will be set when the task is scheduled
1374a756cb24SAndrey Churbanov   else
1375a756cb24SAndrey Churbanov     taskdata->td_last_tied = taskdata;
1376405037c4SAndrey Churbanov   taskdata->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
137786ed6aa6SJoachim Protze #if OMPT_SUPPORT
137886ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled))
137986ed6aa6SJoachim Protze     __ompt_task_init(taskdata, gtid);
138086ed6aa6SJoachim Protze #endif
13819d64275aSShilei Tian   // Only need to keep track of child task counts if team parallel and tasking
13829d64275aSShilei Tian   // not serialized or if it is a proxy or detachable or hidden helper task
13839d64275aSShilei Tian   if (flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE ||
13849d64275aSShilei Tian       flags->hidden_helper ||
13859d64275aSShilei Tian       !(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
138637e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
13877cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
138837e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
13893041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
13903041982dSJonathan Peyton     // implicit not deallocated
13917cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT) {
139237e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
13937cc577a4SJonathan Peyton     }
13949d64275aSShilei Tian     if (flags->hidden_helper) {
13959d64275aSShilei Tian       taskdata->td_flags.task_serial = FALSE;
13969d64275aSShilei Tian       // Increment the number of hidden helper tasks to be executed
13979d64275aSShilei Tian       KMP_ATOMIC_INC(&__kmp_unexecuted_hidden_helper_tasks);
13989d64275aSShilei Tian     }
1399db635a28SHansang Bae   }
14009d64275aSShilei Tian 
14017cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_task_alloc(exit): T#%d created task %p parent=%p\n",
14027cc577a4SJonathan Peyton                 gtid, taskdata, taskdata->td_parent));
14037cc577a4SJonathan Peyton 
14047cc577a4SJonathan Peyton   return task;
14057cc577a4SJonathan Peyton }
14067cc577a4SJonathan Peyton 
14073041982dSJonathan Peyton kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
14083041982dSJonathan Peyton                                   kmp_int32 flags, size_t sizeof_kmp_task_t,
14093041982dSJonathan Peyton                                   size_t sizeof_shareds,
14103041982dSJonathan Peyton                                   kmp_routine_entry_t task_entry) {
14117cc577a4SJonathan Peyton   kmp_task_t *retval;
14127cc577a4SJonathan Peyton   kmp_tasking_flags_t *input_flags = (kmp_tasking_flags_t *)&flags;
1413787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
14147cc577a4SJonathan Peyton   input_flags->native = FALSE;
14157cc577a4SJonathan Peyton   // __kmp_task_alloc() sets up all other runtime flags
1416405037c4SAndrey Churbanov   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s %s %s) "
1417405037c4SAndrey Churbanov                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
1418405037c4SAndrey Churbanov                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
1419405037c4SAndrey Churbanov                 input_flags->proxy ? "proxy" : "",
1420405037c4SAndrey Churbanov                 input_flags->detachable ? "detachable" : "", sizeof_kmp_task_t,
1421405037c4SAndrey Churbanov                 sizeof_shareds, task_entry));
14227cc577a4SJonathan Peyton 
14237cc577a4SJonathan Peyton   retval = __kmp_task_alloc(loc_ref, gtid, input_flags, sizeof_kmp_task_t,
14247cc577a4SJonathan Peyton                             sizeof_shareds, task_entry);
14257cc577a4SJonathan Peyton 
14267cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmpc_omp_task_alloc(exit): T#%d retval %p\n", gtid, retval));
14277cc577a4SJonathan Peyton 
14287cc577a4SJonathan Peyton   return retval;
14297cc577a4SJonathan Peyton }
14307cc577a4SJonathan Peyton 
1431b48e44a6SGheorghe-Teodor Bercea kmp_task_t *__kmpc_omp_target_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
1432b48e44a6SGheorghe-Teodor Bercea                                          kmp_int32 flags,
1433b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_kmp_task_t,
1434b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_shareds,
1435b48e44a6SGheorghe-Teodor Bercea                                          kmp_routine_entry_t task_entry,
1436b48e44a6SGheorghe-Teodor Bercea                                          kmp_int64 device_id) {
14379d64275aSShilei Tian   if (__kmp_enable_hidden_helper) {
14389d64275aSShilei Tian     auto &input_flags = reinterpret_cast<kmp_tasking_flags_t &>(flags);
14399d64275aSShilei Tian     input_flags.hidden_helper = TRUE;
14409f5d6ea5SShilei Tian     input_flags.tiedness = TASK_UNTIED;
14419d64275aSShilei Tian   }
14429d64275aSShilei Tian 
1443b48e44a6SGheorghe-Teodor Bercea   return __kmpc_omp_task_alloc(loc_ref, gtid, flags, sizeof_kmp_task_t,
1444b48e44a6SGheorghe-Teodor Bercea                                sizeof_shareds, task_entry);
1445b48e44a6SGheorghe-Teodor Bercea }
1446b48e44a6SGheorghe-Teodor Bercea 
1447b04f7d68SJonathan Peyton /*!
1448b04f7d68SJonathan Peyton @ingroup TASKING
1449b04f7d68SJonathan Peyton @param loc_ref location of the original task directive
1450b04f7d68SJonathan Peyton @param gtid Global Thread ID of encountering thread
1451b04f7d68SJonathan Peyton @param new_task task thunk allocated by __kmpc_omp_task_alloc() for the ''new
1452b04f7d68SJonathan Peyton task''
1453b04f7d68SJonathan Peyton @param naffins Number of affinity items
1454b04f7d68SJonathan Peyton @param affin_list List of affinity items
1455b04f7d68SJonathan Peyton @return Returns non-zero if registering affinity information was not successful.
1456b04f7d68SJonathan Peyton  Returns 0 if registration was successful
1457b04f7d68SJonathan Peyton This entry registers the affinity information attached to a task with the task
1458b04f7d68SJonathan Peyton thunk structure kmp_taskdata_t.
1459b04f7d68SJonathan Peyton */
1460b04f7d68SJonathan Peyton kmp_int32
1461b04f7d68SJonathan Peyton __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref, kmp_int32 gtid,
1462b04f7d68SJonathan Peyton                                   kmp_task_t *new_task, kmp_int32 naffins,
1463b04f7d68SJonathan Peyton                                   kmp_task_affinity_info_t *affin_list) {
1464b04f7d68SJonathan Peyton   return 0;
1465b04f7d68SJonathan Peyton }
1466b04f7d68SJonathan Peyton 
14677cc577a4SJonathan Peyton //  __kmp_invoke_task: invoke the specified task
14687cc577a4SJonathan Peyton //
14697cc577a4SJonathan Peyton // gtid: global thread ID of caller
14707cc577a4SJonathan Peyton // task: the task to invoke
147142016791SKazuaki Ishizaki // current_task: the task to resume after task invocation
14723041982dSJonathan Peyton static void __kmp_invoke_task(kmp_int32 gtid, kmp_task_t *task,
14733041982dSJonathan Peyton                               kmp_taskdata_t *current_task) {
14747cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
1475b1b221c8SJonathan Peyton   kmp_info_t *thread;
14767cc577a4SJonathan Peyton   int discard = 0 /* false */;
14773041982dSJonathan Peyton   KA_TRACE(
14783041982dSJonathan Peyton       30, ("__kmp_invoke_task(enter): T#%d invoking task %p, current_task=%p\n",
14797cc577a4SJonathan Peyton            gtid, taskdata, current_task));
14807cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task);
14816bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.proxy == TASK_PROXY &&
14826bf84871SAndreyChurbanov                taskdata->td_flags.complete == 1)) {
14837cc577a4SJonathan Peyton     // This is a proxy task that was already completed but it needs to run
14847cc577a4SJonathan Peyton     // its bottom-half finish
14853041982dSJonathan Peyton     KA_TRACE(
14863041982dSJonathan Peyton         30,
14873041982dSJonathan Peyton         ("__kmp_invoke_task: T#%d running bottom finish for proxy task %p\n",
14887cc577a4SJonathan Peyton          gtid, taskdata));
14897cc577a4SJonathan Peyton 
14907cc577a4SJonathan Peyton     __kmp_bottom_half_finish_proxy(gtid, task);
14917cc577a4SJonathan Peyton 
14923041982dSJonathan Peyton     KA_TRACE(30, ("__kmp_invoke_task(exit): T#%d completed bottom finish for "
14933041982dSJonathan Peyton                   "proxy task %p, resuming task %p\n",
14943041982dSJonathan Peyton                   gtid, taskdata, current_task));
14957cc577a4SJonathan Peyton 
14967cc577a4SJonathan Peyton     return;
14977cc577a4SJonathan Peyton   }
14987cc577a4SJonathan Peyton 
14997cc577a4SJonathan Peyton #if OMPT_SUPPORT
150086ed6aa6SJoachim Protze   // For untied tasks, the first task executed only calls __kmpc_omp_task and
150186ed6aa6SJoachim Protze   // does not execute code.
15027cc577a4SJonathan Peyton   ompt_thread_info_t oldInfo;
1503f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
15047cc577a4SJonathan Peyton     // Store the threads states and restore them after the task
15057cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
15067cc577a4SJonathan Peyton     oldInfo = thread->th.ompt_thread_info;
15077cc577a4SJonathan Peyton     thread->th.ompt_thread_info.wait_id = 0;
150882e94a59SJoachim Protze     thread->th.ompt_thread_info.state = (thread->th.th_team_serialized)
15090e0d6cddSJoachim Protze                                             ? ompt_state_work_serial
15100e0d6cddSJoachim Protze                                             : ompt_state_work_parallel;
15110e0d6cddSJoachim Protze     taskdata->ompt_task_info.frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
15127cc577a4SJonathan Peyton   }
15137cc577a4SJonathan Peyton #endif
15147cc577a4SJonathan Peyton 
15159d64275aSShilei Tian   // Decreament the counter of hidden helper tasks to be executed
15169d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
15179d64275aSShilei Tian     // Hidden helper tasks can only be executed by hidden helper threads
15189d64275aSShilei Tian     KMP_ASSERT(KMP_HIDDEN_HELPER_THREAD(gtid));
15199d64275aSShilei Tian     KMP_ATOMIC_DEC(&__kmp_unexecuted_hidden_helper_tasks);
15209d64275aSShilei Tian   }
15219d64275aSShilei Tian 
152286ed6aa6SJoachim Protze   // Proxy tasks are not handled by the runtime
152386ed6aa6SJoachim Protze   if (taskdata->td_flags.proxy != TASK_PROXY) {
152486ed6aa6SJoachim Protze     __kmp_task_start(gtid, task, current_task); // OMPT only if not discarded
152586ed6aa6SJoachim Protze   }
152686ed6aa6SJoachim Protze 
15277cc577a4SJonathan Peyton   // TODO: cancel tasks if the parallel region has also been cancelled
15287cc577a4SJonathan Peyton   // TODO: check if this sequence can be hoisted above __kmp_task_start
15297cc577a4SJonathan Peyton   // if cancellation has been enabled for this run ...
15306bf84871SAndreyChurbanov   if (UNLIKELY(__kmp_omp_cancellation)) {
1531b1b221c8SJonathan Peyton     thread = __kmp_threads[gtid];
1532b1b221c8SJonathan Peyton     kmp_team_t *this_team = thread->th.th_team;
15337cc577a4SJonathan Peyton     kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
15343041982dSJonathan Peyton     if ((taskgroup && taskgroup->cancel_request) ||
15353041982dSJonathan Peyton         (this_team->t.t_cancel_request == cancel_parallel)) {
153682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
153782e94a59SJoachim Protze       ompt_data_t *task_data;
1538f0a1c65fSJonas Hahnfeld       if (UNLIKELY(ompt_enabled.ompt_callback_cancel)) {
153982e94a59SJoachim Protze         __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
154082e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_cancel)(
154182e94a59SJoachim Protze             task_data,
154282e94a59SJoachim Protze             ((taskgroup && taskgroup->cancel_request) ? ompt_cancel_taskgroup
154382e94a59SJoachim Protze                                                       : ompt_cancel_parallel) |
154482e94a59SJoachim Protze                 ompt_cancel_discarded_task,
154582e94a59SJoachim Protze             NULL);
154682e94a59SJoachim Protze       }
154782e94a59SJoachim Protze #endif
15487cc577a4SJonathan Peyton       KMP_COUNT_BLOCK(TASK_cancelled);
15497cc577a4SJonathan Peyton       // this task belongs to a task group and we need to cancel it
15507cc577a4SJonathan Peyton       discard = 1 /* true */;
15517cc577a4SJonathan Peyton     }
15527cc577a4SJonathan Peyton   }
15537cc577a4SJonathan Peyton 
15547cc577a4SJonathan Peyton   // Invoke the task routine and pass in relevant data.
15557cc577a4SJonathan Peyton   // Thunks generated by gcc take a different argument list.
15567cc577a4SJonathan Peyton   if (!discard) {
1557a756cb24SAndrey Churbanov     if (taskdata->td_flags.tiedness == TASK_UNTIED) {
1558a756cb24SAndrey Churbanov       taskdata->td_last_tied = current_task->td_last_tied;
1559a756cb24SAndrey Churbanov       KMP_DEBUG_ASSERT(taskdata->td_last_tied);
1560a756cb24SAndrey Churbanov     }
15617cc577a4SJonathan Peyton #if KMP_STATS_ENABLED
15627cc577a4SJonathan Peyton     KMP_COUNT_BLOCK(TASK_executed);
15637cc577a4SJonathan Peyton     switch (KMP_GET_THREAD_STATE()) {
15643041982dSJonathan Peyton     case FORK_JOIN_BARRIER:
15653041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_join_bar);
15663041982dSJonathan Peyton       break;
15673041982dSJonathan Peyton     case PLAIN_BARRIER:
15683041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_plain_bar);
15693041982dSJonathan Peyton       break;
15703041982dSJonathan Peyton     case TASKYIELD:
15713041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskyield);
15723041982dSJonathan Peyton       break;
15733041982dSJonathan Peyton     case TASKWAIT:
15743041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskwait);
15753041982dSJonathan Peyton       break;
15763041982dSJonathan Peyton     case TASKGROUP:
15773041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskgroup);
15783041982dSJonathan Peyton       break;
15793041982dSJonathan Peyton     default:
15803041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_immediate);
15813041982dSJonathan Peyton       break;
15827cc577a4SJonathan Peyton     }
15837cc577a4SJonathan Peyton #endif // KMP_STATS_ENABLED
15847cc577a4SJonathan Peyton 
158582e94a59SJoachim Protze // OMPT task begin
158682e94a59SJoachim Protze #if OMPT_SUPPORT
1587f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.enabled))
158882e94a59SJoachim Protze       __ompt_task_start(task, current_task, gtid);
15897cc577a4SJonathan Peyton #endif
15907cc577a4SJonathan Peyton 
1591f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1592f61602b0SVignesh Balasubramanian     if (ompd_state & OMPD_ENABLE_BP)
1593f61602b0SVignesh Balasubramanian       ompd_bp_task_begin();
1594f61602b0SVignesh Balasubramanian #endif
1595f61602b0SVignesh Balasubramanian 
1596b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1597b1b221c8SJonathan Peyton     kmp_uint64 cur_time;
1598b1b221c8SJonathan Peyton     kmp_int32 kmp_itt_count_task =
1599b1b221c8SJonathan Peyton         __kmp_forkjoin_frames_mode == 3 && !taskdata->td_flags.task_serial &&
1600b1b221c8SJonathan Peyton         current_task->td_flags.tasktype == TASK_IMPLICIT;
1601b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1602b1b221c8SJonathan Peyton       thread = __kmp_threads[gtid];
1603b1b221c8SJonathan Peyton       // Time outer level explicit task on barrier for adjusting imbalance time
1604b1b221c8SJonathan Peyton       if (thread->th.th_bar_arrive_time)
1605b1b221c8SJonathan Peyton         cur_time = __itt_get_timestamp();
1606b1b221c8SJonathan Peyton       else
1607b1b221c8SJonathan Peyton         kmp_itt_count_task = 0; // thread is not on a barrier - skip timing
1608b1b221c8SJonathan Peyton     }
1609ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquired self (new task)
1610b1b221c8SJonathan Peyton #endif
1611b1b221c8SJonathan Peyton 
16127cc577a4SJonathan Peyton #ifdef KMP_GOMP_COMPAT
16137cc577a4SJonathan Peyton     if (taskdata->td_flags.native) {
16147cc577a4SJonathan Peyton       ((void (*)(void *))(*(task->routine)))(task->shareds);
16153041982dSJonathan Peyton     } else
16167cc577a4SJonathan Peyton #endif /* KMP_GOMP_COMPAT */
16177cc577a4SJonathan Peyton     {
16187cc577a4SJonathan Peyton       (*(task->routine))(gtid, task);
16197cc577a4SJonathan Peyton     }
16207cc577a4SJonathan Peyton     KMP_POP_PARTITIONED_TIMER();
16217cc577a4SJonathan Peyton 
1622b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1623b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1624b1b221c8SJonathan Peyton       // Barrier imbalance - adjust arrive time with the task duration
1625b1b221c8SJonathan Peyton       thread->th.th_bar_arrive_time += (__itt_get_timestamp() - cur_time);
1626b1b221c8SJonathan Peyton     }
1627ffd8f009SAndreyChurbanov     KMP_FSYNC_CANCEL(taskdata); // destroy self (just executed)
1628ffd8f009SAndreyChurbanov     KMP_FSYNC_RELEASING(taskdata->td_parent); // releasing parent
1629b1b221c8SJonathan Peyton #endif
16307cc577a4SJonathan Peyton   }
16317cc577a4SJonathan Peyton 
1632f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1633f61602b0SVignesh Balasubramanian   if (ompd_state & OMPD_ENABLE_BP)
1634f61602b0SVignesh Balasubramanian     ompd_bp_task_end();
1635f61602b0SVignesh Balasubramanian #endif
1636f61602b0SVignesh Balasubramanian 
16377cc577a4SJonathan Peyton   // Proxy tasks are not handled by the runtime
16387cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy != TASK_PROXY) {
163986ed6aa6SJoachim Protze #if OMPT_SUPPORT
164086ed6aa6SJoachim Protze     if (UNLIKELY(ompt_enabled.enabled)) {
164186ed6aa6SJoachim Protze       thread->th.ompt_thread_info = oldInfo;
164286ed6aa6SJoachim Protze       if (taskdata->td_flags.tiedness == TASK_TIED) {
16430e0d6cddSJoachim Protze         taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
164486ed6aa6SJoachim Protze       }
164586ed6aa6SJoachim Protze       __kmp_task_finish<true>(gtid, task, current_task);
164686ed6aa6SJoachim Protze     } else
164786ed6aa6SJoachim Protze #endif
164886ed6aa6SJoachim Protze       __kmp_task_finish<false>(gtid, task, current_task);
16497cc577a4SJonathan Peyton   }
16507cc577a4SJonathan Peyton 
16513041982dSJonathan Peyton   KA_TRACE(
16523041982dSJonathan Peyton       30,
16533041982dSJonathan Peyton       ("__kmp_invoke_task(exit): T#%d completed task %p, resuming task %p\n",
16547cc577a4SJonathan Peyton        gtid, taskdata, current_task));
16557cc577a4SJonathan Peyton   return;
16567cc577a4SJonathan Peyton }
16577cc577a4SJonathan Peyton 
16587cc577a4SJonathan Peyton // __kmpc_omp_task_parts: Schedule a thread-switchable task for execution
16597cc577a4SJonathan Peyton //
16607cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
16617cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
16627cc577a4SJonathan Peyton // new_task: task thunk allocated by __kmp_omp_task_alloc() for the ''new task''
16637cc577a4SJonathan Peyton // Returns:
16643041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
16653041982dSJonathan Peyton //    be resumed later.
16663041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
16673041982dSJonathan Peyton //    resumed later.
16683041982dSJonathan Peyton kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
16693041982dSJonathan Peyton                                 kmp_task_t *new_task) {
16707cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
16717cc577a4SJonathan Peyton 
16723041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_parts(enter): T#%d loc=%p task=%p\n", gtid,
16733041982dSJonathan Peyton                 loc_ref, new_taskdata));
16747cc577a4SJonathan Peyton 
167582e94a59SJoachim Protze #if OMPT_SUPPORT
167682e94a59SJoachim Protze   kmp_taskdata_t *parent;
1677f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
167882e94a59SJoachim Protze     parent = new_taskdata->td_parent;
167982e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
168082e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1681467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
168282e94a59SJoachim Protze           &(new_taskdata->ompt_task_info.task_data), ompt_task_explicit, 0,
168382e94a59SJoachim Protze           OMPT_GET_RETURN_ADDRESS(0));
168482e94a59SJoachim Protze     }
168582e94a59SJoachim Protze   }
168682e94a59SJoachim Protze #endif
168782e94a59SJoachim Protze 
16883041982dSJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
16893041982dSJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
16907cc577a4SJonathan Peyton 
16917cc577a4SJonathan Peyton   if (__kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
16927cc577a4SJonathan Peyton   { // Execute this task immediately
16937cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
16947cc577a4SJonathan Peyton     new_taskdata->td_flags.task_serial = 1;
16957cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
16967cc577a4SJonathan Peyton   }
16977cc577a4SJonathan Peyton 
16983041982dSJonathan Peyton   KA_TRACE(
16993041982dSJonathan Peyton       10,
17003041982dSJonathan Peyton       ("__kmpc_omp_task_parts(exit): T#%d returning TASK_CURRENT_NOT_QUEUED: "
17013041982dSJonathan Peyton        "loc=%p task=%p, return: TASK_CURRENT_NOT_QUEUED\n",
17023041982dSJonathan Peyton        gtid, loc_ref, new_taskdata));
17037cc577a4SJonathan Peyton 
170482e94a59SJoachim Protze #if OMPT_SUPPORT
1705f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
17060e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
170782e94a59SJoachim Protze   }
170882e94a59SJoachim Protze #endif
17097cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17107cc577a4SJonathan Peyton }
17117cc577a4SJonathan Peyton 
17127cc577a4SJonathan Peyton // __kmp_omp_task: Schedule a non-thread-switchable task for execution
17133041982dSJonathan Peyton //
17147cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17157cc577a4SJonathan Peyton // new_task:non-thread-switchable task thunk allocated by __kmp_omp_task_alloc()
17163041982dSJonathan Peyton // serialize_immediate: if TRUE then if the task is executed immediately its
17173041982dSJonathan Peyton // execution will be serialized
17183041982dSJonathan Peyton // Returns:
17193041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17203041982dSJonathan Peyton //    be resumed later.
17213041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17223041982dSJonathan Peyton //    resumed later.
17233041982dSJonathan Peyton kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
17243041982dSJonathan Peyton                          bool serialize_immediate) {
17257cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17267cc577a4SJonathan Peyton 
1727e4b4f994SJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
1728e4b4f994SJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
17293041982dSJonathan Peyton   if (new_taskdata->td_flags.proxy == TASK_PROXY ||
17303041982dSJonathan Peyton       __kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
17317cc577a4SJonathan Peyton   { // Execute this task immediately
17327cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
17337cc577a4SJonathan Peyton     if (serialize_immediate)
17347cc577a4SJonathan Peyton       new_taskdata->td_flags.task_serial = 1;
17357cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
17367cc577a4SJonathan Peyton   }
17377cc577a4SJonathan Peyton 
17387cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17397cc577a4SJonathan Peyton }
17407cc577a4SJonathan Peyton 
17413041982dSJonathan Peyton // __kmpc_omp_task: Wrapper around __kmp_omp_task to schedule a
17423041982dSJonathan Peyton // non-thread-switchable task from the parent thread only!
17433041982dSJonathan Peyton //
17447cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
17457cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17463041982dSJonathan Peyton // new_task: non-thread-switchable task thunk allocated by
17473041982dSJonathan Peyton // __kmp_omp_task_alloc()
17483041982dSJonathan Peyton // Returns:
17493041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17503041982dSJonathan Peyton //    be resumed later.
17513041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17523041982dSJonathan Peyton //    resumed later.
17533041982dSJonathan Peyton kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
17543041982dSJonathan Peyton                           kmp_task_t *new_task) {
17557cc577a4SJonathan Peyton   kmp_int32 res;
17567cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
17577cc577a4SJonathan Peyton 
175882e94a59SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
17597cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17607cc577a4SJonathan Peyton #endif
17613041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
17623041982dSJonathan Peyton                 new_taskdata));
1763787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
17647cc577a4SJonathan Peyton 
176582e94a59SJoachim Protze #if OMPT_SUPPORT
176682e94a59SJoachim Protze   kmp_taskdata_t *parent = NULL;
176786ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
176886ed6aa6SJoachim Protze     if (!new_taskdata->td_flags.started) {
176982e94a59SJoachim Protze       OMPT_STORE_RETURN_ADDRESS(gtid);
177082e94a59SJoachim Protze       parent = new_taskdata->td_parent;
17710e0d6cddSJoachim Protze       if (!parent->ompt_task_info.frame.enter_frame.ptr) {
1772309b00a4SShilei Tian         parent->ompt_task_info.frame.enter_frame.ptr =
1773309b00a4SShilei Tian             OMPT_GET_FRAME_ADDRESS(0);
177486ed6aa6SJoachim Protze       }
177582e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_task_create) {
177682e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1777467f3924SHansang Bae             &(parent->ompt_task_info.task_data),
1778467f3924SHansang Bae             &(parent->ompt_task_info.frame),
177982e94a59SJoachim Protze             &(new_taskdata->ompt_task_info.task_data),
178082e94a59SJoachim Protze             ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
178182e94a59SJoachim Protze             OMPT_LOAD_RETURN_ADDRESS(gtid));
178282e94a59SJoachim Protze       }
178386ed6aa6SJoachim Protze     } else {
178486ed6aa6SJoachim Protze       // We are scheduling the continuation of an UNTIED task.
178586ed6aa6SJoachim Protze       // Scheduling back to the parent task.
178686ed6aa6SJoachim Protze       __ompt_task_finish(new_task,
178786ed6aa6SJoachim Protze                          new_taskdata->ompt_task_info.scheduling_parent,
1788489cdb78SJoachim Protze                          ompt_task_switch);
17890e0d6cddSJoachim Protze       new_taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
179086ed6aa6SJoachim Protze     }
179182e94a59SJoachim Protze   }
179282e94a59SJoachim Protze #endif
179382e94a59SJoachim Protze 
17947cc577a4SJonathan Peyton   res = __kmp_omp_task(gtid, new_task, true);
17957cc577a4SJonathan Peyton 
17963041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
17973041982dSJonathan Peyton                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
17987cc577a4SJonathan Peyton                 gtid, loc_ref, new_taskdata));
179982e94a59SJoachim Protze #if OMPT_SUPPORT
1800f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18010e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
180282e94a59SJoachim Protze   }
180382e94a59SJoachim Protze #endif
18047cc577a4SJonathan Peyton   return res;
18057cc577a4SJonathan Peyton }
18067cc577a4SJonathan Peyton 
1807cdaefac5SJoachim Protze // __kmp_omp_taskloop_task: Wrapper around __kmp_omp_task to schedule
1808cdaefac5SJoachim Protze // a taskloop task with the correct OMPT return address
1809cdaefac5SJoachim Protze //
1810cdaefac5SJoachim Protze // loc_ref: location of original task pragma (ignored)
1811cdaefac5SJoachim Protze // gtid: Global Thread ID of encountering thread
1812cdaefac5SJoachim Protze // new_task: non-thread-switchable task thunk allocated by
1813cdaefac5SJoachim Protze // __kmp_omp_task_alloc()
1814cdaefac5SJoachim Protze // codeptr_ra: return address for OMPT callback
1815cdaefac5SJoachim Protze // Returns:
1816cdaefac5SJoachim Protze //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
1817cdaefac5SJoachim Protze //    be resumed later.
1818cdaefac5SJoachim Protze //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
1819cdaefac5SJoachim Protze //    resumed later.
1820cdaefac5SJoachim Protze kmp_int32 __kmp_omp_taskloop_task(ident_t *loc_ref, kmp_int32 gtid,
1821cdaefac5SJoachim Protze                                   kmp_task_t *new_task, void *codeptr_ra) {
1822cdaefac5SJoachim Protze   kmp_int32 res;
1823cdaefac5SJoachim Protze   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
1824cdaefac5SJoachim Protze 
1825cdaefac5SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
1826cdaefac5SJoachim Protze   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
1827cdaefac5SJoachim Protze #endif
1828cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
1829cdaefac5SJoachim Protze                 new_taskdata));
1830cdaefac5SJoachim Protze 
1831cdaefac5SJoachim Protze #if OMPT_SUPPORT
1832cdaefac5SJoachim Protze   kmp_taskdata_t *parent = NULL;
1833cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && !new_taskdata->td_flags.started)) {
1834cdaefac5SJoachim Protze     parent = new_taskdata->td_parent;
18350e0d6cddSJoachim Protze     if (!parent->ompt_task_info.frame.enter_frame.ptr)
18360e0d6cddSJoachim Protze       parent->ompt_task_info.frame.enter_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
1837cdaefac5SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
1838cdaefac5SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1839467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
1840cdaefac5SJoachim Protze           &(new_taskdata->ompt_task_info.task_data),
1841cdaefac5SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
1842cdaefac5SJoachim Protze           codeptr_ra);
1843cdaefac5SJoachim Protze     }
1844cdaefac5SJoachim Protze   }
1845cdaefac5SJoachim Protze #endif
1846cdaefac5SJoachim Protze 
1847cdaefac5SJoachim Protze   res = __kmp_omp_task(gtid, new_task, true);
1848cdaefac5SJoachim Protze 
1849cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
1850cdaefac5SJoachim Protze                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
1851cdaefac5SJoachim Protze                 gtid, loc_ref, new_taskdata));
1852cdaefac5SJoachim Protze #if OMPT_SUPPORT
1853cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18540e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
1855cdaefac5SJoachim Protze   }
1856cdaefac5SJoachim Protze #endif
1857cdaefac5SJoachim Protze   return res;
1858cdaefac5SJoachim Protze }
1859cdaefac5SJoachim Protze 
186082e94a59SJoachim Protze template <bool ompt>
186182e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_template(ident_t *loc_ref, kmp_int32 gtid,
186282e94a59SJoachim Protze                                               void *frame_address,
186382e94a59SJoachim Protze                                               void *return_address) {
1864467f3924SHansang Bae   kmp_taskdata_t *taskdata = nullptr;
18657cc577a4SJonathan Peyton   kmp_info_t *thread;
18667cc577a4SJonathan Peyton   int thread_finished = FALSE;
18677cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKWAIT);
18687cc577a4SJonathan Peyton 
18697cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(enter): T#%d loc=%p\n", gtid, loc_ref));
1870838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
18717cc577a4SJonathan Peyton 
18727cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
18737cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
18747cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
18757cc577a4SJonathan Peyton 
187682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
187782e94a59SJoachim Protze     ompt_data_t *my_task_data;
187882e94a59SJoachim Protze     ompt_data_t *my_parallel_data;
18797cc577a4SJonathan Peyton 
188082e94a59SJoachim Protze     if (ompt) {
188182e94a59SJoachim Protze       my_task_data = &(taskdata->ompt_task_info.task_data);
188282e94a59SJoachim Protze       my_parallel_data = OMPT_CUR_TEAM_DATA(thread);
188382e94a59SJoachim Protze 
18840e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame.ptr = frame_address;
188582e94a59SJoachim Protze 
188682e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
188782e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
188882e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
188982e94a59SJoachim Protze             my_task_data, return_address);
189082e94a59SJoachim Protze       }
189182e94a59SJoachim Protze 
189282e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
189382e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
189482e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
189582e94a59SJoachim Protze             my_task_data, return_address);
18967cc577a4SJonathan Peyton       }
18977cc577a4SJonathan Peyton     }
189882e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
18997cc577a4SJonathan Peyton 
19003041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
19013041982dSJonathan Peyton // taskwait.
19027cc577a4SJonathan Peyton #if USE_ITT_BUILD
19037cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
19047cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19057cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
19067cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
19077cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
19087cc577a4SJonathan Peyton 
19097cc577a4SJonathan Peyton #if USE_ITT_BUILD
1910838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
1911838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
1912838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
1913838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
19147cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19157cc577a4SJonathan Peyton 
19163041982dSJonathan Peyton     bool must_wait =
19173041982dSJonathan Peyton         !taskdata->td_flags.team_serial && !taskdata->td_flags.final;
19187cc577a4SJonathan Peyton 
19193041982dSJonathan Peyton     must_wait = must_wait || (thread->th.th_task_team != NULL &&
19203041982dSJonathan Peyton                               thread->th.th_task_team->tt.tt_found_proxy_tasks);
19219d64275aSShilei Tian     // If hidden helper thread is encountered, we must enable wait here.
19229d64275aSShilei Tian     must_wait =
19239d64275aSShilei Tian         must_wait ||
19249d64275aSShilei Tian         (__kmp_enable_hidden_helper && thread->th.th_task_team != NULL &&
19259d64275aSShilei Tian          thread->th.th_task_team->tt.tt_hidden_helper_task_encountered);
19269d64275aSShilei Tian 
19273041982dSJonathan Peyton     if (must_wait) {
1928e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
1929e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
193037e2ef54SJonathan Peyton                 &(taskdata->td_incomplete_child_tasks)),
1931c47afcd9SAndrey Churbanov           0U);
193237e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) != 0) {
19333041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
19343041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
19353041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
19367cc577a4SJonathan Peyton       }
19377cc577a4SJonathan Peyton     }
19387cc577a4SJonathan Peyton #if USE_ITT_BUILD
1939838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
1940ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with children
19417cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19427cc577a4SJonathan Peyton 
19433041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
19443041982dSJonathan Peyton     // negated.
19457cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
19467cc577a4SJonathan Peyton 
194782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
194882e94a59SJoachim Protze     if (ompt) {
194982e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
195082e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
195182e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
195282e94a59SJoachim Protze             my_task_data, return_address);
195382e94a59SJoachim Protze       }
195482e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
195582e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
195682e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
195782e94a59SJoachim Protze             my_task_data, return_address);
19587cc577a4SJonathan Peyton       }
19590e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = ompt_data_none;
19607cc577a4SJonathan Peyton     }
196182e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
196282e94a59SJoachim Protze 
19637cc577a4SJonathan Peyton   }
19647cc577a4SJonathan Peyton 
19657cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(exit): T#%d task %p finished waiting, "
19663041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
19673041982dSJonathan Peyton                 gtid, taskdata));
19687cc577a4SJonathan Peyton 
19697cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
19707cc577a4SJonathan Peyton }
19717cc577a4SJonathan Peyton 
1972489cdb78SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
197382e94a59SJoachim Protze OMPT_NOINLINE
197482e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_ompt(ident_t *loc_ref, kmp_int32 gtid,
197582e94a59SJoachim Protze                                           void *frame_address,
197682e94a59SJoachim Protze                                           void *return_address) {
197782e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<true>(loc_ref, gtid, frame_address,
197882e94a59SJoachim Protze                                             return_address);
197982e94a59SJoachim Protze }
1980489cdb78SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
198182e94a59SJoachim Protze 
198282e94a59SJoachim Protze // __kmpc_omp_taskwait: Wait until all tasks generated by the current task are
198382e94a59SJoachim Protze // complete
198482e94a59SJoachim Protze kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid) {
198582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
198682e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
198782e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
19880e0d6cddSJoachim Protze     return __kmpc_omp_taskwait_ompt(loc_ref, gtid, OMPT_GET_FRAME_ADDRESS(0),
198982e94a59SJoachim Protze                                     OMPT_LOAD_RETURN_ADDRESS(gtid));
199082e94a59SJoachim Protze   }
199182e94a59SJoachim Protze #endif
199282e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<false>(loc_ref, gtid, NULL, NULL);
199382e94a59SJoachim Protze }
199482e94a59SJoachim Protze 
19957cc577a4SJonathan Peyton // __kmpc_omp_taskyield: switch to a different task
19963041982dSJonathan Peyton kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid, int end_part) {
1997467f3924SHansang Bae   kmp_taskdata_t *taskdata = NULL;
19987cc577a4SJonathan Peyton   kmp_info_t *thread;
19997cc577a4SJonathan Peyton   int thread_finished = FALSE;
20007cc577a4SJonathan Peyton 
20017cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKYIELD);
20027cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKYIELD);
20037cc577a4SJonathan Peyton 
20047cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(enter): T#%d loc=%p end_part = %d\n",
20057cc577a4SJonathan Peyton                 gtid, loc_ref, end_part));
2006787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
20077cc577a4SJonathan Peyton 
20087cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec && __kmp_init_parallel) {
20097cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
20107cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
20117cc577a4SJonathan Peyton // Should we model this as a task wait or not?
20123041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
20133041982dSJonathan Peyton // taskwait.
20147cc577a4SJonathan Peyton #if USE_ITT_BUILD
20157cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
20167cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20177cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
20187cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
20197cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
20207cc577a4SJonathan Peyton 
20217cc577a4SJonathan Peyton #if USE_ITT_BUILD
2022838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2023838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2024838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2025838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
20267cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20277cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial) {
20287cc577a4SJonathan Peyton       kmp_task_team_t *task_team = thread->th.th_task_team;
20297cc577a4SJonathan Peyton       if (task_team != NULL) {
20307cc577a4SJonathan Peyton         if (KMP_TASKING_ENABLED(task_team)) {
203182e94a59SJoachim Protze #if OMPT_SUPPORT
2032f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
203382e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 1;
203482e94a59SJoachim Protze #endif
20353041982dSJonathan Peyton           __kmp_execute_tasks_32(
2036e0665a90STerry Wilmarth               thread, gtid, (kmp_flag_32<> *)NULL, FALSE,
20373041982dSJonathan Peyton               &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
20383041982dSJonathan Peyton               __kmp_task_stealing_constraint);
203982e94a59SJoachim Protze #if OMPT_SUPPORT
2040f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
204182e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 0;
204282e94a59SJoachim Protze #endif
20437cc577a4SJonathan Peyton         }
20447cc577a4SJonathan Peyton       }
20457cc577a4SJonathan Peyton     }
20467cc577a4SJonathan Peyton #if USE_ITT_BUILD
2047838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
20487cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20497cc577a4SJonathan Peyton 
20503041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
20513041982dSJonathan Peyton     // negated.
20527cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
20537cc577a4SJonathan Peyton   }
20547cc577a4SJonathan Peyton 
20557cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(exit): T#%d task %p resuming, "
20563041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
20573041982dSJonathan Peyton                 gtid, taskdata));
20587cc577a4SJonathan Peyton 
20597cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
20607cc577a4SJonathan Peyton }
20617cc577a4SJonathan Peyton 
206272ba2109SAndrey Churbanov // Task Reduction implementation
2063a8426ac8SJonathan Peyton //
2064a8426ac8SJonathan Peyton // Note: initial implementation didn't take into account the possibility
2065a8426ac8SJonathan Peyton // to specify omp_orig for initializer of the UDR (user defined reduction).
2066a8426ac8SJonathan Peyton // Corrected implementation takes into account the omp_orig object.
2067a8426ac8SJonathan Peyton // Compiler is free to use old implementation if omp_orig is not specified.
206872ba2109SAndrey Churbanov 
2069a8426ac8SJonathan Peyton /*!
2070a8426ac8SJonathan Peyton @ingroup BASIC_TYPES
2071a8426ac8SJonathan Peyton @{
2072a8426ac8SJonathan Peyton */
2073a8426ac8SJonathan Peyton 
2074a8426ac8SJonathan Peyton /*!
2075a8426ac8SJonathan Peyton Flags for special info per task reduction item.
2076a8426ac8SJonathan Peyton */
2077a8426ac8SJonathan Peyton typedef struct kmp_taskred_flags {
2078a8426ac8SJonathan Peyton   /*! 1 - use lazy alloc/init (e.g. big objects, #tasks < #threads) */
2079a8426ac8SJonathan Peyton   unsigned lazy_priv : 1;
208072ba2109SAndrey Churbanov   unsigned reserved31 : 31;
2081a8426ac8SJonathan Peyton } kmp_taskred_flags_t;
208272ba2109SAndrey Churbanov 
2083a8426ac8SJonathan Peyton /*!
2084a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2085a8426ac8SJonathan Peyton */
208672ba2109SAndrey Churbanov typedef struct kmp_task_red_input {
2087a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2088a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item in bytes */
2089a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2090a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (single parameter) */
2091a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2092a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2093a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
209472ba2109SAndrey Churbanov } kmp_task_red_input_t;
209572ba2109SAndrey Churbanov 
209672ba2109SAndrey Churbanov /*!
2097a8426ac8SJonathan Peyton Internal struct for reduction data item related info saved by the library.
209872ba2109SAndrey Churbanov */
2099a8426ac8SJonathan Peyton typedef struct kmp_taskred_data {
2100a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2101a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2102a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2103a8426ac8SJonathan Peyton   void *reduce_priv; /**< array of thread specific items */
2104a8426ac8SJonathan Peyton   void *reduce_pend; /**< end of private data for faster comparison op */
2105a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2106a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2107a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2108a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2109a8426ac8SJonathan Peyton   void *reduce_orig; /**< original item (can be used in UDR initializer) */
2110a8426ac8SJonathan Peyton } kmp_taskred_data_t;
2111a8426ac8SJonathan Peyton 
2112a8426ac8SJonathan Peyton /*!
2113a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2114a8426ac8SJonathan Peyton 
2115a8426ac8SJonathan Peyton New interface: added reduce_orig field to provide omp_orig for UDR initializer.
2116a8426ac8SJonathan Peyton */
2117a8426ac8SJonathan Peyton typedef struct kmp_taskred_input {
2118a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2119a8426ac8SJonathan Peyton   void *reduce_orig; /**< original reduction item used for initialization */
2120a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2121a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2122a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2123a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2124a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2125a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2126a8426ac8SJonathan Peyton } kmp_taskred_input_t;
2127a8426ac8SJonathan Peyton /*!
2128a8426ac8SJonathan Peyton @}
2129a8426ac8SJonathan Peyton */
2130a8426ac8SJonathan Peyton 
2131a8426ac8SJonathan Peyton template <typename T> void __kmp_assign_orig(kmp_taskred_data_t &item, T &src);
2132a8426ac8SJonathan Peyton template <>
2133a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_task_red_input_t>(kmp_taskred_data_t &item,
2134a8426ac8SJonathan Peyton                                              kmp_task_red_input_t &src) {
2135a8426ac8SJonathan Peyton   item.reduce_orig = NULL;
2136a8426ac8SJonathan Peyton }
2137a8426ac8SJonathan Peyton template <>
2138a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_taskred_input_t>(kmp_taskred_data_t &item,
2139a8426ac8SJonathan Peyton                                             kmp_taskred_input_t &src) {
2140a8426ac8SJonathan Peyton   if (src.reduce_orig != NULL) {
2141a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_orig;
2142a8426ac8SJonathan Peyton   } else {
2143a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_shar;
2144a8426ac8SJonathan Peyton   } // non-NULL reduce_orig means new interface used
2145a8426ac8SJonathan Peyton }
2146a8426ac8SJonathan Peyton 
21476b316febSTerry Wilmarth template <typename T> void __kmp_call_init(kmp_taskred_data_t &item, size_t j);
2148a8426ac8SJonathan Peyton template <>
2149a8426ac8SJonathan Peyton void __kmp_call_init<kmp_task_red_input_t>(kmp_taskred_data_t &item,
21506b316febSTerry Wilmarth                                            size_t offset) {
2151a8426ac8SJonathan Peyton   ((void (*)(void *))item.reduce_init)((char *)(item.reduce_priv) + offset);
2152a8426ac8SJonathan Peyton }
2153a8426ac8SJonathan Peyton template <>
2154a8426ac8SJonathan Peyton void __kmp_call_init<kmp_taskred_input_t>(kmp_taskred_data_t &item,
21556b316febSTerry Wilmarth                                           size_t offset) {
2156a8426ac8SJonathan Peyton   ((void (*)(void *, void *))item.reduce_init)(
2157a8426ac8SJonathan Peyton       (char *)(item.reduce_priv) + offset, item.reduce_orig);
2158a8426ac8SJonathan Peyton }
2159a8426ac8SJonathan Peyton 
2160a8426ac8SJonathan Peyton template <typename T>
2161a8426ac8SJonathan Peyton void *__kmp_task_reduction_init(int gtid, int num, T *data) {
2162787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
216372ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
216472ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = thread->th.th_current_task->td_taskgroup;
21656b316febSTerry Wilmarth   kmp_uint32 nth = thread->th.th_team_nproc;
2166a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
216772ba2109SAndrey Churbanov 
216872ba2109SAndrey Churbanov   // check input data just in case
216972ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
217072ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
217172ba2109SAndrey Churbanov   KMP_ASSERT(num > 0);
217272ba2109SAndrey Churbanov   if (nth == 1) {
217372ba2109SAndrey Churbanov     KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, tg %p, exiting nth=1\n",
217472ba2109SAndrey Churbanov                   gtid, tg));
217572ba2109SAndrey Churbanov     return (void *)tg;
217672ba2109SAndrey Churbanov   }
217772ba2109SAndrey Churbanov   KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, taskgroup %p, #items %d\n",
217872ba2109SAndrey Churbanov                 gtid, tg, num));
2179a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2180a8426ac8SJonathan Peyton       thread, num * sizeof(kmp_taskred_data_t));
218172ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
2182a8426ac8SJonathan Peyton     size_t size = data[i].reduce_size - 1;
218372ba2109SAndrey Churbanov     // round the size up to cache line per thread-specific item
218472ba2109SAndrey Churbanov     size += CACHE_LINE - size % CACHE_LINE;
2185a8426ac8SJonathan Peyton     KMP_ASSERT(data[i].reduce_comb != NULL); // combiner is mandatory
2186a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar;
218772ba2109SAndrey Churbanov     arr[i].reduce_size = size;
2188a8426ac8SJonathan Peyton     arr[i].flags = data[i].flags;
2189a8426ac8SJonathan Peyton     arr[i].reduce_comb = data[i].reduce_comb;
2190a8426ac8SJonathan Peyton     arr[i].reduce_init = data[i].reduce_init;
2191a8426ac8SJonathan Peyton     arr[i].reduce_fini = data[i].reduce_fini;
2192a8426ac8SJonathan Peyton     __kmp_assign_orig<T>(arr[i], data[i]);
2193a8426ac8SJonathan Peyton     if (!arr[i].flags.lazy_priv) {
219472ba2109SAndrey Churbanov       // allocate cache-line aligned block and fill it with zeros
219572ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * size);
219672ba2109SAndrey Churbanov       arr[i].reduce_pend = (char *)(arr[i].reduce_priv) + nth * size;
2197a8426ac8SJonathan Peyton       if (arr[i].reduce_init != NULL) {
2198a8426ac8SJonathan Peyton         // initialize all thread-specific items
21996b316febSTerry Wilmarth         for (size_t j = 0; j < nth; ++j) {
2200a8426ac8SJonathan Peyton           __kmp_call_init<T>(arr[i], j * size);
220172ba2109SAndrey Churbanov         }
220272ba2109SAndrey Churbanov       }
220372ba2109SAndrey Churbanov     } else {
220472ba2109SAndrey Churbanov       // only allocate space for pointers now,
2205a8426ac8SJonathan Peyton       // objects will be lazily allocated/initialized if/when requested
2206a8426ac8SJonathan Peyton       // note that __kmp_allocate zeroes the allocated memory
220772ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * sizeof(void *));
220872ba2109SAndrey Churbanov     }
220972ba2109SAndrey Churbanov   }
221072ba2109SAndrey Churbanov   tg->reduce_data = (void *)arr;
221172ba2109SAndrey Churbanov   tg->reduce_num_data = num;
221272ba2109SAndrey Churbanov   return (void *)tg;
221372ba2109SAndrey Churbanov }
221472ba2109SAndrey Churbanov 
221572ba2109SAndrey Churbanov /*!
221672ba2109SAndrey Churbanov @ingroup TASKING
221772ba2109SAndrey Churbanov @param gtid      Global thread ID
2218a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2219a8426ac8SJonathan Peyton @param data      Array of data for reduction
2220a8426ac8SJonathan Peyton @return The taskgroup identifier
2221a8426ac8SJonathan Peyton 
2222a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2223a8426ac8SJonathan Peyton 
2224a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2225a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2226a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2227a8426ac8SJonathan Peyton without help of the runtime library.
2228a8426ac8SJonathan Peyton */
2229a8426ac8SJonathan Peyton void *__kmpc_task_reduction_init(int gtid, int num, void *data) {
2230a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_task_red_input_t *)data);
2231a8426ac8SJonathan Peyton }
2232a8426ac8SJonathan Peyton 
2233a8426ac8SJonathan Peyton /*!
2234a8426ac8SJonathan Peyton @ingroup TASKING
2235a8426ac8SJonathan Peyton @param gtid      Global thread ID
2236a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2237a8426ac8SJonathan Peyton @param data      Array of data for reduction
2238a8426ac8SJonathan Peyton @return The taskgroup identifier
2239a8426ac8SJonathan Peyton 
2240a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2241a8426ac8SJonathan Peyton 
2242a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2243a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2244a8426ac8SJonathan Peyton */
2245a8426ac8SJonathan Peyton void *__kmpc_taskred_init(int gtid, int num, void *data) {
2246a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_taskred_input_t *)data);
2247a8426ac8SJonathan Peyton }
2248a8426ac8SJonathan Peyton 
2249a8426ac8SJonathan Peyton // Copy task reduction data (except for shared pointers).
2250a8426ac8SJonathan Peyton template <typename T>
2251a8426ac8SJonathan Peyton void __kmp_task_reduction_init_copy(kmp_info_t *thr, int num, T *data,
2252a8426ac8SJonathan Peyton                                     kmp_taskgroup_t *tg, void *reduce_data) {
2253a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
2254a8426ac8SJonathan Peyton   KA_TRACE(20, ("__kmp_task_reduction_init_copy: Th %p, init taskgroup %p,"
2255a8426ac8SJonathan Peyton                 " from data %p\n",
2256a8426ac8SJonathan Peyton                 thr, tg, reduce_data));
2257a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2258a8426ac8SJonathan Peyton       thr, num * sizeof(kmp_taskred_data_t));
2259a8426ac8SJonathan Peyton   // threads will share private copies, thunk routines, sizes, flags, etc.:
2260a8426ac8SJonathan Peyton   KMP_MEMCPY(arr, reduce_data, num * sizeof(kmp_taskred_data_t));
2261a8426ac8SJonathan Peyton   for (int i = 0; i < num; ++i) {
2262a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar; // init unique shared pointers
2263a8426ac8SJonathan Peyton   }
2264a8426ac8SJonathan Peyton   tg->reduce_data = (void *)arr;
2265a8426ac8SJonathan Peyton   tg->reduce_num_data = num;
2266a8426ac8SJonathan Peyton }
2267a8426ac8SJonathan Peyton 
2268a8426ac8SJonathan Peyton /*!
2269a8426ac8SJonathan Peyton @ingroup TASKING
2270a8426ac8SJonathan Peyton @param gtid    Global thread ID
227172ba2109SAndrey Churbanov @param tskgrp  The taskgroup ID (optional)
227272ba2109SAndrey Churbanov @param data    Shared location of the item
227372ba2109SAndrey Churbanov @return The pointer to per-thread data
227472ba2109SAndrey Churbanov 
227572ba2109SAndrey Churbanov Get thread-specific location of data item
227672ba2109SAndrey Churbanov */
22773041982dSJonathan Peyton void *__kmpc_task_reduction_get_th_data(int gtid, void *tskgrp, void *data) {
2278787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
227972ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
228072ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
228172ba2109SAndrey Churbanov   if (nth == 1)
228272ba2109SAndrey Churbanov     return data; // nothing to do
228372ba2109SAndrey Churbanov 
228472ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = (kmp_taskgroup_t *)tskgrp;
228572ba2109SAndrey Churbanov   if (tg == NULL)
228672ba2109SAndrey Churbanov     tg = thread->th.th_current_task->td_taskgroup;
228772ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
2288a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)(tg->reduce_data);
228972ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
229072ba2109SAndrey Churbanov   kmp_int32 tid = thread->th.th_info.ds.ds_tid;
229172ba2109SAndrey Churbanov 
229272ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
229372ba2109SAndrey Churbanov   while (tg != NULL) {
229472ba2109SAndrey Churbanov     for (int i = 0; i < num; ++i) {
229572ba2109SAndrey Churbanov       if (!arr[i].flags.lazy_priv) {
229672ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar ||
229772ba2109SAndrey Churbanov             (data >= arr[i].reduce_priv && data < arr[i].reduce_pend))
229872ba2109SAndrey Churbanov           return (char *)(arr[i].reduce_priv) + tid * arr[i].reduce_size;
229972ba2109SAndrey Churbanov       } else {
230072ba2109SAndrey Churbanov         // check shared location first
230172ba2109SAndrey Churbanov         void **p_priv = (void **)(arr[i].reduce_priv);
230272ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar)
230372ba2109SAndrey Churbanov           goto found;
230472ba2109SAndrey Churbanov         // check if we get some thread specific location as parameter
230572ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j)
230672ba2109SAndrey Churbanov           if (data == p_priv[j])
230772ba2109SAndrey Churbanov             goto found;
230872ba2109SAndrey Churbanov         continue; // not found, continue search
230972ba2109SAndrey Churbanov       found:
231072ba2109SAndrey Churbanov         if (p_priv[tid] == NULL) {
231172ba2109SAndrey Churbanov           // allocate thread specific object lazily
231272ba2109SAndrey Churbanov           p_priv[tid] = __kmp_allocate(arr[i].reduce_size);
2313a8426ac8SJonathan Peyton           if (arr[i].reduce_init != NULL) {
2314a8426ac8SJonathan Peyton             if (arr[i].reduce_orig != NULL) { // new interface
2315a8426ac8SJonathan Peyton               ((void (*)(void *, void *))arr[i].reduce_init)(
2316a8426ac8SJonathan Peyton                   p_priv[tid], arr[i].reduce_orig);
2317a8426ac8SJonathan Peyton             } else { // old interface (single parameter)
2318a8426ac8SJonathan Peyton               ((void (*)(void *))arr[i].reduce_init)(p_priv[tid]);
2319a8426ac8SJonathan Peyton             }
232072ba2109SAndrey Churbanov           }
232172ba2109SAndrey Churbanov         }
232272ba2109SAndrey Churbanov         return p_priv[tid];
232372ba2109SAndrey Churbanov       }
232472ba2109SAndrey Churbanov     }
232572ba2109SAndrey Churbanov     tg = tg->parent;
2326a8426ac8SJonathan Peyton     arr = (kmp_taskred_data_t *)(tg->reduce_data);
232772ba2109SAndrey Churbanov     num = tg->reduce_num_data;
232872ba2109SAndrey Churbanov   }
232972ba2109SAndrey Churbanov   KMP_ASSERT2(0, "Unknown task reduction item");
233072ba2109SAndrey Churbanov   return NULL; // ERROR, this line never executed
233172ba2109SAndrey Churbanov }
233272ba2109SAndrey Churbanov 
233372ba2109SAndrey Churbanov // Finalize task reduction.
233472ba2109SAndrey Churbanov // Called from __kmpc_end_taskgroup()
23353041982dSJonathan Peyton static void __kmp_task_reduction_fini(kmp_info_t *th, kmp_taskgroup_t *tg) {
233672ba2109SAndrey Churbanov   kmp_int32 nth = th->th.th_team_nproc;
233772ba2109SAndrey Churbanov   KMP_DEBUG_ASSERT(nth > 1); // should not be called if nth == 1
2338a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)tg->reduce_data;
233972ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
234072ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
234172ba2109SAndrey Churbanov     void *sh_data = arr[i].reduce_shar;
234272ba2109SAndrey Churbanov     void (*f_fini)(void *) = (void (*)(void *))(arr[i].reduce_fini);
23433041982dSJonathan Peyton     void (*f_comb)(void *, void *) =
23443041982dSJonathan Peyton         (void (*)(void *, void *))(arr[i].reduce_comb);
234572ba2109SAndrey Churbanov     if (!arr[i].flags.lazy_priv) {
234672ba2109SAndrey Churbanov       void *pr_data = arr[i].reduce_priv;
234772ba2109SAndrey Churbanov       size_t size = arr[i].reduce_size;
234872ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
234972ba2109SAndrey Churbanov         void *priv_data = (char *)pr_data + j * size;
235072ba2109SAndrey Churbanov         f_comb(sh_data, priv_data); // combine results
235172ba2109SAndrey Churbanov         if (f_fini)
235272ba2109SAndrey Churbanov           f_fini(priv_data); // finalize if needed
235372ba2109SAndrey Churbanov       }
235472ba2109SAndrey Churbanov     } else {
235572ba2109SAndrey Churbanov       void **pr_data = (void **)(arr[i].reduce_priv);
235672ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
235772ba2109SAndrey Churbanov         if (pr_data[j] != NULL) {
235872ba2109SAndrey Churbanov           f_comb(sh_data, pr_data[j]); // combine results
235972ba2109SAndrey Churbanov           if (f_fini)
236072ba2109SAndrey Churbanov             f_fini(pr_data[j]); // finalize if needed
236172ba2109SAndrey Churbanov           __kmp_free(pr_data[j]);
236272ba2109SAndrey Churbanov         }
236372ba2109SAndrey Churbanov       }
236472ba2109SAndrey Churbanov     }
236572ba2109SAndrey Churbanov     __kmp_free(arr[i].reduce_priv);
236672ba2109SAndrey Churbanov   }
236772ba2109SAndrey Churbanov   __kmp_thread_free(th, arr);
236872ba2109SAndrey Churbanov   tg->reduce_data = NULL;
236972ba2109SAndrey Churbanov   tg->reduce_num_data = 0;
237072ba2109SAndrey Churbanov }
2371a8426ac8SJonathan Peyton 
2372a8426ac8SJonathan Peyton // Cleanup task reduction data for parallel or worksharing,
2373a8426ac8SJonathan Peyton // do not touch task private data other threads still working with.
2374a8426ac8SJonathan Peyton // Called from __kmpc_end_taskgroup()
2375a8426ac8SJonathan Peyton static void __kmp_task_reduction_clean(kmp_info_t *th, kmp_taskgroup_t *tg) {
2376a8426ac8SJonathan Peyton   __kmp_thread_free(th, tg->reduce_data);
2377a8426ac8SJonathan Peyton   tg->reduce_data = NULL;
2378a8426ac8SJonathan Peyton   tg->reduce_num_data = 0;
2379a8426ac8SJonathan Peyton }
2380a8426ac8SJonathan Peyton 
2381a8426ac8SJonathan Peyton template <typename T>
2382a8426ac8SJonathan Peyton void *__kmp_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2383a8426ac8SJonathan Peyton                                          int num, T *data) {
2384787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
2385a8426ac8SJonathan Peyton   kmp_info_t *thr = __kmp_threads[gtid];
2386a8426ac8SJonathan Peyton   kmp_int32 nth = thr->th.th_team_nproc;
2387a8426ac8SJonathan Peyton   __kmpc_taskgroup(loc, gtid); // form new taskgroup first
2388a8426ac8SJonathan Peyton   if (nth == 1) {
2389a8426ac8SJonathan Peyton     KA_TRACE(10,
2390a8426ac8SJonathan Peyton              ("__kmpc_reduction_modifier_init: T#%d, tg %p, exiting nth=1\n",
2391a8426ac8SJonathan Peyton               gtid, thr->th.th_current_task->td_taskgroup));
2392a8426ac8SJonathan Peyton     return (void *)thr->th.th_current_task->td_taskgroup;
2393a8426ac8SJonathan Peyton   }
2394a8426ac8SJonathan Peyton   kmp_team_t *team = thr->th.th_team;
2395a8426ac8SJonathan Peyton   void *reduce_data;
2396a8426ac8SJonathan Peyton   kmp_taskgroup_t *tg;
2397a8426ac8SJonathan Peyton   reduce_data = KMP_ATOMIC_LD_RLX(&team->t.t_tg_reduce_data[is_ws]);
2398a8426ac8SJonathan Peyton   if (reduce_data == NULL &&
2399a8426ac8SJonathan Peyton       __kmp_atomic_compare_store(&team->t.t_tg_reduce_data[is_ws], reduce_data,
2400a8426ac8SJonathan Peyton                                  (void *)1)) {
2401a8426ac8SJonathan Peyton     // single thread enters this block to initialize common reduction data
2402a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data == NULL);
2403a8426ac8SJonathan Peyton     // first initialize own data, then make a copy other threads can use
2404a8426ac8SJonathan Peyton     tg = (kmp_taskgroup_t *)__kmp_task_reduction_init<T>(gtid, num, data);
2405a8426ac8SJonathan Peyton     reduce_data = __kmp_thread_malloc(thr, num * sizeof(kmp_taskred_data_t));
2406a8426ac8SJonathan Peyton     KMP_MEMCPY(reduce_data, tg->reduce_data, num * sizeof(kmp_taskred_data_t));
2407a8426ac8SJonathan Peyton     // fini counters should be 0 at this point
2408a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[0]) == 0);
2409a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[1]) == 0);
2410a8426ac8SJonathan Peyton     KMP_ATOMIC_ST_REL(&team->t.t_tg_reduce_data[is_ws], reduce_data);
2411a8426ac8SJonathan Peyton   } else {
2412a8426ac8SJonathan Peyton     while (
2413a8426ac8SJonathan Peyton         (reduce_data = KMP_ATOMIC_LD_ACQ(&team->t.t_tg_reduce_data[is_ws])) ==
2414a8426ac8SJonathan Peyton         (void *)1) { // wait for task reduction initialization
2415a8426ac8SJonathan Peyton       KMP_CPU_PAUSE();
2416a8426ac8SJonathan Peyton     }
2417a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data > (void *)1); // should be valid pointer here
2418a8426ac8SJonathan Peyton     tg = thr->th.th_current_task->td_taskgroup;
2419a8426ac8SJonathan Peyton     __kmp_task_reduction_init_copy<T>(thr, num, data, tg, reduce_data);
2420a8426ac8SJonathan Peyton   }
2421a8426ac8SJonathan Peyton   return tg;
2422a8426ac8SJonathan Peyton }
2423a8426ac8SJonathan Peyton 
2424a8426ac8SJonathan Peyton /*!
2425a8426ac8SJonathan Peyton @ingroup TASKING
2426a8426ac8SJonathan Peyton @param loc       Source location info
2427a8426ac8SJonathan Peyton @param gtid      Global thread ID
2428a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2429a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2430a8426ac8SJonathan Peyton @param data      Array of data for reduction
2431a8426ac8SJonathan Peyton @return The taskgroup identifier
2432a8426ac8SJonathan Peyton 
2433a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2434a8426ac8SJonathan Peyton 
2435a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2436a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2437a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2438a8426ac8SJonathan Peyton without help of the runtime library.
2439a8426ac8SJonathan Peyton */
2440a8426ac8SJonathan Peyton void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2441a8426ac8SJonathan Peyton                                           int num, void *data) {
2442a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2443a8426ac8SJonathan Peyton                                             (kmp_task_red_input_t *)data);
2444a8426ac8SJonathan Peyton }
2445a8426ac8SJonathan Peyton 
2446a8426ac8SJonathan Peyton /*!
2447a8426ac8SJonathan Peyton @ingroup TASKING
2448a8426ac8SJonathan Peyton @param loc       Source location info
2449a8426ac8SJonathan Peyton @param gtid      Global thread ID
2450a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2451a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2452a8426ac8SJonathan Peyton @param data      Array of data for reduction
2453a8426ac8SJonathan Peyton @return The taskgroup identifier
2454a8426ac8SJonathan Peyton 
2455a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2456a8426ac8SJonathan Peyton 
2457a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2458a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2459a8426ac8SJonathan Peyton */
2460a8426ac8SJonathan Peyton void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num,
2461a8426ac8SJonathan Peyton                                    void *data) {
2462a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2463a8426ac8SJonathan Peyton                                             (kmp_taskred_input_t *)data);
2464a8426ac8SJonathan Peyton }
2465a8426ac8SJonathan Peyton 
2466a8426ac8SJonathan Peyton /*!
2467a8426ac8SJonathan Peyton @ingroup TASKING
2468a8426ac8SJonathan Peyton @param loc       Source location info
2469a8426ac8SJonathan Peyton @param gtid      Global thread ID
2470a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2471a8426ac8SJonathan Peyton 
2472a8426ac8SJonathan Peyton Finalize task reduction for a parallel or worksharing.
2473a8426ac8SJonathan Peyton */
2474a8426ac8SJonathan Peyton void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid, int is_ws) {
2475a8426ac8SJonathan Peyton   __kmpc_end_taskgroup(loc, gtid);
2476a8426ac8SJonathan Peyton }
24777cc577a4SJonathan Peyton 
24787cc577a4SJonathan Peyton // __kmpc_taskgroup: Start a new taskgroup
24793041982dSJonathan Peyton void __kmpc_taskgroup(ident_t *loc, int gtid) {
2480787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
24817cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
24827cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
24837cc577a4SJonathan Peyton   kmp_taskgroup_t *tg_new =
24847cc577a4SJonathan Peyton       (kmp_taskgroup_t *)__kmp_thread_malloc(thread, sizeof(kmp_taskgroup_t));
24857cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_taskgroup: T#%d loc=%p group=%p\n", gtid, loc, tg_new));
248637e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->count, 0);
248737e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->cancel_request, cancel_noreq);
24887cc577a4SJonathan Peyton   tg_new->parent = taskdata->td_taskgroup;
248972ba2109SAndrey Churbanov   tg_new->reduce_data = NULL;
249072ba2109SAndrey Churbanov   tg_new->reduce_num_data = 0;
249144575657SPeyton, Jonathan L   tg_new->gomp_data = NULL;
24927cc577a4SJonathan Peyton   taskdata->td_taskgroup = tg_new;
249382e94a59SJoachim Protze 
249482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2495f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
249682e94a59SJoachim Protze     void *codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
249782e94a59SJoachim Protze     if (!codeptr)
249882e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
249982e94a59SJoachim Protze     kmp_team_t *team = thread->th.th_team;
250082e94a59SJoachim Protze     ompt_data_t my_task_data = taskdata->ompt_task_info.task_data;
250182e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
250282e94a59SJoachim Protze     ompt_data_t my_parallel_data = team->t.ompt_team_info.parallel_data;
250382e94a59SJoachim Protze 
250482e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
250582e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
250682e94a59SJoachim Protze         &(my_task_data), codeptr);
250782e94a59SJoachim Protze   }
250882e94a59SJoachim Protze #endif
25097cc577a4SJonathan Peyton }
25107cc577a4SJonathan Peyton 
25117cc577a4SJonathan Peyton // __kmpc_end_taskgroup: Wait until all tasks generated by the current task
25127cc577a4SJonathan Peyton //                       and its descendants are complete
25133041982dSJonathan Peyton void __kmpc_end_taskgroup(ident_t *loc, int gtid) {
2514787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
25157cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
25167cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
25177cc577a4SJonathan Peyton   kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
25187cc577a4SJonathan Peyton   int thread_finished = FALSE;
25197cc577a4SJonathan Peyton 
252082e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
252182e94a59SJoachim Protze   kmp_team_t *team;
252282e94a59SJoachim Protze   ompt_data_t my_task_data;
252382e94a59SJoachim Protze   ompt_data_t my_parallel_data;
2524467f3924SHansang Bae   void *codeptr = nullptr;
2525f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
252682e94a59SJoachim Protze     team = thread->th.th_team;
252782e94a59SJoachim Protze     my_task_data = taskdata->ompt_task_info.task_data;
252882e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
252982e94a59SJoachim Protze     my_parallel_data = team->t.ompt_team_info.parallel_data;
253082e94a59SJoachim Protze     codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
253182e94a59SJoachim Protze     if (!codeptr)
253282e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
253382e94a59SJoachim Protze   }
253482e94a59SJoachim Protze #endif
253582e94a59SJoachim Protze 
25367cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(enter): T#%d loc=%p\n", gtid, loc));
25377cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup != NULL);
25387cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKGROUP);
25397cc577a4SJonathan Peyton 
25407cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
2541a756cb24SAndrey Churbanov     // mark task as waiting not on a barrier
2542a756cb24SAndrey Churbanov     taskdata->td_taskwait_counter += 1;
2543a756cb24SAndrey Churbanov     taskdata->td_taskwait_ident = loc;
2544a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = gtid + 1;
25457cc577a4SJonathan Peyton #if USE_ITT_BUILD
25463041982dSJonathan Peyton     // For ITT the taskgroup wait is similar to taskwait until we need to
25473041982dSJonathan Peyton     // distinguish them
2548838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2549838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2550838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2551838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
25527cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25537cc577a4SJonathan Peyton 
255482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2555f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
255682e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
255782e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
255882e94a59SJoachim Protze           &(my_task_data), codeptr);
255982e94a59SJoachim Protze     }
256082e94a59SJoachim Protze #endif
256182e94a59SJoachim Protze 
25623041982dSJonathan Peyton     if (!taskdata->td_flags.team_serial ||
25633041982dSJonathan Peyton         (thread->th.th_task_team != NULL &&
2564996baa58SShilei Tian          (thread->th.th_task_team->tt.tt_found_proxy_tasks ||
2565996baa58SShilei Tian           thread->th.th_task_team->tt.tt_hidden_helper_task_encountered))) {
2566e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
2567e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *, &(taskgroup->count)), 0U);
256837e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskgroup->count) != 0) {
25693041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
25703041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
25713041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
25727cc577a4SJonathan Peyton       }
25737cc577a4SJonathan Peyton     }
2574a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread; // end waiting
25757cc577a4SJonathan Peyton 
257682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2577f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
257882e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
257982e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
258082e94a59SJoachim Protze           &(my_task_data), codeptr);
258182e94a59SJoachim Protze     }
258282e94a59SJoachim Protze #endif
258382e94a59SJoachim Protze 
25847cc577a4SJonathan Peyton #if USE_ITT_BUILD
2585838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
2586ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with descendants
25877cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25887cc577a4SJonathan Peyton   }
25897cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup->count == 0);
25907cc577a4SJonathan Peyton 
259144575657SPeyton, Jonathan L   if (taskgroup->reduce_data != NULL &&
259244575657SPeyton, Jonathan L       !taskgroup->gomp_data) { // need to reduce?
2593a8426ac8SJonathan Peyton     int cnt;
2594a8426ac8SJonathan Peyton     void *reduce_data;
2595a8426ac8SJonathan Peyton     kmp_team_t *t = thread->th.th_team;
2596a8426ac8SJonathan Peyton     kmp_taskred_data_t *arr = (kmp_taskred_data_t *)taskgroup->reduce_data;
2597a8426ac8SJonathan Peyton     // check if <priv> data of the first reduction variable shared for the team
2598a8426ac8SJonathan Peyton     void *priv0 = arr[0].reduce_priv;
2599a8426ac8SJonathan Peyton     if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[0])) != NULL &&
2600a8426ac8SJonathan Peyton         ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2601a8426ac8SJonathan Peyton       // finishing task reduction on parallel
2602a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[0]);
2603a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2604a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2605a8426ac8SJonathan Peyton         // finalize task reduction:
260672ba2109SAndrey Churbanov         __kmp_task_reduction_fini(thread, taskgroup);
2607a8426ac8SJonathan Peyton         // cleanup fields in the team structure:
2608a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2609a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2610a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[0], NULL);
2611a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[0], 0);
2612a8426ac8SJonathan Peyton       } else {
2613a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2614a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2615a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2616a8426ac8SJonathan Peyton       }
2617a8426ac8SJonathan Peyton     } else if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[1])) !=
2618a8426ac8SJonathan Peyton                    NULL &&
2619a8426ac8SJonathan Peyton                ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2620a8426ac8SJonathan Peyton       // finishing task reduction on worksharing
2621a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[1]);
2622a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2623a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2624a8426ac8SJonathan Peyton         __kmp_task_reduction_fini(thread, taskgroup);
2625a8426ac8SJonathan Peyton         // cleanup fields in team structure:
2626a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2627a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2628a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[1], NULL);
2629a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[1], 0);
2630a8426ac8SJonathan Peyton       } else {
2631a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2632a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2633a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2634a8426ac8SJonathan Peyton       }
2635a8426ac8SJonathan Peyton     } else {
2636a8426ac8SJonathan Peyton       // finishing task reduction on taskgroup
2637a8426ac8SJonathan Peyton       __kmp_task_reduction_fini(thread, taskgroup);
2638a8426ac8SJonathan Peyton     }
2639a8426ac8SJonathan Peyton   }
26407cc577a4SJonathan Peyton   // Restore parent taskgroup for the current task
26417cc577a4SJonathan Peyton   taskdata->td_taskgroup = taskgroup->parent;
26427cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskgroup);
26437cc577a4SJonathan Peyton 
26443041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(exit): T#%d task %p finished waiting\n",
26453041982dSJonathan Peyton                 gtid, taskdata));
264682e94a59SJoachim Protze 
264782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2648f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
264982e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
265082e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
265182e94a59SJoachim Protze         &(my_task_data), codeptr);
265282e94a59SJoachim Protze   }
265382e94a59SJoachim Protze #endif
26547cc577a4SJonathan Peyton }
26557cc577a4SJonathan Peyton 
26567cc577a4SJonathan Peyton // __kmp_remove_my_task: remove a task from my own deque
26573041982dSJonathan Peyton static kmp_task_t *__kmp_remove_my_task(kmp_info_t *thread, kmp_int32 gtid,
26583041982dSJonathan Peyton                                         kmp_task_team_t *task_team,
26593041982dSJonathan Peyton                                         kmp_int32 is_constrained) {
26607cc577a4SJonathan Peyton   kmp_task_t *task;
26617cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
26627cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
26637cc577a4SJonathan Peyton   kmp_uint32 tail;
26647cc577a4SJonathan Peyton 
26657cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
26663041982dSJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_threads_data !=
26673041982dSJonathan Peyton                    NULL); // Caller should check this condition
26687cc577a4SJonathan Peyton 
26697cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
26707cc577a4SJonathan Peyton 
26717cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(enter): T#%d ntasks=%d head=%u tail=%u\n",
26723041982dSJonathan Peyton                 gtid, thread_data->td.td_deque_ntasks,
26733041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26747cc577a4SJonathan Peyton 
26757cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26763041982dSJonathan Peyton     KA_TRACE(10,
26773041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #1): T#%d No tasks to remove: "
26783041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26793041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26803041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26817cc577a4SJonathan Peyton     return NULL;
26827cc577a4SJonathan Peyton   }
26837cc577a4SJonathan Peyton 
26847cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
26857cc577a4SJonathan Peyton 
26867cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26877cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
26883041982dSJonathan Peyton     KA_TRACE(10,
26893041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
26903041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26913041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26923041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26937cc577a4SJonathan Peyton     return NULL;
26947cc577a4SJonathan Peyton   }
26957cc577a4SJonathan Peyton 
26963041982dSJonathan Peyton   tail = (thread_data->td.td_deque_tail - 1) &
26973041982dSJonathan Peyton          TASK_DEQUE_MASK(thread_data->td); // Wrap index.
26987cc577a4SJonathan Peyton   taskdata = thread_data->td.td_deque[tail];
26997cc577a4SJonathan Peyton 
2700c3344345SAndrey Churbanov   if (!__kmp_task_is_allowed(gtid, is_constrained, taskdata,
2701c3344345SAndrey Churbanov                              thread->th.th_current_task)) {
2702a756cb24SAndrey Churbanov     // The TSC does not allow to steal victim task
27037cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
2704c3344345SAndrey Churbanov     KA_TRACE(10,
2705c3344345SAndrey Churbanov              ("__kmp_remove_my_task(exit #3): T#%d TSC blocks tail task: "
27063041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27073041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
2708c3344345SAndrey Churbanov               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27097cc577a4SJonathan Peyton     return NULL;
27107cc577a4SJonathan Peyton   }
27117cc577a4SJonathan Peyton 
27127cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = tail;
27137cc577a4SJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks, thread_data->td.td_deque_ntasks - 1);
27147cc577a4SJonathan Peyton 
27157cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
27167cc577a4SJonathan Peyton 
2717c3344345SAndrey Churbanov   KA_TRACE(10, ("__kmp_remove_my_task(exit #4): T#%d task %p removed: "
27183041982dSJonathan Peyton                 "ntasks=%d head=%u tail=%u\n",
27193041982dSJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
27203041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27217cc577a4SJonathan Peyton 
27227cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
27237cc577a4SJonathan Peyton   return task;
27247cc577a4SJonathan Peyton }
27257cc577a4SJonathan Peyton 
27267cc577a4SJonathan Peyton // __kmp_steal_task: remove a task from another thread's deque
27277cc577a4SJonathan Peyton // Assume that calling thread has already checked existence of
27287cc577a4SJonathan Peyton // task_team thread_data before calling this routine.
2729a756cb24SAndrey Churbanov static kmp_task_t *__kmp_steal_task(kmp_info_t *victim_thr, kmp_int32 gtid,
2730c47afcd9SAndrey Churbanov                                     kmp_task_team_t *task_team,
273137e2ef54SJonathan Peyton                                     std::atomic<kmp_int32> *unfinished_threads,
2732c47afcd9SAndrey Churbanov                                     int *thread_finished,
2733c47afcd9SAndrey Churbanov                                     kmp_int32 is_constrained) {
27347cc577a4SJonathan Peyton   kmp_task_t *task;
27357cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
2736a756cb24SAndrey Churbanov   kmp_taskdata_t *current;
27377cc577a4SJonathan Peyton   kmp_thread_data_t *victim_td, *threads_data;
2738c3344345SAndrey Churbanov   kmp_int32 target;
27397cc577a4SJonathan Peyton   kmp_int32 victim_tid;
27407cc577a4SJonathan Peyton 
27417cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
27427cc577a4SJonathan Peyton 
27437cc577a4SJonathan Peyton   threads_data = task_team->tt.tt_threads_data;
27447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL); // Caller should check this condition
27457cc577a4SJonathan Peyton 
2746a756cb24SAndrey Churbanov   victim_tid = victim_thr->th.th_info.ds.ds_tid;
27477cc577a4SJonathan Peyton   victim_td = &threads_data[victim_tid];
27487cc577a4SJonathan Peyton 
27493041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_steal_task(enter): T#%d try to steal from T#%d: "
2750a756cb24SAndrey Churbanov                 "task_team=%p ntasks=%d head=%u tail=%u\n",
2751a756cb24SAndrey Churbanov                 gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27523041982dSJonathan Peyton                 victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27533041982dSJonathan Peyton                 victim_td->td.td_deque_tail));
27547cc577a4SJonathan Peyton 
2755a756cb24SAndrey Churbanov   if (TCR_4(victim_td->td.td_deque_ntasks) == 0) {
27563041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #1): T#%d could not steal from T#%d: "
2757a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2758a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27593041982dSJonathan Peyton                   victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27603041982dSJonathan Peyton                   victim_td->td.td_deque_tail));
27617cc577a4SJonathan Peyton     return NULL;
27627cc577a4SJonathan Peyton   }
27637cc577a4SJonathan Peyton 
27647cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&victim_td->td.td_deque_lock);
27657cc577a4SJonathan Peyton 
2766a756cb24SAndrey Churbanov   int ntasks = TCR_4(victim_td->td.td_deque_ntasks);
27677cc577a4SJonathan Peyton   // Check again after we acquire the lock
2768a756cb24SAndrey Churbanov   if (ntasks == 0) {
27697cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
27703041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #2): T#%d could not steal from T#%d: "
2771a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2772a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2773a756cb24SAndrey Churbanov                   victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27747cc577a4SJonathan Peyton     return NULL;
27757cc577a4SJonathan Peyton   }
27767cc577a4SJonathan Peyton 
27777cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(victim_td->td.td_deque != NULL);
2778c3344345SAndrey Churbanov   current = __kmp_threads[gtid]->th.th_current_task;
27797cc577a4SJonathan Peyton   taskdata = victim_td->td.td_deque[victim_td->td.td_deque_head];
2780c3344345SAndrey Churbanov   if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2781c3344345SAndrey Churbanov     // Bump head pointer and Wrap.
2782c3344345SAndrey Churbanov     victim_td->td.td_deque_head =
2783c3344345SAndrey Churbanov         (victim_td->td.td_deque_head + 1) & TASK_DEQUE_MASK(victim_td->td);
2784c3344345SAndrey Churbanov   } else {
2785a756cb24SAndrey Churbanov     if (!task_team->tt.tt_untied_task_encountered) {
2786a756cb24SAndrey Churbanov       // The TSC does not allow to steal victim task
27877cc577a4SJonathan Peyton       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2788c3344345SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #3): T#%d could not steal from "
2789a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2790a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
27917cc577a4SJonathan Peyton                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27927cc577a4SJonathan Peyton       return NULL;
27937cc577a4SJonathan Peyton     }
2794a756cb24SAndrey Churbanov     int i;
2795a756cb24SAndrey Churbanov     // walk through victim's deque trying to steal any task
2796a756cb24SAndrey Churbanov     target = victim_td->td.td_deque_head;
2797c3344345SAndrey Churbanov     taskdata = NULL;
2798a756cb24SAndrey Churbanov     for (i = 1; i < ntasks; ++i) {
2799a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2800a756cb24SAndrey Churbanov       taskdata = victim_td->td.td_deque[target];
2801c3344345SAndrey Churbanov       if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2802c3344345SAndrey Churbanov         break; // found victim task
2803c3344345SAndrey Churbanov       } else {
2804a756cb24SAndrey Churbanov         taskdata = NULL;
2805a756cb24SAndrey Churbanov       }
2806a756cb24SAndrey Churbanov     }
2807a756cb24SAndrey Churbanov     if (taskdata == NULL) {
2808a756cb24SAndrey Churbanov       // No appropriate candidate to steal found
2809a756cb24SAndrey Churbanov       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2810a756cb24SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #4): T#%d could not steal from "
2811a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2812a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2813a756cb24SAndrey Churbanov                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
2814a756cb24SAndrey Churbanov       return NULL;
2815a756cb24SAndrey Churbanov     }
2816a756cb24SAndrey Churbanov     int prev = target;
2817a756cb24SAndrey Churbanov     for (i = i + 1; i < ntasks; ++i) {
2818a756cb24SAndrey Churbanov       // shift remaining tasks in the deque left by 1
2819a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2820a756cb24SAndrey Churbanov       victim_td->td.td_deque[prev] = victim_td->td.td_deque[target];
2821a756cb24SAndrey Churbanov       prev = target;
2822a756cb24SAndrey Churbanov     }
2823baad3f60SJonathan Peyton     KMP_DEBUG_ASSERT(
2824baad3f60SJonathan Peyton         victim_td->td.td_deque_tail ==
2825baad3f60SJonathan Peyton         (kmp_uint32)((target + 1) & TASK_DEQUE_MASK(victim_td->td)));
2826a756cb24SAndrey Churbanov     victim_td->td.td_deque_tail = target; // tail -= 1 (wrapped))
2827a756cb24SAndrey Churbanov   }
28287cc577a4SJonathan Peyton   if (*thread_finished) {
28293041982dSJonathan Peyton     // We need to un-mark this victim as a finished victim.  This must be done
28303041982dSJonathan Peyton     // before releasing the lock, or else other threads (starting with the
283197d000cfStlwilmar     // primary thread victim) might be prematurely released from the barrier!!!
28328b81524cSAndreyChurbanov #if KMP_DEBUG
28338b81524cSAndreyChurbanov     kmp_int32 count =
28348b81524cSAndreyChurbanov #endif
28358b81524cSAndreyChurbanov         KMP_ATOMIC_INC(unfinished_threads);
28363041982dSJonathan Peyton     KA_TRACE(
28373041982dSJonathan Peyton         20,
28383041982dSJonathan Peyton         ("__kmp_steal_task: T#%d inc unfinished_threads to %d: task_team=%p\n",
28397cc577a4SJonathan Peyton          gtid, count + 1, task_team));
28407cc577a4SJonathan Peyton     *thread_finished = FALSE;
28417cc577a4SJonathan Peyton   }
2842a756cb24SAndrey Churbanov   TCW_4(victim_td->td.td_deque_ntasks, ntasks - 1);
28433041982dSJonathan Peyton 
28447cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
28457cc577a4SJonathan Peyton 
28467cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(TASK_stolen);
2847a756cb24SAndrey Churbanov   KA_TRACE(10,
2848a756cb24SAndrey Churbanov            ("__kmp_steal_task(exit #5): T#%d stole task %p from T#%d: "
2849a756cb24SAndrey Churbanov             "task_team=%p ntasks=%d head=%u tail=%u\n",
2850a756cb24SAndrey Churbanov             gtid, taskdata, __kmp_gtid_from_thread(victim_thr), task_team,
2851a756cb24SAndrey Churbanov             ntasks, victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28527cc577a4SJonathan Peyton 
28537cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
28547cc577a4SJonathan Peyton   return task;
28557cc577a4SJonathan Peyton }
28567cc577a4SJonathan Peyton 
28573041982dSJonathan Peyton // __kmp_execute_tasks_template: Choose and execute tasks until either the
28583041982dSJonathan Peyton // condition is statisfied (return true) or there are none left (return false).
28593041982dSJonathan Peyton //
28607cc577a4SJonathan Peyton // final_spin is TRUE if this is the spin at the release barrier.
28617cc577a4SJonathan Peyton // thread_finished indicates whether the thread is finished executing all
28627cc577a4SJonathan Peyton // the tasks it has on its deque, and is at the release barrier.
28637cc577a4SJonathan Peyton // spinner is the location on which to spin.
28647cc577a4SJonathan Peyton // spinner == NULL means only execute a single task and return.
28657cc577a4SJonathan Peyton // checker is the value to check to terminate the spin.
28667cc577a4SJonathan Peyton template <class C>
28673041982dSJonathan Peyton static inline int __kmp_execute_tasks_template(
28683041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, C *flag, int final_spin,
28693041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
28703041982dSJonathan Peyton     kmp_int32 is_constrained) {
28717cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
28727cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
28737cc577a4SJonathan Peyton   kmp_task_t *task;
28747cc577a4SJonathan Peyton   kmp_info_t *other_thread;
28757cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
287637e2ef54SJonathan Peyton   std::atomic<kmp_int32> *unfinished_threads;
2877a756cb24SAndrey Churbanov   kmp_int32 nthreads, victim_tid = -2, use_own_tasks = 1, new_victim = 0,
28783041982dSJonathan Peyton                       tid = thread->th.th_info.ds.ds_tid;
28797cc577a4SJonathan Peyton 
28807cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
28817cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread == __kmp_threads[gtid]);
28827cc577a4SJonathan Peyton 
2883a4a9c48cSJonathan Peyton   if (task_team == NULL || current_task == NULL)
28843041982dSJonathan Peyton     return FALSE;
28857cc577a4SJonathan Peyton 
28863041982dSJonathan Peyton   KA_TRACE(15, ("__kmp_execute_tasks_template(enter): T#%d final_spin=%d "
28873041982dSJonathan Peyton                 "*thread_finished=%d\n",
28887cc577a4SJonathan Peyton                 gtid, final_spin, *thread_finished));
28897cc577a4SJonathan Peyton 
2890581490e7SAndrey Churbanov   thread->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
28917cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
28929d64275aSShilei Tian 
28937cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
28947cc577a4SJonathan Peyton 
28957cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
28967cc577a4SJonathan Peyton   unfinished_threads = &(task_team->tt.tt_unfinished_threads);
28979d64275aSShilei Tian   KMP_DEBUG_ASSERT(nthreads > 1 || task_team->tt.tt_found_proxy_tasks ||
28989d64275aSShilei Tian                    task_team->tt.tt_hidden_helper_task_encountered);
289937e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(*unfinished_threads >= 0);
29007cc577a4SJonathan Peyton 
29013041982dSJonathan Peyton   while (1) { // Outer loop keeps trying to find tasks in case of single thread
29023041982dSJonathan Peyton     // getting tasks from target constructs
29037cc577a4SJonathan Peyton     while (1) { // Inner loop to find a task and execute it
29047cc577a4SJonathan Peyton       task = NULL;
29057cc577a4SJonathan Peyton       if (use_own_tasks) { // check on own queue first
29067cc577a4SJonathan Peyton         task = __kmp_remove_my_task(thread, gtid, task_team, is_constrained);
29077cc577a4SJonathan Peyton       }
29087cc577a4SJonathan Peyton       if ((task == NULL) && (nthreads > 1)) { // Steal a task
29097cc577a4SJonathan Peyton         int asleep = 1;
29107cc577a4SJonathan Peyton         use_own_tasks = 0;
29117cc577a4SJonathan Peyton         // Try to steal from the last place I stole from successfully.
2912a756cb24SAndrey Churbanov         if (victim_tid == -2) { // haven't stolen anything yet
2913a756cb24SAndrey Churbanov           victim_tid = threads_data[tid].td.td_deque_last_stolen;
2914a756cb24SAndrey Churbanov           if (victim_tid !=
29153041982dSJonathan Peyton               -1) // if we have a last stolen from victim, get the thread
2916a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29177cc577a4SJonathan Peyton         }
2918a756cb24SAndrey Churbanov         if (victim_tid != -1) { // found last victim
29197cc577a4SJonathan Peyton           asleep = 0;
29203041982dSJonathan Peyton         } else if (!new_victim) { // no recent steals and we haven't already
29213041982dSJonathan Peyton           // used a new victim; select a random thread
29227cc577a4SJonathan Peyton           do { // Find a different thread to steal work from.
29233041982dSJonathan Peyton             // Pick a random thread. Initial plan was to cycle through all the
29243041982dSJonathan Peyton             // threads, and only return if we tried to steal from every thread,
29253041982dSJonathan Peyton             // and failed.  Arch says that's not such a great idea.
2926a756cb24SAndrey Churbanov             victim_tid = __kmp_get_random(thread) % (nthreads - 1);
2927a756cb24SAndrey Churbanov             if (victim_tid >= tid) {
2928a756cb24SAndrey Churbanov               ++victim_tid; // Adjusts random distribution to exclude self
29297cc577a4SJonathan Peyton             }
29307cc577a4SJonathan Peyton             // Found a potential victim
2931a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29323041982dSJonathan Peyton             // There is a slight chance that __kmp_enable_tasking() did not wake
29333041982dSJonathan Peyton             // up all threads waiting at the barrier.  If victim is sleeping,
29343041982dSJonathan Peyton             // then wake it up. Since we were going to pay the cache miss
29353041982dSJonathan Peyton             // penalty for referencing another thread's kmp_info_t struct
29363041982dSJonathan Peyton             // anyway,
29373041982dSJonathan Peyton             // the check shouldn't cost too much performance at this point. In
29383041982dSJonathan Peyton             // extra barrier mode, tasks do not sleep at the separate tasking
29393041982dSJonathan Peyton             // barrier, so this isn't a problem.
29407cc577a4SJonathan Peyton             asleep = 0;
29417cc577a4SJonathan Peyton             if ((__kmp_tasking_mode == tskm_task_teams) &&
29427cc577a4SJonathan Peyton                 (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) &&
2943c47afcd9SAndrey Churbanov                 (TCR_PTR(CCAST(void *, other_thread->th.th_sleep_loc)) !=
2944c47afcd9SAndrey Churbanov                  NULL)) {
29457cc577a4SJonathan Peyton               asleep = 1;
2946d8e4cb91STerry Wilmarth               __kmp_null_resume_wrapper(other_thread);
29473041982dSJonathan Peyton               // A sleeping thread should not have any tasks on it's queue.
29483041982dSJonathan Peyton               // There is a slight possibility that it resumes, steals a task
29493041982dSJonathan Peyton               // from another thread, which spawns more tasks, all in the time
29503041982dSJonathan Peyton               // that it takes this thread to check => don't write an assertion
29513041982dSJonathan Peyton               // that the victim's queue is empty.  Try stealing from a
29523041982dSJonathan Peyton               // different thread.
29537cc577a4SJonathan Peyton             }
29547cc577a4SJonathan Peyton           } while (asleep);
29557cc577a4SJonathan Peyton         }
29567cc577a4SJonathan Peyton 
29577cc577a4SJonathan Peyton         if (!asleep) {
29587cc577a4SJonathan Peyton           // We have a victim to try to steal from
29593041982dSJonathan Peyton           task = __kmp_steal_task(other_thread, gtid, task_team,
29603041982dSJonathan Peyton                                   unfinished_threads, thread_finished,
29613041982dSJonathan Peyton                                   is_constrained);
29627cc577a4SJonathan Peyton         }
29637cc577a4SJonathan Peyton         if (task != NULL) { // set last stolen to victim
2964a756cb24SAndrey Churbanov           if (threads_data[tid].td.td_deque_last_stolen != victim_tid) {
2965a756cb24SAndrey Churbanov             threads_data[tid].td.td_deque_last_stolen = victim_tid;
29663041982dSJonathan Peyton             // The pre-refactored code did not try more than 1 successful new
29673041982dSJonathan Peyton             // vicitm, unless the last one generated more local tasks;
29683041982dSJonathan Peyton             // new_victim keeps track of this
29697cc577a4SJonathan Peyton             new_victim = 1;
29707cc577a4SJonathan Peyton           }
29713041982dSJonathan Peyton         } else { // No tasks found; unset last_stolen
29727cc577a4SJonathan Peyton           KMP_CHECK_UPDATE(threads_data[tid].td.td_deque_last_stolen, -1);
2973a756cb24SAndrey Churbanov           victim_tid = -2; // no successful victim found
29747cc577a4SJonathan Peyton         }
29757cc577a4SJonathan Peyton       }
29767cc577a4SJonathan Peyton 
29779d64275aSShilei Tian       if (task == NULL)
29789d64275aSShilei Tian         break; // break out of tasking loop
29797cc577a4SJonathan Peyton 
29807cc577a4SJonathan Peyton // Found a task; execute it
29817cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
29827cc577a4SJonathan Peyton       if (__itt_sync_create_ptr || KMP_ITT_DEBUG) {
29833041982dSJonathan Peyton         if (itt_sync_obj == NULL) { // we are at fork barrier where we could not
29843041982dSJonathan Peyton           // get the object reliably
29857cc577a4SJonathan Peyton           itt_sync_obj = __kmp_itt_barrier_object(gtid, bs_forkjoin_barrier);
29867cc577a4SJonathan Peyton         }
29877cc577a4SJonathan Peyton         __kmp_itt_task_starting(itt_sync_obj);
29887cc577a4SJonathan Peyton       }
29897cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY */
29907cc577a4SJonathan Peyton       __kmp_invoke_task(gtid, task, current_task);
29917cc577a4SJonathan Peyton #if USE_ITT_BUILD
29923041982dSJonathan Peyton       if (itt_sync_obj != NULL)
29933041982dSJonathan Peyton         __kmp_itt_task_finished(itt_sync_obj);
29947cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
29953041982dSJonathan Peyton       // If this thread is only partway through the barrier and the condition is
29963041982dSJonathan Peyton       // met, then return now, so that the barrier gather/release pattern can
29973041982dSJonathan Peyton       // proceed. If this thread is in the last spin loop in the barrier,
29983041982dSJonathan Peyton       // waiting to be released, we know that the termination condition will not
299942016791SKazuaki Ishizaki       // be satisfied, so don't waste any cycles checking it.
30007cc577a4SJonathan Peyton       if (flag == NULL || (!final_spin && flag->done_check())) {
30013041982dSJonathan Peyton         KA_TRACE(
30023041982dSJonathan Peyton             15,
30033041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30043041982dSJonathan Peyton              gtid));
30057cc577a4SJonathan Peyton         return TRUE;
30067cc577a4SJonathan Peyton       }
30077cc577a4SJonathan Peyton       if (thread->th.th_task_team == NULL) {
30087cc577a4SJonathan Peyton         break;
30097cc577a4SJonathan Peyton       }
3010e47d32f1SJonathan Peyton       KMP_YIELD(__kmp_library == library_throughput); // Yield before next task
30113041982dSJonathan Peyton       // If execution of a stolen task results in more tasks being placed on our
30123041982dSJonathan Peyton       // run queue, reset use_own_tasks
30137cc577a4SJonathan Peyton       if (!use_own_tasks && TCR_4(threads_data[tid].td.td_deque_ntasks) != 0) {
30143041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d stolen task spawned "
30153041982dSJonathan Peyton                       "other tasks, restart\n",
30163041982dSJonathan Peyton                       gtid));
30177cc577a4SJonathan Peyton         use_own_tasks = 1;
30187cc577a4SJonathan Peyton         new_victim = 0;
30197cc577a4SJonathan Peyton       }
30207cc577a4SJonathan Peyton     }
30217cc577a4SJonathan Peyton 
3022e4b4f994SJonathan Peyton     // The task source has been exhausted. If in final spin loop of barrier,
3023e4b4f994SJonathan Peyton     // check if termination condition is satisfied. The work queue may be empty
3024e4b4f994SJonathan Peyton     // but there might be proxy tasks still executing.
302537e2ef54SJonathan Peyton     if (final_spin &&
3026e4b4f994SJonathan Peyton         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks) == 0) {
30273041982dSJonathan Peyton       // First, decrement the #unfinished threads, if that has not already been
30283041982dSJonathan Peyton       // done.  This decrement might be to the spin location, and result in the
30293041982dSJonathan Peyton       // termination condition being satisfied.
30307cc577a4SJonathan Peyton       if (!*thread_finished) {
30318b81524cSAndreyChurbanov #if KMP_DEBUG
30328b81524cSAndreyChurbanov         kmp_int32 count = -1 +
30338b81524cSAndreyChurbanov #endif
30348b81524cSAndreyChurbanov             KMP_ATOMIC_DEC(unfinished_threads);
30353041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d dec "
30363041982dSJonathan Peyton                       "unfinished_threads to %d task_team=%p\n",
30377cc577a4SJonathan Peyton                       gtid, count, task_team));
30387cc577a4SJonathan Peyton         *thread_finished = TRUE;
30397cc577a4SJonathan Peyton       }
30407cc577a4SJonathan Peyton 
30417cc577a4SJonathan Peyton       // It is now unsafe to reference thread->th.th_team !!!
304297d000cfStlwilmar       // Decrementing task_team->tt.tt_unfinished_threads can allow the primary
30433041982dSJonathan Peyton       // thread to pass through the barrier, where it might reset each thread's
30443041982dSJonathan Peyton       // th.th_team field for the next parallel region. If we can steal more
30453041982dSJonathan Peyton       // work, we know that this has not happened yet.
30467cc577a4SJonathan Peyton       if (flag != NULL && flag->done_check()) {
30473041982dSJonathan Peyton         KA_TRACE(
30483041982dSJonathan Peyton             15,
30493041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30503041982dSJonathan Peyton              gtid));
30517cc577a4SJonathan Peyton         return TRUE;
30527cc577a4SJonathan Peyton       }
30537cc577a4SJonathan Peyton     }
30547cc577a4SJonathan Peyton 
305597d000cfStlwilmar     // If this thread's task team is NULL, primary thread has recognized that
305697d000cfStlwilmar     // there are no more tasks; bail out
30577cc577a4SJonathan Peyton     if (thread->th.th_task_team == NULL) {
30583041982dSJonathan Peyton       KA_TRACE(15,
30593041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d no more tasks\n", gtid));
30607cc577a4SJonathan Peyton       return FALSE;
30617cc577a4SJonathan Peyton     }
30627cc577a4SJonathan Peyton 
30633041982dSJonathan Peyton     // We could be getting tasks from target constructs; if this is the only
30643041982dSJonathan Peyton     // thread, keep trying to execute tasks from own queue
30659d64275aSShilei Tian     if (nthreads == 1 &&
30669d64275aSShilei Tian         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks))
30677cc577a4SJonathan Peyton       use_own_tasks = 1;
3068e4b4f994SJonathan Peyton     else {
30693041982dSJonathan Peyton       KA_TRACE(15,
30703041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d can't find work\n", gtid));
30717cc577a4SJonathan Peyton       return FALSE;
30727cc577a4SJonathan Peyton     }
30737cc577a4SJonathan Peyton   }
30747cc577a4SJonathan Peyton }
30757cc577a4SJonathan Peyton 
3076e0665a90STerry Wilmarth template <bool C, bool S>
30773041982dSJonathan Peyton int __kmp_execute_tasks_32(
3078e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32<C, S> *flag, int final_spin,
30793041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30803041982dSJonathan Peyton     kmp_int32 is_constrained) {
30813041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30823041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30833041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30847cc577a4SJonathan Peyton }
30857cc577a4SJonathan Peyton 
3086e0665a90STerry Wilmarth template <bool C, bool S>
30873041982dSJonathan Peyton int __kmp_execute_tasks_64(
3088e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64<C, S> *flag, int final_spin,
30893041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30903041982dSJonathan Peyton     kmp_int32 is_constrained) {
30913041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30923041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30933041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30947cc577a4SJonathan Peyton }
30957cc577a4SJonathan Peyton 
3096d8e4cb91STerry Wilmarth template <bool C, bool S>
3097d8e4cb91STerry Wilmarth int __kmp_atomic_execute_tasks_64(
3098d8e4cb91STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_atomic_flag_64<C, S> *flag,
3099d8e4cb91STerry Wilmarth     int final_spin, int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
3100d8e4cb91STerry Wilmarth     kmp_int32 is_constrained) {
3101d8e4cb91STerry Wilmarth   return __kmp_execute_tasks_template(
3102d8e4cb91STerry Wilmarth       thread, gtid, flag, final_spin,
3103d8e4cb91STerry Wilmarth       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
3104d8e4cb91STerry Wilmarth }
3105d8e4cb91STerry Wilmarth 
31063041982dSJonathan Peyton int __kmp_execute_tasks_oncore(
31073041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
31083041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31093041982dSJonathan Peyton     kmp_int32 is_constrained) {
31103041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31113041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31123041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31137cc577a4SJonathan Peyton }
31147cc577a4SJonathan Peyton 
3115e0665a90STerry Wilmarth template int
3116e0665a90STerry Wilmarth __kmp_execute_tasks_32<false, false>(kmp_info_t *, kmp_int32,
3117e0665a90STerry Wilmarth                                      kmp_flag_32<false, false> *, int,
3118e0665a90STerry Wilmarth                                      int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3119e0665a90STerry Wilmarth 
3120e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<false, true>(kmp_info_t *, kmp_int32,
3121e0665a90STerry Wilmarth                                                  kmp_flag_64<false, true> *,
3122e0665a90STerry Wilmarth                                                  int,
3123e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3124e0665a90STerry Wilmarth                                                  kmp_int32);
3125e0665a90STerry Wilmarth 
3126e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<true, false>(kmp_info_t *, kmp_int32,
3127e0665a90STerry Wilmarth                                                  kmp_flag_64<true, false> *,
3128e0665a90STerry Wilmarth                                                  int,
3129e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3130e0665a90STerry Wilmarth                                                  kmp_int32);
3131e0665a90STerry Wilmarth 
3132d8e4cb91STerry Wilmarth template int __kmp_atomic_execute_tasks_64<false, true>(
3133d8e4cb91STerry Wilmarth     kmp_info_t *, kmp_int32, kmp_atomic_flag_64<false, true> *, int,
3134d8e4cb91STerry Wilmarth     int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3135d8e4cb91STerry Wilmarth 
3136d8e4cb91STerry Wilmarth template int __kmp_atomic_execute_tasks_64<true, false>(
3137d8e4cb91STerry Wilmarth     kmp_info_t *, kmp_int32, kmp_atomic_flag_64<true, false> *, int,
3138d8e4cb91STerry Wilmarth     int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3139d8e4cb91STerry Wilmarth 
31407cc577a4SJonathan Peyton // __kmp_enable_tasking: Allocate task team and resume threads sleeping at the
31417cc577a4SJonathan Peyton // next barrier so they can assist in executing enqueued tasks.
31427cc577a4SJonathan Peyton // First thread in allocates the task team atomically.
31433041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
31443041982dSJonathan Peyton                                  kmp_info_t *this_thr) {
31457cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
31467cc577a4SJonathan Peyton   int nthreads, i, is_init_thread;
31477cc577a4SJonathan Peyton 
31487cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(enter): T#%d\n",
31497cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31507cc577a4SJonathan Peyton 
31517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
31527cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr->th.th_team != NULL);
31537cc577a4SJonathan Peyton 
31547cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
31557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 0);
31567cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads == this_thr->th.th_team->t.t_nproc);
31577cc577a4SJonathan Peyton 
31587cc577a4SJonathan Peyton   // Allocate or increase the size of threads_data if necessary
31597cc577a4SJonathan Peyton   is_init_thread = __kmp_realloc_task_threads_data(this_thr, task_team);
31607cc577a4SJonathan Peyton 
31617cc577a4SJonathan Peyton   if (!is_init_thread) {
31627cc577a4SJonathan Peyton     // Some other thread already set up the array.
31633041982dSJonathan Peyton     KA_TRACE(
31643041982dSJonathan Peyton         20,
31653041982dSJonathan Peyton         ("__kmp_enable_tasking(exit): T#%d: threads array already set up.\n",
31667cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr)));
31677cc577a4SJonathan Peyton     return;
31687cc577a4SJonathan Peyton   }
31697cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
31707cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
31717cc577a4SJonathan Peyton 
31729b8bb323SJonathan Peyton   if (__kmp_tasking_mode == tskm_task_teams &&
31733041982dSJonathan Peyton       (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME)) {
31747cc577a4SJonathan Peyton     // Release any threads sleeping at the barrier, so that they can steal
31757cc577a4SJonathan Peyton     // tasks and execute them.  In extra barrier mode, tasks do not sleep
31767cc577a4SJonathan Peyton     // at the separate tasking barrier, so this isn't a problem.
31777cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
3178d8e4cb91STerry Wilmarth       void *sleep_loc;
31797cc577a4SJonathan Peyton       kmp_info_t *thread = threads_data[i].td.td_thr;
31807cc577a4SJonathan Peyton 
31817cc577a4SJonathan Peyton       if (i == this_thr->th.th_info.ds.ds_tid) {
31827cc577a4SJonathan Peyton         continue;
31837cc577a4SJonathan Peyton       }
31847cc577a4SJonathan Peyton       // Since we haven't locked the thread's suspend mutex lock at this
31857cc577a4SJonathan Peyton       // point, there is a small window where a thread might be putting
31867cc577a4SJonathan Peyton       // itself to sleep, but hasn't set the th_sleep_loc field yet.
31877cc577a4SJonathan Peyton       // To work around this, __kmp_execute_tasks_template() periodically checks
31883041982dSJonathan Peyton       // see if other threads are sleeping (using the same random mechanism that
31893041982dSJonathan Peyton       // is used for task stealing) and awakens them if they are.
3190c47afcd9SAndrey Churbanov       if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3191c47afcd9SAndrey Churbanov           NULL) {
31927cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d waking up thread T#%d\n",
31937cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31947cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
3195d8e4cb91STerry Wilmarth         __kmp_null_resume_wrapper(thread);
31963041982dSJonathan Peyton       } else {
31977cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d don't wake up thread T#%d\n",
31987cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31997cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
32007cc577a4SJonathan Peyton       }
32017cc577a4SJonathan Peyton     }
32027cc577a4SJonathan Peyton   }
32037cc577a4SJonathan Peyton 
32047cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(exit): T#%d\n",
32057cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
32067cc577a4SJonathan Peyton }
32077cc577a4SJonathan Peyton 
32087cc577a4SJonathan Peyton /* // TODO: Check the comment consistency
32097cc577a4SJonathan Peyton  * Utility routines for "task teams".  A task team (kmp_task_t) is kind of
32107cc577a4SJonathan Peyton  * like a shadow of the kmp_team_t data struct, with a different lifetime.
32117cc577a4SJonathan Peyton  * After a child * thread checks into a barrier and calls __kmp_release() from
32127cc577a4SJonathan Peyton  * the particular variant of __kmp_<barrier_kind>_barrier_gather(), it can no
32137cc577a4SJonathan Peyton  * longer assume that the kmp_team_t structure is intact (at any moment, the
321497d000cfStlwilmar  * primary thread may exit the barrier code and free the team data structure,
32157cc577a4SJonathan Peyton  * and return the threads to the thread pool).
32167cc577a4SJonathan Peyton  *
3217ed5fe645SKelvin Li  * This does not work with the tasking code, as the thread is still
32187cc577a4SJonathan Peyton  * expected to participate in the execution of any tasks that may have been
32197cc577a4SJonathan Peyton  * spawned my a member of the team, and the thread still needs access to all
32207cc577a4SJonathan Peyton  * to each thread in the team, so that it can steal work from it.
32217cc577a4SJonathan Peyton  *
32227cc577a4SJonathan Peyton  * Enter the existence of the kmp_task_team_t struct.  It employs a reference
322397d000cfStlwilmar  * counting mechanism, and is allocated by the primary thread before calling
32247cc577a4SJonathan Peyton  * __kmp_<barrier_kind>_release, and then is release by the last thread to
32257cc577a4SJonathan Peyton  * exit __kmp_<barrier_kind>_release at the next barrier.  I.e. the lifetimes
32267cc577a4SJonathan Peyton  * of the kmp_task_team_t structs for consecutive barriers can overlap
322797d000cfStlwilmar  * (and will, unless the primary thread is the last thread to exit the barrier
3228e4b4f994SJonathan Peyton  * release phase, which is not typical). The existence of such a struct is
3229e4b4f994SJonathan Peyton  * useful outside the context of tasking.
32307cc577a4SJonathan Peyton  *
32317cc577a4SJonathan Peyton  * We currently use the existence of the threads array as an indicator that
32327cc577a4SJonathan Peyton  * tasks were spawned since the last barrier.  If the structure is to be
32337cc577a4SJonathan Peyton  * useful outside the context of tasking, then this will have to change, but
323442016791SKazuaki Ishizaki  * not setting the field minimizes the performance impact of tasking on
32357cc577a4SJonathan Peyton  * barriers, when no explicit tasks were spawned (pushed, actually).
32367cc577a4SJonathan Peyton  */
32377cc577a4SJonathan Peyton 
32383041982dSJonathan Peyton static kmp_task_team_t *__kmp_free_task_teams =
32393041982dSJonathan Peyton     NULL; // Free list for task_team data structures
32407cc577a4SJonathan Peyton // Lock for task team data structures
3241eaa9e40cSJonathan Peyton kmp_bootstrap_lock_t __kmp_task_team_lock =
32423041982dSJonathan Peyton     KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_task_team_lock);
32437cc577a4SJonathan Peyton 
32447cc577a4SJonathan Peyton // __kmp_alloc_task_deque:
32457cc577a4SJonathan Peyton // Allocates a task deque for a particular thread, and initialize the necessary
32467cc577a4SJonathan Peyton // data structures relating to the deque.  This only happens once per thread
32473041982dSJonathan Peyton // per task team since task teams are recycled. No lock is needed during
32483041982dSJonathan Peyton // allocation since each thread allocates its own deque.
32493041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
32503041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data) {
32517cc577a4SJonathan Peyton   __kmp_init_bootstrap_lock(&thread_data->td.td_deque_lock);
32527cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque == NULL);
32537cc577a4SJonathan Peyton 
32547cc577a4SJonathan Peyton   // Initialize last stolen task field to "none"
32557cc577a4SJonathan Peyton   thread_data->td.td_deque_last_stolen = -1;
32567cc577a4SJonathan Peyton 
32577cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == 0);
32587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_head == 0);
32597cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_tail == 0);
32607cc577a4SJonathan Peyton 
32613041982dSJonathan Peyton   KE_TRACE(
32623041982dSJonathan Peyton       10,
32633041982dSJonathan Peyton       ("__kmp_alloc_task_deque: T#%d allocating deque[%d] for thread_data %p\n",
32647cc577a4SJonathan Peyton        __kmp_gtid_from_thread(thread), INITIAL_TASK_DEQUE_SIZE, thread_data));
32657cc577a4SJonathan Peyton   // Allocate space for task deque, and zero the deque
32667cc577a4SJonathan Peyton   // Cannot use __kmp_thread_calloc() because threads not around for
32677cc577a4SJonathan Peyton   // kmp_reap_task_team( ).
32683041982dSJonathan Peyton   thread_data->td.td_deque = (kmp_taskdata_t **)__kmp_allocate(
32693041982dSJonathan Peyton       INITIAL_TASK_DEQUE_SIZE * sizeof(kmp_taskdata_t *));
32707cc577a4SJonathan Peyton   thread_data->td.td_deque_size = INITIAL_TASK_DEQUE_SIZE;
32717cc577a4SJonathan Peyton }
32727cc577a4SJonathan Peyton 
32737cc577a4SJonathan Peyton // __kmp_free_task_deque:
32743041982dSJonathan Peyton // Deallocates a task deque for a particular thread. Happens at library
32753041982dSJonathan Peyton // deallocation so don't need to reset all thread data fields.
32763041982dSJonathan Peyton static void __kmp_free_task_deque(kmp_thread_data_t *thread_data) {
32777cc577a4SJonathan Peyton   if (thread_data->td.td_deque != NULL) {
32781b536724SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
32797cc577a4SJonathan Peyton     TCW_4(thread_data->td.td_deque_ntasks, 0);
32807cc577a4SJonathan Peyton     __kmp_free(thread_data->td.td_deque);
32817cc577a4SJonathan Peyton     thread_data->td.td_deque = NULL;
32827cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
32831b536724SJonathan Peyton   }
32847cc577a4SJonathan Peyton 
32857cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
32867cc577a4SJonathan Peyton   // GEH: Figure out what to do here for td_susp_tied_tasks
32877cc577a4SJonathan Peyton   if (thread_data->td.td_susp_tied_tasks.ts_entries != TASK_STACK_EMPTY) {
32887cc577a4SJonathan Peyton     __kmp_free_task_stack(__kmp_thread_from_gtid(gtid), thread_data);
32897cc577a4SJonathan Peyton   }
32907cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
32917cc577a4SJonathan Peyton }
32927cc577a4SJonathan Peyton 
32937cc577a4SJonathan Peyton // __kmp_realloc_task_threads_data:
32943041982dSJonathan Peyton // Allocates a threads_data array for a task team, either by allocating an
32953041982dSJonathan Peyton // initial array or enlarging an existing array.  Only the first thread to get
32964c6a098aSKazuaki Ishizaki // the lock allocs or enlarges the array and re-initializes the array elements.
32977cc577a4SJonathan Peyton // That thread returns "TRUE", the rest return "FALSE".
32987cc577a4SJonathan Peyton // Assumes that the new array size is given by task_team -> tt.tt_nproc.
32997cc577a4SJonathan Peyton // The current size is given by task_team -> tt.tt_max_threads.
33003041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
33013041982dSJonathan Peyton                                            kmp_task_team_t *task_team) {
33027cc577a4SJonathan Peyton   kmp_thread_data_t **threads_data_p;
33037cc577a4SJonathan Peyton   kmp_int32 nthreads, maxthreads;
33047cc577a4SJonathan Peyton   int is_init_thread = FALSE;
33057cc577a4SJonathan Peyton 
33067cc577a4SJonathan Peyton   if (TCR_4(task_team->tt.tt_found_tasks)) {
33077cc577a4SJonathan Peyton     // Already reallocated and initialized.
33087cc577a4SJonathan Peyton     return FALSE;
33097cc577a4SJonathan Peyton   }
33107cc577a4SJonathan Peyton 
33117cc577a4SJonathan Peyton   threads_data_p = &task_team->tt.tt_threads_data;
33127cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
33137cc577a4SJonathan Peyton   maxthreads = task_team->tt.tt_max_threads;
33147cc577a4SJonathan Peyton 
33153041982dSJonathan Peyton   // All threads must lock when they encounter the first task of the implicit
33163041982dSJonathan Peyton   // task region to make sure threads_data fields are (re)initialized before
33173041982dSJonathan Peyton   // used.
33187cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
33197cc577a4SJonathan Peyton 
33207cc577a4SJonathan Peyton   if (!TCR_4(task_team->tt.tt_found_tasks)) {
33217cc577a4SJonathan Peyton     // first thread to enable tasking
33227cc577a4SJonathan Peyton     kmp_team_t *team = thread->th.th_team;
33237cc577a4SJonathan Peyton     int i;
33247cc577a4SJonathan Peyton 
33257cc577a4SJonathan Peyton     is_init_thread = TRUE;
33267cc577a4SJonathan Peyton     if (maxthreads < nthreads) {
33277cc577a4SJonathan Peyton 
33287cc577a4SJonathan Peyton       if (*threads_data_p != NULL) {
33297cc577a4SJonathan Peyton         kmp_thread_data_t *old_data = *threads_data_p;
33307cc577a4SJonathan Peyton         kmp_thread_data_t *new_data = NULL;
33317cc577a4SJonathan Peyton 
33323041982dSJonathan Peyton         KE_TRACE(
33333041982dSJonathan Peyton             10,
33343041982dSJonathan Peyton             ("__kmp_realloc_task_threads_data: T#%d reallocating "
33357cc577a4SJonathan Peyton              "threads data for task_team %p, new_size = %d, old_size = %d\n",
33363041982dSJonathan Peyton              __kmp_gtid_from_thread(thread), task_team, nthreads, maxthreads));
33377cc577a4SJonathan Peyton         // Reallocate threads_data to have more elements than current array
33387cc577a4SJonathan Peyton         // Cannot use __kmp_thread_realloc() because threads not around for
33397cc577a4SJonathan Peyton         // kmp_reap_task_team( ).  Note all new array entries are initialized
33407cc577a4SJonathan Peyton         // to zero by __kmp_allocate().
33413041982dSJonathan Peyton         new_data = (kmp_thread_data_t *)__kmp_allocate(
33423041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33437cc577a4SJonathan Peyton         // copy old data to new data
33447cc577a4SJonathan Peyton         KMP_MEMCPY_S((void *)new_data, nthreads * sizeof(kmp_thread_data_t),
334571483f2dSAndrey Churbanov                      (void *)old_data, maxthreads * sizeof(kmp_thread_data_t));
33467cc577a4SJonathan Peyton 
33477cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33487cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33497cc577a4SJonathan Peyton         for (i = maxthreads; i < nthreads; i++) {
33507cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33517cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33527cc577a4SJonathan Peyton         }
33537cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33547cc577a4SJonathan Peyton        // Install the new data and free the old data
33557cc577a4SJonathan Peyton         (*threads_data_p) = new_data;
33567cc577a4SJonathan Peyton         __kmp_free(old_data);
33573041982dSJonathan Peyton       } else {
33587cc577a4SJonathan Peyton         KE_TRACE(10, ("__kmp_realloc_task_threads_data: T#%d allocating "
33597cc577a4SJonathan Peyton                       "threads data for task_team %p, size = %d\n",
33607cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread), task_team, nthreads));
33617cc577a4SJonathan Peyton         // Make the initial allocate for threads_data array, and zero entries
33627cc577a4SJonathan Peyton         // Cannot use __kmp_thread_calloc() because threads not around for
33637cc577a4SJonathan Peyton         // kmp_reap_task_team( ).
33643041982dSJonathan Peyton         *threads_data_p = (kmp_thread_data_t *)__kmp_allocate(
33653041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33667cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33677cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33687cc577a4SJonathan Peyton         for (i = 0; i < nthreads; i++) {
33697cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33707cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33717cc577a4SJonathan Peyton         }
33727cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33737cc577a4SJonathan Peyton       }
33747cc577a4SJonathan Peyton       task_team->tt.tt_max_threads = nthreads;
33753041982dSJonathan Peyton     } else {
33767cc577a4SJonathan Peyton       // If array has (more than) enough elements, go ahead and use it
33777cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(*threads_data_p != NULL);
33787cc577a4SJonathan Peyton     }
33797cc577a4SJonathan Peyton 
33807cc577a4SJonathan Peyton     // initialize threads_data pointers back to thread_info structures
33817cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
33827cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33837cc577a4SJonathan Peyton       thread_data->td.td_thr = team->t.t_threads[i];
33847cc577a4SJonathan Peyton 
33857cc577a4SJonathan Peyton       if (thread_data->td.td_deque_last_stolen >= nthreads) {
33867cc577a4SJonathan Peyton         // The last stolen field survives across teams / barrier, and the number
33877cc577a4SJonathan Peyton         // of threads may have changed.  It's possible (likely?) that a new
33883041982dSJonathan Peyton         // parallel region will exhibit the same behavior as previous region.
33897cc577a4SJonathan Peyton         thread_data->td.td_deque_last_stolen = -1;
33907cc577a4SJonathan Peyton       }
33917cc577a4SJonathan Peyton     }
33927cc577a4SJonathan Peyton 
33937cc577a4SJonathan Peyton     KMP_MB();
33947cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_tasks, TRUE);
33957cc577a4SJonathan Peyton   }
33967cc577a4SJonathan Peyton 
33977cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
33987cc577a4SJonathan Peyton   return is_init_thread;
33997cc577a4SJonathan Peyton }
34007cc577a4SJonathan Peyton 
34017cc577a4SJonathan Peyton // __kmp_free_task_threads_data:
34027cc577a4SJonathan Peyton // Deallocates a threads_data array for a task team, including any attached
34037cc577a4SJonathan Peyton // tasking deques.  Only occurs at library shutdown.
34043041982dSJonathan Peyton static void __kmp_free_task_threads_data(kmp_task_team_t *task_team) {
34057cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
34067cc577a4SJonathan Peyton   if (task_team->tt.tt_threads_data != NULL) {
34077cc577a4SJonathan Peyton     int i;
34087cc577a4SJonathan Peyton     for (i = 0; i < task_team->tt.tt_max_threads; i++) {
34097cc577a4SJonathan Peyton       __kmp_free_task_deque(&task_team->tt.tt_threads_data[i]);
34107cc577a4SJonathan Peyton     }
34117cc577a4SJonathan Peyton     __kmp_free(task_team->tt.tt_threads_data);
34127cc577a4SJonathan Peyton     task_team->tt.tt_threads_data = NULL;
34137cc577a4SJonathan Peyton   }
34147cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
34157cc577a4SJonathan Peyton }
34167cc577a4SJonathan Peyton 
34177cc577a4SJonathan Peyton // __kmp_allocate_task_team:
34187cc577a4SJonathan Peyton // Allocates a task team associated with a specific team, taking it from
34193041982dSJonathan Peyton // the global task team free list if possible.  Also initializes data
34203041982dSJonathan Peyton // structures.
34213041982dSJonathan Peyton static kmp_task_team_t *__kmp_allocate_task_team(kmp_info_t *thread,
34223041982dSJonathan Peyton                                                  kmp_team_t *team) {
34237cc577a4SJonathan Peyton   kmp_task_team_t *task_team = NULL;
34247cc577a4SJonathan Peyton   int nthreads;
34257cc577a4SJonathan Peyton 
34267cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d entering; team = %p\n",
34277cc577a4SJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), team));
34287cc577a4SJonathan Peyton 
34297cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
34307cc577a4SJonathan Peyton     // Take a task team from the task team pool
34317cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34327cc577a4SJonathan Peyton     if (__kmp_free_task_teams != NULL) {
34337cc577a4SJonathan Peyton       task_team = __kmp_free_task_teams;
34347cc577a4SJonathan Peyton       TCW_PTR(__kmp_free_task_teams, task_team->tt.tt_next);
34357cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
34367cc577a4SJonathan Peyton     }
34377cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34387cc577a4SJonathan Peyton   }
34397cc577a4SJonathan Peyton 
34407cc577a4SJonathan Peyton   if (task_team == NULL) {
34417cc577a4SJonathan Peyton     KE_TRACE(10, ("__kmp_allocate_task_team: T#%d allocating "
34427cc577a4SJonathan Peyton                   "task team for team %p\n",
34437cc577a4SJonathan Peyton                   __kmp_gtid_from_thread(thread), team));
3444ffd8f009SAndreyChurbanov     // Allocate a new task team if one is not available. Cannot use
3445ffd8f009SAndreyChurbanov     // __kmp_thread_malloc because threads not around for kmp_reap_task_team.
34467cc577a4SJonathan Peyton     task_team = (kmp_task_team_t *)__kmp_allocate(sizeof(kmp_task_team_t));
34477cc577a4SJonathan Peyton     __kmp_init_bootstrap_lock(&task_team->tt.tt_threads_lock);
3448ffd8f009SAndreyChurbanov #if USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG
3449ffd8f009SAndreyChurbanov     // suppress race conditions detection on synchronization flags in debug mode
3450ffd8f009SAndreyChurbanov     // this helps to analyze library internals eliminating false positives
3451ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(
3452ffd8f009SAndreyChurbanov         __itt_suppress_range, __itt_suppress_threading_errors,
3453ffd8f009SAndreyChurbanov         &task_team->tt.tt_found_tasks, sizeof(task_team->tt.tt_found_tasks));
3454ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(__itt_suppress_range,
3455ffd8f009SAndreyChurbanov                               __itt_suppress_threading_errors,
3456ffd8f009SAndreyChurbanov                               CCAST(kmp_uint32 *, &task_team->tt.tt_active),
3457ffd8f009SAndreyChurbanov                               sizeof(task_team->tt.tt_active));
3458ffd8f009SAndreyChurbanov #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG */
3459ffd8f009SAndreyChurbanov     // Note: __kmp_allocate zeroes returned memory, othewise we would need:
34603041982dSJonathan Peyton     // task_team->tt.tt_threads_data = NULL;
34617cc577a4SJonathan Peyton     // task_team->tt.tt_max_threads = 0;
34627cc577a4SJonathan Peyton     // task_team->tt.tt_next = NULL;
34637cc577a4SJonathan Peyton   }
34647cc577a4SJonathan Peyton 
34657cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_tasks, FALSE);
34667cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
34677cc577a4SJonathan Peyton   task_team->tt.tt_nproc = nthreads = team->t.t_nproc;
34687cc577a4SJonathan Peyton 
346937e2ef54SJonathan Peyton   KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads, nthreads);
34709d64275aSShilei Tian   TCW_4(task_team->tt.tt_hidden_helper_task_encountered, FALSE);
34717cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_active, TRUE);
34727cc577a4SJonathan Peyton 
34733041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d exiting; task_team = %p "
34743041982dSJonathan Peyton                 "unfinished_threads init'd to %d\n",
34753041982dSJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), task_team,
347637e2ef54SJonathan Peyton                 KMP_ATOMIC_LD_RLX(&task_team->tt.tt_unfinished_threads)));
34777cc577a4SJonathan Peyton   return task_team;
34787cc577a4SJonathan Peyton }
34797cc577a4SJonathan Peyton 
34807cc577a4SJonathan Peyton // __kmp_free_task_team:
34817cc577a4SJonathan Peyton // Frees the task team associated with a specific thread, and adds it
34827cc577a4SJonathan Peyton // to the global task team free list.
34833041982dSJonathan Peyton void __kmp_free_task_team(kmp_info_t *thread, kmp_task_team_t *task_team) {
34847cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_free_task_team: T#%d task_team = %p\n",
34857cc577a4SJonathan Peyton                 thread ? __kmp_gtid_from_thread(thread) : -1, task_team));
34867cc577a4SJonathan Peyton 
34877cc577a4SJonathan Peyton   // Put task team back on free list
34887cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34897cc577a4SJonathan Peyton 
34907cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_next == NULL);
34917cc577a4SJonathan Peyton   task_team->tt.tt_next = __kmp_free_task_teams;
34927cc577a4SJonathan Peyton   TCW_PTR(__kmp_free_task_teams, task_team);
34937cc577a4SJonathan Peyton 
34947cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34957cc577a4SJonathan Peyton }
34967cc577a4SJonathan Peyton 
34977cc577a4SJonathan Peyton // __kmp_reap_task_teams:
34987cc577a4SJonathan Peyton // Free all the task teams on the task team free list.
34997cc577a4SJonathan Peyton // Should only be done during library shutdown.
35003041982dSJonathan Peyton // Cannot do anything that needs a thread structure or gtid since they are
35013041982dSJonathan Peyton // already gone.
35023041982dSJonathan Peyton void __kmp_reap_task_teams(void) {
35037cc577a4SJonathan Peyton   kmp_task_team_t *task_team;
35047cc577a4SJonathan Peyton 
35057cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
35067cc577a4SJonathan Peyton     // Free all task_teams on the free list
35077cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
35087cc577a4SJonathan Peyton     while ((task_team = __kmp_free_task_teams) != NULL) {
35097cc577a4SJonathan Peyton       __kmp_free_task_teams = task_team->tt.tt_next;
35107cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
35117cc577a4SJonathan Peyton 
35127cc577a4SJonathan Peyton       // Free threads_data if necessary
35137cc577a4SJonathan Peyton       if (task_team->tt.tt_threads_data != NULL) {
35147cc577a4SJonathan Peyton         __kmp_free_task_threads_data(task_team);
35157cc577a4SJonathan Peyton       }
35167cc577a4SJonathan Peyton       __kmp_free(task_team);
35177cc577a4SJonathan Peyton     }
35187cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
35197cc577a4SJonathan Peyton   }
35207cc577a4SJonathan Peyton }
35217cc577a4SJonathan Peyton 
35227cc577a4SJonathan Peyton // __kmp_wait_to_unref_task_teams:
35237cc577a4SJonathan Peyton // Some threads could still be in the fork barrier release code, possibly
35247cc577a4SJonathan Peyton // trying to steal tasks.  Wait for each thread to unreference its task team.
35253041982dSJonathan Peyton void __kmp_wait_to_unref_task_teams(void) {
35267cc577a4SJonathan Peyton   kmp_info_t *thread;
35277cc577a4SJonathan Peyton   kmp_uint32 spins;
35287cc577a4SJonathan Peyton   int done;
35297cc577a4SJonathan Peyton 
35307cc577a4SJonathan Peyton   KMP_INIT_YIELD(spins);
35317cc577a4SJonathan Peyton 
35327cc577a4SJonathan Peyton   for (;;) {
35337cc577a4SJonathan Peyton     done = TRUE;
35347cc577a4SJonathan Peyton 
35357cc577a4SJonathan Peyton     // TODO: GEH - this may be is wrong because some sync would be necessary
35363041982dSJonathan Peyton     // in case threads are added to the pool during the traversal. Need to
35373041982dSJonathan Peyton     // verify that lock for thread pool is held when calling this routine.
3538c47afcd9SAndrey Churbanov     for (thread = CCAST(kmp_info_t *, __kmp_thread_pool); thread != NULL;
35393041982dSJonathan Peyton          thread = thread->th.th_next_pool) {
35407cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35417cc577a4SJonathan Peyton       DWORD exit_val;
35427cc577a4SJonathan Peyton #endif
35437cc577a4SJonathan Peyton       if (TCR_PTR(thread->th.th_task_team) == NULL) {
35447cc577a4SJonathan Peyton         KA_TRACE(10, ("__kmp_wait_to_unref_task_team: T#%d task_team == NULL\n",
35457cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
35467cc577a4SJonathan Peyton         continue;
35477cc577a4SJonathan Peyton       }
35487cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35497cc577a4SJonathan Peyton       // TODO: GEH - add this check for Linux* OS / OS X* as well?
35507cc577a4SJonathan Peyton       if (!__kmp_is_thread_alive(thread, &exit_val)) {
35517cc577a4SJonathan Peyton         thread->th.th_task_team = NULL;
35527cc577a4SJonathan Peyton         continue;
35537cc577a4SJonathan Peyton       }
35547cc577a4SJonathan Peyton #endif
35557cc577a4SJonathan Peyton 
35567cc577a4SJonathan Peyton       done = FALSE; // Because th_task_team pointer is not NULL for this thread
35577cc577a4SJonathan Peyton 
35583041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_wait_to_unref_task_team: Waiting for T#%d to "
35593041982dSJonathan Peyton                     "unreference task_team\n",
35607cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(thread)));
35617cc577a4SJonathan Peyton 
35627cc577a4SJonathan Peyton       if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
3563d8e4cb91STerry Wilmarth         void *sleep_loc;
35647cc577a4SJonathan Peyton         // If the thread is sleeping, awaken it.
3565c47afcd9SAndrey Churbanov         if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3566c47afcd9SAndrey Churbanov             NULL) {
35673041982dSJonathan Peyton           KA_TRACE(
35683041982dSJonathan Peyton               10,
35693041982dSJonathan Peyton               ("__kmp_wait_to_unref_task_team: T#%d waking up thread T#%d\n",
35707cc577a4SJonathan Peyton                __kmp_gtid_from_thread(thread), __kmp_gtid_from_thread(thread)));
3571d8e4cb91STerry Wilmarth           __kmp_null_resume_wrapper(thread);
35727cc577a4SJonathan Peyton         }
35737cc577a4SJonathan Peyton       }
35747cc577a4SJonathan Peyton     }
35757cc577a4SJonathan Peyton     if (done) {
35767cc577a4SJonathan Peyton       break;
35777cc577a4SJonathan Peyton     }
35787cc577a4SJonathan Peyton 
3579e47d32f1SJonathan Peyton     // If oversubscribed or have waited a bit, yield.
3580e47d32f1SJonathan Peyton     KMP_YIELD_OVERSUB_ELSE_SPIN(spins);
35817cc577a4SJonathan Peyton   }
35827cc577a4SJonathan Peyton }
35837cc577a4SJonathan Peyton 
35847cc577a4SJonathan Peyton // __kmp_task_team_setup:  Create a task_team for the current team, but use
35857cc577a4SJonathan Peyton // an already created, unused one if it already exists.
35863041982dSJonathan Peyton void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team, int always) {
35877cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
35887cc577a4SJonathan Peyton 
35893041982dSJonathan Peyton   // If this task_team hasn't been created yet, allocate it. It will be used in
35903041982dSJonathan Peyton   // the region after the next.
35913041982dSJonathan Peyton   // If it exists, it is the current task team and shouldn't be touched yet as
35923041982dSJonathan Peyton   // it may still be in use.
35933041982dSJonathan Peyton   if (team->t.t_task_team[this_thr->th.th_task_state] == NULL &&
35943041982dSJonathan Peyton       (always || team->t.t_nproc > 1)) {
35953041982dSJonathan Peyton     team->t.t_task_team[this_thr->th.th_task_state] =
35963041982dSJonathan Peyton         __kmp_allocate_task_team(this_thr, team);
359797d000cfStlwilmar     KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created new task_team %p"
35983041982dSJonathan Peyton                   " for team %d at parity=%d\n",
35993041982dSJonathan Peyton                   __kmp_gtid_from_thread(this_thr),
3600467f3924SHansang Bae                   team->t.t_task_team[this_thr->th.th_task_state], team->t.t_id,
36013041982dSJonathan Peyton                   this_thr->th.th_task_state));
36027cc577a4SJonathan Peyton   }
36037cc577a4SJonathan Peyton 
36043041982dSJonathan Peyton   // After threads exit the release, they will call sync, and then point to this
36053041982dSJonathan Peyton   // other task_team; make sure it is allocated and properly initialized. As
36063041982dSJonathan Peyton   // threads spin in the barrier release phase, they will continue to use the
36073041982dSJonathan Peyton   // previous task_team struct(above), until they receive the signal to stop
36083041982dSJonathan Peyton   // checking for tasks (they can't safely reference the kmp_team_t struct,
360997d000cfStlwilmar   // which could be reallocated by the primary thread). No task teams are formed
36103041982dSJonathan Peyton   // for serialized teams.
36117cc577a4SJonathan Peyton   if (team->t.t_nproc > 1) {
36127cc577a4SJonathan Peyton     int other_team = 1 - this_thr->th.th_task_state;
3613467f3924SHansang Bae     KMP_DEBUG_ASSERT(other_team >= 0 && other_team < 2);
36147cc577a4SJonathan Peyton     if (team->t.t_task_team[other_team] == NULL) { // setup other team as well
36153041982dSJonathan Peyton       team->t.t_task_team[other_team] =
36163041982dSJonathan Peyton           __kmp_allocate_task_team(this_thr, team);
361797d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created second new "
36183041982dSJonathan Peyton                     "task_team %p for team %d at parity=%d\n",
36193041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3620467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36213041982dSJonathan Peyton     } else { // Leave the old task team struct in place for the upcoming region;
36223041982dSJonathan Peyton       // adjust as needed
36237cc577a4SJonathan Peyton       kmp_task_team_t *task_team = team->t.t_task_team[other_team];
36243041982dSJonathan Peyton       if (!task_team->tt.tt_active ||
36253041982dSJonathan Peyton           team->t.t_nproc != task_team->tt.tt_nproc) {
36267cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_nproc, team->t.t_nproc);
36277cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_tasks, FALSE);
36287cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
362937e2ef54SJonathan Peyton         KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads,
363037e2ef54SJonathan Peyton                           team->t.t_nproc);
36317cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_active, TRUE);
36327cc577a4SJonathan Peyton       }
36333041982dSJonathan Peyton       // if team size has changed, the first thread to enable tasking will
36343041982dSJonathan Peyton       // realloc threads_data if necessary
363597d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d reset next task_team "
36363041982dSJonathan Peyton                     "%p for team %d at parity=%d\n",
36373041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3638467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36397cc577a4SJonathan Peyton     }
36407cc577a4SJonathan Peyton   }
36419d64275aSShilei Tian 
36429d64275aSShilei Tian   // For regular thread, task enabling should be called when the task is going
36439d64275aSShilei Tian   // to be pushed to a dequeue. However, for the hidden helper thread, we need
36449d64275aSShilei Tian   // it ahead of time so that some operations can be performed without race
36459d64275aSShilei Tian   // condition.
36469d64275aSShilei Tian   if (this_thr == __kmp_hidden_helper_main_thread) {
36479d64275aSShilei Tian     for (int i = 0; i < 2; ++i) {
36489d64275aSShilei Tian       kmp_task_team_t *task_team = team->t.t_task_team[i];
36499d64275aSShilei Tian       if (KMP_TASKING_ENABLED(task_team)) {
36509d64275aSShilei Tian         continue;
36519d64275aSShilei Tian       }
36529d64275aSShilei Tian       __kmp_enable_tasking(task_team, this_thr);
36539d64275aSShilei Tian       for (int j = 0; j < task_team->tt.tt_nproc; ++j) {
36549d64275aSShilei Tian         kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[j];
36559d64275aSShilei Tian         if (thread_data->td.td_deque == NULL) {
36569d64275aSShilei Tian           __kmp_alloc_task_deque(__kmp_hidden_helper_threads[j], thread_data);
36579d64275aSShilei Tian         }
36589d64275aSShilei Tian       }
36599d64275aSShilei Tian     }
36609d64275aSShilei Tian   }
36617cc577a4SJonathan Peyton }
36627cc577a4SJonathan Peyton 
36637cc577a4SJonathan Peyton // __kmp_task_team_sync: Propagation of task team data from team to threads
36647cc577a4SJonathan Peyton // which happens just after the release phase of a team barrier.  This may be
36657cc577a4SJonathan Peyton // called by any thread, but only for teams with # threads > 1.
36663041982dSJonathan Peyton void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team) {
36677cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36687cc577a4SJonathan Peyton 
36693041982dSJonathan Peyton   // Toggle the th_task_state field, to switch which task_team this thread
36703041982dSJonathan Peyton   // refers to
36716b316febSTerry Wilmarth   this_thr->th.th_task_state = (kmp_uint8)(1 - this_thr->th.th_task_state);
36726b316febSTerry Wilmarth 
36733041982dSJonathan Peyton   // It is now safe to propagate the task team pointer from the team struct to
36743041982dSJonathan Peyton   // the current thread.
36753041982dSJonathan Peyton   TCW_PTR(this_thr->th.th_task_team,
36763041982dSJonathan Peyton           team->t.t_task_team[this_thr->th.th_task_state]);
36773041982dSJonathan Peyton   KA_TRACE(20,
36783041982dSJonathan Peyton            ("__kmp_task_team_sync: Thread T#%d task team switched to task_team "
36793041982dSJonathan Peyton             "%p from Team #%d (parity=%d)\n",
36807cc577a4SJonathan Peyton             __kmp_gtid_from_thread(this_thr), this_thr->th.th_task_team,
3681467f3924SHansang Bae             team->t.t_id, this_thr->th.th_task_state));
36827cc577a4SJonathan Peyton }
36837cc577a4SJonathan Peyton 
368497d000cfStlwilmar // __kmp_task_team_wait: Primary thread waits for outstanding tasks after the
368597d000cfStlwilmar // barrier gather phase. Only called by primary thread if #threads in team > 1
368697d000cfStlwilmar // or if proxy tasks were created.
36873041982dSJonathan Peyton //
36883041982dSJonathan Peyton // wait is a flag that defaults to 1 (see kmp.h), but waiting can be turned off
368997d000cfStlwilmar // by passing in 0 optionally as the last argument. When wait is zero, primary
36903041982dSJonathan Peyton // thread does not wait for unfinished_threads to reach 0.
36913041982dSJonathan Peyton void __kmp_task_team_wait(
36923041982dSJonathan Peyton     kmp_info_t *this_thr,
36933041982dSJonathan Peyton     kmp_team_t *team USE_ITT_BUILD_ARG(void *itt_sync_obj), int wait) {
36947cc577a4SJonathan Peyton   kmp_task_team_t *task_team = team->t.t_task_team[this_thr->th.th_task_state];
36957cc577a4SJonathan Peyton 
36967cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36977cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team == this_thr->th.th_task_team);
36987cc577a4SJonathan Peyton 
36997cc577a4SJonathan Peyton   if ((task_team != NULL) && KMP_TASKING_ENABLED(task_team)) {
37007cc577a4SJonathan Peyton     if (wait) {
370197d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_wait: Primary T#%d waiting for all tasks "
37023041982dSJonathan Peyton                     "(for unfinished_threads to reach 0) on task_team = %p\n",
37037cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(this_thr), task_team));
37043041982dSJonathan Peyton       // Worker threads may have dropped through to release phase, but could
37053041982dSJonathan Peyton       // still be executing tasks. Wait here for tasks to complete. To avoid
370697d000cfStlwilmar       // memory contention, only primary thread checks termination condition.
3707e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
3708e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
370937e2ef54SJonathan Peyton                 &task_team->tt.tt_unfinished_threads),
3710c47afcd9SAndrey Churbanov           0U);
37113041982dSJonathan Peyton       flag.wait(this_thr, TRUE USE_ITT_BUILD_ARG(itt_sync_obj));
37127cc577a4SJonathan Peyton     }
37133041982dSJonathan Peyton     // Deactivate the old task team, so that the worker threads will stop
37143041982dSJonathan Peyton     // referencing it while spinning.
37153041982dSJonathan Peyton     KA_TRACE(
37163041982dSJonathan Peyton         20,
371797d000cfStlwilmar         ("__kmp_task_team_wait: Primary T#%d deactivating task_team %p: "
37187cc577a4SJonathan Peyton          "setting active to false, setting local and team's pointer to NULL\n",
37197cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr), task_team));
37203041982dSJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1 ||
37213041982dSJonathan Peyton                      task_team->tt.tt_found_proxy_tasks == TRUE);
37227cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_proxy_tasks, FALSE);
3723a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(task_team->tt.tt_untied_task_encountered, 0);
37247cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_active, FALSE);
37257cc577a4SJonathan Peyton     KMP_MB();
37267cc577a4SJonathan Peyton 
37277cc577a4SJonathan Peyton     TCW_PTR(this_thr->th.th_task_team, NULL);
37287cc577a4SJonathan Peyton   }
37297cc577a4SJonathan Peyton }
37307cc577a4SJonathan Peyton 
37317cc577a4SJonathan Peyton // __kmp_tasking_barrier:
3732e0665a90STerry Wilmarth // This routine is called only when __kmp_tasking_mode == tskm_extra_barrier.
37333041982dSJonathan Peyton // Internal function to execute all tasks prior to a regular barrier or a join
37343041982dSJonathan Peyton // barrier. It is a full barrier itself, which unfortunately turns regular
37353041982dSJonathan Peyton // barriers into double barriers and join barriers into 1 1/2 barriers.
37363041982dSJonathan Peyton void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread, int gtid) {
373737e2ef54SJonathan Peyton   std::atomic<kmp_uint32> *spin = RCAST(
373837e2ef54SJonathan Peyton       std::atomic<kmp_uint32> *,
3739c47afcd9SAndrey Churbanov       &team->t.t_task_team[thread->th.th_task_state]->tt.tt_unfinished_threads);
37407cc577a4SJonathan Peyton   int flag = FALSE;
37417cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode == tskm_extra_barrier);
37427cc577a4SJonathan Peyton 
37437cc577a4SJonathan Peyton #if USE_ITT_BUILD
374437e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_INIT(spin, NULL);
37457cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
3746e0665a90STerry Wilmarth   kmp_flag_32<false, false> spin_flag(spin, 0U);
37473041982dSJonathan Peyton   while (!spin_flag.execute_tasks(thread, gtid, TRUE,
37483041982dSJonathan Peyton                                   &flag USE_ITT_BUILD_ARG(NULL), 0)) {
37497cc577a4SJonathan Peyton #if USE_ITT_BUILD
37507cc577a4SJonathan Peyton     // TODO: What about itt_sync_obj??
375137e2ef54SJonathan Peyton     KMP_FSYNC_SPIN_PREPARE(RCAST(void *, spin));
37527cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37537cc577a4SJonathan Peyton 
37547cc577a4SJonathan Peyton     if (TCR_4(__kmp_global.g.g_done)) {
37557cc577a4SJonathan Peyton       if (__kmp_global.g.g_abort)
37567cc577a4SJonathan Peyton         __kmp_abort_thread();
37577cc577a4SJonathan Peyton       break;
37587cc577a4SJonathan Peyton     }
3759e47d32f1SJonathan Peyton     KMP_YIELD(TRUE);
37607cc577a4SJonathan Peyton   }
37617cc577a4SJonathan Peyton #if USE_ITT_BUILD
376237e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_ACQUIRED(RCAST(void *, spin));
37637cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37647cc577a4SJonathan Peyton }
37657cc577a4SJonathan Peyton 
37663041982dSJonathan Peyton // __kmp_give_task puts a task into a given thread queue if:
37673041982dSJonathan Peyton //  - the queue for that thread was created
37683041982dSJonathan Peyton //  - there's space in that queue
37693041982dSJonathan Peyton // Because of this, __kmp_push_task needs to check if there's space after
37703041982dSJonathan Peyton // getting the lock
37713041982dSJonathan Peyton static bool __kmp_give_task(kmp_info_t *thread, kmp_int32 tid, kmp_task_t *task,
37723041982dSJonathan Peyton                             kmp_int32 pass) {
37737cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
37747cc577a4SJonathan Peyton   kmp_task_team_t *task_team = taskdata->td_task_team;
37757cc577a4SJonathan Peyton 
37763041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_give_task: trying to give task %p to thread %d.\n",
37773041982dSJonathan Peyton                 taskdata, tid));
37787cc577a4SJonathan Peyton 
37797cc577a4SJonathan Peyton   // If task_team is NULL something went really bad...
37807cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
37817cc577a4SJonathan Peyton 
37827cc577a4SJonathan Peyton   bool result = false;
37837cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
37847cc577a4SJonathan Peyton 
37857cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
37867cc577a4SJonathan Peyton     // There's no queue in this thread, go find another one
37877cc577a4SJonathan Peyton     // We're guaranteed that at least one thread has a queue
37883041982dSJonathan Peyton     KA_TRACE(30,
37893041982dSJonathan Peyton              ("__kmp_give_task: thread %d has no queue while giving task %p.\n",
37903041982dSJonathan Peyton               tid, taskdata));
37917cc577a4SJonathan Peyton     return result;
37927cc577a4SJonathan Peyton   }
37937cc577a4SJonathan Peyton 
37943041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
37953041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
37963041982dSJonathan Peyton     KA_TRACE(
37973041982dSJonathan Peyton         30,
37983041982dSJonathan Peyton         ("__kmp_give_task: queue is full while giving task %p to thread %d.\n",
37993041982dSJonathan Peyton          taskdata, tid));
38007cc577a4SJonathan Peyton 
38013041982dSJonathan Peyton     // if this deque is bigger than the pass ratio give a chance to another
38023041982dSJonathan Peyton     // thread
38033041982dSJonathan Peyton     if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38043041982dSJonathan Peyton       return result;
38057cc577a4SJonathan Peyton 
38067cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38073895148dSJoachim Protze     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38083895148dSJoachim Protze         TASK_DEQUE_SIZE(thread_data->td)) {
38093895148dSJoachim Protze       // expand deque to push the task which is not allowed to execute
38107cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38113895148dSJoachim Protze     }
38127cc577a4SJonathan Peyton 
38137cc577a4SJonathan Peyton   } else {
38147cc577a4SJonathan Peyton 
38157cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38167cc577a4SJonathan Peyton 
38173041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38183041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
38193041982dSJonathan Peyton       KA_TRACE(30, ("__kmp_give_task: queue is full while giving task %p to "
38203041982dSJonathan Peyton                     "thread %d.\n",
38213041982dSJonathan Peyton                     taskdata, tid));
38227cc577a4SJonathan Peyton 
38233041982dSJonathan Peyton       // if this deque is bigger than the pass ratio give a chance to another
38243041982dSJonathan Peyton       // thread
38257cc577a4SJonathan Peyton       if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38267cc577a4SJonathan Peyton         goto release_and_exit;
38277cc577a4SJonathan Peyton 
38287cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38297cc577a4SJonathan Peyton     }
38307cc577a4SJonathan Peyton   }
38317cc577a4SJonathan Peyton 
38327cc577a4SJonathan Peyton   // lock is held here, and there is space in the deque
38337cc577a4SJonathan Peyton 
38347cc577a4SJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] = taskdata;
38357cc577a4SJonathan Peyton   // Wrap index.
38363041982dSJonathan Peyton   thread_data->td.td_deque_tail =
38373041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
38383041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
38393041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1);
38407cc577a4SJonathan Peyton 
38417cc577a4SJonathan Peyton   result = true;
38423041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_give_task: successfully gave task %p to thread %d.\n",
38433041982dSJonathan Peyton                 taskdata, tid));
38447cc577a4SJonathan Peyton 
38457cc577a4SJonathan Peyton release_and_exit:
38467cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
38477cc577a4SJonathan Peyton 
38487cc577a4SJonathan Peyton   return result;
38497cc577a4SJonathan Peyton }
38507cc577a4SJonathan Peyton 
38513c76e992SJoachim Protze #define PROXY_TASK_FLAG 0x40000000
38523041982dSJonathan Peyton /* The finish of the proxy tasks is divided in two pieces:
38537cc577a4SJonathan Peyton     - the top half is the one that can be done from a thread outside the team
3854c3344345SAndrey Churbanov     - the bottom half must be run from a thread within the team
38557cc577a4SJonathan Peyton 
38563041982dSJonathan Peyton    In order to run the bottom half the task gets queued back into one of the
38573041982dSJonathan Peyton    threads of the team. Once the td_incomplete_child_task counter of the parent
38583041982dSJonathan Peyton    is decremented the threads can leave the barriers. So, the bottom half needs
38593041982dSJonathan Peyton    to be queued before the counter is decremented. The top half is therefore
38603041982dSJonathan Peyton    divided in two parts:
38617cc577a4SJonathan Peyton     - things that can be run before queuing the bottom half
38627cc577a4SJonathan Peyton     - things that must be run after queuing the bottom half
38637cc577a4SJonathan Peyton 
38643041982dSJonathan Peyton    This creates a second race as the bottom half can free the task before the
38653041982dSJonathan Peyton    second top half is executed. To avoid this we use the
38663041982dSJonathan Peyton    td_incomplete_child_task of the proxy task to synchronize the top and bottom
38673041982dSJonathan Peyton    half. */
38683041982dSJonathan Peyton static void __kmp_first_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38697cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
38707cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38717cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
38727cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
38737cc577a4SJonathan Peyton 
38747cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
38757cc577a4SJonathan Peyton 
38767cc577a4SJonathan Peyton   if (taskdata->td_taskgroup)
387737e2ef54SJonathan Peyton     KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
38787cc577a4SJonathan Peyton 
38793041982dSJonathan Peyton   // Create an imaginary children for this task so the bottom half cannot
38803041982dSJonathan Peyton   // release the task before we have completed the second top half
38813c76e992SJoachim Protze   KMP_ATOMIC_OR(&taskdata->td_incomplete_child_tasks, PROXY_TASK_FLAG);
38827cc577a4SJonathan Peyton }
38837cc577a4SJonathan Peyton 
38843041982dSJonathan Peyton static void __kmp_second_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38858b81524cSAndreyChurbanov #if KMP_DEBUG
38867cc577a4SJonathan Peyton   kmp_int32 children = 0;
38877cc577a4SJonathan Peyton   // Predecrement simulated by "- 1" calculation
38888b81524cSAndreyChurbanov   children = -1 +
38898b81524cSAndreyChurbanov #endif
38908b81524cSAndreyChurbanov       KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks);
38917cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
38927cc577a4SJonathan Peyton 
38937cc577a4SJonathan Peyton   // Remove the imaginary children
38943c76e992SJoachim Protze   KMP_ATOMIC_AND(&taskdata->td_incomplete_child_tasks, ~PROXY_TASK_FLAG);
38957cc577a4SJonathan Peyton }
38967cc577a4SJonathan Peyton 
38973041982dSJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask) {
38987cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
38997cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
39007cc577a4SJonathan Peyton 
39017cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39023041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete ==
39033041982dSJonathan Peyton                    1); // top half must run before bottom half
39047cc577a4SJonathan Peyton 
39057cc577a4SJonathan Peyton   // We need to wait to make sure the top half is finished
39067cc577a4SJonathan Peyton   // Spinning here should be ok as this should happen quickly
39073c76e992SJoachim Protze   while ((KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) &
39083c76e992SJoachim Protze           PROXY_TASK_FLAG) > 0)
39093041982dSJonathan Peyton     ;
39107cc577a4SJonathan Peyton 
39117cc577a4SJonathan Peyton   __kmp_release_deps(gtid, taskdata);
39127cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
39137cc577a4SJonathan Peyton }
39147cc577a4SJonathan Peyton 
39157cc577a4SJonathan Peyton /*!
39167cc577a4SJonathan Peyton @ingroup TASKING
39177cc577a4SJonathan Peyton @param gtid Global Thread ID of encountering thread
39187cc577a4SJonathan Peyton @param ptask Task which execution is completed
39197cc577a4SJonathan Peyton 
3920ed5fe645SKelvin Li Execute the completion of a proxy task from a thread of that is part of the
39213041982dSJonathan Peyton team. Run first and bottom halves directly.
39227cc577a4SJonathan Peyton */
39233041982dSJonathan Peyton void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask) {
39247cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39257cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39263041982dSJonathan Peyton   KA_TRACE(
39273041982dSJonathan Peyton       10, ("__kmp_proxy_task_completed(enter): T#%d proxy task %p completing\n",
39283041982dSJonathan Peyton            gtid, taskdata));
3929787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
39307cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39317cc577a4SJonathan Peyton 
39327cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39337cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39347cc577a4SJonathan Peyton   __kmp_bottom_half_finish_proxy(gtid, ptask);
39357cc577a4SJonathan Peyton 
39363041982dSJonathan Peyton   KA_TRACE(10,
39373041982dSJonathan Peyton            ("__kmp_proxy_task_completed(exit): T#%d proxy task %p completing\n",
39383041982dSJonathan Peyton             gtid, taskdata));
39397cc577a4SJonathan Peyton }
39407cc577a4SJonathan Peyton 
3941ea452353SShilei Tian void __kmpc_give_task(kmp_task_t *ptask, kmp_int32 start = 0) {
3942ea452353SShilei Tian   KMP_DEBUG_ASSERT(ptask != NULL);
3943ea452353SShilei Tian   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
3944ea452353SShilei Tian 
3945ea452353SShilei Tian   // Enqueue task to complete bottom half completion from a thread within the
3946ea452353SShilei Tian   // corresponding team
3947ea452353SShilei Tian   kmp_team_t *team = taskdata->td_team;
3948ea452353SShilei Tian   kmp_int32 nthreads = team->t.t_nproc;
3949ea452353SShilei Tian   kmp_info_t *thread;
3950ea452353SShilei Tian 
3951ea452353SShilei Tian   // This should be similar to start_k = __kmp_get_random( thread ) % nthreads
3952ea452353SShilei Tian   // but we cannot use __kmp_get_random here
3953*680c71b1SShilei Tian   kmp_int32 start_k = start % nthreads;
3954ea452353SShilei Tian   kmp_int32 pass = 1;
3955ea452353SShilei Tian   kmp_int32 k = start_k;
3956ea452353SShilei Tian 
3957ea452353SShilei Tian   do {
3958ea452353SShilei Tian     // For now we're just linearly trying to find a thread
3959ea452353SShilei Tian     thread = team->t.t_threads[k];
3960ea452353SShilei Tian     k = (k + 1) % nthreads;
3961ea452353SShilei Tian 
3962ea452353SShilei Tian     // we did a full pass through all the threads
3963ea452353SShilei Tian     if (k == start_k)
3964ea452353SShilei Tian       pass = pass << 1;
3965ea452353SShilei Tian 
3966ea452353SShilei Tian   } while (!__kmp_give_task(thread, k, ptask, pass));
3967ea452353SShilei Tian }
3968ea452353SShilei Tian 
39697cc577a4SJonathan Peyton /*!
39707cc577a4SJonathan Peyton @ingroup TASKING
39717cc577a4SJonathan Peyton @param ptask Task which execution is completed
39727cc577a4SJonathan Peyton 
3973ed5fe645SKelvin Li Execute the completion of a proxy task from a thread that could not belong to
39743041982dSJonathan Peyton the team.
39757cc577a4SJonathan Peyton */
39763041982dSJonathan Peyton void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask) {
39777cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39787cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39797cc577a4SJonathan Peyton 
39803041982dSJonathan Peyton   KA_TRACE(
39813041982dSJonathan Peyton       10,
39823041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(enter): proxy task completing ooo %p\n",
39833041982dSJonathan Peyton        taskdata));
39847cc577a4SJonathan Peyton 
39857cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39867cc577a4SJonathan Peyton 
39877cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39887cc577a4SJonathan Peyton 
3989ea452353SShilei Tian   __kmpc_give_task(ptask);
39907cc577a4SJonathan Peyton 
39917cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39927cc577a4SJonathan Peyton 
39933041982dSJonathan Peyton   KA_TRACE(
39943041982dSJonathan Peyton       10,
39953041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(exit): proxy task completing ooo %p\n",
39963041982dSJonathan Peyton        taskdata));
39977cc577a4SJonathan Peyton }
39987cc577a4SJonathan Peyton 
3999405037c4SAndrey Churbanov kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref, int gtid,
4000405037c4SAndrey Churbanov                                                 kmp_task_t *task) {
4001405037c4SAndrey Churbanov   kmp_taskdata_t *td = KMP_TASK_TO_TASKDATA(task);
4002405037c4SAndrey Churbanov   if (td->td_allow_completion_event.type == KMP_EVENT_UNINITIALIZED) {
4003405037c4SAndrey Churbanov     td->td_allow_completion_event.type = KMP_EVENT_ALLOW_COMPLETION;
4004405037c4SAndrey Churbanov     td->td_allow_completion_event.ed.task = task;
4005405037c4SAndrey Churbanov     __kmp_init_tas_lock(&td->td_allow_completion_event.lock);
4006405037c4SAndrey Churbanov   }
4007405037c4SAndrey Churbanov   return &td->td_allow_completion_event;
4008405037c4SAndrey Churbanov }
4009405037c4SAndrey Churbanov 
4010405037c4SAndrey Churbanov void __kmp_fulfill_event(kmp_event_t *event) {
4011405037c4SAndrey Churbanov   if (event->type == KMP_EVENT_ALLOW_COMPLETION) {
4012405037c4SAndrey Churbanov     kmp_task_t *ptask = event->ed.task;
4013405037c4SAndrey Churbanov     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
4014405037c4SAndrey Churbanov     bool detached = false;
4015405037c4SAndrey Churbanov     int gtid = __kmp_get_gtid();
4016405037c4SAndrey Churbanov 
4017d23131a3SJoachim Protze     // The associated task might have completed or could be completing at this
4018405037c4SAndrey Churbanov     // point.
4019405037c4SAndrey Churbanov     // We need to take the lock to avoid races
4020405037c4SAndrey Churbanov     __kmp_acquire_tas_lock(&event->lock, gtid);
402110995c77SJoachim Protze     if (taskdata->td_flags.proxy == TASK_PROXY) {
4022405037c4SAndrey Churbanov       detached = true;
402310995c77SJoachim Protze     } else {
402410995c77SJoachim Protze #if OMPT_SUPPORT
402510995c77SJoachim Protze       // The OMPT event must occur under mutual exclusion,
402610995c77SJoachim Protze       // otherwise the tool might access ptask after free
402710995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
402810995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_early_fulfill);
402910995c77SJoachim Protze #endif
403010995c77SJoachim Protze     }
4031405037c4SAndrey Churbanov     event->type = KMP_EVENT_UNINITIALIZED;
4032405037c4SAndrey Churbanov     __kmp_release_tas_lock(&event->lock, gtid);
4033405037c4SAndrey Churbanov 
4034405037c4SAndrey Churbanov     if (detached) {
403510995c77SJoachim Protze #if OMPT_SUPPORT
403610995c77SJoachim Protze       // We free ptask afterwards and know the task is finished,
403710995c77SJoachim Protze       // so locking is not necessary
403810995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
403910995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_late_fulfill);
404010995c77SJoachim Protze #endif
4041405037c4SAndrey Churbanov       // If the task detached complete the proxy task
4042405037c4SAndrey Churbanov       if (gtid >= 0) {
4043405037c4SAndrey Churbanov         kmp_team_t *team = taskdata->td_team;
4044405037c4SAndrey Churbanov         kmp_info_t *thread = __kmp_get_thread();
4045405037c4SAndrey Churbanov         if (thread->th.th_team == team) {
4046405037c4SAndrey Churbanov           __kmpc_proxy_task_completed(gtid, ptask);
4047405037c4SAndrey Churbanov           return;
4048405037c4SAndrey Churbanov         }
4049405037c4SAndrey Churbanov       }
4050405037c4SAndrey Churbanov 
4051405037c4SAndrey Churbanov       // fallback
4052405037c4SAndrey Churbanov       __kmpc_proxy_task_completed_ooo(ptask);
4053405037c4SAndrey Churbanov     }
4054405037c4SAndrey Churbanov   }
4055405037c4SAndrey Churbanov }
4056405037c4SAndrey Churbanov 
40573041982dSJonathan Peyton // __kmp_task_dup_alloc: Allocate the taskdata and make a copy of source task
40583041982dSJonathan Peyton // for taskloop
40597cc577a4SJonathan Peyton //
40607cc577a4SJonathan Peyton // thread:   allocating thread
40617cc577a4SJonathan Peyton // task_src: pointer to source task to be duplicated
40627cc577a4SJonathan Peyton // returns:  a pointer to the allocated kmp_task_t structure (task).
40633041982dSJonathan Peyton kmp_task_t *__kmp_task_dup_alloc(kmp_info_t *thread, kmp_task_t *task_src) {
40647cc577a4SJonathan Peyton   kmp_task_t *task;
40657cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
40665e111c5dSAndreyChurbanov   kmp_taskdata_t *taskdata_src = KMP_TASK_TO_TASKDATA(task_src);
40675e111c5dSAndreyChurbanov   kmp_taskdata_t *parent_task = taskdata_src->td_parent; // same parent task
40687cc577a4SJonathan Peyton   size_t shareds_offset;
40697cc577a4SJonathan Peyton   size_t task_size;
40707cc577a4SJonathan Peyton 
40713041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_dup_alloc(enter): Th %p, source task %p\n", thread,
40723041982dSJonathan Peyton                 task_src));
40733041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.proxy ==
40743041982dSJonathan Peyton                    TASK_FULL); // it should not be proxy task
40757cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.tasktype == TASK_EXPLICIT);
40767cc577a4SJonathan Peyton   task_size = taskdata_src->td_size_alloc;
40777cc577a4SJonathan Peyton 
40787cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
40793041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_dup_alloc: Th %p, malloc size %ld\n", thread,
40803041982dSJonathan Peyton                 task_size));
40817cc577a4SJonathan Peyton #if USE_FAST_MEMORY
40827cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, task_size);
40837cc577a4SJonathan Peyton #else
40847cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, task_size);
40857cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
40867cc577a4SJonathan Peyton   KMP_MEMCPY(taskdata, taskdata_src, task_size);
40877cc577a4SJonathan Peyton 
40887cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
40897cc577a4SJonathan Peyton 
40907cc577a4SJonathan Peyton   // Initialize new task (only specific fields not affected by memcpy)
40917cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
40927cc577a4SJonathan Peyton   if (task->shareds != NULL) { // need setup shareds pointer
40937cc577a4SJonathan Peyton     shareds_offset = (char *)task_src->shareds - (char *)taskdata_src;
40947cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
40953041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
40963041982dSJonathan Peyton                      0);
40977cc577a4SJonathan Peyton   }
40987cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
409993e17cfeSJonathan Peyton   taskdata->td_parent = parent_task;
4100ae044467SAndreyChurbanov   // task inherits the taskgroup from the parent task
4101ae044467SAndreyChurbanov   taskdata->td_taskgroup = parent_task->td_taskgroup;
4102ae044467SAndreyChurbanov   // tied task needs to initialize the td_last_tied at creation,
4103ae044467SAndreyChurbanov   // untied one does this when it is scheduled for execution
4104ae044467SAndreyChurbanov   if (taskdata->td_flags.tiedness == TASK_TIED)
4105ae044467SAndreyChurbanov     taskdata->td_last_tied = taskdata;
41067cc577a4SJonathan Peyton 
41073041982dSJonathan Peyton   // Only need to keep track of child task counts if team parallel and tasking
41083041982dSJonathan Peyton   // not serialized
41097cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
411037e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
41117cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
411237e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
41133041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
41143041982dSJonathan Peyton     // implicit not deallocated
41157cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT)
411637e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
41177cc577a4SJonathan Peyton   }
41187cc577a4SJonathan Peyton 
41193041982dSJonathan Peyton   KA_TRACE(20,
41203041982dSJonathan Peyton            ("__kmp_task_dup_alloc(exit): Th %p, created task %p, parent=%p\n",
41217cc577a4SJonathan Peyton             thread, taskdata, taskdata->td_parent));
41227cc577a4SJonathan Peyton #if OMPT_SUPPORT
4123f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
412482e94a59SJoachim Protze     __ompt_task_init(taskdata, thread->th.th_info.ds.ds_gtid);
41257cc577a4SJonathan Peyton #endif
41267cc577a4SJonathan Peyton   return task;
41277cc577a4SJonathan Peyton }
41287cc577a4SJonathan Peyton 
41297cc577a4SJonathan Peyton // Routine optionally generated by the compiler for setting the lastprivate flag
41307cc577a4SJonathan Peyton // and calling needed constructors for private/firstprivate objects
41317cc577a4SJonathan Peyton // (used to form taskloop tasks from pattern task)
413293e17cfeSJonathan Peyton // Parameters: dest task, src task, lastprivate flag.
41337cc577a4SJonathan Peyton typedef void (*p_task_dup_t)(kmp_task_t *, kmp_task_t *, kmp_int32);
41347cc577a4SJonathan Peyton 
413527a677fcSJonathan Peyton KMP_BUILD_ASSERT(sizeof(long) == 4 || sizeof(long) == 8);
413627a677fcSJonathan Peyton 
413727a677fcSJonathan Peyton // class to encapsulate manipulating loop bounds in a taskloop task.
413827a677fcSJonathan Peyton // this abstracts away the Intel vs GOMP taskloop interface for setting/getting
413927a677fcSJonathan Peyton // the loop bound variables.
414027a677fcSJonathan Peyton class kmp_taskloop_bounds_t {
414127a677fcSJonathan Peyton   kmp_task_t *task;
414227a677fcSJonathan Peyton   const kmp_taskdata_t *taskdata;
414327a677fcSJonathan Peyton   size_t lower_offset;
414427a677fcSJonathan Peyton   size_t upper_offset;
414527a677fcSJonathan Peyton 
414627a677fcSJonathan Peyton public:
414727a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, kmp_uint64 *lb, kmp_uint64 *ub)
414827a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(task)),
414927a677fcSJonathan Peyton         lower_offset((char *)lb - (char *)task),
415027a677fcSJonathan Peyton         upper_offset((char *)ub - (char *)task) {
415127a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)lb > (char *)_task);
415227a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)ub > (char *)_task);
415327a677fcSJonathan Peyton   }
415427a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, const kmp_taskloop_bounds_t &bounds)
415527a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(_task)),
415627a677fcSJonathan Peyton         lower_offset(bounds.lower_offset), upper_offset(bounds.upper_offset) {}
415727a677fcSJonathan Peyton   size_t get_lower_offset() const { return lower_offset; }
415827a677fcSJonathan Peyton   size_t get_upper_offset() const { return upper_offset; }
415927a677fcSJonathan Peyton   kmp_uint64 get_lb() const {
416027a677fcSJonathan Peyton     kmp_int64 retval;
416127a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
416227a677fcSJonathan Peyton     // Intel task just returns the lower bound normally
416327a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
416427a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + lower_offset);
416527a677fcSJonathan Peyton     } else {
416627a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
416727a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
416827a677fcSJonathan Peyton         kmp_int32 *lb = RCAST(kmp_int32 *, task->shareds);
416927a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
417027a677fcSJonathan Peyton       } else {
417127a677fcSJonathan Peyton         kmp_int64 *lb = RCAST(kmp_int64 *, task->shareds);
417227a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
417327a677fcSJonathan Peyton       }
417427a677fcSJonathan Peyton     }
417527a677fcSJonathan Peyton #else
4176b3d84790SMartin Storsjö     (void)taskdata;
417727a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + lower_offset);
417827a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
417927a677fcSJonathan Peyton     return retval;
418027a677fcSJonathan Peyton   }
418127a677fcSJonathan Peyton   kmp_uint64 get_ub() const {
418227a677fcSJonathan Peyton     kmp_int64 retval;
418327a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
418427a677fcSJonathan Peyton     // Intel task just returns the upper bound normally
418527a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
418627a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + upper_offset);
418727a677fcSJonathan Peyton     } else {
418827a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
418927a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
419027a677fcSJonathan Peyton         kmp_int32 *ub = RCAST(kmp_int32 *, task->shareds) + 1;
419127a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
419227a677fcSJonathan Peyton       } else {
419327a677fcSJonathan Peyton         kmp_int64 *ub = RCAST(kmp_int64 *, task->shareds) + 1;
419427a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
419527a677fcSJonathan Peyton       }
419627a677fcSJonathan Peyton     }
419727a677fcSJonathan Peyton #else
419827a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + upper_offset);
419927a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
420027a677fcSJonathan Peyton     return retval;
420127a677fcSJonathan Peyton   }
420227a677fcSJonathan Peyton   void set_lb(kmp_uint64 lb) {
420327a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
420427a677fcSJonathan Peyton     // Intel task just sets the lower bound normally
420527a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
420627a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + lower_offset) = lb;
420727a677fcSJonathan Peyton     } else {
420827a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
420927a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
421027a677fcSJonathan Peyton         kmp_uint32 *lower = RCAST(kmp_uint32 *, task->shareds);
421127a677fcSJonathan Peyton         *lower = (kmp_uint32)lb;
421227a677fcSJonathan Peyton       } else {
421327a677fcSJonathan Peyton         kmp_uint64 *lower = RCAST(kmp_uint64 *, task->shareds);
421427a677fcSJonathan Peyton         *lower = (kmp_uint64)lb;
421527a677fcSJonathan Peyton       }
421627a677fcSJonathan Peyton     }
421727a677fcSJonathan Peyton #else
421827a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + lower_offset) = lb;
421927a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
422027a677fcSJonathan Peyton   }
422127a677fcSJonathan Peyton   void set_ub(kmp_uint64 ub) {
422227a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
422327a677fcSJonathan Peyton     // Intel task just sets the upper bound normally
422427a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
422527a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + upper_offset) = ub;
422627a677fcSJonathan Peyton     } else {
422727a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
422827a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
422927a677fcSJonathan Peyton         kmp_uint32 *upper = RCAST(kmp_uint32 *, task->shareds) + 1;
423027a677fcSJonathan Peyton         *upper = (kmp_uint32)ub;
423127a677fcSJonathan Peyton       } else {
423227a677fcSJonathan Peyton         kmp_uint64 *upper = RCAST(kmp_uint64 *, task->shareds) + 1;
423327a677fcSJonathan Peyton         *upper = (kmp_uint64)ub;
423427a677fcSJonathan Peyton       }
423527a677fcSJonathan Peyton     }
423627a677fcSJonathan Peyton #else
423727a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + upper_offset) = ub;
423827a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
423927a677fcSJonathan Peyton   }
424027a677fcSJonathan Peyton };
424127a677fcSJonathan Peyton 
42427cc577a4SJonathan Peyton // __kmp_taskloop_linear: Start tasks of the taskloop linearly
42437cc577a4SJonathan Peyton //
42447cc577a4SJonathan Peyton // loc        Source location information
42457cc577a4SJonathan Peyton // gtid       Global thread ID
424693e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
424793e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
424893e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
42497cc577a4SJonathan Peyton // st         Loop stride
425093e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
425193e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
425293e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
425393e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4254540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
425593e17cfeSJonathan Peyton // tc         Iterations count
42567cc577a4SJonathan Peyton // task_dup   Tasks duplication routine
4257cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
42583041982dSJonathan Peyton void __kmp_taskloop_linear(ident_t *loc, int gtid, kmp_task_t *task,
42597cc577a4SJonathan Peyton                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
426093e17cfeSJonathan Peyton                            kmp_uint64 ub_glob, kmp_uint64 num_tasks,
426193e17cfeSJonathan Peyton                            kmp_uint64 grainsize, kmp_uint64 extras,
4262540007b4SNawrin Sultana                            kmp_int64 last_chunk, kmp_uint64 tc,
4263cdaefac5SJoachim Protze #if OMPT_SUPPORT
4264cdaefac5SJoachim Protze                            void *codeptr_ra,
4265cdaefac5SJoachim Protze #endif
4266cdaefac5SJoachim Protze                            void *task_dup) {
42677cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKLOOP);
42687cc577a4SJonathan Peyton   KMP_TIME_PARTITIONED_BLOCK(OMP_taskloop_scheduling);
42697cc577a4SJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
427027a677fcSJonathan Peyton   // compiler provides global bounds here
427127a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
427227a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
427327a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
427493e17cfeSJonathan Peyton   kmp_uint64 i;
42757cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
42767cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
42777cc577a4SJonathan Peyton   kmp_task_t *next_task;
42787cc577a4SJonathan Peyton   kmp_int32 lastpriv = 0;
42797cc577a4SJonathan Peyton 
4280309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4281309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
428293e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
428393e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
428493e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_linear: T#%d: %lld tasks, grainsize %lld, "
4285540007b4SNawrin Sultana                 "extras %lld, last_chunk %lld, i=%lld,%lld(%d)%lld, dup %p\n",
4286540007b4SNawrin Sultana                 gtid, num_tasks, grainsize, extras, last_chunk, lower, upper,
4287540007b4SNawrin Sultana                 ub_glob, st, task_dup));
428893e17cfeSJonathan Peyton 
428993e17cfeSJonathan Peyton   // Launch num_tasks tasks, assign grainsize iterations each task
429093e17cfeSJonathan Peyton   for (i = 0; i < num_tasks; ++i) {
429193e17cfeSJonathan Peyton     kmp_uint64 chunk_minus_1;
429293e17cfeSJonathan Peyton     if (extras == 0) {
429393e17cfeSJonathan Peyton       chunk_minus_1 = grainsize - 1;
429493e17cfeSJonathan Peyton     } else {
429593e17cfeSJonathan Peyton       chunk_minus_1 = grainsize;
429693e17cfeSJonathan Peyton       --extras; // first extras iterations get bigger chunk (grainsize+1)
429793e17cfeSJonathan Peyton     }
429893e17cfeSJonathan Peyton     upper = lower + st * chunk_minus_1;
4299540007b4SNawrin Sultana     if (upper > *ub) {
4300540007b4SNawrin Sultana       upper = *ub;
4301540007b4SNawrin Sultana     }
430293e17cfeSJonathan Peyton     if (i == num_tasks - 1) {
430393e17cfeSJonathan Peyton       // schedule the last task, set lastprivate flag if needed
430493e17cfeSJonathan Peyton       if (st == 1) { // most common case
430593e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper == *ub);
430693e17cfeSJonathan Peyton         if (upper == ub_glob)
430793e17cfeSJonathan Peyton           lastpriv = 1;
430893e17cfeSJonathan Peyton       } else if (st > 0) { // positive loop stride
430993e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT((kmp_uint64)st > *ub - upper);
431093e17cfeSJonathan Peyton         if ((kmp_uint64)st > ub_glob - upper)
431193e17cfeSJonathan Peyton           lastpriv = 1;
431293e17cfeSJonathan Peyton       } else { // negative loop stride
431393e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper + st < *ub);
431493e17cfeSJonathan Peyton         if (upper - ub_glob < (kmp_uint64)(-st))
431593e17cfeSJonathan Peyton           lastpriv = 1;
431693e17cfeSJonathan Peyton       }
431793e17cfeSJonathan Peyton     }
431893e17cfeSJonathan Peyton     next_task = __kmp_task_dup_alloc(thread, task); // allocate new task
431927a677fcSJonathan Peyton     kmp_taskdata_t *next_taskdata = KMP_TASK_TO_TASKDATA(next_task);
432027a677fcSJonathan Peyton     kmp_taskloop_bounds_t next_task_bounds =
432127a677fcSJonathan Peyton         kmp_taskloop_bounds_t(next_task, task_bounds);
432227a677fcSJonathan Peyton 
432393e17cfeSJonathan Peyton     // adjust task-specific bounds
432427a677fcSJonathan Peyton     next_task_bounds.set_lb(lower);
432527a677fcSJonathan Peyton     if (next_taskdata->td_flags.native) {
432627a677fcSJonathan Peyton       next_task_bounds.set_ub(upper + (st > 0 ? 1 : -1));
432727a677fcSJonathan Peyton     } else {
432827a677fcSJonathan Peyton       next_task_bounds.set_ub(upper);
432927a677fcSJonathan Peyton     }
43304c6a098aSKazuaki Ishizaki     if (ptask_dup != NULL) // set lastprivate flag, construct firstprivates,
43314c6a098aSKazuaki Ishizaki                            // etc.
433293e17cfeSJonathan Peyton       ptask_dup(next_task, task, lastpriv);
433327a677fcSJonathan Peyton     KA_TRACE(40,
433427a677fcSJonathan Peyton              ("__kmp_taskloop_linear: T#%d; task #%llu: task %p: lower %lld, "
433527a677fcSJonathan Peyton               "upper %lld stride %lld, (offsets %p %p)\n",
433627a677fcSJonathan Peyton               gtid, i, next_task, lower, upper, st,
433727a677fcSJonathan Peyton               next_task_bounds.get_lower_offset(),
433827a677fcSJonathan Peyton               next_task_bounds.get_upper_offset()));
4339cdaefac5SJoachim Protze #if OMPT_SUPPORT
4340cdaefac5SJoachim Protze     __kmp_omp_taskloop_task(NULL, gtid, next_task,
4341cdaefac5SJoachim Protze                             codeptr_ra); // schedule new task
4342cdaefac5SJoachim Protze #else
434393e17cfeSJonathan Peyton     __kmp_omp_task(gtid, next_task, true); // schedule new task
4344cdaefac5SJoachim Protze #endif
434593e17cfeSJonathan Peyton     lower = upper + st; // adjust lower bound for the next iteration
434693e17cfeSJonathan Peyton   }
434793e17cfeSJonathan Peyton   // free the pattern task and exit
434893e17cfeSJonathan Peyton   __kmp_task_start(gtid, task, current_task); // make internal bookkeeping
434993e17cfeSJonathan Peyton   // do not execute the pattern task, just do internal bookkeeping
435086ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task, current_task);
435193e17cfeSJonathan Peyton }
435293e17cfeSJonathan Peyton 
435393e17cfeSJonathan Peyton // Structure to keep taskloop parameters for auxiliary task
435493e17cfeSJonathan Peyton // kept in the shareds of the task structure.
435593e17cfeSJonathan Peyton typedef struct __taskloop_params {
435693e17cfeSJonathan Peyton   kmp_task_t *task;
435793e17cfeSJonathan Peyton   kmp_uint64 *lb;
435893e17cfeSJonathan Peyton   kmp_uint64 *ub;
435993e17cfeSJonathan Peyton   void *task_dup;
436093e17cfeSJonathan Peyton   kmp_int64 st;
436193e17cfeSJonathan Peyton   kmp_uint64 ub_glob;
436293e17cfeSJonathan Peyton   kmp_uint64 num_tasks;
436393e17cfeSJonathan Peyton   kmp_uint64 grainsize;
436493e17cfeSJonathan Peyton   kmp_uint64 extras;
4365540007b4SNawrin Sultana   kmp_int64 last_chunk;
436693e17cfeSJonathan Peyton   kmp_uint64 tc;
436793e17cfeSJonathan Peyton   kmp_uint64 num_t_min;
4368cdaefac5SJoachim Protze #if OMPT_SUPPORT
4369cdaefac5SJoachim Protze   void *codeptr_ra;
4370cdaefac5SJoachim Protze #endif
437193e17cfeSJonathan Peyton } __taskloop_params_t;
437293e17cfeSJonathan Peyton 
437393e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *, int, kmp_task_t *, kmp_uint64 *,
437493e17cfeSJonathan Peyton                           kmp_uint64 *, kmp_int64, kmp_uint64, kmp_uint64,
4375540007b4SNawrin Sultana                           kmp_uint64, kmp_uint64, kmp_int64, kmp_uint64,
4376540007b4SNawrin Sultana                           kmp_uint64,
4377cdaefac5SJoachim Protze #if OMPT_SUPPORT
4378cdaefac5SJoachim Protze                           void *,
4379cdaefac5SJoachim Protze #endif
438093e17cfeSJonathan Peyton                           void *);
438193e17cfeSJonathan Peyton 
4382ed5fe645SKelvin Li // Execute part of the taskloop submitted as a task.
438393e17cfeSJonathan Peyton int __kmp_taskloop_task(int gtid, void *ptask) {
4384d74d8902SJonathan Peyton   __taskloop_params_t *p =
4385d74d8902SJonathan Peyton       (__taskloop_params_t *)((kmp_task_t *)ptask)->shareds;
438693e17cfeSJonathan Peyton   kmp_task_t *task = p->task;
438793e17cfeSJonathan Peyton   kmp_uint64 *lb = p->lb;
438893e17cfeSJonathan Peyton   kmp_uint64 *ub = p->ub;
438993e17cfeSJonathan Peyton   void *task_dup = p->task_dup;
439093e17cfeSJonathan Peyton   //  p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
439193e17cfeSJonathan Peyton   kmp_int64 st = p->st;
439293e17cfeSJonathan Peyton   kmp_uint64 ub_glob = p->ub_glob;
439393e17cfeSJonathan Peyton   kmp_uint64 num_tasks = p->num_tasks;
439493e17cfeSJonathan Peyton   kmp_uint64 grainsize = p->grainsize;
439593e17cfeSJonathan Peyton   kmp_uint64 extras = p->extras;
4396540007b4SNawrin Sultana   kmp_int64 last_chunk = p->last_chunk;
439793e17cfeSJonathan Peyton   kmp_uint64 tc = p->tc;
439893e17cfeSJonathan Peyton   kmp_uint64 num_t_min = p->num_t_min;
4399cdaefac5SJoachim Protze #if OMPT_SUPPORT
4400cdaefac5SJoachim Protze   void *codeptr_ra = p->codeptr_ra;
4401cdaefac5SJoachim Protze #endif
440293e17cfeSJonathan Peyton #if KMP_DEBUG
440393e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
440493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
4405540007b4SNawrin Sultana   KA_TRACE(20,
4406540007b4SNawrin Sultana            ("__kmp_taskloop_task: T#%d, task %p: %lld tasks, grainsize"
4407540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4408540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4409540007b4SNawrin Sultana             st, task_dup));
441093e17cfeSJonathan Peyton #endif
441193e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks * 2 + 1 > num_t_min);
441293e17cfeSJonathan Peyton   if (num_tasks > num_t_min)
441393e17cfeSJonathan Peyton     __kmp_taskloop_recur(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4414540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_t_min,
4415cdaefac5SJoachim Protze #if OMPT_SUPPORT
4416cdaefac5SJoachim Protze                          codeptr_ra,
4417cdaefac5SJoachim Protze #endif
4418cdaefac5SJoachim Protze                          task_dup);
441993e17cfeSJonathan Peyton   else
442093e17cfeSJonathan Peyton     __kmp_taskloop_linear(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4421540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4422cdaefac5SJoachim Protze #if OMPT_SUPPORT
4423cdaefac5SJoachim Protze                           codeptr_ra,
4424cdaefac5SJoachim Protze #endif
4425cdaefac5SJoachim Protze                           task_dup);
442693e17cfeSJonathan Peyton 
442793e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmp_taskloop_task(exit): T#%d\n", gtid));
442893e17cfeSJonathan Peyton   return 0;
442993e17cfeSJonathan Peyton }
443093e17cfeSJonathan Peyton 
4431ed5fe645SKelvin Li // Schedule part of the taskloop as a task,
4432ed5fe645SKelvin Li // execute the rest of the taskloop.
443393e17cfeSJonathan Peyton //
443493e17cfeSJonathan Peyton // loc        Source location information
443593e17cfeSJonathan Peyton // gtid       Global thread ID
443693e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
443793e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
443893e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
443993e17cfeSJonathan Peyton // st         Loop stride
444093e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
444193e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
444293e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
444393e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4444540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
444593e17cfeSJonathan Peyton // tc         Iterations count
444642016791SKazuaki Ishizaki // num_t_min  Threshold to launch tasks recursively
444793e17cfeSJonathan Peyton // task_dup   Tasks duplication routine
4448cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
444993e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *loc, int gtid, kmp_task_t *task,
445093e17cfeSJonathan Peyton                           kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
445193e17cfeSJonathan Peyton                           kmp_uint64 ub_glob, kmp_uint64 num_tasks,
445293e17cfeSJonathan Peyton                           kmp_uint64 grainsize, kmp_uint64 extras,
4453540007b4SNawrin Sultana                           kmp_int64 last_chunk, kmp_uint64 tc,
4454540007b4SNawrin Sultana                           kmp_uint64 num_t_min,
4455cdaefac5SJoachim Protze #if OMPT_SUPPORT
4456cdaefac5SJoachim Protze                           void *codeptr_ra,
4457cdaefac5SJoachim Protze #endif
4458cdaefac5SJoachim Protze                           void *task_dup) {
445993e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
446093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
446193e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > num_t_min);
4462540007b4SNawrin Sultana   KA_TRACE(20,
4463540007b4SNawrin Sultana            ("__kmp_taskloop_recur: T#%d, task %p: %lld tasks, grainsize"
4464540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4465540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4466540007b4SNawrin Sultana             st, task_dup));
446793e17cfeSJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
446893e17cfeSJonathan Peyton   kmp_uint64 lower = *lb;
446993e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
447093e17cfeSJonathan Peyton   //  kmp_taskdata_t *current_task = thread->th.th_current_task;
447193e17cfeSJonathan Peyton   kmp_task_t *next_task;
447293e17cfeSJonathan Peyton   size_t lower_offset =
447393e17cfeSJonathan Peyton       (char *)lb - (char *)task; // remember offset of lb in the task structure
447493e17cfeSJonathan Peyton   size_t upper_offset =
447593e17cfeSJonathan Peyton       (char *)ub - (char *)task; // remember offset of ub in the task structure
447693e17cfeSJonathan Peyton 
4477309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4478309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
447993e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
448093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
448193e17cfeSJonathan Peyton 
448293e17cfeSJonathan Peyton   // split the loop in two halves
448393e17cfeSJonathan Peyton   kmp_uint64 lb1, ub0, tc0, tc1, ext0, ext1;
4484540007b4SNawrin Sultana   kmp_int64 last_chunk0 = 0, last_chunk1 = 0;
448593e17cfeSJonathan Peyton   kmp_uint64 gr_size0 = grainsize;
448693e17cfeSJonathan Peyton   kmp_uint64 n_tsk0 = num_tasks >> 1; // num_tasks/2 to execute
448793e17cfeSJonathan Peyton   kmp_uint64 n_tsk1 = num_tasks - n_tsk0; // to schedule as a task
4488540007b4SNawrin Sultana   if (last_chunk < 0) {
4489540007b4SNawrin Sultana     ext0 = ext1 = 0;
4490540007b4SNawrin Sultana     last_chunk1 = last_chunk;
4491540007b4SNawrin Sultana     tc0 = grainsize * n_tsk0;
4492540007b4SNawrin Sultana     tc1 = tc - tc0;
4493540007b4SNawrin Sultana   } else if (n_tsk0 <= extras) {
449493e17cfeSJonathan Peyton     gr_size0++; // integrate extras into grainsize
449593e17cfeSJonathan Peyton     ext0 = 0; // no extra iters in 1st half
449693e17cfeSJonathan Peyton     ext1 = extras - n_tsk0; // remaining extras
449793e17cfeSJonathan Peyton     tc0 = gr_size0 * n_tsk0;
449893e17cfeSJonathan Peyton     tc1 = tc - tc0;
449993e17cfeSJonathan Peyton   } else { // n_tsk0 > extras
450093e17cfeSJonathan Peyton     ext1 = 0; // no extra iters in 2nd half
450193e17cfeSJonathan Peyton     ext0 = extras;
450293e17cfeSJonathan Peyton     tc1 = grainsize * n_tsk1;
450393e17cfeSJonathan Peyton     tc0 = tc - tc1;
450493e17cfeSJonathan Peyton   }
450593e17cfeSJonathan Peyton   ub0 = lower + st * (tc0 - 1);
450693e17cfeSJonathan Peyton   lb1 = ub0 + st;
450793e17cfeSJonathan Peyton 
450893e17cfeSJonathan Peyton   // create pattern task for 2nd half of the loop
450993e17cfeSJonathan Peyton   next_task = __kmp_task_dup_alloc(thread, task); // duplicate the task
451093e17cfeSJonathan Peyton   // adjust lower bound (upper bound is not changed) for the 2nd half
451193e17cfeSJonathan Peyton   *(kmp_uint64 *)((char *)next_task + lower_offset) = lb1;
45124c6a098aSKazuaki Ishizaki   if (ptask_dup != NULL) // construct firstprivates, etc.
451393e17cfeSJonathan Peyton     ptask_dup(next_task, task, 0);
451493e17cfeSJonathan Peyton   *ub = ub0; // adjust upper bound for the 1st half
451593e17cfeSJonathan Peyton 
451693e17cfeSJonathan Peyton   // create auxiliary task for 2nd half of the loop
45175e111c5dSAndreyChurbanov   // make sure new task has same parent task as the pattern task
45185e111c5dSAndreyChurbanov   kmp_taskdata_t *current_task = thread->th.th_current_task;
45195e111c5dSAndreyChurbanov   thread->th.th_current_task = taskdata->td_parent;
452093e17cfeSJonathan Peyton   kmp_task_t *new_task =
452193e17cfeSJonathan Peyton       __kmpc_omp_task_alloc(loc, gtid, 1, 3 * sizeof(void *),
452293e17cfeSJonathan Peyton                             sizeof(__taskloop_params_t), &__kmp_taskloop_task);
45235e111c5dSAndreyChurbanov   // restore current task
45245e111c5dSAndreyChurbanov   thread->th.th_current_task = current_task;
452593e17cfeSJonathan Peyton   __taskloop_params_t *p = (__taskloop_params_t *)new_task->shareds;
452693e17cfeSJonathan Peyton   p->task = next_task;
452793e17cfeSJonathan Peyton   p->lb = (kmp_uint64 *)((char *)next_task + lower_offset);
452893e17cfeSJonathan Peyton   p->ub = (kmp_uint64 *)((char *)next_task + upper_offset);
452993e17cfeSJonathan Peyton   p->task_dup = task_dup;
453093e17cfeSJonathan Peyton   p->st = st;
453193e17cfeSJonathan Peyton   p->ub_glob = ub_glob;
453293e17cfeSJonathan Peyton   p->num_tasks = n_tsk1;
453393e17cfeSJonathan Peyton   p->grainsize = grainsize;
453493e17cfeSJonathan Peyton   p->extras = ext1;
4535540007b4SNawrin Sultana   p->last_chunk = last_chunk1;
453693e17cfeSJonathan Peyton   p->tc = tc1;
453793e17cfeSJonathan Peyton   p->num_t_min = num_t_min;
4538cdaefac5SJoachim Protze #if OMPT_SUPPORT
4539cdaefac5SJoachim Protze   p->codeptr_ra = codeptr_ra;
4540cdaefac5SJoachim Protze #endif
4541cdaefac5SJoachim Protze 
4542cdaefac5SJoachim Protze #if OMPT_SUPPORT
4543cdaefac5SJoachim Protze   // schedule new task with correct return address for OMPT events
4544cdaefac5SJoachim Protze   __kmp_omp_taskloop_task(NULL, gtid, new_task, codeptr_ra);
4545cdaefac5SJoachim Protze #else
4546f729df82SGheorghe-Teodor Bercea   __kmp_omp_task(gtid, new_task, true); // schedule new task
4547cdaefac5SJoachim Protze #endif
454893e17cfeSJonathan Peyton 
454993e17cfeSJonathan Peyton   // execute the 1st half of current subrange
455093e17cfeSJonathan Peyton   if (n_tsk0 > num_t_min)
4551d74d8902SJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0, gr_size0,
4552540007b4SNawrin Sultana                          ext0, last_chunk0, tc0, num_t_min,
4553cdaefac5SJoachim Protze #if OMPT_SUPPORT
4554cdaefac5SJoachim Protze                          codeptr_ra,
4555cdaefac5SJoachim Protze #endif
4556cdaefac5SJoachim Protze                          task_dup);
455793e17cfeSJonathan Peyton   else
455893e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0,
4559540007b4SNawrin Sultana                           gr_size0, ext0, last_chunk0, tc0,
4560cdaefac5SJoachim Protze #if OMPT_SUPPORT
4561cdaefac5SJoachim Protze                           codeptr_ra,
4562cdaefac5SJoachim Protze #endif
4563cdaefac5SJoachim Protze                           task_dup);
456493e17cfeSJonathan Peyton 
4565540007b4SNawrin Sultana   KA_TRACE(40, ("__kmp_taskloop_recur(exit): T#%d\n", gtid));
456693e17cfeSJonathan Peyton }
456793e17cfeSJonathan Peyton 
4568540007b4SNawrin Sultana static void __kmp_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4569540007b4SNawrin Sultana                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4570540007b4SNawrin Sultana                            int nogroup, int sched, kmp_uint64 grainsize,
4571540007b4SNawrin Sultana                            int modifier, void *task_dup) {
457293e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
457393e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
457482e94a59SJoachim Protze   if (nogroup == 0) {
457582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
457682e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
457782e94a59SJoachim Protze #endif
457893e17cfeSJonathan Peyton     __kmpc_taskgroup(loc, gtid);
457982e94a59SJoachim Protze   }
458093e17cfeSJonathan Peyton 
458193e17cfeSJonathan Peyton   // =========================================================================
458293e17cfeSJonathan Peyton   // calculate loop parameters
458327a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
458493e17cfeSJonathan Peyton   kmp_uint64 tc;
458527a677fcSJonathan Peyton   // compiler provides global bounds here
458627a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
458727a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
458893e17cfeSJonathan Peyton   kmp_uint64 ub_glob = upper; // global upper used to calc lastprivate flag
458993e17cfeSJonathan Peyton   kmp_uint64 num_tasks = 0, extras = 0;
4590540007b4SNawrin Sultana   kmp_int64 last_chunk =
4591540007b4SNawrin Sultana       0; // reduce grainsize of last task by last_chunk in strict mode
459293e17cfeSJonathan Peyton   kmp_uint64 num_tasks_min = __kmp_taskloop_min_tasks;
459393e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
459493e17cfeSJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
459593e17cfeSJonathan Peyton 
4596540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop: T#%d, task %p, lb %lld, ub %lld, st %lld, "
4597540007b4SNawrin Sultana                 "grain %llu(%d, %d), dup %p\n",
4598540007b4SNawrin Sultana                 gtid, taskdata, lower, upper, st, grainsize, sched, modifier,
4599540007b4SNawrin Sultana                 task_dup));
460027a677fcSJonathan Peyton 
46017cc577a4SJonathan Peyton   // compute trip count
46027cc577a4SJonathan Peyton   if (st == 1) { // most common case
46037cc577a4SJonathan Peyton     tc = upper - lower + 1;
46047cc577a4SJonathan Peyton   } else if (st < 0) {
46057cc577a4SJonathan Peyton     tc = (lower - upper) / (-st) + 1;
46067cc577a4SJonathan Peyton   } else { // st > 0
46077cc577a4SJonathan Peyton     tc = (upper - lower) / st + 1;
46087cc577a4SJonathan Peyton   }
46097cc577a4SJonathan Peyton   if (tc == 0) {
4610540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop(exit): T#%d zero-trip loop\n", gtid));
46117cc577a4SJonathan Peyton     // free the pattern task and exit
46127cc577a4SJonathan Peyton     __kmp_task_start(gtid, task, current_task);
46137cc577a4SJonathan Peyton     // do not execute anything for zero-trip loop
461486ed6aa6SJoachim Protze     __kmp_task_finish<false>(gtid, task, current_task);
46157cc577a4SJonathan Peyton     return;
46167cc577a4SJonathan Peyton   }
4617cdaefac5SJoachim Protze 
4618cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4619cdaefac5SJoachim Protze   ompt_team_info_t *team_info = __ompt_get_teaminfo(0, NULL);
4620cdaefac5SJoachim Protze   ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
4621cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4622cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4623cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_begin, &(team_info->parallel_data),
4624cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4625cdaefac5SJoachim Protze   }
4626cdaefac5SJoachim Protze #endif
4627cdaefac5SJoachim Protze 
462893e17cfeSJonathan Peyton   if (num_tasks_min == 0)
462993e17cfeSJonathan Peyton     // TODO: can we choose better default heuristic?
4630d74d8902SJonathan Peyton     num_tasks_min =
4631d74d8902SJonathan Peyton         KMP_MIN(thread->th.th_team_nproc * 10, INITIAL_TASK_DEQUE_SIZE);
46327cc577a4SJonathan Peyton 
46337cc577a4SJonathan Peyton   // compute num_tasks/grainsize based on the input provided
46347cc577a4SJonathan Peyton   switch (sched) {
46357cc577a4SJonathan Peyton   case 0: // no schedule clause specified, we can choose the default
46367cc577a4SJonathan Peyton     // let's try to schedule (team_size*10) tasks
46377cc577a4SJonathan Peyton     grainsize = thread->th.th_team_nproc * 10;
46380c599c38SJoachim Protze     KMP_FALLTHROUGH();
46397cc577a4SJonathan Peyton   case 2: // num_tasks provided
46407cc577a4SJonathan Peyton     if (grainsize > tc) {
46417cc577a4SJonathan Peyton       num_tasks = tc; // too big num_tasks requested, adjust values
46427cc577a4SJonathan Peyton       grainsize = 1;
46437cc577a4SJonathan Peyton       extras = 0;
46447cc577a4SJonathan Peyton     } else {
46457cc577a4SJonathan Peyton       num_tasks = grainsize;
46467cc577a4SJonathan Peyton       grainsize = tc / num_tasks;
46477cc577a4SJonathan Peyton       extras = tc % num_tasks;
46487cc577a4SJonathan Peyton     }
46497cc577a4SJonathan Peyton     break;
46507cc577a4SJonathan Peyton   case 1: // grainsize provided
46517cc577a4SJonathan Peyton     if (grainsize > tc) {
4652540007b4SNawrin Sultana       num_tasks = 1;
4653540007b4SNawrin Sultana       grainsize = tc; // too big grainsize requested, adjust values
4654540007b4SNawrin Sultana       extras = 0;
4655540007b4SNawrin Sultana     } else {
4656540007b4SNawrin Sultana       if (modifier) {
4657540007b4SNawrin Sultana         num_tasks = (tc + grainsize - 1) / grainsize;
4658540007b4SNawrin Sultana         last_chunk = tc - (num_tasks * grainsize);
46597cc577a4SJonathan Peyton         extras = 0;
46607cc577a4SJonathan Peyton       } else {
46617cc577a4SJonathan Peyton         num_tasks = tc / grainsize;
466293e17cfeSJonathan Peyton         // adjust grainsize for balanced distribution of iterations
466393e17cfeSJonathan Peyton         grainsize = tc / num_tasks;
46647cc577a4SJonathan Peyton         extras = tc % num_tasks;
46657cc577a4SJonathan Peyton       }
4666540007b4SNawrin Sultana     }
46677cc577a4SJonathan Peyton     break;
46687cc577a4SJonathan Peyton   default:
46697cc577a4SJonathan Peyton     KMP_ASSERT2(0, "unknown scheduling of taskloop");
46707cc577a4SJonathan Peyton   }
4671540007b4SNawrin Sultana 
4672309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4673309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
46747cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
46757cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
467693e17cfeSJonathan Peyton   // =========================================================================
46777cc577a4SJonathan Peyton 
46787cc577a4SJonathan Peyton   // check if clause value first
467927a677fcSJonathan Peyton   // Also require GOMP_taskloop to reduce to linear (taskdata->td_flags.native)
46807cc577a4SJonathan Peyton   if (if_val == 0) { // if(0) specified, mark task as serial
46817cc577a4SJonathan Peyton     taskdata->td_flags.task_serial = 1;
46827cc577a4SJonathan Peyton     taskdata->td_flags.tiedness = TASK_TIED; // AC: serial task cannot be untied
468393e17cfeSJonathan Peyton     // always start serial tasks linearly
468493e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4685540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4686cdaefac5SJoachim Protze #if OMPT_SUPPORT
4687cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4688cdaefac5SJoachim Protze #endif
4689cdaefac5SJoachim Protze                           task_dup);
469027a677fcSJonathan Peyton     // !taskdata->td_flags.native => currently force linear spawning of tasks
469127a677fcSJonathan Peyton     // for GOMP_taskloop
469227a677fcSJonathan Peyton   } else if (num_tasks > num_tasks_min && !taskdata->td_flags.native) {
4693540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go recursive: tc %llu, #tasks %llu"
4694540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4695540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4696540007b4SNawrin Sultana                   last_chunk));
469793e17cfeSJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4698540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_tasks_min,
4699cdaefac5SJoachim Protze #if OMPT_SUPPORT
4700cdaefac5SJoachim Protze                          OMPT_GET_RETURN_ADDRESS(0),
4701cdaefac5SJoachim Protze #endif
4702cdaefac5SJoachim Protze                          task_dup);
470393e17cfeSJonathan Peyton   } else {
4704540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go linear: tc %llu, #tasks %llu"
4705540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4706540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4707540007b4SNawrin Sultana                   last_chunk));
470893e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4709540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4710cdaefac5SJoachim Protze #if OMPT_SUPPORT
4711cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4712cdaefac5SJoachim Protze #endif
4713cdaefac5SJoachim Protze                           task_dup);
47147cc577a4SJonathan Peyton   }
47157cc577a4SJonathan Peyton 
4716cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4717cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4718cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4719cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_end, &(team_info->parallel_data),
4720cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4721cdaefac5SJoachim Protze   }
4722cdaefac5SJoachim Protze #endif
4723cdaefac5SJoachim Protze 
472482e94a59SJoachim Protze   if (nogroup == 0) {
472582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
472682e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
472782e94a59SJoachim Protze #endif
47287cc577a4SJonathan Peyton     __kmpc_end_taskgroup(loc, gtid);
472982e94a59SJoachim Protze   }
4730540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop(exit): T#%d\n", gtid));
4731540007b4SNawrin Sultana }
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 task_dup  Tasks duplication routine
4746540007b4SNawrin Sultana 
4747540007b4SNawrin Sultana Execute the taskloop construct.
4748540007b4SNawrin Sultana */
4749540007b4SNawrin Sultana void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4750540007b4SNawrin Sultana                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,
4751540007b4SNawrin Sultana                      int sched, kmp_uint64 grainsize, void *task_dup) {
4752540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4753540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop(enter): T#%d\n", gtid));
4754540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4755540007b4SNawrin Sultana                  0, task_dup);
475693e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d\n", gtid));
47577cc577a4SJonathan Peyton }
4758540007b4SNawrin Sultana 
4759540007b4SNawrin Sultana /*!
4760540007b4SNawrin Sultana @ingroup TASKING
4761540007b4SNawrin Sultana @param loc       Source location information
4762540007b4SNawrin Sultana @param gtid      Global thread ID
4763540007b4SNawrin Sultana @param task      Task structure
4764540007b4SNawrin Sultana @param if_val    Value of the if clause
4765540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4766540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4767540007b4SNawrin Sultana @param st        Loop stride
4768540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4769540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4770540007b4SNawrin Sultana @param grainsize Schedule value if specified
4771540007b4SNawrin Sultana @param modifer   Modifier 'strict' for sched, 1 if present, 0 otherwise
4772540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4773540007b4SNawrin Sultana 
4774540007b4SNawrin Sultana Execute the taskloop construct.
4775540007b4SNawrin Sultana */
4776540007b4SNawrin Sultana void __kmpc_taskloop_5(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4777540007b4SNawrin Sultana                        kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4778540007b4SNawrin Sultana                        int nogroup, int sched, kmp_uint64 grainsize,
4779540007b4SNawrin Sultana                        int modifier, void *task_dup) {
4780540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4781540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(enter): T#%d\n", gtid));
4782540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4783540007b4SNawrin Sultana                  modifier, task_dup);
4784540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(exit): T#%d\n", gtid));
4785540007b4SNawrin Sultana }
4786