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 
327*1d8d43aeSShilei Tian   // If we encounter a hidden helper task, and the current thread is not a
328*1d8d43aeSShilei Tian   // hidden helper thread, we have to give the task to any hidden helper thread
329*1d8d43aeSShilei Tian   // starting from its shadow one.
330*1d8d43aeSShilei Tian   if (UNLIKELY(taskdata->td_flags.hidden_helper &&
331*1d8d43aeSShilei Tian                !KMP_HIDDEN_HELPER_THREAD(gtid))) {
332*1d8d43aeSShilei Tian     kmp_int32 shadow_gtid = KMP_GTID_TO_SHADOW_GTID(gtid);
333*1d8d43aeSShilei Tian     __kmpc_give_task(task, __kmp_tid_from_gtid(shadow_gtid));
334*1d8d43aeSShilei Tian     // Signal the hidden helper threads.
335*1d8d43aeSShilei Tian     __kmp_hidden_helper_worker_thread_signal();
336*1d8d43aeSShilei Tian     return TASK_SUCCESSFULLY_PUSHED;
3379d64275aSShilei Tian   }
3389d64275aSShilei Tian 
3397cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
3407cc577a4SJonathan Peyton   kmp_int32 tid = __kmp_tid_from_gtid(gtid);
3417cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
3427cc577a4SJonathan Peyton 
3433041982dSJonathan Peyton   KA_TRACE(20,
3443041982dSJonathan Peyton            ("__kmp_push_task: T#%d trying to push task %p.\n", gtid, taskdata));
3457cc577a4SJonathan Peyton 
3466bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
3473041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
3483041982dSJonathan Peyton     // freed prematurely
34937e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
350baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
3513041982dSJonathan Peyton     KA_TRACE(
3523041982dSJonathan Peyton         20,
3533041982dSJonathan Peyton         ("__kmp_push_task: T#%d untied_count (%d) incremented for task %p\n",
3547cc577a4SJonathan Peyton          gtid, counter, taskdata));
3557cc577a4SJonathan Peyton   }
3567cc577a4SJonathan Peyton 
3577cc577a4SJonathan Peyton   // The first check avoids building task_team thread data if serialized
3586bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.task_serial)) {
3593041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_push_task: T#%d team serialized; returning "
3603041982dSJonathan Peyton                   "TASK_NOT_PUSHED for task %p\n",
3617cc577a4SJonathan Peyton                   gtid, taskdata));
3627cc577a4SJonathan Peyton     return TASK_NOT_PUSHED;
3637cc577a4SJonathan Peyton   }
3647cc577a4SJonathan Peyton 
3653041982dSJonathan Peyton   // Now that serialized tasks have returned, we can assume that we are not in
3663041982dSJonathan Peyton   // immediate exec mode
3677cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
3686bf84871SAndreyChurbanov   if (UNLIKELY(!KMP_TASKING_ENABLED(task_team))) {
3697cc577a4SJonathan Peyton     __kmp_enable_tasking(task_team, thread);
3707cc577a4SJonathan Peyton   }
3717cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(task_team->tt.tt_found_tasks) == TRUE);
3727cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_PTR(task_team->tt.tt_threads_data) != NULL);
3737cc577a4SJonathan Peyton 
3747cc577a4SJonathan Peyton   // Find tasking deque specific to encountering thread
3757cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[tid];
3767cc577a4SJonathan Peyton 
3779d64275aSShilei Tian   // No lock needed since only owner can allocate. If the task is hidden_helper,
3789d64275aSShilei Tian   // we don't need it either because we have initialized the dequeue for hidden
3799d64275aSShilei Tian   // helper thread data.
3806bf84871SAndreyChurbanov   if (UNLIKELY(thread_data->td.td_deque == NULL)) {
3817cc577a4SJonathan Peyton     __kmp_alloc_task_deque(thread, thread_data);
3827cc577a4SJonathan Peyton   }
3837cc577a4SJonathan Peyton 
384c3344345SAndrey Churbanov   int locked = 0;
3857cc577a4SJonathan Peyton   // Check if deque is full
3863041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
3873041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
388a23806e6SAndrey Churbanov     if (__kmp_enable_task_throttling &&
389a23806e6SAndrey Churbanov         __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
390c3344345SAndrey Churbanov                               thread->th.th_current_task)) {
3913041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_push_task: T#%d deque is full; returning "
3923041982dSJonathan Peyton                     "TASK_NOT_PUSHED for task %p\n",
3937cc577a4SJonathan Peyton                     gtid, taskdata));
3947cc577a4SJonathan Peyton       return TASK_NOT_PUSHED;
395c3344345SAndrey Churbanov     } else {
3967cc577a4SJonathan Peyton       __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
397c3344345SAndrey Churbanov       locked = 1;
3983895148dSJoachim Protze       if (TCR_4(thread_data->td.td_deque_ntasks) >=
3993895148dSJoachim Protze           TASK_DEQUE_SIZE(thread_data->td)) {
400c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
401c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
402c3344345SAndrey Churbanov       }
403c3344345SAndrey Churbanov     }
4043895148dSJoachim Protze   }
405c3344345SAndrey Churbanov   // Lock the deque for the task push operation
406c3344345SAndrey Churbanov   if (!locked) {
407c3344345SAndrey Churbanov     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
408c3344345SAndrey Churbanov     // Need to recheck as we can get a proxy task from thread outside of OpenMP
4093041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
4103041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
411a23806e6SAndrey Churbanov       if (__kmp_enable_task_throttling &&
412a23806e6SAndrey Churbanov           __kmp_task_is_allowed(gtid, __kmp_task_stealing_constraint, taskdata,
413c3344345SAndrey Churbanov                                 thread->th.th_current_task)) {
4147cc577a4SJonathan Peyton         __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
415c3344345SAndrey Churbanov         KA_TRACE(20, ("__kmp_push_task: T#%d deque is full on 2nd check; "
416c3344345SAndrey Churbanov                       "returning TASK_NOT_PUSHED for task %p\n",
4177cc577a4SJonathan Peyton                       gtid, taskdata));
4187cc577a4SJonathan Peyton         return TASK_NOT_PUSHED;
419c3344345SAndrey Churbanov       } else {
420c3344345SAndrey Churbanov         // expand deque to push the task which is not allowed to execute
421c3344345SAndrey Churbanov         __kmp_realloc_task_deque(thread, thread_data);
4227cc577a4SJonathan Peyton       }
423c3344345SAndrey Churbanov     }
424c3344345SAndrey Churbanov   }
4257cc577a4SJonathan Peyton   // Must have room since no thread can add tasks but calling thread
4263041982dSJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) <
4273041982dSJonathan Peyton                    TASK_DEQUE_SIZE(thread_data->td));
4287cc577a4SJonathan Peyton 
4293041982dSJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] =
4303041982dSJonathan Peyton       taskdata; // Push taskdata
4317cc577a4SJonathan Peyton   // Wrap index.
4323041982dSJonathan Peyton   thread_data->td.td_deque_tail =
4333041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
4343041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
4353041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1); // Adjust task count
436ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(thread->th.th_current_task); // releasing self
437ffd8f009SAndreyChurbanov   KMP_FSYNC_RELEASING(taskdata); // releasing child
4387cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_push_task: T#%d returning TASK_SUCCESSFULLY_PUSHED: "
4397cc577a4SJonathan Peyton                 "task=%p ntasks=%d head=%u tail=%u\n",
4407cc577a4SJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
4417cc577a4SJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
4427cc577a4SJonathan Peyton 
4437cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
4447cc577a4SJonathan Peyton 
4457cc577a4SJonathan Peyton   return TASK_SUCCESSFULLY_PUSHED;
4467cc577a4SJonathan Peyton }
4477cc577a4SJonathan Peyton 
4483041982dSJonathan Peyton // __kmp_pop_current_task_from_thread: set up current task from called thread
4493041982dSJonathan Peyton // when team ends
4503041982dSJonathan Peyton //
4517cc577a4SJonathan Peyton // this_thr: thread structure to set current_task in.
4523041982dSJonathan Peyton void __kmp_pop_current_task_from_thread(kmp_info_t *this_thr) {
4533041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(enter): T#%d "
4543041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
4557cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
4567cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
4577cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
4587cc577a4SJonathan Peyton 
4597cc577a4SJonathan Peyton   this_thr->th.th_current_task = this_thr->th.th_current_task->td_parent;
4607cc577a4SJonathan Peyton 
4613041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(exit): T#%d "
4623041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
4637cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
4647cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
4657cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
4667cc577a4SJonathan Peyton }
4677cc577a4SJonathan Peyton 
4683041982dSJonathan Peyton // __kmp_push_current_task_to_thread: set up current task in called thread for a
4693041982dSJonathan Peyton // new team
4703041982dSJonathan Peyton //
4717cc577a4SJonathan Peyton // this_thr: thread structure to set up
4727cc577a4SJonathan Peyton // team: team for implicit task data
4737cc577a4SJonathan Peyton // tid: thread within team to set up
4743041982dSJonathan Peyton void __kmp_push_current_task_to_thread(kmp_info_t *this_thr, kmp_team_t *team,
4753041982dSJonathan Peyton                                        int tid) {
4763041982dSJonathan Peyton   // current task of the thread is a parent of the new just created implicit
4773041982dSJonathan Peyton   // tasks of new team
4783041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(enter): T#%d this_thread=%p "
4793041982dSJonathan Peyton                 "curtask=%p "
4807cc577a4SJonathan Peyton                 "parent_task=%p\n",
4817cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
4827cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
4837cc577a4SJonathan Peyton 
4847cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr != NULL);
4857cc577a4SJonathan Peyton 
4867cc577a4SJonathan Peyton   if (tid == 0) {
4877cc577a4SJonathan Peyton     if (this_thr->th.th_current_task != &team->t.t_implicit_task_taskdata[0]) {
4883041982dSJonathan Peyton       team->t.t_implicit_task_taskdata[0].td_parent =
4893041982dSJonathan Peyton           this_thr->th.th_current_task;
4907cc577a4SJonathan Peyton       this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[0];
4917cc577a4SJonathan Peyton     }
4927cc577a4SJonathan Peyton   } else {
4933041982dSJonathan Peyton     team->t.t_implicit_task_taskdata[tid].td_parent =
4943041982dSJonathan Peyton         team->t.t_implicit_task_taskdata[0].td_parent;
4957cc577a4SJonathan Peyton     this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[tid];
4967cc577a4SJonathan Peyton   }
4977cc577a4SJonathan Peyton 
4983041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(exit): T#%d this_thread=%p "
4993041982dSJonathan Peyton                 "curtask=%p "
5007cc577a4SJonathan Peyton                 "parent_task=%p\n",
5017cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
5027cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
5037cc577a4SJonathan Peyton }
5047cc577a4SJonathan Peyton 
5057cc577a4SJonathan Peyton // __kmp_task_start: bookkeeping for a task starting execution
5063041982dSJonathan Peyton //
5077cc577a4SJonathan Peyton // GTID: global thread id of calling thread
5087cc577a4SJonathan Peyton // task: task starting execution
5097cc577a4SJonathan Peyton // current_task: task suspending
5103041982dSJonathan Peyton static void __kmp_task_start(kmp_int32 gtid, kmp_task_t *task,
5113041982dSJonathan Peyton                              kmp_taskdata_t *current_task) {
5127cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
5137cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
5147cc577a4SJonathan Peyton 
5153041982dSJonathan Peyton   KA_TRACE(10,
5163041982dSJonathan Peyton            ("__kmp_task_start(enter): T#%d starting task %p: current_task=%p\n",
5177cc577a4SJonathan Peyton             gtid, taskdata, current_task));
5187cc577a4SJonathan Peyton 
5197cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
5207cc577a4SJonathan Peyton 
5217cc577a4SJonathan Peyton   // mark currently executing task as suspended
5227cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
5237cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( current_task -> td_flags.executing == 1 );
5247cc577a4SJonathan Peyton   current_task->td_flags.executing = 0;
5257cc577a4SJonathan Peyton 
5267cc577a4SJonathan Peyton // Add task to stack if tied
5277cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
5283041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
5297cc577a4SJonathan Peyton     __kmp_push_task_stack(gtid, thread, taskdata);
5307cc577a4SJonathan Peyton   }
5317cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
5327cc577a4SJonathan Peyton 
5337cc577a4SJonathan Peyton   // mark starting task as executing and as current task
5347cc577a4SJonathan Peyton   thread->th.th_current_task = taskdata;
5357cc577a4SJonathan Peyton 
5363041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 0 ||
5373041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
5383041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0 ||
5393041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
5407cc577a4SJonathan Peyton   taskdata->td_flags.started = 1;
5417cc577a4SJonathan Peyton   taskdata->td_flags.executing = 1;
5427cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
5437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
5447cc577a4SJonathan Peyton 
5457cc577a4SJonathan Peyton   // GEH TODO: shouldn't we pass some sort of location identifier here?
5467cc577a4SJonathan Peyton   // APT: yes, we will pass location here.
5477cc577a4SJonathan Peyton   // need to store current thread state (in a thread or taskdata structure)
5487cc577a4SJonathan Peyton   // before setting work_state, otherwise wrong state is set after end of task
5497cc577a4SJonathan Peyton 
5503041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_start(exit): T#%d task=%p\n", gtid, taskdata));
5517cc577a4SJonathan Peyton 
5527cc577a4SJonathan Peyton   return;
5537cc577a4SJonathan Peyton }
5547cc577a4SJonathan Peyton 
55582e94a59SJoachim Protze #if OMPT_SUPPORT
55682e94a59SJoachim Protze //------------------------------------------------------------------------------
55782e94a59SJoachim Protze // __ompt_task_init:
55882e94a59SJoachim Protze //   Initialize OMPT fields maintained by a task. This will only be called after
55982e94a59SJoachim Protze //   ompt_start_tool, so we already know whether ompt is enabled or not.
56082e94a59SJoachim Protze 
56182e94a59SJoachim Protze static inline void __ompt_task_init(kmp_taskdata_t *task, int tid) {
56282e94a59SJoachim Protze   // The calls to __ompt_task_init already have the ompt_enabled condition.
56382e94a59SJoachim Protze   task->ompt_task_info.task_data.value = 0;
5640e0d6cddSJoachim Protze   task->ompt_task_info.frame.exit_frame = ompt_data_none;
5650e0d6cddSJoachim Protze   task->ompt_task_info.frame.enter_frame = ompt_data_none;
566309b00a4SShilei Tian   task->ompt_task_info.frame.exit_frame_flags =
567309b00a4SShilei Tian       ompt_frame_runtime | ompt_frame_framepointer;
568309b00a4SShilei Tian   task->ompt_task_info.frame.enter_frame_flags =
569309b00a4SShilei Tian       ompt_frame_runtime | ompt_frame_framepointer;
57082e94a59SJoachim Protze }
57182e94a59SJoachim Protze 
57282e94a59SJoachim Protze // __ompt_task_start:
57382e94a59SJoachim Protze //   Build and trigger task-begin event
57482e94a59SJoachim Protze static inline void __ompt_task_start(kmp_task_t *task,
57582e94a59SJoachim Protze                                      kmp_taskdata_t *current_task,
57682e94a59SJoachim Protze                                      kmp_int32 gtid) {
57782e94a59SJoachim Protze   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
578489cdb78SJoachim Protze   ompt_task_status_t status = ompt_task_switch;
57982e94a59SJoachim Protze   if (__kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded) {
58082e94a59SJoachim Protze     status = ompt_task_yield;
58182e94a59SJoachim Protze     __kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded = 0;
58282e94a59SJoachim Protze   }
58382e94a59SJoachim Protze   /* let OMPT know that we're about to run this task */
58482e94a59SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
58582e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
58682e94a59SJoachim Protze         &(current_task->ompt_task_info.task_data), status,
58782e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data));
58882e94a59SJoachim Protze   }
58982e94a59SJoachim Protze   taskdata->ompt_task_info.scheduling_parent = current_task;
59082e94a59SJoachim Protze }
59182e94a59SJoachim Protze 
59282e94a59SJoachim Protze // __ompt_task_finish:
59382e94a59SJoachim Protze //   Build and trigger final task-schedule event
59410995c77SJoachim Protze static inline void __ompt_task_finish(kmp_task_t *task,
59510995c77SJoachim Protze                                       kmp_taskdata_t *resumed_task,
59610995c77SJoachim Protze                                       ompt_task_status_t status) {
59710995c77SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
59882e94a59SJoachim Protze     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
59982e94a59SJoachim Protze     if (__kmp_omp_cancellation && taskdata->td_taskgroup &&
60082e94a59SJoachim Protze         taskdata->td_taskgroup->cancel_request == cancel_taskgroup) {
60182e94a59SJoachim Protze       status = ompt_task_cancel;
60282e94a59SJoachim Protze     }
60382e94a59SJoachim Protze 
60482e94a59SJoachim Protze     /* let OMPT know that we're returning to the callee task */
60582e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
60682e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data), status,
60710995c77SJoachim Protze         (resumed_task ? &(resumed_task->ompt_task_info.task_data) : NULL));
60882e94a59SJoachim Protze   }
60982e94a59SJoachim Protze }
61082e94a59SJoachim Protze #endif
61182e94a59SJoachim Protze 
61282e94a59SJoachim Protze template <bool ompt>
61382e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_template(ident_t *loc_ref, kmp_int32 gtid,
61482e94a59SJoachim Protze                                                kmp_task_t *task,
61582e94a59SJoachim Protze                                                void *frame_address,
61682e94a59SJoachim Protze                                                void *return_address) {
6177cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
6187cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
6197cc577a4SJonathan Peyton 
6203041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(enter): T#%d loc=%p task=%p "
6213041982dSJonathan Peyton                 "current_task=%p\n",
6227cc577a4SJonathan Peyton                 gtid, loc_ref, taskdata, current_task));
6237cc577a4SJonathan Peyton 
624838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
6253041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
6263041982dSJonathan Peyton     // freed prematurely
62737e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
628baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
6293041982dSJonathan Peyton     KA_TRACE(20, ("__kmpc_omp_task_begin_if0: T#%d untied_count (%d) "
6303041982dSJonathan Peyton                   "incremented for task %p\n",
6317cc577a4SJonathan Peyton                   gtid, counter, taskdata));
6327cc577a4SJonathan Peyton   }
6337cc577a4SJonathan Peyton 
6343041982dSJonathan Peyton   taskdata->td_flags.task_serial =
6353041982dSJonathan Peyton       1; // Execute this task immediately, not deferred.
6367cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
6377cc577a4SJonathan Peyton 
63882e94a59SJoachim Protze #if OMPT_SUPPORT
63982e94a59SJoachim Protze   if (ompt) {
6400e0d6cddSJoachim Protze     if (current_task->ompt_task_info.frame.enter_frame.ptr == NULL) {
6410e0d6cddSJoachim Protze       current_task->ompt_task_info.frame.enter_frame.ptr =
6420e0d6cddSJoachim Protze           taskdata->ompt_task_info.frame.exit_frame.ptr = frame_address;
6430e0d6cddSJoachim Protze       current_task->ompt_task_info.frame.enter_frame_flags =
644309b00a4SShilei Tian           taskdata->ompt_task_info.frame.exit_frame_flags =
645309b00a4SShilei Tian               ompt_frame_application | ompt_frame_framepointer;
64682e94a59SJoachim Protze     }
64782e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
64882e94a59SJoachim Protze       ompt_task_info_t *parent_info = &(current_task->ompt_task_info);
64982e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
65082e94a59SJoachim Protze           &(parent_info->task_data), &(parent_info->frame),
65182e94a59SJoachim Protze           &(taskdata->ompt_task_info.task_data),
65282e94a59SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(taskdata), 0,
65382e94a59SJoachim Protze           return_address);
65482e94a59SJoachim Protze     }
65582e94a59SJoachim Protze     __ompt_task_start(task, current_task, gtid);
65682e94a59SJoachim Protze   }
65782e94a59SJoachim Protze #endif // OMPT_SUPPORT
65882e94a59SJoachim Protze 
6593041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(exit): T#%d loc=%p task=%p,\n", gtid,
6603041982dSJonathan Peyton                 loc_ref, taskdata));
66182e94a59SJoachim Protze }
6627cc577a4SJonathan Peyton 
66382e94a59SJoachim Protze #if OMPT_SUPPORT
66482e94a59SJoachim Protze OMPT_NOINLINE
66582e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
66682e94a59SJoachim Protze                                            kmp_task_t *task,
66782e94a59SJoachim Protze                                            void *frame_address,
66882e94a59SJoachim Protze                                            void *return_address) {
669f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<true>(loc_ref, gtid, task, frame_address,
670f0a1c65fSJonas Hahnfeld                                            return_address);
67182e94a59SJoachim Protze }
67282e94a59SJoachim Protze #endif // OMPT_SUPPORT
67382e94a59SJoachim Protze 
67482e94a59SJoachim Protze // __kmpc_omp_task_begin_if0: report that a given serialized task has started
67582e94a59SJoachim Protze // execution
67682e94a59SJoachim Protze //
67782e94a59SJoachim Protze // loc_ref: source location information; points to beginning of task block.
67882e94a59SJoachim Protze // gtid: global thread number.
67982e94a59SJoachim Protze // task: task thunk for the started task.
68082e94a59SJoachim Protze void __kmpc_omp_task_begin_if0(ident_t *loc_ref, kmp_int32 gtid,
68182e94a59SJoachim Protze                                kmp_task_t *task) {
68282e94a59SJoachim Protze #if OMPT_SUPPORT
68382e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
68482e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
68582e94a59SJoachim Protze     __kmpc_omp_task_begin_if0_ompt(loc_ref, gtid, task,
68682e94a59SJoachim Protze                                    OMPT_GET_FRAME_ADDRESS(1),
68782e94a59SJoachim Protze                                    OMPT_LOAD_RETURN_ADDRESS(gtid));
6887cc577a4SJonathan Peyton     return;
6897cc577a4SJonathan Peyton   }
69082e94a59SJoachim Protze #endif
691f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<false>(loc_ref, gtid, task, NULL, NULL);
69282e94a59SJoachim Protze }
6937cc577a4SJonathan Peyton 
6947cc577a4SJonathan Peyton #ifdef TASK_UNUSED
6957cc577a4SJonathan Peyton // __kmpc_omp_task_begin: report that a given task has started execution
6967cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
6973041982dSJonathan Peyton void __kmpc_omp_task_begin(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task) {
6987cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
6997cc577a4SJonathan Peyton 
7003041982dSJonathan Peyton   KA_TRACE(
7013041982dSJonathan Peyton       10,
7023041982dSJonathan Peyton       ("__kmpc_omp_task_begin(enter): T#%d loc=%p task=%p current_task=%p\n",
7037cc577a4SJonathan Peyton        gtid, loc_ref, KMP_TASK_TO_TASKDATA(task), current_task));
7047cc577a4SJonathan Peyton 
7057cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
7067cc577a4SJonathan Peyton 
7073041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin(exit): T#%d loc=%p task=%p,\n", gtid,
7083041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
7097cc577a4SJonathan Peyton   return;
7107cc577a4SJonathan Peyton }
7117cc577a4SJonathan Peyton #endif // TASK_UNUSED
7127cc577a4SJonathan Peyton 
7137cc577a4SJonathan Peyton // __kmp_free_task: free the current task space and the space for shareds
7143041982dSJonathan Peyton //
7157cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
7167cc577a4SJonathan Peyton // taskdata: task to free
7177cc577a4SJonathan Peyton // thread: thread data structure of caller
7183041982dSJonathan Peyton static void __kmp_free_task(kmp_int32 gtid, kmp_taskdata_t *taskdata,
7193041982dSJonathan Peyton                             kmp_info_t *thread) {
7203041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_free_task: T#%d freeing data from task %p\n", gtid,
7213041982dSJonathan Peyton                 taskdata));
7227cc577a4SJonathan Peyton 
7237cc577a4SJonathan Peyton   // Check to make sure all flags and counters have the correct values
7247cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7257cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0);
7267cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 1);
7277cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
72837e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_allocated_child_tasks == 0 ||
7293041982dSJonathan Peyton                    taskdata->td_flags.task_serial == 1);
73037e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_incomplete_child_tasks == 0);
7317cc577a4SJonathan Peyton 
7327cc577a4SJonathan Peyton   taskdata->td_flags.freed = 1;
7337cc577a4SJonathan Peyton // deallocate the taskdata and shared variable blocks associated with this task
7347cc577a4SJonathan Peyton #if USE_FAST_MEMORY
7357cc577a4SJonathan Peyton   __kmp_fast_free(thread, taskdata);
7367cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
7377cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskdata);
7387cc577a4SJonathan Peyton #endif
7393041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_free_task: T#%d freed task %p\n", gtid, taskdata));
7407cc577a4SJonathan Peyton }
7417cc577a4SJonathan Peyton 
7423041982dSJonathan Peyton // __kmp_free_task_and_ancestors: free the current task and ancestors without
7433041982dSJonathan Peyton // children
7447cc577a4SJonathan Peyton //
7457cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
7467cc577a4SJonathan Peyton // taskdata: task to free
7477cc577a4SJonathan Peyton // thread: thread data structure of caller
7483041982dSJonathan Peyton static void __kmp_free_task_and_ancestors(kmp_int32 gtid,
7493041982dSJonathan Peyton                                           kmp_taskdata_t *taskdata,
7503041982dSJonathan Peyton                                           kmp_info_t *thread) {
7517cc577a4SJonathan Peyton   // Proxy tasks must always be allowed to free their parents
7527cc577a4SJonathan Peyton   // because they can be run in background even in serial mode.
7533041982dSJonathan Peyton   kmp_int32 team_serial =
7543041982dSJonathan Peyton       (taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) &&
7553041982dSJonathan Peyton       !taskdata->td_flags.proxy;
7567cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7577cc577a4SJonathan Peyton 
75837e2ef54SJonathan Peyton   kmp_int32 children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
7597cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
7607cc577a4SJonathan Peyton 
7617cc577a4SJonathan Peyton   // Now, go up the ancestor tree to see if any ancestors can now be freed.
7623041982dSJonathan Peyton   while (children == 0) {
7637cc577a4SJonathan Peyton     kmp_taskdata_t *parent_taskdata = taskdata->td_parent;
7647cc577a4SJonathan Peyton 
7657cc577a4SJonathan Peyton     KA_TRACE(20, ("__kmp_free_task_and_ancestors(enter): T#%d task %p complete "
7663041982dSJonathan Peyton                   "and freeing itself\n",
7673041982dSJonathan Peyton                   gtid, taskdata));
7687cc577a4SJonathan Peyton 
7697cc577a4SJonathan Peyton     // --- Deallocate my ancestor task ---
7707cc577a4SJonathan Peyton     __kmp_free_task(gtid, taskdata, thread);
7717cc577a4SJonathan Peyton 
7727cc577a4SJonathan Peyton     taskdata = parent_taskdata;
7737cc577a4SJonathan Peyton 
774c3344345SAndrey Churbanov     if (team_serial)
775c3344345SAndrey Churbanov       return;
7763041982dSJonathan Peyton     // Stop checking ancestors at implicit task instead of walking up ancestor
7773041982dSJonathan Peyton     // tree to avoid premature deallocation of ancestors.
778c3344345SAndrey Churbanov     if (taskdata->td_flags.tasktype == TASK_IMPLICIT) {
779c3344345SAndrey Churbanov       if (taskdata->td_dephash) { // do we need to cleanup dephash?
780c3344345SAndrey Churbanov         int children = KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks);
781c3344345SAndrey Churbanov         kmp_tasking_flags_t flags_old = taskdata->td_flags;
782c3344345SAndrey Churbanov         if (children == 0 && flags_old.complete == 1) {
783c3344345SAndrey Churbanov           kmp_tasking_flags_t flags_new = flags_old;
784c3344345SAndrey Churbanov           flags_new.complete = 0;
785c3344345SAndrey Churbanov           if (KMP_COMPARE_AND_STORE_ACQ32(
786c3344345SAndrey Churbanov                   RCAST(kmp_int32 *, &taskdata->td_flags),
787c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_old),
788c3344345SAndrey Churbanov                   *RCAST(kmp_int32 *, &flags_new))) {
789c3344345SAndrey Churbanov             KA_TRACE(100, ("__kmp_free_task_and_ancestors: T#%d cleans "
790c3344345SAndrey Churbanov                            "dephash of implicit task %p\n",
791c3344345SAndrey Churbanov                            gtid, taskdata));
792c3344345SAndrey Churbanov             // cleanup dephash of finished implicit task
793c3344345SAndrey Churbanov             __kmp_dephash_free_entries(thread, taskdata->td_dephash);
794c3344345SAndrey Churbanov           }
795c3344345SAndrey Churbanov         }
796c3344345SAndrey Churbanov       }
7977cc577a4SJonathan Peyton       return;
798c3344345SAndrey Churbanov     }
7997cc577a4SJonathan Peyton     // Predecrement simulated by "- 1" calculation
80037e2ef54SJonathan Peyton     children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
8017cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(children >= 0);
8027cc577a4SJonathan Peyton   }
8037cc577a4SJonathan Peyton 
8043041982dSJonathan Peyton   KA_TRACE(
8053041982dSJonathan Peyton       20, ("__kmp_free_task_and_ancestors(exit): T#%d task %p has %d children; "
8063041982dSJonathan Peyton            "not freeing it yet\n",
8073041982dSJonathan Peyton            gtid, taskdata, children));
8087cc577a4SJonathan Peyton }
8097cc577a4SJonathan Peyton 
8107cc577a4SJonathan Peyton // __kmp_task_finish: bookkeeping to do when a task finishes execution
8113041982dSJonathan Peyton //
8127cc577a4SJonathan Peyton // gtid: global thread ID for calling thread
8137cc577a4SJonathan Peyton // task: task to be finished
8147cc577a4SJonathan Peyton // resumed_task: task to be resumed.  (may be NULL if task is serialized)
81510995c77SJoachim Protze //
81610995c77SJoachim Protze // template<ompt>: effectively ompt_enabled.enabled!=0
81710995c77SJoachim Protze // the version with ompt=false is inlined, allowing to optimize away all ompt
81810995c77SJoachim Protze // code in this case
81986ed6aa6SJoachim Protze template <bool ompt>
8203041982dSJonathan Peyton static void __kmp_task_finish(kmp_int32 gtid, kmp_task_t *task,
8213041982dSJonathan Peyton                               kmp_taskdata_t *resumed_task) {
8227cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
8237cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
8243041982dSJonathan Peyton   kmp_task_team_t *task_team =
8253041982dSJonathan Peyton       thread->th.th_task_team; // might be NULL for serial teams...
8268b81524cSAndreyChurbanov #if KMP_DEBUG
8277cc577a4SJonathan Peyton   kmp_int32 children = 0;
8288b81524cSAndreyChurbanov #endif
8293041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_finish(enter): T#%d finishing task %p and resuming "
8303041982dSJonathan Peyton                 "task %p\n",
8317cc577a4SJonathan Peyton                 gtid, taskdata, resumed_task));
8327cc577a4SJonathan Peyton 
8337cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
8347cc577a4SJonathan Peyton 
8357cc577a4SJonathan Peyton // Pop task from stack if tied
8367cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
8373041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
8387cc577a4SJonathan Peyton     __kmp_pop_task_stack(gtid, thread, taskdata);
8397cc577a4SJonathan Peyton   }
8407cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
8417cc577a4SJonathan Peyton 
8426bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
8433041982dSJonathan Peyton     // untied task needs to check the counter so that the task structure is not
8443041982dSJonathan Peyton     // freed prematurely
84537e2ef54SJonathan Peyton     kmp_int32 counter = KMP_ATOMIC_DEC(&taskdata->td_untied_count) - 1;
8463041982dSJonathan Peyton     KA_TRACE(
8473041982dSJonathan Peyton         20,
8483041982dSJonathan Peyton         ("__kmp_task_finish: T#%d untied_count (%d) decremented for task %p\n",
8497cc577a4SJonathan Peyton          gtid, counter, taskdata));
8507cc577a4SJonathan Peyton     if (counter > 0) {
8513041982dSJonathan Peyton       // untied task is not done, to be continued possibly by other thread, do
8523041982dSJonathan Peyton       // not free it now
8537cc577a4SJonathan Peyton       if (resumed_task == NULL) {
8547cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(taskdata->td_flags.task_serial);
8553041982dSJonathan Peyton         resumed_task = taskdata->td_parent; // In a serialized task, the resumed
8563041982dSJonathan Peyton         // task is the parent
8577cc577a4SJonathan Peyton       }
8587cc577a4SJonathan Peyton       thread->th.th_current_task = resumed_task; // restore current_task
8597cc577a4SJonathan Peyton       resumed_task->td_flags.executing = 1; // resume previous task
8603041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_task_finish(exit): T#%d partially done task %p, "
8613041982dSJonathan Peyton                     "resuming task %p\n",
8627cc577a4SJonathan Peyton                     gtid, taskdata, resumed_task));
8637cc577a4SJonathan Peyton       return;
8647cc577a4SJonathan Peyton     }
8657cc577a4SJonathan Peyton   }
8667cc577a4SJonathan Peyton 
867d23131a3SJoachim Protze   // bookkeeping for resuming task:
868d23131a3SJoachim Protze   // GEH - note tasking_ser => task_serial
869d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(
870d23131a3SJoachim Protze       (taskdata->td_flags.tasking_ser || taskdata->td_flags.task_serial) ==
871d23131a3SJoachim Protze       taskdata->td_flags.task_serial);
872d23131a3SJoachim Protze   if (taskdata->td_flags.task_serial) {
873d23131a3SJoachim Protze     if (resumed_task == NULL) {
874d23131a3SJoachim Protze       resumed_task = taskdata->td_parent; // In a serialized task, the resumed
875d23131a3SJoachim Protze       // task is the parent
876d23131a3SJoachim Protze     }
877d23131a3SJoachim Protze   } else {
878d23131a3SJoachim Protze     KMP_DEBUG_ASSERT(resumed_task !=
879d23131a3SJoachim Protze                      NULL); // verify that resumed task is passed as argument
880d23131a3SJoachim Protze   }
881d23131a3SJoachim Protze 
882d23131a3SJoachim Protze   /* If the tasks' destructor thunk flag has been set, we need to invoke the
883d23131a3SJoachim Protze      destructor thunk that has been generated by the compiler. The code is
884d23131a3SJoachim Protze      placed here, since at this point other tasks might have been released
885d23131a3SJoachim Protze      hence overlapping the destructor invocations with some other work in the
886d23131a3SJoachim Protze      released tasks.  The OpenMP spec is not specific on when the destructors
887d23131a3SJoachim Protze      are invoked, so we should be free to choose. */
888838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.destructors_thunk)) {
889d23131a3SJoachim Protze     kmp_routine_entry_t destr_thunk = task->data1.destructors;
890d23131a3SJoachim Protze     KMP_ASSERT(destr_thunk);
891d23131a3SJoachim Protze     destr_thunk(gtid, task);
892d23131a3SJoachim Protze   }
893d23131a3SJoachim Protze 
8947cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
895d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 1);
896d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
897d23131a3SJoachim Protze 
898405037c4SAndrey Churbanov   bool detach = false;
899838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.detachable == TASK_DETACHABLE)) {
900405037c4SAndrey Churbanov     if (taskdata->td_allow_completion_event.type ==
901405037c4SAndrey Churbanov         KMP_EVENT_ALLOW_COMPLETION) {
902405037c4SAndrey Churbanov       // event hasn't been fulfilled yet. Try to detach task.
903405037c4SAndrey Churbanov       __kmp_acquire_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
904405037c4SAndrey Churbanov       if (taskdata->td_allow_completion_event.type ==
905405037c4SAndrey Churbanov           KMP_EVENT_ALLOW_COMPLETION) {
906d23131a3SJoachim Protze         // task finished execution
907d23131a3SJoachim Protze         KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
908d23131a3SJoachim Protze         taskdata->td_flags.executing = 0; // suspend the finishing task
90910995c77SJoachim Protze 
91010995c77SJoachim Protze #if OMPT_SUPPORT
91110995c77SJoachim Protze         // For a detached task, which is not completed, we switch back
91210995c77SJoachim Protze         // the omp_fulfill_event signals completion
91310995c77SJoachim Protze         // locking is necessary to avoid a race with ompt_task_late_fulfill
91410995c77SJoachim Protze         if (ompt)
91510995c77SJoachim Protze           __ompt_task_finish(task, resumed_task, ompt_task_detach);
91610995c77SJoachim Protze #endif
91710995c77SJoachim Protze 
918d23131a3SJoachim Protze         // no access to taskdata after this point!
919d23131a3SJoachim Protze         // __kmp_fulfill_event might free taskdata at any time from now
92010995c77SJoachim Protze 
921405037c4SAndrey Churbanov         taskdata->td_flags.proxy = TASK_PROXY; // proxify!
922405037c4SAndrey Churbanov         detach = true;
923405037c4SAndrey Churbanov       }
924405037c4SAndrey Churbanov       __kmp_release_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
925405037c4SAndrey Churbanov     }
926405037c4SAndrey Churbanov   }
9277cc577a4SJonathan Peyton 
928405037c4SAndrey Churbanov   if (!detach) {
929405037c4SAndrey Churbanov     taskdata->td_flags.complete = 1; // mark the task as completed
930405037c4SAndrey Churbanov 
93110995c77SJoachim Protze #if OMPT_SUPPORT
93210995c77SJoachim Protze     // This is not a detached task, we are done here
93310995c77SJoachim Protze     if (ompt)
93410995c77SJoachim Protze       __ompt_task_finish(task, resumed_task, ompt_task_complete);
93510995c77SJoachim Protze #endif
93610995c77SJoachim Protze 
9373041982dSJonathan Peyton     // Only need to keep track of count if team parallel and tasking not
93857d8b8d6SAndreyChurbanov     // serialized, or task is detachable and event has already been fulfilled
93957d8b8d6SAndreyChurbanov     if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) ||
9409d64275aSShilei Tian         taskdata->td_flags.detachable == TASK_DETACHABLE ||
9419d64275aSShilei Tian         taskdata->td_flags.hidden_helper) {
942c2c43132SShilei Tian       __kmp_release_deps(gtid, taskdata);
9437cc577a4SJonathan Peyton       // Predecrement simulated by "- 1" calculation
9448b81524cSAndreyChurbanov #if KMP_DEBUG
9458b81524cSAndreyChurbanov       children = -1 +
9468b81524cSAndreyChurbanov #endif
9478b81524cSAndreyChurbanov           KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks);
9487cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(children >= 0);
9497cc577a4SJonathan Peyton       if (taskdata->td_taskgroup)
95037e2ef54SJonathan Peyton         KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
951c2c43132SShilei Tian     } else if (task_team && (task_team->tt.tt_found_proxy_tasks ||
952c2c43132SShilei Tian                              task_team->tt.tt_hidden_helper_task_encountered)) {
953c2c43132SShilei Tian       // if we found proxy or hidden helper tasks there could exist a dependency
954c2c43132SShilei Tian       // chain with the proxy task as origin
9557cc577a4SJonathan Peyton       __kmp_release_deps(gtid, taskdata);
9567cc577a4SJonathan Peyton     }
9573041982dSJonathan Peyton     // td_flags.executing must be marked as 0 after __kmp_release_deps has been
958d23131a3SJoachim Protze     // called. Othertwise, if a task is executed immediately from the
959d23131a3SJoachim Protze     // release_deps code, the flag will be reset to 1 again by this same
960d23131a3SJoachim Protze     // function
9617cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
9627cc577a4SJonathan Peyton     taskdata->td_flags.executing = 0; // suspend the finishing task
963d23131a3SJoachim Protze   }
964d23131a3SJoachim Protze 
9653041982dSJonathan Peyton   KA_TRACE(
9663041982dSJonathan Peyton       20, ("__kmp_task_finish: T#%d finished task %p, %d incomplete children\n",
9677cc577a4SJonathan Peyton            gtid, taskdata, children));
9687cc577a4SJonathan Peyton 
9697cc577a4SJonathan Peyton   // Free this task and then ancestor tasks if they have no children.
9707cc577a4SJonathan Peyton   // Restore th_current_task first as suggested by John:
9717cc577a4SJonathan Peyton   // johnmc: if an asynchronous inquiry peers into the runtime system
9727cc577a4SJonathan Peyton   // it doesn't see the freed task as the current task.
9737cc577a4SJonathan Peyton   thread->th.th_current_task = resumed_task;
974405037c4SAndrey Churbanov   if (!detach)
9757cc577a4SJonathan Peyton     __kmp_free_task_and_ancestors(gtid, taskdata, thread);
9767cc577a4SJonathan Peyton 
9777cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
9787cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( resumed_task->td_flags.executing == 0 );
9797cc577a4SJonathan Peyton   resumed_task->td_flags.executing = 1; // resume previous task
9807cc577a4SJonathan Peyton 
9813041982dSJonathan Peyton   KA_TRACE(
9823041982dSJonathan Peyton       10, ("__kmp_task_finish(exit): T#%d finished task %p, resuming task %p\n",
9837cc577a4SJonathan Peyton            gtid, taskdata, resumed_task));
9847cc577a4SJonathan Peyton 
9857cc577a4SJonathan Peyton   return;
9867cc577a4SJonathan Peyton }
9877cc577a4SJonathan Peyton 
98882e94a59SJoachim Protze template <bool ompt>
98982e94a59SJoachim Protze static void __kmpc_omp_task_complete_if0_template(ident_t *loc_ref,
99082e94a59SJoachim Protze                                                   kmp_int32 gtid,
9913041982dSJonathan Peyton                                                   kmp_task_t *task) {
9927cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(enter): T#%d loc=%p task=%p\n",
9937cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
994838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
9953041982dSJonathan Peyton   // this routine will provide task to resume
99686ed6aa6SJoachim Protze   __kmp_task_finish<ompt>(gtid, task, NULL);
9977cc577a4SJonathan Peyton 
9987cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(exit): T#%d loc=%p task=%p\n",
9997cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
100082e94a59SJoachim Protze 
100182e94a59SJoachim Protze #if OMPT_SUPPORT
100282e94a59SJoachim Protze   if (ompt) {
10030e0d6cddSJoachim Protze     ompt_frame_t *ompt_frame;
100482e94a59SJoachim Protze     __ompt_get_task_info_internal(0, NULL, NULL, &ompt_frame, NULL, NULL);
10050e0d6cddSJoachim Protze     ompt_frame->enter_frame = ompt_data_none;
1006309b00a4SShilei Tian     ompt_frame->enter_frame_flags =
1007309b00a4SShilei Tian         ompt_frame_runtime | ompt_frame_framepointer;
100882e94a59SJoachim Protze   }
100982e94a59SJoachim Protze #endif
101082e94a59SJoachim Protze 
10117cc577a4SJonathan Peyton   return;
10127cc577a4SJonathan Peyton }
10137cc577a4SJonathan Peyton 
101482e94a59SJoachim Protze #if OMPT_SUPPORT
101582e94a59SJoachim Protze OMPT_NOINLINE
101682e94a59SJoachim Protze void __kmpc_omp_task_complete_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
101782e94a59SJoachim Protze                                        kmp_task_t *task) {
101882e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<true>(loc_ref, gtid, task);
101982e94a59SJoachim Protze }
102082e94a59SJoachim Protze #endif // OMPT_SUPPORT
102182e94a59SJoachim Protze 
102282e94a59SJoachim Protze // __kmpc_omp_task_complete_if0: report that a task has completed execution
102382e94a59SJoachim Protze //
102482e94a59SJoachim Protze // loc_ref: source location information; points to end of task block.
102582e94a59SJoachim Protze // gtid: global thread number.
102682e94a59SJoachim Protze // task: task thunk for the completed task.
102782e94a59SJoachim Protze void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
102882e94a59SJoachim Protze                                   kmp_task_t *task) {
102982e94a59SJoachim Protze #if OMPT_SUPPORT
103082e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
103182e94a59SJoachim Protze     __kmpc_omp_task_complete_if0_ompt(loc_ref, gtid, task);
103282e94a59SJoachim Protze     return;
103382e94a59SJoachim Protze   }
103482e94a59SJoachim Protze #endif
103582e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<false>(loc_ref, gtid, task);
103682e94a59SJoachim Protze }
103782e94a59SJoachim Protze 
10387cc577a4SJonathan Peyton #ifdef TASK_UNUSED
10397cc577a4SJonathan Peyton // __kmpc_omp_task_complete: report that a task has completed execution
10407cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
10413041982dSJonathan Peyton void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
10423041982dSJonathan Peyton                               kmp_task_t *task) {
10433041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(enter): T#%d loc=%p task=%p\n", gtid,
10443041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10457cc577a4SJonathan Peyton 
104686ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task,
104786ed6aa6SJoachim Protze                            NULL); // Not sure how to find task to resume
10487cc577a4SJonathan Peyton 
10493041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(exit): T#%d loc=%p task=%p\n", gtid,
10503041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10517cc577a4SJonathan Peyton   return;
10527cc577a4SJonathan Peyton }
10537cc577a4SJonathan Peyton #endif // TASK_UNUSED
10547cc577a4SJonathan Peyton 
10553041982dSJonathan Peyton // __kmp_init_implicit_task: Initialize the appropriate fields in the implicit
10563041982dSJonathan Peyton // task for a given thread
10577cc577a4SJonathan Peyton //
10587cc577a4SJonathan Peyton // loc_ref:  reference to source location of parallel region
10597cc577a4SJonathan Peyton // this_thr:  thread data structure corresponding to implicit task
10607cc577a4SJonathan Peyton // team: team for this_thr
10617cc577a4SJonathan Peyton // tid: thread id of given thread within team
10627cc577a4SJonathan Peyton // set_curr_task: TRUE if need to push current task to thread
10633041982dSJonathan Peyton // NOTE: Routine does not set up the implicit task ICVS.  This is assumed to
10643041982dSJonathan Peyton // have already been done elsewhere.
10657cc577a4SJonathan Peyton // TODO: Get better loc_ref.  Value passed in may be NULL
10663041982dSJonathan Peyton void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
10673041982dSJonathan Peyton                               kmp_team_t *team, int tid, int set_curr_task) {
10687cc577a4SJonathan Peyton   kmp_taskdata_t *task = &team->t.t_implicit_task_taskdata[tid];
10697cc577a4SJonathan Peyton 
10703041982dSJonathan Peyton   KF_TRACE(
10713041982dSJonathan Peyton       10,
10723041982dSJonathan Peyton       ("__kmp_init_implicit_task(enter): T#:%d team=%p task=%p, reinit=%s\n",
10737cc577a4SJonathan Peyton        tid, team, task, set_curr_task ? "TRUE" : "FALSE"));
10747cc577a4SJonathan Peyton 
10757cc577a4SJonathan Peyton   task->td_task_id = KMP_GEN_TASK_ID();
10767cc577a4SJonathan Peyton   task->td_team = team;
10773041982dSJonathan Peyton   //    task->td_parent   = NULL;  // fix for CQ230101 (broken parent task info
10783041982dSJonathan Peyton   //    in debugger)
10797cc577a4SJonathan Peyton   task->td_ident = loc_ref;
10807cc577a4SJonathan Peyton   task->td_taskwait_ident = NULL;
10817cc577a4SJonathan Peyton   task->td_taskwait_counter = 0;
10827cc577a4SJonathan Peyton   task->td_taskwait_thread = 0;
10837cc577a4SJonathan Peyton 
10847cc577a4SJonathan Peyton   task->td_flags.tiedness = TASK_TIED;
10857cc577a4SJonathan Peyton   task->td_flags.tasktype = TASK_IMPLICIT;
10867cc577a4SJonathan Peyton   task->td_flags.proxy = TASK_FULL;
10877cc577a4SJonathan Peyton 
10887cc577a4SJonathan Peyton   // All implicit tasks are executed immediately, not deferred
10897cc577a4SJonathan Peyton   task->td_flags.task_serial = 1;
10907cc577a4SJonathan Peyton   task->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
10917cc577a4SJonathan Peyton   task->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
10927cc577a4SJonathan Peyton 
10937cc577a4SJonathan Peyton   task->td_flags.started = 1;
10947cc577a4SJonathan Peyton   task->td_flags.executing = 1;
10957cc577a4SJonathan Peyton   task->td_flags.complete = 0;
10967cc577a4SJonathan Peyton   task->td_flags.freed = 0;
10977cc577a4SJonathan Peyton 
10987cc577a4SJonathan Peyton   task->td_depnode = NULL;
1099a756cb24SAndrey Churbanov   task->td_last_tied = task;
1100405037c4SAndrey Churbanov   task->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
11017cc577a4SJonathan Peyton 
11023041982dSJonathan Peyton   if (set_curr_task) { // only do this init first time thread is created
110337e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_incomplete_child_tasks, 0);
1104642688b6SJonathan Peyton     // Not used: don't need to deallocate implicit task
110537e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_allocated_child_tasks, 0);
11067cc577a4SJonathan Peyton     task->td_taskgroup = NULL; // An implicit task does not have taskgroup
11077cc577a4SJonathan Peyton     task->td_dephash = NULL;
11087cc577a4SJonathan Peyton     __kmp_push_current_task_to_thread(this_thr, team, tid);
11097cc577a4SJonathan Peyton   } else {
11107cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_incomplete_child_tasks == 0);
11117cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_allocated_child_tasks == 0);
11127cc577a4SJonathan Peyton   }
11137cc577a4SJonathan Peyton 
11147cc577a4SJonathan Peyton #if OMPT_SUPPORT
1115f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
111682e94a59SJoachim Protze     __ompt_task_init(task, tid);
11177cc577a4SJonathan Peyton #endif
11187cc577a4SJonathan Peyton 
11193041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_init_implicit_task(exit): T#:%d team=%p task=%p\n", tid,
11203041982dSJonathan Peyton                 team, task));
11217cc577a4SJonathan Peyton }
11227cc577a4SJonathan Peyton 
11233041982dSJonathan Peyton // __kmp_finish_implicit_task: Release resources associated to implicit tasks
11243041982dSJonathan Peyton // at the end of parallel regions. Some resources are kept for reuse in the next
11253041982dSJonathan Peyton // parallel region.
11267cc577a4SJonathan Peyton //
11273041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11283041982dSJonathan Peyton void __kmp_finish_implicit_task(kmp_info_t *thread) {
11297cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1130c3344345SAndrey Churbanov   if (task->td_dephash) {
1131c3344345SAndrey Churbanov     int children;
1132c3344345SAndrey Churbanov     task->td_flags.complete = 1;
1133c3344345SAndrey Churbanov     children = KMP_ATOMIC_LD_ACQ(&task->td_incomplete_child_tasks);
1134c3344345SAndrey Churbanov     kmp_tasking_flags_t flags_old = task->td_flags;
1135c3344345SAndrey Churbanov     if (children == 0 && flags_old.complete == 1) {
1136c3344345SAndrey Churbanov       kmp_tasking_flags_t flags_new = flags_old;
1137c3344345SAndrey Churbanov       flags_new.complete = 0;
1138c3344345SAndrey Churbanov       if (KMP_COMPARE_AND_STORE_ACQ32(RCAST(kmp_int32 *, &task->td_flags),
1139c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_old),
1140c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_new))) {
1141c3344345SAndrey Churbanov         KA_TRACE(100, ("__kmp_finish_implicit_task: T#%d cleans "
1142c3344345SAndrey Churbanov                        "dephash of implicit task %p\n",
1143c3344345SAndrey Churbanov                        thread->th.th_info.ds.ds_gtid, task));
11447cc577a4SJonathan Peyton         __kmp_dephash_free_entries(thread, task->td_dephash);
11457cc577a4SJonathan Peyton       }
1146c3344345SAndrey Churbanov     }
1147c3344345SAndrey Churbanov   }
1148c3344345SAndrey Churbanov }
11497cc577a4SJonathan Peyton 
11503041982dSJonathan Peyton // __kmp_free_implicit_task: Release resources associated to implicit tasks
11513041982dSJonathan Peyton // when these are destroyed regions
11527cc577a4SJonathan Peyton //
11533041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11543041982dSJonathan Peyton void __kmp_free_implicit_task(kmp_info_t *thread) {
11557cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1156bff8ded9SJonathan Peyton   if (task && task->td_dephash) {
11577cc577a4SJonathan Peyton     __kmp_dephash_free(thread, task->td_dephash);
11587cc577a4SJonathan Peyton     task->td_dephash = NULL;
11597cc577a4SJonathan Peyton   }
1160bff8ded9SJonathan Peyton }
11617cc577a4SJonathan Peyton 
11623041982dSJonathan Peyton // Round up a size to a power of two specified by val: Used to insert padding
11633041982dSJonathan Peyton // between structures co-allocated using a single malloc() call
11643041982dSJonathan Peyton static size_t __kmp_round_up_to_val(size_t size, size_t val) {
11657cc577a4SJonathan Peyton   if (size & (val - 1)) {
11667cc577a4SJonathan Peyton     size &= ~(val - 1);
11677cc577a4SJonathan Peyton     if (size <= KMP_SIZE_T_MAX - val) {
11687cc577a4SJonathan Peyton       size += val; // Round up if there is no overflow.
1169bd3a7633SJonathan Peyton     }
1170bd3a7633SJonathan Peyton   }
11717cc577a4SJonathan Peyton   return size;
11727cc577a4SJonathan Peyton } // __kmp_round_up_to_va
11737cc577a4SJonathan Peyton 
11747cc577a4SJonathan Peyton // __kmp_task_alloc: Allocate the taskdata and task data structures for a task
11757cc577a4SJonathan Peyton //
11767cc577a4SJonathan Peyton // loc_ref: source location information
11777cc577a4SJonathan Peyton // gtid: global thread number.
11783041982dSJonathan Peyton // flags: include tiedness & task type (explicit vs. implicit) of the ''new''
11793041982dSJonathan Peyton // task encountered. Converted from kmp_int32 to kmp_tasking_flags_t in routine.
11803041982dSJonathan Peyton // sizeof_kmp_task_t:  Size in bytes of kmp_task_t data structure including
11813041982dSJonathan Peyton // private vars accessed in task.
11823041982dSJonathan Peyton // sizeof_shareds:  Size in bytes of array of pointers to shared vars accessed
11833041982dSJonathan Peyton // in task.
11847cc577a4SJonathan Peyton // task_entry: Pointer to task code entry point generated by compiler.
11857cc577a4SJonathan Peyton // returns: a pointer to the allocated kmp_task_t structure (task).
11863041982dSJonathan Peyton kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
11873041982dSJonathan Peyton                              kmp_tasking_flags_t *flags,
11887cc577a4SJonathan Peyton                              size_t sizeof_kmp_task_t, size_t sizeof_shareds,
11893041982dSJonathan Peyton                              kmp_routine_entry_t task_entry) {
11907cc577a4SJonathan Peyton   kmp_task_t *task;
11917cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
11927cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
11937cc577a4SJonathan Peyton   kmp_team_t *team = thread->th.th_team;
11947cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
11957cc577a4SJonathan Peyton   size_t shareds_offset;
11967cc577a4SJonathan Peyton 
11976bf84871SAndreyChurbanov   if (UNLIKELY(!TCR_4(__kmp_init_middle)))
119828226e7dSJonathan Peyton     __kmp_middle_initialize();
119928226e7dSJonathan Peyton 
12009d64275aSShilei Tian   if (flags->hidden_helper) {
12019d64275aSShilei Tian     if (__kmp_enable_hidden_helper) {
12029d64275aSShilei Tian       if (!TCR_4(__kmp_init_hidden_helper))
12039d64275aSShilei Tian         __kmp_hidden_helper_initialize();
12049d64275aSShilei Tian     } else {
12059d64275aSShilei Tian       // If the hidden helper task is not enabled, reset the flag to FALSE.
12069d64275aSShilei Tian       flags->hidden_helper = FALSE;
12079d64275aSShilei Tian     }
12089d64275aSShilei Tian   }
12099d64275aSShilei Tian 
12107cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_task_alloc(enter): T#%d loc=%p, flags=(0x%x) "
12117cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12127cc577a4SJonathan Peyton                 gtid, loc_ref, *((kmp_int32 *)flags), sizeof_kmp_task_t,
12137cc577a4SJonathan Peyton                 sizeof_shareds, task_entry));
12147cc577a4SJonathan Peyton 
1215467f3924SHansang Bae   KMP_DEBUG_ASSERT(parent_task);
12167cc577a4SJonathan Peyton   if (parent_task->td_flags.final) {
12177cc577a4SJonathan Peyton     if (flags->merged_if0) {
12187cc577a4SJonathan Peyton     }
12197cc577a4SJonathan Peyton     flags->final = 1;
12207cc577a4SJonathan Peyton   }
12219d64275aSShilei Tian 
1222a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED && !team->t.t_serialized) {
1223a756cb24SAndrey Churbanov     // Untied task encountered causes the TSC algorithm to check entire deque of
1224a756cb24SAndrey Churbanov     // the victim thread. If no untied task encountered, then checking the head
1225a756cb24SAndrey Churbanov     // of the deque should be enough.
1226680c71b1SShilei Tian     KMP_CHECK_UPDATE(thread->th.th_task_team->tt.tt_untied_task_encountered, 1);
1227a756cb24SAndrey Churbanov   }
12287cc577a4SJonathan Peyton 
1229405037c4SAndrey Churbanov   // Detachable tasks are not proxy tasks yet but could be in the future. Doing
1230405037c4SAndrey Churbanov   // the tasking setup
1231405037c4SAndrey Churbanov   // when that happens is too late.
1232838dcdb5SAndreyChurbanov   if (UNLIKELY(flags->proxy == TASK_PROXY ||
1233838dcdb5SAndreyChurbanov                flags->detachable == TASK_DETACHABLE || flags->hidden_helper)) {
12347cc577a4SJonathan Peyton     if (flags->proxy == TASK_PROXY) {
12357cc577a4SJonathan Peyton       flags->tiedness = TASK_UNTIED;
12367cc577a4SJonathan Peyton       flags->merged_if0 = 1;
1237405037c4SAndrey Churbanov     }
12383041982dSJonathan Peyton     /* are we running in a sequential parallel or tskm_immediate_exec... we need
12393041982dSJonathan Peyton        tasking support enabled */
1240680c71b1SShilei Tian     if ((thread->th.th_task_team) == NULL) {
12417cc577a4SJonathan Peyton       /* This should only happen if the team is serialized
12423041982dSJonathan Peyton           setup a task team and propagate it to the thread */
12437cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(team->t.t_serialized);
12443041982dSJonathan Peyton       KA_TRACE(30,
12453041982dSJonathan Peyton                ("T#%d creating task team in __kmp_task_alloc for proxy task\n",
12463041982dSJonathan Peyton                 gtid));
1247680c71b1SShilei Tian       // 1 indicates setup the current team regardless of nthreads
1248680c71b1SShilei Tian       __kmp_task_team_setup(thread, team, 1);
1249680c71b1SShilei Tian       thread->th.th_task_team = team->t.t_task_team[thread->th.th_task_state];
12507cc577a4SJonathan Peyton     }
1251680c71b1SShilei Tian     kmp_task_team_t *task_team = thread->th.th_task_team;
12527cc577a4SJonathan Peyton 
12537cc577a4SJonathan Peyton     /* tasking must be enabled now as the task might not be pushed */
12547cc577a4SJonathan Peyton     if (!KMP_TASKING_ENABLED(task_team)) {
12553041982dSJonathan Peyton       KA_TRACE(
12563041982dSJonathan Peyton           30,
12573041982dSJonathan Peyton           ("T#%d enabling tasking in __kmp_task_alloc for proxy task\n", gtid));
1258680c71b1SShilei Tian       __kmp_enable_tasking(task_team, thread);
1259680c71b1SShilei Tian       kmp_int32 tid = thread->th.th_info.ds.ds_tid;
12607cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
12617cc577a4SJonathan Peyton       // No lock needed since only owner can allocate
12627cc577a4SJonathan Peyton       if (thread_data->td.td_deque == NULL) {
1263680c71b1SShilei Tian         __kmp_alloc_task_deque(thread, thread_data);
12647cc577a4SJonathan Peyton       }
12657cc577a4SJonathan Peyton     }
12667cc577a4SJonathan Peyton 
12673c31b784SShilei Tian     if ((flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE) &&
12689d64275aSShilei Tian         task_team->tt.tt_found_proxy_tasks == FALSE)
12697cc577a4SJonathan Peyton       TCW_4(task_team->tt.tt_found_proxy_tasks, TRUE);
12709d64275aSShilei Tian     if (flags->hidden_helper &&
12719d64275aSShilei Tian         task_team->tt.tt_hidden_helper_task_encountered == FALSE)
12729d64275aSShilei Tian       TCW_4(task_team->tt.tt_hidden_helper_task_encountered, TRUE);
12737cc577a4SJonathan Peyton   }
12747cc577a4SJonathan Peyton 
12757cc577a4SJonathan Peyton   // Calculate shared structure offset including padding after kmp_task_t struct
12767cc577a4SJonathan Peyton   // to align pointers in shared struct
12777cc577a4SJonathan Peyton   shareds_offset = sizeof(kmp_taskdata_t) + sizeof_kmp_task_t;
12787cc577a4SJonathan Peyton   shareds_offset = __kmp_round_up_to_val(shareds_offset, sizeof(void *));
12797cc577a4SJonathan Peyton 
12807cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
12813041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d First malloc size: %ld\n", gtid,
12823041982dSJonathan Peyton                 shareds_offset));
12833041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d Second malloc size: %ld\n", gtid,
12843041982dSJonathan Peyton                 sizeof_shareds));
12857cc577a4SJonathan Peyton 
12867cc577a4SJonathan Peyton   // Avoid double allocation here by combining shareds with taskdata
12877cc577a4SJonathan Peyton #if USE_FAST_MEMORY
1288680c71b1SShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, shareds_offset +
1289680c71b1SShilei Tian                                                                sizeof_shareds);
12907cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
1291680c71b1SShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, shareds_offset +
1292680c71b1SShilei Tian                                                                sizeof_shareds);
12937cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
12947cc577a4SJonathan Peyton 
12957cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
12967cc577a4SJonathan Peyton 
12977cc577a4SJonathan Peyton // Make sure task & taskdata are aligned appropriately
12987cc577a4SJonathan Peyton #if KMP_ARCH_X86 || KMP_ARCH_PPC64 || !KMP_HAVE_QUAD
12997cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(double) - 1)) == 0);
13007cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(double) - 1)) == 0);
13017cc577a4SJonathan Peyton #else
13027cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(_Quad) - 1)) == 0);
13037cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(_Quad) - 1)) == 0);
13047cc577a4SJonathan Peyton #endif
13057cc577a4SJonathan Peyton   if (sizeof_shareds > 0) {
13067cc577a4SJonathan Peyton     // Avoid double allocation here by combining shareds with taskdata
13077cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
13087cc577a4SJonathan Peyton     // Make sure shareds struct is aligned to pointer size
13093041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
13103041982dSJonathan Peyton                      0);
13117cc577a4SJonathan Peyton   } else {
13127cc577a4SJonathan Peyton     task->shareds = NULL;
13137cc577a4SJonathan Peyton   }
13147cc577a4SJonathan Peyton   task->routine = task_entry;
13157cc577a4SJonathan Peyton   task->part_id = 0; // AC: Always start with 0 part id
13167cc577a4SJonathan Peyton 
13177cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
13189d64275aSShilei Tian   taskdata->td_team = thread->th.th_team;
1319680c71b1SShilei Tian   taskdata->td_alloc_thread = thread;
13207cc577a4SJonathan Peyton   taskdata->td_parent = parent_task;
13217cc577a4SJonathan Peyton   taskdata->td_level = parent_task->td_level + 1; // increment nesting level
132237e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_untied_count, 0);
13237cc577a4SJonathan Peyton   taskdata->td_ident = loc_ref;
13247cc577a4SJonathan Peyton   taskdata->td_taskwait_ident = NULL;
13257cc577a4SJonathan Peyton   taskdata->td_taskwait_counter = 0;
13267cc577a4SJonathan Peyton   taskdata->td_taskwait_thread = 0;
13277cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_parent != NULL);
13287cc577a4SJonathan Peyton   // avoid copying icvs for proxy tasks
13297cc577a4SJonathan Peyton   if (flags->proxy == TASK_FULL)
13307cc577a4SJonathan Peyton     copy_icvs(&taskdata->td_icvs, &taskdata->td_parent->td_icvs);
13317cc577a4SJonathan Peyton 
1332db635a28SHansang Bae   taskdata->td_flags = *flags;
13337cc577a4SJonathan Peyton   taskdata->td_task_team = thread->th.th_task_team;
13347cc577a4SJonathan Peyton   taskdata->td_size_alloc = shareds_offset + sizeof_shareds;
13357cc577a4SJonathan Peyton   taskdata->td_flags.tasktype = TASK_EXPLICIT;
1336680c71b1SShilei Tian   // If it is hidden helper task, we need to set the team and task team
1337680c71b1SShilei Tian   // correspondingly.
1338680c71b1SShilei Tian   if (flags->hidden_helper) {
1339680c71b1SShilei Tian     kmp_info_t *shadow_thread = __kmp_threads[KMP_GTID_TO_SHADOW_GTID(gtid)];
1340680c71b1SShilei Tian     taskdata->td_team = shadow_thread->th.th_team;
1341680c71b1SShilei Tian     taskdata->td_task_team = shadow_thread->th.th_task_team;
1342680c71b1SShilei Tian   }
13437cc577a4SJonathan Peyton 
13447cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of tasking_ser flag
13457cc577a4SJonathan Peyton   taskdata->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
13467cc577a4SJonathan Peyton 
13477cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of team_serial flag
13487cc577a4SJonathan Peyton   taskdata->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
13497cc577a4SJonathan Peyton 
13503041982dSJonathan Peyton   // GEH - Note we serialize the task if the team is serialized to make sure
13513041982dSJonathan Peyton   // implicit parallel region tasks are not left until program termination to
13523041982dSJonathan Peyton   // execute. Also, it helps locality to execute immediately.
13533041982dSJonathan Peyton 
13543041982dSJonathan Peyton   taskdata->td_flags.task_serial =
13553041982dSJonathan Peyton       (parent_task->td_flags.final || taskdata->td_flags.team_serial ||
1356add8d90cSJoachim Protze        taskdata->td_flags.tasking_ser || flags->merged_if0);
13577cc577a4SJonathan Peyton 
13587cc577a4SJonathan Peyton   taskdata->td_flags.started = 0;
13597cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0;
13607cc577a4SJonathan Peyton   taskdata->td_flags.complete = 0;
13617cc577a4SJonathan Peyton   taskdata->td_flags.freed = 0;
13627cc577a4SJonathan Peyton 
136337e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_incomplete_child_tasks, 0);
136437e2ef54SJonathan Peyton   // start at one because counts current task and children
136537e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_allocated_child_tasks, 1);
13663041982dSJonathan Peyton   taskdata->td_taskgroup =
13673041982dSJonathan Peyton       parent_task->td_taskgroup; // task inherits taskgroup from the parent task
13687cc577a4SJonathan Peyton   taskdata->td_dephash = NULL;
13697cc577a4SJonathan Peyton   taskdata->td_depnode = NULL;
1370a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED)
1371a756cb24SAndrey Churbanov     taskdata->td_last_tied = NULL; // will be set when the task is scheduled
1372a756cb24SAndrey Churbanov   else
1373a756cb24SAndrey Churbanov     taskdata->td_last_tied = taskdata;
1374405037c4SAndrey Churbanov   taskdata->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
137586ed6aa6SJoachim Protze #if OMPT_SUPPORT
137686ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled))
137786ed6aa6SJoachim Protze     __ompt_task_init(taskdata, gtid);
137886ed6aa6SJoachim Protze #endif
13799d64275aSShilei Tian   // Only need to keep track of child task counts if team parallel and tasking
13809d64275aSShilei Tian   // not serialized or if it is a proxy or detachable or hidden helper task
13819d64275aSShilei Tian   if (flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE ||
13829d64275aSShilei Tian       flags->hidden_helper ||
13839d64275aSShilei Tian       !(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
138437e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
13857cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
138637e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
13873041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
13883041982dSJonathan Peyton     // implicit not deallocated
13897cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT) {
139037e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
13917cc577a4SJonathan Peyton     }
13929d64275aSShilei Tian     if (flags->hidden_helper) {
13939d64275aSShilei Tian       taskdata->td_flags.task_serial = FALSE;
13949d64275aSShilei Tian       // Increment the number of hidden helper tasks to be executed
13959d64275aSShilei Tian       KMP_ATOMIC_INC(&__kmp_unexecuted_hidden_helper_tasks);
13969d64275aSShilei Tian     }
1397db635a28SHansang Bae   }
13989d64275aSShilei Tian 
13997cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_task_alloc(exit): T#%d created task %p parent=%p\n",
14007cc577a4SJonathan Peyton                 gtid, taskdata, taskdata->td_parent));
14017cc577a4SJonathan Peyton 
14027cc577a4SJonathan Peyton   return task;
14037cc577a4SJonathan Peyton }
14047cc577a4SJonathan Peyton 
14053041982dSJonathan Peyton kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
14063041982dSJonathan Peyton                                   kmp_int32 flags, size_t sizeof_kmp_task_t,
14073041982dSJonathan Peyton                                   size_t sizeof_shareds,
14083041982dSJonathan Peyton                                   kmp_routine_entry_t task_entry) {
14097cc577a4SJonathan Peyton   kmp_task_t *retval;
14107cc577a4SJonathan Peyton   kmp_tasking_flags_t *input_flags = (kmp_tasking_flags_t *)&flags;
1411787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
14127cc577a4SJonathan Peyton   input_flags->native = FALSE;
14137cc577a4SJonathan Peyton   // __kmp_task_alloc() sets up all other runtime flags
1414405037c4SAndrey Churbanov   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s %s %s) "
1415405037c4SAndrey Churbanov                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
1416405037c4SAndrey Churbanov                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
1417405037c4SAndrey Churbanov                 input_flags->proxy ? "proxy" : "",
1418405037c4SAndrey Churbanov                 input_flags->detachable ? "detachable" : "", sizeof_kmp_task_t,
1419405037c4SAndrey Churbanov                 sizeof_shareds, task_entry));
14207cc577a4SJonathan Peyton 
14217cc577a4SJonathan Peyton   retval = __kmp_task_alloc(loc_ref, gtid, input_flags, sizeof_kmp_task_t,
14227cc577a4SJonathan Peyton                             sizeof_shareds, task_entry);
14237cc577a4SJonathan Peyton 
14247cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmpc_omp_task_alloc(exit): T#%d retval %p\n", gtid, retval));
14257cc577a4SJonathan Peyton 
14267cc577a4SJonathan Peyton   return retval;
14277cc577a4SJonathan Peyton }
14287cc577a4SJonathan Peyton 
1429b48e44a6SGheorghe-Teodor Bercea kmp_task_t *__kmpc_omp_target_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
1430b48e44a6SGheorghe-Teodor Bercea                                          kmp_int32 flags,
1431b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_kmp_task_t,
1432b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_shareds,
1433b48e44a6SGheorghe-Teodor Bercea                                          kmp_routine_entry_t task_entry,
1434b48e44a6SGheorghe-Teodor Bercea                                          kmp_int64 device_id) {
14359d64275aSShilei Tian   auto &input_flags = reinterpret_cast<kmp_tasking_flags_t &>(flags);
1436262289c1SYe Luo   // target task is untied defined in the specification
14379f5d6ea5SShilei Tian   input_flags.tiedness = TASK_UNTIED;
1438262289c1SYe Luo 
1439262289c1SYe Luo   if (__kmp_enable_hidden_helper)
1440262289c1SYe Luo     input_flags.hidden_helper = TRUE;
14419d64275aSShilei Tian 
1442b48e44a6SGheorghe-Teodor Bercea   return __kmpc_omp_task_alloc(loc_ref, gtid, flags, sizeof_kmp_task_t,
1443b48e44a6SGheorghe-Teodor Bercea                                sizeof_shareds, task_entry);
1444b48e44a6SGheorghe-Teodor Bercea }
1445b48e44a6SGheorghe-Teodor Bercea 
1446b04f7d68SJonathan Peyton /*!
1447b04f7d68SJonathan Peyton @ingroup TASKING
1448b04f7d68SJonathan Peyton @param loc_ref location of the original task directive
1449b04f7d68SJonathan Peyton @param gtid Global Thread ID of encountering thread
1450b04f7d68SJonathan Peyton @param new_task task thunk allocated by __kmpc_omp_task_alloc() for the ''new
1451b04f7d68SJonathan Peyton task''
1452b04f7d68SJonathan Peyton @param naffins Number of affinity items
1453b04f7d68SJonathan Peyton @param affin_list List of affinity items
1454b04f7d68SJonathan Peyton @return Returns non-zero if registering affinity information was not successful.
1455b04f7d68SJonathan Peyton  Returns 0 if registration was successful
1456b04f7d68SJonathan Peyton This entry registers the affinity information attached to a task with the task
1457b04f7d68SJonathan Peyton thunk structure kmp_taskdata_t.
1458b04f7d68SJonathan Peyton */
1459b04f7d68SJonathan Peyton kmp_int32
1460b04f7d68SJonathan Peyton __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref, kmp_int32 gtid,
1461b04f7d68SJonathan Peyton                                   kmp_task_t *new_task, kmp_int32 naffins,
1462b04f7d68SJonathan Peyton                                   kmp_task_affinity_info_t *affin_list) {
1463b04f7d68SJonathan Peyton   return 0;
1464b04f7d68SJonathan Peyton }
1465b04f7d68SJonathan Peyton 
14667cc577a4SJonathan Peyton //  __kmp_invoke_task: invoke the specified task
14677cc577a4SJonathan Peyton //
14687cc577a4SJonathan Peyton // gtid: global thread ID of caller
14697cc577a4SJonathan Peyton // task: the task to invoke
147042016791SKazuaki Ishizaki // current_task: the task to resume after task invocation
14713041982dSJonathan Peyton static void __kmp_invoke_task(kmp_int32 gtid, kmp_task_t *task,
14723041982dSJonathan Peyton                               kmp_taskdata_t *current_task) {
14737cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
1474b1b221c8SJonathan Peyton   kmp_info_t *thread;
14757cc577a4SJonathan Peyton   int discard = 0 /* false */;
14763041982dSJonathan Peyton   KA_TRACE(
14773041982dSJonathan Peyton       30, ("__kmp_invoke_task(enter): T#%d invoking task %p, current_task=%p\n",
14787cc577a4SJonathan Peyton            gtid, taskdata, current_task));
14797cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task);
14806bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.proxy == TASK_PROXY &&
14816bf84871SAndreyChurbanov                taskdata->td_flags.complete == 1)) {
14827cc577a4SJonathan Peyton     // This is a proxy task that was already completed but it needs to run
14837cc577a4SJonathan Peyton     // its bottom-half finish
14843041982dSJonathan Peyton     KA_TRACE(
14853041982dSJonathan Peyton         30,
14863041982dSJonathan Peyton         ("__kmp_invoke_task: T#%d running bottom finish for proxy task %p\n",
14877cc577a4SJonathan Peyton          gtid, taskdata));
14887cc577a4SJonathan Peyton 
14897cc577a4SJonathan Peyton     __kmp_bottom_half_finish_proxy(gtid, task);
14907cc577a4SJonathan Peyton 
14913041982dSJonathan Peyton     KA_TRACE(30, ("__kmp_invoke_task(exit): T#%d completed bottom finish for "
14923041982dSJonathan Peyton                   "proxy task %p, resuming task %p\n",
14933041982dSJonathan Peyton                   gtid, taskdata, current_task));
14947cc577a4SJonathan Peyton 
14957cc577a4SJonathan Peyton     return;
14967cc577a4SJonathan Peyton   }
14977cc577a4SJonathan Peyton 
14987cc577a4SJonathan Peyton #if OMPT_SUPPORT
149986ed6aa6SJoachim Protze   // For untied tasks, the first task executed only calls __kmpc_omp_task and
150086ed6aa6SJoachim Protze   // does not execute code.
15017cc577a4SJonathan Peyton   ompt_thread_info_t oldInfo;
1502f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
15037cc577a4SJonathan Peyton     // Store the threads states and restore them after the task
15047cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
15057cc577a4SJonathan Peyton     oldInfo = thread->th.ompt_thread_info;
15067cc577a4SJonathan Peyton     thread->th.ompt_thread_info.wait_id = 0;
150782e94a59SJoachim Protze     thread->th.ompt_thread_info.state = (thread->th.th_team_serialized)
15080e0d6cddSJoachim Protze                                             ? ompt_state_work_serial
15090e0d6cddSJoachim Protze                                             : ompt_state_work_parallel;
15100e0d6cddSJoachim Protze     taskdata->ompt_task_info.frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
15117cc577a4SJonathan Peyton   }
15127cc577a4SJonathan Peyton #endif
15137cc577a4SJonathan Peyton 
15149d64275aSShilei Tian   // Decreament the counter of hidden helper tasks to be executed
15159d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
15169d64275aSShilei Tian     // Hidden helper tasks can only be executed by hidden helper threads
15179d64275aSShilei Tian     KMP_ASSERT(KMP_HIDDEN_HELPER_THREAD(gtid));
15189d64275aSShilei Tian     KMP_ATOMIC_DEC(&__kmp_unexecuted_hidden_helper_tasks);
15199d64275aSShilei Tian   }
15209d64275aSShilei Tian 
152186ed6aa6SJoachim Protze   // Proxy tasks are not handled by the runtime
152286ed6aa6SJoachim Protze   if (taskdata->td_flags.proxy != TASK_PROXY) {
152386ed6aa6SJoachim Protze     __kmp_task_start(gtid, task, current_task); // OMPT only if not discarded
152486ed6aa6SJoachim Protze   }
152586ed6aa6SJoachim Protze 
15267cc577a4SJonathan Peyton   // TODO: cancel tasks if the parallel region has also been cancelled
15277cc577a4SJonathan Peyton   // TODO: check if this sequence can be hoisted above __kmp_task_start
15287cc577a4SJonathan Peyton   // if cancellation has been enabled for this run ...
15296bf84871SAndreyChurbanov   if (UNLIKELY(__kmp_omp_cancellation)) {
1530b1b221c8SJonathan Peyton     thread = __kmp_threads[gtid];
1531b1b221c8SJonathan Peyton     kmp_team_t *this_team = thread->th.th_team;
15327cc577a4SJonathan Peyton     kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
15333041982dSJonathan Peyton     if ((taskgroup && taskgroup->cancel_request) ||
15343041982dSJonathan Peyton         (this_team->t.t_cancel_request == cancel_parallel)) {
153582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
153682e94a59SJoachim Protze       ompt_data_t *task_data;
1537f0a1c65fSJonas Hahnfeld       if (UNLIKELY(ompt_enabled.ompt_callback_cancel)) {
153882e94a59SJoachim Protze         __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
153982e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_cancel)(
154082e94a59SJoachim Protze             task_data,
154182e94a59SJoachim Protze             ((taskgroup && taskgroup->cancel_request) ? ompt_cancel_taskgroup
154282e94a59SJoachim Protze                                                       : ompt_cancel_parallel) |
154382e94a59SJoachim Protze                 ompt_cancel_discarded_task,
154482e94a59SJoachim Protze             NULL);
154582e94a59SJoachim Protze       }
154682e94a59SJoachim Protze #endif
15477cc577a4SJonathan Peyton       KMP_COUNT_BLOCK(TASK_cancelled);
15487cc577a4SJonathan Peyton       // this task belongs to a task group and we need to cancel it
15497cc577a4SJonathan Peyton       discard = 1 /* true */;
15507cc577a4SJonathan Peyton     }
15517cc577a4SJonathan Peyton   }
15527cc577a4SJonathan Peyton 
15537cc577a4SJonathan Peyton   // Invoke the task routine and pass in relevant data.
15547cc577a4SJonathan Peyton   // Thunks generated by gcc take a different argument list.
15557cc577a4SJonathan Peyton   if (!discard) {
1556a756cb24SAndrey Churbanov     if (taskdata->td_flags.tiedness == TASK_UNTIED) {
1557a756cb24SAndrey Churbanov       taskdata->td_last_tied = current_task->td_last_tied;
1558a756cb24SAndrey Churbanov       KMP_DEBUG_ASSERT(taskdata->td_last_tied);
1559a756cb24SAndrey Churbanov     }
15607cc577a4SJonathan Peyton #if KMP_STATS_ENABLED
15617cc577a4SJonathan Peyton     KMP_COUNT_BLOCK(TASK_executed);
15627cc577a4SJonathan Peyton     switch (KMP_GET_THREAD_STATE()) {
15633041982dSJonathan Peyton     case FORK_JOIN_BARRIER:
15643041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_join_bar);
15653041982dSJonathan Peyton       break;
15663041982dSJonathan Peyton     case PLAIN_BARRIER:
15673041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_plain_bar);
15683041982dSJonathan Peyton       break;
15693041982dSJonathan Peyton     case TASKYIELD:
15703041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskyield);
15713041982dSJonathan Peyton       break;
15723041982dSJonathan Peyton     case TASKWAIT:
15733041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskwait);
15743041982dSJonathan Peyton       break;
15753041982dSJonathan Peyton     case TASKGROUP:
15763041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskgroup);
15773041982dSJonathan Peyton       break;
15783041982dSJonathan Peyton     default:
15793041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_immediate);
15803041982dSJonathan Peyton       break;
15817cc577a4SJonathan Peyton     }
15827cc577a4SJonathan Peyton #endif // KMP_STATS_ENABLED
15837cc577a4SJonathan Peyton 
158482e94a59SJoachim Protze // OMPT task begin
158582e94a59SJoachim Protze #if OMPT_SUPPORT
1586f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.enabled))
158782e94a59SJoachim Protze       __ompt_task_start(task, current_task, gtid);
15887cc577a4SJonathan Peyton #endif
15897cc577a4SJonathan Peyton 
1590f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1591f61602b0SVignesh Balasubramanian     if (ompd_state & OMPD_ENABLE_BP)
1592f61602b0SVignesh Balasubramanian       ompd_bp_task_begin();
1593f61602b0SVignesh Balasubramanian #endif
1594f61602b0SVignesh Balasubramanian 
1595b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1596b1b221c8SJonathan Peyton     kmp_uint64 cur_time;
1597b1b221c8SJonathan Peyton     kmp_int32 kmp_itt_count_task =
1598b1b221c8SJonathan Peyton         __kmp_forkjoin_frames_mode == 3 && !taskdata->td_flags.task_serial &&
1599b1b221c8SJonathan Peyton         current_task->td_flags.tasktype == TASK_IMPLICIT;
1600b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1601b1b221c8SJonathan Peyton       thread = __kmp_threads[gtid];
1602b1b221c8SJonathan Peyton       // Time outer level explicit task on barrier for adjusting imbalance time
1603b1b221c8SJonathan Peyton       if (thread->th.th_bar_arrive_time)
1604b1b221c8SJonathan Peyton         cur_time = __itt_get_timestamp();
1605b1b221c8SJonathan Peyton       else
1606b1b221c8SJonathan Peyton         kmp_itt_count_task = 0; // thread is not on a barrier - skip timing
1607b1b221c8SJonathan Peyton     }
1608ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquired self (new task)
1609b1b221c8SJonathan Peyton #endif
1610b1b221c8SJonathan Peyton 
16117cc577a4SJonathan Peyton #ifdef KMP_GOMP_COMPAT
16127cc577a4SJonathan Peyton     if (taskdata->td_flags.native) {
16137cc577a4SJonathan Peyton       ((void (*)(void *))(*(task->routine)))(task->shareds);
16143041982dSJonathan Peyton     } else
16157cc577a4SJonathan Peyton #endif /* KMP_GOMP_COMPAT */
16167cc577a4SJonathan Peyton     {
16177cc577a4SJonathan Peyton       (*(task->routine))(gtid, task);
16187cc577a4SJonathan Peyton     }
16197cc577a4SJonathan Peyton     KMP_POP_PARTITIONED_TIMER();
16207cc577a4SJonathan Peyton 
1621b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1622b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1623b1b221c8SJonathan Peyton       // Barrier imbalance - adjust arrive time with the task duration
1624b1b221c8SJonathan Peyton       thread->th.th_bar_arrive_time += (__itt_get_timestamp() - cur_time);
1625b1b221c8SJonathan Peyton     }
1626ffd8f009SAndreyChurbanov     KMP_FSYNC_CANCEL(taskdata); // destroy self (just executed)
1627ffd8f009SAndreyChurbanov     KMP_FSYNC_RELEASING(taskdata->td_parent); // releasing parent
1628b1b221c8SJonathan Peyton #endif
16297cc577a4SJonathan Peyton   }
16307cc577a4SJonathan Peyton 
1631f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1632f61602b0SVignesh Balasubramanian   if (ompd_state & OMPD_ENABLE_BP)
1633f61602b0SVignesh Balasubramanian     ompd_bp_task_end();
1634f61602b0SVignesh Balasubramanian #endif
1635f61602b0SVignesh Balasubramanian 
16367cc577a4SJonathan Peyton   // Proxy tasks are not handled by the runtime
16377cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy != TASK_PROXY) {
163886ed6aa6SJoachim Protze #if OMPT_SUPPORT
163986ed6aa6SJoachim Protze     if (UNLIKELY(ompt_enabled.enabled)) {
164086ed6aa6SJoachim Protze       thread->th.ompt_thread_info = oldInfo;
164186ed6aa6SJoachim Protze       if (taskdata->td_flags.tiedness == TASK_TIED) {
16420e0d6cddSJoachim Protze         taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
164386ed6aa6SJoachim Protze       }
164486ed6aa6SJoachim Protze       __kmp_task_finish<true>(gtid, task, current_task);
164586ed6aa6SJoachim Protze     } else
164686ed6aa6SJoachim Protze #endif
164786ed6aa6SJoachim Protze       __kmp_task_finish<false>(gtid, task, current_task);
16487cc577a4SJonathan Peyton   }
16497cc577a4SJonathan Peyton 
16503041982dSJonathan Peyton   KA_TRACE(
16513041982dSJonathan Peyton       30,
16523041982dSJonathan Peyton       ("__kmp_invoke_task(exit): T#%d completed task %p, resuming task %p\n",
16537cc577a4SJonathan Peyton        gtid, taskdata, current_task));
16547cc577a4SJonathan Peyton   return;
16557cc577a4SJonathan Peyton }
16567cc577a4SJonathan Peyton 
16577cc577a4SJonathan Peyton // __kmpc_omp_task_parts: Schedule a thread-switchable task for execution
16587cc577a4SJonathan Peyton //
16597cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
16607cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
16617cc577a4SJonathan Peyton // new_task: task thunk allocated by __kmp_omp_task_alloc() for the ''new task''
16627cc577a4SJonathan Peyton // Returns:
16633041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
16643041982dSJonathan Peyton //    be resumed later.
16653041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
16663041982dSJonathan Peyton //    resumed later.
16673041982dSJonathan Peyton kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
16683041982dSJonathan Peyton                                 kmp_task_t *new_task) {
16697cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
16707cc577a4SJonathan Peyton 
16713041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_parts(enter): T#%d loc=%p task=%p\n", gtid,
16723041982dSJonathan Peyton                 loc_ref, new_taskdata));
16737cc577a4SJonathan Peyton 
167482e94a59SJoachim Protze #if OMPT_SUPPORT
167582e94a59SJoachim Protze   kmp_taskdata_t *parent;
1676f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
167782e94a59SJoachim Protze     parent = new_taskdata->td_parent;
167882e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
167982e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1680467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
168182e94a59SJoachim Protze           &(new_taskdata->ompt_task_info.task_data), ompt_task_explicit, 0,
168282e94a59SJoachim Protze           OMPT_GET_RETURN_ADDRESS(0));
168382e94a59SJoachim Protze     }
168482e94a59SJoachim Protze   }
168582e94a59SJoachim Protze #endif
168682e94a59SJoachim Protze 
16873041982dSJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
16883041982dSJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
16897cc577a4SJonathan Peyton 
16907cc577a4SJonathan Peyton   if (__kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
16917cc577a4SJonathan Peyton   { // Execute this task immediately
16927cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
16937cc577a4SJonathan Peyton     new_taskdata->td_flags.task_serial = 1;
16947cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
16957cc577a4SJonathan Peyton   }
16967cc577a4SJonathan Peyton 
16973041982dSJonathan Peyton   KA_TRACE(
16983041982dSJonathan Peyton       10,
16993041982dSJonathan Peyton       ("__kmpc_omp_task_parts(exit): T#%d returning TASK_CURRENT_NOT_QUEUED: "
17003041982dSJonathan Peyton        "loc=%p task=%p, return: TASK_CURRENT_NOT_QUEUED\n",
17013041982dSJonathan Peyton        gtid, loc_ref, new_taskdata));
17027cc577a4SJonathan Peyton 
170382e94a59SJoachim Protze #if OMPT_SUPPORT
1704f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
17050e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
170682e94a59SJoachim Protze   }
170782e94a59SJoachim Protze #endif
17087cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17097cc577a4SJonathan Peyton }
17107cc577a4SJonathan Peyton 
17117cc577a4SJonathan Peyton // __kmp_omp_task: Schedule a non-thread-switchable task for execution
17123041982dSJonathan Peyton //
17137cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17147cc577a4SJonathan Peyton // new_task:non-thread-switchable task thunk allocated by __kmp_omp_task_alloc()
17153041982dSJonathan Peyton // serialize_immediate: if TRUE then if the task is executed immediately its
17163041982dSJonathan Peyton // execution will be serialized
17173041982dSJonathan Peyton // Returns:
17183041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17193041982dSJonathan Peyton //    be resumed later.
17203041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17213041982dSJonathan Peyton //    resumed later.
17223041982dSJonathan Peyton kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
17233041982dSJonathan Peyton                          bool serialize_immediate) {
17247cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17257cc577a4SJonathan Peyton 
1726e4b4f994SJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
1727e4b4f994SJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
17283041982dSJonathan Peyton   if (new_taskdata->td_flags.proxy == TASK_PROXY ||
17293041982dSJonathan Peyton       __kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
17307cc577a4SJonathan Peyton   { // Execute this task immediately
17317cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
17327cc577a4SJonathan Peyton     if (serialize_immediate)
17337cc577a4SJonathan Peyton       new_taskdata->td_flags.task_serial = 1;
17347cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
17357cc577a4SJonathan Peyton   }
17367cc577a4SJonathan Peyton 
17377cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17387cc577a4SJonathan Peyton }
17397cc577a4SJonathan Peyton 
17403041982dSJonathan Peyton // __kmpc_omp_task: Wrapper around __kmp_omp_task to schedule a
17413041982dSJonathan Peyton // non-thread-switchable task from the parent thread only!
17423041982dSJonathan Peyton //
17437cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
17447cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17453041982dSJonathan Peyton // new_task: non-thread-switchable task thunk allocated by
17463041982dSJonathan Peyton // __kmp_omp_task_alloc()
17473041982dSJonathan Peyton // Returns:
17483041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17493041982dSJonathan Peyton //    be resumed later.
17503041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17513041982dSJonathan Peyton //    resumed later.
17523041982dSJonathan Peyton kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
17533041982dSJonathan Peyton                           kmp_task_t *new_task) {
17547cc577a4SJonathan Peyton   kmp_int32 res;
17557cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
17567cc577a4SJonathan Peyton 
175782e94a59SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
17587cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17597cc577a4SJonathan Peyton #endif
17603041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
17613041982dSJonathan Peyton                 new_taskdata));
1762787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
17637cc577a4SJonathan Peyton 
176482e94a59SJoachim Protze #if OMPT_SUPPORT
176582e94a59SJoachim Protze   kmp_taskdata_t *parent = NULL;
176686ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
176786ed6aa6SJoachim Protze     if (!new_taskdata->td_flags.started) {
176882e94a59SJoachim Protze       OMPT_STORE_RETURN_ADDRESS(gtid);
176982e94a59SJoachim Protze       parent = new_taskdata->td_parent;
17700e0d6cddSJoachim Protze       if (!parent->ompt_task_info.frame.enter_frame.ptr) {
1771309b00a4SShilei Tian         parent->ompt_task_info.frame.enter_frame.ptr =
1772309b00a4SShilei Tian             OMPT_GET_FRAME_ADDRESS(0);
177386ed6aa6SJoachim Protze       }
177482e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_task_create) {
177582e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1776467f3924SHansang Bae             &(parent->ompt_task_info.task_data),
1777467f3924SHansang Bae             &(parent->ompt_task_info.frame),
177882e94a59SJoachim Protze             &(new_taskdata->ompt_task_info.task_data),
177982e94a59SJoachim Protze             ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
178082e94a59SJoachim Protze             OMPT_LOAD_RETURN_ADDRESS(gtid));
178182e94a59SJoachim Protze       }
178286ed6aa6SJoachim Protze     } else {
178386ed6aa6SJoachim Protze       // We are scheduling the continuation of an UNTIED task.
178486ed6aa6SJoachim Protze       // Scheduling back to the parent task.
178586ed6aa6SJoachim Protze       __ompt_task_finish(new_task,
178686ed6aa6SJoachim Protze                          new_taskdata->ompt_task_info.scheduling_parent,
1787489cdb78SJoachim Protze                          ompt_task_switch);
17880e0d6cddSJoachim Protze       new_taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
178986ed6aa6SJoachim Protze     }
179082e94a59SJoachim Protze   }
179182e94a59SJoachim Protze #endif
179282e94a59SJoachim Protze 
17937cc577a4SJonathan Peyton   res = __kmp_omp_task(gtid, new_task, true);
17947cc577a4SJonathan Peyton 
17953041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
17963041982dSJonathan Peyton                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
17977cc577a4SJonathan Peyton                 gtid, loc_ref, new_taskdata));
179882e94a59SJoachim Protze #if OMPT_SUPPORT
1799f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18000e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
180182e94a59SJoachim Protze   }
180282e94a59SJoachim Protze #endif
18037cc577a4SJonathan Peyton   return res;
18047cc577a4SJonathan Peyton }
18057cc577a4SJonathan Peyton 
1806cdaefac5SJoachim Protze // __kmp_omp_taskloop_task: Wrapper around __kmp_omp_task to schedule
1807cdaefac5SJoachim Protze // a taskloop task with the correct OMPT return address
1808cdaefac5SJoachim Protze //
1809cdaefac5SJoachim Protze // loc_ref: location of original task pragma (ignored)
1810cdaefac5SJoachim Protze // gtid: Global Thread ID of encountering thread
1811cdaefac5SJoachim Protze // new_task: non-thread-switchable task thunk allocated by
1812cdaefac5SJoachim Protze // __kmp_omp_task_alloc()
1813cdaefac5SJoachim Protze // codeptr_ra: return address for OMPT callback
1814cdaefac5SJoachim Protze // Returns:
1815cdaefac5SJoachim Protze //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
1816cdaefac5SJoachim Protze //    be resumed later.
1817cdaefac5SJoachim Protze //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
1818cdaefac5SJoachim Protze //    resumed later.
1819cdaefac5SJoachim Protze kmp_int32 __kmp_omp_taskloop_task(ident_t *loc_ref, kmp_int32 gtid,
1820cdaefac5SJoachim Protze                                   kmp_task_t *new_task, void *codeptr_ra) {
1821cdaefac5SJoachim Protze   kmp_int32 res;
1822cdaefac5SJoachim Protze   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
1823cdaefac5SJoachim Protze 
1824cdaefac5SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
1825cdaefac5SJoachim Protze   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
1826cdaefac5SJoachim Protze #endif
1827cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
1828cdaefac5SJoachim Protze                 new_taskdata));
1829cdaefac5SJoachim Protze 
1830cdaefac5SJoachim Protze #if OMPT_SUPPORT
1831cdaefac5SJoachim Protze   kmp_taskdata_t *parent = NULL;
1832cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && !new_taskdata->td_flags.started)) {
1833cdaefac5SJoachim Protze     parent = new_taskdata->td_parent;
18340e0d6cddSJoachim Protze     if (!parent->ompt_task_info.frame.enter_frame.ptr)
18350e0d6cddSJoachim Protze       parent->ompt_task_info.frame.enter_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
1836cdaefac5SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
1837cdaefac5SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1838467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
1839cdaefac5SJoachim Protze           &(new_taskdata->ompt_task_info.task_data),
1840cdaefac5SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
1841cdaefac5SJoachim Protze           codeptr_ra);
1842cdaefac5SJoachim Protze     }
1843cdaefac5SJoachim Protze   }
1844cdaefac5SJoachim Protze #endif
1845cdaefac5SJoachim Protze 
1846cdaefac5SJoachim Protze   res = __kmp_omp_task(gtid, new_task, true);
1847cdaefac5SJoachim Protze 
1848cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
1849cdaefac5SJoachim Protze                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
1850cdaefac5SJoachim Protze                 gtid, loc_ref, new_taskdata));
1851cdaefac5SJoachim Protze #if OMPT_SUPPORT
1852cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18530e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
1854cdaefac5SJoachim Protze   }
1855cdaefac5SJoachim Protze #endif
1856cdaefac5SJoachim Protze   return res;
1857cdaefac5SJoachim Protze }
1858cdaefac5SJoachim Protze 
185982e94a59SJoachim Protze template <bool ompt>
186082e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_template(ident_t *loc_ref, kmp_int32 gtid,
186182e94a59SJoachim Protze                                               void *frame_address,
186282e94a59SJoachim Protze                                               void *return_address) {
1863467f3924SHansang Bae   kmp_taskdata_t *taskdata = nullptr;
18647cc577a4SJonathan Peyton   kmp_info_t *thread;
18657cc577a4SJonathan Peyton   int thread_finished = FALSE;
18667cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKWAIT);
18677cc577a4SJonathan Peyton 
18687cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(enter): T#%d loc=%p\n", gtid, loc_ref));
1869838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
18707cc577a4SJonathan Peyton 
18717cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
18727cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
18737cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
18747cc577a4SJonathan Peyton 
187582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
187682e94a59SJoachim Protze     ompt_data_t *my_task_data;
187782e94a59SJoachim Protze     ompt_data_t *my_parallel_data;
18787cc577a4SJonathan Peyton 
187982e94a59SJoachim Protze     if (ompt) {
188082e94a59SJoachim Protze       my_task_data = &(taskdata->ompt_task_info.task_data);
188182e94a59SJoachim Protze       my_parallel_data = OMPT_CUR_TEAM_DATA(thread);
188282e94a59SJoachim Protze 
18830e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame.ptr = frame_address;
188482e94a59SJoachim Protze 
188582e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
188682e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
188782e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
188882e94a59SJoachim Protze             my_task_data, return_address);
188982e94a59SJoachim Protze       }
189082e94a59SJoachim Protze 
189182e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
189282e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
189382e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
189482e94a59SJoachim Protze             my_task_data, return_address);
18957cc577a4SJonathan Peyton       }
18967cc577a4SJonathan Peyton     }
189782e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
18987cc577a4SJonathan Peyton 
18993041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
19003041982dSJonathan Peyton // taskwait.
19017cc577a4SJonathan Peyton #if USE_ITT_BUILD
19027cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
19037cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19047cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
19057cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
19067cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
19077cc577a4SJonathan Peyton 
19087cc577a4SJonathan Peyton #if USE_ITT_BUILD
1909838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
1910838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
1911838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
1912838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
19137cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19147cc577a4SJonathan Peyton 
19153041982dSJonathan Peyton     bool must_wait =
19163041982dSJonathan Peyton         !taskdata->td_flags.team_serial && !taskdata->td_flags.final;
19177cc577a4SJonathan Peyton 
19183041982dSJonathan Peyton     must_wait = must_wait || (thread->th.th_task_team != NULL &&
19193041982dSJonathan Peyton                               thread->th.th_task_team->tt.tt_found_proxy_tasks);
19209d64275aSShilei Tian     // If hidden helper thread is encountered, we must enable wait here.
19219d64275aSShilei Tian     must_wait =
19229d64275aSShilei Tian         must_wait ||
19239d64275aSShilei Tian         (__kmp_enable_hidden_helper && thread->th.th_task_team != NULL &&
19249d64275aSShilei Tian          thread->th.th_task_team->tt.tt_hidden_helper_task_encountered);
19259d64275aSShilei Tian 
19263041982dSJonathan Peyton     if (must_wait) {
1927e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
1928e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
192937e2ef54SJonathan Peyton                 &(taskdata->td_incomplete_child_tasks)),
1930c47afcd9SAndrey Churbanov           0U);
193137e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) != 0) {
19323041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
19333041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
19343041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
19357cc577a4SJonathan Peyton       }
19367cc577a4SJonathan Peyton     }
19377cc577a4SJonathan Peyton #if USE_ITT_BUILD
1938838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
1939ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with children
19407cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19417cc577a4SJonathan Peyton 
19423041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
19433041982dSJonathan Peyton     // negated.
19447cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
19457cc577a4SJonathan Peyton 
194682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
194782e94a59SJoachim Protze     if (ompt) {
194882e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
194982e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
195082e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
195182e94a59SJoachim Protze             my_task_data, return_address);
195282e94a59SJoachim Protze       }
195382e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
195482e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
195582e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
195682e94a59SJoachim Protze             my_task_data, return_address);
19577cc577a4SJonathan Peyton       }
19580e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = ompt_data_none;
19597cc577a4SJonathan Peyton     }
196082e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
196182e94a59SJoachim Protze 
19627cc577a4SJonathan Peyton   }
19637cc577a4SJonathan Peyton 
19647cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(exit): T#%d task %p finished waiting, "
19653041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
19663041982dSJonathan Peyton                 gtid, taskdata));
19677cc577a4SJonathan Peyton 
19687cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
19697cc577a4SJonathan Peyton }
19707cc577a4SJonathan Peyton 
1971489cdb78SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
197282e94a59SJoachim Protze OMPT_NOINLINE
197382e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_ompt(ident_t *loc_ref, kmp_int32 gtid,
197482e94a59SJoachim Protze                                           void *frame_address,
197582e94a59SJoachim Protze                                           void *return_address) {
197682e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<true>(loc_ref, gtid, frame_address,
197782e94a59SJoachim Protze                                             return_address);
197882e94a59SJoachim Protze }
1979489cdb78SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
198082e94a59SJoachim Protze 
198182e94a59SJoachim Protze // __kmpc_omp_taskwait: Wait until all tasks generated by the current task are
198282e94a59SJoachim Protze // complete
198382e94a59SJoachim Protze kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid) {
198482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
198582e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
198682e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
19870e0d6cddSJoachim Protze     return __kmpc_omp_taskwait_ompt(loc_ref, gtid, OMPT_GET_FRAME_ADDRESS(0),
198882e94a59SJoachim Protze                                     OMPT_LOAD_RETURN_ADDRESS(gtid));
198982e94a59SJoachim Protze   }
199082e94a59SJoachim Protze #endif
199182e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<false>(loc_ref, gtid, NULL, NULL);
199282e94a59SJoachim Protze }
199382e94a59SJoachim Protze 
19947cc577a4SJonathan Peyton // __kmpc_omp_taskyield: switch to a different task
19953041982dSJonathan Peyton kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid, int end_part) {
1996467f3924SHansang Bae   kmp_taskdata_t *taskdata = NULL;
19977cc577a4SJonathan Peyton   kmp_info_t *thread;
19987cc577a4SJonathan Peyton   int thread_finished = FALSE;
19997cc577a4SJonathan Peyton 
20007cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKYIELD);
20017cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKYIELD);
20027cc577a4SJonathan Peyton 
20037cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(enter): T#%d loc=%p end_part = %d\n",
20047cc577a4SJonathan Peyton                 gtid, loc_ref, end_part));
2005787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
20067cc577a4SJonathan Peyton 
20077cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec && __kmp_init_parallel) {
20087cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
20097cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
20107cc577a4SJonathan Peyton // Should we model this as a task wait or not?
20113041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
20123041982dSJonathan Peyton // taskwait.
20137cc577a4SJonathan Peyton #if USE_ITT_BUILD
20147cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
20157cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20167cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
20177cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
20187cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
20197cc577a4SJonathan Peyton 
20207cc577a4SJonathan Peyton #if USE_ITT_BUILD
2021838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2022838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2023838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2024838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
20257cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20267cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial) {
20277cc577a4SJonathan Peyton       kmp_task_team_t *task_team = thread->th.th_task_team;
20287cc577a4SJonathan Peyton       if (task_team != NULL) {
20297cc577a4SJonathan Peyton         if (KMP_TASKING_ENABLED(task_team)) {
203082e94a59SJoachim Protze #if OMPT_SUPPORT
2031f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
203282e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 1;
203382e94a59SJoachim Protze #endif
20343041982dSJonathan Peyton           __kmp_execute_tasks_32(
2035e0665a90STerry Wilmarth               thread, gtid, (kmp_flag_32<> *)NULL, FALSE,
20363041982dSJonathan Peyton               &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
20373041982dSJonathan Peyton               __kmp_task_stealing_constraint);
203882e94a59SJoachim Protze #if OMPT_SUPPORT
2039f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
204082e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 0;
204182e94a59SJoachim Protze #endif
20427cc577a4SJonathan Peyton         }
20437cc577a4SJonathan Peyton       }
20447cc577a4SJonathan Peyton     }
20457cc577a4SJonathan Peyton #if USE_ITT_BUILD
2046838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
20477cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20487cc577a4SJonathan Peyton 
20493041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
20503041982dSJonathan Peyton     // negated.
20517cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
20527cc577a4SJonathan Peyton   }
20537cc577a4SJonathan Peyton 
20547cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(exit): T#%d task %p resuming, "
20553041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
20563041982dSJonathan Peyton                 gtid, taskdata));
20577cc577a4SJonathan Peyton 
20587cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
20597cc577a4SJonathan Peyton }
20607cc577a4SJonathan Peyton 
206172ba2109SAndrey Churbanov // Task Reduction implementation
2062a8426ac8SJonathan Peyton //
2063a8426ac8SJonathan Peyton // Note: initial implementation didn't take into account the possibility
2064a8426ac8SJonathan Peyton // to specify omp_orig for initializer of the UDR (user defined reduction).
2065a8426ac8SJonathan Peyton // Corrected implementation takes into account the omp_orig object.
2066a8426ac8SJonathan Peyton // Compiler is free to use old implementation if omp_orig is not specified.
206772ba2109SAndrey Churbanov 
2068a8426ac8SJonathan Peyton /*!
2069a8426ac8SJonathan Peyton @ingroup BASIC_TYPES
2070a8426ac8SJonathan Peyton @{
2071a8426ac8SJonathan Peyton */
2072a8426ac8SJonathan Peyton 
2073a8426ac8SJonathan Peyton /*!
2074a8426ac8SJonathan Peyton Flags for special info per task reduction item.
2075a8426ac8SJonathan Peyton */
2076a8426ac8SJonathan Peyton typedef struct kmp_taskred_flags {
2077a8426ac8SJonathan Peyton   /*! 1 - use lazy alloc/init (e.g. big objects, #tasks < #threads) */
2078a8426ac8SJonathan Peyton   unsigned lazy_priv : 1;
207972ba2109SAndrey Churbanov   unsigned reserved31 : 31;
2080a8426ac8SJonathan Peyton } kmp_taskred_flags_t;
208172ba2109SAndrey Churbanov 
2082a8426ac8SJonathan Peyton /*!
2083a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2084a8426ac8SJonathan Peyton */
208572ba2109SAndrey Churbanov typedef struct kmp_task_red_input {
2086a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2087a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item in bytes */
2088a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2089a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (single parameter) */
2090a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2091a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2092a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
209372ba2109SAndrey Churbanov } kmp_task_red_input_t;
209472ba2109SAndrey Churbanov 
209572ba2109SAndrey Churbanov /*!
2096a8426ac8SJonathan Peyton Internal struct for reduction data item related info saved by the library.
209772ba2109SAndrey Churbanov */
2098a8426ac8SJonathan Peyton typedef struct kmp_taskred_data {
2099a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2100a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2101a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2102a8426ac8SJonathan Peyton   void *reduce_priv; /**< array of thread specific items */
2103a8426ac8SJonathan Peyton   void *reduce_pend; /**< end of private data for faster comparison op */
2104a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2105a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2106a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2107a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2108a8426ac8SJonathan Peyton   void *reduce_orig; /**< original item (can be used in UDR initializer) */
2109a8426ac8SJonathan Peyton } kmp_taskred_data_t;
2110a8426ac8SJonathan Peyton 
2111a8426ac8SJonathan Peyton /*!
2112a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2113a8426ac8SJonathan Peyton 
2114a8426ac8SJonathan Peyton New interface: added reduce_orig field to provide omp_orig for UDR initializer.
2115a8426ac8SJonathan Peyton */
2116a8426ac8SJonathan Peyton typedef struct kmp_taskred_input {
2117a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2118a8426ac8SJonathan Peyton   void *reduce_orig; /**< original reduction item used for initialization */
2119a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2120a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2121a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2122a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2123a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2124a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2125a8426ac8SJonathan Peyton } kmp_taskred_input_t;
2126a8426ac8SJonathan Peyton /*!
2127a8426ac8SJonathan Peyton @}
2128a8426ac8SJonathan Peyton */
2129a8426ac8SJonathan Peyton 
2130a8426ac8SJonathan Peyton template <typename T> void __kmp_assign_orig(kmp_taskred_data_t &item, T &src);
2131a8426ac8SJonathan Peyton template <>
2132a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_task_red_input_t>(kmp_taskred_data_t &item,
2133a8426ac8SJonathan Peyton                                              kmp_task_red_input_t &src) {
2134a8426ac8SJonathan Peyton   item.reduce_orig = NULL;
2135a8426ac8SJonathan Peyton }
2136a8426ac8SJonathan Peyton template <>
2137a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_taskred_input_t>(kmp_taskred_data_t &item,
2138a8426ac8SJonathan Peyton                                             kmp_taskred_input_t &src) {
2139a8426ac8SJonathan Peyton   if (src.reduce_orig != NULL) {
2140a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_orig;
2141a8426ac8SJonathan Peyton   } else {
2142a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_shar;
2143a8426ac8SJonathan Peyton   } // non-NULL reduce_orig means new interface used
2144a8426ac8SJonathan Peyton }
2145a8426ac8SJonathan Peyton 
21466b316febSTerry Wilmarth template <typename T> void __kmp_call_init(kmp_taskred_data_t &item, size_t j);
2147a8426ac8SJonathan Peyton template <>
2148a8426ac8SJonathan Peyton void __kmp_call_init<kmp_task_red_input_t>(kmp_taskred_data_t &item,
21496b316febSTerry Wilmarth                                            size_t offset) {
2150a8426ac8SJonathan Peyton   ((void (*)(void *))item.reduce_init)((char *)(item.reduce_priv) + offset);
2151a8426ac8SJonathan Peyton }
2152a8426ac8SJonathan Peyton template <>
2153a8426ac8SJonathan Peyton void __kmp_call_init<kmp_taskred_input_t>(kmp_taskred_data_t &item,
21546b316febSTerry Wilmarth                                           size_t offset) {
2155a8426ac8SJonathan Peyton   ((void (*)(void *, void *))item.reduce_init)(
2156a8426ac8SJonathan Peyton       (char *)(item.reduce_priv) + offset, item.reduce_orig);
2157a8426ac8SJonathan Peyton }
2158a8426ac8SJonathan Peyton 
2159a8426ac8SJonathan Peyton template <typename T>
2160a8426ac8SJonathan Peyton void *__kmp_task_reduction_init(int gtid, int num, T *data) {
2161787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
216272ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
216372ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = thread->th.th_current_task->td_taskgroup;
21646b316febSTerry Wilmarth   kmp_uint32 nth = thread->th.th_team_nproc;
2165a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
216672ba2109SAndrey Churbanov 
216772ba2109SAndrey Churbanov   // check input data just in case
216872ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
216972ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
217072ba2109SAndrey Churbanov   KMP_ASSERT(num > 0);
217172ba2109SAndrey Churbanov   if (nth == 1) {
217272ba2109SAndrey Churbanov     KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, tg %p, exiting nth=1\n",
217372ba2109SAndrey Churbanov                   gtid, tg));
217472ba2109SAndrey Churbanov     return (void *)tg;
217572ba2109SAndrey Churbanov   }
217672ba2109SAndrey Churbanov   KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, taskgroup %p, #items %d\n",
217772ba2109SAndrey Churbanov                 gtid, tg, num));
2178a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2179a8426ac8SJonathan Peyton       thread, num * sizeof(kmp_taskred_data_t));
218072ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
2181a8426ac8SJonathan Peyton     size_t size = data[i].reduce_size - 1;
218272ba2109SAndrey Churbanov     // round the size up to cache line per thread-specific item
218372ba2109SAndrey Churbanov     size += CACHE_LINE - size % CACHE_LINE;
2184a8426ac8SJonathan Peyton     KMP_ASSERT(data[i].reduce_comb != NULL); // combiner is mandatory
2185a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar;
218672ba2109SAndrey Churbanov     arr[i].reduce_size = size;
2187a8426ac8SJonathan Peyton     arr[i].flags = data[i].flags;
2188a8426ac8SJonathan Peyton     arr[i].reduce_comb = data[i].reduce_comb;
2189a8426ac8SJonathan Peyton     arr[i].reduce_init = data[i].reduce_init;
2190a8426ac8SJonathan Peyton     arr[i].reduce_fini = data[i].reduce_fini;
2191a8426ac8SJonathan Peyton     __kmp_assign_orig<T>(arr[i], data[i]);
2192a8426ac8SJonathan Peyton     if (!arr[i].flags.lazy_priv) {
219372ba2109SAndrey Churbanov       // allocate cache-line aligned block and fill it with zeros
219472ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * size);
219572ba2109SAndrey Churbanov       arr[i].reduce_pend = (char *)(arr[i].reduce_priv) + nth * size;
2196a8426ac8SJonathan Peyton       if (arr[i].reduce_init != NULL) {
2197a8426ac8SJonathan Peyton         // initialize all thread-specific items
21986b316febSTerry Wilmarth         for (size_t j = 0; j < nth; ++j) {
2199a8426ac8SJonathan Peyton           __kmp_call_init<T>(arr[i], j * size);
220072ba2109SAndrey Churbanov         }
220172ba2109SAndrey Churbanov       }
220272ba2109SAndrey Churbanov     } else {
220372ba2109SAndrey Churbanov       // only allocate space for pointers now,
2204a8426ac8SJonathan Peyton       // objects will be lazily allocated/initialized if/when requested
2205a8426ac8SJonathan Peyton       // note that __kmp_allocate zeroes the allocated memory
220672ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * sizeof(void *));
220772ba2109SAndrey Churbanov     }
220872ba2109SAndrey Churbanov   }
220972ba2109SAndrey Churbanov   tg->reduce_data = (void *)arr;
221072ba2109SAndrey Churbanov   tg->reduce_num_data = num;
221172ba2109SAndrey Churbanov   return (void *)tg;
221272ba2109SAndrey Churbanov }
221372ba2109SAndrey Churbanov 
221472ba2109SAndrey Churbanov /*!
221572ba2109SAndrey Churbanov @ingroup TASKING
221672ba2109SAndrey Churbanov @param gtid      Global thread ID
2217a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2218a8426ac8SJonathan Peyton @param data      Array of data for reduction
2219a8426ac8SJonathan Peyton @return The taskgroup identifier
2220a8426ac8SJonathan Peyton 
2221a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2222a8426ac8SJonathan Peyton 
2223a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2224a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2225a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2226a8426ac8SJonathan Peyton without help of the runtime library.
2227a8426ac8SJonathan Peyton */
2228a8426ac8SJonathan Peyton void *__kmpc_task_reduction_init(int gtid, int num, void *data) {
2229a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_task_red_input_t *)data);
2230a8426ac8SJonathan Peyton }
2231a8426ac8SJonathan Peyton 
2232a8426ac8SJonathan Peyton /*!
2233a8426ac8SJonathan Peyton @ingroup TASKING
2234a8426ac8SJonathan Peyton @param gtid      Global thread ID
2235a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2236a8426ac8SJonathan Peyton @param data      Array of data for reduction
2237a8426ac8SJonathan Peyton @return The taskgroup identifier
2238a8426ac8SJonathan Peyton 
2239a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2240a8426ac8SJonathan Peyton 
2241a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2242a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2243a8426ac8SJonathan Peyton */
2244a8426ac8SJonathan Peyton void *__kmpc_taskred_init(int gtid, int num, void *data) {
2245a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_taskred_input_t *)data);
2246a8426ac8SJonathan Peyton }
2247a8426ac8SJonathan Peyton 
2248a8426ac8SJonathan Peyton // Copy task reduction data (except for shared pointers).
2249a8426ac8SJonathan Peyton template <typename T>
2250a8426ac8SJonathan Peyton void __kmp_task_reduction_init_copy(kmp_info_t *thr, int num, T *data,
2251a8426ac8SJonathan Peyton                                     kmp_taskgroup_t *tg, void *reduce_data) {
2252a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
2253a8426ac8SJonathan Peyton   KA_TRACE(20, ("__kmp_task_reduction_init_copy: Th %p, init taskgroup %p,"
2254a8426ac8SJonathan Peyton                 " from data %p\n",
2255a8426ac8SJonathan Peyton                 thr, tg, reduce_data));
2256a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2257a8426ac8SJonathan Peyton       thr, num * sizeof(kmp_taskred_data_t));
2258a8426ac8SJonathan Peyton   // threads will share private copies, thunk routines, sizes, flags, etc.:
2259a8426ac8SJonathan Peyton   KMP_MEMCPY(arr, reduce_data, num * sizeof(kmp_taskred_data_t));
2260a8426ac8SJonathan Peyton   for (int i = 0; i < num; ++i) {
2261a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar; // init unique shared pointers
2262a8426ac8SJonathan Peyton   }
2263a8426ac8SJonathan Peyton   tg->reduce_data = (void *)arr;
2264a8426ac8SJonathan Peyton   tg->reduce_num_data = num;
2265a8426ac8SJonathan Peyton }
2266a8426ac8SJonathan Peyton 
2267a8426ac8SJonathan Peyton /*!
2268a8426ac8SJonathan Peyton @ingroup TASKING
2269a8426ac8SJonathan Peyton @param gtid    Global thread ID
227072ba2109SAndrey Churbanov @param tskgrp  The taskgroup ID (optional)
227172ba2109SAndrey Churbanov @param data    Shared location of the item
227272ba2109SAndrey Churbanov @return The pointer to per-thread data
227372ba2109SAndrey Churbanov 
227472ba2109SAndrey Churbanov Get thread-specific location of data item
227572ba2109SAndrey Churbanov */
22763041982dSJonathan Peyton void *__kmpc_task_reduction_get_th_data(int gtid, void *tskgrp, void *data) {
2277787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
227872ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
227972ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
228072ba2109SAndrey Churbanov   if (nth == 1)
228172ba2109SAndrey Churbanov     return data; // nothing to do
228272ba2109SAndrey Churbanov 
228372ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = (kmp_taskgroup_t *)tskgrp;
228472ba2109SAndrey Churbanov   if (tg == NULL)
228572ba2109SAndrey Churbanov     tg = thread->th.th_current_task->td_taskgroup;
228672ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
2287a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)(tg->reduce_data);
228872ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
228972ba2109SAndrey Churbanov   kmp_int32 tid = thread->th.th_info.ds.ds_tid;
229072ba2109SAndrey Churbanov 
229172ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
229272ba2109SAndrey Churbanov   while (tg != NULL) {
229372ba2109SAndrey Churbanov     for (int i = 0; i < num; ++i) {
229472ba2109SAndrey Churbanov       if (!arr[i].flags.lazy_priv) {
229572ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar ||
229672ba2109SAndrey Churbanov             (data >= arr[i].reduce_priv && data < arr[i].reduce_pend))
229772ba2109SAndrey Churbanov           return (char *)(arr[i].reduce_priv) + tid * arr[i].reduce_size;
229872ba2109SAndrey Churbanov       } else {
229972ba2109SAndrey Churbanov         // check shared location first
230072ba2109SAndrey Churbanov         void **p_priv = (void **)(arr[i].reduce_priv);
230172ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar)
230272ba2109SAndrey Churbanov           goto found;
230372ba2109SAndrey Churbanov         // check if we get some thread specific location as parameter
230472ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j)
230572ba2109SAndrey Churbanov           if (data == p_priv[j])
230672ba2109SAndrey Churbanov             goto found;
230772ba2109SAndrey Churbanov         continue; // not found, continue search
230872ba2109SAndrey Churbanov       found:
230972ba2109SAndrey Churbanov         if (p_priv[tid] == NULL) {
231072ba2109SAndrey Churbanov           // allocate thread specific object lazily
231172ba2109SAndrey Churbanov           p_priv[tid] = __kmp_allocate(arr[i].reduce_size);
2312a8426ac8SJonathan Peyton           if (arr[i].reduce_init != NULL) {
2313a8426ac8SJonathan Peyton             if (arr[i].reduce_orig != NULL) { // new interface
2314a8426ac8SJonathan Peyton               ((void (*)(void *, void *))arr[i].reduce_init)(
2315a8426ac8SJonathan Peyton                   p_priv[tid], arr[i].reduce_orig);
2316a8426ac8SJonathan Peyton             } else { // old interface (single parameter)
2317a8426ac8SJonathan Peyton               ((void (*)(void *))arr[i].reduce_init)(p_priv[tid]);
2318a8426ac8SJonathan Peyton             }
231972ba2109SAndrey Churbanov           }
232072ba2109SAndrey Churbanov         }
232172ba2109SAndrey Churbanov         return p_priv[tid];
232272ba2109SAndrey Churbanov       }
232372ba2109SAndrey Churbanov     }
232472ba2109SAndrey Churbanov     tg = tg->parent;
2325a8426ac8SJonathan Peyton     arr = (kmp_taskred_data_t *)(tg->reduce_data);
232672ba2109SAndrey Churbanov     num = tg->reduce_num_data;
232772ba2109SAndrey Churbanov   }
232872ba2109SAndrey Churbanov   KMP_ASSERT2(0, "Unknown task reduction item");
232972ba2109SAndrey Churbanov   return NULL; // ERROR, this line never executed
233072ba2109SAndrey Churbanov }
233172ba2109SAndrey Churbanov 
233272ba2109SAndrey Churbanov // Finalize task reduction.
233372ba2109SAndrey Churbanov // Called from __kmpc_end_taskgroup()
23343041982dSJonathan Peyton static void __kmp_task_reduction_fini(kmp_info_t *th, kmp_taskgroup_t *tg) {
233572ba2109SAndrey Churbanov   kmp_int32 nth = th->th.th_team_nproc;
233672ba2109SAndrey Churbanov   KMP_DEBUG_ASSERT(nth > 1); // should not be called if nth == 1
2337a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)tg->reduce_data;
233872ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
233972ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
234072ba2109SAndrey Churbanov     void *sh_data = arr[i].reduce_shar;
234172ba2109SAndrey Churbanov     void (*f_fini)(void *) = (void (*)(void *))(arr[i].reduce_fini);
23423041982dSJonathan Peyton     void (*f_comb)(void *, void *) =
23433041982dSJonathan Peyton         (void (*)(void *, void *))(arr[i].reduce_comb);
234472ba2109SAndrey Churbanov     if (!arr[i].flags.lazy_priv) {
234572ba2109SAndrey Churbanov       void *pr_data = arr[i].reduce_priv;
234672ba2109SAndrey Churbanov       size_t size = arr[i].reduce_size;
234772ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
234872ba2109SAndrey Churbanov         void *priv_data = (char *)pr_data + j * size;
234972ba2109SAndrey Churbanov         f_comb(sh_data, priv_data); // combine results
235072ba2109SAndrey Churbanov         if (f_fini)
235172ba2109SAndrey Churbanov           f_fini(priv_data); // finalize if needed
235272ba2109SAndrey Churbanov       }
235372ba2109SAndrey Churbanov     } else {
235472ba2109SAndrey Churbanov       void **pr_data = (void **)(arr[i].reduce_priv);
235572ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
235672ba2109SAndrey Churbanov         if (pr_data[j] != NULL) {
235772ba2109SAndrey Churbanov           f_comb(sh_data, pr_data[j]); // combine results
235872ba2109SAndrey Churbanov           if (f_fini)
235972ba2109SAndrey Churbanov             f_fini(pr_data[j]); // finalize if needed
236072ba2109SAndrey Churbanov           __kmp_free(pr_data[j]);
236172ba2109SAndrey Churbanov         }
236272ba2109SAndrey Churbanov       }
236372ba2109SAndrey Churbanov     }
236472ba2109SAndrey Churbanov     __kmp_free(arr[i].reduce_priv);
236572ba2109SAndrey Churbanov   }
236672ba2109SAndrey Churbanov   __kmp_thread_free(th, arr);
236772ba2109SAndrey Churbanov   tg->reduce_data = NULL;
236872ba2109SAndrey Churbanov   tg->reduce_num_data = 0;
236972ba2109SAndrey Churbanov }
2370a8426ac8SJonathan Peyton 
2371a8426ac8SJonathan Peyton // Cleanup task reduction data for parallel or worksharing,
2372a8426ac8SJonathan Peyton // do not touch task private data other threads still working with.
2373a8426ac8SJonathan Peyton // Called from __kmpc_end_taskgroup()
2374a8426ac8SJonathan Peyton static void __kmp_task_reduction_clean(kmp_info_t *th, kmp_taskgroup_t *tg) {
2375a8426ac8SJonathan Peyton   __kmp_thread_free(th, tg->reduce_data);
2376a8426ac8SJonathan Peyton   tg->reduce_data = NULL;
2377a8426ac8SJonathan Peyton   tg->reduce_num_data = 0;
2378a8426ac8SJonathan Peyton }
2379a8426ac8SJonathan Peyton 
2380a8426ac8SJonathan Peyton template <typename T>
2381a8426ac8SJonathan Peyton void *__kmp_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2382a8426ac8SJonathan Peyton                                          int num, T *data) {
2383787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
2384a8426ac8SJonathan Peyton   kmp_info_t *thr = __kmp_threads[gtid];
2385a8426ac8SJonathan Peyton   kmp_int32 nth = thr->th.th_team_nproc;
2386a8426ac8SJonathan Peyton   __kmpc_taskgroup(loc, gtid); // form new taskgroup first
2387a8426ac8SJonathan Peyton   if (nth == 1) {
2388a8426ac8SJonathan Peyton     KA_TRACE(10,
2389a8426ac8SJonathan Peyton              ("__kmpc_reduction_modifier_init: T#%d, tg %p, exiting nth=1\n",
2390a8426ac8SJonathan Peyton               gtid, thr->th.th_current_task->td_taskgroup));
2391a8426ac8SJonathan Peyton     return (void *)thr->th.th_current_task->td_taskgroup;
2392a8426ac8SJonathan Peyton   }
2393a8426ac8SJonathan Peyton   kmp_team_t *team = thr->th.th_team;
2394a8426ac8SJonathan Peyton   void *reduce_data;
2395a8426ac8SJonathan Peyton   kmp_taskgroup_t *tg;
2396a8426ac8SJonathan Peyton   reduce_data = KMP_ATOMIC_LD_RLX(&team->t.t_tg_reduce_data[is_ws]);
2397a8426ac8SJonathan Peyton   if (reduce_data == NULL &&
2398a8426ac8SJonathan Peyton       __kmp_atomic_compare_store(&team->t.t_tg_reduce_data[is_ws], reduce_data,
2399a8426ac8SJonathan Peyton                                  (void *)1)) {
2400a8426ac8SJonathan Peyton     // single thread enters this block to initialize common reduction data
2401a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data == NULL);
2402a8426ac8SJonathan Peyton     // first initialize own data, then make a copy other threads can use
2403a8426ac8SJonathan Peyton     tg = (kmp_taskgroup_t *)__kmp_task_reduction_init<T>(gtid, num, data);
2404a8426ac8SJonathan Peyton     reduce_data = __kmp_thread_malloc(thr, num * sizeof(kmp_taskred_data_t));
2405a8426ac8SJonathan Peyton     KMP_MEMCPY(reduce_data, tg->reduce_data, num * sizeof(kmp_taskred_data_t));
2406a8426ac8SJonathan Peyton     // fini counters should be 0 at this point
2407a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[0]) == 0);
2408a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[1]) == 0);
2409a8426ac8SJonathan Peyton     KMP_ATOMIC_ST_REL(&team->t.t_tg_reduce_data[is_ws], reduce_data);
2410a8426ac8SJonathan Peyton   } else {
2411a8426ac8SJonathan Peyton     while (
2412a8426ac8SJonathan Peyton         (reduce_data = KMP_ATOMIC_LD_ACQ(&team->t.t_tg_reduce_data[is_ws])) ==
2413a8426ac8SJonathan Peyton         (void *)1) { // wait for task reduction initialization
2414a8426ac8SJonathan Peyton       KMP_CPU_PAUSE();
2415a8426ac8SJonathan Peyton     }
2416a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data > (void *)1); // should be valid pointer here
2417a8426ac8SJonathan Peyton     tg = thr->th.th_current_task->td_taskgroup;
2418a8426ac8SJonathan Peyton     __kmp_task_reduction_init_copy<T>(thr, num, data, tg, reduce_data);
2419a8426ac8SJonathan Peyton   }
2420a8426ac8SJonathan Peyton   return tg;
2421a8426ac8SJonathan Peyton }
2422a8426ac8SJonathan Peyton 
2423a8426ac8SJonathan Peyton /*!
2424a8426ac8SJonathan Peyton @ingroup TASKING
2425a8426ac8SJonathan Peyton @param loc       Source location info
2426a8426ac8SJonathan Peyton @param gtid      Global thread ID
2427a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2428a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2429a8426ac8SJonathan Peyton @param data      Array of data for reduction
2430a8426ac8SJonathan Peyton @return The taskgroup identifier
2431a8426ac8SJonathan Peyton 
2432a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2433a8426ac8SJonathan Peyton 
2434a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2435a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2436a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2437a8426ac8SJonathan Peyton without help of the runtime library.
2438a8426ac8SJonathan Peyton */
2439a8426ac8SJonathan Peyton void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2440a8426ac8SJonathan Peyton                                           int num, void *data) {
2441a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2442a8426ac8SJonathan Peyton                                             (kmp_task_red_input_t *)data);
2443a8426ac8SJonathan Peyton }
2444a8426ac8SJonathan Peyton 
2445a8426ac8SJonathan Peyton /*!
2446a8426ac8SJonathan Peyton @ingroup TASKING
2447a8426ac8SJonathan Peyton @param loc       Source location info
2448a8426ac8SJonathan Peyton @param gtid      Global thread ID
2449a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2450a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2451a8426ac8SJonathan Peyton @param data      Array of data for reduction
2452a8426ac8SJonathan Peyton @return The taskgroup identifier
2453a8426ac8SJonathan Peyton 
2454a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2455a8426ac8SJonathan Peyton 
2456a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2457a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2458a8426ac8SJonathan Peyton */
2459a8426ac8SJonathan Peyton void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num,
2460a8426ac8SJonathan Peyton                                    void *data) {
2461a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2462a8426ac8SJonathan Peyton                                             (kmp_taskred_input_t *)data);
2463a8426ac8SJonathan Peyton }
2464a8426ac8SJonathan Peyton 
2465a8426ac8SJonathan Peyton /*!
2466a8426ac8SJonathan Peyton @ingroup TASKING
2467a8426ac8SJonathan Peyton @param loc       Source location info
2468a8426ac8SJonathan Peyton @param gtid      Global thread ID
2469a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2470a8426ac8SJonathan Peyton 
2471a8426ac8SJonathan Peyton Finalize task reduction for a parallel or worksharing.
2472a8426ac8SJonathan Peyton */
2473a8426ac8SJonathan Peyton void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid, int is_ws) {
2474a8426ac8SJonathan Peyton   __kmpc_end_taskgroup(loc, gtid);
2475a8426ac8SJonathan Peyton }
24767cc577a4SJonathan Peyton 
24777cc577a4SJonathan Peyton // __kmpc_taskgroup: Start a new taskgroup
24783041982dSJonathan Peyton void __kmpc_taskgroup(ident_t *loc, int gtid) {
2479787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
24807cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
24817cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
24827cc577a4SJonathan Peyton   kmp_taskgroup_t *tg_new =
24837cc577a4SJonathan Peyton       (kmp_taskgroup_t *)__kmp_thread_malloc(thread, sizeof(kmp_taskgroup_t));
24847cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_taskgroup: T#%d loc=%p group=%p\n", gtid, loc, tg_new));
248537e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->count, 0);
248637e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->cancel_request, cancel_noreq);
24877cc577a4SJonathan Peyton   tg_new->parent = taskdata->td_taskgroup;
248872ba2109SAndrey Churbanov   tg_new->reduce_data = NULL;
248972ba2109SAndrey Churbanov   tg_new->reduce_num_data = 0;
249044575657SPeyton, Jonathan L   tg_new->gomp_data = NULL;
24917cc577a4SJonathan Peyton   taskdata->td_taskgroup = tg_new;
249282e94a59SJoachim Protze 
249382e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2494f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
249582e94a59SJoachim Protze     void *codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
249682e94a59SJoachim Protze     if (!codeptr)
249782e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
249882e94a59SJoachim Protze     kmp_team_t *team = thread->th.th_team;
249982e94a59SJoachim Protze     ompt_data_t my_task_data = taskdata->ompt_task_info.task_data;
250082e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
250182e94a59SJoachim Protze     ompt_data_t my_parallel_data = team->t.ompt_team_info.parallel_data;
250282e94a59SJoachim Protze 
250382e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
250482e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
250582e94a59SJoachim Protze         &(my_task_data), codeptr);
250682e94a59SJoachim Protze   }
250782e94a59SJoachim Protze #endif
25087cc577a4SJonathan Peyton }
25097cc577a4SJonathan Peyton 
25107cc577a4SJonathan Peyton // __kmpc_end_taskgroup: Wait until all tasks generated by the current task
25117cc577a4SJonathan Peyton //                       and its descendants are complete
25123041982dSJonathan Peyton void __kmpc_end_taskgroup(ident_t *loc, int gtid) {
2513787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
25147cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
25157cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
25167cc577a4SJonathan Peyton   kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
25177cc577a4SJonathan Peyton   int thread_finished = FALSE;
25187cc577a4SJonathan Peyton 
251982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
252082e94a59SJoachim Protze   kmp_team_t *team;
252182e94a59SJoachim Protze   ompt_data_t my_task_data;
252282e94a59SJoachim Protze   ompt_data_t my_parallel_data;
2523467f3924SHansang Bae   void *codeptr = nullptr;
2524f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
252582e94a59SJoachim Protze     team = thread->th.th_team;
252682e94a59SJoachim Protze     my_task_data = taskdata->ompt_task_info.task_data;
252782e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
252882e94a59SJoachim Protze     my_parallel_data = team->t.ompt_team_info.parallel_data;
252982e94a59SJoachim Protze     codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
253082e94a59SJoachim Protze     if (!codeptr)
253182e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
253282e94a59SJoachim Protze   }
253382e94a59SJoachim Protze #endif
253482e94a59SJoachim Protze 
25357cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(enter): T#%d loc=%p\n", gtid, loc));
25367cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup != NULL);
25377cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKGROUP);
25387cc577a4SJonathan Peyton 
25397cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
2540a756cb24SAndrey Churbanov     // mark task as waiting not on a barrier
2541a756cb24SAndrey Churbanov     taskdata->td_taskwait_counter += 1;
2542a756cb24SAndrey Churbanov     taskdata->td_taskwait_ident = loc;
2543a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = gtid + 1;
25447cc577a4SJonathan Peyton #if USE_ITT_BUILD
25453041982dSJonathan Peyton     // For ITT the taskgroup wait is similar to taskwait until we need to
25463041982dSJonathan Peyton     // distinguish them
2547838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2548838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2549838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2550838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
25517cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25527cc577a4SJonathan Peyton 
255382e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2554f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
255582e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
255682e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
255782e94a59SJoachim Protze           &(my_task_data), codeptr);
255882e94a59SJoachim Protze     }
255982e94a59SJoachim Protze #endif
256082e94a59SJoachim Protze 
25613041982dSJonathan Peyton     if (!taskdata->td_flags.team_serial ||
25623041982dSJonathan Peyton         (thread->th.th_task_team != NULL &&
2563996baa58SShilei Tian          (thread->th.th_task_team->tt.tt_found_proxy_tasks ||
2564996baa58SShilei Tian           thread->th.th_task_team->tt.tt_hidden_helper_task_encountered))) {
2565e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
2566e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *, &(taskgroup->count)), 0U);
256737e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskgroup->count) != 0) {
25683041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
25693041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
25703041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
25717cc577a4SJonathan Peyton       }
25727cc577a4SJonathan Peyton     }
2573a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread; // end waiting
25747cc577a4SJonathan Peyton 
257582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2576f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
257782e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
257882e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
257982e94a59SJoachim Protze           &(my_task_data), codeptr);
258082e94a59SJoachim Protze     }
258182e94a59SJoachim Protze #endif
258282e94a59SJoachim Protze 
25837cc577a4SJonathan Peyton #if USE_ITT_BUILD
2584838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
2585ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with descendants
25867cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25877cc577a4SJonathan Peyton   }
25887cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup->count == 0);
25897cc577a4SJonathan Peyton 
259044575657SPeyton, Jonathan L   if (taskgroup->reduce_data != NULL &&
259144575657SPeyton, Jonathan L       !taskgroup->gomp_data) { // need to reduce?
2592a8426ac8SJonathan Peyton     int cnt;
2593a8426ac8SJonathan Peyton     void *reduce_data;
2594a8426ac8SJonathan Peyton     kmp_team_t *t = thread->th.th_team;
2595a8426ac8SJonathan Peyton     kmp_taskred_data_t *arr = (kmp_taskred_data_t *)taskgroup->reduce_data;
2596a8426ac8SJonathan Peyton     // check if <priv> data of the first reduction variable shared for the team
2597a8426ac8SJonathan Peyton     void *priv0 = arr[0].reduce_priv;
2598a8426ac8SJonathan Peyton     if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[0])) != NULL &&
2599a8426ac8SJonathan Peyton         ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2600a8426ac8SJonathan Peyton       // finishing task reduction on parallel
2601a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[0]);
2602a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2603a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2604a8426ac8SJonathan Peyton         // finalize task reduction:
260572ba2109SAndrey Churbanov         __kmp_task_reduction_fini(thread, taskgroup);
2606a8426ac8SJonathan Peyton         // cleanup fields in the team structure:
2607a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2608a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2609a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[0], NULL);
2610a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[0], 0);
2611a8426ac8SJonathan Peyton       } else {
2612a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2613a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2614a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2615a8426ac8SJonathan Peyton       }
2616a8426ac8SJonathan Peyton     } else if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[1])) !=
2617a8426ac8SJonathan Peyton                    NULL &&
2618a8426ac8SJonathan Peyton                ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2619a8426ac8SJonathan Peyton       // finishing task reduction on worksharing
2620a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[1]);
2621a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2622a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2623a8426ac8SJonathan Peyton         __kmp_task_reduction_fini(thread, taskgroup);
2624a8426ac8SJonathan Peyton         // cleanup fields in team structure:
2625a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2626a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2627a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[1], NULL);
2628a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[1], 0);
2629a8426ac8SJonathan Peyton       } else {
2630a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2631a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2632a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2633a8426ac8SJonathan Peyton       }
2634a8426ac8SJonathan Peyton     } else {
2635a8426ac8SJonathan Peyton       // finishing task reduction on taskgroup
2636a8426ac8SJonathan Peyton       __kmp_task_reduction_fini(thread, taskgroup);
2637a8426ac8SJonathan Peyton     }
2638a8426ac8SJonathan Peyton   }
26397cc577a4SJonathan Peyton   // Restore parent taskgroup for the current task
26407cc577a4SJonathan Peyton   taskdata->td_taskgroup = taskgroup->parent;
26417cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskgroup);
26427cc577a4SJonathan Peyton 
26433041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(exit): T#%d task %p finished waiting\n",
26443041982dSJonathan Peyton                 gtid, taskdata));
264582e94a59SJoachim Protze 
264682e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2647f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
264882e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
264982e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
265082e94a59SJoachim Protze         &(my_task_data), codeptr);
265182e94a59SJoachim Protze   }
265282e94a59SJoachim Protze #endif
26537cc577a4SJonathan Peyton }
26547cc577a4SJonathan Peyton 
26557cc577a4SJonathan Peyton // __kmp_remove_my_task: remove a task from my own deque
26563041982dSJonathan Peyton static kmp_task_t *__kmp_remove_my_task(kmp_info_t *thread, kmp_int32 gtid,
26573041982dSJonathan Peyton                                         kmp_task_team_t *task_team,
26583041982dSJonathan Peyton                                         kmp_int32 is_constrained) {
26597cc577a4SJonathan Peyton   kmp_task_t *task;
26607cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
26617cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
26627cc577a4SJonathan Peyton   kmp_uint32 tail;
26637cc577a4SJonathan Peyton 
26647cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
26653041982dSJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_threads_data !=
26663041982dSJonathan Peyton                    NULL); // Caller should check this condition
26677cc577a4SJonathan Peyton 
26687cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
26697cc577a4SJonathan Peyton 
26707cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(enter): T#%d ntasks=%d head=%u tail=%u\n",
26713041982dSJonathan Peyton                 gtid, thread_data->td.td_deque_ntasks,
26723041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26737cc577a4SJonathan Peyton 
26747cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26753041982dSJonathan Peyton     KA_TRACE(10,
26763041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #1): T#%d No tasks to remove: "
26773041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26783041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26793041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26807cc577a4SJonathan Peyton     return NULL;
26817cc577a4SJonathan Peyton   }
26827cc577a4SJonathan Peyton 
26837cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
26847cc577a4SJonathan Peyton 
26857cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26867cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
26873041982dSJonathan Peyton     KA_TRACE(10,
26883041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
26893041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26903041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26913041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26927cc577a4SJonathan Peyton     return NULL;
26937cc577a4SJonathan Peyton   }
26947cc577a4SJonathan Peyton 
26953041982dSJonathan Peyton   tail = (thread_data->td.td_deque_tail - 1) &
26963041982dSJonathan Peyton          TASK_DEQUE_MASK(thread_data->td); // Wrap index.
26977cc577a4SJonathan Peyton   taskdata = thread_data->td.td_deque[tail];
26987cc577a4SJonathan Peyton 
2699c3344345SAndrey Churbanov   if (!__kmp_task_is_allowed(gtid, is_constrained, taskdata,
2700c3344345SAndrey Churbanov                              thread->th.th_current_task)) {
2701a756cb24SAndrey Churbanov     // The TSC does not allow to steal victim task
27027cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
2703c3344345SAndrey Churbanov     KA_TRACE(10,
2704c3344345SAndrey Churbanov              ("__kmp_remove_my_task(exit #3): T#%d TSC blocks tail task: "
27053041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27063041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
2707c3344345SAndrey Churbanov               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27087cc577a4SJonathan Peyton     return NULL;
27097cc577a4SJonathan Peyton   }
27107cc577a4SJonathan Peyton 
27117cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = tail;
27127cc577a4SJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks, thread_data->td.td_deque_ntasks - 1);
27137cc577a4SJonathan Peyton 
27147cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
27157cc577a4SJonathan Peyton 
2716c3344345SAndrey Churbanov   KA_TRACE(10, ("__kmp_remove_my_task(exit #4): T#%d task %p removed: "
27173041982dSJonathan Peyton                 "ntasks=%d head=%u tail=%u\n",
27183041982dSJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
27193041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27207cc577a4SJonathan Peyton 
27217cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
27227cc577a4SJonathan Peyton   return task;
27237cc577a4SJonathan Peyton }
27247cc577a4SJonathan Peyton 
27257cc577a4SJonathan Peyton // __kmp_steal_task: remove a task from another thread's deque
27267cc577a4SJonathan Peyton // Assume that calling thread has already checked existence of
27277cc577a4SJonathan Peyton // task_team thread_data before calling this routine.
2728a756cb24SAndrey Churbanov static kmp_task_t *__kmp_steal_task(kmp_info_t *victim_thr, kmp_int32 gtid,
2729c47afcd9SAndrey Churbanov                                     kmp_task_team_t *task_team,
273037e2ef54SJonathan Peyton                                     std::atomic<kmp_int32> *unfinished_threads,
2731c47afcd9SAndrey Churbanov                                     int *thread_finished,
2732c47afcd9SAndrey Churbanov                                     kmp_int32 is_constrained) {
27337cc577a4SJonathan Peyton   kmp_task_t *task;
27347cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
2735a756cb24SAndrey Churbanov   kmp_taskdata_t *current;
27367cc577a4SJonathan Peyton   kmp_thread_data_t *victim_td, *threads_data;
2737c3344345SAndrey Churbanov   kmp_int32 target;
27387cc577a4SJonathan Peyton   kmp_int32 victim_tid;
27397cc577a4SJonathan Peyton 
27407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
27417cc577a4SJonathan Peyton 
27427cc577a4SJonathan Peyton   threads_data = task_team->tt.tt_threads_data;
27437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL); // Caller should check this condition
27447cc577a4SJonathan Peyton 
2745a756cb24SAndrey Churbanov   victim_tid = victim_thr->th.th_info.ds.ds_tid;
27467cc577a4SJonathan Peyton   victim_td = &threads_data[victim_tid];
27477cc577a4SJonathan Peyton 
27483041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_steal_task(enter): T#%d try to steal from T#%d: "
2749a756cb24SAndrey Churbanov                 "task_team=%p ntasks=%d head=%u tail=%u\n",
2750a756cb24SAndrey Churbanov                 gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27513041982dSJonathan Peyton                 victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27523041982dSJonathan Peyton                 victim_td->td.td_deque_tail));
27537cc577a4SJonathan Peyton 
2754a756cb24SAndrey Churbanov   if (TCR_4(victim_td->td.td_deque_ntasks) == 0) {
27553041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #1): T#%d could not steal from T#%d: "
2756a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2757a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27583041982dSJonathan Peyton                   victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27593041982dSJonathan Peyton                   victim_td->td.td_deque_tail));
27607cc577a4SJonathan Peyton     return NULL;
27617cc577a4SJonathan Peyton   }
27627cc577a4SJonathan Peyton 
27637cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&victim_td->td.td_deque_lock);
27647cc577a4SJonathan Peyton 
2765a756cb24SAndrey Churbanov   int ntasks = TCR_4(victim_td->td.td_deque_ntasks);
27667cc577a4SJonathan Peyton   // Check again after we acquire the lock
2767a756cb24SAndrey Churbanov   if (ntasks == 0) {
27687cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
27693041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #2): T#%d could not steal from T#%d: "
2770a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2771a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2772a756cb24SAndrey Churbanov                   victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27737cc577a4SJonathan Peyton     return NULL;
27747cc577a4SJonathan Peyton   }
27757cc577a4SJonathan Peyton 
27767cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(victim_td->td.td_deque != NULL);
2777c3344345SAndrey Churbanov   current = __kmp_threads[gtid]->th.th_current_task;
27787cc577a4SJonathan Peyton   taskdata = victim_td->td.td_deque[victim_td->td.td_deque_head];
2779c3344345SAndrey Churbanov   if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2780c3344345SAndrey Churbanov     // Bump head pointer and Wrap.
2781c3344345SAndrey Churbanov     victim_td->td.td_deque_head =
2782c3344345SAndrey Churbanov         (victim_td->td.td_deque_head + 1) & TASK_DEQUE_MASK(victim_td->td);
2783c3344345SAndrey Churbanov   } else {
2784a756cb24SAndrey Churbanov     if (!task_team->tt.tt_untied_task_encountered) {
2785a756cb24SAndrey Churbanov       // The TSC does not allow to steal victim task
27867cc577a4SJonathan Peyton       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2787c3344345SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #3): T#%d could not steal from "
2788a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2789a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
27907cc577a4SJonathan Peyton                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27917cc577a4SJonathan Peyton       return NULL;
27927cc577a4SJonathan Peyton     }
2793a756cb24SAndrey Churbanov     int i;
2794a756cb24SAndrey Churbanov     // walk through victim's deque trying to steal any task
2795a756cb24SAndrey Churbanov     target = victim_td->td.td_deque_head;
2796c3344345SAndrey Churbanov     taskdata = NULL;
2797a756cb24SAndrey Churbanov     for (i = 1; i < ntasks; ++i) {
2798a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2799a756cb24SAndrey Churbanov       taskdata = victim_td->td.td_deque[target];
2800c3344345SAndrey Churbanov       if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2801c3344345SAndrey Churbanov         break; // found victim task
2802c3344345SAndrey Churbanov       } else {
2803a756cb24SAndrey Churbanov         taskdata = NULL;
2804a756cb24SAndrey Churbanov       }
2805a756cb24SAndrey Churbanov     }
2806a756cb24SAndrey Churbanov     if (taskdata == NULL) {
2807a756cb24SAndrey Churbanov       // No appropriate candidate to steal found
2808a756cb24SAndrey Churbanov       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2809a756cb24SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #4): T#%d could not steal from "
2810a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2811a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2812a756cb24SAndrey Churbanov                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
2813a756cb24SAndrey Churbanov       return NULL;
2814a756cb24SAndrey Churbanov     }
2815a756cb24SAndrey Churbanov     int prev = target;
2816a756cb24SAndrey Churbanov     for (i = i + 1; i < ntasks; ++i) {
2817a756cb24SAndrey Churbanov       // shift remaining tasks in the deque left by 1
2818a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2819a756cb24SAndrey Churbanov       victim_td->td.td_deque[prev] = victim_td->td.td_deque[target];
2820a756cb24SAndrey Churbanov       prev = target;
2821a756cb24SAndrey Churbanov     }
2822baad3f60SJonathan Peyton     KMP_DEBUG_ASSERT(
2823baad3f60SJonathan Peyton         victim_td->td.td_deque_tail ==
2824baad3f60SJonathan Peyton         (kmp_uint32)((target + 1) & TASK_DEQUE_MASK(victim_td->td)));
2825a756cb24SAndrey Churbanov     victim_td->td.td_deque_tail = target; // tail -= 1 (wrapped))
2826a756cb24SAndrey Churbanov   }
28277cc577a4SJonathan Peyton   if (*thread_finished) {
28283041982dSJonathan Peyton     // We need to un-mark this victim as a finished victim.  This must be done
28293041982dSJonathan Peyton     // before releasing the lock, or else other threads (starting with the
283097d000cfStlwilmar     // primary thread victim) might be prematurely released from the barrier!!!
28318b81524cSAndreyChurbanov #if KMP_DEBUG
28328b81524cSAndreyChurbanov     kmp_int32 count =
28338b81524cSAndreyChurbanov #endif
28348b81524cSAndreyChurbanov         KMP_ATOMIC_INC(unfinished_threads);
28353041982dSJonathan Peyton     KA_TRACE(
28363041982dSJonathan Peyton         20,
28373041982dSJonathan Peyton         ("__kmp_steal_task: T#%d inc unfinished_threads to %d: task_team=%p\n",
28387cc577a4SJonathan Peyton          gtid, count + 1, task_team));
28397cc577a4SJonathan Peyton     *thread_finished = FALSE;
28407cc577a4SJonathan Peyton   }
2841a756cb24SAndrey Churbanov   TCW_4(victim_td->td.td_deque_ntasks, ntasks - 1);
28423041982dSJonathan Peyton 
28437cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
28447cc577a4SJonathan Peyton 
28457cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(TASK_stolen);
2846a756cb24SAndrey Churbanov   KA_TRACE(10,
2847a756cb24SAndrey Churbanov            ("__kmp_steal_task(exit #5): T#%d stole task %p from T#%d: "
2848a756cb24SAndrey Churbanov             "task_team=%p ntasks=%d head=%u tail=%u\n",
2849a756cb24SAndrey Churbanov             gtid, taskdata, __kmp_gtid_from_thread(victim_thr), task_team,
2850a756cb24SAndrey Churbanov             ntasks, victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28517cc577a4SJonathan Peyton 
28527cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
28537cc577a4SJonathan Peyton   return task;
28547cc577a4SJonathan Peyton }
28557cc577a4SJonathan Peyton 
28563041982dSJonathan Peyton // __kmp_execute_tasks_template: Choose and execute tasks until either the
28573041982dSJonathan Peyton // condition is statisfied (return true) or there are none left (return false).
28583041982dSJonathan Peyton //
28597cc577a4SJonathan Peyton // final_spin is TRUE if this is the spin at the release barrier.
28607cc577a4SJonathan Peyton // thread_finished indicates whether the thread is finished executing all
28617cc577a4SJonathan Peyton // the tasks it has on its deque, and is at the release barrier.
28627cc577a4SJonathan Peyton // spinner is the location on which to spin.
28637cc577a4SJonathan Peyton // spinner == NULL means only execute a single task and return.
28647cc577a4SJonathan Peyton // checker is the value to check to terminate the spin.
28657cc577a4SJonathan Peyton template <class C>
28663041982dSJonathan Peyton static inline int __kmp_execute_tasks_template(
28673041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, C *flag, int final_spin,
28683041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
28693041982dSJonathan Peyton     kmp_int32 is_constrained) {
28707cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
28717cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
28727cc577a4SJonathan Peyton   kmp_task_t *task;
28737cc577a4SJonathan Peyton   kmp_info_t *other_thread;
28747cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
287537e2ef54SJonathan Peyton   std::atomic<kmp_int32> *unfinished_threads;
2876a756cb24SAndrey Churbanov   kmp_int32 nthreads, victim_tid = -2, use_own_tasks = 1, new_victim = 0,
28773041982dSJonathan Peyton                       tid = thread->th.th_info.ds.ds_tid;
28787cc577a4SJonathan Peyton 
28797cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
28807cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread == __kmp_threads[gtid]);
28817cc577a4SJonathan Peyton 
2882a4a9c48cSJonathan Peyton   if (task_team == NULL || current_task == NULL)
28833041982dSJonathan Peyton     return FALSE;
28847cc577a4SJonathan Peyton 
28853041982dSJonathan Peyton   KA_TRACE(15, ("__kmp_execute_tasks_template(enter): T#%d final_spin=%d "
28863041982dSJonathan Peyton                 "*thread_finished=%d\n",
28877cc577a4SJonathan Peyton                 gtid, final_spin, *thread_finished));
28887cc577a4SJonathan Peyton 
2889581490e7SAndrey Churbanov   thread->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
28907cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
28919d64275aSShilei Tian 
28927cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
28937cc577a4SJonathan Peyton 
28947cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
28957cc577a4SJonathan Peyton   unfinished_threads = &(task_team->tt.tt_unfinished_threads);
28969d64275aSShilei Tian   KMP_DEBUG_ASSERT(nthreads > 1 || task_team->tt.tt_found_proxy_tasks ||
28979d64275aSShilei Tian                    task_team->tt.tt_hidden_helper_task_encountered);
289837e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(*unfinished_threads >= 0);
28997cc577a4SJonathan Peyton 
29003041982dSJonathan Peyton   while (1) { // Outer loop keeps trying to find tasks in case of single thread
29013041982dSJonathan Peyton     // getting tasks from target constructs
29027cc577a4SJonathan Peyton     while (1) { // Inner loop to find a task and execute it
29037cc577a4SJonathan Peyton       task = NULL;
29047cc577a4SJonathan Peyton       if (use_own_tasks) { // check on own queue first
29057cc577a4SJonathan Peyton         task = __kmp_remove_my_task(thread, gtid, task_team, is_constrained);
29067cc577a4SJonathan Peyton       }
29077cc577a4SJonathan Peyton       if ((task == NULL) && (nthreads > 1)) { // Steal a task
29087cc577a4SJonathan Peyton         int asleep = 1;
29097cc577a4SJonathan Peyton         use_own_tasks = 0;
29107cc577a4SJonathan Peyton         // Try to steal from the last place I stole from successfully.
2911a756cb24SAndrey Churbanov         if (victim_tid == -2) { // haven't stolen anything yet
2912a756cb24SAndrey Churbanov           victim_tid = threads_data[tid].td.td_deque_last_stolen;
2913a756cb24SAndrey Churbanov           if (victim_tid !=
29143041982dSJonathan Peyton               -1) // if we have a last stolen from victim, get the thread
2915a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29167cc577a4SJonathan Peyton         }
2917a756cb24SAndrey Churbanov         if (victim_tid != -1) { // found last victim
29187cc577a4SJonathan Peyton           asleep = 0;
29193041982dSJonathan Peyton         } else if (!new_victim) { // no recent steals and we haven't already
29203041982dSJonathan Peyton           // used a new victim; select a random thread
29217cc577a4SJonathan Peyton           do { // Find a different thread to steal work from.
29223041982dSJonathan Peyton             // Pick a random thread. Initial plan was to cycle through all the
29233041982dSJonathan Peyton             // threads, and only return if we tried to steal from every thread,
29243041982dSJonathan Peyton             // and failed.  Arch says that's not such a great idea.
2925a756cb24SAndrey Churbanov             victim_tid = __kmp_get_random(thread) % (nthreads - 1);
2926a756cb24SAndrey Churbanov             if (victim_tid >= tid) {
2927a756cb24SAndrey Churbanov               ++victim_tid; // Adjusts random distribution to exclude self
29287cc577a4SJonathan Peyton             }
29297cc577a4SJonathan Peyton             // Found a potential victim
2930a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29313041982dSJonathan Peyton             // There is a slight chance that __kmp_enable_tasking() did not wake
29323041982dSJonathan Peyton             // up all threads waiting at the barrier.  If victim is sleeping,
29333041982dSJonathan Peyton             // then wake it up. Since we were going to pay the cache miss
29343041982dSJonathan Peyton             // penalty for referencing another thread's kmp_info_t struct
29353041982dSJonathan Peyton             // anyway,
29363041982dSJonathan Peyton             // the check shouldn't cost too much performance at this point. In
29373041982dSJonathan Peyton             // extra barrier mode, tasks do not sleep at the separate tasking
29383041982dSJonathan Peyton             // barrier, so this isn't a problem.
29397cc577a4SJonathan Peyton             asleep = 0;
29407cc577a4SJonathan Peyton             if ((__kmp_tasking_mode == tskm_task_teams) &&
29417cc577a4SJonathan Peyton                 (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) &&
2942c47afcd9SAndrey Churbanov                 (TCR_PTR(CCAST(void *, other_thread->th.th_sleep_loc)) !=
2943c47afcd9SAndrey Churbanov                  NULL)) {
29447cc577a4SJonathan Peyton               asleep = 1;
2945d8e4cb91STerry Wilmarth               __kmp_null_resume_wrapper(other_thread);
29463041982dSJonathan Peyton               // A sleeping thread should not have any tasks on it's queue.
29473041982dSJonathan Peyton               // There is a slight possibility that it resumes, steals a task
29483041982dSJonathan Peyton               // from another thread, which spawns more tasks, all in the time
29493041982dSJonathan Peyton               // that it takes this thread to check => don't write an assertion
29503041982dSJonathan Peyton               // that the victim's queue is empty.  Try stealing from a
29513041982dSJonathan Peyton               // different thread.
29527cc577a4SJonathan Peyton             }
29537cc577a4SJonathan Peyton           } while (asleep);
29547cc577a4SJonathan Peyton         }
29557cc577a4SJonathan Peyton 
29567cc577a4SJonathan Peyton         if (!asleep) {
29577cc577a4SJonathan Peyton           // We have a victim to try to steal from
29583041982dSJonathan Peyton           task = __kmp_steal_task(other_thread, gtid, task_team,
29593041982dSJonathan Peyton                                   unfinished_threads, thread_finished,
29603041982dSJonathan Peyton                                   is_constrained);
29617cc577a4SJonathan Peyton         }
29627cc577a4SJonathan Peyton         if (task != NULL) { // set last stolen to victim
2963a756cb24SAndrey Churbanov           if (threads_data[tid].td.td_deque_last_stolen != victim_tid) {
2964a756cb24SAndrey Churbanov             threads_data[tid].td.td_deque_last_stolen = victim_tid;
29653041982dSJonathan Peyton             // The pre-refactored code did not try more than 1 successful new
29663041982dSJonathan Peyton             // vicitm, unless the last one generated more local tasks;
29673041982dSJonathan Peyton             // new_victim keeps track of this
29687cc577a4SJonathan Peyton             new_victim = 1;
29697cc577a4SJonathan Peyton           }
29703041982dSJonathan Peyton         } else { // No tasks found; unset last_stolen
29717cc577a4SJonathan Peyton           KMP_CHECK_UPDATE(threads_data[tid].td.td_deque_last_stolen, -1);
2972a756cb24SAndrey Churbanov           victim_tid = -2; // no successful victim found
29737cc577a4SJonathan Peyton         }
29747cc577a4SJonathan Peyton       }
29757cc577a4SJonathan Peyton 
29769d64275aSShilei Tian       if (task == NULL)
29779d64275aSShilei Tian         break; // break out of tasking loop
29787cc577a4SJonathan Peyton 
29797cc577a4SJonathan Peyton // Found a task; execute it
29807cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
29817cc577a4SJonathan Peyton       if (__itt_sync_create_ptr || KMP_ITT_DEBUG) {
29823041982dSJonathan Peyton         if (itt_sync_obj == NULL) { // we are at fork barrier where we could not
29833041982dSJonathan Peyton           // get the object reliably
29847cc577a4SJonathan Peyton           itt_sync_obj = __kmp_itt_barrier_object(gtid, bs_forkjoin_barrier);
29857cc577a4SJonathan Peyton         }
29867cc577a4SJonathan Peyton         __kmp_itt_task_starting(itt_sync_obj);
29877cc577a4SJonathan Peyton       }
29887cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY */
29897cc577a4SJonathan Peyton       __kmp_invoke_task(gtid, task, current_task);
29907cc577a4SJonathan Peyton #if USE_ITT_BUILD
29913041982dSJonathan Peyton       if (itt_sync_obj != NULL)
29923041982dSJonathan Peyton         __kmp_itt_task_finished(itt_sync_obj);
29937cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
29943041982dSJonathan Peyton       // If this thread is only partway through the barrier and the condition is
29953041982dSJonathan Peyton       // met, then return now, so that the barrier gather/release pattern can
29963041982dSJonathan Peyton       // proceed. If this thread is in the last spin loop in the barrier,
29973041982dSJonathan Peyton       // waiting to be released, we know that the termination condition will not
299842016791SKazuaki Ishizaki       // be satisfied, so don't waste any cycles checking it.
29997cc577a4SJonathan Peyton       if (flag == NULL || (!final_spin && flag->done_check())) {
30003041982dSJonathan Peyton         KA_TRACE(
30013041982dSJonathan Peyton             15,
30023041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30033041982dSJonathan Peyton              gtid));
30047cc577a4SJonathan Peyton         return TRUE;
30057cc577a4SJonathan Peyton       }
30067cc577a4SJonathan Peyton       if (thread->th.th_task_team == NULL) {
30077cc577a4SJonathan Peyton         break;
30087cc577a4SJonathan Peyton       }
3009e47d32f1SJonathan Peyton       KMP_YIELD(__kmp_library == library_throughput); // Yield before next task
30103041982dSJonathan Peyton       // If execution of a stolen task results in more tasks being placed on our
30113041982dSJonathan Peyton       // run queue, reset use_own_tasks
30127cc577a4SJonathan Peyton       if (!use_own_tasks && TCR_4(threads_data[tid].td.td_deque_ntasks) != 0) {
30133041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d stolen task spawned "
30143041982dSJonathan Peyton                       "other tasks, restart\n",
30153041982dSJonathan Peyton                       gtid));
30167cc577a4SJonathan Peyton         use_own_tasks = 1;
30177cc577a4SJonathan Peyton         new_victim = 0;
30187cc577a4SJonathan Peyton       }
30197cc577a4SJonathan Peyton     }
30207cc577a4SJonathan Peyton 
3021e4b4f994SJonathan Peyton     // The task source has been exhausted. If in final spin loop of barrier,
3022e4b4f994SJonathan Peyton     // check if termination condition is satisfied. The work queue may be empty
3023e4b4f994SJonathan Peyton     // but there might be proxy tasks still executing.
302437e2ef54SJonathan Peyton     if (final_spin &&
3025e4b4f994SJonathan Peyton         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks) == 0) {
30263041982dSJonathan Peyton       // First, decrement the #unfinished threads, if that has not already been
30273041982dSJonathan Peyton       // done.  This decrement might be to the spin location, and result in the
30283041982dSJonathan Peyton       // termination condition being satisfied.
30297cc577a4SJonathan Peyton       if (!*thread_finished) {
30308b81524cSAndreyChurbanov #if KMP_DEBUG
30318b81524cSAndreyChurbanov         kmp_int32 count = -1 +
30328b81524cSAndreyChurbanov #endif
30338b81524cSAndreyChurbanov             KMP_ATOMIC_DEC(unfinished_threads);
30343041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d dec "
30353041982dSJonathan Peyton                       "unfinished_threads to %d task_team=%p\n",
30367cc577a4SJonathan Peyton                       gtid, count, task_team));
30377cc577a4SJonathan Peyton         *thread_finished = TRUE;
30387cc577a4SJonathan Peyton       }
30397cc577a4SJonathan Peyton 
30407cc577a4SJonathan Peyton       // It is now unsafe to reference thread->th.th_team !!!
304197d000cfStlwilmar       // Decrementing task_team->tt.tt_unfinished_threads can allow the primary
30423041982dSJonathan Peyton       // thread to pass through the barrier, where it might reset each thread's
30433041982dSJonathan Peyton       // th.th_team field for the next parallel region. If we can steal more
30443041982dSJonathan Peyton       // work, we know that this has not happened yet.
30457cc577a4SJonathan Peyton       if (flag != NULL && flag->done_check()) {
30463041982dSJonathan Peyton         KA_TRACE(
30473041982dSJonathan Peyton             15,
30483041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30493041982dSJonathan Peyton              gtid));
30507cc577a4SJonathan Peyton         return TRUE;
30517cc577a4SJonathan Peyton       }
30527cc577a4SJonathan Peyton     }
30537cc577a4SJonathan Peyton 
305497d000cfStlwilmar     // If this thread's task team is NULL, primary thread has recognized that
305597d000cfStlwilmar     // there are no more tasks; bail out
30567cc577a4SJonathan Peyton     if (thread->th.th_task_team == NULL) {
30573041982dSJonathan Peyton       KA_TRACE(15,
30583041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d no more tasks\n", gtid));
30597cc577a4SJonathan Peyton       return FALSE;
30607cc577a4SJonathan Peyton     }
30617cc577a4SJonathan Peyton 
30623041982dSJonathan Peyton     // We could be getting tasks from target constructs; if this is the only
30633041982dSJonathan Peyton     // thread, keep trying to execute tasks from own queue
30649d64275aSShilei Tian     if (nthreads == 1 &&
30659d64275aSShilei Tian         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks))
30667cc577a4SJonathan Peyton       use_own_tasks = 1;
3067e4b4f994SJonathan Peyton     else {
30683041982dSJonathan Peyton       KA_TRACE(15,
30693041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d can't find work\n", gtid));
30707cc577a4SJonathan Peyton       return FALSE;
30717cc577a4SJonathan Peyton     }
30727cc577a4SJonathan Peyton   }
30737cc577a4SJonathan Peyton }
30747cc577a4SJonathan Peyton 
3075e0665a90STerry Wilmarth template <bool C, bool S>
30763041982dSJonathan Peyton int __kmp_execute_tasks_32(
3077e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32<C, S> *flag, int final_spin,
30783041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30793041982dSJonathan Peyton     kmp_int32 is_constrained) {
30803041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30813041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30823041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30837cc577a4SJonathan Peyton }
30847cc577a4SJonathan Peyton 
3085e0665a90STerry Wilmarth template <bool C, bool S>
30863041982dSJonathan Peyton int __kmp_execute_tasks_64(
3087e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64<C, S> *flag, int final_spin,
30883041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30893041982dSJonathan Peyton     kmp_int32 is_constrained) {
30903041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30913041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30923041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30937cc577a4SJonathan Peyton }
30947cc577a4SJonathan Peyton 
3095d8e4cb91STerry Wilmarth template <bool C, bool S>
3096d8e4cb91STerry Wilmarth int __kmp_atomic_execute_tasks_64(
3097d8e4cb91STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_atomic_flag_64<C, S> *flag,
3098d8e4cb91STerry Wilmarth     int final_spin, int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
3099d8e4cb91STerry Wilmarth     kmp_int32 is_constrained) {
3100d8e4cb91STerry Wilmarth   return __kmp_execute_tasks_template(
3101d8e4cb91STerry Wilmarth       thread, gtid, flag, final_spin,
3102d8e4cb91STerry Wilmarth       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
3103d8e4cb91STerry Wilmarth }
3104d8e4cb91STerry Wilmarth 
31053041982dSJonathan Peyton int __kmp_execute_tasks_oncore(
31063041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
31073041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31083041982dSJonathan Peyton     kmp_int32 is_constrained) {
31093041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31103041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31113041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31127cc577a4SJonathan Peyton }
31137cc577a4SJonathan Peyton 
3114e0665a90STerry Wilmarth template int
3115e0665a90STerry Wilmarth __kmp_execute_tasks_32<false, false>(kmp_info_t *, kmp_int32,
3116e0665a90STerry Wilmarth                                      kmp_flag_32<false, false> *, int,
3117e0665a90STerry Wilmarth                                      int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3118e0665a90STerry Wilmarth 
3119e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<false, true>(kmp_info_t *, kmp_int32,
3120e0665a90STerry Wilmarth                                                  kmp_flag_64<false, true> *,
3121e0665a90STerry Wilmarth                                                  int,
3122e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3123e0665a90STerry Wilmarth                                                  kmp_int32);
3124e0665a90STerry Wilmarth 
3125e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<true, false>(kmp_info_t *, kmp_int32,
3126e0665a90STerry Wilmarth                                                  kmp_flag_64<true, false> *,
3127e0665a90STerry Wilmarth                                                  int,
3128e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3129e0665a90STerry Wilmarth                                                  kmp_int32);
3130e0665a90STerry Wilmarth 
3131d8e4cb91STerry Wilmarth template int __kmp_atomic_execute_tasks_64<false, true>(
3132d8e4cb91STerry Wilmarth     kmp_info_t *, kmp_int32, kmp_atomic_flag_64<false, true> *, int,
3133d8e4cb91STerry Wilmarth     int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3134d8e4cb91STerry Wilmarth 
3135d8e4cb91STerry Wilmarth template int __kmp_atomic_execute_tasks_64<true, false>(
3136d8e4cb91STerry Wilmarth     kmp_info_t *, kmp_int32, kmp_atomic_flag_64<true, false> *, int,
3137d8e4cb91STerry Wilmarth     int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3138d8e4cb91STerry Wilmarth 
31397cc577a4SJonathan Peyton // __kmp_enable_tasking: Allocate task team and resume threads sleeping at the
31407cc577a4SJonathan Peyton // next barrier so they can assist in executing enqueued tasks.
31417cc577a4SJonathan Peyton // First thread in allocates the task team atomically.
31423041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
31433041982dSJonathan Peyton                                  kmp_info_t *this_thr) {
31447cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
31457cc577a4SJonathan Peyton   int nthreads, i, is_init_thread;
31467cc577a4SJonathan Peyton 
31477cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(enter): T#%d\n",
31487cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31497cc577a4SJonathan Peyton 
31507cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
31517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr->th.th_team != NULL);
31527cc577a4SJonathan Peyton 
31537cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
31547cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 0);
31557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads == this_thr->th.th_team->t.t_nproc);
31567cc577a4SJonathan Peyton 
31577cc577a4SJonathan Peyton   // Allocate or increase the size of threads_data if necessary
31587cc577a4SJonathan Peyton   is_init_thread = __kmp_realloc_task_threads_data(this_thr, task_team);
31597cc577a4SJonathan Peyton 
31607cc577a4SJonathan Peyton   if (!is_init_thread) {
31617cc577a4SJonathan Peyton     // Some other thread already set up the array.
31623041982dSJonathan Peyton     KA_TRACE(
31633041982dSJonathan Peyton         20,
31643041982dSJonathan Peyton         ("__kmp_enable_tasking(exit): T#%d: threads array already set up.\n",
31657cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr)));
31667cc577a4SJonathan Peyton     return;
31677cc577a4SJonathan Peyton   }
31687cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
31697cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
31707cc577a4SJonathan Peyton 
31719b8bb323SJonathan Peyton   if (__kmp_tasking_mode == tskm_task_teams &&
31723041982dSJonathan Peyton       (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME)) {
31737cc577a4SJonathan Peyton     // Release any threads sleeping at the barrier, so that they can steal
31747cc577a4SJonathan Peyton     // tasks and execute them.  In extra barrier mode, tasks do not sleep
31757cc577a4SJonathan Peyton     // at the separate tasking barrier, so this isn't a problem.
31767cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
3177d8e4cb91STerry Wilmarth       void *sleep_loc;
31787cc577a4SJonathan Peyton       kmp_info_t *thread = threads_data[i].td.td_thr;
31797cc577a4SJonathan Peyton 
31807cc577a4SJonathan Peyton       if (i == this_thr->th.th_info.ds.ds_tid) {
31817cc577a4SJonathan Peyton         continue;
31827cc577a4SJonathan Peyton       }
31837cc577a4SJonathan Peyton       // Since we haven't locked the thread's suspend mutex lock at this
31847cc577a4SJonathan Peyton       // point, there is a small window where a thread might be putting
31857cc577a4SJonathan Peyton       // itself to sleep, but hasn't set the th_sleep_loc field yet.
31867cc577a4SJonathan Peyton       // To work around this, __kmp_execute_tasks_template() periodically checks
31873041982dSJonathan Peyton       // see if other threads are sleeping (using the same random mechanism that
31883041982dSJonathan Peyton       // is used for task stealing) and awakens them if they are.
3189c47afcd9SAndrey Churbanov       if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3190c47afcd9SAndrey Churbanov           NULL) {
31917cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d waking up thread T#%d\n",
31927cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31937cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
3194d8e4cb91STerry Wilmarth         __kmp_null_resume_wrapper(thread);
31953041982dSJonathan Peyton       } else {
31967cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d don't wake up thread T#%d\n",
31977cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
31987cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31997cc577a4SJonathan Peyton       }
32007cc577a4SJonathan Peyton     }
32017cc577a4SJonathan Peyton   }
32027cc577a4SJonathan Peyton 
32037cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(exit): T#%d\n",
32047cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
32057cc577a4SJonathan Peyton }
32067cc577a4SJonathan Peyton 
32077cc577a4SJonathan Peyton /* // TODO: Check the comment consistency
32087cc577a4SJonathan Peyton  * Utility routines for "task teams".  A task team (kmp_task_t) is kind of
32097cc577a4SJonathan Peyton  * like a shadow of the kmp_team_t data struct, with a different lifetime.
32107cc577a4SJonathan Peyton  * After a child * thread checks into a barrier and calls __kmp_release() from
32117cc577a4SJonathan Peyton  * the particular variant of __kmp_<barrier_kind>_barrier_gather(), it can no
32127cc577a4SJonathan Peyton  * longer assume that the kmp_team_t structure is intact (at any moment, the
321397d000cfStlwilmar  * primary thread may exit the barrier code and free the team data structure,
32147cc577a4SJonathan Peyton  * and return the threads to the thread pool).
32157cc577a4SJonathan Peyton  *
3216ed5fe645SKelvin Li  * This does not work with the tasking code, as the thread is still
32177cc577a4SJonathan Peyton  * expected to participate in the execution of any tasks that may have been
32187cc577a4SJonathan Peyton  * spawned my a member of the team, and the thread still needs access to all
32197cc577a4SJonathan Peyton  * to each thread in the team, so that it can steal work from it.
32207cc577a4SJonathan Peyton  *
32217cc577a4SJonathan Peyton  * Enter the existence of the kmp_task_team_t struct.  It employs a reference
322297d000cfStlwilmar  * counting mechanism, and is allocated by the primary thread before calling
32237cc577a4SJonathan Peyton  * __kmp_<barrier_kind>_release, and then is release by the last thread to
32247cc577a4SJonathan Peyton  * exit __kmp_<barrier_kind>_release at the next barrier.  I.e. the lifetimes
32257cc577a4SJonathan Peyton  * of the kmp_task_team_t structs for consecutive barriers can overlap
322697d000cfStlwilmar  * (and will, unless the primary thread is the last thread to exit the barrier
3227e4b4f994SJonathan Peyton  * release phase, which is not typical). The existence of such a struct is
3228e4b4f994SJonathan Peyton  * useful outside the context of tasking.
32297cc577a4SJonathan Peyton  *
32307cc577a4SJonathan Peyton  * We currently use the existence of the threads array as an indicator that
32317cc577a4SJonathan Peyton  * tasks were spawned since the last barrier.  If the structure is to be
32327cc577a4SJonathan Peyton  * useful outside the context of tasking, then this will have to change, but
323342016791SKazuaki Ishizaki  * not setting the field minimizes the performance impact of tasking on
32347cc577a4SJonathan Peyton  * barriers, when no explicit tasks were spawned (pushed, actually).
32357cc577a4SJonathan Peyton  */
32367cc577a4SJonathan Peyton 
32373041982dSJonathan Peyton static kmp_task_team_t *__kmp_free_task_teams =
32383041982dSJonathan Peyton     NULL; // Free list for task_team data structures
32397cc577a4SJonathan Peyton // Lock for task team data structures
3240eaa9e40cSJonathan Peyton kmp_bootstrap_lock_t __kmp_task_team_lock =
32413041982dSJonathan Peyton     KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_task_team_lock);
32427cc577a4SJonathan Peyton 
32437cc577a4SJonathan Peyton // __kmp_alloc_task_deque:
32447cc577a4SJonathan Peyton // Allocates a task deque for a particular thread, and initialize the necessary
32457cc577a4SJonathan Peyton // data structures relating to the deque.  This only happens once per thread
32463041982dSJonathan Peyton // per task team since task teams are recycled. No lock is needed during
32473041982dSJonathan Peyton // allocation since each thread allocates its own deque.
32483041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
32493041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data) {
32507cc577a4SJonathan Peyton   __kmp_init_bootstrap_lock(&thread_data->td.td_deque_lock);
32517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque == NULL);
32527cc577a4SJonathan Peyton 
32537cc577a4SJonathan Peyton   // Initialize last stolen task field to "none"
32547cc577a4SJonathan Peyton   thread_data->td.td_deque_last_stolen = -1;
32557cc577a4SJonathan Peyton 
32567cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == 0);
32577cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_head == 0);
32587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_tail == 0);
32597cc577a4SJonathan Peyton 
32603041982dSJonathan Peyton   KE_TRACE(
32613041982dSJonathan Peyton       10,
32623041982dSJonathan Peyton       ("__kmp_alloc_task_deque: T#%d allocating deque[%d] for thread_data %p\n",
32637cc577a4SJonathan Peyton        __kmp_gtid_from_thread(thread), INITIAL_TASK_DEQUE_SIZE, thread_data));
32647cc577a4SJonathan Peyton   // Allocate space for task deque, and zero the deque
32657cc577a4SJonathan Peyton   // Cannot use __kmp_thread_calloc() because threads not around for
32667cc577a4SJonathan Peyton   // kmp_reap_task_team( ).
32673041982dSJonathan Peyton   thread_data->td.td_deque = (kmp_taskdata_t **)__kmp_allocate(
32683041982dSJonathan Peyton       INITIAL_TASK_DEQUE_SIZE * sizeof(kmp_taskdata_t *));
32697cc577a4SJonathan Peyton   thread_data->td.td_deque_size = INITIAL_TASK_DEQUE_SIZE;
32707cc577a4SJonathan Peyton }
32717cc577a4SJonathan Peyton 
32727cc577a4SJonathan Peyton // __kmp_free_task_deque:
32733041982dSJonathan Peyton // Deallocates a task deque for a particular thread. Happens at library
32743041982dSJonathan Peyton // deallocation so don't need to reset all thread data fields.
32753041982dSJonathan Peyton static void __kmp_free_task_deque(kmp_thread_data_t *thread_data) {
32767cc577a4SJonathan Peyton   if (thread_data->td.td_deque != NULL) {
32771b536724SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
32787cc577a4SJonathan Peyton     TCW_4(thread_data->td.td_deque_ntasks, 0);
32797cc577a4SJonathan Peyton     __kmp_free(thread_data->td.td_deque);
32807cc577a4SJonathan Peyton     thread_data->td.td_deque = NULL;
32817cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
32821b536724SJonathan Peyton   }
32837cc577a4SJonathan Peyton 
32847cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
32857cc577a4SJonathan Peyton   // GEH: Figure out what to do here for td_susp_tied_tasks
32867cc577a4SJonathan Peyton   if (thread_data->td.td_susp_tied_tasks.ts_entries != TASK_STACK_EMPTY) {
32877cc577a4SJonathan Peyton     __kmp_free_task_stack(__kmp_thread_from_gtid(gtid), thread_data);
32887cc577a4SJonathan Peyton   }
32897cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
32907cc577a4SJonathan Peyton }
32917cc577a4SJonathan Peyton 
32927cc577a4SJonathan Peyton // __kmp_realloc_task_threads_data:
32933041982dSJonathan Peyton // Allocates a threads_data array for a task team, either by allocating an
32943041982dSJonathan Peyton // initial array or enlarging an existing array.  Only the first thread to get
32954c6a098aSKazuaki Ishizaki // the lock allocs or enlarges the array and re-initializes the array elements.
32967cc577a4SJonathan Peyton // That thread returns "TRUE", the rest return "FALSE".
32977cc577a4SJonathan Peyton // Assumes that the new array size is given by task_team -> tt.tt_nproc.
32987cc577a4SJonathan Peyton // The current size is given by task_team -> tt.tt_max_threads.
32993041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
33003041982dSJonathan Peyton                                            kmp_task_team_t *task_team) {
33017cc577a4SJonathan Peyton   kmp_thread_data_t **threads_data_p;
33027cc577a4SJonathan Peyton   kmp_int32 nthreads, maxthreads;
33037cc577a4SJonathan Peyton   int is_init_thread = FALSE;
33047cc577a4SJonathan Peyton 
33057cc577a4SJonathan Peyton   if (TCR_4(task_team->tt.tt_found_tasks)) {
33067cc577a4SJonathan Peyton     // Already reallocated and initialized.
33077cc577a4SJonathan Peyton     return FALSE;
33087cc577a4SJonathan Peyton   }
33097cc577a4SJonathan Peyton 
33107cc577a4SJonathan Peyton   threads_data_p = &task_team->tt.tt_threads_data;
33117cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
33127cc577a4SJonathan Peyton   maxthreads = task_team->tt.tt_max_threads;
33137cc577a4SJonathan Peyton 
33143041982dSJonathan Peyton   // All threads must lock when they encounter the first task of the implicit
33153041982dSJonathan Peyton   // task region to make sure threads_data fields are (re)initialized before
33163041982dSJonathan Peyton   // used.
33177cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
33187cc577a4SJonathan Peyton 
33197cc577a4SJonathan Peyton   if (!TCR_4(task_team->tt.tt_found_tasks)) {
33207cc577a4SJonathan Peyton     // first thread to enable tasking
33217cc577a4SJonathan Peyton     kmp_team_t *team = thread->th.th_team;
33227cc577a4SJonathan Peyton     int i;
33237cc577a4SJonathan Peyton 
33247cc577a4SJonathan Peyton     is_init_thread = TRUE;
33257cc577a4SJonathan Peyton     if (maxthreads < nthreads) {
33267cc577a4SJonathan Peyton 
33277cc577a4SJonathan Peyton       if (*threads_data_p != NULL) {
33287cc577a4SJonathan Peyton         kmp_thread_data_t *old_data = *threads_data_p;
33297cc577a4SJonathan Peyton         kmp_thread_data_t *new_data = NULL;
33307cc577a4SJonathan Peyton 
33313041982dSJonathan Peyton         KE_TRACE(
33323041982dSJonathan Peyton             10,
33333041982dSJonathan Peyton             ("__kmp_realloc_task_threads_data: T#%d reallocating "
33347cc577a4SJonathan Peyton              "threads data for task_team %p, new_size = %d, old_size = %d\n",
33353041982dSJonathan Peyton              __kmp_gtid_from_thread(thread), task_team, nthreads, maxthreads));
33367cc577a4SJonathan Peyton         // Reallocate threads_data to have more elements than current array
33377cc577a4SJonathan Peyton         // Cannot use __kmp_thread_realloc() because threads not around for
33387cc577a4SJonathan Peyton         // kmp_reap_task_team( ).  Note all new array entries are initialized
33397cc577a4SJonathan Peyton         // to zero by __kmp_allocate().
33403041982dSJonathan Peyton         new_data = (kmp_thread_data_t *)__kmp_allocate(
33413041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33427cc577a4SJonathan Peyton         // copy old data to new data
33437cc577a4SJonathan Peyton         KMP_MEMCPY_S((void *)new_data, nthreads * sizeof(kmp_thread_data_t),
334471483f2dSAndrey Churbanov                      (void *)old_data, maxthreads * sizeof(kmp_thread_data_t));
33457cc577a4SJonathan Peyton 
33467cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33477cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33487cc577a4SJonathan Peyton         for (i = maxthreads; i < nthreads; i++) {
33497cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33507cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33517cc577a4SJonathan Peyton         }
33527cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33537cc577a4SJonathan Peyton        // Install the new data and free the old data
33547cc577a4SJonathan Peyton         (*threads_data_p) = new_data;
33557cc577a4SJonathan Peyton         __kmp_free(old_data);
33563041982dSJonathan Peyton       } else {
33577cc577a4SJonathan Peyton         KE_TRACE(10, ("__kmp_realloc_task_threads_data: T#%d allocating "
33587cc577a4SJonathan Peyton                       "threads data for task_team %p, size = %d\n",
33597cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread), task_team, nthreads));
33607cc577a4SJonathan Peyton         // Make the initial allocate for threads_data array, and zero entries
33617cc577a4SJonathan Peyton         // Cannot use __kmp_thread_calloc() because threads not around for
33627cc577a4SJonathan Peyton         // kmp_reap_task_team( ).
33633041982dSJonathan Peyton         *threads_data_p = (kmp_thread_data_t *)__kmp_allocate(
33643041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33657cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33667cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33677cc577a4SJonathan Peyton         for (i = 0; i < nthreads; i++) {
33687cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33697cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33707cc577a4SJonathan Peyton         }
33717cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33727cc577a4SJonathan Peyton       }
33737cc577a4SJonathan Peyton       task_team->tt.tt_max_threads = nthreads;
33743041982dSJonathan Peyton     } else {
33757cc577a4SJonathan Peyton       // If array has (more than) enough elements, go ahead and use it
33767cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(*threads_data_p != NULL);
33777cc577a4SJonathan Peyton     }
33787cc577a4SJonathan Peyton 
33797cc577a4SJonathan Peyton     // initialize threads_data pointers back to thread_info structures
33807cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
33817cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33827cc577a4SJonathan Peyton       thread_data->td.td_thr = team->t.t_threads[i];
33837cc577a4SJonathan Peyton 
33847cc577a4SJonathan Peyton       if (thread_data->td.td_deque_last_stolen >= nthreads) {
33857cc577a4SJonathan Peyton         // The last stolen field survives across teams / barrier, and the number
33867cc577a4SJonathan Peyton         // of threads may have changed.  It's possible (likely?) that a new
33873041982dSJonathan Peyton         // parallel region will exhibit the same behavior as previous region.
33887cc577a4SJonathan Peyton         thread_data->td.td_deque_last_stolen = -1;
33897cc577a4SJonathan Peyton       }
33907cc577a4SJonathan Peyton     }
33917cc577a4SJonathan Peyton 
33927cc577a4SJonathan Peyton     KMP_MB();
33937cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_tasks, TRUE);
33947cc577a4SJonathan Peyton   }
33957cc577a4SJonathan Peyton 
33967cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
33977cc577a4SJonathan Peyton   return is_init_thread;
33987cc577a4SJonathan Peyton }
33997cc577a4SJonathan Peyton 
34007cc577a4SJonathan Peyton // __kmp_free_task_threads_data:
34017cc577a4SJonathan Peyton // Deallocates a threads_data array for a task team, including any attached
34027cc577a4SJonathan Peyton // tasking deques.  Only occurs at library shutdown.
34033041982dSJonathan Peyton static void __kmp_free_task_threads_data(kmp_task_team_t *task_team) {
34047cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
34057cc577a4SJonathan Peyton   if (task_team->tt.tt_threads_data != NULL) {
34067cc577a4SJonathan Peyton     int i;
34077cc577a4SJonathan Peyton     for (i = 0; i < task_team->tt.tt_max_threads; i++) {
34087cc577a4SJonathan Peyton       __kmp_free_task_deque(&task_team->tt.tt_threads_data[i]);
34097cc577a4SJonathan Peyton     }
34107cc577a4SJonathan Peyton     __kmp_free(task_team->tt.tt_threads_data);
34117cc577a4SJonathan Peyton     task_team->tt.tt_threads_data = NULL;
34127cc577a4SJonathan Peyton   }
34137cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
34147cc577a4SJonathan Peyton }
34157cc577a4SJonathan Peyton 
34167cc577a4SJonathan Peyton // __kmp_allocate_task_team:
34177cc577a4SJonathan Peyton // Allocates a task team associated with a specific team, taking it from
34183041982dSJonathan Peyton // the global task team free list if possible.  Also initializes data
34193041982dSJonathan Peyton // structures.
34203041982dSJonathan Peyton static kmp_task_team_t *__kmp_allocate_task_team(kmp_info_t *thread,
34213041982dSJonathan Peyton                                                  kmp_team_t *team) {
34227cc577a4SJonathan Peyton   kmp_task_team_t *task_team = NULL;
34237cc577a4SJonathan Peyton   int nthreads;
34247cc577a4SJonathan Peyton 
34257cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d entering; team = %p\n",
34267cc577a4SJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), team));
34277cc577a4SJonathan Peyton 
34287cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
34297cc577a4SJonathan Peyton     // Take a task team from the task team pool
34307cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34317cc577a4SJonathan Peyton     if (__kmp_free_task_teams != NULL) {
34327cc577a4SJonathan Peyton       task_team = __kmp_free_task_teams;
34337cc577a4SJonathan Peyton       TCW_PTR(__kmp_free_task_teams, task_team->tt.tt_next);
34347cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
34357cc577a4SJonathan Peyton     }
34367cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34377cc577a4SJonathan Peyton   }
34387cc577a4SJonathan Peyton 
34397cc577a4SJonathan Peyton   if (task_team == NULL) {
34407cc577a4SJonathan Peyton     KE_TRACE(10, ("__kmp_allocate_task_team: T#%d allocating "
34417cc577a4SJonathan Peyton                   "task team for team %p\n",
34427cc577a4SJonathan Peyton                   __kmp_gtid_from_thread(thread), team));
3443ffd8f009SAndreyChurbanov     // Allocate a new task team if one is not available. Cannot use
3444ffd8f009SAndreyChurbanov     // __kmp_thread_malloc because threads not around for kmp_reap_task_team.
34457cc577a4SJonathan Peyton     task_team = (kmp_task_team_t *)__kmp_allocate(sizeof(kmp_task_team_t));
34467cc577a4SJonathan Peyton     __kmp_init_bootstrap_lock(&task_team->tt.tt_threads_lock);
3447ffd8f009SAndreyChurbanov #if USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG
3448ffd8f009SAndreyChurbanov     // suppress race conditions detection on synchronization flags in debug mode
3449ffd8f009SAndreyChurbanov     // this helps to analyze library internals eliminating false positives
3450ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(
3451ffd8f009SAndreyChurbanov         __itt_suppress_range, __itt_suppress_threading_errors,
3452ffd8f009SAndreyChurbanov         &task_team->tt.tt_found_tasks, sizeof(task_team->tt.tt_found_tasks));
3453ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(__itt_suppress_range,
3454ffd8f009SAndreyChurbanov                               __itt_suppress_threading_errors,
3455ffd8f009SAndreyChurbanov                               CCAST(kmp_uint32 *, &task_team->tt.tt_active),
3456ffd8f009SAndreyChurbanov                               sizeof(task_team->tt.tt_active));
3457ffd8f009SAndreyChurbanov #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG */
3458ffd8f009SAndreyChurbanov     // Note: __kmp_allocate zeroes returned memory, othewise we would need:
34593041982dSJonathan Peyton     // task_team->tt.tt_threads_data = NULL;
34607cc577a4SJonathan Peyton     // task_team->tt.tt_max_threads = 0;
34617cc577a4SJonathan Peyton     // task_team->tt.tt_next = NULL;
34627cc577a4SJonathan Peyton   }
34637cc577a4SJonathan Peyton 
34647cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_tasks, FALSE);
34657cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
34667cc577a4SJonathan Peyton   task_team->tt.tt_nproc = nthreads = team->t.t_nproc;
34677cc577a4SJonathan Peyton 
346837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads, nthreads);
34699d64275aSShilei Tian   TCW_4(task_team->tt.tt_hidden_helper_task_encountered, FALSE);
34707cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_active, TRUE);
34717cc577a4SJonathan Peyton 
34723041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d exiting; task_team = %p "
34733041982dSJonathan Peyton                 "unfinished_threads init'd to %d\n",
34743041982dSJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), task_team,
347537e2ef54SJonathan Peyton                 KMP_ATOMIC_LD_RLX(&task_team->tt.tt_unfinished_threads)));
34767cc577a4SJonathan Peyton   return task_team;
34777cc577a4SJonathan Peyton }
34787cc577a4SJonathan Peyton 
34797cc577a4SJonathan Peyton // __kmp_free_task_team:
34807cc577a4SJonathan Peyton // Frees the task team associated with a specific thread, and adds it
34817cc577a4SJonathan Peyton // to the global task team free list.
34823041982dSJonathan Peyton void __kmp_free_task_team(kmp_info_t *thread, kmp_task_team_t *task_team) {
34837cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_free_task_team: T#%d task_team = %p\n",
34847cc577a4SJonathan Peyton                 thread ? __kmp_gtid_from_thread(thread) : -1, task_team));
34857cc577a4SJonathan Peyton 
34867cc577a4SJonathan Peyton   // Put task team back on free list
34877cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34887cc577a4SJonathan Peyton 
34897cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_next == NULL);
34907cc577a4SJonathan Peyton   task_team->tt.tt_next = __kmp_free_task_teams;
34917cc577a4SJonathan Peyton   TCW_PTR(__kmp_free_task_teams, task_team);
34927cc577a4SJonathan Peyton 
34937cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34947cc577a4SJonathan Peyton }
34957cc577a4SJonathan Peyton 
34967cc577a4SJonathan Peyton // __kmp_reap_task_teams:
34977cc577a4SJonathan Peyton // Free all the task teams on the task team free list.
34987cc577a4SJonathan Peyton // Should only be done during library shutdown.
34993041982dSJonathan Peyton // Cannot do anything that needs a thread structure or gtid since they are
35003041982dSJonathan Peyton // already gone.
35013041982dSJonathan Peyton void __kmp_reap_task_teams(void) {
35027cc577a4SJonathan Peyton   kmp_task_team_t *task_team;
35037cc577a4SJonathan Peyton 
35047cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
35057cc577a4SJonathan Peyton     // Free all task_teams on the free list
35067cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
35077cc577a4SJonathan Peyton     while ((task_team = __kmp_free_task_teams) != NULL) {
35087cc577a4SJonathan Peyton       __kmp_free_task_teams = task_team->tt.tt_next;
35097cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
35107cc577a4SJonathan Peyton 
35117cc577a4SJonathan Peyton       // Free threads_data if necessary
35127cc577a4SJonathan Peyton       if (task_team->tt.tt_threads_data != NULL) {
35137cc577a4SJonathan Peyton         __kmp_free_task_threads_data(task_team);
35147cc577a4SJonathan Peyton       }
35157cc577a4SJonathan Peyton       __kmp_free(task_team);
35167cc577a4SJonathan Peyton     }
35177cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
35187cc577a4SJonathan Peyton   }
35197cc577a4SJonathan Peyton }
35207cc577a4SJonathan Peyton 
35217cc577a4SJonathan Peyton // __kmp_wait_to_unref_task_teams:
35227cc577a4SJonathan Peyton // Some threads could still be in the fork barrier release code, possibly
35237cc577a4SJonathan Peyton // trying to steal tasks.  Wait for each thread to unreference its task team.
35243041982dSJonathan Peyton void __kmp_wait_to_unref_task_teams(void) {
35257cc577a4SJonathan Peyton   kmp_info_t *thread;
35267cc577a4SJonathan Peyton   kmp_uint32 spins;
35277cc577a4SJonathan Peyton   int done;
35287cc577a4SJonathan Peyton 
35297cc577a4SJonathan Peyton   KMP_INIT_YIELD(spins);
35307cc577a4SJonathan Peyton 
35317cc577a4SJonathan Peyton   for (;;) {
35327cc577a4SJonathan Peyton     done = TRUE;
35337cc577a4SJonathan Peyton 
35347cc577a4SJonathan Peyton     // TODO: GEH - this may be is wrong because some sync would be necessary
35353041982dSJonathan Peyton     // in case threads are added to the pool during the traversal. Need to
35363041982dSJonathan Peyton     // verify that lock for thread pool is held when calling this routine.
3537c47afcd9SAndrey Churbanov     for (thread = CCAST(kmp_info_t *, __kmp_thread_pool); thread != NULL;
35383041982dSJonathan Peyton          thread = thread->th.th_next_pool) {
35397cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35407cc577a4SJonathan Peyton       DWORD exit_val;
35417cc577a4SJonathan Peyton #endif
35427cc577a4SJonathan Peyton       if (TCR_PTR(thread->th.th_task_team) == NULL) {
35437cc577a4SJonathan Peyton         KA_TRACE(10, ("__kmp_wait_to_unref_task_team: T#%d task_team == NULL\n",
35447cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
35457cc577a4SJonathan Peyton         continue;
35467cc577a4SJonathan Peyton       }
35477cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35487cc577a4SJonathan Peyton       // TODO: GEH - add this check for Linux* OS / OS X* as well?
35497cc577a4SJonathan Peyton       if (!__kmp_is_thread_alive(thread, &exit_val)) {
35507cc577a4SJonathan Peyton         thread->th.th_task_team = NULL;
35517cc577a4SJonathan Peyton         continue;
35527cc577a4SJonathan Peyton       }
35537cc577a4SJonathan Peyton #endif
35547cc577a4SJonathan Peyton 
35557cc577a4SJonathan Peyton       done = FALSE; // Because th_task_team pointer is not NULL for this thread
35567cc577a4SJonathan Peyton 
35573041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_wait_to_unref_task_team: Waiting for T#%d to "
35583041982dSJonathan Peyton                     "unreference task_team\n",
35597cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(thread)));
35607cc577a4SJonathan Peyton 
35617cc577a4SJonathan Peyton       if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
3562d8e4cb91STerry Wilmarth         void *sleep_loc;
35637cc577a4SJonathan Peyton         // If the thread is sleeping, awaken it.
3564c47afcd9SAndrey Churbanov         if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3565c47afcd9SAndrey Churbanov             NULL) {
35663041982dSJonathan Peyton           KA_TRACE(
35673041982dSJonathan Peyton               10,
35683041982dSJonathan Peyton               ("__kmp_wait_to_unref_task_team: T#%d waking up thread T#%d\n",
35697cc577a4SJonathan Peyton                __kmp_gtid_from_thread(thread), __kmp_gtid_from_thread(thread)));
3570d8e4cb91STerry Wilmarth           __kmp_null_resume_wrapper(thread);
35717cc577a4SJonathan Peyton         }
35727cc577a4SJonathan Peyton       }
35737cc577a4SJonathan Peyton     }
35747cc577a4SJonathan Peyton     if (done) {
35757cc577a4SJonathan Peyton       break;
35767cc577a4SJonathan Peyton     }
35777cc577a4SJonathan Peyton 
3578e47d32f1SJonathan Peyton     // If oversubscribed or have waited a bit, yield.
3579e47d32f1SJonathan Peyton     KMP_YIELD_OVERSUB_ELSE_SPIN(spins);
35807cc577a4SJonathan Peyton   }
35817cc577a4SJonathan Peyton }
35827cc577a4SJonathan Peyton 
35837cc577a4SJonathan Peyton // __kmp_task_team_setup:  Create a task_team for the current team, but use
35847cc577a4SJonathan Peyton // an already created, unused one if it already exists.
35853041982dSJonathan Peyton void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team, int always) {
35867cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
35877cc577a4SJonathan Peyton 
35883041982dSJonathan Peyton   // If this task_team hasn't been created yet, allocate it. It will be used in
35893041982dSJonathan Peyton   // the region after the next.
35903041982dSJonathan Peyton   // If it exists, it is the current task team and shouldn't be touched yet as
35913041982dSJonathan Peyton   // it may still be in use.
35923041982dSJonathan Peyton   if (team->t.t_task_team[this_thr->th.th_task_state] == NULL &&
35933041982dSJonathan Peyton       (always || team->t.t_nproc > 1)) {
35943041982dSJonathan Peyton     team->t.t_task_team[this_thr->th.th_task_state] =
35953041982dSJonathan Peyton         __kmp_allocate_task_team(this_thr, team);
359697d000cfStlwilmar     KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created new task_team %p"
35973041982dSJonathan Peyton                   " for team %d at parity=%d\n",
35983041982dSJonathan Peyton                   __kmp_gtid_from_thread(this_thr),
3599467f3924SHansang Bae                   team->t.t_task_team[this_thr->th.th_task_state], team->t.t_id,
36003041982dSJonathan Peyton                   this_thr->th.th_task_state));
36017cc577a4SJonathan Peyton   }
36027cc577a4SJonathan Peyton 
36033041982dSJonathan Peyton   // After threads exit the release, they will call sync, and then point to this
36043041982dSJonathan Peyton   // other task_team; make sure it is allocated and properly initialized. As
36053041982dSJonathan Peyton   // threads spin in the barrier release phase, they will continue to use the
36063041982dSJonathan Peyton   // previous task_team struct(above), until they receive the signal to stop
36073041982dSJonathan Peyton   // checking for tasks (they can't safely reference the kmp_team_t struct,
360897d000cfStlwilmar   // which could be reallocated by the primary thread). No task teams are formed
36093041982dSJonathan Peyton   // for serialized teams.
36107cc577a4SJonathan Peyton   if (team->t.t_nproc > 1) {
36117cc577a4SJonathan Peyton     int other_team = 1 - this_thr->th.th_task_state;
3612467f3924SHansang Bae     KMP_DEBUG_ASSERT(other_team >= 0 && other_team < 2);
36137cc577a4SJonathan Peyton     if (team->t.t_task_team[other_team] == NULL) { // setup other team as well
36143041982dSJonathan Peyton       team->t.t_task_team[other_team] =
36153041982dSJonathan Peyton           __kmp_allocate_task_team(this_thr, team);
361697d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created second new "
36173041982dSJonathan Peyton                     "task_team %p for team %d at parity=%d\n",
36183041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3619467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36203041982dSJonathan Peyton     } else { // Leave the old task team struct in place for the upcoming region;
36213041982dSJonathan Peyton       // adjust as needed
36227cc577a4SJonathan Peyton       kmp_task_team_t *task_team = team->t.t_task_team[other_team];
36233041982dSJonathan Peyton       if (!task_team->tt.tt_active ||
36243041982dSJonathan Peyton           team->t.t_nproc != task_team->tt.tt_nproc) {
36257cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_nproc, team->t.t_nproc);
36267cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_tasks, FALSE);
36277cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
362837e2ef54SJonathan Peyton         KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads,
362937e2ef54SJonathan Peyton                           team->t.t_nproc);
36307cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_active, TRUE);
36317cc577a4SJonathan Peyton       }
36323041982dSJonathan Peyton       // if team size has changed, the first thread to enable tasking will
36333041982dSJonathan Peyton       // realloc threads_data if necessary
363497d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d reset next task_team "
36353041982dSJonathan Peyton                     "%p for team %d at parity=%d\n",
36363041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3637467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36387cc577a4SJonathan Peyton     }
36397cc577a4SJonathan Peyton   }
36409d64275aSShilei Tian 
36419d64275aSShilei Tian   // For regular thread, task enabling should be called when the task is going
36429d64275aSShilei Tian   // to be pushed to a dequeue. However, for the hidden helper thread, we need
36439d64275aSShilei Tian   // it ahead of time so that some operations can be performed without race
36449d64275aSShilei Tian   // condition.
36459d64275aSShilei Tian   if (this_thr == __kmp_hidden_helper_main_thread) {
36469d64275aSShilei Tian     for (int i = 0; i < 2; ++i) {
36479d64275aSShilei Tian       kmp_task_team_t *task_team = team->t.t_task_team[i];
36489d64275aSShilei Tian       if (KMP_TASKING_ENABLED(task_team)) {
36499d64275aSShilei Tian         continue;
36509d64275aSShilei Tian       }
36519d64275aSShilei Tian       __kmp_enable_tasking(task_team, this_thr);
36529d64275aSShilei Tian       for (int j = 0; j < task_team->tt.tt_nproc; ++j) {
36539d64275aSShilei Tian         kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[j];
36549d64275aSShilei Tian         if (thread_data->td.td_deque == NULL) {
36559d64275aSShilei Tian           __kmp_alloc_task_deque(__kmp_hidden_helper_threads[j], thread_data);
36569d64275aSShilei Tian         }
36579d64275aSShilei Tian       }
36589d64275aSShilei Tian     }
36599d64275aSShilei Tian   }
36607cc577a4SJonathan Peyton }
36617cc577a4SJonathan Peyton 
36627cc577a4SJonathan Peyton // __kmp_task_team_sync: Propagation of task team data from team to threads
36637cc577a4SJonathan Peyton // which happens just after the release phase of a team barrier.  This may be
36647cc577a4SJonathan Peyton // called by any thread, but only for teams with # threads > 1.
36653041982dSJonathan Peyton void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team) {
36667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36677cc577a4SJonathan Peyton 
36683041982dSJonathan Peyton   // Toggle the th_task_state field, to switch which task_team this thread
36693041982dSJonathan Peyton   // refers to
36706b316febSTerry Wilmarth   this_thr->th.th_task_state = (kmp_uint8)(1 - this_thr->th.th_task_state);
36716b316febSTerry Wilmarth 
36723041982dSJonathan Peyton   // It is now safe to propagate the task team pointer from the team struct to
36733041982dSJonathan Peyton   // the current thread.
36743041982dSJonathan Peyton   TCW_PTR(this_thr->th.th_task_team,
36753041982dSJonathan Peyton           team->t.t_task_team[this_thr->th.th_task_state]);
36763041982dSJonathan Peyton   KA_TRACE(20,
36773041982dSJonathan Peyton            ("__kmp_task_team_sync: Thread T#%d task team switched to task_team "
36783041982dSJonathan Peyton             "%p from Team #%d (parity=%d)\n",
36797cc577a4SJonathan Peyton             __kmp_gtid_from_thread(this_thr), this_thr->th.th_task_team,
3680467f3924SHansang Bae             team->t.t_id, this_thr->th.th_task_state));
36817cc577a4SJonathan Peyton }
36827cc577a4SJonathan Peyton 
368397d000cfStlwilmar // __kmp_task_team_wait: Primary thread waits for outstanding tasks after the
368497d000cfStlwilmar // barrier gather phase. Only called by primary thread if #threads in team > 1
368597d000cfStlwilmar // or if proxy tasks were created.
36863041982dSJonathan Peyton //
36873041982dSJonathan Peyton // wait is a flag that defaults to 1 (see kmp.h), but waiting can be turned off
368897d000cfStlwilmar // by passing in 0 optionally as the last argument. When wait is zero, primary
36893041982dSJonathan Peyton // thread does not wait for unfinished_threads to reach 0.
36903041982dSJonathan Peyton void __kmp_task_team_wait(
36913041982dSJonathan Peyton     kmp_info_t *this_thr,
36923041982dSJonathan Peyton     kmp_team_t *team USE_ITT_BUILD_ARG(void *itt_sync_obj), int wait) {
36937cc577a4SJonathan Peyton   kmp_task_team_t *task_team = team->t.t_task_team[this_thr->th.th_task_state];
36947cc577a4SJonathan Peyton 
36957cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36967cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team == this_thr->th.th_task_team);
36977cc577a4SJonathan Peyton 
36987cc577a4SJonathan Peyton   if ((task_team != NULL) && KMP_TASKING_ENABLED(task_team)) {
36997cc577a4SJonathan Peyton     if (wait) {
370097d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_wait: Primary T#%d waiting for all tasks "
37013041982dSJonathan Peyton                     "(for unfinished_threads to reach 0) on task_team = %p\n",
37027cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(this_thr), task_team));
37033041982dSJonathan Peyton       // Worker threads may have dropped through to release phase, but could
37043041982dSJonathan Peyton       // still be executing tasks. Wait here for tasks to complete. To avoid
370597d000cfStlwilmar       // memory contention, only primary thread checks termination condition.
3706e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
3707e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
370837e2ef54SJonathan Peyton                 &task_team->tt.tt_unfinished_threads),
3709c47afcd9SAndrey Churbanov           0U);
37103041982dSJonathan Peyton       flag.wait(this_thr, TRUE USE_ITT_BUILD_ARG(itt_sync_obj));
37117cc577a4SJonathan Peyton     }
37123041982dSJonathan Peyton     // Deactivate the old task team, so that the worker threads will stop
37133041982dSJonathan Peyton     // referencing it while spinning.
37143041982dSJonathan Peyton     KA_TRACE(
37153041982dSJonathan Peyton         20,
371697d000cfStlwilmar         ("__kmp_task_team_wait: Primary T#%d deactivating task_team %p: "
37177cc577a4SJonathan Peyton          "setting active to false, setting local and team's pointer to NULL\n",
37187cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr), task_team));
37193041982dSJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1 ||
37203041982dSJonathan Peyton                      task_team->tt.tt_found_proxy_tasks == TRUE);
37217cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_proxy_tasks, FALSE);
3722a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(task_team->tt.tt_untied_task_encountered, 0);
37237cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_active, FALSE);
37247cc577a4SJonathan Peyton     KMP_MB();
37257cc577a4SJonathan Peyton 
37267cc577a4SJonathan Peyton     TCW_PTR(this_thr->th.th_task_team, NULL);
37277cc577a4SJonathan Peyton   }
37287cc577a4SJonathan Peyton }
37297cc577a4SJonathan Peyton 
37307cc577a4SJonathan Peyton // __kmp_tasking_barrier:
3731e0665a90STerry Wilmarth // This routine is called only when __kmp_tasking_mode == tskm_extra_barrier.
37323041982dSJonathan Peyton // Internal function to execute all tasks prior to a regular barrier or a join
37333041982dSJonathan Peyton // barrier. It is a full barrier itself, which unfortunately turns regular
37343041982dSJonathan Peyton // barriers into double barriers and join barriers into 1 1/2 barriers.
37353041982dSJonathan Peyton void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread, int gtid) {
373637e2ef54SJonathan Peyton   std::atomic<kmp_uint32> *spin = RCAST(
373737e2ef54SJonathan Peyton       std::atomic<kmp_uint32> *,
3738c47afcd9SAndrey Churbanov       &team->t.t_task_team[thread->th.th_task_state]->tt.tt_unfinished_threads);
37397cc577a4SJonathan Peyton   int flag = FALSE;
37407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode == tskm_extra_barrier);
37417cc577a4SJonathan Peyton 
37427cc577a4SJonathan Peyton #if USE_ITT_BUILD
374337e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_INIT(spin, NULL);
37447cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
3745e0665a90STerry Wilmarth   kmp_flag_32<false, false> spin_flag(spin, 0U);
37463041982dSJonathan Peyton   while (!spin_flag.execute_tasks(thread, gtid, TRUE,
37473041982dSJonathan Peyton                                   &flag USE_ITT_BUILD_ARG(NULL), 0)) {
37487cc577a4SJonathan Peyton #if USE_ITT_BUILD
37497cc577a4SJonathan Peyton     // TODO: What about itt_sync_obj??
375037e2ef54SJonathan Peyton     KMP_FSYNC_SPIN_PREPARE(RCAST(void *, spin));
37517cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37527cc577a4SJonathan Peyton 
37537cc577a4SJonathan Peyton     if (TCR_4(__kmp_global.g.g_done)) {
37547cc577a4SJonathan Peyton       if (__kmp_global.g.g_abort)
37557cc577a4SJonathan Peyton         __kmp_abort_thread();
37567cc577a4SJonathan Peyton       break;
37577cc577a4SJonathan Peyton     }
3758e47d32f1SJonathan Peyton     KMP_YIELD(TRUE);
37597cc577a4SJonathan Peyton   }
37607cc577a4SJonathan Peyton #if USE_ITT_BUILD
376137e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_ACQUIRED(RCAST(void *, spin));
37627cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37637cc577a4SJonathan Peyton }
37647cc577a4SJonathan Peyton 
37653041982dSJonathan Peyton // __kmp_give_task puts a task into a given thread queue if:
37663041982dSJonathan Peyton //  - the queue for that thread was created
37673041982dSJonathan Peyton //  - there's space in that queue
37683041982dSJonathan Peyton // Because of this, __kmp_push_task needs to check if there's space after
37693041982dSJonathan Peyton // getting the lock
37703041982dSJonathan Peyton static bool __kmp_give_task(kmp_info_t *thread, kmp_int32 tid, kmp_task_t *task,
37713041982dSJonathan Peyton                             kmp_int32 pass) {
37727cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
37737cc577a4SJonathan Peyton   kmp_task_team_t *task_team = taskdata->td_task_team;
37747cc577a4SJonathan Peyton 
37753041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_give_task: trying to give task %p to thread %d.\n",
37763041982dSJonathan Peyton                 taskdata, tid));
37777cc577a4SJonathan Peyton 
37787cc577a4SJonathan Peyton   // If task_team is NULL something went really bad...
37797cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
37807cc577a4SJonathan Peyton 
37817cc577a4SJonathan Peyton   bool result = false;
37827cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
37837cc577a4SJonathan Peyton 
37847cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
37857cc577a4SJonathan Peyton     // There's no queue in this thread, go find another one
37867cc577a4SJonathan Peyton     // We're guaranteed that at least one thread has a queue
37873041982dSJonathan Peyton     KA_TRACE(30,
37883041982dSJonathan Peyton              ("__kmp_give_task: thread %d has no queue while giving task %p.\n",
37893041982dSJonathan Peyton               tid, taskdata));
37907cc577a4SJonathan Peyton     return result;
37917cc577a4SJonathan Peyton   }
37927cc577a4SJonathan Peyton 
37933041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
37943041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
37953041982dSJonathan Peyton     KA_TRACE(
37963041982dSJonathan Peyton         30,
37973041982dSJonathan Peyton         ("__kmp_give_task: queue is full while giving task %p to thread %d.\n",
37983041982dSJonathan Peyton          taskdata, tid));
37997cc577a4SJonathan Peyton 
38003041982dSJonathan Peyton     // if this deque is bigger than the pass ratio give a chance to another
38013041982dSJonathan Peyton     // thread
38023041982dSJonathan Peyton     if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38033041982dSJonathan Peyton       return result;
38047cc577a4SJonathan Peyton 
38057cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38063895148dSJoachim Protze     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38073895148dSJoachim Protze         TASK_DEQUE_SIZE(thread_data->td)) {
38083895148dSJoachim Protze       // expand deque to push the task which is not allowed to execute
38097cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38103895148dSJoachim Protze     }
38117cc577a4SJonathan Peyton 
38127cc577a4SJonathan Peyton   } else {
38137cc577a4SJonathan Peyton 
38147cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38157cc577a4SJonathan Peyton 
38163041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38173041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
38183041982dSJonathan Peyton       KA_TRACE(30, ("__kmp_give_task: queue is full while giving task %p to "
38193041982dSJonathan Peyton                     "thread %d.\n",
38203041982dSJonathan Peyton                     taskdata, tid));
38217cc577a4SJonathan Peyton 
38223041982dSJonathan Peyton       // if this deque is bigger than the pass ratio give a chance to another
38233041982dSJonathan Peyton       // thread
38247cc577a4SJonathan Peyton       if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38257cc577a4SJonathan Peyton         goto release_and_exit;
38267cc577a4SJonathan Peyton 
38277cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38287cc577a4SJonathan Peyton     }
38297cc577a4SJonathan Peyton   }
38307cc577a4SJonathan Peyton 
38317cc577a4SJonathan Peyton   // lock is held here, and there is space in the deque
38327cc577a4SJonathan Peyton 
38337cc577a4SJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] = taskdata;
38347cc577a4SJonathan Peyton   // Wrap index.
38353041982dSJonathan Peyton   thread_data->td.td_deque_tail =
38363041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
38373041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
38383041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1);
38397cc577a4SJonathan Peyton 
38407cc577a4SJonathan Peyton   result = true;
38413041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_give_task: successfully gave task %p to thread %d.\n",
38423041982dSJonathan Peyton                 taskdata, tid));
38437cc577a4SJonathan Peyton 
38447cc577a4SJonathan Peyton release_and_exit:
38457cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
38467cc577a4SJonathan Peyton 
38477cc577a4SJonathan Peyton   return result;
38487cc577a4SJonathan Peyton }
38497cc577a4SJonathan Peyton 
38503c76e992SJoachim Protze #define PROXY_TASK_FLAG 0x40000000
38513041982dSJonathan Peyton /* The finish of the proxy tasks is divided in two pieces:
38527cc577a4SJonathan Peyton     - the top half is the one that can be done from a thread outside the team
3853c3344345SAndrey Churbanov     - the bottom half must be run from a thread within the team
38547cc577a4SJonathan Peyton 
38553041982dSJonathan Peyton    In order to run the bottom half the task gets queued back into one of the
38563041982dSJonathan Peyton    threads of the team. Once the td_incomplete_child_task counter of the parent
38573041982dSJonathan Peyton    is decremented the threads can leave the barriers. So, the bottom half needs
38583041982dSJonathan Peyton    to be queued before the counter is decremented. The top half is therefore
38593041982dSJonathan Peyton    divided in two parts:
38607cc577a4SJonathan Peyton     - things that can be run before queuing the bottom half
38617cc577a4SJonathan Peyton     - things that must be run after queuing the bottom half
38627cc577a4SJonathan Peyton 
38633041982dSJonathan Peyton    This creates a second race as the bottom half can free the task before the
38643041982dSJonathan Peyton    second top half is executed. To avoid this we use the
38653041982dSJonathan Peyton    td_incomplete_child_task of the proxy task to synchronize the top and bottom
38663041982dSJonathan Peyton    half. */
38673041982dSJonathan Peyton static void __kmp_first_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38687cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
38697cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38707cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
38717cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
38727cc577a4SJonathan Peyton 
38737cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
38747cc577a4SJonathan Peyton 
38757cc577a4SJonathan Peyton   if (taskdata->td_taskgroup)
387637e2ef54SJonathan Peyton     KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
38777cc577a4SJonathan Peyton 
38783041982dSJonathan Peyton   // Create an imaginary children for this task so the bottom half cannot
38793041982dSJonathan Peyton   // release the task before we have completed the second top half
38803c76e992SJoachim Protze   KMP_ATOMIC_OR(&taskdata->td_incomplete_child_tasks, PROXY_TASK_FLAG);
38817cc577a4SJonathan Peyton }
38827cc577a4SJonathan Peyton 
38833041982dSJonathan Peyton static void __kmp_second_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38848b81524cSAndreyChurbanov #if KMP_DEBUG
38857cc577a4SJonathan Peyton   kmp_int32 children = 0;
38867cc577a4SJonathan Peyton   // Predecrement simulated by "- 1" calculation
38878b81524cSAndreyChurbanov   children = -1 +
38888b81524cSAndreyChurbanov #endif
38898b81524cSAndreyChurbanov       KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks);
38907cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
38917cc577a4SJonathan Peyton 
38927cc577a4SJonathan Peyton   // Remove the imaginary children
38933c76e992SJoachim Protze   KMP_ATOMIC_AND(&taskdata->td_incomplete_child_tasks, ~PROXY_TASK_FLAG);
38947cc577a4SJonathan Peyton }
38957cc577a4SJonathan Peyton 
38963041982dSJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask) {
38977cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
38987cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
38997cc577a4SJonathan Peyton 
39007cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39013041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete ==
39023041982dSJonathan Peyton                    1); // top half must run before bottom half
39037cc577a4SJonathan Peyton 
39047cc577a4SJonathan Peyton   // We need to wait to make sure the top half is finished
39057cc577a4SJonathan Peyton   // Spinning here should be ok as this should happen quickly
39063c76e992SJoachim Protze   while ((KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) &
39073c76e992SJoachim Protze           PROXY_TASK_FLAG) > 0)
39083041982dSJonathan Peyton     ;
39097cc577a4SJonathan Peyton 
39107cc577a4SJonathan Peyton   __kmp_release_deps(gtid, taskdata);
39117cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
39127cc577a4SJonathan Peyton }
39137cc577a4SJonathan Peyton 
39147cc577a4SJonathan Peyton /*!
39157cc577a4SJonathan Peyton @ingroup TASKING
39167cc577a4SJonathan Peyton @param gtid Global Thread ID of encountering thread
39177cc577a4SJonathan Peyton @param ptask Task which execution is completed
39187cc577a4SJonathan Peyton 
3919ed5fe645SKelvin Li Execute the completion of a proxy task from a thread of that is part of the
39203041982dSJonathan Peyton team. Run first and bottom halves directly.
39217cc577a4SJonathan Peyton */
39223041982dSJonathan Peyton void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask) {
39237cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39247cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39253041982dSJonathan Peyton   KA_TRACE(
39263041982dSJonathan Peyton       10, ("__kmp_proxy_task_completed(enter): T#%d proxy task %p completing\n",
39273041982dSJonathan Peyton            gtid, taskdata));
3928787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
39297cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39307cc577a4SJonathan Peyton 
39317cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39327cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39337cc577a4SJonathan Peyton   __kmp_bottom_half_finish_proxy(gtid, ptask);
39347cc577a4SJonathan Peyton 
39353041982dSJonathan Peyton   KA_TRACE(10,
39363041982dSJonathan Peyton            ("__kmp_proxy_task_completed(exit): T#%d proxy task %p completing\n",
39373041982dSJonathan Peyton             gtid, taskdata));
39387cc577a4SJonathan Peyton }
39397cc577a4SJonathan Peyton 
3940ea452353SShilei Tian void __kmpc_give_task(kmp_task_t *ptask, kmp_int32 start = 0) {
3941ea452353SShilei Tian   KMP_DEBUG_ASSERT(ptask != NULL);
3942ea452353SShilei Tian   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
3943ea452353SShilei Tian 
3944ea452353SShilei Tian   // Enqueue task to complete bottom half completion from a thread within the
3945ea452353SShilei Tian   // corresponding team
3946ea452353SShilei Tian   kmp_team_t *team = taskdata->td_team;
3947ea452353SShilei Tian   kmp_int32 nthreads = team->t.t_nproc;
3948ea452353SShilei Tian   kmp_info_t *thread;
3949ea452353SShilei Tian 
3950ea452353SShilei Tian   // This should be similar to start_k = __kmp_get_random( thread ) % nthreads
3951ea452353SShilei Tian   // but we cannot use __kmp_get_random here
3952680c71b1SShilei Tian   kmp_int32 start_k = start % nthreads;
3953ea452353SShilei Tian   kmp_int32 pass = 1;
3954ea452353SShilei Tian   kmp_int32 k = start_k;
3955ea452353SShilei Tian 
3956ea452353SShilei Tian   do {
3957ea452353SShilei Tian     // For now we're just linearly trying to find a thread
3958ea452353SShilei Tian     thread = team->t.t_threads[k];
3959ea452353SShilei Tian     k = (k + 1) % nthreads;
3960ea452353SShilei Tian 
3961ea452353SShilei Tian     // we did a full pass through all the threads
3962ea452353SShilei Tian     if (k == start_k)
3963ea452353SShilei Tian       pass = pass << 1;
3964ea452353SShilei Tian 
3965ea452353SShilei Tian   } while (!__kmp_give_task(thread, k, ptask, pass));
3966ea452353SShilei Tian }
3967ea452353SShilei Tian 
39687cc577a4SJonathan Peyton /*!
39697cc577a4SJonathan Peyton @ingroup TASKING
39707cc577a4SJonathan Peyton @param ptask Task which execution is completed
39717cc577a4SJonathan Peyton 
3972ed5fe645SKelvin Li Execute the completion of a proxy task from a thread that could not belong to
39733041982dSJonathan Peyton the team.
39747cc577a4SJonathan Peyton */
39753041982dSJonathan Peyton void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask) {
39767cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39777cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39787cc577a4SJonathan Peyton 
39793041982dSJonathan Peyton   KA_TRACE(
39803041982dSJonathan Peyton       10,
39813041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(enter): proxy task completing ooo %p\n",
39823041982dSJonathan Peyton        taskdata));
39837cc577a4SJonathan Peyton 
39847cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39857cc577a4SJonathan Peyton 
39867cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39877cc577a4SJonathan Peyton 
3988ea452353SShilei Tian   __kmpc_give_task(ptask);
39897cc577a4SJonathan Peyton 
39907cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39917cc577a4SJonathan Peyton 
39923041982dSJonathan Peyton   KA_TRACE(
39933041982dSJonathan Peyton       10,
39943041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(exit): proxy task completing ooo %p\n",
39953041982dSJonathan Peyton        taskdata));
39967cc577a4SJonathan Peyton }
39977cc577a4SJonathan Peyton 
3998405037c4SAndrey Churbanov kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref, int gtid,
3999405037c4SAndrey Churbanov                                                 kmp_task_t *task) {
4000405037c4SAndrey Churbanov   kmp_taskdata_t *td = KMP_TASK_TO_TASKDATA(task);
4001405037c4SAndrey Churbanov   if (td->td_allow_completion_event.type == KMP_EVENT_UNINITIALIZED) {
4002405037c4SAndrey Churbanov     td->td_allow_completion_event.type = KMP_EVENT_ALLOW_COMPLETION;
4003405037c4SAndrey Churbanov     td->td_allow_completion_event.ed.task = task;
4004405037c4SAndrey Churbanov     __kmp_init_tas_lock(&td->td_allow_completion_event.lock);
4005405037c4SAndrey Churbanov   }
4006405037c4SAndrey Churbanov   return &td->td_allow_completion_event;
4007405037c4SAndrey Churbanov }
4008405037c4SAndrey Churbanov 
4009405037c4SAndrey Churbanov void __kmp_fulfill_event(kmp_event_t *event) {
4010405037c4SAndrey Churbanov   if (event->type == KMP_EVENT_ALLOW_COMPLETION) {
4011405037c4SAndrey Churbanov     kmp_task_t *ptask = event->ed.task;
4012405037c4SAndrey Churbanov     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
4013405037c4SAndrey Churbanov     bool detached = false;
4014405037c4SAndrey Churbanov     int gtid = __kmp_get_gtid();
4015405037c4SAndrey Churbanov 
4016d23131a3SJoachim Protze     // The associated task might have completed or could be completing at this
4017405037c4SAndrey Churbanov     // point.
4018405037c4SAndrey Churbanov     // We need to take the lock to avoid races
4019405037c4SAndrey Churbanov     __kmp_acquire_tas_lock(&event->lock, gtid);
402010995c77SJoachim Protze     if (taskdata->td_flags.proxy == TASK_PROXY) {
4021405037c4SAndrey Churbanov       detached = true;
402210995c77SJoachim Protze     } else {
402310995c77SJoachim Protze #if OMPT_SUPPORT
402410995c77SJoachim Protze       // The OMPT event must occur under mutual exclusion,
402510995c77SJoachim Protze       // otherwise the tool might access ptask after free
402610995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
402710995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_early_fulfill);
402810995c77SJoachim Protze #endif
402910995c77SJoachim Protze     }
4030405037c4SAndrey Churbanov     event->type = KMP_EVENT_UNINITIALIZED;
4031405037c4SAndrey Churbanov     __kmp_release_tas_lock(&event->lock, gtid);
4032405037c4SAndrey Churbanov 
4033405037c4SAndrey Churbanov     if (detached) {
403410995c77SJoachim Protze #if OMPT_SUPPORT
403510995c77SJoachim Protze       // We free ptask afterwards and know the task is finished,
403610995c77SJoachim Protze       // so locking is not necessary
403710995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
403810995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_late_fulfill);
403910995c77SJoachim Protze #endif
4040405037c4SAndrey Churbanov       // If the task detached complete the proxy task
4041405037c4SAndrey Churbanov       if (gtid >= 0) {
4042405037c4SAndrey Churbanov         kmp_team_t *team = taskdata->td_team;
4043405037c4SAndrey Churbanov         kmp_info_t *thread = __kmp_get_thread();
4044405037c4SAndrey Churbanov         if (thread->th.th_team == team) {
4045405037c4SAndrey Churbanov           __kmpc_proxy_task_completed(gtid, ptask);
4046405037c4SAndrey Churbanov           return;
4047405037c4SAndrey Churbanov         }
4048405037c4SAndrey Churbanov       }
4049405037c4SAndrey Churbanov 
4050405037c4SAndrey Churbanov       // fallback
4051405037c4SAndrey Churbanov       __kmpc_proxy_task_completed_ooo(ptask);
4052405037c4SAndrey Churbanov     }
4053405037c4SAndrey Churbanov   }
4054405037c4SAndrey Churbanov }
4055405037c4SAndrey Churbanov 
40563041982dSJonathan Peyton // __kmp_task_dup_alloc: Allocate the taskdata and make a copy of source task
40573041982dSJonathan Peyton // for taskloop
40587cc577a4SJonathan Peyton //
40597cc577a4SJonathan Peyton // thread:   allocating thread
40607cc577a4SJonathan Peyton // task_src: pointer to source task to be duplicated
40617cc577a4SJonathan Peyton // returns:  a pointer to the allocated kmp_task_t structure (task).
40623041982dSJonathan Peyton kmp_task_t *__kmp_task_dup_alloc(kmp_info_t *thread, kmp_task_t *task_src) {
40637cc577a4SJonathan Peyton   kmp_task_t *task;
40647cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
40655e111c5dSAndreyChurbanov   kmp_taskdata_t *taskdata_src = KMP_TASK_TO_TASKDATA(task_src);
40665e111c5dSAndreyChurbanov   kmp_taskdata_t *parent_task = taskdata_src->td_parent; // same parent task
40677cc577a4SJonathan Peyton   size_t shareds_offset;
40687cc577a4SJonathan Peyton   size_t task_size;
40697cc577a4SJonathan Peyton 
40703041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_dup_alloc(enter): Th %p, source task %p\n", thread,
40713041982dSJonathan Peyton                 task_src));
40723041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.proxy ==
40733041982dSJonathan Peyton                    TASK_FULL); // it should not be proxy task
40747cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.tasktype == TASK_EXPLICIT);
40757cc577a4SJonathan Peyton   task_size = taskdata_src->td_size_alloc;
40767cc577a4SJonathan Peyton 
40777cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
40783041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_dup_alloc: Th %p, malloc size %ld\n", thread,
40793041982dSJonathan Peyton                 task_size));
40807cc577a4SJonathan Peyton #if USE_FAST_MEMORY
40817cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, task_size);
40827cc577a4SJonathan Peyton #else
40837cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, task_size);
40847cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
40857cc577a4SJonathan Peyton   KMP_MEMCPY(taskdata, taskdata_src, task_size);
40867cc577a4SJonathan Peyton 
40877cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
40887cc577a4SJonathan Peyton 
40897cc577a4SJonathan Peyton   // Initialize new task (only specific fields not affected by memcpy)
40907cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
40917cc577a4SJonathan Peyton   if (task->shareds != NULL) { // need setup shareds pointer
40927cc577a4SJonathan Peyton     shareds_offset = (char *)task_src->shareds - (char *)taskdata_src;
40937cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
40943041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
40953041982dSJonathan Peyton                      0);
40967cc577a4SJonathan Peyton   }
40977cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
409893e17cfeSJonathan Peyton   taskdata->td_parent = parent_task;
4099ae044467SAndreyChurbanov   // task inherits the taskgroup from the parent task
4100ae044467SAndreyChurbanov   taskdata->td_taskgroup = parent_task->td_taskgroup;
4101ae044467SAndreyChurbanov   // tied task needs to initialize the td_last_tied at creation,
4102ae044467SAndreyChurbanov   // untied one does this when it is scheduled for execution
4103ae044467SAndreyChurbanov   if (taskdata->td_flags.tiedness == TASK_TIED)
4104ae044467SAndreyChurbanov     taskdata->td_last_tied = taskdata;
41057cc577a4SJonathan Peyton 
41063041982dSJonathan Peyton   // Only need to keep track of child task counts if team parallel and tasking
41073041982dSJonathan Peyton   // not serialized
41087cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
410937e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
41107cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
411137e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
41123041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
41133041982dSJonathan Peyton     // implicit not deallocated
41147cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT)
411537e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
41167cc577a4SJonathan Peyton   }
41177cc577a4SJonathan Peyton 
41183041982dSJonathan Peyton   KA_TRACE(20,
41193041982dSJonathan Peyton            ("__kmp_task_dup_alloc(exit): Th %p, created task %p, parent=%p\n",
41207cc577a4SJonathan Peyton             thread, taskdata, taskdata->td_parent));
41217cc577a4SJonathan Peyton #if OMPT_SUPPORT
4122f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
412382e94a59SJoachim Protze     __ompt_task_init(taskdata, thread->th.th_info.ds.ds_gtid);
41247cc577a4SJonathan Peyton #endif
41257cc577a4SJonathan Peyton   return task;
41267cc577a4SJonathan Peyton }
41277cc577a4SJonathan Peyton 
41287cc577a4SJonathan Peyton // Routine optionally generated by the compiler for setting the lastprivate flag
41297cc577a4SJonathan Peyton // and calling needed constructors for private/firstprivate objects
41307cc577a4SJonathan Peyton // (used to form taskloop tasks from pattern task)
413193e17cfeSJonathan Peyton // Parameters: dest task, src task, lastprivate flag.
41327cc577a4SJonathan Peyton typedef void (*p_task_dup_t)(kmp_task_t *, kmp_task_t *, kmp_int32);
41337cc577a4SJonathan Peyton 
413427a677fcSJonathan Peyton KMP_BUILD_ASSERT(sizeof(long) == 4 || sizeof(long) == 8);
413527a677fcSJonathan Peyton 
413627a677fcSJonathan Peyton // class to encapsulate manipulating loop bounds in a taskloop task.
413727a677fcSJonathan Peyton // this abstracts away the Intel vs GOMP taskloop interface for setting/getting
413827a677fcSJonathan Peyton // the loop bound variables.
413927a677fcSJonathan Peyton class kmp_taskloop_bounds_t {
414027a677fcSJonathan Peyton   kmp_task_t *task;
414127a677fcSJonathan Peyton   const kmp_taskdata_t *taskdata;
414227a677fcSJonathan Peyton   size_t lower_offset;
414327a677fcSJonathan Peyton   size_t upper_offset;
414427a677fcSJonathan Peyton 
414527a677fcSJonathan Peyton public:
414627a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, kmp_uint64 *lb, kmp_uint64 *ub)
414727a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(task)),
414827a677fcSJonathan Peyton         lower_offset((char *)lb - (char *)task),
414927a677fcSJonathan Peyton         upper_offset((char *)ub - (char *)task) {
415027a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)lb > (char *)_task);
415127a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)ub > (char *)_task);
415227a677fcSJonathan Peyton   }
415327a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, const kmp_taskloop_bounds_t &bounds)
415427a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(_task)),
415527a677fcSJonathan Peyton         lower_offset(bounds.lower_offset), upper_offset(bounds.upper_offset) {}
415627a677fcSJonathan Peyton   size_t get_lower_offset() const { return lower_offset; }
415727a677fcSJonathan Peyton   size_t get_upper_offset() const { return upper_offset; }
415827a677fcSJonathan Peyton   kmp_uint64 get_lb() const {
415927a677fcSJonathan Peyton     kmp_int64 retval;
416027a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
416127a677fcSJonathan Peyton     // Intel task just returns the lower bound normally
416227a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
416327a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + lower_offset);
416427a677fcSJonathan Peyton     } else {
416527a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
416627a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
416727a677fcSJonathan Peyton         kmp_int32 *lb = RCAST(kmp_int32 *, task->shareds);
416827a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
416927a677fcSJonathan Peyton       } else {
417027a677fcSJonathan Peyton         kmp_int64 *lb = RCAST(kmp_int64 *, task->shareds);
417127a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
417227a677fcSJonathan Peyton       }
417327a677fcSJonathan Peyton     }
417427a677fcSJonathan Peyton #else
4175b3d84790SMartin Storsjö     (void)taskdata;
417627a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + lower_offset);
417727a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
417827a677fcSJonathan Peyton     return retval;
417927a677fcSJonathan Peyton   }
418027a677fcSJonathan Peyton   kmp_uint64 get_ub() const {
418127a677fcSJonathan Peyton     kmp_int64 retval;
418227a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
418327a677fcSJonathan Peyton     // Intel task just returns the upper bound normally
418427a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
418527a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + upper_offset);
418627a677fcSJonathan Peyton     } else {
418727a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
418827a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
418927a677fcSJonathan Peyton         kmp_int32 *ub = RCAST(kmp_int32 *, task->shareds) + 1;
419027a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
419127a677fcSJonathan Peyton       } else {
419227a677fcSJonathan Peyton         kmp_int64 *ub = RCAST(kmp_int64 *, task->shareds) + 1;
419327a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
419427a677fcSJonathan Peyton       }
419527a677fcSJonathan Peyton     }
419627a677fcSJonathan Peyton #else
419727a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + upper_offset);
419827a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
419927a677fcSJonathan Peyton     return retval;
420027a677fcSJonathan Peyton   }
420127a677fcSJonathan Peyton   void set_lb(kmp_uint64 lb) {
420227a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
420327a677fcSJonathan Peyton     // Intel task just sets the lower bound normally
420427a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
420527a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + lower_offset) = lb;
420627a677fcSJonathan Peyton     } else {
420727a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
420827a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
420927a677fcSJonathan Peyton         kmp_uint32 *lower = RCAST(kmp_uint32 *, task->shareds);
421027a677fcSJonathan Peyton         *lower = (kmp_uint32)lb;
421127a677fcSJonathan Peyton       } else {
421227a677fcSJonathan Peyton         kmp_uint64 *lower = RCAST(kmp_uint64 *, task->shareds);
421327a677fcSJonathan Peyton         *lower = (kmp_uint64)lb;
421427a677fcSJonathan Peyton       }
421527a677fcSJonathan Peyton     }
421627a677fcSJonathan Peyton #else
421727a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + lower_offset) = lb;
421827a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
421927a677fcSJonathan Peyton   }
422027a677fcSJonathan Peyton   void set_ub(kmp_uint64 ub) {
422127a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
422227a677fcSJonathan Peyton     // Intel task just sets the upper bound normally
422327a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
422427a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + upper_offset) = ub;
422527a677fcSJonathan Peyton     } else {
422627a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
422727a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
422827a677fcSJonathan Peyton         kmp_uint32 *upper = RCAST(kmp_uint32 *, task->shareds) + 1;
422927a677fcSJonathan Peyton         *upper = (kmp_uint32)ub;
423027a677fcSJonathan Peyton       } else {
423127a677fcSJonathan Peyton         kmp_uint64 *upper = RCAST(kmp_uint64 *, task->shareds) + 1;
423227a677fcSJonathan Peyton         *upper = (kmp_uint64)ub;
423327a677fcSJonathan Peyton       }
423427a677fcSJonathan Peyton     }
423527a677fcSJonathan Peyton #else
423627a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + upper_offset) = ub;
423727a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
423827a677fcSJonathan Peyton   }
423927a677fcSJonathan Peyton };
424027a677fcSJonathan Peyton 
42417cc577a4SJonathan Peyton // __kmp_taskloop_linear: Start tasks of the taskloop linearly
42427cc577a4SJonathan Peyton //
42437cc577a4SJonathan Peyton // loc        Source location information
42447cc577a4SJonathan Peyton // gtid       Global thread ID
424593e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
424693e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
424793e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
42487cc577a4SJonathan Peyton // st         Loop stride
424993e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
425093e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
425193e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
425293e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4253540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
425493e17cfeSJonathan Peyton // tc         Iterations count
42557cc577a4SJonathan Peyton // task_dup   Tasks duplication routine
4256cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
42573041982dSJonathan Peyton void __kmp_taskloop_linear(ident_t *loc, int gtid, kmp_task_t *task,
42587cc577a4SJonathan Peyton                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
425993e17cfeSJonathan Peyton                            kmp_uint64 ub_glob, kmp_uint64 num_tasks,
426093e17cfeSJonathan Peyton                            kmp_uint64 grainsize, kmp_uint64 extras,
4261540007b4SNawrin Sultana                            kmp_int64 last_chunk, kmp_uint64 tc,
4262cdaefac5SJoachim Protze #if OMPT_SUPPORT
4263cdaefac5SJoachim Protze                            void *codeptr_ra,
4264cdaefac5SJoachim Protze #endif
4265cdaefac5SJoachim Protze                            void *task_dup) {
42667cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKLOOP);
42677cc577a4SJonathan Peyton   KMP_TIME_PARTITIONED_BLOCK(OMP_taskloop_scheduling);
42687cc577a4SJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
426927a677fcSJonathan Peyton   // compiler provides global bounds here
427027a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
427127a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
427227a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
427393e17cfeSJonathan Peyton   kmp_uint64 i;
42747cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
42757cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
42767cc577a4SJonathan Peyton   kmp_task_t *next_task;
42777cc577a4SJonathan Peyton   kmp_int32 lastpriv = 0;
42787cc577a4SJonathan Peyton 
4279309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4280309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
428193e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
428293e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
428393e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_linear: T#%d: %lld tasks, grainsize %lld, "
4284540007b4SNawrin Sultana                 "extras %lld, last_chunk %lld, i=%lld,%lld(%d)%lld, dup %p\n",
4285540007b4SNawrin Sultana                 gtid, num_tasks, grainsize, extras, last_chunk, lower, upper,
4286540007b4SNawrin Sultana                 ub_glob, st, task_dup));
428793e17cfeSJonathan Peyton 
428893e17cfeSJonathan Peyton   // Launch num_tasks tasks, assign grainsize iterations each task
428993e17cfeSJonathan Peyton   for (i = 0; i < num_tasks; ++i) {
429093e17cfeSJonathan Peyton     kmp_uint64 chunk_minus_1;
429193e17cfeSJonathan Peyton     if (extras == 0) {
429293e17cfeSJonathan Peyton       chunk_minus_1 = grainsize - 1;
429393e17cfeSJonathan Peyton     } else {
429493e17cfeSJonathan Peyton       chunk_minus_1 = grainsize;
429593e17cfeSJonathan Peyton       --extras; // first extras iterations get bigger chunk (grainsize+1)
429693e17cfeSJonathan Peyton     }
429793e17cfeSJonathan Peyton     upper = lower + st * chunk_minus_1;
4298540007b4SNawrin Sultana     if (upper > *ub) {
4299540007b4SNawrin Sultana       upper = *ub;
4300540007b4SNawrin Sultana     }
430193e17cfeSJonathan Peyton     if (i == num_tasks - 1) {
430293e17cfeSJonathan Peyton       // schedule the last task, set lastprivate flag if needed
430393e17cfeSJonathan Peyton       if (st == 1) { // most common case
430493e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper == *ub);
430593e17cfeSJonathan Peyton         if (upper == ub_glob)
430693e17cfeSJonathan Peyton           lastpriv = 1;
430793e17cfeSJonathan Peyton       } else if (st > 0) { // positive loop stride
430893e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT((kmp_uint64)st > *ub - upper);
430993e17cfeSJonathan Peyton         if ((kmp_uint64)st > ub_glob - upper)
431093e17cfeSJonathan Peyton           lastpriv = 1;
431193e17cfeSJonathan Peyton       } else { // negative loop stride
431293e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper + st < *ub);
431393e17cfeSJonathan Peyton         if (upper - ub_glob < (kmp_uint64)(-st))
431493e17cfeSJonathan Peyton           lastpriv = 1;
431593e17cfeSJonathan Peyton       }
431693e17cfeSJonathan Peyton     }
431793e17cfeSJonathan Peyton     next_task = __kmp_task_dup_alloc(thread, task); // allocate new task
431827a677fcSJonathan Peyton     kmp_taskdata_t *next_taskdata = KMP_TASK_TO_TASKDATA(next_task);
431927a677fcSJonathan Peyton     kmp_taskloop_bounds_t next_task_bounds =
432027a677fcSJonathan Peyton         kmp_taskloop_bounds_t(next_task, task_bounds);
432127a677fcSJonathan Peyton 
432293e17cfeSJonathan Peyton     // adjust task-specific bounds
432327a677fcSJonathan Peyton     next_task_bounds.set_lb(lower);
432427a677fcSJonathan Peyton     if (next_taskdata->td_flags.native) {
432527a677fcSJonathan Peyton       next_task_bounds.set_ub(upper + (st > 0 ? 1 : -1));
432627a677fcSJonathan Peyton     } else {
432727a677fcSJonathan Peyton       next_task_bounds.set_ub(upper);
432827a677fcSJonathan Peyton     }
43294c6a098aSKazuaki Ishizaki     if (ptask_dup != NULL) // set lastprivate flag, construct firstprivates,
43304c6a098aSKazuaki Ishizaki                            // etc.
433193e17cfeSJonathan Peyton       ptask_dup(next_task, task, lastpriv);
433227a677fcSJonathan Peyton     KA_TRACE(40,
433327a677fcSJonathan Peyton              ("__kmp_taskloop_linear: T#%d; task #%llu: task %p: lower %lld, "
433427a677fcSJonathan Peyton               "upper %lld stride %lld, (offsets %p %p)\n",
433527a677fcSJonathan Peyton               gtid, i, next_task, lower, upper, st,
433627a677fcSJonathan Peyton               next_task_bounds.get_lower_offset(),
433727a677fcSJonathan Peyton               next_task_bounds.get_upper_offset()));
4338cdaefac5SJoachim Protze #if OMPT_SUPPORT
4339cdaefac5SJoachim Protze     __kmp_omp_taskloop_task(NULL, gtid, next_task,
4340cdaefac5SJoachim Protze                             codeptr_ra); // schedule new task
4341cdaefac5SJoachim Protze #else
434293e17cfeSJonathan Peyton     __kmp_omp_task(gtid, next_task, true); // schedule new task
4343cdaefac5SJoachim Protze #endif
434493e17cfeSJonathan Peyton     lower = upper + st; // adjust lower bound for the next iteration
434593e17cfeSJonathan Peyton   }
434693e17cfeSJonathan Peyton   // free the pattern task and exit
434793e17cfeSJonathan Peyton   __kmp_task_start(gtid, task, current_task); // make internal bookkeeping
434893e17cfeSJonathan Peyton   // do not execute the pattern task, just do internal bookkeeping
434986ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task, current_task);
435093e17cfeSJonathan Peyton }
435193e17cfeSJonathan Peyton 
435293e17cfeSJonathan Peyton // Structure to keep taskloop parameters for auxiliary task
435393e17cfeSJonathan Peyton // kept in the shareds of the task structure.
435493e17cfeSJonathan Peyton typedef struct __taskloop_params {
435593e17cfeSJonathan Peyton   kmp_task_t *task;
435693e17cfeSJonathan Peyton   kmp_uint64 *lb;
435793e17cfeSJonathan Peyton   kmp_uint64 *ub;
435893e17cfeSJonathan Peyton   void *task_dup;
435993e17cfeSJonathan Peyton   kmp_int64 st;
436093e17cfeSJonathan Peyton   kmp_uint64 ub_glob;
436193e17cfeSJonathan Peyton   kmp_uint64 num_tasks;
436293e17cfeSJonathan Peyton   kmp_uint64 grainsize;
436393e17cfeSJonathan Peyton   kmp_uint64 extras;
4364540007b4SNawrin Sultana   kmp_int64 last_chunk;
436593e17cfeSJonathan Peyton   kmp_uint64 tc;
436693e17cfeSJonathan Peyton   kmp_uint64 num_t_min;
4367cdaefac5SJoachim Protze #if OMPT_SUPPORT
4368cdaefac5SJoachim Protze   void *codeptr_ra;
4369cdaefac5SJoachim Protze #endif
437093e17cfeSJonathan Peyton } __taskloop_params_t;
437193e17cfeSJonathan Peyton 
437293e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *, int, kmp_task_t *, kmp_uint64 *,
437393e17cfeSJonathan Peyton                           kmp_uint64 *, kmp_int64, kmp_uint64, kmp_uint64,
4374540007b4SNawrin Sultana                           kmp_uint64, kmp_uint64, kmp_int64, kmp_uint64,
4375540007b4SNawrin Sultana                           kmp_uint64,
4376cdaefac5SJoachim Protze #if OMPT_SUPPORT
4377cdaefac5SJoachim Protze                           void *,
4378cdaefac5SJoachim Protze #endif
437993e17cfeSJonathan Peyton                           void *);
438093e17cfeSJonathan Peyton 
4381ed5fe645SKelvin Li // Execute part of the taskloop submitted as a task.
438293e17cfeSJonathan Peyton int __kmp_taskloop_task(int gtid, void *ptask) {
4383d74d8902SJonathan Peyton   __taskloop_params_t *p =
4384d74d8902SJonathan Peyton       (__taskloop_params_t *)((kmp_task_t *)ptask)->shareds;
438593e17cfeSJonathan Peyton   kmp_task_t *task = p->task;
438693e17cfeSJonathan Peyton   kmp_uint64 *lb = p->lb;
438793e17cfeSJonathan Peyton   kmp_uint64 *ub = p->ub;
438893e17cfeSJonathan Peyton   void *task_dup = p->task_dup;
438993e17cfeSJonathan Peyton   //  p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
439093e17cfeSJonathan Peyton   kmp_int64 st = p->st;
439193e17cfeSJonathan Peyton   kmp_uint64 ub_glob = p->ub_glob;
439293e17cfeSJonathan Peyton   kmp_uint64 num_tasks = p->num_tasks;
439393e17cfeSJonathan Peyton   kmp_uint64 grainsize = p->grainsize;
439493e17cfeSJonathan Peyton   kmp_uint64 extras = p->extras;
4395540007b4SNawrin Sultana   kmp_int64 last_chunk = p->last_chunk;
439693e17cfeSJonathan Peyton   kmp_uint64 tc = p->tc;
439793e17cfeSJonathan Peyton   kmp_uint64 num_t_min = p->num_t_min;
4398cdaefac5SJoachim Protze #if OMPT_SUPPORT
4399cdaefac5SJoachim Protze   void *codeptr_ra = p->codeptr_ra;
4400cdaefac5SJoachim Protze #endif
440193e17cfeSJonathan Peyton #if KMP_DEBUG
440293e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
440393e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
4404540007b4SNawrin Sultana   KA_TRACE(20,
4405540007b4SNawrin Sultana            ("__kmp_taskloop_task: T#%d, task %p: %lld tasks, grainsize"
4406540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4407540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4408540007b4SNawrin Sultana             st, task_dup));
440993e17cfeSJonathan Peyton #endif
441093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks * 2 + 1 > num_t_min);
441193e17cfeSJonathan Peyton   if (num_tasks > num_t_min)
441293e17cfeSJonathan Peyton     __kmp_taskloop_recur(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4413540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_t_min,
4414cdaefac5SJoachim Protze #if OMPT_SUPPORT
4415cdaefac5SJoachim Protze                          codeptr_ra,
4416cdaefac5SJoachim Protze #endif
4417cdaefac5SJoachim Protze                          task_dup);
441893e17cfeSJonathan Peyton   else
441993e17cfeSJonathan Peyton     __kmp_taskloop_linear(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4420540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4421cdaefac5SJoachim Protze #if OMPT_SUPPORT
4422cdaefac5SJoachim Protze                           codeptr_ra,
4423cdaefac5SJoachim Protze #endif
4424cdaefac5SJoachim Protze                           task_dup);
442593e17cfeSJonathan Peyton 
442693e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmp_taskloop_task(exit): T#%d\n", gtid));
442793e17cfeSJonathan Peyton   return 0;
442893e17cfeSJonathan Peyton }
442993e17cfeSJonathan Peyton 
4430ed5fe645SKelvin Li // Schedule part of the taskloop as a task,
4431ed5fe645SKelvin Li // execute the rest of the taskloop.
443293e17cfeSJonathan Peyton //
443393e17cfeSJonathan Peyton // loc        Source location information
443493e17cfeSJonathan Peyton // gtid       Global thread ID
443593e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
443693e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
443793e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
443893e17cfeSJonathan Peyton // st         Loop stride
443993e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
444093e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
444193e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
444293e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4443540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
444493e17cfeSJonathan Peyton // tc         Iterations count
444542016791SKazuaki Ishizaki // num_t_min  Threshold to launch tasks recursively
444693e17cfeSJonathan Peyton // task_dup   Tasks duplication routine
4447cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
444893e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *loc, int gtid, kmp_task_t *task,
444993e17cfeSJonathan Peyton                           kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
445093e17cfeSJonathan Peyton                           kmp_uint64 ub_glob, kmp_uint64 num_tasks,
445193e17cfeSJonathan Peyton                           kmp_uint64 grainsize, kmp_uint64 extras,
4452540007b4SNawrin Sultana                           kmp_int64 last_chunk, kmp_uint64 tc,
4453540007b4SNawrin Sultana                           kmp_uint64 num_t_min,
4454cdaefac5SJoachim Protze #if OMPT_SUPPORT
4455cdaefac5SJoachim Protze                           void *codeptr_ra,
4456cdaefac5SJoachim Protze #endif
4457cdaefac5SJoachim Protze                           void *task_dup) {
445893e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
445993e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
446093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > num_t_min);
4461540007b4SNawrin Sultana   KA_TRACE(20,
4462540007b4SNawrin Sultana            ("__kmp_taskloop_recur: T#%d, task %p: %lld tasks, grainsize"
4463540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4464540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4465540007b4SNawrin Sultana             st, task_dup));
446693e17cfeSJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
446793e17cfeSJonathan Peyton   kmp_uint64 lower = *lb;
446893e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
446993e17cfeSJonathan Peyton   //  kmp_taskdata_t *current_task = thread->th.th_current_task;
447093e17cfeSJonathan Peyton   kmp_task_t *next_task;
447193e17cfeSJonathan Peyton   size_t lower_offset =
447293e17cfeSJonathan Peyton       (char *)lb - (char *)task; // remember offset of lb in the task structure
447393e17cfeSJonathan Peyton   size_t upper_offset =
447493e17cfeSJonathan Peyton       (char *)ub - (char *)task; // remember offset of ub in the task structure
447593e17cfeSJonathan Peyton 
4476309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4477309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
447893e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
447993e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
448093e17cfeSJonathan Peyton 
448193e17cfeSJonathan Peyton   // split the loop in two halves
448293e17cfeSJonathan Peyton   kmp_uint64 lb1, ub0, tc0, tc1, ext0, ext1;
4483540007b4SNawrin Sultana   kmp_int64 last_chunk0 = 0, last_chunk1 = 0;
448493e17cfeSJonathan Peyton   kmp_uint64 gr_size0 = grainsize;
448593e17cfeSJonathan Peyton   kmp_uint64 n_tsk0 = num_tasks >> 1; // num_tasks/2 to execute
448693e17cfeSJonathan Peyton   kmp_uint64 n_tsk1 = num_tasks - n_tsk0; // to schedule as a task
4487540007b4SNawrin Sultana   if (last_chunk < 0) {
4488540007b4SNawrin Sultana     ext0 = ext1 = 0;
4489540007b4SNawrin Sultana     last_chunk1 = last_chunk;
4490540007b4SNawrin Sultana     tc0 = grainsize * n_tsk0;
4491540007b4SNawrin Sultana     tc1 = tc - tc0;
4492540007b4SNawrin Sultana   } else if (n_tsk0 <= extras) {
449393e17cfeSJonathan Peyton     gr_size0++; // integrate extras into grainsize
449493e17cfeSJonathan Peyton     ext0 = 0; // no extra iters in 1st half
449593e17cfeSJonathan Peyton     ext1 = extras - n_tsk0; // remaining extras
449693e17cfeSJonathan Peyton     tc0 = gr_size0 * n_tsk0;
449793e17cfeSJonathan Peyton     tc1 = tc - tc0;
449893e17cfeSJonathan Peyton   } else { // n_tsk0 > extras
449993e17cfeSJonathan Peyton     ext1 = 0; // no extra iters in 2nd half
450093e17cfeSJonathan Peyton     ext0 = extras;
450193e17cfeSJonathan Peyton     tc1 = grainsize * n_tsk1;
450293e17cfeSJonathan Peyton     tc0 = tc - tc1;
450393e17cfeSJonathan Peyton   }
450493e17cfeSJonathan Peyton   ub0 = lower + st * (tc0 - 1);
450593e17cfeSJonathan Peyton   lb1 = ub0 + st;
450693e17cfeSJonathan Peyton 
450793e17cfeSJonathan Peyton   // create pattern task for 2nd half of the loop
450893e17cfeSJonathan Peyton   next_task = __kmp_task_dup_alloc(thread, task); // duplicate the task
450993e17cfeSJonathan Peyton   // adjust lower bound (upper bound is not changed) for the 2nd half
451093e17cfeSJonathan Peyton   *(kmp_uint64 *)((char *)next_task + lower_offset) = lb1;
45114c6a098aSKazuaki Ishizaki   if (ptask_dup != NULL) // construct firstprivates, etc.
451293e17cfeSJonathan Peyton     ptask_dup(next_task, task, 0);
451393e17cfeSJonathan Peyton   *ub = ub0; // adjust upper bound for the 1st half
451493e17cfeSJonathan Peyton 
451593e17cfeSJonathan Peyton   // create auxiliary task for 2nd half of the loop
45165e111c5dSAndreyChurbanov   // make sure new task has same parent task as the pattern task
45175e111c5dSAndreyChurbanov   kmp_taskdata_t *current_task = thread->th.th_current_task;
45185e111c5dSAndreyChurbanov   thread->th.th_current_task = taskdata->td_parent;
451993e17cfeSJonathan Peyton   kmp_task_t *new_task =
452093e17cfeSJonathan Peyton       __kmpc_omp_task_alloc(loc, gtid, 1, 3 * sizeof(void *),
452193e17cfeSJonathan Peyton                             sizeof(__taskloop_params_t), &__kmp_taskloop_task);
45225e111c5dSAndreyChurbanov   // restore current task
45235e111c5dSAndreyChurbanov   thread->th.th_current_task = current_task;
452493e17cfeSJonathan Peyton   __taskloop_params_t *p = (__taskloop_params_t *)new_task->shareds;
452593e17cfeSJonathan Peyton   p->task = next_task;
452693e17cfeSJonathan Peyton   p->lb = (kmp_uint64 *)((char *)next_task + lower_offset);
452793e17cfeSJonathan Peyton   p->ub = (kmp_uint64 *)((char *)next_task + upper_offset);
452893e17cfeSJonathan Peyton   p->task_dup = task_dup;
452993e17cfeSJonathan Peyton   p->st = st;
453093e17cfeSJonathan Peyton   p->ub_glob = ub_glob;
453193e17cfeSJonathan Peyton   p->num_tasks = n_tsk1;
453293e17cfeSJonathan Peyton   p->grainsize = grainsize;
453393e17cfeSJonathan Peyton   p->extras = ext1;
4534540007b4SNawrin Sultana   p->last_chunk = last_chunk1;
453593e17cfeSJonathan Peyton   p->tc = tc1;
453693e17cfeSJonathan Peyton   p->num_t_min = num_t_min;
4537cdaefac5SJoachim Protze #if OMPT_SUPPORT
4538cdaefac5SJoachim Protze   p->codeptr_ra = codeptr_ra;
4539cdaefac5SJoachim Protze #endif
4540cdaefac5SJoachim Protze 
4541cdaefac5SJoachim Protze #if OMPT_SUPPORT
4542cdaefac5SJoachim Protze   // schedule new task with correct return address for OMPT events
4543cdaefac5SJoachim Protze   __kmp_omp_taskloop_task(NULL, gtid, new_task, codeptr_ra);
4544cdaefac5SJoachim Protze #else
4545f729df82SGheorghe-Teodor Bercea   __kmp_omp_task(gtid, new_task, true); // schedule new task
4546cdaefac5SJoachim Protze #endif
454793e17cfeSJonathan Peyton 
454893e17cfeSJonathan Peyton   // execute the 1st half of current subrange
454993e17cfeSJonathan Peyton   if (n_tsk0 > num_t_min)
4550d74d8902SJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0, gr_size0,
4551540007b4SNawrin Sultana                          ext0, last_chunk0, tc0, num_t_min,
4552cdaefac5SJoachim Protze #if OMPT_SUPPORT
4553cdaefac5SJoachim Protze                          codeptr_ra,
4554cdaefac5SJoachim Protze #endif
4555cdaefac5SJoachim Protze                          task_dup);
455693e17cfeSJonathan Peyton   else
455793e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0,
4558540007b4SNawrin Sultana                           gr_size0, ext0, last_chunk0, tc0,
4559cdaefac5SJoachim Protze #if OMPT_SUPPORT
4560cdaefac5SJoachim Protze                           codeptr_ra,
4561cdaefac5SJoachim Protze #endif
4562cdaefac5SJoachim Protze                           task_dup);
456393e17cfeSJonathan Peyton 
4564540007b4SNawrin Sultana   KA_TRACE(40, ("__kmp_taskloop_recur(exit): T#%d\n", gtid));
456593e17cfeSJonathan Peyton }
456693e17cfeSJonathan Peyton 
4567540007b4SNawrin Sultana static void __kmp_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4568540007b4SNawrin Sultana                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4569540007b4SNawrin Sultana                            int nogroup, int sched, kmp_uint64 grainsize,
4570540007b4SNawrin Sultana                            int modifier, void *task_dup) {
457193e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
457293e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
457382e94a59SJoachim Protze   if (nogroup == 0) {
457482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
457582e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
457682e94a59SJoachim Protze #endif
457793e17cfeSJonathan Peyton     __kmpc_taskgroup(loc, gtid);
457882e94a59SJoachim Protze   }
457993e17cfeSJonathan Peyton 
458093e17cfeSJonathan Peyton   // =========================================================================
458193e17cfeSJonathan Peyton   // calculate loop parameters
458227a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
458393e17cfeSJonathan Peyton   kmp_uint64 tc;
458427a677fcSJonathan Peyton   // compiler provides global bounds here
458527a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
458627a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
458793e17cfeSJonathan Peyton   kmp_uint64 ub_glob = upper; // global upper used to calc lastprivate flag
458893e17cfeSJonathan Peyton   kmp_uint64 num_tasks = 0, extras = 0;
4589540007b4SNawrin Sultana   kmp_int64 last_chunk =
4590540007b4SNawrin Sultana       0; // reduce grainsize of last task by last_chunk in strict mode
459193e17cfeSJonathan Peyton   kmp_uint64 num_tasks_min = __kmp_taskloop_min_tasks;
459293e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
459393e17cfeSJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
459493e17cfeSJonathan Peyton 
4595540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop: T#%d, task %p, lb %lld, ub %lld, st %lld, "
4596540007b4SNawrin Sultana                 "grain %llu(%d, %d), dup %p\n",
4597540007b4SNawrin Sultana                 gtid, taskdata, lower, upper, st, grainsize, sched, modifier,
4598540007b4SNawrin Sultana                 task_dup));
459927a677fcSJonathan Peyton 
46007cc577a4SJonathan Peyton   // compute trip count
46017cc577a4SJonathan Peyton   if (st == 1) { // most common case
46027cc577a4SJonathan Peyton     tc = upper - lower + 1;
46037cc577a4SJonathan Peyton   } else if (st < 0) {
46047cc577a4SJonathan Peyton     tc = (lower - upper) / (-st) + 1;
46057cc577a4SJonathan Peyton   } else { // st > 0
46067cc577a4SJonathan Peyton     tc = (upper - lower) / st + 1;
46077cc577a4SJonathan Peyton   }
46087cc577a4SJonathan Peyton   if (tc == 0) {
4609540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop(exit): T#%d zero-trip loop\n", gtid));
46107cc577a4SJonathan Peyton     // free the pattern task and exit
46117cc577a4SJonathan Peyton     __kmp_task_start(gtid, task, current_task);
46127cc577a4SJonathan Peyton     // do not execute anything for zero-trip loop
461386ed6aa6SJoachim Protze     __kmp_task_finish<false>(gtid, task, current_task);
46147cc577a4SJonathan Peyton     return;
46157cc577a4SJonathan Peyton   }
4616cdaefac5SJoachim Protze 
4617cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4618cdaefac5SJoachim Protze   ompt_team_info_t *team_info = __ompt_get_teaminfo(0, NULL);
4619cdaefac5SJoachim Protze   ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
4620cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4621cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4622cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_begin, &(team_info->parallel_data),
4623cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4624cdaefac5SJoachim Protze   }
4625cdaefac5SJoachim Protze #endif
4626cdaefac5SJoachim Protze 
462793e17cfeSJonathan Peyton   if (num_tasks_min == 0)
462893e17cfeSJonathan Peyton     // TODO: can we choose better default heuristic?
4629d74d8902SJonathan Peyton     num_tasks_min =
4630d74d8902SJonathan Peyton         KMP_MIN(thread->th.th_team_nproc * 10, INITIAL_TASK_DEQUE_SIZE);
46317cc577a4SJonathan Peyton 
46327cc577a4SJonathan Peyton   // compute num_tasks/grainsize based on the input provided
46337cc577a4SJonathan Peyton   switch (sched) {
46347cc577a4SJonathan Peyton   case 0: // no schedule clause specified, we can choose the default
46357cc577a4SJonathan Peyton     // let's try to schedule (team_size*10) tasks
46367cc577a4SJonathan Peyton     grainsize = thread->th.th_team_nproc * 10;
46370c599c38SJoachim Protze     KMP_FALLTHROUGH();
46387cc577a4SJonathan Peyton   case 2: // num_tasks provided
46397cc577a4SJonathan Peyton     if (grainsize > tc) {
46407cc577a4SJonathan Peyton       num_tasks = tc; // too big num_tasks requested, adjust values
46417cc577a4SJonathan Peyton       grainsize = 1;
46427cc577a4SJonathan Peyton       extras = 0;
46437cc577a4SJonathan Peyton     } else {
46447cc577a4SJonathan Peyton       num_tasks = grainsize;
46457cc577a4SJonathan Peyton       grainsize = tc / num_tasks;
46467cc577a4SJonathan Peyton       extras = tc % num_tasks;
46477cc577a4SJonathan Peyton     }
46487cc577a4SJonathan Peyton     break;
46497cc577a4SJonathan Peyton   case 1: // grainsize provided
46507cc577a4SJonathan Peyton     if (grainsize > tc) {
4651540007b4SNawrin Sultana       num_tasks = 1;
4652540007b4SNawrin Sultana       grainsize = tc; // too big grainsize requested, adjust values
4653540007b4SNawrin Sultana       extras = 0;
4654540007b4SNawrin Sultana     } else {
4655540007b4SNawrin Sultana       if (modifier) {
4656540007b4SNawrin Sultana         num_tasks = (tc + grainsize - 1) / grainsize;
4657540007b4SNawrin Sultana         last_chunk = tc - (num_tasks * grainsize);
46587cc577a4SJonathan Peyton         extras = 0;
46597cc577a4SJonathan Peyton       } else {
46607cc577a4SJonathan Peyton         num_tasks = tc / grainsize;
466193e17cfeSJonathan Peyton         // adjust grainsize for balanced distribution of iterations
466293e17cfeSJonathan Peyton         grainsize = tc / num_tasks;
46637cc577a4SJonathan Peyton         extras = tc % num_tasks;
46647cc577a4SJonathan Peyton       }
4665540007b4SNawrin Sultana     }
46667cc577a4SJonathan Peyton     break;
46677cc577a4SJonathan Peyton   default:
46687cc577a4SJonathan Peyton     KMP_ASSERT2(0, "unknown scheduling of taskloop");
46697cc577a4SJonathan Peyton   }
4670540007b4SNawrin Sultana 
4671309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4672309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
46737cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
46747cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
467593e17cfeSJonathan Peyton   // =========================================================================
46767cc577a4SJonathan Peyton 
46777cc577a4SJonathan Peyton   // check if clause value first
467827a677fcSJonathan Peyton   // Also require GOMP_taskloop to reduce to linear (taskdata->td_flags.native)
46797cc577a4SJonathan Peyton   if (if_val == 0) { // if(0) specified, mark task as serial
46807cc577a4SJonathan Peyton     taskdata->td_flags.task_serial = 1;
46817cc577a4SJonathan Peyton     taskdata->td_flags.tiedness = TASK_TIED; // AC: serial task cannot be untied
468293e17cfeSJonathan Peyton     // always start serial tasks linearly
468393e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4684540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4685cdaefac5SJoachim Protze #if OMPT_SUPPORT
4686cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4687cdaefac5SJoachim Protze #endif
4688cdaefac5SJoachim Protze                           task_dup);
468927a677fcSJonathan Peyton     // !taskdata->td_flags.native => currently force linear spawning of tasks
469027a677fcSJonathan Peyton     // for GOMP_taskloop
469127a677fcSJonathan Peyton   } else if (num_tasks > num_tasks_min && !taskdata->td_flags.native) {
4692540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go recursive: tc %llu, #tasks %llu"
4693540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4694540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4695540007b4SNawrin Sultana                   last_chunk));
469693e17cfeSJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4697540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_tasks_min,
4698cdaefac5SJoachim Protze #if OMPT_SUPPORT
4699cdaefac5SJoachim Protze                          OMPT_GET_RETURN_ADDRESS(0),
4700cdaefac5SJoachim Protze #endif
4701cdaefac5SJoachim Protze                          task_dup);
470293e17cfeSJonathan Peyton   } else {
4703540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go linear: tc %llu, #tasks %llu"
4704540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4705540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4706540007b4SNawrin Sultana                   last_chunk));
470793e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4708540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4709cdaefac5SJoachim Protze #if OMPT_SUPPORT
4710cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4711cdaefac5SJoachim Protze #endif
4712cdaefac5SJoachim Protze                           task_dup);
47137cc577a4SJonathan Peyton   }
47147cc577a4SJonathan Peyton 
4715cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4716cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4717cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4718cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_end, &(team_info->parallel_data),
4719cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4720cdaefac5SJoachim Protze   }
4721cdaefac5SJoachim Protze #endif
4722cdaefac5SJoachim Protze 
472382e94a59SJoachim Protze   if (nogroup == 0) {
472482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
472582e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
472682e94a59SJoachim Protze #endif
47277cc577a4SJonathan Peyton     __kmpc_end_taskgroup(loc, gtid);
472882e94a59SJoachim Protze   }
4729540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop(exit): T#%d\n", gtid));
4730540007b4SNawrin Sultana }
4731540007b4SNawrin Sultana 
4732540007b4SNawrin Sultana /*!
4733540007b4SNawrin Sultana @ingroup TASKING
4734540007b4SNawrin Sultana @param loc       Source location information
4735540007b4SNawrin Sultana @param gtid      Global thread ID
4736540007b4SNawrin Sultana @param task      Task structure
4737540007b4SNawrin Sultana @param if_val    Value of the if clause
4738540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4739540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4740540007b4SNawrin Sultana @param st        Loop stride
4741540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4742540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4743540007b4SNawrin Sultana @param grainsize Schedule value if specified
4744540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4745540007b4SNawrin Sultana 
4746540007b4SNawrin Sultana Execute the taskloop construct.
4747540007b4SNawrin Sultana */
4748540007b4SNawrin Sultana void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4749540007b4SNawrin Sultana                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,
4750540007b4SNawrin Sultana                      int sched, kmp_uint64 grainsize, void *task_dup) {
4751540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4752540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop(enter): T#%d\n", gtid));
4753540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4754540007b4SNawrin Sultana                  0, task_dup);
475593e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d\n", gtid));
47567cc577a4SJonathan Peyton }
4757540007b4SNawrin Sultana 
4758540007b4SNawrin Sultana /*!
4759540007b4SNawrin Sultana @ingroup TASKING
4760540007b4SNawrin Sultana @param loc       Source location information
4761540007b4SNawrin Sultana @param gtid      Global thread ID
4762540007b4SNawrin Sultana @param task      Task structure
4763540007b4SNawrin Sultana @param if_val    Value of the if clause
4764540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4765540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4766540007b4SNawrin Sultana @param st        Loop stride
4767540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4768540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4769540007b4SNawrin Sultana @param grainsize Schedule value if specified
4770540007b4SNawrin Sultana @param modifer   Modifier 'strict' for sched, 1 if present, 0 otherwise
4771540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4772540007b4SNawrin Sultana 
4773540007b4SNawrin Sultana Execute the taskloop construct.
4774540007b4SNawrin Sultana */
4775540007b4SNawrin Sultana void __kmpc_taskloop_5(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4776540007b4SNawrin Sultana                        kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4777540007b4SNawrin Sultana                        int nogroup, int sched, kmp_uint64 grainsize,
4778540007b4SNawrin Sultana                        int modifier, void *task_dup) {
4779540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4780540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(enter): T#%d\n", gtid));
4781540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4782540007b4SNawrin Sultana                  modifier, task_dup);
4783540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(exit): T#%d\n", gtid));
4784540007b4SNawrin Sultana }
4785