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 
3271d8d43aeSShilei Tian   // If we encounter a hidden helper task, and the current thread is not a
3281d8d43aeSShilei Tian   // hidden helper thread, we have to give the task to any hidden helper thread
3291d8d43aeSShilei Tian   // starting from its shadow one.
3301d8d43aeSShilei Tian   if (UNLIKELY(taskdata->td_flags.hidden_helper &&
3311d8d43aeSShilei Tian                !KMP_HIDDEN_HELPER_THREAD(gtid))) {
3321d8d43aeSShilei Tian     kmp_int32 shadow_gtid = KMP_GTID_TO_SHADOW_GTID(gtid);
3331d8d43aeSShilei Tian     __kmpc_give_task(task, __kmp_tid_from_gtid(shadow_gtid));
3341d8d43aeSShilei Tian     // Signal the hidden helper threads.
3351d8d43aeSShilei Tian     __kmp_hidden_helper_worker_thread_signal();
3361d8d43aeSShilei 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 
8108442967fSShilei Tian // Only need to keep track of child task counts if any of the following:
8118442967fSShilei Tian // 1. team parallel and tasking not serialized;
8128442967fSShilei Tian // 2. it is a proxy or detachable or hidden helper task
8138442967fSShilei Tian // 3. the children counter of its parent task is greater than 0.
8148442967fSShilei Tian // The reason for the 3rd one is for serialized team that found detached task,
8158442967fSShilei Tian // hidden helper task, T. In this case, the execution of T is still deferred,
8168442967fSShilei Tian // and it is also possible that a regular task depends on T. In this case, if we
8178442967fSShilei Tian // don't track the children, task synchronization will be broken.
8188442967fSShilei Tian static bool __kmp_track_children_task(kmp_taskdata_t *taskdata) {
8198442967fSShilei Tian   kmp_tasking_flags_t flags = taskdata->td_flags;
8208442967fSShilei Tian   bool ret = !(flags.team_serial || flags.tasking_ser);
8218442967fSShilei Tian   ret = ret || flags.proxy == TASK_PROXY ||
8228442967fSShilei Tian         flags.detachable == TASK_DETACHABLE || flags.hidden_helper;
8238442967fSShilei Tian   ret = ret ||
8248442967fSShilei Tian         KMP_ATOMIC_LD_ACQ(&taskdata->td_parent->td_incomplete_child_tasks) > 0;
8258442967fSShilei Tian   return ret;
8268442967fSShilei Tian }
8278442967fSShilei Tian 
8287cc577a4SJonathan Peyton // __kmp_task_finish: bookkeeping to do when a task finishes execution
8293041982dSJonathan Peyton //
8307cc577a4SJonathan Peyton // gtid: global thread ID for calling thread
8317cc577a4SJonathan Peyton // task: task to be finished
8327cc577a4SJonathan Peyton // resumed_task: task to be resumed.  (may be NULL if task is serialized)
83310995c77SJoachim Protze //
83410995c77SJoachim Protze // template<ompt>: effectively ompt_enabled.enabled!=0
83510995c77SJoachim Protze // the version with ompt=false is inlined, allowing to optimize away all ompt
83610995c77SJoachim Protze // code in this case
83786ed6aa6SJoachim Protze template <bool ompt>
8383041982dSJonathan Peyton static void __kmp_task_finish(kmp_int32 gtid, kmp_task_t *task,
8393041982dSJonathan Peyton                               kmp_taskdata_t *resumed_task) {
8407cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
8417cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
8423041982dSJonathan Peyton   kmp_task_team_t *task_team =
8433041982dSJonathan Peyton       thread->th.th_task_team; // might be NULL for serial teams...
8448b81524cSAndreyChurbanov #if KMP_DEBUG
8457cc577a4SJonathan Peyton   kmp_int32 children = 0;
8468b81524cSAndreyChurbanov #endif
8473041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_finish(enter): T#%d finishing task %p and resuming "
8483041982dSJonathan Peyton                 "task %p\n",
8497cc577a4SJonathan Peyton                 gtid, taskdata, resumed_task));
8507cc577a4SJonathan Peyton 
8517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
8527cc577a4SJonathan Peyton 
8537cc577a4SJonathan Peyton // Pop task from stack if tied
8547cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
8553041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
8567cc577a4SJonathan Peyton     __kmp_pop_task_stack(gtid, thread, taskdata);
8577cc577a4SJonathan Peyton   }
8587cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
8597cc577a4SJonathan Peyton 
8606bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.tiedness == TASK_UNTIED)) {
8613041982dSJonathan Peyton     // untied task needs to check the counter so that the task structure is not
8623041982dSJonathan Peyton     // freed prematurely
86337e2ef54SJonathan Peyton     kmp_int32 counter = KMP_ATOMIC_DEC(&taskdata->td_untied_count) - 1;
8643041982dSJonathan Peyton     KA_TRACE(
8653041982dSJonathan Peyton         20,
8663041982dSJonathan Peyton         ("__kmp_task_finish: T#%d untied_count (%d) decremented for task %p\n",
8677cc577a4SJonathan Peyton          gtid, counter, taskdata));
8687cc577a4SJonathan Peyton     if (counter > 0) {
8693041982dSJonathan Peyton       // untied task is not done, to be continued possibly by other thread, do
8703041982dSJonathan Peyton       // not free it now
8717cc577a4SJonathan Peyton       if (resumed_task == NULL) {
8727cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(taskdata->td_flags.task_serial);
8733041982dSJonathan Peyton         resumed_task = taskdata->td_parent; // In a serialized task, the resumed
8743041982dSJonathan Peyton         // task is the parent
8757cc577a4SJonathan Peyton       }
8767cc577a4SJonathan Peyton       thread->th.th_current_task = resumed_task; // restore current_task
8777cc577a4SJonathan Peyton       resumed_task->td_flags.executing = 1; // resume previous task
8783041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_task_finish(exit): T#%d partially done task %p, "
8793041982dSJonathan Peyton                     "resuming task %p\n",
8807cc577a4SJonathan Peyton                     gtid, taskdata, resumed_task));
8817cc577a4SJonathan Peyton       return;
8827cc577a4SJonathan Peyton     }
8837cc577a4SJonathan Peyton   }
8847cc577a4SJonathan Peyton 
885d23131a3SJoachim Protze   // bookkeeping for resuming task:
886d23131a3SJoachim Protze   // GEH - note tasking_ser => task_serial
887d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(
888d23131a3SJoachim Protze       (taskdata->td_flags.tasking_ser || taskdata->td_flags.task_serial) ==
889d23131a3SJoachim Protze       taskdata->td_flags.task_serial);
890d23131a3SJoachim Protze   if (taskdata->td_flags.task_serial) {
891d23131a3SJoachim Protze     if (resumed_task == NULL) {
892d23131a3SJoachim Protze       resumed_task = taskdata->td_parent; // In a serialized task, the resumed
893d23131a3SJoachim Protze       // task is the parent
894d23131a3SJoachim Protze     }
895d23131a3SJoachim Protze   } else {
896d23131a3SJoachim Protze     KMP_DEBUG_ASSERT(resumed_task !=
897d23131a3SJoachim Protze                      NULL); // verify that resumed task is passed as argument
898d23131a3SJoachim Protze   }
899d23131a3SJoachim Protze 
900d23131a3SJoachim Protze   /* If the tasks' destructor thunk flag has been set, we need to invoke the
901d23131a3SJoachim Protze      destructor thunk that has been generated by the compiler. The code is
902d23131a3SJoachim Protze      placed here, since at this point other tasks might have been released
903d23131a3SJoachim Protze      hence overlapping the destructor invocations with some other work in the
904d23131a3SJoachim Protze      released tasks.  The OpenMP spec is not specific on when the destructors
905d23131a3SJoachim Protze      are invoked, so we should be free to choose. */
906838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.destructors_thunk)) {
907d23131a3SJoachim Protze     kmp_routine_entry_t destr_thunk = task->data1.destructors;
908d23131a3SJoachim Protze     KMP_ASSERT(destr_thunk);
909d23131a3SJoachim Protze     destr_thunk(gtid, task);
910d23131a3SJoachim Protze   }
911d23131a3SJoachim Protze 
9127cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
913d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 1);
914d23131a3SJoachim Protze   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
915d23131a3SJoachim Protze 
916405037c4SAndrey Churbanov   bool detach = false;
917838dcdb5SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.detachable == TASK_DETACHABLE)) {
918405037c4SAndrey Churbanov     if (taskdata->td_allow_completion_event.type ==
919405037c4SAndrey Churbanov         KMP_EVENT_ALLOW_COMPLETION) {
920405037c4SAndrey Churbanov       // event hasn't been fulfilled yet. Try to detach task.
921405037c4SAndrey Churbanov       __kmp_acquire_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
922405037c4SAndrey Churbanov       if (taskdata->td_allow_completion_event.type ==
923405037c4SAndrey Churbanov           KMP_EVENT_ALLOW_COMPLETION) {
924d23131a3SJoachim Protze         // task finished execution
925d23131a3SJoachim Protze         KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
926d23131a3SJoachim Protze         taskdata->td_flags.executing = 0; // suspend the finishing task
92710995c77SJoachim Protze 
92810995c77SJoachim Protze #if OMPT_SUPPORT
92910995c77SJoachim Protze         // For a detached task, which is not completed, we switch back
93010995c77SJoachim Protze         // the omp_fulfill_event signals completion
93110995c77SJoachim Protze         // locking is necessary to avoid a race with ompt_task_late_fulfill
93210995c77SJoachim Protze         if (ompt)
93310995c77SJoachim Protze           __ompt_task_finish(task, resumed_task, ompt_task_detach);
93410995c77SJoachim Protze #endif
93510995c77SJoachim Protze 
936d23131a3SJoachim Protze         // no access to taskdata after this point!
937d23131a3SJoachim Protze         // __kmp_fulfill_event might free taskdata at any time from now
93810995c77SJoachim Protze 
939405037c4SAndrey Churbanov         taskdata->td_flags.proxy = TASK_PROXY; // proxify!
940405037c4SAndrey Churbanov         detach = true;
941405037c4SAndrey Churbanov       }
942405037c4SAndrey Churbanov       __kmp_release_tas_lock(&taskdata->td_allow_completion_event.lock, gtid);
943405037c4SAndrey Churbanov     }
944405037c4SAndrey Churbanov   }
9457cc577a4SJonathan Peyton 
946405037c4SAndrey Churbanov   if (!detach) {
947405037c4SAndrey Churbanov     taskdata->td_flags.complete = 1; // mark the task as completed
948405037c4SAndrey Churbanov 
94910995c77SJoachim Protze #if OMPT_SUPPORT
95010995c77SJoachim Protze     // This is not a detached task, we are done here
95110995c77SJoachim Protze     if (ompt)
95210995c77SJoachim Protze       __ompt_task_finish(task, resumed_task, ompt_task_complete);
95310995c77SJoachim Protze #endif
9548442967fSShilei Tian     // TODO: What would be the balance between the conditions in the function
9558442967fSShilei Tian     // and an atomic operation?
9568442967fSShilei Tian     if (__kmp_track_children_task(taskdata)) {
957c2c43132SShilei Tian       __kmp_release_deps(gtid, taskdata);
9587cc577a4SJonathan Peyton       // Predecrement simulated by "- 1" calculation
9598b81524cSAndreyChurbanov #if KMP_DEBUG
9608b81524cSAndreyChurbanov       children = -1 +
9618b81524cSAndreyChurbanov #endif
9628b81524cSAndreyChurbanov           KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks);
9637cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(children >= 0);
9647cc577a4SJonathan Peyton       if (taskdata->td_taskgroup)
96537e2ef54SJonathan Peyton         KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
966c2c43132SShilei Tian     } else if (task_team && (task_team->tt.tt_found_proxy_tasks ||
967c2c43132SShilei Tian                              task_team->tt.tt_hidden_helper_task_encountered)) {
968c2c43132SShilei Tian       // if we found proxy or hidden helper tasks there could exist a dependency
969c2c43132SShilei Tian       // chain with the proxy task as origin
9707cc577a4SJonathan Peyton       __kmp_release_deps(gtid, taskdata);
9717cc577a4SJonathan Peyton     }
9723041982dSJonathan Peyton     // td_flags.executing must be marked as 0 after __kmp_release_deps has been
973d23131a3SJoachim Protze     // called. Othertwise, if a task is executed immediately from the
974d23131a3SJoachim Protze     // release_deps code, the flag will be reset to 1 again by this same
975d23131a3SJoachim Protze     // function
9767cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
9777cc577a4SJonathan Peyton     taskdata->td_flags.executing = 0; // suspend the finishing task
978d23131a3SJoachim Protze   }
979d23131a3SJoachim Protze 
9803041982dSJonathan Peyton   KA_TRACE(
9813041982dSJonathan Peyton       20, ("__kmp_task_finish: T#%d finished task %p, %d incomplete children\n",
9827cc577a4SJonathan Peyton            gtid, taskdata, children));
9837cc577a4SJonathan Peyton 
9847cc577a4SJonathan Peyton   // Free this task and then ancestor tasks if they have no children.
9857cc577a4SJonathan Peyton   // Restore th_current_task first as suggested by John:
9867cc577a4SJonathan Peyton   // johnmc: if an asynchronous inquiry peers into the runtime system
9877cc577a4SJonathan Peyton   // it doesn't see the freed task as the current task.
9887cc577a4SJonathan Peyton   thread->th.th_current_task = resumed_task;
989405037c4SAndrey Churbanov   if (!detach)
9907cc577a4SJonathan Peyton     __kmp_free_task_and_ancestors(gtid, taskdata, thread);
9917cc577a4SJonathan Peyton 
9927cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
9937cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( resumed_task->td_flags.executing == 0 );
9947cc577a4SJonathan Peyton   resumed_task->td_flags.executing = 1; // resume previous task
9957cc577a4SJonathan Peyton 
9963041982dSJonathan Peyton   KA_TRACE(
9973041982dSJonathan Peyton       10, ("__kmp_task_finish(exit): T#%d finished task %p, resuming task %p\n",
9987cc577a4SJonathan Peyton            gtid, taskdata, resumed_task));
9997cc577a4SJonathan Peyton 
10007cc577a4SJonathan Peyton   return;
10017cc577a4SJonathan Peyton }
10027cc577a4SJonathan Peyton 
100382e94a59SJoachim Protze template <bool ompt>
100482e94a59SJoachim Protze static void __kmpc_omp_task_complete_if0_template(ident_t *loc_ref,
100582e94a59SJoachim Protze                                                   kmp_int32 gtid,
10063041982dSJonathan Peyton                                                   kmp_task_t *task) {
10077cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(enter): T#%d loc=%p task=%p\n",
10087cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
1009838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
10103041982dSJonathan Peyton   // this routine will provide task to resume
101186ed6aa6SJoachim Protze   __kmp_task_finish<ompt>(gtid, task, NULL);
10127cc577a4SJonathan Peyton 
10137cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(exit): T#%d loc=%p task=%p\n",
10147cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
101582e94a59SJoachim Protze 
101682e94a59SJoachim Protze #if OMPT_SUPPORT
101782e94a59SJoachim Protze   if (ompt) {
10180e0d6cddSJoachim Protze     ompt_frame_t *ompt_frame;
101982e94a59SJoachim Protze     __ompt_get_task_info_internal(0, NULL, NULL, &ompt_frame, NULL, NULL);
10200e0d6cddSJoachim Protze     ompt_frame->enter_frame = ompt_data_none;
1021309b00a4SShilei Tian     ompt_frame->enter_frame_flags =
1022309b00a4SShilei Tian         ompt_frame_runtime | ompt_frame_framepointer;
102382e94a59SJoachim Protze   }
102482e94a59SJoachim Protze #endif
102582e94a59SJoachim Protze 
10267cc577a4SJonathan Peyton   return;
10277cc577a4SJonathan Peyton }
10287cc577a4SJonathan Peyton 
102982e94a59SJoachim Protze #if OMPT_SUPPORT
103082e94a59SJoachim Protze OMPT_NOINLINE
103182e94a59SJoachim Protze void __kmpc_omp_task_complete_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
103282e94a59SJoachim Protze                                        kmp_task_t *task) {
103382e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<true>(loc_ref, gtid, task);
103482e94a59SJoachim Protze }
103582e94a59SJoachim Protze #endif // OMPT_SUPPORT
103682e94a59SJoachim Protze 
103782e94a59SJoachim Protze // __kmpc_omp_task_complete_if0: report that a task has completed execution
103882e94a59SJoachim Protze //
103982e94a59SJoachim Protze // loc_ref: source location information; points to end of task block.
104082e94a59SJoachim Protze // gtid: global thread number.
104182e94a59SJoachim Protze // task: task thunk for the completed task.
104282e94a59SJoachim Protze void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
104382e94a59SJoachim Protze                                   kmp_task_t *task) {
104482e94a59SJoachim Protze #if OMPT_SUPPORT
104582e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
104682e94a59SJoachim Protze     __kmpc_omp_task_complete_if0_ompt(loc_ref, gtid, task);
104782e94a59SJoachim Protze     return;
104882e94a59SJoachim Protze   }
104982e94a59SJoachim Protze #endif
105082e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<false>(loc_ref, gtid, task);
105182e94a59SJoachim Protze }
105282e94a59SJoachim Protze 
10537cc577a4SJonathan Peyton #ifdef TASK_UNUSED
10547cc577a4SJonathan Peyton // __kmpc_omp_task_complete: report that a task has completed execution
10557cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
10563041982dSJonathan Peyton void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
10573041982dSJonathan Peyton                               kmp_task_t *task) {
10583041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(enter): T#%d loc=%p task=%p\n", gtid,
10593041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10607cc577a4SJonathan Peyton 
106186ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task,
106286ed6aa6SJoachim Protze                            NULL); // Not sure how to find task to resume
10637cc577a4SJonathan Peyton 
10643041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(exit): T#%d loc=%p task=%p\n", gtid,
10653041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
10667cc577a4SJonathan Peyton   return;
10677cc577a4SJonathan Peyton }
10687cc577a4SJonathan Peyton #endif // TASK_UNUSED
10697cc577a4SJonathan Peyton 
10703041982dSJonathan Peyton // __kmp_init_implicit_task: Initialize the appropriate fields in the implicit
10713041982dSJonathan Peyton // task for a given thread
10727cc577a4SJonathan Peyton //
10737cc577a4SJonathan Peyton // loc_ref:  reference to source location of parallel region
10747cc577a4SJonathan Peyton // this_thr:  thread data structure corresponding to implicit task
10757cc577a4SJonathan Peyton // team: team for this_thr
10767cc577a4SJonathan Peyton // tid: thread id of given thread within team
10777cc577a4SJonathan Peyton // set_curr_task: TRUE if need to push current task to thread
10783041982dSJonathan Peyton // NOTE: Routine does not set up the implicit task ICVS.  This is assumed to
10793041982dSJonathan Peyton // have already been done elsewhere.
10807cc577a4SJonathan Peyton // TODO: Get better loc_ref.  Value passed in may be NULL
10813041982dSJonathan Peyton void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
10823041982dSJonathan Peyton                               kmp_team_t *team, int tid, int set_curr_task) {
10837cc577a4SJonathan Peyton   kmp_taskdata_t *task = &team->t.t_implicit_task_taskdata[tid];
10847cc577a4SJonathan Peyton 
10853041982dSJonathan Peyton   KF_TRACE(
10863041982dSJonathan Peyton       10,
10873041982dSJonathan Peyton       ("__kmp_init_implicit_task(enter): T#:%d team=%p task=%p, reinit=%s\n",
10887cc577a4SJonathan Peyton        tid, team, task, set_curr_task ? "TRUE" : "FALSE"));
10897cc577a4SJonathan Peyton 
10907cc577a4SJonathan Peyton   task->td_task_id = KMP_GEN_TASK_ID();
10917cc577a4SJonathan Peyton   task->td_team = team;
10923041982dSJonathan Peyton   //    task->td_parent   = NULL;  // fix for CQ230101 (broken parent task info
10933041982dSJonathan Peyton   //    in debugger)
10947cc577a4SJonathan Peyton   task->td_ident = loc_ref;
10957cc577a4SJonathan Peyton   task->td_taskwait_ident = NULL;
10967cc577a4SJonathan Peyton   task->td_taskwait_counter = 0;
10977cc577a4SJonathan Peyton   task->td_taskwait_thread = 0;
10987cc577a4SJonathan Peyton 
10997cc577a4SJonathan Peyton   task->td_flags.tiedness = TASK_TIED;
11007cc577a4SJonathan Peyton   task->td_flags.tasktype = TASK_IMPLICIT;
11017cc577a4SJonathan Peyton   task->td_flags.proxy = TASK_FULL;
11027cc577a4SJonathan Peyton 
11037cc577a4SJonathan Peyton   // All implicit tasks are executed immediately, not deferred
11047cc577a4SJonathan Peyton   task->td_flags.task_serial = 1;
11057cc577a4SJonathan Peyton   task->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
11067cc577a4SJonathan Peyton   task->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
11077cc577a4SJonathan Peyton 
11087cc577a4SJonathan Peyton   task->td_flags.started = 1;
11097cc577a4SJonathan Peyton   task->td_flags.executing = 1;
11107cc577a4SJonathan Peyton   task->td_flags.complete = 0;
11117cc577a4SJonathan Peyton   task->td_flags.freed = 0;
11127cc577a4SJonathan Peyton 
11137cc577a4SJonathan Peyton   task->td_depnode = NULL;
1114a756cb24SAndrey Churbanov   task->td_last_tied = task;
1115405037c4SAndrey Churbanov   task->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
11167cc577a4SJonathan Peyton 
11173041982dSJonathan Peyton   if (set_curr_task) { // only do this init first time thread is created
111837e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_incomplete_child_tasks, 0);
1119642688b6SJonathan Peyton     // Not used: don't need to deallocate implicit task
112037e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_allocated_child_tasks, 0);
11217cc577a4SJonathan Peyton     task->td_taskgroup = NULL; // An implicit task does not have taskgroup
11227cc577a4SJonathan Peyton     task->td_dephash = NULL;
11237cc577a4SJonathan Peyton     __kmp_push_current_task_to_thread(this_thr, team, tid);
11247cc577a4SJonathan Peyton   } else {
11257cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_incomplete_child_tasks == 0);
11267cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_allocated_child_tasks == 0);
11277cc577a4SJonathan Peyton   }
11287cc577a4SJonathan Peyton 
11297cc577a4SJonathan Peyton #if OMPT_SUPPORT
1130f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
113182e94a59SJoachim Protze     __ompt_task_init(task, tid);
11327cc577a4SJonathan Peyton #endif
11337cc577a4SJonathan Peyton 
11343041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_init_implicit_task(exit): T#:%d team=%p task=%p\n", tid,
11353041982dSJonathan Peyton                 team, task));
11367cc577a4SJonathan Peyton }
11377cc577a4SJonathan Peyton 
11383041982dSJonathan Peyton // __kmp_finish_implicit_task: Release resources associated to implicit tasks
11393041982dSJonathan Peyton // at the end of parallel regions. Some resources are kept for reuse in the next
11403041982dSJonathan Peyton // parallel region.
11417cc577a4SJonathan Peyton //
11423041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11433041982dSJonathan Peyton void __kmp_finish_implicit_task(kmp_info_t *thread) {
11447cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1145c3344345SAndrey Churbanov   if (task->td_dephash) {
1146c3344345SAndrey Churbanov     int children;
1147c3344345SAndrey Churbanov     task->td_flags.complete = 1;
1148c3344345SAndrey Churbanov     children = KMP_ATOMIC_LD_ACQ(&task->td_incomplete_child_tasks);
1149c3344345SAndrey Churbanov     kmp_tasking_flags_t flags_old = task->td_flags;
1150c3344345SAndrey Churbanov     if (children == 0 && flags_old.complete == 1) {
1151c3344345SAndrey Churbanov       kmp_tasking_flags_t flags_new = flags_old;
1152c3344345SAndrey Churbanov       flags_new.complete = 0;
1153c3344345SAndrey Churbanov       if (KMP_COMPARE_AND_STORE_ACQ32(RCAST(kmp_int32 *, &task->td_flags),
1154c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_old),
1155c3344345SAndrey Churbanov                                       *RCAST(kmp_int32 *, &flags_new))) {
1156c3344345SAndrey Churbanov         KA_TRACE(100, ("__kmp_finish_implicit_task: T#%d cleans "
1157c3344345SAndrey Churbanov                        "dephash of implicit task %p\n",
1158c3344345SAndrey Churbanov                        thread->th.th_info.ds.ds_gtid, task));
11597cc577a4SJonathan Peyton         __kmp_dephash_free_entries(thread, task->td_dephash);
11607cc577a4SJonathan Peyton       }
1161c3344345SAndrey Churbanov     }
1162c3344345SAndrey Churbanov   }
1163c3344345SAndrey Churbanov }
11647cc577a4SJonathan Peyton 
11653041982dSJonathan Peyton // __kmp_free_implicit_task: Release resources associated to implicit tasks
11663041982dSJonathan Peyton // when these are destroyed regions
11677cc577a4SJonathan Peyton //
11683041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
11693041982dSJonathan Peyton void __kmp_free_implicit_task(kmp_info_t *thread) {
11707cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
1171bff8ded9SJonathan Peyton   if (task && task->td_dephash) {
11727cc577a4SJonathan Peyton     __kmp_dephash_free(thread, task->td_dephash);
11737cc577a4SJonathan Peyton     task->td_dephash = NULL;
11747cc577a4SJonathan Peyton   }
1175bff8ded9SJonathan Peyton }
11767cc577a4SJonathan Peyton 
11773041982dSJonathan Peyton // Round up a size to a power of two specified by val: Used to insert padding
11783041982dSJonathan Peyton // between structures co-allocated using a single malloc() call
11793041982dSJonathan Peyton static size_t __kmp_round_up_to_val(size_t size, size_t val) {
11807cc577a4SJonathan Peyton   if (size & (val - 1)) {
11817cc577a4SJonathan Peyton     size &= ~(val - 1);
11827cc577a4SJonathan Peyton     if (size <= KMP_SIZE_T_MAX - val) {
11837cc577a4SJonathan Peyton       size += val; // Round up if there is no overflow.
1184bd3a7633SJonathan Peyton     }
1185bd3a7633SJonathan Peyton   }
11867cc577a4SJonathan Peyton   return size;
11877cc577a4SJonathan Peyton } // __kmp_round_up_to_va
11887cc577a4SJonathan Peyton 
11897cc577a4SJonathan Peyton // __kmp_task_alloc: Allocate the taskdata and task data structures for a task
11907cc577a4SJonathan Peyton //
11917cc577a4SJonathan Peyton // loc_ref: source location information
11927cc577a4SJonathan Peyton // gtid: global thread number.
11933041982dSJonathan Peyton // flags: include tiedness & task type (explicit vs. implicit) of the ''new''
11943041982dSJonathan Peyton // task encountered. Converted from kmp_int32 to kmp_tasking_flags_t in routine.
11953041982dSJonathan Peyton // sizeof_kmp_task_t:  Size in bytes of kmp_task_t data structure including
11963041982dSJonathan Peyton // private vars accessed in task.
11973041982dSJonathan Peyton // sizeof_shareds:  Size in bytes of array of pointers to shared vars accessed
11983041982dSJonathan Peyton // in task.
11997cc577a4SJonathan Peyton // task_entry: Pointer to task code entry point generated by compiler.
12007cc577a4SJonathan Peyton // returns: a pointer to the allocated kmp_task_t structure (task).
12013041982dSJonathan Peyton kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
12023041982dSJonathan Peyton                              kmp_tasking_flags_t *flags,
12037cc577a4SJonathan Peyton                              size_t sizeof_kmp_task_t, size_t sizeof_shareds,
12043041982dSJonathan Peyton                              kmp_routine_entry_t task_entry) {
12057cc577a4SJonathan Peyton   kmp_task_t *task;
12067cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
12077cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
12087cc577a4SJonathan Peyton   kmp_team_t *team = thread->th.th_team;
12097cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
12107cc577a4SJonathan Peyton   size_t shareds_offset;
12117cc577a4SJonathan Peyton 
12126bf84871SAndreyChurbanov   if (UNLIKELY(!TCR_4(__kmp_init_middle)))
121328226e7dSJonathan Peyton     __kmp_middle_initialize();
121428226e7dSJonathan Peyton 
12159d64275aSShilei Tian   if (flags->hidden_helper) {
12169d64275aSShilei Tian     if (__kmp_enable_hidden_helper) {
12179d64275aSShilei Tian       if (!TCR_4(__kmp_init_hidden_helper))
12189d64275aSShilei Tian         __kmp_hidden_helper_initialize();
12199d64275aSShilei Tian     } else {
12209d64275aSShilei Tian       // If the hidden helper task is not enabled, reset the flag to FALSE.
12219d64275aSShilei Tian       flags->hidden_helper = FALSE;
12229d64275aSShilei Tian     }
12239d64275aSShilei Tian   }
12249d64275aSShilei Tian 
12257cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_task_alloc(enter): T#%d loc=%p, flags=(0x%x) "
12267cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12277cc577a4SJonathan Peyton                 gtid, loc_ref, *((kmp_int32 *)flags), sizeof_kmp_task_t,
12287cc577a4SJonathan Peyton                 sizeof_shareds, task_entry));
12297cc577a4SJonathan Peyton 
1230467f3924SHansang Bae   KMP_DEBUG_ASSERT(parent_task);
12317cc577a4SJonathan Peyton   if (parent_task->td_flags.final) {
12327cc577a4SJonathan Peyton     if (flags->merged_if0) {
12337cc577a4SJonathan Peyton     }
12347cc577a4SJonathan Peyton     flags->final = 1;
12357cc577a4SJonathan Peyton   }
12369d64275aSShilei Tian 
1237a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED && !team->t.t_serialized) {
1238a756cb24SAndrey Churbanov     // Untied task encountered causes the TSC algorithm to check entire deque of
1239a756cb24SAndrey Churbanov     // the victim thread. If no untied task encountered, then checking the head
1240a756cb24SAndrey Churbanov     // of the deque should be enough.
1241680c71b1SShilei Tian     KMP_CHECK_UPDATE(thread->th.th_task_team->tt.tt_untied_task_encountered, 1);
1242a756cb24SAndrey Churbanov   }
12437cc577a4SJonathan Peyton 
1244405037c4SAndrey Churbanov   // Detachable tasks are not proxy tasks yet but could be in the future. Doing
1245405037c4SAndrey Churbanov   // the tasking setup
1246405037c4SAndrey Churbanov   // when that happens is too late.
1247838dcdb5SAndreyChurbanov   if (UNLIKELY(flags->proxy == TASK_PROXY ||
1248838dcdb5SAndreyChurbanov                flags->detachable == TASK_DETACHABLE || flags->hidden_helper)) {
12497cc577a4SJonathan Peyton     if (flags->proxy == TASK_PROXY) {
12507cc577a4SJonathan Peyton       flags->tiedness = TASK_UNTIED;
12517cc577a4SJonathan Peyton       flags->merged_if0 = 1;
1252405037c4SAndrey Churbanov     }
12533041982dSJonathan Peyton     /* are we running in a sequential parallel or tskm_immediate_exec... we need
12543041982dSJonathan Peyton        tasking support enabled */
1255680c71b1SShilei Tian     if ((thread->th.th_task_team) == NULL) {
12567cc577a4SJonathan Peyton       /* This should only happen if the team is serialized
12573041982dSJonathan Peyton           setup a task team and propagate it to the thread */
12587cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(team->t.t_serialized);
12593041982dSJonathan Peyton       KA_TRACE(30,
12603041982dSJonathan Peyton                ("T#%d creating task team in __kmp_task_alloc for proxy task\n",
12613041982dSJonathan Peyton                 gtid));
1262680c71b1SShilei Tian       // 1 indicates setup the current team regardless of nthreads
1263680c71b1SShilei Tian       __kmp_task_team_setup(thread, team, 1);
1264680c71b1SShilei Tian       thread->th.th_task_team = team->t.t_task_team[thread->th.th_task_state];
12657cc577a4SJonathan Peyton     }
1266680c71b1SShilei Tian     kmp_task_team_t *task_team = thread->th.th_task_team;
12677cc577a4SJonathan Peyton 
12687cc577a4SJonathan Peyton     /* tasking must be enabled now as the task might not be pushed */
12697cc577a4SJonathan Peyton     if (!KMP_TASKING_ENABLED(task_team)) {
12703041982dSJonathan Peyton       KA_TRACE(
12713041982dSJonathan Peyton           30,
12723041982dSJonathan Peyton           ("T#%d enabling tasking in __kmp_task_alloc for proxy task\n", gtid));
1273680c71b1SShilei Tian       __kmp_enable_tasking(task_team, thread);
1274680c71b1SShilei Tian       kmp_int32 tid = thread->th.th_info.ds.ds_tid;
12757cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
12767cc577a4SJonathan Peyton       // No lock needed since only owner can allocate
12777cc577a4SJonathan Peyton       if (thread_data->td.td_deque == NULL) {
1278680c71b1SShilei Tian         __kmp_alloc_task_deque(thread, thread_data);
12797cc577a4SJonathan Peyton       }
12807cc577a4SJonathan Peyton     }
12817cc577a4SJonathan Peyton 
12823c31b784SShilei Tian     if ((flags->proxy == TASK_PROXY || flags->detachable == TASK_DETACHABLE) &&
12839d64275aSShilei Tian         task_team->tt.tt_found_proxy_tasks == FALSE)
12847cc577a4SJonathan Peyton       TCW_4(task_team->tt.tt_found_proxy_tasks, TRUE);
12859d64275aSShilei Tian     if (flags->hidden_helper &&
12869d64275aSShilei Tian         task_team->tt.tt_hidden_helper_task_encountered == FALSE)
12879d64275aSShilei Tian       TCW_4(task_team->tt.tt_hidden_helper_task_encountered, TRUE);
12887cc577a4SJonathan Peyton   }
12897cc577a4SJonathan Peyton 
12907cc577a4SJonathan Peyton   // Calculate shared structure offset including padding after kmp_task_t struct
12917cc577a4SJonathan Peyton   // to align pointers in shared struct
12927cc577a4SJonathan Peyton   shareds_offset = sizeof(kmp_taskdata_t) + sizeof_kmp_task_t;
12937cc577a4SJonathan Peyton   shareds_offset = __kmp_round_up_to_val(shareds_offset, sizeof(void *));
12947cc577a4SJonathan Peyton 
12957cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
12963041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d First malloc size: %ld\n", gtid,
12973041982dSJonathan Peyton                 shareds_offset));
12983041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d Second malloc size: %ld\n", gtid,
12993041982dSJonathan Peyton                 sizeof_shareds));
13007cc577a4SJonathan Peyton 
13017cc577a4SJonathan Peyton   // Avoid double allocation here by combining shareds with taskdata
13027cc577a4SJonathan Peyton #if USE_FAST_MEMORY
1303680c71b1SShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, shareds_offset +
1304680c71b1SShilei Tian                                                                sizeof_shareds);
13057cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
1306680c71b1SShilei Tian   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, shareds_offset +
1307680c71b1SShilei Tian                                                                sizeof_shareds);
13087cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
13097cc577a4SJonathan Peyton 
13107cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
13117cc577a4SJonathan Peyton 
13127cc577a4SJonathan Peyton // Make sure task & taskdata are aligned appropriately
13137cc577a4SJonathan Peyton #if KMP_ARCH_X86 || KMP_ARCH_PPC64 || !KMP_HAVE_QUAD
13147cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(double) - 1)) == 0);
13157cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(double) - 1)) == 0);
13167cc577a4SJonathan Peyton #else
13177cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(_Quad) - 1)) == 0);
13187cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(_Quad) - 1)) == 0);
13197cc577a4SJonathan Peyton #endif
13207cc577a4SJonathan Peyton   if (sizeof_shareds > 0) {
13217cc577a4SJonathan Peyton     // Avoid double allocation here by combining shareds with taskdata
13227cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
13237cc577a4SJonathan Peyton     // Make sure shareds struct is aligned to pointer size
13243041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
13253041982dSJonathan Peyton                      0);
13267cc577a4SJonathan Peyton   } else {
13277cc577a4SJonathan Peyton     task->shareds = NULL;
13287cc577a4SJonathan Peyton   }
13297cc577a4SJonathan Peyton   task->routine = task_entry;
13307cc577a4SJonathan Peyton   task->part_id = 0; // AC: Always start with 0 part id
13317cc577a4SJonathan Peyton 
13327cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
13339d64275aSShilei Tian   taskdata->td_team = thread->th.th_team;
1334680c71b1SShilei Tian   taskdata->td_alloc_thread = thread;
13357cc577a4SJonathan Peyton   taskdata->td_parent = parent_task;
13367cc577a4SJonathan Peyton   taskdata->td_level = parent_task->td_level + 1; // increment nesting level
133737e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_untied_count, 0);
13387cc577a4SJonathan Peyton   taskdata->td_ident = loc_ref;
13397cc577a4SJonathan Peyton   taskdata->td_taskwait_ident = NULL;
13407cc577a4SJonathan Peyton   taskdata->td_taskwait_counter = 0;
13417cc577a4SJonathan Peyton   taskdata->td_taskwait_thread = 0;
13427cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_parent != NULL);
13437cc577a4SJonathan Peyton   // avoid copying icvs for proxy tasks
13447cc577a4SJonathan Peyton   if (flags->proxy == TASK_FULL)
13457cc577a4SJonathan Peyton     copy_icvs(&taskdata->td_icvs, &taskdata->td_parent->td_icvs);
13467cc577a4SJonathan Peyton 
1347db635a28SHansang Bae   taskdata->td_flags = *flags;
13487cc577a4SJonathan Peyton   taskdata->td_task_team = thread->th.th_task_team;
13497cc577a4SJonathan Peyton   taskdata->td_size_alloc = shareds_offset + sizeof_shareds;
13507cc577a4SJonathan Peyton   taskdata->td_flags.tasktype = TASK_EXPLICIT;
1351680c71b1SShilei Tian   // If it is hidden helper task, we need to set the team and task team
1352680c71b1SShilei Tian   // correspondingly.
1353680c71b1SShilei Tian   if (flags->hidden_helper) {
1354680c71b1SShilei Tian     kmp_info_t *shadow_thread = __kmp_threads[KMP_GTID_TO_SHADOW_GTID(gtid)];
1355680c71b1SShilei Tian     taskdata->td_team = shadow_thread->th.th_team;
1356680c71b1SShilei Tian     taskdata->td_task_team = shadow_thread->th.th_task_team;
1357680c71b1SShilei Tian   }
13587cc577a4SJonathan Peyton 
13597cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of tasking_ser flag
13607cc577a4SJonathan Peyton   taskdata->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
13617cc577a4SJonathan Peyton 
13627cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of team_serial flag
13637cc577a4SJonathan Peyton   taskdata->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
13647cc577a4SJonathan Peyton 
13653041982dSJonathan Peyton   // GEH - Note we serialize the task if the team is serialized to make sure
13663041982dSJonathan Peyton   // implicit parallel region tasks are not left until program termination to
13673041982dSJonathan Peyton   // execute. Also, it helps locality to execute immediately.
13683041982dSJonathan Peyton 
13693041982dSJonathan Peyton   taskdata->td_flags.task_serial =
13703041982dSJonathan Peyton       (parent_task->td_flags.final || taskdata->td_flags.team_serial ||
1371add8d90cSJoachim Protze        taskdata->td_flags.tasking_ser || flags->merged_if0);
13727cc577a4SJonathan Peyton 
13737cc577a4SJonathan Peyton   taskdata->td_flags.started = 0;
13747cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0;
13757cc577a4SJonathan Peyton   taskdata->td_flags.complete = 0;
13767cc577a4SJonathan Peyton   taskdata->td_flags.freed = 0;
13777cc577a4SJonathan Peyton 
137837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_incomplete_child_tasks, 0);
137937e2ef54SJonathan Peyton   // start at one because counts current task and children
138037e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_allocated_child_tasks, 1);
13813041982dSJonathan Peyton   taskdata->td_taskgroup =
13823041982dSJonathan Peyton       parent_task->td_taskgroup; // task inherits taskgroup from the parent task
13837cc577a4SJonathan Peyton   taskdata->td_dephash = NULL;
13847cc577a4SJonathan Peyton   taskdata->td_depnode = NULL;
1385a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED)
1386a756cb24SAndrey Churbanov     taskdata->td_last_tied = NULL; // will be set when the task is scheduled
1387a756cb24SAndrey Churbanov   else
1388a756cb24SAndrey Churbanov     taskdata->td_last_tied = taskdata;
1389405037c4SAndrey Churbanov   taskdata->td_allow_completion_event.type = KMP_EVENT_UNINITIALIZED;
139086ed6aa6SJoachim Protze #if OMPT_SUPPORT
139186ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled))
139286ed6aa6SJoachim Protze     __ompt_task_init(taskdata, gtid);
139386ed6aa6SJoachim Protze #endif
13948442967fSShilei Tian   // TODO: What would be the balance between the conditions in the function and
13958442967fSShilei Tian   // an atomic operation?
13968442967fSShilei Tian   if (__kmp_track_children_task(taskdata)) {
139737e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
13987cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
139937e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
14003041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
14013041982dSJonathan Peyton     // implicit not deallocated
14027cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT) {
140337e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
14047cc577a4SJonathan Peyton     }
14059d64275aSShilei Tian     if (flags->hidden_helper) {
14069d64275aSShilei Tian       taskdata->td_flags.task_serial = FALSE;
14079d64275aSShilei Tian       // Increment the number of hidden helper tasks to be executed
14089d64275aSShilei Tian       KMP_ATOMIC_INC(&__kmp_unexecuted_hidden_helper_tasks);
14099d64275aSShilei Tian     }
1410db635a28SHansang Bae   }
14119d64275aSShilei Tian 
14127cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_task_alloc(exit): T#%d created task %p parent=%p\n",
14137cc577a4SJonathan Peyton                 gtid, taskdata, taskdata->td_parent));
14147cc577a4SJonathan Peyton 
14157cc577a4SJonathan Peyton   return task;
14167cc577a4SJonathan Peyton }
14177cc577a4SJonathan Peyton 
14183041982dSJonathan Peyton kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
14193041982dSJonathan Peyton                                   kmp_int32 flags, size_t sizeof_kmp_task_t,
14203041982dSJonathan Peyton                                   size_t sizeof_shareds,
14213041982dSJonathan Peyton                                   kmp_routine_entry_t task_entry) {
14227cc577a4SJonathan Peyton   kmp_task_t *retval;
14237cc577a4SJonathan Peyton   kmp_tasking_flags_t *input_flags = (kmp_tasking_flags_t *)&flags;
1424787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
14257cc577a4SJonathan Peyton   input_flags->native = FALSE;
14267cc577a4SJonathan Peyton   // __kmp_task_alloc() sets up all other runtime flags
1427405037c4SAndrey Churbanov   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s %s %s) "
1428405037c4SAndrey Churbanov                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
1429405037c4SAndrey Churbanov                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
1430405037c4SAndrey Churbanov                 input_flags->proxy ? "proxy" : "",
1431405037c4SAndrey Churbanov                 input_flags->detachable ? "detachable" : "", sizeof_kmp_task_t,
1432405037c4SAndrey Churbanov                 sizeof_shareds, task_entry));
14337cc577a4SJonathan Peyton 
14347cc577a4SJonathan Peyton   retval = __kmp_task_alloc(loc_ref, gtid, input_flags, sizeof_kmp_task_t,
14357cc577a4SJonathan Peyton                             sizeof_shareds, task_entry);
14367cc577a4SJonathan Peyton 
14377cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmpc_omp_task_alloc(exit): T#%d retval %p\n", gtid, retval));
14387cc577a4SJonathan Peyton 
14397cc577a4SJonathan Peyton   return retval;
14407cc577a4SJonathan Peyton }
14417cc577a4SJonathan Peyton 
1442b48e44a6SGheorghe-Teodor Bercea kmp_task_t *__kmpc_omp_target_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
1443b48e44a6SGheorghe-Teodor Bercea                                          kmp_int32 flags,
1444b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_kmp_task_t,
1445b48e44a6SGheorghe-Teodor Bercea                                          size_t sizeof_shareds,
1446b48e44a6SGheorghe-Teodor Bercea                                          kmp_routine_entry_t task_entry,
1447b48e44a6SGheorghe-Teodor Bercea                                          kmp_int64 device_id) {
14489d64275aSShilei Tian   auto &input_flags = reinterpret_cast<kmp_tasking_flags_t &>(flags);
1449262289c1SYe Luo   // target task is untied defined in the specification
14509f5d6ea5SShilei Tian   input_flags.tiedness = TASK_UNTIED;
1451262289c1SYe Luo 
1452262289c1SYe Luo   if (__kmp_enable_hidden_helper)
1453262289c1SYe Luo     input_flags.hidden_helper = TRUE;
14549d64275aSShilei Tian 
1455b48e44a6SGheorghe-Teodor Bercea   return __kmpc_omp_task_alloc(loc_ref, gtid, flags, sizeof_kmp_task_t,
1456b48e44a6SGheorghe-Teodor Bercea                                sizeof_shareds, task_entry);
1457b48e44a6SGheorghe-Teodor Bercea }
1458b48e44a6SGheorghe-Teodor Bercea 
1459b04f7d68SJonathan Peyton /*!
1460b04f7d68SJonathan Peyton @ingroup TASKING
1461b04f7d68SJonathan Peyton @param loc_ref location of the original task directive
1462b04f7d68SJonathan Peyton @param gtid Global Thread ID of encountering thread
1463b04f7d68SJonathan Peyton @param new_task task thunk allocated by __kmpc_omp_task_alloc() for the ''new
1464b04f7d68SJonathan Peyton task''
1465b04f7d68SJonathan Peyton @param naffins Number of affinity items
1466b04f7d68SJonathan Peyton @param affin_list List of affinity items
1467b04f7d68SJonathan Peyton @return Returns non-zero if registering affinity information was not successful.
1468b04f7d68SJonathan Peyton  Returns 0 if registration was successful
1469b04f7d68SJonathan Peyton This entry registers the affinity information attached to a task with the task
1470b04f7d68SJonathan Peyton thunk structure kmp_taskdata_t.
1471b04f7d68SJonathan Peyton */
1472b04f7d68SJonathan Peyton kmp_int32
1473b04f7d68SJonathan Peyton __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref, kmp_int32 gtid,
1474b04f7d68SJonathan Peyton                                   kmp_task_t *new_task, kmp_int32 naffins,
1475b04f7d68SJonathan Peyton                                   kmp_task_affinity_info_t *affin_list) {
1476b04f7d68SJonathan Peyton   return 0;
1477b04f7d68SJonathan Peyton }
1478b04f7d68SJonathan Peyton 
14797cc577a4SJonathan Peyton //  __kmp_invoke_task: invoke the specified task
14807cc577a4SJonathan Peyton //
14817cc577a4SJonathan Peyton // gtid: global thread ID of caller
14827cc577a4SJonathan Peyton // task: the task to invoke
148342016791SKazuaki Ishizaki // current_task: the task to resume after task invocation
14843041982dSJonathan Peyton static void __kmp_invoke_task(kmp_int32 gtid, kmp_task_t *task,
14853041982dSJonathan Peyton                               kmp_taskdata_t *current_task) {
14867cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
1487b1b221c8SJonathan Peyton   kmp_info_t *thread;
14887cc577a4SJonathan Peyton   int discard = 0 /* false */;
14893041982dSJonathan Peyton   KA_TRACE(
14903041982dSJonathan Peyton       30, ("__kmp_invoke_task(enter): T#%d invoking task %p, current_task=%p\n",
14917cc577a4SJonathan Peyton            gtid, taskdata, current_task));
14927cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task);
14936bf84871SAndreyChurbanov   if (UNLIKELY(taskdata->td_flags.proxy == TASK_PROXY &&
14946bf84871SAndreyChurbanov                taskdata->td_flags.complete == 1)) {
14957cc577a4SJonathan Peyton     // This is a proxy task that was already completed but it needs to run
14967cc577a4SJonathan Peyton     // its bottom-half finish
14973041982dSJonathan Peyton     KA_TRACE(
14983041982dSJonathan Peyton         30,
14993041982dSJonathan Peyton         ("__kmp_invoke_task: T#%d running bottom finish for proxy task %p\n",
15007cc577a4SJonathan Peyton          gtid, taskdata));
15017cc577a4SJonathan Peyton 
15027cc577a4SJonathan Peyton     __kmp_bottom_half_finish_proxy(gtid, task);
15037cc577a4SJonathan Peyton 
15043041982dSJonathan Peyton     KA_TRACE(30, ("__kmp_invoke_task(exit): T#%d completed bottom finish for "
15053041982dSJonathan Peyton                   "proxy task %p, resuming task %p\n",
15063041982dSJonathan Peyton                   gtid, taskdata, current_task));
15077cc577a4SJonathan Peyton 
15087cc577a4SJonathan Peyton     return;
15097cc577a4SJonathan Peyton   }
15107cc577a4SJonathan Peyton 
15117cc577a4SJonathan Peyton #if OMPT_SUPPORT
151286ed6aa6SJoachim Protze   // For untied tasks, the first task executed only calls __kmpc_omp_task and
151386ed6aa6SJoachim Protze   // does not execute code.
15147cc577a4SJonathan Peyton   ompt_thread_info_t oldInfo;
1515f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
15167cc577a4SJonathan Peyton     // Store the threads states and restore them after the task
15177cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
15187cc577a4SJonathan Peyton     oldInfo = thread->th.ompt_thread_info;
15197cc577a4SJonathan Peyton     thread->th.ompt_thread_info.wait_id = 0;
152082e94a59SJoachim Protze     thread->th.ompt_thread_info.state = (thread->th.th_team_serialized)
15210e0d6cddSJoachim Protze                                             ? ompt_state_work_serial
15220e0d6cddSJoachim Protze                                             : ompt_state_work_parallel;
15230e0d6cddSJoachim Protze     taskdata->ompt_task_info.frame.exit_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
15247cc577a4SJonathan Peyton   }
15257cc577a4SJonathan Peyton #endif
15267cc577a4SJonathan Peyton 
15279d64275aSShilei Tian   // Decreament the counter of hidden helper tasks to be executed
15289d64275aSShilei Tian   if (taskdata->td_flags.hidden_helper) {
15299d64275aSShilei Tian     // Hidden helper tasks can only be executed by hidden helper threads
15309d64275aSShilei Tian     KMP_ASSERT(KMP_HIDDEN_HELPER_THREAD(gtid));
15319d64275aSShilei Tian     KMP_ATOMIC_DEC(&__kmp_unexecuted_hidden_helper_tasks);
15329d64275aSShilei Tian   }
15339d64275aSShilei Tian 
153486ed6aa6SJoachim Protze   // Proxy tasks are not handled by the runtime
153586ed6aa6SJoachim Protze   if (taskdata->td_flags.proxy != TASK_PROXY) {
153686ed6aa6SJoachim Protze     __kmp_task_start(gtid, task, current_task); // OMPT only if not discarded
153786ed6aa6SJoachim Protze   }
153886ed6aa6SJoachim Protze 
15397cc577a4SJonathan Peyton   // TODO: cancel tasks if the parallel region has also been cancelled
15407cc577a4SJonathan Peyton   // TODO: check if this sequence can be hoisted above __kmp_task_start
15417cc577a4SJonathan Peyton   // if cancellation has been enabled for this run ...
15426bf84871SAndreyChurbanov   if (UNLIKELY(__kmp_omp_cancellation)) {
1543b1b221c8SJonathan Peyton     thread = __kmp_threads[gtid];
1544b1b221c8SJonathan Peyton     kmp_team_t *this_team = thread->th.th_team;
15457cc577a4SJonathan Peyton     kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
15463041982dSJonathan Peyton     if ((taskgroup && taskgroup->cancel_request) ||
15473041982dSJonathan Peyton         (this_team->t.t_cancel_request == cancel_parallel)) {
154882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
154982e94a59SJoachim Protze       ompt_data_t *task_data;
1550f0a1c65fSJonas Hahnfeld       if (UNLIKELY(ompt_enabled.ompt_callback_cancel)) {
155182e94a59SJoachim Protze         __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
155282e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_cancel)(
155382e94a59SJoachim Protze             task_data,
155482e94a59SJoachim Protze             ((taskgroup && taskgroup->cancel_request) ? ompt_cancel_taskgroup
155582e94a59SJoachim Protze                                                       : ompt_cancel_parallel) |
155682e94a59SJoachim Protze                 ompt_cancel_discarded_task,
155782e94a59SJoachim Protze             NULL);
155882e94a59SJoachim Protze       }
155982e94a59SJoachim Protze #endif
15607cc577a4SJonathan Peyton       KMP_COUNT_BLOCK(TASK_cancelled);
15617cc577a4SJonathan Peyton       // this task belongs to a task group and we need to cancel it
15627cc577a4SJonathan Peyton       discard = 1 /* true */;
15637cc577a4SJonathan Peyton     }
15647cc577a4SJonathan Peyton   }
15657cc577a4SJonathan Peyton 
15667cc577a4SJonathan Peyton   // Invoke the task routine and pass in relevant data.
15677cc577a4SJonathan Peyton   // Thunks generated by gcc take a different argument list.
15687cc577a4SJonathan Peyton   if (!discard) {
1569a756cb24SAndrey Churbanov     if (taskdata->td_flags.tiedness == TASK_UNTIED) {
1570a756cb24SAndrey Churbanov       taskdata->td_last_tied = current_task->td_last_tied;
1571a756cb24SAndrey Churbanov       KMP_DEBUG_ASSERT(taskdata->td_last_tied);
1572a756cb24SAndrey Churbanov     }
15737cc577a4SJonathan Peyton #if KMP_STATS_ENABLED
15747cc577a4SJonathan Peyton     KMP_COUNT_BLOCK(TASK_executed);
15757cc577a4SJonathan Peyton     switch (KMP_GET_THREAD_STATE()) {
15763041982dSJonathan Peyton     case FORK_JOIN_BARRIER:
15773041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_join_bar);
15783041982dSJonathan Peyton       break;
15793041982dSJonathan Peyton     case PLAIN_BARRIER:
15803041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_plain_bar);
15813041982dSJonathan Peyton       break;
15823041982dSJonathan Peyton     case TASKYIELD:
15833041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskyield);
15843041982dSJonathan Peyton       break;
15853041982dSJonathan Peyton     case TASKWAIT:
15863041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskwait);
15873041982dSJonathan Peyton       break;
15883041982dSJonathan Peyton     case TASKGROUP:
15893041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskgroup);
15903041982dSJonathan Peyton       break;
15913041982dSJonathan Peyton     default:
15923041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_immediate);
15933041982dSJonathan Peyton       break;
15947cc577a4SJonathan Peyton     }
15957cc577a4SJonathan Peyton #endif // KMP_STATS_ENABLED
15967cc577a4SJonathan Peyton 
159782e94a59SJoachim Protze // OMPT task begin
159882e94a59SJoachim Protze #if OMPT_SUPPORT
1599f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.enabled))
160082e94a59SJoachim Protze       __ompt_task_start(task, current_task, gtid);
16017cc577a4SJonathan Peyton #endif
16027cc577a4SJonathan Peyton 
1603f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1604f61602b0SVignesh Balasubramanian     if (ompd_state & OMPD_ENABLE_BP)
1605f61602b0SVignesh Balasubramanian       ompd_bp_task_begin();
1606f61602b0SVignesh Balasubramanian #endif
1607f61602b0SVignesh Balasubramanian 
1608b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1609b1b221c8SJonathan Peyton     kmp_uint64 cur_time;
1610b1b221c8SJonathan Peyton     kmp_int32 kmp_itt_count_task =
1611b1b221c8SJonathan Peyton         __kmp_forkjoin_frames_mode == 3 && !taskdata->td_flags.task_serial &&
1612b1b221c8SJonathan Peyton         current_task->td_flags.tasktype == TASK_IMPLICIT;
1613b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1614b1b221c8SJonathan Peyton       thread = __kmp_threads[gtid];
1615b1b221c8SJonathan Peyton       // Time outer level explicit task on barrier for adjusting imbalance time
1616b1b221c8SJonathan Peyton       if (thread->th.th_bar_arrive_time)
1617b1b221c8SJonathan Peyton         cur_time = __itt_get_timestamp();
1618b1b221c8SJonathan Peyton       else
1619b1b221c8SJonathan Peyton         kmp_itt_count_task = 0; // thread is not on a barrier - skip timing
1620b1b221c8SJonathan Peyton     }
1621ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquired self (new task)
1622b1b221c8SJonathan Peyton #endif
1623b1b221c8SJonathan Peyton 
1624*63f8099eSAndreyChurbanov     if (task->routine != NULL) {
16257cc577a4SJonathan Peyton #ifdef KMP_GOMP_COMPAT
16267cc577a4SJonathan Peyton       if (taskdata->td_flags.native) {
16277cc577a4SJonathan Peyton         ((void (*)(void *))(*(task->routine)))(task->shareds);
16283041982dSJonathan Peyton       } else
16297cc577a4SJonathan Peyton #endif /* KMP_GOMP_COMPAT */
16307cc577a4SJonathan Peyton       {
16317cc577a4SJonathan Peyton         (*(task->routine))(gtid, task);
16327cc577a4SJonathan Peyton       }
1633*63f8099eSAndreyChurbanov     }
16347cc577a4SJonathan Peyton     KMP_POP_PARTITIONED_TIMER();
16357cc577a4SJonathan Peyton 
1636b1b221c8SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1637b1b221c8SJonathan Peyton     if (kmp_itt_count_task) {
1638b1b221c8SJonathan Peyton       // Barrier imbalance - adjust arrive time with the task duration
1639b1b221c8SJonathan Peyton       thread->th.th_bar_arrive_time += (__itt_get_timestamp() - cur_time);
1640b1b221c8SJonathan Peyton     }
1641ffd8f009SAndreyChurbanov     KMP_FSYNC_CANCEL(taskdata); // destroy self (just executed)
1642ffd8f009SAndreyChurbanov     KMP_FSYNC_RELEASING(taskdata->td_parent); // releasing parent
1643b1b221c8SJonathan Peyton #endif
16447cc577a4SJonathan Peyton   }
16457cc577a4SJonathan Peyton 
1646f61602b0SVignesh Balasubramanian #if OMPD_SUPPORT
1647f61602b0SVignesh Balasubramanian   if (ompd_state & OMPD_ENABLE_BP)
1648f61602b0SVignesh Balasubramanian     ompd_bp_task_end();
1649f61602b0SVignesh Balasubramanian #endif
1650f61602b0SVignesh Balasubramanian 
16517cc577a4SJonathan Peyton   // Proxy tasks are not handled by the runtime
16527cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy != TASK_PROXY) {
165386ed6aa6SJoachim Protze #if OMPT_SUPPORT
165486ed6aa6SJoachim Protze     if (UNLIKELY(ompt_enabled.enabled)) {
165586ed6aa6SJoachim Protze       thread->th.ompt_thread_info = oldInfo;
165686ed6aa6SJoachim Protze       if (taskdata->td_flags.tiedness == TASK_TIED) {
16570e0d6cddSJoachim Protze         taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
165886ed6aa6SJoachim Protze       }
165986ed6aa6SJoachim Protze       __kmp_task_finish<true>(gtid, task, current_task);
166086ed6aa6SJoachim Protze     } else
166186ed6aa6SJoachim Protze #endif
166286ed6aa6SJoachim Protze       __kmp_task_finish<false>(gtid, task, current_task);
16637cc577a4SJonathan Peyton   }
16647cc577a4SJonathan Peyton 
16653041982dSJonathan Peyton   KA_TRACE(
16663041982dSJonathan Peyton       30,
16673041982dSJonathan Peyton       ("__kmp_invoke_task(exit): T#%d completed task %p, resuming task %p\n",
16687cc577a4SJonathan Peyton        gtid, taskdata, current_task));
16697cc577a4SJonathan Peyton   return;
16707cc577a4SJonathan Peyton }
16717cc577a4SJonathan Peyton 
16727cc577a4SJonathan Peyton // __kmpc_omp_task_parts: Schedule a thread-switchable task for execution
16737cc577a4SJonathan Peyton //
16747cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
16757cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
16767cc577a4SJonathan Peyton // new_task: task thunk allocated by __kmp_omp_task_alloc() for the ''new task''
16777cc577a4SJonathan Peyton // Returns:
16783041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
16793041982dSJonathan Peyton //    be resumed later.
16803041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
16813041982dSJonathan Peyton //    resumed later.
16823041982dSJonathan Peyton kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
16833041982dSJonathan Peyton                                 kmp_task_t *new_task) {
16847cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
16857cc577a4SJonathan Peyton 
16863041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_parts(enter): T#%d loc=%p task=%p\n", gtid,
16873041982dSJonathan Peyton                 loc_ref, new_taskdata));
16887cc577a4SJonathan Peyton 
168982e94a59SJoachim Protze #if OMPT_SUPPORT
169082e94a59SJoachim Protze   kmp_taskdata_t *parent;
1691f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
169282e94a59SJoachim Protze     parent = new_taskdata->td_parent;
169382e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
169482e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1695467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
169682e94a59SJoachim Protze           &(new_taskdata->ompt_task_info.task_data), ompt_task_explicit, 0,
169782e94a59SJoachim Protze           OMPT_GET_RETURN_ADDRESS(0));
169882e94a59SJoachim Protze     }
169982e94a59SJoachim Protze   }
170082e94a59SJoachim Protze #endif
170182e94a59SJoachim Protze 
17023041982dSJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
17033041982dSJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
17047cc577a4SJonathan Peyton 
17057cc577a4SJonathan Peyton   if (__kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
17067cc577a4SJonathan Peyton   { // Execute this task immediately
17077cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
17087cc577a4SJonathan Peyton     new_taskdata->td_flags.task_serial = 1;
17097cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
17107cc577a4SJonathan Peyton   }
17117cc577a4SJonathan Peyton 
17123041982dSJonathan Peyton   KA_TRACE(
17133041982dSJonathan Peyton       10,
17143041982dSJonathan Peyton       ("__kmpc_omp_task_parts(exit): T#%d returning TASK_CURRENT_NOT_QUEUED: "
17153041982dSJonathan Peyton        "loc=%p task=%p, return: TASK_CURRENT_NOT_QUEUED\n",
17163041982dSJonathan Peyton        gtid, loc_ref, new_taskdata));
17177cc577a4SJonathan Peyton 
171882e94a59SJoachim Protze #if OMPT_SUPPORT
1719f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
17200e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
172182e94a59SJoachim Protze   }
172282e94a59SJoachim Protze #endif
17237cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17247cc577a4SJonathan Peyton }
17257cc577a4SJonathan Peyton 
17267cc577a4SJonathan Peyton // __kmp_omp_task: Schedule a non-thread-switchable task for execution
17273041982dSJonathan Peyton //
17287cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17297cc577a4SJonathan Peyton // new_task:non-thread-switchable task thunk allocated by __kmp_omp_task_alloc()
17303041982dSJonathan Peyton // serialize_immediate: if TRUE then if the task is executed immediately its
17313041982dSJonathan Peyton // execution will be serialized
17323041982dSJonathan Peyton // Returns:
17333041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17343041982dSJonathan Peyton //    be resumed later.
17353041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17363041982dSJonathan Peyton //    resumed later.
17373041982dSJonathan Peyton kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
17383041982dSJonathan Peyton                          bool serialize_immediate) {
17397cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17407cc577a4SJonathan Peyton 
1741e4b4f994SJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
1742e4b4f994SJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
17433041982dSJonathan Peyton   if (new_taskdata->td_flags.proxy == TASK_PROXY ||
17443041982dSJonathan Peyton       __kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
17457cc577a4SJonathan Peyton   { // Execute this task immediately
17467cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
17477cc577a4SJonathan Peyton     if (serialize_immediate)
17487cc577a4SJonathan Peyton       new_taskdata->td_flags.task_serial = 1;
17497cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
17507cc577a4SJonathan Peyton   }
17517cc577a4SJonathan Peyton 
17527cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17537cc577a4SJonathan Peyton }
17547cc577a4SJonathan Peyton 
17553041982dSJonathan Peyton // __kmpc_omp_task: Wrapper around __kmp_omp_task to schedule a
17563041982dSJonathan Peyton // non-thread-switchable task from the parent thread only!
17573041982dSJonathan Peyton //
17587cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
17597cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
17603041982dSJonathan Peyton // new_task: non-thread-switchable task thunk allocated by
17613041982dSJonathan Peyton // __kmp_omp_task_alloc()
17623041982dSJonathan Peyton // Returns:
17633041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
17643041982dSJonathan Peyton //    be resumed later.
17653041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
17663041982dSJonathan Peyton //    resumed later.
17673041982dSJonathan Peyton kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
17683041982dSJonathan Peyton                           kmp_task_t *new_task) {
17697cc577a4SJonathan Peyton   kmp_int32 res;
17707cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
17717cc577a4SJonathan Peyton 
177282e94a59SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
17737cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
17747cc577a4SJonathan Peyton #endif
17753041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
17763041982dSJonathan Peyton                 new_taskdata));
1777787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
17787cc577a4SJonathan Peyton 
177982e94a59SJoachim Protze #if OMPT_SUPPORT
178082e94a59SJoachim Protze   kmp_taskdata_t *parent = NULL;
178186ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
178286ed6aa6SJoachim Protze     if (!new_taskdata->td_flags.started) {
178382e94a59SJoachim Protze       OMPT_STORE_RETURN_ADDRESS(gtid);
178482e94a59SJoachim Protze       parent = new_taskdata->td_parent;
17850e0d6cddSJoachim Protze       if (!parent->ompt_task_info.frame.enter_frame.ptr) {
1786309b00a4SShilei Tian         parent->ompt_task_info.frame.enter_frame.ptr =
1787309b00a4SShilei Tian             OMPT_GET_FRAME_ADDRESS(0);
178886ed6aa6SJoachim Protze       }
178982e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_task_create) {
179082e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1791467f3924SHansang Bae             &(parent->ompt_task_info.task_data),
1792467f3924SHansang Bae             &(parent->ompt_task_info.frame),
179382e94a59SJoachim Protze             &(new_taskdata->ompt_task_info.task_data),
179482e94a59SJoachim Protze             ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
179582e94a59SJoachim Protze             OMPT_LOAD_RETURN_ADDRESS(gtid));
179682e94a59SJoachim Protze       }
179786ed6aa6SJoachim Protze     } else {
179886ed6aa6SJoachim Protze       // We are scheduling the continuation of an UNTIED task.
179986ed6aa6SJoachim Protze       // Scheduling back to the parent task.
180086ed6aa6SJoachim Protze       __ompt_task_finish(new_task,
180186ed6aa6SJoachim Protze                          new_taskdata->ompt_task_info.scheduling_parent,
1802489cdb78SJoachim Protze                          ompt_task_switch);
18030e0d6cddSJoachim Protze       new_taskdata->ompt_task_info.frame.exit_frame = ompt_data_none;
180486ed6aa6SJoachim Protze     }
180582e94a59SJoachim Protze   }
180682e94a59SJoachim Protze #endif
180782e94a59SJoachim Protze 
18087cc577a4SJonathan Peyton   res = __kmp_omp_task(gtid, new_task, true);
18097cc577a4SJonathan Peyton 
18103041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
18113041982dSJonathan Peyton                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
18127cc577a4SJonathan Peyton                 gtid, loc_ref, new_taskdata));
181382e94a59SJoachim Protze #if OMPT_SUPPORT
1814f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18150e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
181682e94a59SJoachim Protze   }
181782e94a59SJoachim Protze #endif
18187cc577a4SJonathan Peyton   return res;
18197cc577a4SJonathan Peyton }
18207cc577a4SJonathan Peyton 
1821cdaefac5SJoachim Protze // __kmp_omp_taskloop_task: Wrapper around __kmp_omp_task to schedule
1822cdaefac5SJoachim Protze // a taskloop task with the correct OMPT return address
1823cdaefac5SJoachim Protze //
1824cdaefac5SJoachim Protze // loc_ref: location of original task pragma (ignored)
1825cdaefac5SJoachim Protze // gtid: Global Thread ID of encountering thread
1826cdaefac5SJoachim Protze // new_task: non-thread-switchable task thunk allocated by
1827cdaefac5SJoachim Protze // __kmp_omp_task_alloc()
1828cdaefac5SJoachim Protze // codeptr_ra: return address for OMPT callback
1829cdaefac5SJoachim Protze // Returns:
1830cdaefac5SJoachim Protze //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
1831cdaefac5SJoachim Protze //    be resumed later.
1832cdaefac5SJoachim Protze //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
1833cdaefac5SJoachim Protze //    resumed later.
1834cdaefac5SJoachim Protze kmp_int32 __kmp_omp_taskloop_task(ident_t *loc_ref, kmp_int32 gtid,
1835cdaefac5SJoachim Protze                                   kmp_task_t *new_task, void *codeptr_ra) {
1836cdaefac5SJoachim Protze   kmp_int32 res;
1837cdaefac5SJoachim Protze   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
1838cdaefac5SJoachim Protze 
1839cdaefac5SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
1840cdaefac5SJoachim Protze   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
1841cdaefac5SJoachim Protze #endif
1842cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
1843cdaefac5SJoachim Protze                 new_taskdata));
1844cdaefac5SJoachim Protze 
1845cdaefac5SJoachim Protze #if OMPT_SUPPORT
1846cdaefac5SJoachim Protze   kmp_taskdata_t *parent = NULL;
1847cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && !new_taskdata->td_flags.started)) {
1848cdaefac5SJoachim Protze     parent = new_taskdata->td_parent;
18490e0d6cddSJoachim Protze     if (!parent->ompt_task_info.frame.enter_frame.ptr)
18500e0d6cddSJoachim Protze       parent->ompt_task_info.frame.enter_frame.ptr = OMPT_GET_FRAME_ADDRESS(0);
1851cdaefac5SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
1852cdaefac5SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1853467f3924SHansang Bae           &(parent->ompt_task_info.task_data), &(parent->ompt_task_info.frame),
1854cdaefac5SJoachim Protze           &(new_taskdata->ompt_task_info.task_data),
1855cdaefac5SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
1856cdaefac5SJoachim Protze           codeptr_ra);
1857cdaefac5SJoachim Protze     }
1858cdaefac5SJoachim Protze   }
1859cdaefac5SJoachim Protze #endif
1860cdaefac5SJoachim Protze 
1861cdaefac5SJoachim Protze   res = __kmp_omp_task(gtid, new_task, true);
1862cdaefac5SJoachim Protze 
1863cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
1864cdaefac5SJoachim Protze                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
1865cdaefac5SJoachim Protze                 gtid, loc_ref, new_taskdata));
1866cdaefac5SJoachim Protze #if OMPT_SUPPORT
1867cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
18680e0d6cddSJoachim Protze     parent->ompt_task_info.frame.enter_frame = ompt_data_none;
1869cdaefac5SJoachim Protze   }
1870cdaefac5SJoachim Protze #endif
1871cdaefac5SJoachim Protze   return res;
1872cdaefac5SJoachim Protze }
1873cdaefac5SJoachim Protze 
187482e94a59SJoachim Protze template <bool ompt>
187582e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_template(ident_t *loc_ref, kmp_int32 gtid,
187682e94a59SJoachim Protze                                               void *frame_address,
187782e94a59SJoachim Protze                                               void *return_address) {
1878467f3924SHansang Bae   kmp_taskdata_t *taskdata = nullptr;
18797cc577a4SJonathan Peyton   kmp_info_t *thread;
18807cc577a4SJonathan Peyton   int thread_finished = FALSE;
18817cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKWAIT);
18827cc577a4SJonathan Peyton 
18837cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(enter): T#%d loc=%p\n", gtid, loc_ref));
1884838dcdb5SAndreyChurbanov   KMP_DEBUG_ASSERT(gtid >= 0);
18857cc577a4SJonathan Peyton 
18867cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
18877cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
18887cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
18897cc577a4SJonathan Peyton 
189082e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
189182e94a59SJoachim Protze     ompt_data_t *my_task_data;
189282e94a59SJoachim Protze     ompt_data_t *my_parallel_data;
18937cc577a4SJonathan Peyton 
189482e94a59SJoachim Protze     if (ompt) {
189582e94a59SJoachim Protze       my_task_data = &(taskdata->ompt_task_info.task_data);
189682e94a59SJoachim Protze       my_parallel_data = OMPT_CUR_TEAM_DATA(thread);
189782e94a59SJoachim Protze 
18980e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame.ptr = frame_address;
189982e94a59SJoachim Protze 
190082e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
190182e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
190282e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
190382e94a59SJoachim Protze             my_task_data, return_address);
190482e94a59SJoachim Protze       }
190582e94a59SJoachim Protze 
190682e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
190782e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
190882e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
190982e94a59SJoachim Protze             my_task_data, return_address);
19107cc577a4SJonathan Peyton       }
19117cc577a4SJonathan Peyton     }
191282e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
19137cc577a4SJonathan Peyton 
19143041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
19153041982dSJonathan Peyton // taskwait.
19167cc577a4SJonathan Peyton #if USE_ITT_BUILD
19177cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
19187cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19197cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
19207cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
19217cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
19227cc577a4SJonathan Peyton 
19237cc577a4SJonathan Peyton #if USE_ITT_BUILD
1924838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
1925838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
1926838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
1927838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
19287cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19297cc577a4SJonathan Peyton 
19303041982dSJonathan Peyton     bool must_wait =
19313041982dSJonathan Peyton         !taskdata->td_flags.team_serial && !taskdata->td_flags.final;
19327cc577a4SJonathan Peyton 
19333041982dSJonathan Peyton     must_wait = must_wait || (thread->th.th_task_team != NULL &&
19343041982dSJonathan Peyton                               thread->th.th_task_team->tt.tt_found_proxy_tasks);
19359d64275aSShilei Tian     // If hidden helper thread is encountered, we must enable wait here.
19369d64275aSShilei Tian     must_wait =
19379d64275aSShilei Tian         must_wait ||
19389d64275aSShilei Tian         (__kmp_enable_hidden_helper && thread->th.th_task_team != NULL &&
19399d64275aSShilei Tian          thread->th.th_task_team->tt.tt_hidden_helper_task_encountered);
19409d64275aSShilei Tian 
19413041982dSJonathan Peyton     if (must_wait) {
1942e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
1943e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
194437e2ef54SJonathan Peyton                 &(taskdata->td_incomplete_child_tasks)),
1945c47afcd9SAndrey Churbanov           0U);
194637e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) != 0) {
19473041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
19483041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
19493041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
19507cc577a4SJonathan Peyton       }
19517cc577a4SJonathan Peyton     }
19527cc577a4SJonathan Peyton #if USE_ITT_BUILD
1953838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
1954ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with children
19557cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
19567cc577a4SJonathan Peyton 
19573041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
19583041982dSJonathan Peyton     // negated.
19597cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
19607cc577a4SJonathan Peyton 
196182e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
196282e94a59SJoachim Protze     if (ompt) {
196382e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
196482e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
196582e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
196682e94a59SJoachim Protze             my_task_data, return_address);
196782e94a59SJoachim Protze       }
196882e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
196982e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
197082e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
197182e94a59SJoachim Protze             my_task_data, return_address);
19727cc577a4SJonathan Peyton       }
19730e0d6cddSJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = ompt_data_none;
19747cc577a4SJonathan Peyton     }
197582e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
197682e94a59SJoachim Protze 
19777cc577a4SJonathan Peyton   }
19787cc577a4SJonathan Peyton 
19797cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(exit): T#%d task %p finished waiting, "
19803041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
19813041982dSJonathan Peyton                 gtid, taskdata));
19827cc577a4SJonathan Peyton 
19837cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
19847cc577a4SJonathan Peyton }
19857cc577a4SJonathan Peyton 
1986489cdb78SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
198782e94a59SJoachim Protze OMPT_NOINLINE
198882e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_ompt(ident_t *loc_ref, kmp_int32 gtid,
198982e94a59SJoachim Protze                                           void *frame_address,
199082e94a59SJoachim Protze                                           void *return_address) {
199182e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<true>(loc_ref, gtid, frame_address,
199282e94a59SJoachim Protze                                             return_address);
199382e94a59SJoachim Protze }
1994489cdb78SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
199582e94a59SJoachim Protze 
199682e94a59SJoachim Protze // __kmpc_omp_taskwait: Wait until all tasks generated by the current task are
199782e94a59SJoachim Protze // complete
199882e94a59SJoachim Protze kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid) {
199982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
200082e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
200182e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
20020e0d6cddSJoachim Protze     return __kmpc_omp_taskwait_ompt(loc_ref, gtid, OMPT_GET_FRAME_ADDRESS(0),
200382e94a59SJoachim Protze                                     OMPT_LOAD_RETURN_ADDRESS(gtid));
200482e94a59SJoachim Protze   }
200582e94a59SJoachim Protze #endif
200682e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<false>(loc_ref, gtid, NULL, NULL);
200782e94a59SJoachim Protze }
200882e94a59SJoachim Protze 
20097cc577a4SJonathan Peyton // __kmpc_omp_taskyield: switch to a different task
20103041982dSJonathan Peyton kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid, int end_part) {
2011467f3924SHansang Bae   kmp_taskdata_t *taskdata = NULL;
20127cc577a4SJonathan Peyton   kmp_info_t *thread;
20137cc577a4SJonathan Peyton   int thread_finished = FALSE;
20147cc577a4SJonathan Peyton 
20157cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKYIELD);
20167cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKYIELD);
20177cc577a4SJonathan Peyton 
20187cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(enter): T#%d loc=%p end_part = %d\n",
20197cc577a4SJonathan Peyton                 gtid, loc_ref, end_part));
2020787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
20217cc577a4SJonathan Peyton 
20227cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec && __kmp_init_parallel) {
20237cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
20247cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
20257cc577a4SJonathan Peyton // Should we model this as a task wait or not?
20263041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
20273041982dSJonathan Peyton // taskwait.
20287cc577a4SJonathan Peyton #if USE_ITT_BUILD
20297cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
20307cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20317cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
20327cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
20337cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
20347cc577a4SJonathan Peyton 
20357cc577a4SJonathan Peyton #if USE_ITT_BUILD
2036838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2037838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2038838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2039838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
20407cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20417cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial) {
20427cc577a4SJonathan Peyton       kmp_task_team_t *task_team = thread->th.th_task_team;
20437cc577a4SJonathan Peyton       if (task_team != NULL) {
20447cc577a4SJonathan Peyton         if (KMP_TASKING_ENABLED(task_team)) {
204582e94a59SJoachim Protze #if OMPT_SUPPORT
2046f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
204782e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 1;
204882e94a59SJoachim Protze #endif
20493041982dSJonathan Peyton           __kmp_execute_tasks_32(
2050e0665a90STerry Wilmarth               thread, gtid, (kmp_flag_32<> *)NULL, FALSE,
20513041982dSJonathan Peyton               &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
20523041982dSJonathan Peyton               __kmp_task_stealing_constraint);
205382e94a59SJoachim Protze #if OMPT_SUPPORT
2054f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
205582e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 0;
205682e94a59SJoachim Protze #endif
20577cc577a4SJonathan Peyton         }
20587cc577a4SJonathan Peyton       }
20597cc577a4SJonathan Peyton     }
20607cc577a4SJonathan Peyton #if USE_ITT_BUILD
2061838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
20627cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
20637cc577a4SJonathan Peyton 
20643041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
20653041982dSJonathan Peyton     // negated.
20667cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
20677cc577a4SJonathan Peyton   }
20687cc577a4SJonathan Peyton 
20697cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(exit): T#%d task %p resuming, "
20703041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
20713041982dSJonathan Peyton                 gtid, taskdata));
20727cc577a4SJonathan Peyton 
20737cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
20747cc577a4SJonathan Peyton }
20757cc577a4SJonathan Peyton 
207672ba2109SAndrey Churbanov // Task Reduction implementation
2077a8426ac8SJonathan Peyton //
2078a8426ac8SJonathan Peyton // Note: initial implementation didn't take into account the possibility
2079a8426ac8SJonathan Peyton // to specify omp_orig for initializer of the UDR (user defined reduction).
2080a8426ac8SJonathan Peyton // Corrected implementation takes into account the omp_orig object.
2081a8426ac8SJonathan Peyton // Compiler is free to use old implementation if omp_orig is not specified.
208272ba2109SAndrey Churbanov 
2083a8426ac8SJonathan Peyton /*!
2084a8426ac8SJonathan Peyton @ingroup BASIC_TYPES
2085a8426ac8SJonathan Peyton @{
2086a8426ac8SJonathan Peyton */
2087a8426ac8SJonathan Peyton 
2088a8426ac8SJonathan Peyton /*!
2089a8426ac8SJonathan Peyton Flags for special info per task reduction item.
2090a8426ac8SJonathan Peyton */
2091a8426ac8SJonathan Peyton typedef struct kmp_taskred_flags {
2092a8426ac8SJonathan Peyton   /*! 1 - use lazy alloc/init (e.g. big objects, #tasks < #threads) */
2093a8426ac8SJonathan Peyton   unsigned lazy_priv : 1;
209472ba2109SAndrey Churbanov   unsigned reserved31 : 31;
2095a8426ac8SJonathan Peyton } kmp_taskred_flags_t;
209672ba2109SAndrey Churbanov 
2097a8426ac8SJonathan Peyton /*!
2098a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2099a8426ac8SJonathan Peyton */
210072ba2109SAndrey Churbanov typedef struct kmp_task_red_input {
2101a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2102a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item in bytes */
2103a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2104a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (single parameter) */
2105a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2106a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2107a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
210872ba2109SAndrey Churbanov } kmp_task_red_input_t;
210972ba2109SAndrey Churbanov 
211072ba2109SAndrey Churbanov /*!
2111a8426ac8SJonathan Peyton Internal struct for reduction data item related info saved by the library.
211272ba2109SAndrey Churbanov */
2113a8426ac8SJonathan Peyton typedef struct kmp_taskred_data {
2114a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2115a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2116a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2117a8426ac8SJonathan Peyton   void *reduce_priv; /**< array of thread specific items */
2118a8426ac8SJonathan Peyton   void *reduce_pend; /**< end of private data for faster comparison op */
2119a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2120a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2121a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2122a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2123a8426ac8SJonathan Peyton   void *reduce_orig; /**< original item (can be used in UDR initializer) */
2124a8426ac8SJonathan Peyton } kmp_taskred_data_t;
2125a8426ac8SJonathan Peyton 
2126a8426ac8SJonathan Peyton /*!
2127a8426ac8SJonathan Peyton Internal struct for reduction data item related info set up by compiler.
2128a8426ac8SJonathan Peyton 
2129a8426ac8SJonathan Peyton New interface: added reduce_orig field to provide omp_orig for UDR initializer.
2130a8426ac8SJonathan Peyton */
2131a8426ac8SJonathan Peyton typedef struct kmp_taskred_input {
2132a8426ac8SJonathan Peyton   void *reduce_shar; /**< shared between tasks item to reduce into */
2133a8426ac8SJonathan Peyton   void *reduce_orig; /**< original reduction item used for initialization */
2134a8426ac8SJonathan Peyton   size_t reduce_size; /**< size of data item */
2135a8426ac8SJonathan Peyton   // three compiler-generated routines (init, fini are optional):
2136a8426ac8SJonathan Peyton   void *reduce_init; /**< data initialization routine (two parameters) */
2137a8426ac8SJonathan Peyton   void *reduce_fini; /**< data finalization routine */
2138a8426ac8SJonathan Peyton   void *reduce_comb; /**< data combiner routine */
2139a8426ac8SJonathan Peyton   kmp_taskred_flags_t flags; /**< flags for additional info from compiler */
2140a8426ac8SJonathan Peyton } kmp_taskred_input_t;
2141a8426ac8SJonathan Peyton /*!
2142a8426ac8SJonathan Peyton @}
2143a8426ac8SJonathan Peyton */
2144a8426ac8SJonathan Peyton 
2145a8426ac8SJonathan Peyton template <typename T> void __kmp_assign_orig(kmp_taskred_data_t &item, T &src);
2146a8426ac8SJonathan Peyton template <>
2147a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_task_red_input_t>(kmp_taskred_data_t &item,
2148a8426ac8SJonathan Peyton                                              kmp_task_red_input_t &src) {
2149a8426ac8SJonathan Peyton   item.reduce_orig = NULL;
2150a8426ac8SJonathan Peyton }
2151a8426ac8SJonathan Peyton template <>
2152a8426ac8SJonathan Peyton void __kmp_assign_orig<kmp_taskred_input_t>(kmp_taskred_data_t &item,
2153a8426ac8SJonathan Peyton                                             kmp_taskred_input_t &src) {
2154a8426ac8SJonathan Peyton   if (src.reduce_orig != NULL) {
2155a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_orig;
2156a8426ac8SJonathan Peyton   } else {
2157a8426ac8SJonathan Peyton     item.reduce_orig = src.reduce_shar;
2158a8426ac8SJonathan Peyton   } // non-NULL reduce_orig means new interface used
2159a8426ac8SJonathan Peyton }
2160a8426ac8SJonathan Peyton 
21616b316febSTerry Wilmarth template <typename T> void __kmp_call_init(kmp_taskred_data_t &item, size_t j);
2162a8426ac8SJonathan Peyton template <>
2163a8426ac8SJonathan Peyton void __kmp_call_init<kmp_task_red_input_t>(kmp_taskred_data_t &item,
21646b316febSTerry Wilmarth                                            size_t offset) {
2165a8426ac8SJonathan Peyton   ((void (*)(void *))item.reduce_init)((char *)(item.reduce_priv) + offset);
2166a8426ac8SJonathan Peyton }
2167a8426ac8SJonathan Peyton template <>
2168a8426ac8SJonathan Peyton void __kmp_call_init<kmp_taskred_input_t>(kmp_taskred_data_t &item,
21696b316febSTerry Wilmarth                                           size_t offset) {
2170a8426ac8SJonathan Peyton   ((void (*)(void *, void *))item.reduce_init)(
2171a8426ac8SJonathan Peyton       (char *)(item.reduce_priv) + offset, item.reduce_orig);
2172a8426ac8SJonathan Peyton }
2173a8426ac8SJonathan Peyton 
2174a8426ac8SJonathan Peyton template <typename T>
2175a8426ac8SJonathan Peyton void *__kmp_task_reduction_init(int gtid, int num, T *data) {
2176787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
217772ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
217872ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = thread->th.th_current_task->td_taskgroup;
21796b316febSTerry Wilmarth   kmp_uint32 nth = thread->th.th_team_nproc;
2180a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
218172ba2109SAndrey Churbanov 
218272ba2109SAndrey Churbanov   // check input data just in case
218372ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
218472ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
218572ba2109SAndrey Churbanov   KMP_ASSERT(num > 0);
218672ba2109SAndrey Churbanov   if (nth == 1) {
218772ba2109SAndrey Churbanov     KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, tg %p, exiting nth=1\n",
218872ba2109SAndrey Churbanov                   gtid, tg));
218972ba2109SAndrey Churbanov     return (void *)tg;
219072ba2109SAndrey Churbanov   }
219172ba2109SAndrey Churbanov   KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, taskgroup %p, #items %d\n",
219272ba2109SAndrey Churbanov                 gtid, tg, num));
2193a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2194a8426ac8SJonathan Peyton       thread, num * sizeof(kmp_taskred_data_t));
219572ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
2196a8426ac8SJonathan Peyton     size_t size = data[i].reduce_size - 1;
219772ba2109SAndrey Churbanov     // round the size up to cache line per thread-specific item
219872ba2109SAndrey Churbanov     size += CACHE_LINE - size % CACHE_LINE;
2199a8426ac8SJonathan Peyton     KMP_ASSERT(data[i].reduce_comb != NULL); // combiner is mandatory
2200a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar;
220172ba2109SAndrey Churbanov     arr[i].reduce_size = size;
2202a8426ac8SJonathan Peyton     arr[i].flags = data[i].flags;
2203a8426ac8SJonathan Peyton     arr[i].reduce_comb = data[i].reduce_comb;
2204a8426ac8SJonathan Peyton     arr[i].reduce_init = data[i].reduce_init;
2205a8426ac8SJonathan Peyton     arr[i].reduce_fini = data[i].reduce_fini;
2206a8426ac8SJonathan Peyton     __kmp_assign_orig<T>(arr[i], data[i]);
2207a8426ac8SJonathan Peyton     if (!arr[i].flags.lazy_priv) {
220872ba2109SAndrey Churbanov       // allocate cache-line aligned block and fill it with zeros
220972ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * size);
221072ba2109SAndrey Churbanov       arr[i].reduce_pend = (char *)(arr[i].reduce_priv) + nth * size;
2211a8426ac8SJonathan Peyton       if (arr[i].reduce_init != NULL) {
2212a8426ac8SJonathan Peyton         // initialize all thread-specific items
22136b316febSTerry Wilmarth         for (size_t j = 0; j < nth; ++j) {
2214a8426ac8SJonathan Peyton           __kmp_call_init<T>(arr[i], j * size);
221572ba2109SAndrey Churbanov         }
221672ba2109SAndrey Churbanov       }
221772ba2109SAndrey Churbanov     } else {
221872ba2109SAndrey Churbanov       // only allocate space for pointers now,
2219a8426ac8SJonathan Peyton       // objects will be lazily allocated/initialized if/when requested
2220a8426ac8SJonathan Peyton       // note that __kmp_allocate zeroes the allocated memory
222172ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * sizeof(void *));
222272ba2109SAndrey Churbanov     }
222372ba2109SAndrey Churbanov   }
222472ba2109SAndrey Churbanov   tg->reduce_data = (void *)arr;
222572ba2109SAndrey Churbanov   tg->reduce_num_data = num;
222672ba2109SAndrey Churbanov   return (void *)tg;
222772ba2109SAndrey Churbanov }
222872ba2109SAndrey Churbanov 
222972ba2109SAndrey Churbanov /*!
223072ba2109SAndrey Churbanov @ingroup TASKING
223172ba2109SAndrey Churbanov @param gtid      Global thread ID
2232a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2233a8426ac8SJonathan Peyton @param data      Array of data for reduction
2234a8426ac8SJonathan Peyton @return The taskgroup identifier
2235a8426ac8SJonathan Peyton 
2236a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2237a8426ac8SJonathan Peyton 
2238a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2239a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2240a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2241a8426ac8SJonathan Peyton without help of the runtime library.
2242a8426ac8SJonathan Peyton */
2243a8426ac8SJonathan Peyton void *__kmpc_task_reduction_init(int gtid, int num, void *data) {
2244a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_task_red_input_t *)data);
2245a8426ac8SJonathan Peyton }
2246a8426ac8SJonathan Peyton 
2247a8426ac8SJonathan Peyton /*!
2248a8426ac8SJonathan Peyton @ingroup TASKING
2249a8426ac8SJonathan Peyton @param gtid      Global thread ID
2250a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2251a8426ac8SJonathan Peyton @param data      Array of data for reduction
2252a8426ac8SJonathan Peyton @return The taskgroup identifier
2253a8426ac8SJonathan Peyton 
2254a8426ac8SJonathan Peyton Initialize task reduction for the taskgroup.
2255a8426ac8SJonathan Peyton 
2256a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2257a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2258a8426ac8SJonathan Peyton */
2259a8426ac8SJonathan Peyton void *__kmpc_taskred_init(int gtid, int num, void *data) {
2260a8426ac8SJonathan Peyton   return __kmp_task_reduction_init(gtid, num, (kmp_taskred_input_t *)data);
2261a8426ac8SJonathan Peyton }
2262a8426ac8SJonathan Peyton 
2263a8426ac8SJonathan Peyton // Copy task reduction data (except for shared pointers).
2264a8426ac8SJonathan Peyton template <typename T>
2265a8426ac8SJonathan Peyton void __kmp_task_reduction_init_copy(kmp_info_t *thr, int num, T *data,
2266a8426ac8SJonathan Peyton                                     kmp_taskgroup_t *tg, void *reduce_data) {
2267a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr;
2268a8426ac8SJonathan Peyton   KA_TRACE(20, ("__kmp_task_reduction_init_copy: Th %p, init taskgroup %p,"
2269a8426ac8SJonathan Peyton                 " from data %p\n",
2270a8426ac8SJonathan Peyton                 thr, tg, reduce_data));
2271a8426ac8SJonathan Peyton   arr = (kmp_taskred_data_t *)__kmp_thread_malloc(
2272a8426ac8SJonathan Peyton       thr, num * sizeof(kmp_taskred_data_t));
2273a8426ac8SJonathan Peyton   // threads will share private copies, thunk routines, sizes, flags, etc.:
2274a8426ac8SJonathan Peyton   KMP_MEMCPY(arr, reduce_data, num * sizeof(kmp_taskred_data_t));
2275a8426ac8SJonathan Peyton   for (int i = 0; i < num; ++i) {
2276a8426ac8SJonathan Peyton     arr[i].reduce_shar = data[i].reduce_shar; // init unique shared pointers
2277a8426ac8SJonathan Peyton   }
2278a8426ac8SJonathan Peyton   tg->reduce_data = (void *)arr;
2279a8426ac8SJonathan Peyton   tg->reduce_num_data = num;
2280a8426ac8SJonathan Peyton }
2281a8426ac8SJonathan Peyton 
2282a8426ac8SJonathan Peyton /*!
2283a8426ac8SJonathan Peyton @ingroup TASKING
2284a8426ac8SJonathan Peyton @param gtid    Global thread ID
228572ba2109SAndrey Churbanov @param tskgrp  The taskgroup ID (optional)
228672ba2109SAndrey Churbanov @param data    Shared location of the item
228772ba2109SAndrey Churbanov @return The pointer to per-thread data
228872ba2109SAndrey Churbanov 
228972ba2109SAndrey Churbanov Get thread-specific location of data item
229072ba2109SAndrey Churbanov */
22913041982dSJonathan Peyton void *__kmpc_task_reduction_get_th_data(int gtid, void *tskgrp, void *data) {
2292787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
229372ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
229472ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
229572ba2109SAndrey Churbanov   if (nth == 1)
229672ba2109SAndrey Churbanov     return data; // nothing to do
229772ba2109SAndrey Churbanov 
229872ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = (kmp_taskgroup_t *)tskgrp;
229972ba2109SAndrey Churbanov   if (tg == NULL)
230072ba2109SAndrey Churbanov     tg = thread->th.th_current_task->td_taskgroup;
230172ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
2302a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)(tg->reduce_data);
230372ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
230472ba2109SAndrey Churbanov   kmp_int32 tid = thread->th.th_info.ds.ds_tid;
230572ba2109SAndrey Churbanov 
230672ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
230772ba2109SAndrey Churbanov   while (tg != NULL) {
230872ba2109SAndrey Churbanov     for (int i = 0; i < num; ++i) {
230972ba2109SAndrey Churbanov       if (!arr[i].flags.lazy_priv) {
231072ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar ||
231172ba2109SAndrey Churbanov             (data >= arr[i].reduce_priv && data < arr[i].reduce_pend))
231272ba2109SAndrey Churbanov           return (char *)(arr[i].reduce_priv) + tid * arr[i].reduce_size;
231372ba2109SAndrey Churbanov       } else {
231472ba2109SAndrey Churbanov         // check shared location first
231572ba2109SAndrey Churbanov         void **p_priv = (void **)(arr[i].reduce_priv);
231672ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar)
231772ba2109SAndrey Churbanov           goto found;
231872ba2109SAndrey Churbanov         // check if we get some thread specific location as parameter
231972ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j)
232072ba2109SAndrey Churbanov           if (data == p_priv[j])
232172ba2109SAndrey Churbanov             goto found;
232272ba2109SAndrey Churbanov         continue; // not found, continue search
232372ba2109SAndrey Churbanov       found:
232472ba2109SAndrey Churbanov         if (p_priv[tid] == NULL) {
232572ba2109SAndrey Churbanov           // allocate thread specific object lazily
232672ba2109SAndrey Churbanov           p_priv[tid] = __kmp_allocate(arr[i].reduce_size);
2327a8426ac8SJonathan Peyton           if (arr[i].reduce_init != NULL) {
2328a8426ac8SJonathan Peyton             if (arr[i].reduce_orig != NULL) { // new interface
2329a8426ac8SJonathan Peyton               ((void (*)(void *, void *))arr[i].reduce_init)(
2330a8426ac8SJonathan Peyton                   p_priv[tid], arr[i].reduce_orig);
2331a8426ac8SJonathan Peyton             } else { // old interface (single parameter)
2332a8426ac8SJonathan Peyton               ((void (*)(void *))arr[i].reduce_init)(p_priv[tid]);
2333a8426ac8SJonathan Peyton             }
233472ba2109SAndrey Churbanov           }
233572ba2109SAndrey Churbanov         }
233672ba2109SAndrey Churbanov         return p_priv[tid];
233772ba2109SAndrey Churbanov       }
233872ba2109SAndrey Churbanov     }
233972ba2109SAndrey Churbanov     tg = tg->parent;
2340a8426ac8SJonathan Peyton     arr = (kmp_taskred_data_t *)(tg->reduce_data);
234172ba2109SAndrey Churbanov     num = tg->reduce_num_data;
234272ba2109SAndrey Churbanov   }
234372ba2109SAndrey Churbanov   KMP_ASSERT2(0, "Unknown task reduction item");
234472ba2109SAndrey Churbanov   return NULL; // ERROR, this line never executed
234572ba2109SAndrey Churbanov }
234672ba2109SAndrey Churbanov 
234772ba2109SAndrey Churbanov // Finalize task reduction.
234872ba2109SAndrey Churbanov // Called from __kmpc_end_taskgroup()
23493041982dSJonathan Peyton static void __kmp_task_reduction_fini(kmp_info_t *th, kmp_taskgroup_t *tg) {
235072ba2109SAndrey Churbanov   kmp_int32 nth = th->th.th_team_nproc;
235172ba2109SAndrey Churbanov   KMP_DEBUG_ASSERT(nth > 1); // should not be called if nth == 1
2352a8426ac8SJonathan Peyton   kmp_taskred_data_t *arr = (kmp_taskred_data_t *)tg->reduce_data;
235372ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
235472ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
235572ba2109SAndrey Churbanov     void *sh_data = arr[i].reduce_shar;
235672ba2109SAndrey Churbanov     void (*f_fini)(void *) = (void (*)(void *))(arr[i].reduce_fini);
23573041982dSJonathan Peyton     void (*f_comb)(void *, void *) =
23583041982dSJonathan Peyton         (void (*)(void *, void *))(arr[i].reduce_comb);
235972ba2109SAndrey Churbanov     if (!arr[i].flags.lazy_priv) {
236072ba2109SAndrey Churbanov       void *pr_data = arr[i].reduce_priv;
236172ba2109SAndrey Churbanov       size_t size = arr[i].reduce_size;
236272ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
236372ba2109SAndrey Churbanov         void *priv_data = (char *)pr_data + j * size;
236472ba2109SAndrey Churbanov         f_comb(sh_data, priv_data); // combine results
236572ba2109SAndrey Churbanov         if (f_fini)
236672ba2109SAndrey Churbanov           f_fini(priv_data); // finalize if needed
236772ba2109SAndrey Churbanov       }
236872ba2109SAndrey Churbanov     } else {
236972ba2109SAndrey Churbanov       void **pr_data = (void **)(arr[i].reduce_priv);
237072ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
237172ba2109SAndrey Churbanov         if (pr_data[j] != NULL) {
237272ba2109SAndrey Churbanov           f_comb(sh_data, pr_data[j]); // combine results
237372ba2109SAndrey Churbanov           if (f_fini)
237472ba2109SAndrey Churbanov             f_fini(pr_data[j]); // finalize if needed
237572ba2109SAndrey Churbanov           __kmp_free(pr_data[j]);
237672ba2109SAndrey Churbanov         }
237772ba2109SAndrey Churbanov       }
237872ba2109SAndrey Churbanov     }
237972ba2109SAndrey Churbanov     __kmp_free(arr[i].reduce_priv);
238072ba2109SAndrey Churbanov   }
238172ba2109SAndrey Churbanov   __kmp_thread_free(th, arr);
238272ba2109SAndrey Churbanov   tg->reduce_data = NULL;
238372ba2109SAndrey Churbanov   tg->reduce_num_data = 0;
238472ba2109SAndrey Churbanov }
2385a8426ac8SJonathan Peyton 
2386a8426ac8SJonathan Peyton // Cleanup task reduction data for parallel or worksharing,
2387a8426ac8SJonathan Peyton // do not touch task private data other threads still working with.
2388a8426ac8SJonathan Peyton // Called from __kmpc_end_taskgroup()
2389a8426ac8SJonathan Peyton static void __kmp_task_reduction_clean(kmp_info_t *th, kmp_taskgroup_t *tg) {
2390a8426ac8SJonathan Peyton   __kmp_thread_free(th, tg->reduce_data);
2391a8426ac8SJonathan Peyton   tg->reduce_data = NULL;
2392a8426ac8SJonathan Peyton   tg->reduce_num_data = 0;
2393a8426ac8SJonathan Peyton }
2394a8426ac8SJonathan Peyton 
2395a8426ac8SJonathan Peyton template <typename T>
2396a8426ac8SJonathan Peyton void *__kmp_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2397a8426ac8SJonathan Peyton                                          int num, T *data) {
2398787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
2399a8426ac8SJonathan Peyton   kmp_info_t *thr = __kmp_threads[gtid];
2400a8426ac8SJonathan Peyton   kmp_int32 nth = thr->th.th_team_nproc;
2401a8426ac8SJonathan Peyton   __kmpc_taskgroup(loc, gtid); // form new taskgroup first
2402a8426ac8SJonathan Peyton   if (nth == 1) {
2403a8426ac8SJonathan Peyton     KA_TRACE(10,
2404a8426ac8SJonathan Peyton              ("__kmpc_reduction_modifier_init: T#%d, tg %p, exiting nth=1\n",
2405a8426ac8SJonathan Peyton               gtid, thr->th.th_current_task->td_taskgroup));
2406a8426ac8SJonathan Peyton     return (void *)thr->th.th_current_task->td_taskgroup;
2407a8426ac8SJonathan Peyton   }
2408a8426ac8SJonathan Peyton   kmp_team_t *team = thr->th.th_team;
2409a8426ac8SJonathan Peyton   void *reduce_data;
2410a8426ac8SJonathan Peyton   kmp_taskgroup_t *tg;
2411a8426ac8SJonathan Peyton   reduce_data = KMP_ATOMIC_LD_RLX(&team->t.t_tg_reduce_data[is_ws]);
2412a8426ac8SJonathan Peyton   if (reduce_data == NULL &&
2413a8426ac8SJonathan Peyton       __kmp_atomic_compare_store(&team->t.t_tg_reduce_data[is_ws], reduce_data,
2414a8426ac8SJonathan Peyton                                  (void *)1)) {
2415a8426ac8SJonathan Peyton     // single thread enters this block to initialize common reduction data
2416a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data == NULL);
2417a8426ac8SJonathan Peyton     // first initialize own data, then make a copy other threads can use
2418a8426ac8SJonathan Peyton     tg = (kmp_taskgroup_t *)__kmp_task_reduction_init<T>(gtid, num, data);
2419a8426ac8SJonathan Peyton     reduce_data = __kmp_thread_malloc(thr, num * sizeof(kmp_taskred_data_t));
2420a8426ac8SJonathan Peyton     KMP_MEMCPY(reduce_data, tg->reduce_data, num * sizeof(kmp_taskred_data_t));
2421a8426ac8SJonathan Peyton     // fini counters should be 0 at this point
2422a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[0]) == 0);
2423a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(KMP_ATOMIC_LD_RLX(&team->t.t_tg_fini_counter[1]) == 0);
2424a8426ac8SJonathan Peyton     KMP_ATOMIC_ST_REL(&team->t.t_tg_reduce_data[is_ws], reduce_data);
2425a8426ac8SJonathan Peyton   } else {
2426a8426ac8SJonathan Peyton     while (
2427a8426ac8SJonathan Peyton         (reduce_data = KMP_ATOMIC_LD_ACQ(&team->t.t_tg_reduce_data[is_ws])) ==
2428a8426ac8SJonathan Peyton         (void *)1) { // wait for task reduction initialization
2429a8426ac8SJonathan Peyton       KMP_CPU_PAUSE();
2430a8426ac8SJonathan Peyton     }
2431a8426ac8SJonathan Peyton     KMP_DEBUG_ASSERT(reduce_data > (void *)1); // should be valid pointer here
2432a8426ac8SJonathan Peyton     tg = thr->th.th_current_task->td_taskgroup;
2433a8426ac8SJonathan Peyton     __kmp_task_reduction_init_copy<T>(thr, num, data, tg, reduce_data);
2434a8426ac8SJonathan Peyton   }
2435a8426ac8SJonathan Peyton   return tg;
2436a8426ac8SJonathan Peyton }
2437a8426ac8SJonathan Peyton 
2438a8426ac8SJonathan Peyton /*!
2439a8426ac8SJonathan Peyton @ingroup TASKING
2440a8426ac8SJonathan Peyton @param loc       Source location info
2441a8426ac8SJonathan Peyton @param gtid      Global thread ID
2442a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2443a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2444a8426ac8SJonathan Peyton @param data      Array of data for reduction
2445a8426ac8SJonathan Peyton @return The taskgroup identifier
2446a8426ac8SJonathan Peyton 
2447a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2448a8426ac8SJonathan Peyton 
2449a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2450a8426ac8SJonathan Peyton has single parameter - pointer to object to be initialized. That means
2451a8426ac8SJonathan Peyton the reduction either does not use omp_orig object, or the omp_orig is accessible
2452a8426ac8SJonathan Peyton without help of the runtime library.
2453a8426ac8SJonathan Peyton */
2454a8426ac8SJonathan Peyton void *__kmpc_task_reduction_modifier_init(ident_t *loc, int gtid, int is_ws,
2455a8426ac8SJonathan Peyton                                           int num, void *data) {
2456a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2457a8426ac8SJonathan Peyton                                             (kmp_task_red_input_t *)data);
2458a8426ac8SJonathan Peyton }
2459a8426ac8SJonathan Peyton 
2460a8426ac8SJonathan Peyton /*!
2461a8426ac8SJonathan Peyton @ingroup TASKING
2462a8426ac8SJonathan Peyton @param loc       Source location info
2463a8426ac8SJonathan Peyton @param gtid      Global thread ID
2464a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2465a8426ac8SJonathan Peyton @param num       Number of data items to reduce
2466a8426ac8SJonathan Peyton @param data      Array of data for reduction
2467a8426ac8SJonathan Peyton @return The taskgroup identifier
2468a8426ac8SJonathan Peyton 
2469a8426ac8SJonathan Peyton Initialize task reduction for a parallel or worksharing.
2470a8426ac8SJonathan Peyton 
2471a8426ac8SJonathan Peyton Note: this entry supposes the optional compiler-generated initializer routine
2472a8426ac8SJonathan Peyton has two parameters, pointer to object to be initialized and pointer to omp_orig
2473a8426ac8SJonathan Peyton */
2474a8426ac8SJonathan Peyton void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int is_ws, int num,
2475a8426ac8SJonathan Peyton                                    void *data) {
2476a8426ac8SJonathan Peyton   return __kmp_task_reduction_modifier_init(loc, gtid, is_ws, num,
2477a8426ac8SJonathan Peyton                                             (kmp_taskred_input_t *)data);
2478a8426ac8SJonathan Peyton }
2479a8426ac8SJonathan Peyton 
2480a8426ac8SJonathan Peyton /*!
2481a8426ac8SJonathan Peyton @ingroup TASKING
2482a8426ac8SJonathan Peyton @param loc       Source location info
2483a8426ac8SJonathan Peyton @param gtid      Global thread ID
2484a8426ac8SJonathan Peyton @param is_ws     Is 1 if the reduction is for worksharing, 0 otherwise
2485a8426ac8SJonathan Peyton 
2486a8426ac8SJonathan Peyton Finalize task reduction for a parallel or worksharing.
2487a8426ac8SJonathan Peyton */
2488a8426ac8SJonathan Peyton void __kmpc_task_reduction_modifier_fini(ident_t *loc, int gtid, int is_ws) {
2489a8426ac8SJonathan Peyton   __kmpc_end_taskgroup(loc, gtid);
2490a8426ac8SJonathan Peyton }
24917cc577a4SJonathan Peyton 
24927cc577a4SJonathan Peyton // __kmpc_taskgroup: Start a new taskgroup
24933041982dSJonathan Peyton void __kmpc_taskgroup(ident_t *loc, int gtid) {
2494787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
24957cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
24967cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
24977cc577a4SJonathan Peyton   kmp_taskgroup_t *tg_new =
24987cc577a4SJonathan Peyton       (kmp_taskgroup_t *)__kmp_thread_malloc(thread, sizeof(kmp_taskgroup_t));
24997cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_taskgroup: T#%d loc=%p group=%p\n", gtid, loc, tg_new));
250037e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->count, 0);
250137e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->cancel_request, cancel_noreq);
25027cc577a4SJonathan Peyton   tg_new->parent = taskdata->td_taskgroup;
250372ba2109SAndrey Churbanov   tg_new->reduce_data = NULL;
250472ba2109SAndrey Churbanov   tg_new->reduce_num_data = 0;
250544575657SPeyton, Jonathan L   tg_new->gomp_data = NULL;
25067cc577a4SJonathan Peyton   taskdata->td_taskgroup = tg_new;
250782e94a59SJoachim Protze 
250882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2509f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
251082e94a59SJoachim Protze     void *codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
251182e94a59SJoachim Protze     if (!codeptr)
251282e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
251382e94a59SJoachim Protze     kmp_team_t *team = thread->th.th_team;
251482e94a59SJoachim Protze     ompt_data_t my_task_data = taskdata->ompt_task_info.task_data;
251582e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
251682e94a59SJoachim Protze     ompt_data_t my_parallel_data = team->t.ompt_team_info.parallel_data;
251782e94a59SJoachim Protze 
251882e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
251982e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
252082e94a59SJoachim Protze         &(my_task_data), codeptr);
252182e94a59SJoachim Protze   }
252282e94a59SJoachim Protze #endif
25237cc577a4SJonathan Peyton }
25247cc577a4SJonathan Peyton 
25257cc577a4SJonathan Peyton // __kmpc_end_taskgroup: Wait until all tasks generated by the current task
25267cc577a4SJonathan Peyton //                       and its descendants are complete
25273041982dSJonathan Peyton void __kmpc_end_taskgroup(ident_t *loc, int gtid) {
2528787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
25297cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
25307cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
25317cc577a4SJonathan Peyton   kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
25327cc577a4SJonathan Peyton   int thread_finished = FALSE;
25337cc577a4SJonathan Peyton 
253482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
253582e94a59SJoachim Protze   kmp_team_t *team;
253682e94a59SJoachim Protze   ompt_data_t my_task_data;
253782e94a59SJoachim Protze   ompt_data_t my_parallel_data;
2538467f3924SHansang Bae   void *codeptr = nullptr;
2539f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
254082e94a59SJoachim Protze     team = thread->th.th_team;
254182e94a59SJoachim Protze     my_task_data = taskdata->ompt_task_info.task_data;
254282e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
254382e94a59SJoachim Protze     my_parallel_data = team->t.ompt_team_info.parallel_data;
254482e94a59SJoachim Protze     codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
254582e94a59SJoachim Protze     if (!codeptr)
254682e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
254782e94a59SJoachim Protze   }
254882e94a59SJoachim Protze #endif
254982e94a59SJoachim Protze 
25507cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(enter): T#%d loc=%p\n", gtid, loc));
25517cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup != NULL);
25527cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKGROUP);
25537cc577a4SJonathan Peyton 
25547cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
2555a756cb24SAndrey Churbanov     // mark task as waiting not on a barrier
2556a756cb24SAndrey Churbanov     taskdata->td_taskwait_counter += 1;
2557a756cb24SAndrey Churbanov     taskdata->td_taskwait_ident = loc;
2558a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = gtid + 1;
25597cc577a4SJonathan Peyton #if USE_ITT_BUILD
25603041982dSJonathan Peyton     // For ITT the taskgroup wait is similar to taskwait until we need to
25613041982dSJonathan Peyton     // distinguish them
2562838dcdb5SAndreyChurbanov     void *itt_sync_obj = NULL;
2563838dcdb5SAndreyChurbanov #if USE_ITT_NOTIFY
2564838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_STARTING(itt_sync_obj);
2565838dcdb5SAndreyChurbanov #endif /* USE_ITT_NOTIFY */
25667cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25677cc577a4SJonathan Peyton 
256882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2569f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
257082e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
257182e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
257282e94a59SJoachim Protze           &(my_task_data), codeptr);
257382e94a59SJoachim Protze     }
257482e94a59SJoachim Protze #endif
257582e94a59SJoachim Protze 
25763041982dSJonathan Peyton     if (!taskdata->td_flags.team_serial ||
25773041982dSJonathan Peyton         (thread->th.th_task_team != NULL &&
2578996baa58SShilei Tian          (thread->th.th_task_team->tt.tt_found_proxy_tasks ||
2579996baa58SShilei Tian           thread->th.th_task_team->tt.tt_hidden_helper_task_encountered))) {
2580e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
2581e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *, &(taskgroup->count)), 0U);
258237e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskgroup->count) != 0) {
25833041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
25843041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
25853041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
25867cc577a4SJonathan Peyton       }
25877cc577a4SJonathan Peyton     }
2588a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread; // end waiting
25897cc577a4SJonathan Peyton 
259082e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2591f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
259282e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
259382e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
259482e94a59SJoachim Protze           &(my_task_data), codeptr);
259582e94a59SJoachim Protze     }
259682e94a59SJoachim Protze #endif
259782e94a59SJoachim Protze 
25987cc577a4SJonathan Peyton #if USE_ITT_BUILD
2599838dcdb5SAndreyChurbanov     KMP_ITT_TASKWAIT_FINISHED(itt_sync_obj);
2600ffd8f009SAndreyChurbanov     KMP_FSYNC_ACQUIRED(taskdata); // acquire self - sync with descendants
26017cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
26027cc577a4SJonathan Peyton   }
26037cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup->count == 0);
26047cc577a4SJonathan Peyton 
260544575657SPeyton, Jonathan L   if (taskgroup->reduce_data != NULL &&
260644575657SPeyton, Jonathan L       !taskgroup->gomp_data) { // need to reduce?
2607a8426ac8SJonathan Peyton     int cnt;
2608a8426ac8SJonathan Peyton     void *reduce_data;
2609a8426ac8SJonathan Peyton     kmp_team_t *t = thread->th.th_team;
2610a8426ac8SJonathan Peyton     kmp_taskred_data_t *arr = (kmp_taskred_data_t *)taskgroup->reduce_data;
2611a8426ac8SJonathan Peyton     // check if <priv> data of the first reduction variable shared for the team
2612a8426ac8SJonathan Peyton     void *priv0 = arr[0].reduce_priv;
2613a8426ac8SJonathan Peyton     if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[0])) != NULL &&
2614a8426ac8SJonathan Peyton         ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2615a8426ac8SJonathan Peyton       // finishing task reduction on parallel
2616a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[0]);
2617a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2618a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2619a8426ac8SJonathan Peyton         // finalize task reduction:
262072ba2109SAndrey Churbanov         __kmp_task_reduction_fini(thread, taskgroup);
2621a8426ac8SJonathan Peyton         // cleanup fields in the team structure:
2622a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2623a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2624a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[0], NULL);
2625a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[0], 0);
2626a8426ac8SJonathan Peyton       } else {
2627a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2628a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2629a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2630a8426ac8SJonathan Peyton       }
2631a8426ac8SJonathan Peyton     } else if ((reduce_data = KMP_ATOMIC_LD_ACQ(&t->t.t_tg_reduce_data[1])) !=
2632a8426ac8SJonathan Peyton                    NULL &&
2633a8426ac8SJonathan Peyton                ((kmp_taskred_data_t *)reduce_data)[0].reduce_priv == priv0) {
2634a8426ac8SJonathan Peyton       // finishing task reduction on worksharing
2635a8426ac8SJonathan Peyton       cnt = KMP_ATOMIC_INC(&t->t.t_tg_fini_counter[1]);
2636a8426ac8SJonathan Peyton       if (cnt == thread->th.th_team_nproc - 1) {
2637a8426ac8SJonathan Peyton         // we are the last thread passing __kmpc_reduction_modifier_fini()
2638a8426ac8SJonathan Peyton         __kmp_task_reduction_fini(thread, taskgroup);
2639a8426ac8SJonathan Peyton         // cleanup fields in team structure:
2640a8426ac8SJonathan Peyton         // TODO: is relaxed store enough here (whole barrier should follow)?
2641a8426ac8SJonathan Peyton         __kmp_thread_free(thread, reduce_data);
2642a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_reduce_data[1], NULL);
2643a8426ac8SJonathan Peyton         KMP_ATOMIC_ST_REL(&t->t.t_tg_fini_counter[1], 0);
2644a8426ac8SJonathan Peyton       } else {
2645a8426ac8SJonathan Peyton         // we are not the last thread passing __kmpc_reduction_modifier_fini(),
2646a8426ac8SJonathan Peyton         // so do not finalize reduction, just clean own copy of the data
2647a8426ac8SJonathan Peyton         __kmp_task_reduction_clean(thread, taskgroup);
2648a8426ac8SJonathan Peyton       }
2649a8426ac8SJonathan Peyton     } else {
2650a8426ac8SJonathan Peyton       // finishing task reduction on taskgroup
2651a8426ac8SJonathan Peyton       __kmp_task_reduction_fini(thread, taskgroup);
2652a8426ac8SJonathan Peyton     }
2653a8426ac8SJonathan Peyton   }
26547cc577a4SJonathan Peyton   // Restore parent taskgroup for the current task
26557cc577a4SJonathan Peyton   taskdata->td_taskgroup = taskgroup->parent;
26567cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskgroup);
26577cc577a4SJonathan Peyton 
26583041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(exit): T#%d task %p finished waiting\n",
26593041982dSJonathan Peyton                 gtid, taskdata));
266082e94a59SJoachim Protze 
266182e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2662f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
266382e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
266482e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
266582e94a59SJoachim Protze         &(my_task_data), codeptr);
266682e94a59SJoachim Protze   }
266782e94a59SJoachim Protze #endif
26687cc577a4SJonathan Peyton }
26697cc577a4SJonathan Peyton 
26707cc577a4SJonathan Peyton // __kmp_remove_my_task: remove a task from my own deque
26713041982dSJonathan Peyton static kmp_task_t *__kmp_remove_my_task(kmp_info_t *thread, kmp_int32 gtid,
26723041982dSJonathan Peyton                                         kmp_task_team_t *task_team,
26733041982dSJonathan Peyton                                         kmp_int32 is_constrained) {
26747cc577a4SJonathan Peyton   kmp_task_t *task;
26757cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
26767cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
26777cc577a4SJonathan Peyton   kmp_uint32 tail;
26787cc577a4SJonathan Peyton 
26797cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
26803041982dSJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_threads_data !=
26813041982dSJonathan Peyton                    NULL); // Caller should check this condition
26827cc577a4SJonathan Peyton 
26837cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
26847cc577a4SJonathan Peyton 
26857cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(enter): T#%d ntasks=%d head=%u tail=%u\n",
26863041982dSJonathan Peyton                 gtid, thread_data->td.td_deque_ntasks,
26873041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26887cc577a4SJonathan Peyton 
26897cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
26903041982dSJonathan Peyton     KA_TRACE(10,
26913041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #1): T#%d No tasks to remove: "
26923041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
26933041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
26943041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
26957cc577a4SJonathan Peyton     return NULL;
26967cc577a4SJonathan Peyton   }
26977cc577a4SJonathan Peyton 
26987cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
26997cc577a4SJonathan Peyton 
27007cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
27017cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
27023041982dSJonathan Peyton     KA_TRACE(10,
27033041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
27043041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27053041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
27063041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27077cc577a4SJonathan Peyton     return NULL;
27087cc577a4SJonathan Peyton   }
27097cc577a4SJonathan Peyton 
27103041982dSJonathan Peyton   tail = (thread_data->td.td_deque_tail - 1) &
27113041982dSJonathan Peyton          TASK_DEQUE_MASK(thread_data->td); // Wrap index.
27127cc577a4SJonathan Peyton   taskdata = thread_data->td.td_deque[tail];
27137cc577a4SJonathan Peyton 
2714c3344345SAndrey Churbanov   if (!__kmp_task_is_allowed(gtid, is_constrained, taskdata,
2715c3344345SAndrey Churbanov                              thread->th.th_current_task)) {
2716a756cb24SAndrey Churbanov     // The TSC does not allow to steal victim task
27177cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
2718c3344345SAndrey Churbanov     KA_TRACE(10,
2719c3344345SAndrey Churbanov              ("__kmp_remove_my_task(exit #3): T#%d TSC blocks tail task: "
27203041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
27213041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
2722c3344345SAndrey Churbanov               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27237cc577a4SJonathan Peyton     return NULL;
27247cc577a4SJonathan Peyton   }
27257cc577a4SJonathan Peyton 
27267cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = tail;
27277cc577a4SJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks, thread_data->td.td_deque_ntasks - 1);
27287cc577a4SJonathan Peyton 
27297cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
27307cc577a4SJonathan Peyton 
2731c3344345SAndrey Churbanov   KA_TRACE(10, ("__kmp_remove_my_task(exit #4): T#%d task %p removed: "
27323041982dSJonathan Peyton                 "ntasks=%d head=%u tail=%u\n",
27333041982dSJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
27343041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
27357cc577a4SJonathan Peyton 
27367cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
27377cc577a4SJonathan Peyton   return task;
27387cc577a4SJonathan Peyton }
27397cc577a4SJonathan Peyton 
27407cc577a4SJonathan Peyton // __kmp_steal_task: remove a task from another thread's deque
27417cc577a4SJonathan Peyton // Assume that calling thread has already checked existence of
27427cc577a4SJonathan Peyton // task_team thread_data before calling this routine.
2743a756cb24SAndrey Churbanov static kmp_task_t *__kmp_steal_task(kmp_info_t *victim_thr, kmp_int32 gtid,
2744c47afcd9SAndrey Churbanov                                     kmp_task_team_t *task_team,
274537e2ef54SJonathan Peyton                                     std::atomic<kmp_int32> *unfinished_threads,
2746c47afcd9SAndrey Churbanov                                     int *thread_finished,
2747c47afcd9SAndrey Churbanov                                     kmp_int32 is_constrained) {
27487cc577a4SJonathan Peyton   kmp_task_t *task;
27497cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
2750a756cb24SAndrey Churbanov   kmp_taskdata_t *current;
27517cc577a4SJonathan Peyton   kmp_thread_data_t *victim_td, *threads_data;
2752c3344345SAndrey Churbanov   kmp_int32 target;
27537cc577a4SJonathan Peyton   kmp_int32 victim_tid;
27547cc577a4SJonathan Peyton 
27557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
27567cc577a4SJonathan Peyton 
27577cc577a4SJonathan Peyton   threads_data = task_team->tt.tt_threads_data;
27587cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL); // Caller should check this condition
27597cc577a4SJonathan Peyton 
2760a756cb24SAndrey Churbanov   victim_tid = victim_thr->th.th_info.ds.ds_tid;
27617cc577a4SJonathan Peyton   victim_td = &threads_data[victim_tid];
27627cc577a4SJonathan Peyton 
27633041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_steal_task(enter): T#%d try to steal from T#%d: "
2764a756cb24SAndrey Churbanov                 "task_team=%p ntasks=%d head=%u tail=%u\n",
2765a756cb24SAndrey Churbanov                 gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27663041982dSJonathan Peyton                 victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27673041982dSJonathan Peyton                 victim_td->td.td_deque_tail));
27687cc577a4SJonathan Peyton 
2769a756cb24SAndrey Churbanov   if (TCR_4(victim_td->td.td_deque_ntasks) == 0) {
27703041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #1): T#%d could not steal from T#%d: "
2771a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2772a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team,
27733041982dSJonathan Peyton                   victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
27743041982dSJonathan Peyton                   victim_td->td.td_deque_tail));
27757cc577a4SJonathan Peyton     return NULL;
27767cc577a4SJonathan Peyton   }
27777cc577a4SJonathan Peyton 
27787cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&victim_td->td.td_deque_lock);
27797cc577a4SJonathan Peyton 
2780a756cb24SAndrey Churbanov   int ntasks = TCR_4(victim_td->td.td_deque_ntasks);
27817cc577a4SJonathan Peyton   // Check again after we acquire the lock
2782a756cb24SAndrey Churbanov   if (ntasks == 0) {
27837cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
27843041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #2): T#%d could not steal from T#%d: "
2785a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2786a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2787a756cb24SAndrey Churbanov                   victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
27887cc577a4SJonathan Peyton     return NULL;
27897cc577a4SJonathan Peyton   }
27907cc577a4SJonathan Peyton 
27917cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(victim_td->td.td_deque != NULL);
2792c3344345SAndrey Churbanov   current = __kmp_threads[gtid]->th.th_current_task;
27937cc577a4SJonathan Peyton   taskdata = victim_td->td.td_deque[victim_td->td.td_deque_head];
2794c3344345SAndrey Churbanov   if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2795c3344345SAndrey Churbanov     // Bump head pointer and Wrap.
2796c3344345SAndrey Churbanov     victim_td->td.td_deque_head =
2797c3344345SAndrey Churbanov         (victim_td->td.td_deque_head + 1) & TASK_DEQUE_MASK(victim_td->td);
2798c3344345SAndrey Churbanov   } else {
2799a756cb24SAndrey Churbanov     if (!task_team->tt.tt_untied_task_encountered) {
2800a756cb24SAndrey Churbanov       // The TSC does not allow to steal victim task
28017cc577a4SJonathan Peyton       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2802c3344345SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #3): T#%d could not steal from "
2803a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2804a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
28057cc577a4SJonathan Peyton                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28067cc577a4SJonathan Peyton       return NULL;
28077cc577a4SJonathan Peyton     }
2808a756cb24SAndrey Churbanov     int i;
2809a756cb24SAndrey Churbanov     // walk through victim's deque trying to steal any task
2810a756cb24SAndrey Churbanov     target = victim_td->td.td_deque_head;
2811c3344345SAndrey Churbanov     taskdata = NULL;
2812a756cb24SAndrey Churbanov     for (i = 1; i < ntasks; ++i) {
2813a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2814a756cb24SAndrey Churbanov       taskdata = victim_td->td.td_deque[target];
2815c3344345SAndrey Churbanov       if (__kmp_task_is_allowed(gtid, is_constrained, taskdata, current)) {
2816c3344345SAndrey Churbanov         break; // found victim task
2817c3344345SAndrey Churbanov       } else {
2818a756cb24SAndrey Churbanov         taskdata = NULL;
2819a756cb24SAndrey Churbanov       }
2820a756cb24SAndrey Churbanov     }
2821a756cb24SAndrey Churbanov     if (taskdata == NULL) {
2822a756cb24SAndrey Churbanov       // No appropriate candidate to steal found
2823a756cb24SAndrey Churbanov       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2824a756cb24SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #4): T#%d could not steal from "
2825a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2826a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2827a756cb24SAndrey Churbanov                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
2828a756cb24SAndrey Churbanov       return NULL;
2829a756cb24SAndrey Churbanov     }
2830a756cb24SAndrey Churbanov     int prev = target;
2831a756cb24SAndrey Churbanov     for (i = i + 1; i < ntasks; ++i) {
2832a756cb24SAndrey Churbanov       // shift remaining tasks in the deque left by 1
2833a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2834a756cb24SAndrey Churbanov       victim_td->td.td_deque[prev] = victim_td->td.td_deque[target];
2835a756cb24SAndrey Churbanov       prev = target;
2836a756cb24SAndrey Churbanov     }
2837baad3f60SJonathan Peyton     KMP_DEBUG_ASSERT(
2838baad3f60SJonathan Peyton         victim_td->td.td_deque_tail ==
2839baad3f60SJonathan Peyton         (kmp_uint32)((target + 1) & TASK_DEQUE_MASK(victim_td->td)));
2840a756cb24SAndrey Churbanov     victim_td->td.td_deque_tail = target; // tail -= 1 (wrapped))
2841a756cb24SAndrey Churbanov   }
28427cc577a4SJonathan Peyton   if (*thread_finished) {
28433041982dSJonathan Peyton     // We need to un-mark this victim as a finished victim.  This must be done
28443041982dSJonathan Peyton     // before releasing the lock, or else other threads (starting with the
284597d000cfStlwilmar     // primary thread victim) might be prematurely released from the barrier!!!
28468b81524cSAndreyChurbanov #if KMP_DEBUG
28478b81524cSAndreyChurbanov     kmp_int32 count =
28488b81524cSAndreyChurbanov #endif
28498b81524cSAndreyChurbanov         KMP_ATOMIC_INC(unfinished_threads);
28503041982dSJonathan Peyton     KA_TRACE(
28513041982dSJonathan Peyton         20,
28523041982dSJonathan Peyton         ("__kmp_steal_task: T#%d inc unfinished_threads to %d: task_team=%p\n",
28537cc577a4SJonathan Peyton          gtid, count + 1, task_team));
28547cc577a4SJonathan Peyton     *thread_finished = FALSE;
28557cc577a4SJonathan Peyton   }
2856a756cb24SAndrey Churbanov   TCW_4(victim_td->td.td_deque_ntasks, ntasks - 1);
28573041982dSJonathan Peyton 
28587cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
28597cc577a4SJonathan Peyton 
28607cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(TASK_stolen);
2861a756cb24SAndrey Churbanov   KA_TRACE(10,
2862a756cb24SAndrey Churbanov            ("__kmp_steal_task(exit #5): T#%d stole task %p from T#%d: "
2863a756cb24SAndrey Churbanov             "task_team=%p ntasks=%d head=%u tail=%u\n",
2864a756cb24SAndrey Churbanov             gtid, taskdata, __kmp_gtid_from_thread(victim_thr), task_team,
2865a756cb24SAndrey Churbanov             ntasks, victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
28667cc577a4SJonathan Peyton 
28677cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
28687cc577a4SJonathan Peyton   return task;
28697cc577a4SJonathan Peyton }
28707cc577a4SJonathan Peyton 
28713041982dSJonathan Peyton // __kmp_execute_tasks_template: Choose and execute tasks until either the
28723041982dSJonathan Peyton // condition is statisfied (return true) or there are none left (return false).
28733041982dSJonathan Peyton //
28747cc577a4SJonathan Peyton // final_spin is TRUE if this is the spin at the release barrier.
28757cc577a4SJonathan Peyton // thread_finished indicates whether the thread is finished executing all
28767cc577a4SJonathan Peyton // the tasks it has on its deque, and is at the release barrier.
28777cc577a4SJonathan Peyton // spinner is the location on which to spin.
28787cc577a4SJonathan Peyton // spinner == NULL means only execute a single task and return.
28797cc577a4SJonathan Peyton // checker is the value to check to terminate the spin.
28807cc577a4SJonathan Peyton template <class C>
28813041982dSJonathan Peyton static inline int __kmp_execute_tasks_template(
28823041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, C *flag, int final_spin,
28833041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
28843041982dSJonathan Peyton     kmp_int32 is_constrained) {
28857cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
28867cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
28877cc577a4SJonathan Peyton   kmp_task_t *task;
28887cc577a4SJonathan Peyton   kmp_info_t *other_thread;
28897cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
289037e2ef54SJonathan Peyton   std::atomic<kmp_int32> *unfinished_threads;
2891a756cb24SAndrey Churbanov   kmp_int32 nthreads, victim_tid = -2, use_own_tasks = 1, new_victim = 0,
28923041982dSJonathan Peyton                       tid = thread->th.th_info.ds.ds_tid;
28937cc577a4SJonathan Peyton 
28947cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
28957cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread == __kmp_threads[gtid]);
28967cc577a4SJonathan Peyton 
2897a4a9c48cSJonathan Peyton   if (task_team == NULL || current_task == NULL)
28983041982dSJonathan Peyton     return FALSE;
28997cc577a4SJonathan Peyton 
29003041982dSJonathan Peyton   KA_TRACE(15, ("__kmp_execute_tasks_template(enter): T#%d final_spin=%d "
29013041982dSJonathan Peyton                 "*thread_finished=%d\n",
29027cc577a4SJonathan Peyton                 gtid, final_spin, *thread_finished));
29037cc577a4SJonathan Peyton 
2904581490e7SAndrey Churbanov   thread->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
29057cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
29069d64275aSShilei Tian 
29077cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
29087cc577a4SJonathan Peyton 
29097cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
29107cc577a4SJonathan Peyton   unfinished_threads = &(task_team->tt.tt_unfinished_threads);
29119d64275aSShilei Tian   KMP_DEBUG_ASSERT(nthreads > 1 || task_team->tt.tt_found_proxy_tasks ||
29129d64275aSShilei Tian                    task_team->tt.tt_hidden_helper_task_encountered);
291337e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(*unfinished_threads >= 0);
29147cc577a4SJonathan Peyton 
29153041982dSJonathan Peyton   while (1) { // Outer loop keeps trying to find tasks in case of single thread
29163041982dSJonathan Peyton     // getting tasks from target constructs
29177cc577a4SJonathan Peyton     while (1) { // Inner loop to find a task and execute it
29187cc577a4SJonathan Peyton       task = NULL;
29197cc577a4SJonathan Peyton       if (use_own_tasks) { // check on own queue first
29207cc577a4SJonathan Peyton         task = __kmp_remove_my_task(thread, gtid, task_team, is_constrained);
29217cc577a4SJonathan Peyton       }
29227cc577a4SJonathan Peyton       if ((task == NULL) && (nthreads > 1)) { // Steal a task
29237cc577a4SJonathan Peyton         int asleep = 1;
29247cc577a4SJonathan Peyton         use_own_tasks = 0;
29257cc577a4SJonathan Peyton         // Try to steal from the last place I stole from successfully.
2926a756cb24SAndrey Churbanov         if (victim_tid == -2) { // haven't stolen anything yet
2927a756cb24SAndrey Churbanov           victim_tid = threads_data[tid].td.td_deque_last_stolen;
2928a756cb24SAndrey Churbanov           if (victim_tid !=
29293041982dSJonathan Peyton               -1) // if we have a last stolen from victim, get the thread
2930a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29317cc577a4SJonathan Peyton         }
2932a756cb24SAndrey Churbanov         if (victim_tid != -1) { // found last victim
29337cc577a4SJonathan Peyton           asleep = 0;
29343041982dSJonathan Peyton         } else if (!new_victim) { // no recent steals and we haven't already
29353041982dSJonathan Peyton           // used a new victim; select a random thread
29367cc577a4SJonathan Peyton           do { // Find a different thread to steal work from.
29373041982dSJonathan Peyton             // Pick a random thread. Initial plan was to cycle through all the
29383041982dSJonathan Peyton             // threads, and only return if we tried to steal from every thread,
29393041982dSJonathan Peyton             // and failed.  Arch says that's not such a great idea.
2940a756cb24SAndrey Churbanov             victim_tid = __kmp_get_random(thread) % (nthreads - 1);
2941a756cb24SAndrey Churbanov             if (victim_tid >= tid) {
2942a756cb24SAndrey Churbanov               ++victim_tid; // Adjusts random distribution to exclude self
29437cc577a4SJonathan Peyton             }
29447cc577a4SJonathan Peyton             // Found a potential victim
2945a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
29463041982dSJonathan Peyton             // There is a slight chance that __kmp_enable_tasking() did not wake
29473041982dSJonathan Peyton             // up all threads waiting at the barrier.  If victim is sleeping,
29483041982dSJonathan Peyton             // then wake it up. Since we were going to pay the cache miss
29493041982dSJonathan Peyton             // penalty for referencing another thread's kmp_info_t struct
29503041982dSJonathan Peyton             // anyway,
29513041982dSJonathan Peyton             // the check shouldn't cost too much performance at this point. In
29523041982dSJonathan Peyton             // extra barrier mode, tasks do not sleep at the separate tasking
29533041982dSJonathan Peyton             // barrier, so this isn't a problem.
29547cc577a4SJonathan Peyton             asleep = 0;
29557cc577a4SJonathan Peyton             if ((__kmp_tasking_mode == tskm_task_teams) &&
29567cc577a4SJonathan Peyton                 (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) &&
2957c47afcd9SAndrey Churbanov                 (TCR_PTR(CCAST(void *, other_thread->th.th_sleep_loc)) !=
2958c47afcd9SAndrey Churbanov                  NULL)) {
29597cc577a4SJonathan Peyton               asleep = 1;
2960d8e4cb91STerry Wilmarth               __kmp_null_resume_wrapper(other_thread);
29613041982dSJonathan Peyton               // A sleeping thread should not have any tasks on it's queue.
29623041982dSJonathan Peyton               // There is a slight possibility that it resumes, steals a task
29633041982dSJonathan Peyton               // from another thread, which spawns more tasks, all in the time
29643041982dSJonathan Peyton               // that it takes this thread to check => don't write an assertion
29653041982dSJonathan Peyton               // that the victim's queue is empty.  Try stealing from a
29663041982dSJonathan Peyton               // different thread.
29677cc577a4SJonathan Peyton             }
29687cc577a4SJonathan Peyton           } while (asleep);
29697cc577a4SJonathan Peyton         }
29707cc577a4SJonathan Peyton 
29717cc577a4SJonathan Peyton         if (!asleep) {
29727cc577a4SJonathan Peyton           // We have a victim to try to steal from
29733041982dSJonathan Peyton           task = __kmp_steal_task(other_thread, gtid, task_team,
29743041982dSJonathan Peyton                                   unfinished_threads, thread_finished,
29753041982dSJonathan Peyton                                   is_constrained);
29767cc577a4SJonathan Peyton         }
29777cc577a4SJonathan Peyton         if (task != NULL) { // set last stolen to victim
2978a756cb24SAndrey Churbanov           if (threads_data[tid].td.td_deque_last_stolen != victim_tid) {
2979a756cb24SAndrey Churbanov             threads_data[tid].td.td_deque_last_stolen = victim_tid;
29803041982dSJonathan Peyton             // The pre-refactored code did not try more than 1 successful new
29813041982dSJonathan Peyton             // vicitm, unless the last one generated more local tasks;
29823041982dSJonathan Peyton             // new_victim keeps track of this
29837cc577a4SJonathan Peyton             new_victim = 1;
29847cc577a4SJonathan Peyton           }
29853041982dSJonathan Peyton         } else { // No tasks found; unset last_stolen
29867cc577a4SJonathan Peyton           KMP_CHECK_UPDATE(threads_data[tid].td.td_deque_last_stolen, -1);
2987a756cb24SAndrey Churbanov           victim_tid = -2; // no successful victim found
29887cc577a4SJonathan Peyton         }
29897cc577a4SJonathan Peyton       }
29907cc577a4SJonathan Peyton 
29919d64275aSShilei Tian       if (task == NULL)
29929d64275aSShilei Tian         break; // break out of tasking loop
29937cc577a4SJonathan Peyton 
29947cc577a4SJonathan Peyton // Found a task; execute it
29957cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
29967cc577a4SJonathan Peyton       if (__itt_sync_create_ptr || KMP_ITT_DEBUG) {
29973041982dSJonathan Peyton         if (itt_sync_obj == NULL) { // we are at fork barrier where we could not
29983041982dSJonathan Peyton           // get the object reliably
29997cc577a4SJonathan Peyton           itt_sync_obj = __kmp_itt_barrier_object(gtid, bs_forkjoin_barrier);
30007cc577a4SJonathan Peyton         }
30017cc577a4SJonathan Peyton         __kmp_itt_task_starting(itt_sync_obj);
30027cc577a4SJonathan Peyton       }
30037cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY */
30047cc577a4SJonathan Peyton       __kmp_invoke_task(gtid, task, current_task);
30057cc577a4SJonathan Peyton #if USE_ITT_BUILD
30063041982dSJonathan Peyton       if (itt_sync_obj != NULL)
30073041982dSJonathan Peyton         __kmp_itt_task_finished(itt_sync_obj);
30087cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
30093041982dSJonathan Peyton       // If this thread is only partway through the barrier and the condition is
30103041982dSJonathan Peyton       // met, then return now, so that the barrier gather/release pattern can
30113041982dSJonathan Peyton       // proceed. If this thread is in the last spin loop in the barrier,
30123041982dSJonathan Peyton       // waiting to be released, we know that the termination condition will not
301342016791SKazuaki Ishizaki       // be satisfied, so don't waste any cycles checking it.
30147cc577a4SJonathan Peyton       if (flag == NULL || (!final_spin && flag->done_check())) {
30153041982dSJonathan Peyton         KA_TRACE(
30163041982dSJonathan Peyton             15,
30173041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30183041982dSJonathan Peyton              gtid));
30197cc577a4SJonathan Peyton         return TRUE;
30207cc577a4SJonathan Peyton       }
30217cc577a4SJonathan Peyton       if (thread->th.th_task_team == NULL) {
30227cc577a4SJonathan Peyton         break;
30237cc577a4SJonathan Peyton       }
3024e47d32f1SJonathan Peyton       KMP_YIELD(__kmp_library == library_throughput); // Yield before next task
30253041982dSJonathan Peyton       // If execution of a stolen task results in more tasks being placed on our
30263041982dSJonathan Peyton       // run queue, reset use_own_tasks
30277cc577a4SJonathan Peyton       if (!use_own_tasks && TCR_4(threads_data[tid].td.td_deque_ntasks) != 0) {
30283041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d stolen task spawned "
30293041982dSJonathan Peyton                       "other tasks, restart\n",
30303041982dSJonathan Peyton                       gtid));
30317cc577a4SJonathan Peyton         use_own_tasks = 1;
30327cc577a4SJonathan Peyton         new_victim = 0;
30337cc577a4SJonathan Peyton       }
30347cc577a4SJonathan Peyton     }
30357cc577a4SJonathan Peyton 
3036e4b4f994SJonathan Peyton     // The task source has been exhausted. If in final spin loop of barrier,
3037e4b4f994SJonathan Peyton     // check if termination condition is satisfied. The work queue may be empty
3038e4b4f994SJonathan Peyton     // but there might be proxy tasks still executing.
303937e2ef54SJonathan Peyton     if (final_spin &&
3040e4b4f994SJonathan Peyton         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks) == 0) {
30413041982dSJonathan Peyton       // First, decrement the #unfinished threads, if that has not already been
30423041982dSJonathan Peyton       // done.  This decrement might be to the spin location, and result in the
30433041982dSJonathan Peyton       // termination condition being satisfied.
30447cc577a4SJonathan Peyton       if (!*thread_finished) {
30458b81524cSAndreyChurbanov #if KMP_DEBUG
30468b81524cSAndreyChurbanov         kmp_int32 count = -1 +
30478b81524cSAndreyChurbanov #endif
30488b81524cSAndreyChurbanov             KMP_ATOMIC_DEC(unfinished_threads);
30493041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d dec "
30503041982dSJonathan Peyton                       "unfinished_threads to %d task_team=%p\n",
30517cc577a4SJonathan Peyton                       gtid, count, task_team));
30527cc577a4SJonathan Peyton         *thread_finished = TRUE;
30537cc577a4SJonathan Peyton       }
30547cc577a4SJonathan Peyton 
30557cc577a4SJonathan Peyton       // It is now unsafe to reference thread->th.th_team !!!
305697d000cfStlwilmar       // Decrementing task_team->tt.tt_unfinished_threads can allow the primary
30573041982dSJonathan Peyton       // thread to pass through the barrier, where it might reset each thread's
30583041982dSJonathan Peyton       // th.th_team field for the next parallel region. If we can steal more
30593041982dSJonathan Peyton       // work, we know that this has not happened yet.
30607cc577a4SJonathan Peyton       if (flag != NULL && flag->done_check()) {
30613041982dSJonathan Peyton         KA_TRACE(
30623041982dSJonathan Peyton             15,
30633041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
30643041982dSJonathan Peyton              gtid));
30657cc577a4SJonathan Peyton         return TRUE;
30667cc577a4SJonathan Peyton       }
30677cc577a4SJonathan Peyton     }
30687cc577a4SJonathan Peyton 
306997d000cfStlwilmar     // If this thread's task team is NULL, primary thread has recognized that
307097d000cfStlwilmar     // there are no more tasks; bail out
30717cc577a4SJonathan Peyton     if (thread->th.th_task_team == NULL) {
30723041982dSJonathan Peyton       KA_TRACE(15,
30733041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d no more tasks\n", gtid));
30747cc577a4SJonathan Peyton       return FALSE;
30757cc577a4SJonathan Peyton     }
30767cc577a4SJonathan Peyton 
30773041982dSJonathan Peyton     // We could be getting tasks from target constructs; if this is the only
30783041982dSJonathan Peyton     // thread, keep trying to execute tasks from own queue
30799d64275aSShilei Tian     if (nthreads == 1 &&
30809d64275aSShilei Tian         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks))
30817cc577a4SJonathan Peyton       use_own_tasks = 1;
3082e4b4f994SJonathan Peyton     else {
30833041982dSJonathan Peyton       KA_TRACE(15,
30843041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d can't find work\n", gtid));
30857cc577a4SJonathan Peyton       return FALSE;
30867cc577a4SJonathan Peyton     }
30877cc577a4SJonathan Peyton   }
30887cc577a4SJonathan Peyton }
30897cc577a4SJonathan Peyton 
3090e0665a90STerry Wilmarth template <bool C, bool S>
30913041982dSJonathan Peyton int __kmp_execute_tasks_32(
3092e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32<C, S> *flag, int final_spin,
30933041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
30943041982dSJonathan Peyton     kmp_int32 is_constrained) {
30953041982dSJonathan Peyton   return __kmp_execute_tasks_template(
30963041982dSJonathan Peyton       thread, gtid, flag, final_spin,
30973041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
30987cc577a4SJonathan Peyton }
30997cc577a4SJonathan Peyton 
3100e0665a90STerry Wilmarth template <bool C, bool S>
31013041982dSJonathan Peyton int __kmp_execute_tasks_64(
3102e0665a90STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64<C, S> *flag, int final_spin,
31033041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31043041982dSJonathan Peyton     kmp_int32 is_constrained) {
31053041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31063041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31073041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31087cc577a4SJonathan Peyton }
31097cc577a4SJonathan Peyton 
3110d8e4cb91STerry Wilmarth template <bool C, bool S>
3111d8e4cb91STerry Wilmarth int __kmp_atomic_execute_tasks_64(
3112d8e4cb91STerry Wilmarth     kmp_info_t *thread, kmp_int32 gtid, kmp_atomic_flag_64<C, S> *flag,
3113d8e4cb91STerry Wilmarth     int final_spin, int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
3114d8e4cb91STerry Wilmarth     kmp_int32 is_constrained) {
3115d8e4cb91STerry Wilmarth   return __kmp_execute_tasks_template(
3116d8e4cb91STerry Wilmarth       thread, gtid, flag, final_spin,
3117d8e4cb91STerry Wilmarth       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
3118d8e4cb91STerry Wilmarth }
3119d8e4cb91STerry Wilmarth 
31203041982dSJonathan Peyton int __kmp_execute_tasks_oncore(
31213041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
31223041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
31233041982dSJonathan Peyton     kmp_int32 is_constrained) {
31243041982dSJonathan Peyton   return __kmp_execute_tasks_template(
31253041982dSJonathan Peyton       thread, gtid, flag, final_spin,
31263041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
31277cc577a4SJonathan Peyton }
31287cc577a4SJonathan Peyton 
3129e0665a90STerry Wilmarth template int
3130e0665a90STerry Wilmarth __kmp_execute_tasks_32<false, false>(kmp_info_t *, kmp_int32,
3131e0665a90STerry Wilmarth                                      kmp_flag_32<false, false> *, int,
3132e0665a90STerry Wilmarth                                      int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3133e0665a90STerry Wilmarth 
3134e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<false, true>(kmp_info_t *, kmp_int32,
3135e0665a90STerry Wilmarth                                                  kmp_flag_64<false, true> *,
3136e0665a90STerry Wilmarth                                                  int,
3137e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3138e0665a90STerry Wilmarth                                                  kmp_int32);
3139e0665a90STerry Wilmarth 
3140e0665a90STerry Wilmarth template int __kmp_execute_tasks_64<true, false>(kmp_info_t *, kmp_int32,
3141e0665a90STerry Wilmarth                                                  kmp_flag_64<true, false> *,
3142e0665a90STerry Wilmarth                                                  int,
3143e0665a90STerry Wilmarth                                                  int *USE_ITT_BUILD_ARG(void *),
3144e0665a90STerry Wilmarth                                                  kmp_int32);
3145e0665a90STerry Wilmarth 
3146d8e4cb91STerry Wilmarth template int __kmp_atomic_execute_tasks_64<false, true>(
3147d8e4cb91STerry Wilmarth     kmp_info_t *, kmp_int32, kmp_atomic_flag_64<false, true> *, int,
3148d8e4cb91STerry Wilmarth     int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3149d8e4cb91STerry Wilmarth 
3150d8e4cb91STerry Wilmarth template int __kmp_atomic_execute_tasks_64<true, false>(
3151d8e4cb91STerry Wilmarth     kmp_info_t *, kmp_int32, kmp_atomic_flag_64<true, false> *, int,
3152d8e4cb91STerry Wilmarth     int *USE_ITT_BUILD_ARG(void *), kmp_int32);
3153d8e4cb91STerry Wilmarth 
31547cc577a4SJonathan Peyton // __kmp_enable_tasking: Allocate task team and resume threads sleeping at the
31557cc577a4SJonathan Peyton // next barrier so they can assist in executing enqueued tasks.
31567cc577a4SJonathan Peyton // First thread in allocates the task team atomically.
31573041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
31583041982dSJonathan Peyton                                  kmp_info_t *this_thr) {
31597cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
31607cc577a4SJonathan Peyton   int nthreads, i, is_init_thread;
31617cc577a4SJonathan Peyton 
31627cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(enter): T#%d\n",
31637cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
31647cc577a4SJonathan Peyton 
31657cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
31667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr->th.th_team != NULL);
31677cc577a4SJonathan Peyton 
31687cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
31697cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 0);
31707cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads == this_thr->th.th_team->t.t_nproc);
31717cc577a4SJonathan Peyton 
31727cc577a4SJonathan Peyton   // Allocate or increase the size of threads_data if necessary
31737cc577a4SJonathan Peyton   is_init_thread = __kmp_realloc_task_threads_data(this_thr, task_team);
31747cc577a4SJonathan Peyton 
31757cc577a4SJonathan Peyton   if (!is_init_thread) {
31767cc577a4SJonathan Peyton     // Some other thread already set up the array.
31773041982dSJonathan Peyton     KA_TRACE(
31783041982dSJonathan Peyton         20,
31793041982dSJonathan Peyton         ("__kmp_enable_tasking(exit): T#%d: threads array already set up.\n",
31807cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr)));
31817cc577a4SJonathan Peyton     return;
31827cc577a4SJonathan Peyton   }
31837cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
31847cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
31857cc577a4SJonathan Peyton 
31869b8bb323SJonathan Peyton   if (__kmp_tasking_mode == tskm_task_teams &&
31873041982dSJonathan Peyton       (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME)) {
31887cc577a4SJonathan Peyton     // Release any threads sleeping at the barrier, so that they can steal
31897cc577a4SJonathan Peyton     // tasks and execute them.  In extra barrier mode, tasks do not sleep
31907cc577a4SJonathan Peyton     // at the separate tasking barrier, so this isn't a problem.
31917cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
3192d8e4cb91STerry Wilmarth       void *sleep_loc;
31937cc577a4SJonathan Peyton       kmp_info_t *thread = threads_data[i].td.td_thr;
31947cc577a4SJonathan Peyton 
31957cc577a4SJonathan Peyton       if (i == this_thr->th.th_info.ds.ds_tid) {
31967cc577a4SJonathan Peyton         continue;
31977cc577a4SJonathan Peyton       }
31987cc577a4SJonathan Peyton       // Since we haven't locked the thread's suspend mutex lock at this
31997cc577a4SJonathan Peyton       // point, there is a small window where a thread might be putting
32007cc577a4SJonathan Peyton       // itself to sleep, but hasn't set the th_sleep_loc field yet.
32017cc577a4SJonathan Peyton       // To work around this, __kmp_execute_tasks_template() periodically checks
32023041982dSJonathan Peyton       // see if other threads are sleeping (using the same random mechanism that
32033041982dSJonathan Peyton       // is used for task stealing) and awakens them if they are.
3204c47afcd9SAndrey Churbanov       if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3205c47afcd9SAndrey Churbanov           NULL) {
32067cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d waking up thread T#%d\n",
32077cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
32087cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
3209d8e4cb91STerry Wilmarth         __kmp_null_resume_wrapper(thread);
32103041982dSJonathan Peyton       } else {
32117cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d don't wake up thread T#%d\n",
32127cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
32137cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
32147cc577a4SJonathan Peyton       }
32157cc577a4SJonathan Peyton     }
32167cc577a4SJonathan Peyton   }
32177cc577a4SJonathan Peyton 
32187cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(exit): T#%d\n",
32197cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
32207cc577a4SJonathan Peyton }
32217cc577a4SJonathan Peyton 
32227cc577a4SJonathan Peyton /* // TODO: Check the comment consistency
32237cc577a4SJonathan Peyton  * Utility routines for "task teams".  A task team (kmp_task_t) is kind of
32247cc577a4SJonathan Peyton  * like a shadow of the kmp_team_t data struct, with a different lifetime.
32257cc577a4SJonathan Peyton  * After a child * thread checks into a barrier and calls __kmp_release() from
32267cc577a4SJonathan Peyton  * the particular variant of __kmp_<barrier_kind>_barrier_gather(), it can no
32277cc577a4SJonathan Peyton  * longer assume that the kmp_team_t structure is intact (at any moment, the
322897d000cfStlwilmar  * primary thread may exit the barrier code and free the team data structure,
32297cc577a4SJonathan Peyton  * and return the threads to the thread pool).
32307cc577a4SJonathan Peyton  *
3231ed5fe645SKelvin Li  * This does not work with the tasking code, as the thread is still
32327cc577a4SJonathan Peyton  * expected to participate in the execution of any tasks that may have been
32337cc577a4SJonathan Peyton  * spawned my a member of the team, and the thread still needs access to all
32347cc577a4SJonathan Peyton  * to each thread in the team, so that it can steal work from it.
32357cc577a4SJonathan Peyton  *
32367cc577a4SJonathan Peyton  * Enter the existence of the kmp_task_team_t struct.  It employs a reference
323797d000cfStlwilmar  * counting mechanism, and is allocated by the primary thread before calling
32387cc577a4SJonathan Peyton  * __kmp_<barrier_kind>_release, and then is release by the last thread to
32397cc577a4SJonathan Peyton  * exit __kmp_<barrier_kind>_release at the next barrier.  I.e. the lifetimes
32407cc577a4SJonathan Peyton  * of the kmp_task_team_t structs for consecutive barriers can overlap
324197d000cfStlwilmar  * (and will, unless the primary thread is the last thread to exit the barrier
3242e4b4f994SJonathan Peyton  * release phase, which is not typical). The existence of such a struct is
3243e4b4f994SJonathan Peyton  * useful outside the context of tasking.
32447cc577a4SJonathan Peyton  *
32457cc577a4SJonathan Peyton  * We currently use the existence of the threads array as an indicator that
32467cc577a4SJonathan Peyton  * tasks were spawned since the last barrier.  If the structure is to be
32477cc577a4SJonathan Peyton  * useful outside the context of tasking, then this will have to change, but
324842016791SKazuaki Ishizaki  * not setting the field minimizes the performance impact of tasking on
32497cc577a4SJonathan Peyton  * barriers, when no explicit tasks were spawned (pushed, actually).
32507cc577a4SJonathan Peyton  */
32517cc577a4SJonathan Peyton 
32523041982dSJonathan Peyton static kmp_task_team_t *__kmp_free_task_teams =
32533041982dSJonathan Peyton     NULL; // Free list for task_team data structures
32547cc577a4SJonathan Peyton // Lock for task team data structures
3255eaa9e40cSJonathan Peyton kmp_bootstrap_lock_t __kmp_task_team_lock =
32563041982dSJonathan Peyton     KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_task_team_lock);
32577cc577a4SJonathan Peyton 
32587cc577a4SJonathan Peyton // __kmp_alloc_task_deque:
32597cc577a4SJonathan Peyton // Allocates a task deque for a particular thread, and initialize the necessary
32607cc577a4SJonathan Peyton // data structures relating to the deque.  This only happens once per thread
32613041982dSJonathan Peyton // per task team since task teams are recycled. No lock is needed during
32623041982dSJonathan Peyton // allocation since each thread allocates its own deque.
32633041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
32643041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data) {
32657cc577a4SJonathan Peyton   __kmp_init_bootstrap_lock(&thread_data->td.td_deque_lock);
32667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque == NULL);
32677cc577a4SJonathan Peyton 
32687cc577a4SJonathan Peyton   // Initialize last stolen task field to "none"
32697cc577a4SJonathan Peyton   thread_data->td.td_deque_last_stolen = -1;
32707cc577a4SJonathan Peyton 
32717cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == 0);
32727cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_head == 0);
32737cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_tail == 0);
32747cc577a4SJonathan Peyton 
32753041982dSJonathan Peyton   KE_TRACE(
32763041982dSJonathan Peyton       10,
32773041982dSJonathan Peyton       ("__kmp_alloc_task_deque: T#%d allocating deque[%d] for thread_data %p\n",
32787cc577a4SJonathan Peyton        __kmp_gtid_from_thread(thread), INITIAL_TASK_DEQUE_SIZE, thread_data));
32797cc577a4SJonathan Peyton   // Allocate space for task deque, and zero the deque
32807cc577a4SJonathan Peyton   // Cannot use __kmp_thread_calloc() because threads not around for
32817cc577a4SJonathan Peyton   // kmp_reap_task_team( ).
32823041982dSJonathan Peyton   thread_data->td.td_deque = (kmp_taskdata_t **)__kmp_allocate(
32833041982dSJonathan Peyton       INITIAL_TASK_DEQUE_SIZE * sizeof(kmp_taskdata_t *));
32847cc577a4SJonathan Peyton   thread_data->td.td_deque_size = INITIAL_TASK_DEQUE_SIZE;
32857cc577a4SJonathan Peyton }
32867cc577a4SJonathan Peyton 
32877cc577a4SJonathan Peyton // __kmp_free_task_deque:
32883041982dSJonathan Peyton // Deallocates a task deque for a particular thread. Happens at library
32893041982dSJonathan Peyton // deallocation so don't need to reset all thread data fields.
32903041982dSJonathan Peyton static void __kmp_free_task_deque(kmp_thread_data_t *thread_data) {
32917cc577a4SJonathan Peyton   if (thread_data->td.td_deque != NULL) {
32921b536724SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
32937cc577a4SJonathan Peyton     TCW_4(thread_data->td.td_deque_ntasks, 0);
32947cc577a4SJonathan Peyton     __kmp_free(thread_data->td.td_deque);
32957cc577a4SJonathan Peyton     thread_data->td.td_deque = NULL;
32967cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
32971b536724SJonathan Peyton   }
32987cc577a4SJonathan Peyton 
32997cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33007cc577a4SJonathan Peyton   // GEH: Figure out what to do here for td_susp_tied_tasks
33017cc577a4SJonathan Peyton   if (thread_data->td.td_susp_tied_tasks.ts_entries != TASK_STACK_EMPTY) {
33027cc577a4SJonathan Peyton     __kmp_free_task_stack(__kmp_thread_from_gtid(gtid), thread_data);
33037cc577a4SJonathan Peyton   }
33047cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33057cc577a4SJonathan Peyton }
33067cc577a4SJonathan Peyton 
33077cc577a4SJonathan Peyton // __kmp_realloc_task_threads_data:
33083041982dSJonathan Peyton // Allocates a threads_data array for a task team, either by allocating an
33093041982dSJonathan Peyton // initial array or enlarging an existing array.  Only the first thread to get
33104c6a098aSKazuaki Ishizaki // the lock allocs or enlarges the array and re-initializes the array elements.
33117cc577a4SJonathan Peyton // That thread returns "TRUE", the rest return "FALSE".
33127cc577a4SJonathan Peyton // Assumes that the new array size is given by task_team -> tt.tt_nproc.
33137cc577a4SJonathan Peyton // The current size is given by task_team -> tt.tt_max_threads.
33143041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
33153041982dSJonathan Peyton                                            kmp_task_team_t *task_team) {
33167cc577a4SJonathan Peyton   kmp_thread_data_t **threads_data_p;
33177cc577a4SJonathan Peyton   kmp_int32 nthreads, maxthreads;
33187cc577a4SJonathan Peyton   int is_init_thread = FALSE;
33197cc577a4SJonathan Peyton 
33207cc577a4SJonathan Peyton   if (TCR_4(task_team->tt.tt_found_tasks)) {
33217cc577a4SJonathan Peyton     // Already reallocated and initialized.
33227cc577a4SJonathan Peyton     return FALSE;
33237cc577a4SJonathan Peyton   }
33247cc577a4SJonathan Peyton 
33257cc577a4SJonathan Peyton   threads_data_p = &task_team->tt.tt_threads_data;
33267cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
33277cc577a4SJonathan Peyton   maxthreads = task_team->tt.tt_max_threads;
33287cc577a4SJonathan Peyton 
33293041982dSJonathan Peyton   // All threads must lock when they encounter the first task of the implicit
33303041982dSJonathan Peyton   // task region to make sure threads_data fields are (re)initialized before
33313041982dSJonathan Peyton   // used.
33327cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
33337cc577a4SJonathan Peyton 
33347cc577a4SJonathan Peyton   if (!TCR_4(task_team->tt.tt_found_tasks)) {
33357cc577a4SJonathan Peyton     // first thread to enable tasking
33367cc577a4SJonathan Peyton     kmp_team_t *team = thread->th.th_team;
33377cc577a4SJonathan Peyton     int i;
33387cc577a4SJonathan Peyton 
33397cc577a4SJonathan Peyton     is_init_thread = TRUE;
33407cc577a4SJonathan Peyton     if (maxthreads < nthreads) {
33417cc577a4SJonathan Peyton 
33427cc577a4SJonathan Peyton       if (*threads_data_p != NULL) {
33437cc577a4SJonathan Peyton         kmp_thread_data_t *old_data = *threads_data_p;
33447cc577a4SJonathan Peyton         kmp_thread_data_t *new_data = NULL;
33457cc577a4SJonathan Peyton 
33463041982dSJonathan Peyton         KE_TRACE(
33473041982dSJonathan Peyton             10,
33483041982dSJonathan Peyton             ("__kmp_realloc_task_threads_data: T#%d reallocating "
33497cc577a4SJonathan Peyton              "threads data for task_team %p, new_size = %d, old_size = %d\n",
33503041982dSJonathan Peyton              __kmp_gtid_from_thread(thread), task_team, nthreads, maxthreads));
33517cc577a4SJonathan Peyton         // Reallocate threads_data to have more elements than current array
33527cc577a4SJonathan Peyton         // Cannot use __kmp_thread_realloc() because threads not around for
33537cc577a4SJonathan Peyton         // kmp_reap_task_team( ).  Note all new array entries are initialized
33547cc577a4SJonathan Peyton         // to zero by __kmp_allocate().
33553041982dSJonathan Peyton         new_data = (kmp_thread_data_t *)__kmp_allocate(
33563041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33577cc577a4SJonathan Peyton         // copy old data to new data
33587cc577a4SJonathan Peyton         KMP_MEMCPY_S((void *)new_data, nthreads * sizeof(kmp_thread_data_t),
335971483f2dSAndrey Churbanov                      (void *)old_data, maxthreads * sizeof(kmp_thread_data_t));
33607cc577a4SJonathan Peyton 
33617cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33627cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33637cc577a4SJonathan Peyton         for (i = maxthreads; i < nthreads; i++) {
33647cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33657cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33667cc577a4SJonathan Peyton         }
33677cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33687cc577a4SJonathan Peyton        // Install the new data and free the old data
33697cc577a4SJonathan Peyton         (*threads_data_p) = new_data;
33707cc577a4SJonathan Peyton         __kmp_free(old_data);
33713041982dSJonathan Peyton       } else {
33727cc577a4SJonathan Peyton         KE_TRACE(10, ("__kmp_realloc_task_threads_data: T#%d allocating "
33737cc577a4SJonathan Peyton                       "threads data for task_team %p, size = %d\n",
33747cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread), task_team, nthreads));
33757cc577a4SJonathan Peyton         // Make the initial allocate for threads_data array, and zero entries
33767cc577a4SJonathan Peyton         // Cannot use __kmp_thread_calloc() because threads not around for
33777cc577a4SJonathan Peyton         // kmp_reap_task_team( ).
33783041982dSJonathan Peyton         *threads_data_p = (kmp_thread_data_t *)__kmp_allocate(
33793041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
33807cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
33817cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
33827cc577a4SJonathan Peyton         for (i = 0; i < nthreads; i++) {
33837cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33847cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
33857cc577a4SJonathan Peyton         }
33867cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
33877cc577a4SJonathan Peyton       }
33887cc577a4SJonathan Peyton       task_team->tt.tt_max_threads = nthreads;
33893041982dSJonathan Peyton     } else {
33907cc577a4SJonathan Peyton       // If array has (more than) enough elements, go ahead and use it
33917cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(*threads_data_p != NULL);
33927cc577a4SJonathan Peyton     }
33937cc577a4SJonathan Peyton 
33947cc577a4SJonathan Peyton     // initialize threads_data pointers back to thread_info structures
33957cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
33967cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
33977cc577a4SJonathan Peyton       thread_data->td.td_thr = team->t.t_threads[i];
33987cc577a4SJonathan Peyton 
33997cc577a4SJonathan Peyton       if (thread_data->td.td_deque_last_stolen >= nthreads) {
34007cc577a4SJonathan Peyton         // The last stolen field survives across teams / barrier, and the number
34017cc577a4SJonathan Peyton         // of threads may have changed.  It's possible (likely?) that a new
34023041982dSJonathan Peyton         // parallel region will exhibit the same behavior as previous region.
34037cc577a4SJonathan Peyton         thread_data->td.td_deque_last_stolen = -1;
34047cc577a4SJonathan Peyton       }
34057cc577a4SJonathan Peyton     }
34067cc577a4SJonathan Peyton 
34077cc577a4SJonathan Peyton     KMP_MB();
34087cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_tasks, TRUE);
34097cc577a4SJonathan Peyton   }
34107cc577a4SJonathan Peyton 
34117cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
34127cc577a4SJonathan Peyton   return is_init_thread;
34137cc577a4SJonathan Peyton }
34147cc577a4SJonathan Peyton 
34157cc577a4SJonathan Peyton // __kmp_free_task_threads_data:
34167cc577a4SJonathan Peyton // Deallocates a threads_data array for a task team, including any attached
34177cc577a4SJonathan Peyton // tasking deques.  Only occurs at library shutdown.
34183041982dSJonathan Peyton static void __kmp_free_task_threads_data(kmp_task_team_t *task_team) {
34197cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
34207cc577a4SJonathan Peyton   if (task_team->tt.tt_threads_data != NULL) {
34217cc577a4SJonathan Peyton     int i;
34227cc577a4SJonathan Peyton     for (i = 0; i < task_team->tt.tt_max_threads; i++) {
34237cc577a4SJonathan Peyton       __kmp_free_task_deque(&task_team->tt.tt_threads_data[i]);
34247cc577a4SJonathan Peyton     }
34257cc577a4SJonathan Peyton     __kmp_free(task_team->tt.tt_threads_data);
34267cc577a4SJonathan Peyton     task_team->tt.tt_threads_data = NULL;
34277cc577a4SJonathan Peyton   }
34287cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
34297cc577a4SJonathan Peyton }
34307cc577a4SJonathan Peyton 
34317cc577a4SJonathan Peyton // __kmp_allocate_task_team:
34327cc577a4SJonathan Peyton // Allocates a task team associated with a specific team, taking it from
34333041982dSJonathan Peyton // the global task team free list if possible.  Also initializes data
34343041982dSJonathan Peyton // structures.
34353041982dSJonathan Peyton static kmp_task_team_t *__kmp_allocate_task_team(kmp_info_t *thread,
34363041982dSJonathan Peyton                                                  kmp_team_t *team) {
34377cc577a4SJonathan Peyton   kmp_task_team_t *task_team = NULL;
34387cc577a4SJonathan Peyton   int nthreads;
34397cc577a4SJonathan Peyton 
34407cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d entering; team = %p\n",
34417cc577a4SJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), team));
34427cc577a4SJonathan Peyton 
34437cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
34447cc577a4SJonathan Peyton     // Take a task team from the task team pool
34457cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
34467cc577a4SJonathan Peyton     if (__kmp_free_task_teams != NULL) {
34477cc577a4SJonathan Peyton       task_team = __kmp_free_task_teams;
34487cc577a4SJonathan Peyton       TCW_PTR(__kmp_free_task_teams, task_team->tt.tt_next);
34497cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
34507cc577a4SJonathan Peyton     }
34517cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
34527cc577a4SJonathan Peyton   }
34537cc577a4SJonathan Peyton 
34547cc577a4SJonathan Peyton   if (task_team == NULL) {
34557cc577a4SJonathan Peyton     KE_TRACE(10, ("__kmp_allocate_task_team: T#%d allocating "
34567cc577a4SJonathan Peyton                   "task team for team %p\n",
34577cc577a4SJonathan Peyton                   __kmp_gtid_from_thread(thread), team));
3458ffd8f009SAndreyChurbanov     // Allocate a new task team if one is not available. Cannot use
3459ffd8f009SAndreyChurbanov     // __kmp_thread_malloc because threads not around for kmp_reap_task_team.
34607cc577a4SJonathan Peyton     task_team = (kmp_task_team_t *)__kmp_allocate(sizeof(kmp_task_team_t));
34617cc577a4SJonathan Peyton     __kmp_init_bootstrap_lock(&task_team->tt.tt_threads_lock);
3462ffd8f009SAndreyChurbanov #if USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG
3463ffd8f009SAndreyChurbanov     // suppress race conditions detection on synchronization flags in debug mode
3464ffd8f009SAndreyChurbanov     // this helps to analyze library internals eliminating false positives
3465ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(
3466ffd8f009SAndreyChurbanov         __itt_suppress_range, __itt_suppress_threading_errors,
3467ffd8f009SAndreyChurbanov         &task_team->tt.tt_found_tasks, sizeof(task_team->tt.tt_found_tasks));
3468ffd8f009SAndreyChurbanov     __itt_suppress_mark_range(__itt_suppress_range,
3469ffd8f009SAndreyChurbanov                               __itt_suppress_threading_errors,
3470ffd8f009SAndreyChurbanov                               CCAST(kmp_uint32 *, &task_team->tt.tt_active),
3471ffd8f009SAndreyChurbanov                               sizeof(task_team->tt.tt_active));
3472ffd8f009SAndreyChurbanov #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY && KMP_DEBUG */
3473ffd8f009SAndreyChurbanov     // Note: __kmp_allocate zeroes returned memory, othewise we would need:
34743041982dSJonathan Peyton     // task_team->tt.tt_threads_data = NULL;
34757cc577a4SJonathan Peyton     // task_team->tt.tt_max_threads = 0;
34767cc577a4SJonathan Peyton     // task_team->tt.tt_next = NULL;
34777cc577a4SJonathan Peyton   }
34787cc577a4SJonathan Peyton 
34797cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_tasks, FALSE);
34807cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
34817cc577a4SJonathan Peyton   task_team->tt.tt_nproc = nthreads = team->t.t_nproc;
34827cc577a4SJonathan Peyton 
348337e2ef54SJonathan Peyton   KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads, nthreads);
34849d64275aSShilei Tian   TCW_4(task_team->tt.tt_hidden_helper_task_encountered, FALSE);
34857cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_active, TRUE);
34867cc577a4SJonathan Peyton 
34873041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d exiting; task_team = %p "
34883041982dSJonathan Peyton                 "unfinished_threads init'd to %d\n",
34893041982dSJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), task_team,
349037e2ef54SJonathan Peyton                 KMP_ATOMIC_LD_RLX(&task_team->tt.tt_unfinished_threads)));
34917cc577a4SJonathan Peyton   return task_team;
34927cc577a4SJonathan Peyton }
34937cc577a4SJonathan Peyton 
34947cc577a4SJonathan Peyton // __kmp_free_task_team:
34957cc577a4SJonathan Peyton // Frees the task team associated with a specific thread, and adds it
34967cc577a4SJonathan Peyton // to the global task team free list.
34973041982dSJonathan Peyton void __kmp_free_task_team(kmp_info_t *thread, kmp_task_team_t *task_team) {
34987cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_free_task_team: T#%d task_team = %p\n",
34997cc577a4SJonathan Peyton                 thread ? __kmp_gtid_from_thread(thread) : -1, task_team));
35007cc577a4SJonathan Peyton 
35017cc577a4SJonathan Peyton   // Put task team back on free list
35027cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
35037cc577a4SJonathan Peyton 
35047cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_next == NULL);
35057cc577a4SJonathan Peyton   task_team->tt.tt_next = __kmp_free_task_teams;
35067cc577a4SJonathan Peyton   TCW_PTR(__kmp_free_task_teams, task_team);
35077cc577a4SJonathan Peyton 
35087cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
35097cc577a4SJonathan Peyton }
35107cc577a4SJonathan Peyton 
35117cc577a4SJonathan Peyton // __kmp_reap_task_teams:
35127cc577a4SJonathan Peyton // Free all the task teams on the task team free list.
35137cc577a4SJonathan Peyton // Should only be done during library shutdown.
35143041982dSJonathan Peyton // Cannot do anything that needs a thread structure or gtid since they are
35153041982dSJonathan Peyton // already gone.
35163041982dSJonathan Peyton void __kmp_reap_task_teams(void) {
35177cc577a4SJonathan Peyton   kmp_task_team_t *task_team;
35187cc577a4SJonathan Peyton 
35197cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
35207cc577a4SJonathan Peyton     // Free all task_teams on the free list
35217cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
35227cc577a4SJonathan Peyton     while ((task_team = __kmp_free_task_teams) != NULL) {
35237cc577a4SJonathan Peyton       __kmp_free_task_teams = task_team->tt.tt_next;
35247cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
35257cc577a4SJonathan Peyton 
35267cc577a4SJonathan Peyton       // Free threads_data if necessary
35277cc577a4SJonathan Peyton       if (task_team->tt.tt_threads_data != NULL) {
35287cc577a4SJonathan Peyton         __kmp_free_task_threads_data(task_team);
35297cc577a4SJonathan Peyton       }
35307cc577a4SJonathan Peyton       __kmp_free(task_team);
35317cc577a4SJonathan Peyton     }
35327cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
35337cc577a4SJonathan Peyton   }
35347cc577a4SJonathan Peyton }
35357cc577a4SJonathan Peyton 
35367cc577a4SJonathan Peyton // __kmp_wait_to_unref_task_teams:
35377cc577a4SJonathan Peyton // Some threads could still be in the fork barrier release code, possibly
35387cc577a4SJonathan Peyton // trying to steal tasks.  Wait for each thread to unreference its task team.
35393041982dSJonathan Peyton void __kmp_wait_to_unref_task_teams(void) {
35407cc577a4SJonathan Peyton   kmp_info_t *thread;
35417cc577a4SJonathan Peyton   kmp_uint32 spins;
35427cc577a4SJonathan Peyton   int done;
35437cc577a4SJonathan Peyton 
35447cc577a4SJonathan Peyton   KMP_INIT_YIELD(spins);
35457cc577a4SJonathan Peyton 
35467cc577a4SJonathan Peyton   for (;;) {
35477cc577a4SJonathan Peyton     done = TRUE;
35487cc577a4SJonathan Peyton 
35497cc577a4SJonathan Peyton     // TODO: GEH - this may be is wrong because some sync would be necessary
35503041982dSJonathan Peyton     // in case threads are added to the pool during the traversal. Need to
35513041982dSJonathan Peyton     // verify that lock for thread pool is held when calling this routine.
3552c47afcd9SAndrey Churbanov     for (thread = CCAST(kmp_info_t *, __kmp_thread_pool); thread != NULL;
35533041982dSJonathan Peyton          thread = thread->th.th_next_pool) {
35547cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35557cc577a4SJonathan Peyton       DWORD exit_val;
35567cc577a4SJonathan Peyton #endif
35577cc577a4SJonathan Peyton       if (TCR_PTR(thread->th.th_task_team) == NULL) {
35587cc577a4SJonathan Peyton         KA_TRACE(10, ("__kmp_wait_to_unref_task_team: T#%d task_team == NULL\n",
35597cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
35607cc577a4SJonathan Peyton         continue;
35617cc577a4SJonathan Peyton       }
35627cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
35637cc577a4SJonathan Peyton       // TODO: GEH - add this check for Linux* OS / OS X* as well?
35647cc577a4SJonathan Peyton       if (!__kmp_is_thread_alive(thread, &exit_val)) {
35657cc577a4SJonathan Peyton         thread->th.th_task_team = NULL;
35667cc577a4SJonathan Peyton         continue;
35677cc577a4SJonathan Peyton       }
35687cc577a4SJonathan Peyton #endif
35697cc577a4SJonathan Peyton 
35707cc577a4SJonathan Peyton       done = FALSE; // Because th_task_team pointer is not NULL for this thread
35717cc577a4SJonathan Peyton 
35723041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_wait_to_unref_task_team: Waiting for T#%d to "
35733041982dSJonathan Peyton                     "unreference task_team\n",
35747cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(thread)));
35757cc577a4SJonathan Peyton 
35767cc577a4SJonathan Peyton       if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
3577d8e4cb91STerry Wilmarth         void *sleep_loc;
35787cc577a4SJonathan Peyton         // If the thread is sleeping, awaken it.
3579c47afcd9SAndrey Churbanov         if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3580c47afcd9SAndrey Churbanov             NULL) {
35813041982dSJonathan Peyton           KA_TRACE(
35823041982dSJonathan Peyton               10,
35833041982dSJonathan Peyton               ("__kmp_wait_to_unref_task_team: T#%d waking up thread T#%d\n",
35847cc577a4SJonathan Peyton                __kmp_gtid_from_thread(thread), __kmp_gtid_from_thread(thread)));
3585d8e4cb91STerry Wilmarth           __kmp_null_resume_wrapper(thread);
35867cc577a4SJonathan Peyton         }
35877cc577a4SJonathan Peyton       }
35887cc577a4SJonathan Peyton     }
35897cc577a4SJonathan Peyton     if (done) {
35907cc577a4SJonathan Peyton       break;
35917cc577a4SJonathan Peyton     }
35927cc577a4SJonathan Peyton 
3593e47d32f1SJonathan Peyton     // If oversubscribed or have waited a bit, yield.
3594e47d32f1SJonathan Peyton     KMP_YIELD_OVERSUB_ELSE_SPIN(spins);
35957cc577a4SJonathan Peyton   }
35967cc577a4SJonathan Peyton }
35977cc577a4SJonathan Peyton 
35987cc577a4SJonathan Peyton // __kmp_task_team_setup:  Create a task_team for the current team, but use
35997cc577a4SJonathan Peyton // an already created, unused one if it already exists.
36003041982dSJonathan Peyton void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team, int always) {
36017cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36027cc577a4SJonathan Peyton 
36033041982dSJonathan Peyton   // If this task_team hasn't been created yet, allocate it. It will be used in
36043041982dSJonathan Peyton   // the region after the next.
36053041982dSJonathan Peyton   // If it exists, it is the current task team and shouldn't be touched yet as
36063041982dSJonathan Peyton   // it may still be in use.
36073041982dSJonathan Peyton   if (team->t.t_task_team[this_thr->th.th_task_state] == NULL &&
36083041982dSJonathan Peyton       (always || team->t.t_nproc > 1)) {
36093041982dSJonathan Peyton     team->t.t_task_team[this_thr->th.th_task_state] =
36103041982dSJonathan Peyton         __kmp_allocate_task_team(this_thr, team);
361197d000cfStlwilmar     KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created new task_team %p"
36123041982dSJonathan Peyton                   " for team %d at parity=%d\n",
36133041982dSJonathan Peyton                   __kmp_gtid_from_thread(this_thr),
3614467f3924SHansang Bae                   team->t.t_task_team[this_thr->th.th_task_state], team->t.t_id,
36153041982dSJonathan Peyton                   this_thr->th.th_task_state));
36167cc577a4SJonathan Peyton   }
36177cc577a4SJonathan Peyton 
36183041982dSJonathan Peyton   // After threads exit the release, they will call sync, and then point to this
36193041982dSJonathan Peyton   // other task_team; make sure it is allocated and properly initialized. As
36203041982dSJonathan Peyton   // threads spin in the barrier release phase, they will continue to use the
36213041982dSJonathan Peyton   // previous task_team struct(above), until they receive the signal to stop
36223041982dSJonathan Peyton   // checking for tasks (they can't safely reference the kmp_team_t struct,
362397d000cfStlwilmar   // which could be reallocated by the primary thread). No task teams are formed
36243041982dSJonathan Peyton   // for serialized teams.
36257cc577a4SJonathan Peyton   if (team->t.t_nproc > 1) {
36267cc577a4SJonathan Peyton     int other_team = 1 - this_thr->th.th_task_state;
3627467f3924SHansang Bae     KMP_DEBUG_ASSERT(other_team >= 0 && other_team < 2);
36287cc577a4SJonathan Peyton     if (team->t.t_task_team[other_team] == NULL) { // setup other team as well
36293041982dSJonathan Peyton       team->t.t_task_team[other_team] =
36303041982dSJonathan Peyton           __kmp_allocate_task_team(this_thr, team);
363197d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d created second new "
36323041982dSJonathan Peyton                     "task_team %p for team %d at parity=%d\n",
36333041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3634467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36353041982dSJonathan Peyton     } else { // Leave the old task team struct in place for the upcoming region;
36363041982dSJonathan Peyton       // adjust as needed
36377cc577a4SJonathan Peyton       kmp_task_team_t *task_team = team->t.t_task_team[other_team];
36383041982dSJonathan Peyton       if (!task_team->tt.tt_active ||
36393041982dSJonathan Peyton           team->t.t_nproc != task_team->tt.tt_nproc) {
36407cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_nproc, team->t.t_nproc);
36417cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_tasks, FALSE);
36427cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
364337e2ef54SJonathan Peyton         KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads,
364437e2ef54SJonathan Peyton                           team->t.t_nproc);
36457cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_active, TRUE);
36467cc577a4SJonathan Peyton       }
36473041982dSJonathan Peyton       // if team size has changed, the first thread to enable tasking will
36483041982dSJonathan Peyton       // realloc threads_data if necessary
364997d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_setup: Primary T#%d reset next task_team "
36503041982dSJonathan Peyton                     "%p for team %d at parity=%d\n",
36513041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
3652467f3924SHansang Bae                     team->t.t_task_team[other_team], team->t.t_id, other_team));
36537cc577a4SJonathan Peyton     }
36547cc577a4SJonathan Peyton   }
36559d64275aSShilei Tian 
36569d64275aSShilei Tian   // For regular thread, task enabling should be called when the task is going
36579d64275aSShilei Tian   // to be pushed to a dequeue. However, for the hidden helper thread, we need
36589d64275aSShilei Tian   // it ahead of time so that some operations can be performed without race
36599d64275aSShilei Tian   // condition.
36609d64275aSShilei Tian   if (this_thr == __kmp_hidden_helper_main_thread) {
36619d64275aSShilei Tian     for (int i = 0; i < 2; ++i) {
36629d64275aSShilei Tian       kmp_task_team_t *task_team = team->t.t_task_team[i];
36639d64275aSShilei Tian       if (KMP_TASKING_ENABLED(task_team)) {
36649d64275aSShilei Tian         continue;
36659d64275aSShilei Tian       }
36669d64275aSShilei Tian       __kmp_enable_tasking(task_team, this_thr);
36679d64275aSShilei Tian       for (int j = 0; j < task_team->tt.tt_nproc; ++j) {
36689d64275aSShilei Tian         kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[j];
36699d64275aSShilei Tian         if (thread_data->td.td_deque == NULL) {
36709d64275aSShilei Tian           __kmp_alloc_task_deque(__kmp_hidden_helper_threads[j], thread_data);
36719d64275aSShilei Tian         }
36729d64275aSShilei Tian       }
36739d64275aSShilei Tian     }
36749d64275aSShilei Tian   }
36757cc577a4SJonathan Peyton }
36767cc577a4SJonathan Peyton 
36777cc577a4SJonathan Peyton // __kmp_task_team_sync: Propagation of task team data from team to threads
36787cc577a4SJonathan Peyton // which happens just after the release phase of a team barrier.  This may be
36797cc577a4SJonathan Peyton // called by any thread, but only for teams with # threads > 1.
36803041982dSJonathan Peyton void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team) {
36817cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
36827cc577a4SJonathan Peyton 
36833041982dSJonathan Peyton   // Toggle the th_task_state field, to switch which task_team this thread
36843041982dSJonathan Peyton   // refers to
36856b316febSTerry Wilmarth   this_thr->th.th_task_state = (kmp_uint8)(1 - this_thr->th.th_task_state);
36866b316febSTerry Wilmarth 
36873041982dSJonathan Peyton   // It is now safe to propagate the task team pointer from the team struct to
36883041982dSJonathan Peyton   // the current thread.
36893041982dSJonathan Peyton   TCW_PTR(this_thr->th.th_task_team,
36903041982dSJonathan Peyton           team->t.t_task_team[this_thr->th.th_task_state]);
36913041982dSJonathan Peyton   KA_TRACE(20,
36923041982dSJonathan Peyton            ("__kmp_task_team_sync: Thread T#%d task team switched to task_team "
36933041982dSJonathan Peyton             "%p from Team #%d (parity=%d)\n",
36947cc577a4SJonathan Peyton             __kmp_gtid_from_thread(this_thr), this_thr->th.th_task_team,
3695467f3924SHansang Bae             team->t.t_id, this_thr->th.th_task_state));
36967cc577a4SJonathan Peyton }
36977cc577a4SJonathan Peyton 
369897d000cfStlwilmar // __kmp_task_team_wait: Primary thread waits for outstanding tasks after the
369997d000cfStlwilmar // barrier gather phase. Only called by primary thread if #threads in team > 1
370097d000cfStlwilmar // or if proxy tasks were created.
37013041982dSJonathan Peyton //
37023041982dSJonathan Peyton // wait is a flag that defaults to 1 (see kmp.h), but waiting can be turned off
370397d000cfStlwilmar // by passing in 0 optionally as the last argument. When wait is zero, primary
37043041982dSJonathan Peyton // thread does not wait for unfinished_threads to reach 0.
37053041982dSJonathan Peyton void __kmp_task_team_wait(
37063041982dSJonathan Peyton     kmp_info_t *this_thr,
37073041982dSJonathan Peyton     kmp_team_t *team USE_ITT_BUILD_ARG(void *itt_sync_obj), int wait) {
37087cc577a4SJonathan Peyton   kmp_task_team_t *task_team = team->t.t_task_team[this_thr->th.th_task_state];
37097cc577a4SJonathan Peyton 
37107cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
37117cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team == this_thr->th.th_task_team);
37127cc577a4SJonathan Peyton 
37137cc577a4SJonathan Peyton   if ((task_team != NULL) && KMP_TASKING_ENABLED(task_team)) {
37147cc577a4SJonathan Peyton     if (wait) {
371597d000cfStlwilmar       KA_TRACE(20, ("__kmp_task_team_wait: Primary T#%d waiting for all tasks "
37163041982dSJonathan Peyton                     "(for unfinished_threads to reach 0) on task_team = %p\n",
37177cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(this_thr), task_team));
37183041982dSJonathan Peyton       // Worker threads may have dropped through to release phase, but could
37193041982dSJonathan Peyton       // still be executing tasks. Wait here for tasks to complete. To avoid
372097d000cfStlwilmar       // memory contention, only primary thread checks termination condition.
3721e0665a90STerry Wilmarth       kmp_flag_32<false, false> flag(
3722e0665a90STerry Wilmarth           RCAST(std::atomic<kmp_uint32> *,
372337e2ef54SJonathan Peyton                 &task_team->tt.tt_unfinished_threads),
3724c47afcd9SAndrey Churbanov           0U);
37253041982dSJonathan Peyton       flag.wait(this_thr, TRUE USE_ITT_BUILD_ARG(itt_sync_obj));
37267cc577a4SJonathan Peyton     }
37273041982dSJonathan Peyton     // Deactivate the old task team, so that the worker threads will stop
37283041982dSJonathan Peyton     // referencing it while spinning.
37293041982dSJonathan Peyton     KA_TRACE(
37303041982dSJonathan Peyton         20,
373197d000cfStlwilmar         ("__kmp_task_team_wait: Primary T#%d deactivating task_team %p: "
37327cc577a4SJonathan Peyton          "setting active to false, setting local and team's pointer to NULL\n",
37337cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr), task_team));
37343041982dSJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1 ||
37353041982dSJonathan Peyton                      task_team->tt.tt_found_proxy_tasks == TRUE);
37367cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_proxy_tasks, FALSE);
3737a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(task_team->tt.tt_untied_task_encountered, 0);
37387cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_active, FALSE);
37397cc577a4SJonathan Peyton     KMP_MB();
37407cc577a4SJonathan Peyton 
37417cc577a4SJonathan Peyton     TCW_PTR(this_thr->th.th_task_team, NULL);
37427cc577a4SJonathan Peyton   }
37437cc577a4SJonathan Peyton }
37447cc577a4SJonathan Peyton 
37457cc577a4SJonathan Peyton // __kmp_tasking_barrier:
3746e0665a90STerry Wilmarth // This routine is called only when __kmp_tasking_mode == tskm_extra_barrier.
37473041982dSJonathan Peyton // Internal function to execute all tasks prior to a regular barrier or a join
37483041982dSJonathan Peyton // barrier. It is a full barrier itself, which unfortunately turns regular
37493041982dSJonathan Peyton // barriers into double barriers and join barriers into 1 1/2 barriers.
37503041982dSJonathan Peyton void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread, int gtid) {
375137e2ef54SJonathan Peyton   std::atomic<kmp_uint32> *spin = RCAST(
375237e2ef54SJonathan Peyton       std::atomic<kmp_uint32> *,
3753c47afcd9SAndrey Churbanov       &team->t.t_task_team[thread->th.th_task_state]->tt.tt_unfinished_threads);
37547cc577a4SJonathan Peyton   int flag = FALSE;
37557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode == tskm_extra_barrier);
37567cc577a4SJonathan Peyton 
37577cc577a4SJonathan Peyton #if USE_ITT_BUILD
375837e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_INIT(spin, NULL);
37597cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
3760e0665a90STerry Wilmarth   kmp_flag_32<false, false> spin_flag(spin, 0U);
37613041982dSJonathan Peyton   while (!spin_flag.execute_tasks(thread, gtid, TRUE,
37623041982dSJonathan Peyton                                   &flag USE_ITT_BUILD_ARG(NULL), 0)) {
37637cc577a4SJonathan Peyton #if USE_ITT_BUILD
37647cc577a4SJonathan Peyton     // TODO: What about itt_sync_obj??
376537e2ef54SJonathan Peyton     KMP_FSYNC_SPIN_PREPARE(RCAST(void *, spin));
37667cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37677cc577a4SJonathan Peyton 
37687cc577a4SJonathan Peyton     if (TCR_4(__kmp_global.g.g_done)) {
37697cc577a4SJonathan Peyton       if (__kmp_global.g.g_abort)
37707cc577a4SJonathan Peyton         __kmp_abort_thread();
37717cc577a4SJonathan Peyton       break;
37727cc577a4SJonathan Peyton     }
3773e47d32f1SJonathan Peyton     KMP_YIELD(TRUE);
37747cc577a4SJonathan Peyton   }
37757cc577a4SJonathan Peyton #if USE_ITT_BUILD
377637e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_ACQUIRED(RCAST(void *, spin));
37777cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
37787cc577a4SJonathan Peyton }
37797cc577a4SJonathan Peyton 
37803041982dSJonathan Peyton // __kmp_give_task puts a task into a given thread queue if:
37813041982dSJonathan Peyton //  - the queue for that thread was created
37823041982dSJonathan Peyton //  - there's space in that queue
37833041982dSJonathan Peyton // Because of this, __kmp_push_task needs to check if there's space after
37843041982dSJonathan Peyton // getting the lock
37853041982dSJonathan Peyton static bool __kmp_give_task(kmp_info_t *thread, kmp_int32 tid, kmp_task_t *task,
37863041982dSJonathan Peyton                             kmp_int32 pass) {
37877cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
37887cc577a4SJonathan Peyton   kmp_task_team_t *task_team = taskdata->td_task_team;
37897cc577a4SJonathan Peyton 
37903041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_give_task: trying to give task %p to thread %d.\n",
37913041982dSJonathan Peyton                 taskdata, tid));
37927cc577a4SJonathan Peyton 
37937cc577a4SJonathan Peyton   // If task_team is NULL something went really bad...
37947cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
37957cc577a4SJonathan Peyton 
37967cc577a4SJonathan Peyton   bool result = false;
37977cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
37987cc577a4SJonathan Peyton 
37997cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
38007cc577a4SJonathan Peyton     // There's no queue in this thread, go find another one
38017cc577a4SJonathan Peyton     // We're guaranteed that at least one thread has a queue
38023041982dSJonathan Peyton     KA_TRACE(30,
38033041982dSJonathan Peyton              ("__kmp_give_task: thread %d has no queue while giving task %p.\n",
38043041982dSJonathan Peyton               tid, taskdata));
38057cc577a4SJonathan Peyton     return result;
38067cc577a4SJonathan Peyton   }
38077cc577a4SJonathan Peyton 
38083041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
38093041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
38103041982dSJonathan Peyton     KA_TRACE(
38113041982dSJonathan Peyton         30,
38123041982dSJonathan Peyton         ("__kmp_give_task: queue is full while giving task %p to thread %d.\n",
38133041982dSJonathan Peyton          taskdata, tid));
38147cc577a4SJonathan Peyton 
38153041982dSJonathan Peyton     // if this deque is bigger than the pass ratio give a chance to another
38163041982dSJonathan Peyton     // thread
38173041982dSJonathan Peyton     if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38183041982dSJonathan Peyton       return result;
38197cc577a4SJonathan Peyton 
38207cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38213895148dSJoachim Protze     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38223895148dSJoachim Protze         TASK_DEQUE_SIZE(thread_data->td)) {
38233895148dSJoachim Protze       // expand deque to push the task which is not allowed to execute
38247cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38253895148dSJoachim Protze     }
38267cc577a4SJonathan Peyton 
38277cc577a4SJonathan Peyton   } else {
38287cc577a4SJonathan Peyton 
38297cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
38307cc577a4SJonathan Peyton 
38313041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
38323041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
38333041982dSJonathan Peyton       KA_TRACE(30, ("__kmp_give_task: queue is full while giving task %p to "
38343041982dSJonathan Peyton                     "thread %d.\n",
38353041982dSJonathan Peyton                     taskdata, tid));
38367cc577a4SJonathan Peyton 
38373041982dSJonathan Peyton       // if this deque is bigger than the pass ratio give a chance to another
38383041982dSJonathan Peyton       // thread
38397cc577a4SJonathan Peyton       if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
38407cc577a4SJonathan Peyton         goto release_and_exit;
38417cc577a4SJonathan Peyton 
38427cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
38437cc577a4SJonathan Peyton     }
38447cc577a4SJonathan Peyton   }
38457cc577a4SJonathan Peyton 
38467cc577a4SJonathan Peyton   // lock is held here, and there is space in the deque
38477cc577a4SJonathan Peyton 
38487cc577a4SJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] = taskdata;
38497cc577a4SJonathan Peyton   // Wrap index.
38503041982dSJonathan Peyton   thread_data->td.td_deque_tail =
38513041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
38523041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
38533041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1);
38547cc577a4SJonathan Peyton 
38557cc577a4SJonathan Peyton   result = true;
38563041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_give_task: successfully gave task %p to thread %d.\n",
38573041982dSJonathan Peyton                 taskdata, tid));
38587cc577a4SJonathan Peyton 
38597cc577a4SJonathan Peyton release_and_exit:
38607cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
38617cc577a4SJonathan Peyton 
38627cc577a4SJonathan Peyton   return result;
38637cc577a4SJonathan Peyton }
38647cc577a4SJonathan Peyton 
38653c76e992SJoachim Protze #define PROXY_TASK_FLAG 0x40000000
38663041982dSJonathan Peyton /* The finish of the proxy tasks is divided in two pieces:
38677cc577a4SJonathan Peyton     - the top half is the one that can be done from a thread outside the team
3868c3344345SAndrey Churbanov     - the bottom half must be run from a thread within the team
38697cc577a4SJonathan Peyton 
38703041982dSJonathan Peyton    In order to run the bottom half the task gets queued back into one of the
38713041982dSJonathan Peyton    threads of the team. Once the td_incomplete_child_task counter of the parent
38723041982dSJonathan Peyton    is decremented the threads can leave the barriers. So, the bottom half needs
38733041982dSJonathan Peyton    to be queued before the counter is decremented. The top half is therefore
38743041982dSJonathan Peyton    divided in two parts:
38757cc577a4SJonathan Peyton     - things that can be run before queuing the bottom half
38767cc577a4SJonathan Peyton     - things that must be run after queuing the bottom half
38777cc577a4SJonathan Peyton 
38783041982dSJonathan Peyton    This creates a second race as the bottom half can free the task before the
38793041982dSJonathan Peyton    second top half is executed. To avoid this we use the
38803041982dSJonathan Peyton    td_incomplete_child_task of the proxy task to synchronize the top and bottom
38813041982dSJonathan Peyton    half. */
38823041982dSJonathan Peyton static void __kmp_first_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38837cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
38847cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
38857cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
38867cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
38877cc577a4SJonathan Peyton 
38887cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
38897cc577a4SJonathan Peyton 
38907cc577a4SJonathan Peyton   if (taskdata->td_taskgroup)
389137e2ef54SJonathan Peyton     KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
38927cc577a4SJonathan Peyton 
38933041982dSJonathan Peyton   // Create an imaginary children for this task so the bottom half cannot
38943041982dSJonathan Peyton   // release the task before we have completed the second top half
38953c76e992SJoachim Protze   KMP_ATOMIC_OR(&taskdata->td_incomplete_child_tasks, PROXY_TASK_FLAG);
38967cc577a4SJonathan Peyton }
38977cc577a4SJonathan Peyton 
38983041982dSJonathan Peyton static void __kmp_second_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
38998b81524cSAndreyChurbanov #if KMP_DEBUG
39007cc577a4SJonathan Peyton   kmp_int32 children = 0;
39017cc577a4SJonathan Peyton   // Predecrement simulated by "- 1" calculation
39028b81524cSAndreyChurbanov   children = -1 +
39038b81524cSAndreyChurbanov #endif
39048b81524cSAndreyChurbanov       KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks);
39057cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
39067cc577a4SJonathan Peyton 
39077cc577a4SJonathan Peyton   // Remove the imaginary children
39083c76e992SJoachim Protze   KMP_ATOMIC_AND(&taskdata->td_incomplete_child_tasks, ~PROXY_TASK_FLAG);
39097cc577a4SJonathan Peyton }
39107cc577a4SJonathan Peyton 
39113041982dSJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask) {
39127cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39137cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
39147cc577a4SJonathan Peyton 
39157cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39163041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete ==
39173041982dSJonathan Peyton                    1); // top half must run before bottom half
39187cc577a4SJonathan Peyton 
39197cc577a4SJonathan Peyton   // We need to wait to make sure the top half is finished
39207cc577a4SJonathan Peyton   // Spinning here should be ok as this should happen quickly
39213c76e992SJoachim Protze   while ((KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) &
39223c76e992SJoachim Protze           PROXY_TASK_FLAG) > 0)
39233041982dSJonathan Peyton     ;
39247cc577a4SJonathan Peyton 
39257cc577a4SJonathan Peyton   __kmp_release_deps(gtid, taskdata);
39267cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
39277cc577a4SJonathan Peyton }
39287cc577a4SJonathan Peyton 
39297cc577a4SJonathan Peyton /*!
39307cc577a4SJonathan Peyton @ingroup TASKING
39317cc577a4SJonathan Peyton @param gtid Global Thread ID of encountering thread
39327cc577a4SJonathan Peyton @param ptask Task which execution is completed
39337cc577a4SJonathan Peyton 
3934ed5fe645SKelvin Li Execute the completion of a proxy task from a thread of that is part of the
39353041982dSJonathan Peyton team. Run first and bottom halves directly.
39367cc577a4SJonathan Peyton */
39373041982dSJonathan Peyton void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask) {
39387cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39397cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39403041982dSJonathan Peyton   KA_TRACE(
39413041982dSJonathan Peyton       10, ("__kmp_proxy_task_completed(enter): T#%d proxy task %p completing\n",
39423041982dSJonathan Peyton            gtid, taskdata));
3943787eb0c6SAndreyChurbanov   __kmp_assert_valid_gtid(gtid);
39447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
39457cc577a4SJonathan Peyton 
39467cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
39477cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
39487cc577a4SJonathan Peyton   __kmp_bottom_half_finish_proxy(gtid, ptask);
39497cc577a4SJonathan Peyton 
39503041982dSJonathan Peyton   KA_TRACE(10,
39513041982dSJonathan Peyton            ("__kmp_proxy_task_completed(exit): T#%d proxy task %p completing\n",
39523041982dSJonathan Peyton             gtid, taskdata));
39537cc577a4SJonathan Peyton }
39547cc577a4SJonathan Peyton 
3955ea452353SShilei Tian void __kmpc_give_task(kmp_task_t *ptask, kmp_int32 start = 0) {
3956ea452353SShilei Tian   KMP_DEBUG_ASSERT(ptask != NULL);
3957ea452353SShilei Tian   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
3958ea452353SShilei Tian 
3959ea452353SShilei Tian   // Enqueue task to complete bottom half completion from a thread within the
3960ea452353SShilei Tian   // corresponding team
3961ea452353SShilei Tian   kmp_team_t *team = taskdata->td_team;
3962ea452353SShilei Tian   kmp_int32 nthreads = team->t.t_nproc;
3963ea452353SShilei Tian   kmp_info_t *thread;
3964ea452353SShilei Tian 
3965ea452353SShilei Tian   // This should be similar to start_k = __kmp_get_random( thread ) % nthreads
3966ea452353SShilei Tian   // but we cannot use __kmp_get_random here
3967680c71b1SShilei Tian   kmp_int32 start_k = start % nthreads;
3968ea452353SShilei Tian   kmp_int32 pass = 1;
3969ea452353SShilei Tian   kmp_int32 k = start_k;
3970ea452353SShilei Tian 
3971ea452353SShilei Tian   do {
3972ea452353SShilei Tian     // For now we're just linearly trying to find a thread
3973ea452353SShilei Tian     thread = team->t.t_threads[k];
3974ea452353SShilei Tian     k = (k + 1) % nthreads;
3975ea452353SShilei Tian 
3976ea452353SShilei Tian     // we did a full pass through all the threads
3977ea452353SShilei Tian     if (k == start_k)
3978ea452353SShilei Tian       pass = pass << 1;
3979ea452353SShilei Tian 
3980ea452353SShilei Tian   } while (!__kmp_give_task(thread, k, ptask, pass));
3981ea452353SShilei Tian }
3982ea452353SShilei Tian 
39837cc577a4SJonathan Peyton /*!
39847cc577a4SJonathan Peyton @ingroup TASKING
39857cc577a4SJonathan Peyton @param ptask Task which execution is completed
39867cc577a4SJonathan Peyton 
3987ed5fe645SKelvin Li Execute the completion of a proxy task from a thread that could not belong to
39883041982dSJonathan Peyton the team.
39897cc577a4SJonathan Peyton */
39903041982dSJonathan Peyton void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask) {
39917cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
39927cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
39937cc577a4SJonathan Peyton 
39943041982dSJonathan Peyton   KA_TRACE(
39953041982dSJonathan Peyton       10,
39963041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(enter): proxy task completing ooo %p\n",
39973041982dSJonathan Peyton        taskdata));
39987cc577a4SJonathan Peyton 
39997cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
40007cc577a4SJonathan Peyton 
40017cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
40027cc577a4SJonathan Peyton 
4003ea452353SShilei Tian   __kmpc_give_task(ptask);
40047cc577a4SJonathan Peyton 
40057cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
40067cc577a4SJonathan Peyton 
40073041982dSJonathan Peyton   KA_TRACE(
40083041982dSJonathan Peyton       10,
40093041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(exit): proxy task completing ooo %p\n",
40103041982dSJonathan Peyton        taskdata));
40117cc577a4SJonathan Peyton }
40127cc577a4SJonathan Peyton 
4013405037c4SAndrey Churbanov kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref, int gtid,
4014405037c4SAndrey Churbanov                                                 kmp_task_t *task) {
4015405037c4SAndrey Churbanov   kmp_taskdata_t *td = KMP_TASK_TO_TASKDATA(task);
4016405037c4SAndrey Churbanov   if (td->td_allow_completion_event.type == KMP_EVENT_UNINITIALIZED) {
4017405037c4SAndrey Churbanov     td->td_allow_completion_event.type = KMP_EVENT_ALLOW_COMPLETION;
4018405037c4SAndrey Churbanov     td->td_allow_completion_event.ed.task = task;
4019405037c4SAndrey Churbanov     __kmp_init_tas_lock(&td->td_allow_completion_event.lock);
4020405037c4SAndrey Churbanov   }
4021405037c4SAndrey Churbanov   return &td->td_allow_completion_event;
4022405037c4SAndrey Churbanov }
4023405037c4SAndrey Churbanov 
4024405037c4SAndrey Churbanov void __kmp_fulfill_event(kmp_event_t *event) {
4025405037c4SAndrey Churbanov   if (event->type == KMP_EVENT_ALLOW_COMPLETION) {
4026405037c4SAndrey Churbanov     kmp_task_t *ptask = event->ed.task;
4027405037c4SAndrey Churbanov     kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
4028405037c4SAndrey Churbanov     bool detached = false;
4029405037c4SAndrey Churbanov     int gtid = __kmp_get_gtid();
4030405037c4SAndrey Churbanov 
4031d23131a3SJoachim Protze     // The associated task might have completed or could be completing at this
4032405037c4SAndrey Churbanov     // point.
4033405037c4SAndrey Churbanov     // We need to take the lock to avoid races
4034405037c4SAndrey Churbanov     __kmp_acquire_tas_lock(&event->lock, gtid);
403510995c77SJoachim Protze     if (taskdata->td_flags.proxy == TASK_PROXY) {
4036405037c4SAndrey Churbanov       detached = true;
403710995c77SJoachim Protze     } else {
403810995c77SJoachim Protze #if OMPT_SUPPORT
403910995c77SJoachim Protze       // The OMPT event must occur under mutual exclusion,
404010995c77SJoachim Protze       // otherwise the tool might access ptask after free
404110995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
404210995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_early_fulfill);
404310995c77SJoachim Protze #endif
404410995c77SJoachim Protze     }
4045405037c4SAndrey Churbanov     event->type = KMP_EVENT_UNINITIALIZED;
4046405037c4SAndrey Churbanov     __kmp_release_tas_lock(&event->lock, gtid);
4047405037c4SAndrey Churbanov 
4048405037c4SAndrey Churbanov     if (detached) {
404910995c77SJoachim Protze #if OMPT_SUPPORT
405010995c77SJoachim Protze       // We free ptask afterwards and know the task is finished,
405110995c77SJoachim Protze       // so locking is not necessary
405210995c77SJoachim Protze       if (UNLIKELY(ompt_enabled.enabled))
405310995c77SJoachim Protze         __ompt_task_finish(ptask, NULL, ompt_task_late_fulfill);
405410995c77SJoachim Protze #endif
4055405037c4SAndrey Churbanov       // If the task detached complete the proxy task
4056405037c4SAndrey Churbanov       if (gtid >= 0) {
4057405037c4SAndrey Churbanov         kmp_team_t *team = taskdata->td_team;
4058405037c4SAndrey Churbanov         kmp_info_t *thread = __kmp_get_thread();
4059405037c4SAndrey Churbanov         if (thread->th.th_team == team) {
4060405037c4SAndrey Churbanov           __kmpc_proxy_task_completed(gtid, ptask);
4061405037c4SAndrey Churbanov           return;
4062405037c4SAndrey Churbanov         }
4063405037c4SAndrey Churbanov       }
4064405037c4SAndrey Churbanov 
4065405037c4SAndrey Churbanov       // fallback
4066405037c4SAndrey Churbanov       __kmpc_proxy_task_completed_ooo(ptask);
4067405037c4SAndrey Churbanov     }
4068405037c4SAndrey Churbanov   }
4069405037c4SAndrey Churbanov }
4070405037c4SAndrey Churbanov 
40713041982dSJonathan Peyton // __kmp_task_dup_alloc: Allocate the taskdata and make a copy of source task
40723041982dSJonathan Peyton // for taskloop
40737cc577a4SJonathan Peyton //
40747cc577a4SJonathan Peyton // thread:   allocating thread
40757cc577a4SJonathan Peyton // task_src: pointer to source task to be duplicated
40767cc577a4SJonathan Peyton // returns:  a pointer to the allocated kmp_task_t structure (task).
40773041982dSJonathan Peyton kmp_task_t *__kmp_task_dup_alloc(kmp_info_t *thread, kmp_task_t *task_src) {
40787cc577a4SJonathan Peyton   kmp_task_t *task;
40797cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
40805e111c5dSAndreyChurbanov   kmp_taskdata_t *taskdata_src = KMP_TASK_TO_TASKDATA(task_src);
40815e111c5dSAndreyChurbanov   kmp_taskdata_t *parent_task = taskdata_src->td_parent; // same parent task
40827cc577a4SJonathan Peyton   size_t shareds_offset;
40837cc577a4SJonathan Peyton   size_t task_size;
40847cc577a4SJonathan Peyton 
40853041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_dup_alloc(enter): Th %p, source task %p\n", thread,
40863041982dSJonathan Peyton                 task_src));
40873041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.proxy ==
40883041982dSJonathan Peyton                    TASK_FULL); // it should not be proxy task
40897cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.tasktype == TASK_EXPLICIT);
40907cc577a4SJonathan Peyton   task_size = taskdata_src->td_size_alloc;
40917cc577a4SJonathan Peyton 
40927cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
40933041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_dup_alloc: Th %p, malloc size %ld\n", thread,
40943041982dSJonathan Peyton                 task_size));
40957cc577a4SJonathan Peyton #if USE_FAST_MEMORY
40967cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, task_size);
40977cc577a4SJonathan Peyton #else
40987cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, task_size);
40997cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
41007cc577a4SJonathan Peyton   KMP_MEMCPY(taskdata, taskdata_src, task_size);
41017cc577a4SJonathan Peyton 
41027cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
41037cc577a4SJonathan Peyton 
41047cc577a4SJonathan Peyton   // Initialize new task (only specific fields not affected by memcpy)
41057cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
41067cc577a4SJonathan Peyton   if (task->shareds != NULL) { // need setup shareds pointer
41077cc577a4SJonathan Peyton     shareds_offset = (char *)task_src->shareds - (char *)taskdata_src;
41087cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
41093041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
41103041982dSJonathan Peyton                      0);
41117cc577a4SJonathan Peyton   }
41127cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
411393e17cfeSJonathan Peyton   taskdata->td_parent = parent_task;
4114ae044467SAndreyChurbanov   // task inherits the taskgroup from the parent task
4115ae044467SAndreyChurbanov   taskdata->td_taskgroup = parent_task->td_taskgroup;
4116ae044467SAndreyChurbanov   // tied task needs to initialize the td_last_tied at creation,
4117ae044467SAndreyChurbanov   // untied one does this when it is scheduled for execution
4118ae044467SAndreyChurbanov   if (taskdata->td_flags.tiedness == TASK_TIED)
4119ae044467SAndreyChurbanov     taskdata->td_last_tied = taskdata;
41207cc577a4SJonathan Peyton 
41213041982dSJonathan Peyton   // Only need to keep track of child task counts if team parallel and tasking
41223041982dSJonathan Peyton   // not serialized
41237cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
412437e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
41257cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
412637e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
41273041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
41283041982dSJonathan Peyton     // implicit not deallocated
41297cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT)
413037e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
41317cc577a4SJonathan Peyton   }
41327cc577a4SJonathan Peyton 
41333041982dSJonathan Peyton   KA_TRACE(20,
41343041982dSJonathan Peyton            ("__kmp_task_dup_alloc(exit): Th %p, created task %p, parent=%p\n",
41357cc577a4SJonathan Peyton             thread, taskdata, taskdata->td_parent));
41367cc577a4SJonathan Peyton #if OMPT_SUPPORT
4137f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
413882e94a59SJoachim Protze     __ompt_task_init(taskdata, thread->th.th_info.ds.ds_gtid);
41397cc577a4SJonathan Peyton #endif
41407cc577a4SJonathan Peyton   return task;
41417cc577a4SJonathan Peyton }
41427cc577a4SJonathan Peyton 
41437cc577a4SJonathan Peyton // Routine optionally generated by the compiler for setting the lastprivate flag
41447cc577a4SJonathan Peyton // and calling needed constructors for private/firstprivate objects
41457cc577a4SJonathan Peyton // (used to form taskloop tasks from pattern task)
414693e17cfeSJonathan Peyton // Parameters: dest task, src task, lastprivate flag.
41477cc577a4SJonathan Peyton typedef void (*p_task_dup_t)(kmp_task_t *, kmp_task_t *, kmp_int32);
41487cc577a4SJonathan Peyton 
414927a677fcSJonathan Peyton KMP_BUILD_ASSERT(sizeof(long) == 4 || sizeof(long) == 8);
415027a677fcSJonathan Peyton 
415127a677fcSJonathan Peyton // class to encapsulate manipulating loop bounds in a taskloop task.
415227a677fcSJonathan Peyton // this abstracts away the Intel vs GOMP taskloop interface for setting/getting
415327a677fcSJonathan Peyton // the loop bound variables.
415427a677fcSJonathan Peyton class kmp_taskloop_bounds_t {
415527a677fcSJonathan Peyton   kmp_task_t *task;
415627a677fcSJonathan Peyton   const kmp_taskdata_t *taskdata;
415727a677fcSJonathan Peyton   size_t lower_offset;
415827a677fcSJonathan Peyton   size_t upper_offset;
415927a677fcSJonathan Peyton 
416027a677fcSJonathan Peyton public:
416127a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, kmp_uint64 *lb, kmp_uint64 *ub)
416227a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(task)),
416327a677fcSJonathan Peyton         lower_offset((char *)lb - (char *)task),
416427a677fcSJonathan Peyton         upper_offset((char *)ub - (char *)task) {
416527a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)lb > (char *)_task);
416627a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)ub > (char *)_task);
416727a677fcSJonathan Peyton   }
416827a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, const kmp_taskloop_bounds_t &bounds)
416927a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(_task)),
417027a677fcSJonathan Peyton         lower_offset(bounds.lower_offset), upper_offset(bounds.upper_offset) {}
417127a677fcSJonathan Peyton   size_t get_lower_offset() const { return lower_offset; }
417227a677fcSJonathan Peyton   size_t get_upper_offset() const { return upper_offset; }
417327a677fcSJonathan Peyton   kmp_uint64 get_lb() const {
417427a677fcSJonathan Peyton     kmp_int64 retval;
417527a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
417627a677fcSJonathan Peyton     // Intel task just returns the lower bound normally
417727a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
417827a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + lower_offset);
417927a677fcSJonathan Peyton     } else {
418027a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
418127a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
418227a677fcSJonathan Peyton         kmp_int32 *lb = RCAST(kmp_int32 *, task->shareds);
418327a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
418427a677fcSJonathan Peyton       } else {
418527a677fcSJonathan Peyton         kmp_int64 *lb = RCAST(kmp_int64 *, task->shareds);
418627a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
418727a677fcSJonathan Peyton       }
418827a677fcSJonathan Peyton     }
418927a677fcSJonathan Peyton #else
4190b3d84790SMartin Storsjö     (void)taskdata;
419127a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + lower_offset);
419227a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
419327a677fcSJonathan Peyton     return retval;
419427a677fcSJonathan Peyton   }
419527a677fcSJonathan Peyton   kmp_uint64 get_ub() const {
419627a677fcSJonathan Peyton     kmp_int64 retval;
419727a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
419827a677fcSJonathan Peyton     // Intel task just returns the upper bound normally
419927a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
420027a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + upper_offset);
420127a677fcSJonathan Peyton     } else {
420227a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
420327a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
420427a677fcSJonathan Peyton         kmp_int32 *ub = RCAST(kmp_int32 *, task->shareds) + 1;
420527a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
420627a677fcSJonathan Peyton       } else {
420727a677fcSJonathan Peyton         kmp_int64 *ub = RCAST(kmp_int64 *, task->shareds) + 1;
420827a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
420927a677fcSJonathan Peyton       }
421027a677fcSJonathan Peyton     }
421127a677fcSJonathan Peyton #else
421227a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + upper_offset);
421327a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
421427a677fcSJonathan Peyton     return retval;
421527a677fcSJonathan Peyton   }
421627a677fcSJonathan Peyton   void set_lb(kmp_uint64 lb) {
421727a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
421827a677fcSJonathan Peyton     // Intel task just sets the lower bound normally
421927a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
422027a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + lower_offset) = lb;
422127a677fcSJonathan Peyton     } else {
422227a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
422327a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
422427a677fcSJonathan Peyton         kmp_uint32 *lower = RCAST(kmp_uint32 *, task->shareds);
422527a677fcSJonathan Peyton         *lower = (kmp_uint32)lb;
422627a677fcSJonathan Peyton       } else {
422727a677fcSJonathan Peyton         kmp_uint64 *lower = RCAST(kmp_uint64 *, task->shareds);
422827a677fcSJonathan Peyton         *lower = (kmp_uint64)lb;
422927a677fcSJonathan Peyton       }
423027a677fcSJonathan Peyton     }
423127a677fcSJonathan Peyton #else
423227a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + lower_offset) = lb;
423327a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
423427a677fcSJonathan Peyton   }
423527a677fcSJonathan Peyton   void set_ub(kmp_uint64 ub) {
423627a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
423727a677fcSJonathan Peyton     // Intel task just sets the upper bound normally
423827a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
423927a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + upper_offset) = ub;
424027a677fcSJonathan Peyton     } else {
424127a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
424227a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
424327a677fcSJonathan Peyton         kmp_uint32 *upper = RCAST(kmp_uint32 *, task->shareds) + 1;
424427a677fcSJonathan Peyton         *upper = (kmp_uint32)ub;
424527a677fcSJonathan Peyton       } else {
424627a677fcSJonathan Peyton         kmp_uint64 *upper = RCAST(kmp_uint64 *, task->shareds) + 1;
424727a677fcSJonathan Peyton         *upper = (kmp_uint64)ub;
424827a677fcSJonathan Peyton       }
424927a677fcSJonathan Peyton     }
425027a677fcSJonathan Peyton #else
425127a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + upper_offset) = ub;
425227a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
425327a677fcSJonathan Peyton   }
425427a677fcSJonathan Peyton };
425527a677fcSJonathan Peyton 
42567cc577a4SJonathan Peyton // __kmp_taskloop_linear: Start tasks of the taskloop linearly
42577cc577a4SJonathan Peyton //
42587cc577a4SJonathan Peyton // loc        Source location information
42597cc577a4SJonathan Peyton // gtid       Global thread ID
426093e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
426193e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
426293e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
42637cc577a4SJonathan Peyton // st         Loop stride
426493e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
426593e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
426693e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
426793e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4268540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
426993e17cfeSJonathan Peyton // tc         Iterations count
42707cc577a4SJonathan Peyton // task_dup   Tasks duplication routine
4271cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
42723041982dSJonathan Peyton void __kmp_taskloop_linear(ident_t *loc, int gtid, kmp_task_t *task,
42737cc577a4SJonathan Peyton                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
427493e17cfeSJonathan Peyton                            kmp_uint64 ub_glob, kmp_uint64 num_tasks,
427593e17cfeSJonathan Peyton                            kmp_uint64 grainsize, kmp_uint64 extras,
4276540007b4SNawrin Sultana                            kmp_int64 last_chunk, kmp_uint64 tc,
4277cdaefac5SJoachim Protze #if OMPT_SUPPORT
4278cdaefac5SJoachim Protze                            void *codeptr_ra,
4279cdaefac5SJoachim Protze #endif
4280cdaefac5SJoachim Protze                            void *task_dup) {
42817cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKLOOP);
42827cc577a4SJonathan Peyton   KMP_TIME_PARTITIONED_BLOCK(OMP_taskloop_scheduling);
42837cc577a4SJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
428427a677fcSJonathan Peyton   // compiler provides global bounds here
428527a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
428627a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
428727a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
428893e17cfeSJonathan Peyton   kmp_uint64 i;
42897cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
42907cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
42917cc577a4SJonathan Peyton   kmp_task_t *next_task;
42927cc577a4SJonathan Peyton   kmp_int32 lastpriv = 0;
42937cc577a4SJonathan Peyton 
4294309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4295309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
429693e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
429793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
429893e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_linear: T#%d: %lld tasks, grainsize %lld, "
4299540007b4SNawrin Sultana                 "extras %lld, last_chunk %lld, i=%lld,%lld(%d)%lld, dup %p\n",
4300540007b4SNawrin Sultana                 gtid, num_tasks, grainsize, extras, last_chunk, lower, upper,
4301540007b4SNawrin Sultana                 ub_glob, st, task_dup));
430293e17cfeSJonathan Peyton 
430393e17cfeSJonathan Peyton   // Launch num_tasks tasks, assign grainsize iterations each task
430493e17cfeSJonathan Peyton   for (i = 0; i < num_tasks; ++i) {
430593e17cfeSJonathan Peyton     kmp_uint64 chunk_minus_1;
430693e17cfeSJonathan Peyton     if (extras == 0) {
430793e17cfeSJonathan Peyton       chunk_minus_1 = grainsize - 1;
430893e17cfeSJonathan Peyton     } else {
430993e17cfeSJonathan Peyton       chunk_minus_1 = grainsize;
431093e17cfeSJonathan Peyton       --extras; // first extras iterations get bigger chunk (grainsize+1)
431193e17cfeSJonathan Peyton     }
431293e17cfeSJonathan Peyton     upper = lower + st * chunk_minus_1;
4313540007b4SNawrin Sultana     if (upper > *ub) {
4314540007b4SNawrin Sultana       upper = *ub;
4315540007b4SNawrin Sultana     }
431693e17cfeSJonathan Peyton     if (i == num_tasks - 1) {
431793e17cfeSJonathan Peyton       // schedule the last task, set lastprivate flag if needed
431893e17cfeSJonathan Peyton       if (st == 1) { // most common case
431993e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper == *ub);
432093e17cfeSJonathan Peyton         if (upper == ub_glob)
432193e17cfeSJonathan Peyton           lastpriv = 1;
432293e17cfeSJonathan Peyton       } else if (st > 0) { // positive loop stride
432393e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT((kmp_uint64)st > *ub - upper);
432493e17cfeSJonathan Peyton         if ((kmp_uint64)st > ub_glob - upper)
432593e17cfeSJonathan Peyton           lastpriv = 1;
432693e17cfeSJonathan Peyton       } else { // negative loop stride
432793e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper + st < *ub);
432893e17cfeSJonathan Peyton         if (upper - ub_glob < (kmp_uint64)(-st))
432993e17cfeSJonathan Peyton           lastpriv = 1;
433093e17cfeSJonathan Peyton       }
433193e17cfeSJonathan Peyton     }
433293e17cfeSJonathan Peyton     next_task = __kmp_task_dup_alloc(thread, task); // allocate new task
433327a677fcSJonathan Peyton     kmp_taskdata_t *next_taskdata = KMP_TASK_TO_TASKDATA(next_task);
433427a677fcSJonathan Peyton     kmp_taskloop_bounds_t next_task_bounds =
433527a677fcSJonathan Peyton         kmp_taskloop_bounds_t(next_task, task_bounds);
433627a677fcSJonathan Peyton 
433793e17cfeSJonathan Peyton     // adjust task-specific bounds
433827a677fcSJonathan Peyton     next_task_bounds.set_lb(lower);
433927a677fcSJonathan Peyton     if (next_taskdata->td_flags.native) {
434027a677fcSJonathan Peyton       next_task_bounds.set_ub(upper + (st > 0 ? 1 : -1));
434127a677fcSJonathan Peyton     } else {
434227a677fcSJonathan Peyton       next_task_bounds.set_ub(upper);
434327a677fcSJonathan Peyton     }
43444c6a098aSKazuaki Ishizaki     if (ptask_dup != NULL) // set lastprivate flag, construct firstprivates,
43454c6a098aSKazuaki Ishizaki                            // etc.
434693e17cfeSJonathan Peyton       ptask_dup(next_task, task, lastpriv);
434727a677fcSJonathan Peyton     KA_TRACE(40,
434827a677fcSJonathan Peyton              ("__kmp_taskloop_linear: T#%d; task #%llu: task %p: lower %lld, "
434927a677fcSJonathan Peyton               "upper %lld stride %lld, (offsets %p %p)\n",
435027a677fcSJonathan Peyton               gtid, i, next_task, lower, upper, st,
435127a677fcSJonathan Peyton               next_task_bounds.get_lower_offset(),
435227a677fcSJonathan Peyton               next_task_bounds.get_upper_offset()));
4353cdaefac5SJoachim Protze #if OMPT_SUPPORT
4354cdaefac5SJoachim Protze     __kmp_omp_taskloop_task(NULL, gtid, next_task,
4355cdaefac5SJoachim Protze                             codeptr_ra); // schedule new task
4356cdaefac5SJoachim Protze #else
435793e17cfeSJonathan Peyton     __kmp_omp_task(gtid, next_task, true); // schedule new task
4358cdaefac5SJoachim Protze #endif
435993e17cfeSJonathan Peyton     lower = upper + st; // adjust lower bound for the next iteration
436093e17cfeSJonathan Peyton   }
436193e17cfeSJonathan Peyton   // free the pattern task and exit
436293e17cfeSJonathan Peyton   __kmp_task_start(gtid, task, current_task); // make internal bookkeeping
436393e17cfeSJonathan Peyton   // do not execute the pattern task, just do internal bookkeeping
436486ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task, current_task);
436593e17cfeSJonathan Peyton }
436693e17cfeSJonathan Peyton 
436793e17cfeSJonathan Peyton // Structure to keep taskloop parameters for auxiliary task
436893e17cfeSJonathan Peyton // kept in the shareds of the task structure.
436993e17cfeSJonathan Peyton typedef struct __taskloop_params {
437093e17cfeSJonathan Peyton   kmp_task_t *task;
437193e17cfeSJonathan Peyton   kmp_uint64 *lb;
437293e17cfeSJonathan Peyton   kmp_uint64 *ub;
437393e17cfeSJonathan Peyton   void *task_dup;
437493e17cfeSJonathan Peyton   kmp_int64 st;
437593e17cfeSJonathan Peyton   kmp_uint64 ub_glob;
437693e17cfeSJonathan Peyton   kmp_uint64 num_tasks;
437793e17cfeSJonathan Peyton   kmp_uint64 grainsize;
437893e17cfeSJonathan Peyton   kmp_uint64 extras;
4379540007b4SNawrin Sultana   kmp_int64 last_chunk;
438093e17cfeSJonathan Peyton   kmp_uint64 tc;
438193e17cfeSJonathan Peyton   kmp_uint64 num_t_min;
4382cdaefac5SJoachim Protze #if OMPT_SUPPORT
4383cdaefac5SJoachim Protze   void *codeptr_ra;
4384cdaefac5SJoachim Protze #endif
438593e17cfeSJonathan Peyton } __taskloop_params_t;
438693e17cfeSJonathan Peyton 
438793e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *, int, kmp_task_t *, kmp_uint64 *,
438893e17cfeSJonathan Peyton                           kmp_uint64 *, kmp_int64, kmp_uint64, kmp_uint64,
4389540007b4SNawrin Sultana                           kmp_uint64, kmp_uint64, kmp_int64, kmp_uint64,
4390540007b4SNawrin Sultana                           kmp_uint64,
4391cdaefac5SJoachim Protze #if OMPT_SUPPORT
4392cdaefac5SJoachim Protze                           void *,
4393cdaefac5SJoachim Protze #endif
439493e17cfeSJonathan Peyton                           void *);
439593e17cfeSJonathan Peyton 
4396ed5fe645SKelvin Li // Execute part of the taskloop submitted as a task.
439793e17cfeSJonathan Peyton int __kmp_taskloop_task(int gtid, void *ptask) {
4398d74d8902SJonathan Peyton   __taskloop_params_t *p =
4399d74d8902SJonathan Peyton       (__taskloop_params_t *)((kmp_task_t *)ptask)->shareds;
440093e17cfeSJonathan Peyton   kmp_task_t *task = p->task;
440193e17cfeSJonathan Peyton   kmp_uint64 *lb = p->lb;
440293e17cfeSJonathan Peyton   kmp_uint64 *ub = p->ub;
440393e17cfeSJonathan Peyton   void *task_dup = p->task_dup;
440493e17cfeSJonathan Peyton   //  p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
440593e17cfeSJonathan Peyton   kmp_int64 st = p->st;
440693e17cfeSJonathan Peyton   kmp_uint64 ub_glob = p->ub_glob;
440793e17cfeSJonathan Peyton   kmp_uint64 num_tasks = p->num_tasks;
440893e17cfeSJonathan Peyton   kmp_uint64 grainsize = p->grainsize;
440993e17cfeSJonathan Peyton   kmp_uint64 extras = p->extras;
4410540007b4SNawrin Sultana   kmp_int64 last_chunk = p->last_chunk;
441193e17cfeSJonathan Peyton   kmp_uint64 tc = p->tc;
441293e17cfeSJonathan Peyton   kmp_uint64 num_t_min = p->num_t_min;
4413cdaefac5SJoachim Protze #if OMPT_SUPPORT
4414cdaefac5SJoachim Protze   void *codeptr_ra = p->codeptr_ra;
4415cdaefac5SJoachim Protze #endif
441693e17cfeSJonathan Peyton #if KMP_DEBUG
441793e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
441893e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
4419540007b4SNawrin Sultana   KA_TRACE(20,
4420540007b4SNawrin Sultana            ("__kmp_taskloop_task: T#%d, task %p: %lld tasks, grainsize"
4421540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4422540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4423540007b4SNawrin Sultana             st, task_dup));
442493e17cfeSJonathan Peyton #endif
442593e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks * 2 + 1 > num_t_min);
442693e17cfeSJonathan Peyton   if (num_tasks > num_t_min)
442793e17cfeSJonathan Peyton     __kmp_taskloop_recur(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4428540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_t_min,
4429cdaefac5SJoachim Protze #if OMPT_SUPPORT
4430cdaefac5SJoachim Protze                          codeptr_ra,
4431cdaefac5SJoachim Protze #endif
4432cdaefac5SJoachim Protze                          task_dup);
443393e17cfeSJonathan Peyton   else
443493e17cfeSJonathan Peyton     __kmp_taskloop_linear(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
4435540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4436cdaefac5SJoachim Protze #if OMPT_SUPPORT
4437cdaefac5SJoachim Protze                           codeptr_ra,
4438cdaefac5SJoachim Protze #endif
4439cdaefac5SJoachim Protze                           task_dup);
444093e17cfeSJonathan Peyton 
444193e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmp_taskloop_task(exit): T#%d\n", gtid));
444293e17cfeSJonathan Peyton   return 0;
444393e17cfeSJonathan Peyton }
444493e17cfeSJonathan Peyton 
4445ed5fe645SKelvin Li // Schedule part of the taskloop as a task,
4446ed5fe645SKelvin Li // execute the rest of the taskloop.
444793e17cfeSJonathan Peyton //
444893e17cfeSJonathan Peyton // loc        Source location information
444993e17cfeSJonathan Peyton // gtid       Global thread ID
445093e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
445193e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
445293e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
445393e17cfeSJonathan Peyton // st         Loop stride
445493e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
445593e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
445693e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
445793e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
4458540007b4SNawrin Sultana // last_chunk Reduction of grainsize for last task
445993e17cfeSJonathan Peyton // tc         Iterations count
446042016791SKazuaki Ishizaki // num_t_min  Threshold to launch tasks recursively
446193e17cfeSJonathan Peyton // task_dup   Tasks duplication routine
4462cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
446393e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *loc, int gtid, kmp_task_t *task,
446493e17cfeSJonathan Peyton                           kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
446593e17cfeSJonathan Peyton                           kmp_uint64 ub_glob, kmp_uint64 num_tasks,
446693e17cfeSJonathan Peyton                           kmp_uint64 grainsize, kmp_uint64 extras,
4467540007b4SNawrin Sultana                           kmp_int64 last_chunk, kmp_uint64 tc,
4468540007b4SNawrin Sultana                           kmp_uint64 num_t_min,
4469cdaefac5SJoachim Protze #if OMPT_SUPPORT
4470cdaefac5SJoachim Protze                           void *codeptr_ra,
4471cdaefac5SJoachim Protze #endif
4472cdaefac5SJoachim Protze                           void *task_dup) {
447393e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
447493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
447593e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > num_t_min);
4476540007b4SNawrin Sultana   KA_TRACE(20,
4477540007b4SNawrin Sultana            ("__kmp_taskloop_recur: T#%d, task %p: %lld tasks, grainsize"
4478540007b4SNawrin Sultana             " %lld, extras %lld, last_chunk %lld, i=%lld,%lld(%d), dup %p\n",
4479540007b4SNawrin Sultana             gtid, taskdata, num_tasks, grainsize, extras, last_chunk, *lb, *ub,
4480540007b4SNawrin Sultana             st, task_dup));
448193e17cfeSJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
448293e17cfeSJonathan Peyton   kmp_uint64 lower = *lb;
448393e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
448493e17cfeSJonathan Peyton   //  kmp_taskdata_t *current_task = thread->th.th_current_task;
448593e17cfeSJonathan Peyton   kmp_task_t *next_task;
448693e17cfeSJonathan Peyton   size_t lower_offset =
448793e17cfeSJonathan Peyton       (char *)lb - (char *)task; // remember offset of lb in the task structure
448893e17cfeSJonathan Peyton   size_t upper_offset =
448993e17cfeSJonathan Peyton       (char *)ub - (char *)task; // remember offset of ub in the task structure
449093e17cfeSJonathan Peyton 
4491309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4492309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
449393e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
449493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
449593e17cfeSJonathan Peyton 
449693e17cfeSJonathan Peyton   // split the loop in two halves
449793e17cfeSJonathan Peyton   kmp_uint64 lb1, ub0, tc0, tc1, ext0, ext1;
4498540007b4SNawrin Sultana   kmp_int64 last_chunk0 = 0, last_chunk1 = 0;
449993e17cfeSJonathan Peyton   kmp_uint64 gr_size0 = grainsize;
450093e17cfeSJonathan Peyton   kmp_uint64 n_tsk0 = num_tasks >> 1; // num_tasks/2 to execute
450193e17cfeSJonathan Peyton   kmp_uint64 n_tsk1 = num_tasks - n_tsk0; // to schedule as a task
4502540007b4SNawrin Sultana   if (last_chunk < 0) {
4503540007b4SNawrin Sultana     ext0 = ext1 = 0;
4504540007b4SNawrin Sultana     last_chunk1 = last_chunk;
4505540007b4SNawrin Sultana     tc0 = grainsize * n_tsk0;
4506540007b4SNawrin Sultana     tc1 = tc - tc0;
4507540007b4SNawrin Sultana   } else if (n_tsk0 <= extras) {
450893e17cfeSJonathan Peyton     gr_size0++; // integrate extras into grainsize
450993e17cfeSJonathan Peyton     ext0 = 0; // no extra iters in 1st half
451093e17cfeSJonathan Peyton     ext1 = extras - n_tsk0; // remaining extras
451193e17cfeSJonathan Peyton     tc0 = gr_size0 * n_tsk0;
451293e17cfeSJonathan Peyton     tc1 = tc - tc0;
451393e17cfeSJonathan Peyton   } else { // n_tsk0 > extras
451493e17cfeSJonathan Peyton     ext1 = 0; // no extra iters in 2nd half
451593e17cfeSJonathan Peyton     ext0 = extras;
451693e17cfeSJonathan Peyton     tc1 = grainsize * n_tsk1;
451793e17cfeSJonathan Peyton     tc0 = tc - tc1;
451893e17cfeSJonathan Peyton   }
451993e17cfeSJonathan Peyton   ub0 = lower + st * (tc0 - 1);
452093e17cfeSJonathan Peyton   lb1 = ub0 + st;
452193e17cfeSJonathan Peyton 
452293e17cfeSJonathan Peyton   // create pattern task for 2nd half of the loop
452393e17cfeSJonathan Peyton   next_task = __kmp_task_dup_alloc(thread, task); // duplicate the task
452493e17cfeSJonathan Peyton   // adjust lower bound (upper bound is not changed) for the 2nd half
452593e17cfeSJonathan Peyton   *(kmp_uint64 *)((char *)next_task + lower_offset) = lb1;
45264c6a098aSKazuaki Ishizaki   if (ptask_dup != NULL) // construct firstprivates, etc.
452793e17cfeSJonathan Peyton     ptask_dup(next_task, task, 0);
452893e17cfeSJonathan Peyton   *ub = ub0; // adjust upper bound for the 1st half
452993e17cfeSJonathan Peyton 
453093e17cfeSJonathan Peyton   // create auxiliary task for 2nd half of the loop
45315e111c5dSAndreyChurbanov   // make sure new task has same parent task as the pattern task
45325e111c5dSAndreyChurbanov   kmp_taskdata_t *current_task = thread->th.th_current_task;
45335e111c5dSAndreyChurbanov   thread->th.th_current_task = taskdata->td_parent;
453493e17cfeSJonathan Peyton   kmp_task_t *new_task =
453593e17cfeSJonathan Peyton       __kmpc_omp_task_alloc(loc, gtid, 1, 3 * sizeof(void *),
453693e17cfeSJonathan Peyton                             sizeof(__taskloop_params_t), &__kmp_taskloop_task);
45375e111c5dSAndreyChurbanov   // restore current task
45385e111c5dSAndreyChurbanov   thread->th.th_current_task = current_task;
453993e17cfeSJonathan Peyton   __taskloop_params_t *p = (__taskloop_params_t *)new_task->shareds;
454093e17cfeSJonathan Peyton   p->task = next_task;
454193e17cfeSJonathan Peyton   p->lb = (kmp_uint64 *)((char *)next_task + lower_offset);
454293e17cfeSJonathan Peyton   p->ub = (kmp_uint64 *)((char *)next_task + upper_offset);
454393e17cfeSJonathan Peyton   p->task_dup = task_dup;
454493e17cfeSJonathan Peyton   p->st = st;
454593e17cfeSJonathan Peyton   p->ub_glob = ub_glob;
454693e17cfeSJonathan Peyton   p->num_tasks = n_tsk1;
454793e17cfeSJonathan Peyton   p->grainsize = grainsize;
454893e17cfeSJonathan Peyton   p->extras = ext1;
4549540007b4SNawrin Sultana   p->last_chunk = last_chunk1;
455093e17cfeSJonathan Peyton   p->tc = tc1;
455193e17cfeSJonathan Peyton   p->num_t_min = num_t_min;
4552cdaefac5SJoachim Protze #if OMPT_SUPPORT
4553cdaefac5SJoachim Protze   p->codeptr_ra = codeptr_ra;
4554cdaefac5SJoachim Protze #endif
4555cdaefac5SJoachim Protze 
4556cdaefac5SJoachim Protze #if OMPT_SUPPORT
4557cdaefac5SJoachim Protze   // schedule new task with correct return address for OMPT events
4558cdaefac5SJoachim Protze   __kmp_omp_taskloop_task(NULL, gtid, new_task, codeptr_ra);
4559cdaefac5SJoachim Protze #else
4560f729df82SGheorghe-Teodor Bercea   __kmp_omp_task(gtid, new_task, true); // schedule new task
4561cdaefac5SJoachim Protze #endif
456293e17cfeSJonathan Peyton 
456393e17cfeSJonathan Peyton   // execute the 1st half of current subrange
456493e17cfeSJonathan Peyton   if (n_tsk0 > num_t_min)
4565d74d8902SJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0, gr_size0,
4566540007b4SNawrin Sultana                          ext0, last_chunk0, tc0, num_t_min,
4567cdaefac5SJoachim Protze #if OMPT_SUPPORT
4568cdaefac5SJoachim Protze                          codeptr_ra,
4569cdaefac5SJoachim Protze #endif
4570cdaefac5SJoachim Protze                          task_dup);
457193e17cfeSJonathan Peyton   else
457293e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0,
4573540007b4SNawrin Sultana                           gr_size0, ext0, last_chunk0, tc0,
4574cdaefac5SJoachim Protze #if OMPT_SUPPORT
4575cdaefac5SJoachim Protze                           codeptr_ra,
4576cdaefac5SJoachim Protze #endif
4577cdaefac5SJoachim Protze                           task_dup);
457893e17cfeSJonathan Peyton 
4579540007b4SNawrin Sultana   KA_TRACE(40, ("__kmp_taskloop_recur(exit): T#%d\n", gtid));
458093e17cfeSJonathan Peyton }
458193e17cfeSJonathan Peyton 
4582540007b4SNawrin Sultana static void __kmp_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4583540007b4SNawrin Sultana                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4584540007b4SNawrin Sultana                            int nogroup, int sched, kmp_uint64 grainsize,
4585540007b4SNawrin Sultana                            int modifier, void *task_dup) {
458693e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
458793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
458882e94a59SJoachim Protze   if (nogroup == 0) {
458982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
459082e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
459182e94a59SJoachim Protze #endif
459293e17cfeSJonathan Peyton     __kmpc_taskgroup(loc, gtid);
459382e94a59SJoachim Protze   }
459493e17cfeSJonathan Peyton 
459593e17cfeSJonathan Peyton   // =========================================================================
459693e17cfeSJonathan Peyton   // calculate loop parameters
459727a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
459893e17cfeSJonathan Peyton   kmp_uint64 tc;
459927a677fcSJonathan Peyton   // compiler provides global bounds here
460027a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
460127a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
460293e17cfeSJonathan Peyton   kmp_uint64 ub_glob = upper; // global upper used to calc lastprivate flag
460393e17cfeSJonathan Peyton   kmp_uint64 num_tasks = 0, extras = 0;
4604540007b4SNawrin Sultana   kmp_int64 last_chunk =
4605540007b4SNawrin Sultana       0; // reduce grainsize of last task by last_chunk in strict mode
460693e17cfeSJonathan Peyton   kmp_uint64 num_tasks_min = __kmp_taskloop_min_tasks;
460793e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
460893e17cfeSJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
460993e17cfeSJonathan Peyton 
4610540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop: T#%d, task %p, lb %lld, ub %lld, st %lld, "
4611540007b4SNawrin Sultana                 "grain %llu(%d, %d), dup %p\n",
4612540007b4SNawrin Sultana                 gtid, taskdata, lower, upper, st, grainsize, sched, modifier,
4613540007b4SNawrin Sultana                 task_dup));
461427a677fcSJonathan Peyton 
46157cc577a4SJonathan Peyton   // compute trip count
46167cc577a4SJonathan Peyton   if (st == 1) { // most common case
46177cc577a4SJonathan Peyton     tc = upper - lower + 1;
46187cc577a4SJonathan Peyton   } else if (st < 0) {
46197cc577a4SJonathan Peyton     tc = (lower - upper) / (-st) + 1;
46207cc577a4SJonathan Peyton   } else { // st > 0
46217cc577a4SJonathan Peyton     tc = (upper - lower) / st + 1;
46227cc577a4SJonathan Peyton   }
46237cc577a4SJonathan Peyton   if (tc == 0) {
4624540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop(exit): T#%d zero-trip loop\n", gtid));
46257cc577a4SJonathan Peyton     // free the pattern task and exit
46267cc577a4SJonathan Peyton     __kmp_task_start(gtid, task, current_task);
46277cc577a4SJonathan Peyton     // do not execute anything for zero-trip loop
462886ed6aa6SJoachim Protze     __kmp_task_finish<false>(gtid, task, current_task);
46297cc577a4SJonathan Peyton     return;
46307cc577a4SJonathan Peyton   }
4631cdaefac5SJoachim Protze 
4632cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4633cdaefac5SJoachim Protze   ompt_team_info_t *team_info = __ompt_get_teaminfo(0, NULL);
4634cdaefac5SJoachim Protze   ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
4635cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4636cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4637cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_begin, &(team_info->parallel_data),
4638cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4639cdaefac5SJoachim Protze   }
4640cdaefac5SJoachim Protze #endif
4641cdaefac5SJoachim Protze 
464293e17cfeSJonathan Peyton   if (num_tasks_min == 0)
464393e17cfeSJonathan Peyton     // TODO: can we choose better default heuristic?
4644d74d8902SJonathan Peyton     num_tasks_min =
4645d74d8902SJonathan Peyton         KMP_MIN(thread->th.th_team_nproc * 10, INITIAL_TASK_DEQUE_SIZE);
46467cc577a4SJonathan Peyton 
46477cc577a4SJonathan Peyton   // compute num_tasks/grainsize based on the input provided
46487cc577a4SJonathan Peyton   switch (sched) {
46497cc577a4SJonathan Peyton   case 0: // no schedule clause specified, we can choose the default
46507cc577a4SJonathan Peyton     // let's try to schedule (team_size*10) tasks
46517cc577a4SJonathan Peyton     grainsize = thread->th.th_team_nproc * 10;
46520c599c38SJoachim Protze     KMP_FALLTHROUGH();
46537cc577a4SJonathan Peyton   case 2: // num_tasks provided
46547cc577a4SJonathan Peyton     if (grainsize > tc) {
46557cc577a4SJonathan Peyton       num_tasks = tc; // too big num_tasks requested, adjust values
46567cc577a4SJonathan Peyton       grainsize = 1;
46577cc577a4SJonathan Peyton       extras = 0;
46587cc577a4SJonathan Peyton     } else {
46597cc577a4SJonathan Peyton       num_tasks = grainsize;
46607cc577a4SJonathan Peyton       grainsize = tc / num_tasks;
46617cc577a4SJonathan Peyton       extras = tc % num_tasks;
46627cc577a4SJonathan Peyton     }
46637cc577a4SJonathan Peyton     break;
46647cc577a4SJonathan Peyton   case 1: // grainsize provided
46657cc577a4SJonathan Peyton     if (grainsize > tc) {
4666540007b4SNawrin Sultana       num_tasks = 1;
4667540007b4SNawrin Sultana       grainsize = tc; // too big grainsize requested, adjust values
4668540007b4SNawrin Sultana       extras = 0;
4669540007b4SNawrin Sultana     } else {
4670540007b4SNawrin Sultana       if (modifier) {
4671540007b4SNawrin Sultana         num_tasks = (tc + grainsize - 1) / grainsize;
4672540007b4SNawrin Sultana         last_chunk = tc - (num_tasks * grainsize);
46737cc577a4SJonathan Peyton         extras = 0;
46747cc577a4SJonathan Peyton       } else {
46757cc577a4SJonathan Peyton         num_tasks = tc / grainsize;
467693e17cfeSJonathan Peyton         // adjust grainsize for balanced distribution of iterations
467793e17cfeSJonathan Peyton         grainsize = tc / num_tasks;
46787cc577a4SJonathan Peyton         extras = tc % num_tasks;
46797cc577a4SJonathan Peyton       }
4680540007b4SNawrin Sultana     }
46817cc577a4SJonathan Peyton     break;
46827cc577a4SJonathan Peyton   default:
46837cc577a4SJonathan Peyton     KMP_ASSERT2(0, "unknown scheduling of taskloop");
46847cc577a4SJonathan Peyton   }
4685540007b4SNawrin Sultana 
4686309b00a4SShilei Tian   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize +
4687309b00a4SShilei Tian                              (last_chunk < 0 ? last_chunk : extras));
46887cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
46897cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
469093e17cfeSJonathan Peyton   // =========================================================================
46917cc577a4SJonathan Peyton 
46927cc577a4SJonathan Peyton   // check if clause value first
469327a677fcSJonathan Peyton   // Also require GOMP_taskloop to reduce to linear (taskdata->td_flags.native)
46947cc577a4SJonathan Peyton   if (if_val == 0) { // if(0) specified, mark task as serial
46957cc577a4SJonathan Peyton     taskdata->td_flags.task_serial = 1;
46967cc577a4SJonathan Peyton     taskdata->td_flags.tiedness = TASK_TIED; // AC: serial task cannot be untied
469793e17cfeSJonathan Peyton     // always start serial tasks linearly
469893e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4699540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4700cdaefac5SJoachim Protze #if OMPT_SUPPORT
4701cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4702cdaefac5SJoachim Protze #endif
4703cdaefac5SJoachim Protze                           task_dup);
470427a677fcSJonathan Peyton     // !taskdata->td_flags.native => currently force linear spawning of tasks
470527a677fcSJonathan Peyton     // for GOMP_taskloop
470627a677fcSJonathan Peyton   } else if (num_tasks > num_tasks_min && !taskdata->td_flags.native) {
4707540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go recursive: tc %llu, #tasks %llu"
4708540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4709540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4710540007b4SNawrin Sultana                   last_chunk));
471193e17cfeSJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4712540007b4SNawrin Sultana                          grainsize, extras, last_chunk, tc, num_tasks_min,
4713cdaefac5SJoachim Protze #if OMPT_SUPPORT
4714cdaefac5SJoachim Protze                          OMPT_GET_RETURN_ADDRESS(0),
4715cdaefac5SJoachim Protze #endif
4716cdaefac5SJoachim Protze                          task_dup);
471793e17cfeSJonathan Peyton   } else {
4718540007b4SNawrin Sultana     KA_TRACE(20, ("__kmp_taskloop: T#%d, go linear: tc %llu, #tasks %llu"
4719540007b4SNawrin Sultana                   "(%lld), grain %llu, extras %llu, last_chunk %lld\n",
4720540007b4SNawrin Sultana                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras,
4721540007b4SNawrin Sultana                   last_chunk));
472293e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4723540007b4SNawrin Sultana                           grainsize, extras, last_chunk, tc,
4724cdaefac5SJoachim Protze #if OMPT_SUPPORT
4725cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4726cdaefac5SJoachim Protze #endif
4727cdaefac5SJoachim Protze                           task_dup);
47287cc577a4SJonathan Peyton   }
47297cc577a4SJonathan Peyton 
4730cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4731cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4732cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4733cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_end, &(team_info->parallel_data),
4734cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4735cdaefac5SJoachim Protze   }
4736cdaefac5SJoachim Protze #endif
4737cdaefac5SJoachim Protze 
473882e94a59SJoachim Protze   if (nogroup == 0) {
473982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
474082e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
474182e94a59SJoachim Protze #endif
47427cc577a4SJonathan Peyton     __kmpc_end_taskgroup(loc, gtid);
474382e94a59SJoachim Protze   }
4744540007b4SNawrin Sultana   KA_TRACE(20, ("__kmp_taskloop(exit): T#%d\n", gtid));
4745540007b4SNawrin Sultana }
4746540007b4SNawrin Sultana 
4747540007b4SNawrin Sultana /*!
4748540007b4SNawrin Sultana @ingroup TASKING
4749540007b4SNawrin Sultana @param loc       Source location information
4750540007b4SNawrin Sultana @param gtid      Global thread ID
4751540007b4SNawrin Sultana @param task      Task structure
4752540007b4SNawrin Sultana @param if_val    Value of the if clause
4753540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4754540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4755540007b4SNawrin Sultana @param st        Loop stride
4756540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4757540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4758540007b4SNawrin Sultana @param grainsize Schedule value if specified
4759540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4760540007b4SNawrin Sultana 
4761540007b4SNawrin Sultana Execute the taskloop construct.
4762540007b4SNawrin Sultana */
4763540007b4SNawrin Sultana void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4764540007b4SNawrin Sultana                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,
4765540007b4SNawrin Sultana                      int sched, kmp_uint64 grainsize, void *task_dup) {
4766540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4767540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop(enter): T#%d\n", gtid));
4768540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4769540007b4SNawrin Sultana                  0, task_dup);
477093e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d\n", gtid));
47717cc577a4SJonathan Peyton }
4772540007b4SNawrin Sultana 
4773540007b4SNawrin Sultana /*!
4774540007b4SNawrin Sultana @ingroup TASKING
4775540007b4SNawrin Sultana @param loc       Source location information
4776540007b4SNawrin Sultana @param gtid      Global thread ID
4777540007b4SNawrin Sultana @param task      Task structure
4778540007b4SNawrin Sultana @param if_val    Value of the if clause
4779540007b4SNawrin Sultana @param lb        Pointer to loop lower bound in task structure
4780540007b4SNawrin Sultana @param ub        Pointer to loop upper bound in task structure
4781540007b4SNawrin Sultana @param st        Loop stride
4782540007b4SNawrin Sultana @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
4783540007b4SNawrin Sultana @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
4784540007b4SNawrin Sultana @param grainsize Schedule value if specified
4785540007b4SNawrin Sultana @param modifer   Modifier 'strict' for sched, 1 if present, 0 otherwise
4786540007b4SNawrin Sultana @param task_dup  Tasks duplication routine
4787540007b4SNawrin Sultana 
4788540007b4SNawrin Sultana Execute the taskloop construct.
4789540007b4SNawrin Sultana */
4790540007b4SNawrin Sultana void __kmpc_taskloop_5(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
4791540007b4SNawrin Sultana                        kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
4792540007b4SNawrin Sultana                        int nogroup, int sched, kmp_uint64 grainsize,
4793540007b4SNawrin Sultana                        int modifier, void *task_dup) {
4794540007b4SNawrin Sultana   __kmp_assert_valid_gtid(gtid);
4795540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(enter): T#%d\n", gtid));
4796540007b4SNawrin Sultana   __kmp_taskloop(loc, gtid, task, if_val, lb, ub, st, nogroup, sched, grainsize,
4797540007b4SNawrin Sultana                  modifier, task_dup);
4798540007b4SNawrin Sultana   KA_TRACE(20, ("__kmpc_taskloop_5(exit): T#%d\n", gtid));
4799540007b4SNawrin Sultana }
4800