17cc577a4SJonathan Peyton /*
2de4749b7SJonathan Peyton  * kmp_tasking.cpp -- OpenMP 3.0 tasking support.
37cc577a4SJonathan Peyton  */
47cc577a4SJonathan Peyton 
57cc577a4SJonathan Peyton //===----------------------------------------------------------------------===//
67cc577a4SJonathan Peyton //
77cc577a4SJonathan Peyton //                     The LLVM Compiler Infrastructure
87cc577a4SJonathan Peyton //
97cc577a4SJonathan Peyton // This file is dual licensed under the MIT and the University of Illinois Open
107cc577a4SJonathan Peyton // Source Licenses. See LICENSE.txt for details.
117cc577a4SJonathan Peyton //
127cc577a4SJonathan Peyton //===----------------------------------------------------------------------===//
137cc577a4SJonathan Peyton 
147cc577a4SJonathan Peyton #include "kmp.h"
157cc577a4SJonathan Peyton #include "kmp_i18n.h"
167cc577a4SJonathan Peyton #include "kmp_itt.h"
177cc577a4SJonathan Peyton #include "kmp_stats.h"
183041982dSJonathan Peyton #include "kmp_wait_release.h"
197cc577a4SJonathan Peyton 
207cc577a4SJonathan Peyton #if OMPT_SUPPORT
217cc577a4SJonathan Peyton #include "ompt-specific.h"
227cc577a4SJonathan Peyton #endif
237cc577a4SJonathan Peyton 
247cc577a4SJonathan Peyton #include "tsan_annotations.h"
257cc577a4SJonathan Peyton 
267cc577a4SJonathan Peyton /* forward declaration */
273041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
283041982dSJonathan Peyton                                  kmp_info_t *this_thr);
293041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
303041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data);
313041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
323041982dSJonathan Peyton                                            kmp_task_team_t *task_team);
337cc577a4SJonathan Peyton 
347cc577a4SJonathan Peyton #ifdef OMP_45_ENABLED
357cc577a4SJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask);
367cc577a4SJonathan Peyton #endif
377cc577a4SJonathan Peyton 
387cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
397cc577a4SJonathan Peyton 
407cc577a4SJonathan Peyton //  __kmp_trace_task_stack: print the tied tasks from the task stack in order
417cc577a4SJonathan Peyton //  from top do bottom
427cc577a4SJonathan Peyton //
437cc577a4SJonathan Peyton //  gtid: global thread identifier for thread containing stack
447cc577a4SJonathan Peyton //  thread_data: thread data for task team thread containing stack
457cc577a4SJonathan Peyton //  threshold: value above which the trace statement triggers
467cc577a4SJonathan Peyton //  location: string identifying call site of this function (for trace)
473041982dSJonathan Peyton static void __kmp_trace_task_stack(kmp_int32 gtid,
483041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data,
493041982dSJonathan Peyton                                    int threshold, char *location) {
507cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
517cc577a4SJonathan Peyton   kmp_taskdata_t **stack_top = task_stack->ts_top;
527cc577a4SJonathan Peyton   kmp_int32 entries = task_stack->ts_entries;
537cc577a4SJonathan Peyton   kmp_taskdata_t *tied_task;
547cc577a4SJonathan Peyton 
553041982dSJonathan Peyton   KA_TRACE(
563041982dSJonathan Peyton       threshold,
573041982dSJonathan Peyton       ("__kmp_trace_task_stack(start): location = %s, gtid = %d, entries = %d, "
587cc577a4SJonathan Peyton        "first_block = %p, stack_top = %p \n",
597cc577a4SJonathan Peyton        location, gtid, entries, task_stack->ts_first_block, stack_top));
607cc577a4SJonathan Peyton 
617cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(stack_top != NULL);
627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(entries > 0);
637cc577a4SJonathan Peyton 
643041982dSJonathan Peyton   while (entries != 0) {
657cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(stack_top != &task_stack->ts_first_block.sb_block[0]);
667cc577a4SJonathan Peyton     // fix up ts_top if we need to pop from previous block
673041982dSJonathan Peyton     if (entries & TASK_STACK_INDEX_MASK == 0) {
687cc577a4SJonathan Peyton       kmp_stack_block_t *stack_block = (kmp_stack_block_t *)(stack_top);
697cc577a4SJonathan Peyton 
707cc577a4SJonathan Peyton       stack_block = stack_block->sb_prev;
717cc577a4SJonathan Peyton       stack_top = &stack_block->sb_block[TASK_STACK_BLOCK_SIZE];
727cc577a4SJonathan Peyton     }
737cc577a4SJonathan Peyton 
747cc577a4SJonathan Peyton     // finish bookkeeping
757cc577a4SJonathan Peyton     stack_top--;
767cc577a4SJonathan Peyton     entries--;
777cc577a4SJonathan Peyton 
787cc577a4SJonathan Peyton     tied_task = *stack_top;
797cc577a4SJonathan Peyton 
807cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(tied_task != NULL);
817cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
827cc577a4SJonathan Peyton 
833041982dSJonathan Peyton     KA_TRACE(threshold,
843041982dSJonathan Peyton              ("__kmp_trace_task_stack(%s):             gtid=%d, entry=%d, "
857cc577a4SJonathan Peyton               "stack_top=%p, tied_task=%p\n",
867cc577a4SJonathan Peyton               location, gtid, entries, stack_top, tied_task));
877cc577a4SJonathan Peyton   }
887cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(stack_top == &task_stack->ts_first_block.sb_block[0]);
897cc577a4SJonathan Peyton 
903041982dSJonathan Peyton   KA_TRACE(threshold,
913041982dSJonathan Peyton            ("__kmp_trace_task_stack(exit): location = %s, gtid = %d\n",
927cc577a4SJonathan Peyton             location, gtid));
937cc577a4SJonathan Peyton }
947cc577a4SJonathan Peyton 
957cc577a4SJonathan Peyton //  __kmp_init_task_stack: initialize the task stack for the first time
967cc577a4SJonathan Peyton //  after a thread_data structure is created.
977cc577a4SJonathan Peyton //  It should not be necessary to do this again (assuming the stack works).
987cc577a4SJonathan Peyton //
997cc577a4SJonathan Peyton //  gtid: global thread identifier of calling thread
1007cc577a4SJonathan Peyton //  thread_data: thread data for task team thread containing stack
1013041982dSJonathan Peyton static void __kmp_init_task_stack(kmp_int32 gtid,
1023041982dSJonathan Peyton                                   kmp_thread_data_t *thread_data) {
1037cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1047cc577a4SJonathan Peyton   kmp_stack_block_t *first_block;
1057cc577a4SJonathan Peyton 
1067cc577a4SJonathan Peyton   // set up the first block of the stack
1077cc577a4SJonathan Peyton   first_block = &task_stack->ts_first_block;
1087cc577a4SJonathan Peyton   task_stack->ts_top = (kmp_taskdata_t **)first_block;
1093041982dSJonathan Peyton   memset((void *)first_block, '\0',
1103041982dSJonathan Peyton          TASK_STACK_BLOCK_SIZE * sizeof(kmp_taskdata_t *));
1117cc577a4SJonathan Peyton 
1127cc577a4SJonathan Peyton   // initialize the stack to be empty
1137cc577a4SJonathan Peyton   task_stack->ts_entries = TASK_STACK_EMPTY;
1147cc577a4SJonathan Peyton   first_block->sb_next = NULL;
1157cc577a4SJonathan Peyton   first_block->sb_prev = NULL;
1167cc577a4SJonathan Peyton }
1177cc577a4SJonathan Peyton 
1187cc577a4SJonathan Peyton //  __kmp_free_task_stack: free the task stack when thread_data is destroyed.
1197cc577a4SJonathan Peyton //
1207cc577a4SJonathan Peyton //  gtid: global thread identifier for calling thread
1217cc577a4SJonathan Peyton //  thread_data: thread info for thread containing stack
1223041982dSJonathan Peyton static void __kmp_free_task_stack(kmp_int32 gtid,
1233041982dSJonathan Peyton                                   kmp_thread_data_t *thread_data) {
1247cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1257cc577a4SJonathan Peyton   kmp_stack_block_t *stack_block = &task_stack->ts_first_block;
1267cc577a4SJonathan Peyton 
1277cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_entries == TASK_STACK_EMPTY);
1287cc577a4SJonathan Peyton   // free from the second block of the stack
1297cc577a4SJonathan Peyton   while (stack_block != NULL) {
1307cc577a4SJonathan Peyton     kmp_stack_block_t *next_block = (stack_block) ? stack_block->sb_next : NULL;
1317cc577a4SJonathan Peyton 
1327cc577a4SJonathan Peyton     stack_block->sb_next = NULL;
1337cc577a4SJonathan Peyton     stack_block->sb_prev = NULL;
1347cc577a4SJonathan Peyton     if (stack_block != &task_stack->ts_first_block) {
1353041982dSJonathan Peyton       __kmp_thread_free(thread,
1363041982dSJonathan Peyton                         stack_block); // free the block, if not the first
1377cc577a4SJonathan Peyton     }
1387cc577a4SJonathan Peyton     stack_block = next_block;
1397cc577a4SJonathan Peyton   }
1407cc577a4SJonathan Peyton   // initialize the stack to be empty
1417cc577a4SJonathan Peyton   task_stack->ts_entries = 0;
1427cc577a4SJonathan Peyton   task_stack->ts_top = NULL;
1437cc577a4SJonathan Peyton }
1447cc577a4SJonathan Peyton 
1457cc577a4SJonathan Peyton //  __kmp_push_task_stack: Push the tied task onto the task stack.
1467cc577a4SJonathan Peyton //     Grow the stack if necessary by allocating another block.
1477cc577a4SJonathan Peyton //
1487cc577a4SJonathan Peyton //  gtid: global thread identifier for calling thread
1497cc577a4SJonathan Peyton //  thread: thread info for thread containing stack
1507cc577a4SJonathan Peyton //  tied_task: the task to push on the stack
1513041982dSJonathan Peyton static void __kmp_push_task_stack(kmp_int32 gtid, kmp_info_t *thread,
1523041982dSJonathan Peyton                                   kmp_taskdata_t *tied_task) {
1537cc577a4SJonathan Peyton   // GEH - need to consider what to do if tt_threads_data not allocated yet
1543041982dSJonathan Peyton   kmp_thread_data_t *thread_data =
1553041982dSJonathan Peyton       &thread->th.th_task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
1567cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
1577cc577a4SJonathan Peyton 
1587cc577a4SJonathan Peyton   if (tied_task->td_flags.team_serial || tied_task->td_flags.tasking_ser) {
1597cc577a4SJonathan Peyton     return; // Don't push anything on stack if team or team tasks are serialized
1607cc577a4SJonathan Peyton   }
1617cc577a4SJonathan Peyton 
1627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
1637cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_top != NULL);
1647cc577a4SJonathan Peyton 
1653041982dSJonathan Peyton   KA_TRACE(20,
1663041982dSJonathan Peyton            ("__kmp_push_task_stack(enter): GTID: %d; THREAD: %p; TASK: %p\n",
1677cc577a4SJonathan Peyton             gtid, thread, tied_task));
1687cc577a4SJonathan Peyton   // Store entry
1697cc577a4SJonathan Peyton   *(task_stack->ts_top) = tied_task;
1707cc577a4SJonathan Peyton 
1717cc577a4SJonathan Peyton   // Do bookkeeping for next push
1727cc577a4SJonathan Peyton   task_stack->ts_top++;
1737cc577a4SJonathan Peyton   task_stack->ts_entries++;
1747cc577a4SJonathan Peyton 
1753041982dSJonathan Peyton   if (task_stack->ts_entries & TASK_STACK_INDEX_MASK == 0) {
1767cc577a4SJonathan Peyton     // Find beginning of this task block
1777cc577a4SJonathan Peyton     kmp_stack_block_t *stack_block =
1787cc577a4SJonathan Peyton         (kmp_stack_block_t *)(task_stack->ts_top - TASK_STACK_BLOCK_SIZE);
1797cc577a4SJonathan Peyton 
1807cc577a4SJonathan Peyton     // Check if we already have a block
1813041982dSJonathan Peyton     if (stack_block->sb_next !=
1823041982dSJonathan Peyton         NULL) { // reset ts_top to beginning of next block
1837cc577a4SJonathan Peyton       task_stack->ts_top = &stack_block->sb_next->sb_block[0];
1843041982dSJonathan Peyton     } else { // Alloc new block and link it up
1853041982dSJonathan Peyton       kmp_stack_block_t *new_block = (kmp_stack_block_t *)__kmp_thread_calloc(
1863041982dSJonathan Peyton           thread, sizeof(kmp_stack_block_t));
1877cc577a4SJonathan Peyton 
1887cc577a4SJonathan Peyton       task_stack->ts_top = &new_block->sb_block[0];
1897cc577a4SJonathan Peyton       stack_block->sb_next = new_block;
1907cc577a4SJonathan Peyton       new_block->sb_prev = stack_block;
1917cc577a4SJonathan Peyton       new_block->sb_next = NULL;
1927cc577a4SJonathan Peyton 
1933041982dSJonathan Peyton       KA_TRACE(
1943041982dSJonathan Peyton           30,
1953041982dSJonathan Peyton           ("__kmp_push_task_stack(): GTID: %d; TASK: %p; Alloc new block: %p\n",
1967cc577a4SJonathan Peyton            gtid, tied_task, new_block));
1977cc577a4SJonathan Peyton     }
1987cc577a4SJonathan Peyton   }
1993041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_push_task_stack(exit): GTID: %d; TASK: %p\n", gtid,
2003041982dSJonathan Peyton                 tied_task));
2017cc577a4SJonathan Peyton }
2027cc577a4SJonathan Peyton 
2037cc577a4SJonathan Peyton //  __kmp_pop_task_stack: Pop the tied task from the task stack.  Don't return
2047cc577a4SJonathan Peyton //  the task, just check to make sure it matches the ending task passed in.
2057cc577a4SJonathan Peyton //
2067cc577a4SJonathan Peyton //  gtid: global thread identifier for the calling thread
2077cc577a4SJonathan Peyton //  thread: thread info structure containing stack
2087cc577a4SJonathan Peyton //  tied_task: the task popped off the stack
2097cc577a4SJonathan Peyton //  ending_task: the task that is ending (should match popped task)
2103041982dSJonathan Peyton static void __kmp_pop_task_stack(kmp_int32 gtid, kmp_info_t *thread,
2113041982dSJonathan Peyton                                  kmp_taskdata_t *ending_task) {
2127cc577a4SJonathan Peyton   // GEH - need to consider what to do if tt_threads_data not allocated yet
2133041982dSJonathan Peyton   kmp_thread_data_t *thread_data =
2143041982dSJonathan Peyton       &thread->th.th_task_team->tt_threads_data[__kmp_tid_from_gtid(gtid)];
2157cc577a4SJonathan Peyton   kmp_task_stack_t *task_stack = &thread_data->td.td_susp_tied_tasks;
2167cc577a4SJonathan Peyton   kmp_taskdata_t *tied_task;
2177cc577a4SJonathan Peyton 
2187cc577a4SJonathan Peyton   if (ending_task->td_flags.team_serial || ending_task->td_flags.tasking_ser) {
2193041982dSJonathan Peyton     // Don't pop anything from stack if team or team tasks are serialized
2203041982dSJonathan Peyton     return;
2217cc577a4SJonathan Peyton   }
2227cc577a4SJonathan Peyton 
2237cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_top != NULL);
2247cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_stack->ts_entries > 0);
2257cc577a4SJonathan Peyton 
2263041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_pop_task_stack(enter): GTID: %d; THREAD: %p\n", gtid,
2273041982dSJonathan Peyton                 thread));
2287cc577a4SJonathan Peyton 
2297cc577a4SJonathan Peyton   // fix up ts_top if we need to pop from previous block
2303041982dSJonathan Peyton   if (task_stack->ts_entries & TASK_STACK_INDEX_MASK == 0) {
2313041982dSJonathan Peyton     kmp_stack_block_t *stack_block = (kmp_stack_block_t *)(task_stack->ts_top);
2327cc577a4SJonathan Peyton 
2337cc577a4SJonathan Peyton     stack_block = stack_block->sb_prev;
2347cc577a4SJonathan Peyton     task_stack->ts_top = &stack_block->sb_block[TASK_STACK_BLOCK_SIZE];
2357cc577a4SJonathan Peyton   }
2367cc577a4SJonathan Peyton 
2377cc577a4SJonathan Peyton   // finish bookkeeping
2387cc577a4SJonathan Peyton   task_stack->ts_top--;
2397cc577a4SJonathan Peyton   task_stack->ts_entries--;
2407cc577a4SJonathan Peyton 
2417cc577a4SJonathan Peyton   tied_task = *(task_stack->ts_top);
2427cc577a4SJonathan Peyton 
2437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task != NULL);
2447cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task->td_flags.tasktype == TASK_TIED);
2457cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tied_task == ending_task); // If we built the stack correctly
2467cc577a4SJonathan Peyton 
2473041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_pop_task_stack(exit): GTID: %d; TASK: %p\n", gtid,
2483041982dSJonathan Peyton                 tied_task));
2497cc577a4SJonathan Peyton   return;
2507cc577a4SJonathan Peyton }
2517cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
2527cc577a4SJonathan Peyton 
2537cc577a4SJonathan Peyton //  __kmp_push_task: Add a task to the thread's deque
2543041982dSJonathan Peyton static kmp_int32 __kmp_push_task(kmp_int32 gtid, kmp_task_t *task) {
2557cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
2567cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
2577cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
2587cc577a4SJonathan Peyton   kmp_int32 tid = __kmp_tid_from_gtid(gtid);
2597cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
2607cc577a4SJonathan Peyton 
2613041982dSJonathan Peyton   KA_TRACE(20,
2623041982dSJonathan Peyton            ("__kmp_push_task: T#%d trying to push task %p.\n", gtid, taskdata));
2637cc577a4SJonathan Peyton 
2647cc577a4SJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_UNTIED) {
2653041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
2663041982dSJonathan Peyton     // freed prematurely
26737e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
268*baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
2693041982dSJonathan Peyton     KA_TRACE(
2703041982dSJonathan Peyton         20,
2713041982dSJonathan Peyton         ("__kmp_push_task: T#%d untied_count (%d) incremented for task %p\n",
2727cc577a4SJonathan Peyton          gtid, counter, taskdata));
2737cc577a4SJonathan Peyton   }
2747cc577a4SJonathan Peyton 
2757cc577a4SJonathan Peyton   // The first check avoids building task_team thread data if serialized
2767cc577a4SJonathan Peyton   if (taskdata->td_flags.task_serial) {
2773041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_push_task: T#%d team serialized; returning "
2783041982dSJonathan Peyton                   "TASK_NOT_PUSHED for task %p\n",
2797cc577a4SJonathan Peyton                   gtid, taskdata));
2807cc577a4SJonathan Peyton     return TASK_NOT_PUSHED;
2817cc577a4SJonathan Peyton   }
2827cc577a4SJonathan Peyton 
2833041982dSJonathan Peyton   // Now that serialized tasks have returned, we can assume that we are not in
2843041982dSJonathan Peyton   // immediate exec mode
2857cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
2867cc577a4SJonathan Peyton   if (!KMP_TASKING_ENABLED(task_team)) {
2877cc577a4SJonathan Peyton     __kmp_enable_tasking(task_team, thread);
2887cc577a4SJonathan Peyton   }
2897cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(task_team->tt.tt_found_tasks) == TRUE);
2907cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_PTR(task_team->tt.tt_threads_data) != NULL);
2917cc577a4SJonathan Peyton 
2927cc577a4SJonathan Peyton   // Find tasking deque specific to encountering thread
2937cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[tid];
2947cc577a4SJonathan Peyton 
2957cc577a4SJonathan Peyton   // No lock needed since only owner can allocate
2967cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
2977cc577a4SJonathan Peyton     __kmp_alloc_task_deque(thread, thread_data);
2987cc577a4SJonathan Peyton   }
2997cc577a4SJonathan Peyton 
3007cc577a4SJonathan Peyton   // Check if deque is full
3013041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
3023041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
3033041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_push_task: T#%d deque is full; returning "
3043041982dSJonathan Peyton                   "TASK_NOT_PUSHED for task %p\n",
3057cc577a4SJonathan Peyton                   gtid, taskdata));
3067cc577a4SJonathan Peyton     return TASK_NOT_PUSHED;
3077cc577a4SJonathan Peyton   }
3087cc577a4SJonathan Peyton 
3097cc577a4SJonathan Peyton   // Lock the deque for the task push operation
3107cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
3117cc577a4SJonathan Peyton 
3127cc577a4SJonathan Peyton #if OMP_45_ENABLED
3137cc577a4SJonathan Peyton   // Need to recheck as we can get a proxy task from a thread outside of OpenMP
3143041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
3153041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
3167cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
3173041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_push_task: T#%d deque is full on 2nd check; returning "
3183041982dSJonathan Peyton                   "TASK_NOT_PUSHED for task %p\n",
3197cc577a4SJonathan Peyton                   gtid, taskdata));
3207cc577a4SJonathan Peyton     return TASK_NOT_PUSHED;
3217cc577a4SJonathan Peyton   }
3227cc577a4SJonathan Peyton #else
3237cc577a4SJonathan Peyton   // Must have room since no thread can add tasks but calling thread
3243041982dSJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) <
3253041982dSJonathan Peyton                    TASK_DEQUE_SIZE(thread_data->td));
3267cc577a4SJonathan Peyton #endif
3277cc577a4SJonathan Peyton 
3283041982dSJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] =
3293041982dSJonathan Peyton       taskdata; // Push taskdata
3307cc577a4SJonathan Peyton   // Wrap index.
3313041982dSJonathan Peyton   thread_data->td.td_deque_tail =
3323041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
3333041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
3343041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1); // Adjust task count
3357cc577a4SJonathan Peyton 
3367cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_push_task: T#%d returning TASK_SUCCESSFULLY_PUSHED: "
3377cc577a4SJonathan Peyton                 "task=%p ntasks=%d head=%u tail=%u\n",
3387cc577a4SJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
3397cc577a4SJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
3407cc577a4SJonathan Peyton 
3417cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
3427cc577a4SJonathan Peyton 
3437cc577a4SJonathan Peyton   return TASK_SUCCESSFULLY_PUSHED;
3447cc577a4SJonathan Peyton }
3457cc577a4SJonathan Peyton 
3463041982dSJonathan Peyton // __kmp_pop_current_task_from_thread: set up current task from called thread
3473041982dSJonathan Peyton // when team ends
3483041982dSJonathan Peyton //
3497cc577a4SJonathan Peyton // this_thr: thread structure to set current_task in.
3503041982dSJonathan Peyton void __kmp_pop_current_task_from_thread(kmp_info_t *this_thr) {
3513041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(enter): T#%d "
3523041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
3537cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
3547cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
3557cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
3567cc577a4SJonathan Peyton 
3577cc577a4SJonathan Peyton   this_thr->th.th_current_task = this_thr->th.th_current_task->td_parent;
3587cc577a4SJonathan Peyton 
3593041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_pop_current_task_from_thread(exit): T#%d "
3603041982dSJonathan Peyton                 "this_thread=%p, curtask=%p, "
3617cc577a4SJonathan Peyton                 "curtask_parent=%p\n",
3627cc577a4SJonathan Peyton                 0, this_thr, this_thr->th.th_current_task,
3637cc577a4SJonathan Peyton                 this_thr->th.th_current_task->td_parent));
3647cc577a4SJonathan Peyton }
3657cc577a4SJonathan Peyton 
3663041982dSJonathan Peyton // __kmp_push_current_task_to_thread: set up current task in called thread for a
3673041982dSJonathan Peyton // new team
3683041982dSJonathan Peyton //
3697cc577a4SJonathan Peyton // this_thr: thread structure to set up
3707cc577a4SJonathan Peyton // team: team for implicit task data
3717cc577a4SJonathan Peyton // tid: thread within team to set up
3723041982dSJonathan Peyton void __kmp_push_current_task_to_thread(kmp_info_t *this_thr, kmp_team_t *team,
3733041982dSJonathan Peyton                                        int tid) {
3743041982dSJonathan Peyton   // current task of the thread is a parent of the new just created implicit
3753041982dSJonathan Peyton   // tasks of new team
3763041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(enter): T#%d this_thread=%p "
3773041982dSJonathan Peyton                 "curtask=%p "
3787cc577a4SJonathan Peyton                 "parent_task=%p\n",
3797cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
3807cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
3817cc577a4SJonathan Peyton 
3827cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr != NULL);
3837cc577a4SJonathan Peyton 
3847cc577a4SJonathan Peyton   if (tid == 0) {
3857cc577a4SJonathan Peyton     if (this_thr->th.th_current_task != &team->t.t_implicit_task_taskdata[0]) {
3863041982dSJonathan Peyton       team->t.t_implicit_task_taskdata[0].td_parent =
3873041982dSJonathan Peyton           this_thr->th.th_current_task;
3887cc577a4SJonathan Peyton       this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[0];
3897cc577a4SJonathan Peyton     }
3907cc577a4SJonathan Peyton   } else {
3913041982dSJonathan Peyton     team->t.t_implicit_task_taskdata[tid].td_parent =
3923041982dSJonathan Peyton         team->t.t_implicit_task_taskdata[0].td_parent;
3937cc577a4SJonathan Peyton     this_thr->th.th_current_task = &team->t.t_implicit_task_taskdata[tid];
3947cc577a4SJonathan Peyton   }
3957cc577a4SJonathan Peyton 
3963041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_push_current_task_to_thread(exit): T#%d this_thread=%p "
3973041982dSJonathan Peyton                 "curtask=%p "
3987cc577a4SJonathan Peyton                 "parent_task=%p\n",
3997cc577a4SJonathan Peyton                 tid, this_thr, this_thr->th.th_current_task,
4007cc577a4SJonathan Peyton                 team->t.t_implicit_task_taskdata[tid].td_parent));
4017cc577a4SJonathan Peyton }
4027cc577a4SJonathan Peyton 
4037cc577a4SJonathan Peyton // __kmp_task_start: bookkeeping for a task starting execution
4043041982dSJonathan Peyton //
4057cc577a4SJonathan Peyton // GTID: global thread id of calling thread
4067cc577a4SJonathan Peyton // task: task starting execution
4077cc577a4SJonathan Peyton // current_task: task suspending
4083041982dSJonathan Peyton static void __kmp_task_start(kmp_int32 gtid, kmp_task_t *task,
4093041982dSJonathan Peyton                              kmp_taskdata_t *current_task) {
4107cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
4117cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
4127cc577a4SJonathan Peyton 
4133041982dSJonathan Peyton   KA_TRACE(10,
4143041982dSJonathan Peyton            ("__kmp_task_start(enter): T#%d starting task %p: current_task=%p\n",
4157cc577a4SJonathan Peyton             gtid, taskdata, current_task));
4167cc577a4SJonathan Peyton 
4177cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
4187cc577a4SJonathan Peyton 
4197cc577a4SJonathan Peyton   // mark currently executing task as suspended
4207cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
4217cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( current_task -> td_flags.executing == 1 );
4227cc577a4SJonathan Peyton   current_task->td_flags.executing = 0;
4237cc577a4SJonathan Peyton 
4247cc577a4SJonathan Peyton // Add task to stack if tied
4257cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
4263041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
4277cc577a4SJonathan Peyton     __kmp_push_task_stack(gtid, thread, taskdata);
4287cc577a4SJonathan Peyton   }
4297cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
4307cc577a4SJonathan Peyton 
4317cc577a4SJonathan Peyton   // mark starting task as executing and as current task
4327cc577a4SJonathan Peyton   thread->th.th_current_task = taskdata;
4337cc577a4SJonathan Peyton 
4343041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 0 ||
4353041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
4363041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0 ||
4373041982dSJonathan Peyton                    taskdata->td_flags.tiedness == TASK_UNTIED);
4387cc577a4SJonathan Peyton   taskdata->td_flags.started = 1;
4397cc577a4SJonathan Peyton   taskdata->td_flags.executing = 1;
4407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
4417cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
4427cc577a4SJonathan Peyton 
4437cc577a4SJonathan Peyton   // GEH TODO: shouldn't we pass some sort of location identifier here?
4447cc577a4SJonathan Peyton   // APT: yes, we will pass location here.
4457cc577a4SJonathan Peyton   // need to store current thread state (in a thread or taskdata structure)
4467cc577a4SJonathan Peyton   // before setting work_state, otherwise wrong state is set after end of task
4477cc577a4SJonathan Peyton 
4483041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_start(exit): T#%d task=%p\n", gtid, taskdata));
4497cc577a4SJonathan Peyton 
4507cc577a4SJonathan Peyton   return;
4517cc577a4SJonathan Peyton }
4527cc577a4SJonathan Peyton 
45382e94a59SJoachim Protze #if OMPT_SUPPORT
45482e94a59SJoachim Protze //------------------------------------------------------------------------------
45582e94a59SJoachim Protze // __ompt_task_init:
45682e94a59SJoachim Protze //   Initialize OMPT fields maintained by a task. This will only be called after
45782e94a59SJoachim Protze //   ompt_start_tool, so we already know whether ompt is enabled or not.
45882e94a59SJoachim Protze 
45982e94a59SJoachim Protze static inline void __ompt_task_init(kmp_taskdata_t *task, int tid) {
46082e94a59SJoachim Protze   // The calls to __ompt_task_init already have the ompt_enabled condition.
46182e94a59SJoachim Protze   task->ompt_task_info.task_data.value = 0;
462c255ca70SJoachim Protze   task->ompt_task_info.frame.exit_frame = NULL;
463c255ca70SJoachim Protze   task->ompt_task_info.frame.enter_frame = NULL;
46482e94a59SJoachim Protze #if OMP_40_ENABLED
46582e94a59SJoachim Protze   task->ompt_task_info.ndeps = 0;
46682e94a59SJoachim Protze   task->ompt_task_info.deps = NULL;
46782e94a59SJoachim Protze #endif /* OMP_40_ENABLED */
46882e94a59SJoachim Protze }
46982e94a59SJoachim Protze 
47082e94a59SJoachim Protze // __ompt_task_start:
47182e94a59SJoachim Protze //   Build and trigger task-begin event
47282e94a59SJoachim Protze static inline void __ompt_task_start(kmp_task_t *task,
47382e94a59SJoachim Protze                                      kmp_taskdata_t *current_task,
47482e94a59SJoachim Protze                                      kmp_int32 gtid) {
47582e94a59SJoachim Protze   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
47682e94a59SJoachim Protze   ompt_task_status_t status = ompt_task_others;
47782e94a59SJoachim Protze   if (__kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded) {
47882e94a59SJoachim Protze     status = ompt_task_yield;
47982e94a59SJoachim Protze     __kmp_threads[gtid]->th.ompt_thread_info.ompt_task_yielded = 0;
48082e94a59SJoachim Protze   }
48182e94a59SJoachim Protze   /* let OMPT know that we're about to run this task */
48282e94a59SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
48382e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
48482e94a59SJoachim Protze         &(current_task->ompt_task_info.task_data), status,
48582e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data));
48682e94a59SJoachim Protze   }
48782e94a59SJoachim Protze   taskdata->ompt_task_info.scheduling_parent = current_task;
48882e94a59SJoachim Protze }
48982e94a59SJoachim Protze 
49082e94a59SJoachim Protze // __ompt_task_finish:
49182e94a59SJoachim Protze //   Build and trigger final task-schedule event
49286ed6aa6SJoachim Protze static inline void
49386ed6aa6SJoachim Protze __ompt_task_finish(kmp_task_t *task, kmp_taskdata_t *resumed_task,
49486ed6aa6SJoachim Protze                    ompt_task_status_t status = ompt_task_complete) {
49582e94a59SJoachim Protze   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
49682e94a59SJoachim Protze   if (__kmp_omp_cancellation && taskdata->td_taskgroup &&
49782e94a59SJoachim Protze       taskdata->td_taskgroup->cancel_request == cancel_taskgroup) {
49882e94a59SJoachim Protze     status = ompt_task_cancel;
49982e94a59SJoachim Protze   }
50082e94a59SJoachim Protze 
50182e94a59SJoachim Protze   /* let OMPT know that we're returning to the callee task */
50282e94a59SJoachim Protze   if (ompt_enabled.ompt_callback_task_schedule) {
50382e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_task_schedule)(
50482e94a59SJoachim Protze         &(taskdata->ompt_task_info.task_data), status,
50582e94a59SJoachim Protze         &((resumed_task ? resumed_task
50682e94a59SJoachim Protze                         : (taskdata->ompt_task_info.scheduling_parent
50782e94a59SJoachim Protze                                ? taskdata->ompt_task_info.scheduling_parent
50882e94a59SJoachim Protze                                : taskdata->td_parent))
50982e94a59SJoachim Protze               ->ompt_task_info.task_data));
51082e94a59SJoachim Protze   }
51182e94a59SJoachim Protze }
51282e94a59SJoachim Protze #endif
51382e94a59SJoachim Protze 
51482e94a59SJoachim Protze template <bool ompt>
51582e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_template(ident_t *loc_ref, kmp_int32 gtid,
51682e94a59SJoachim Protze                                                kmp_task_t *task,
51782e94a59SJoachim Protze                                                void *frame_address,
51882e94a59SJoachim Protze                                                void *return_address) {
5197cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
5207cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
5217cc577a4SJonathan Peyton 
5223041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(enter): T#%d loc=%p task=%p "
5233041982dSJonathan Peyton                 "current_task=%p\n",
5247cc577a4SJonathan Peyton                 gtid, loc_ref, taskdata, current_task));
5257cc577a4SJonathan Peyton 
5267cc577a4SJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_UNTIED) {
5273041982dSJonathan Peyton     // untied task needs to increment counter so that the task structure is not
5283041982dSJonathan Peyton     // freed prematurely
52937e2ef54SJonathan Peyton     kmp_int32 counter = 1 + KMP_ATOMIC_INC(&taskdata->td_untied_count);
530*baad3f60SJonathan Peyton     KMP_DEBUG_USE_VAR(counter);
5313041982dSJonathan Peyton     KA_TRACE(20, ("__kmpc_omp_task_begin_if0: T#%d untied_count (%d) "
5323041982dSJonathan Peyton                   "incremented for task %p\n",
5337cc577a4SJonathan Peyton                   gtid, counter, taskdata));
5347cc577a4SJonathan Peyton   }
5357cc577a4SJonathan Peyton 
5363041982dSJonathan Peyton   taskdata->td_flags.task_serial =
5373041982dSJonathan Peyton       1; // Execute this task immediately, not deferred.
5387cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
5397cc577a4SJonathan Peyton 
54082e94a59SJoachim Protze #if OMPT_SUPPORT
54182e94a59SJoachim Protze   if (ompt) {
542c255ca70SJoachim Protze     if (current_task->ompt_task_info.frame.enter_frame == NULL) {
543c255ca70SJoachim Protze       current_task->ompt_task_info.frame.enter_frame =
544c255ca70SJoachim Protze           taskdata->ompt_task_info.frame.exit_frame = frame_address;
54582e94a59SJoachim Protze     }
54682e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
54782e94a59SJoachim Protze       ompt_task_info_t *parent_info = &(current_task->ompt_task_info);
54882e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
54982e94a59SJoachim Protze           &(parent_info->task_data), &(parent_info->frame),
55082e94a59SJoachim Protze           &(taskdata->ompt_task_info.task_data),
55182e94a59SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(taskdata), 0,
55282e94a59SJoachim Protze           return_address);
55382e94a59SJoachim Protze     }
55482e94a59SJoachim Protze     __ompt_task_start(task, current_task, gtid);
55582e94a59SJoachim Protze   }
55682e94a59SJoachim Protze #endif // OMPT_SUPPORT
55782e94a59SJoachim Protze 
5583041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin_if0(exit): T#%d loc=%p task=%p,\n", gtid,
5593041982dSJonathan Peyton                 loc_ref, taskdata));
56082e94a59SJoachim Protze }
5617cc577a4SJonathan Peyton 
56282e94a59SJoachim Protze #if OMPT_SUPPORT
56382e94a59SJoachim Protze OMPT_NOINLINE
56482e94a59SJoachim Protze static void __kmpc_omp_task_begin_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
56582e94a59SJoachim Protze                                            kmp_task_t *task,
56682e94a59SJoachim Protze                                            void *frame_address,
56782e94a59SJoachim Protze                                            void *return_address) {
568f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<true>(loc_ref, gtid, task, frame_address,
569f0a1c65fSJonas Hahnfeld                                            return_address);
57082e94a59SJoachim Protze }
57182e94a59SJoachim Protze #endif // OMPT_SUPPORT
57282e94a59SJoachim Protze 
57382e94a59SJoachim Protze // __kmpc_omp_task_begin_if0: report that a given serialized task has started
57482e94a59SJoachim Protze // execution
57582e94a59SJoachim Protze //
57682e94a59SJoachim Protze // loc_ref: source location information; points to beginning of task block.
57782e94a59SJoachim Protze // gtid: global thread number.
57882e94a59SJoachim Protze // task: task thunk for the started task.
57982e94a59SJoachim Protze void __kmpc_omp_task_begin_if0(ident_t *loc_ref, kmp_int32 gtid,
58082e94a59SJoachim Protze                                kmp_task_t *task) {
58182e94a59SJoachim Protze #if OMPT_SUPPORT
58282e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
58382e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
58482e94a59SJoachim Protze     __kmpc_omp_task_begin_if0_ompt(loc_ref, gtid, task,
58582e94a59SJoachim Protze                                    OMPT_GET_FRAME_ADDRESS(1),
58682e94a59SJoachim Protze                                    OMPT_LOAD_RETURN_ADDRESS(gtid));
5877cc577a4SJonathan Peyton     return;
5887cc577a4SJonathan Peyton   }
58982e94a59SJoachim Protze #endif
590f0a1c65fSJonas Hahnfeld   __kmpc_omp_task_begin_if0_template<false>(loc_ref, gtid, task, NULL, NULL);
59182e94a59SJoachim Protze }
5927cc577a4SJonathan Peyton 
5937cc577a4SJonathan Peyton #ifdef TASK_UNUSED
5947cc577a4SJonathan Peyton // __kmpc_omp_task_begin: report that a given task has started execution
5957cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
5963041982dSJonathan Peyton void __kmpc_omp_task_begin(ident_t *loc_ref, kmp_int32 gtid, kmp_task_t *task) {
5977cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
5987cc577a4SJonathan Peyton 
5993041982dSJonathan Peyton   KA_TRACE(
6003041982dSJonathan Peyton       10,
6013041982dSJonathan Peyton       ("__kmpc_omp_task_begin(enter): T#%d loc=%p task=%p current_task=%p\n",
6027cc577a4SJonathan Peyton        gtid, loc_ref, KMP_TASK_TO_TASKDATA(task), current_task));
6037cc577a4SJonathan Peyton 
6047cc577a4SJonathan Peyton   __kmp_task_start(gtid, task, current_task);
6057cc577a4SJonathan Peyton 
6063041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_begin(exit): T#%d loc=%p task=%p,\n", gtid,
6073041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
6087cc577a4SJonathan Peyton   return;
6097cc577a4SJonathan Peyton }
6107cc577a4SJonathan Peyton #endif // TASK_UNUSED
6117cc577a4SJonathan Peyton 
6127cc577a4SJonathan Peyton // __kmp_free_task: free the current task space and the space for shareds
6133041982dSJonathan Peyton //
6147cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
6157cc577a4SJonathan Peyton // taskdata: task to free
6167cc577a4SJonathan Peyton // thread: thread data structure of caller
6173041982dSJonathan Peyton static void __kmp_free_task(kmp_int32 gtid, kmp_taskdata_t *taskdata,
6183041982dSJonathan Peyton                             kmp_info_t *thread) {
6193041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_free_task: T#%d freeing data from task %p\n", gtid,
6203041982dSJonathan Peyton                 taskdata));
6217cc577a4SJonathan Peyton 
6227cc577a4SJonathan Peyton   // Check to make sure all flags and counters have the correct values
6237cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
6247cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 0);
6257cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 1);
6267cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
62737e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_allocated_child_tasks == 0 ||
6283041982dSJonathan Peyton                    taskdata->td_flags.task_serial == 1);
62937e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_incomplete_child_tasks == 0);
6307cc577a4SJonathan Peyton 
6317cc577a4SJonathan Peyton   taskdata->td_flags.freed = 1;
6327cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(taskdata);
6337cc577a4SJonathan Peyton // deallocate the taskdata and shared variable blocks associated with this task
6347cc577a4SJonathan Peyton #if USE_FAST_MEMORY
6357cc577a4SJonathan Peyton   __kmp_fast_free(thread, taskdata);
6367cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
6377cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskdata);
6387cc577a4SJonathan Peyton #endif
6397cc577a4SJonathan Peyton 
6403041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_free_task: T#%d freed task %p\n", gtid, taskdata));
6417cc577a4SJonathan Peyton }
6427cc577a4SJonathan Peyton 
6433041982dSJonathan Peyton // __kmp_free_task_and_ancestors: free the current task and ancestors without
6443041982dSJonathan Peyton // children
6457cc577a4SJonathan Peyton //
6467cc577a4SJonathan Peyton // gtid: Global thread ID of calling thread
6477cc577a4SJonathan Peyton // taskdata: task to free
6487cc577a4SJonathan Peyton // thread: thread data structure of caller
6493041982dSJonathan Peyton static void __kmp_free_task_and_ancestors(kmp_int32 gtid,
6503041982dSJonathan Peyton                                           kmp_taskdata_t *taskdata,
6513041982dSJonathan Peyton                                           kmp_info_t *thread) {
6527cc577a4SJonathan Peyton #if OMP_45_ENABLED
6537cc577a4SJonathan Peyton   // Proxy tasks must always be allowed to free their parents
6547cc577a4SJonathan Peyton   // because they can be run in background even in serial mode.
6553041982dSJonathan Peyton   kmp_int32 team_serial =
6563041982dSJonathan Peyton       (taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) &&
6573041982dSJonathan Peyton       !taskdata->td_flags.proxy;
6587cc577a4SJonathan Peyton #else
6593041982dSJonathan Peyton   kmp_int32 team_serial =
6603041982dSJonathan Peyton       taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser;
6617cc577a4SJonathan Peyton #endif
6627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
6637cc577a4SJonathan Peyton 
66437e2ef54SJonathan Peyton   kmp_int32 children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
6657cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
6667cc577a4SJonathan Peyton 
6677cc577a4SJonathan Peyton   // Now, go up the ancestor tree to see if any ancestors can now be freed.
6683041982dSJonathan Peyton   while (children == 0) {
6697cc577a4SJonathan Peyton     kmp_taskdata_t *parent_taskdata = taskdata->td_parent;
6707cc577a4SJonathan Peyton 
6717cc577a4SJonathan Peyton     KA_TRACE(20, ("__kmp_free_task_and_ancestors(enter): T#%d task %p complete "
6723041982dSJonathan Peyton                   "and freeing itself\n",
6733041982dSJonathan Peyton                   gtid, taskdata));
6747cc577a4SJonathan Peyton 
6757cc577a4SJonathan Peyton     // --- Deallocate my ancestor task ---
6767cc577a4SJonathan Peyton     __kmp_free_task(gtid, taskdata, thread);
6777cc577a4SJonathan Peyton 
6787cc577a4SJonathan Peyton     taskdata = parent_taskdata;
6797cc577a4SJonathan Peyton 
6803041982dSJonathan Peyton     // Stop checking ancestors at implicit task instead of walking up ancestor
6813041982dSJonathan Peyton     // tree to avoid premature deallocation of ancestors.
6827cc577a4SJonathan Peyton     if (team_serial || taskdata->td_flags.tasktype == TASK_IMPLICIT)
6837cc577a4SJonathan Peyton       return;
6847cc577a4SJonathan Peyton 
6857cc577a4SJonathan Peyton     // Predecrement simulated by "- 1" calculation
68637e2ef54SJonathan Peyton     children = KMP_ATOMIC_DEC(&taskdata->td_allocated_child_tasks) - 1;
6877cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(children >= 0);
6887cc577a4SJonathan Peyton   }
6897cc577a4SJonathan Peyton 
6903041982dSJonathan Peyton   KA_TRACE(
6913041982dSJonathan Peyton       20, ("__kmp_free_task_and_ancestors(exit): T#%d task %p has %d children; "
6923041982dSJonathan Peyton            "not freeing it yet\n",
6933041982dSJonathan Peyton            gtid, taskdata, children));
6947cc577a4SJonathan Peyton }
6957cc577a4SJonathan Peyton 
6967cc577a4SJonathan Peyton // __kmp_task_finish: bookkeeping to do when a task finishes execution
6973041982dSJonathan Peyton //
6987cc577a4SJonathan Peyton // gtid: global thread ID for calling thread
6997cc577a4SJonathan Peyton // task: task to be finished
7007cc577a4SJonathan Peyton // resumed_task: task to be resumed.  (may be NULL if task is serialized)
70186ed6aa6SJoachim Protze template <bool ompt>
7023041982dSJonathan Peyton static void __kmp_task_finish(kmp_int32 gtid, kmp_task_t *task,
7033041982dSJonathan Peyton                               kmp_taskdata_t *resumed_task) {
7047cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
7057cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
7063041982dSJonathan Peyton   kmp_task_team_t *task_team =
7073041982dSJonathan Peyton       thread->th.th_task_team; // might be NULL for serial teams...
7087cc577a4SJonathan Peyton   kmp_int32 children = 0;
7097cc577a4SJonathan Peyton 
7103041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_finish(enter): T#%d finishing task %p and resuming "
7113041982dSJonathan Peyton                 "task %p\n",
7127cc577a4SJonathan Peyton                 gtid, taskdata, resumed_task));
7137cc577a4SJonathan Peyton 
7147cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
7157cc577a4SJonathan Peyton 
7167cc577a4SJonathan Peyton // Pop task from stack if tied
7177cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
7183041982dSJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_TIED) {
7197cc577a4SJonathan Peyton     __kmp_pop_task_stack(gtid, thread, taskdata);
7207cc577a4SJonathan Peyton   }
7217cc577a4SJonathan Peyton #endif /* BUILD_TIED_TASK_STACK */
7227cc577a4SJonathan Peyton 
7237cc577a4SJonathan Peyton   if (taskdata->td_flags.tiedness == TASK_UNTIED) {
7243041982dSJonathan Peyton     // untied task needs to check the counter so that the task structure is not
7253041982dSJonathan Peyton     // freed prematurely
72637e2ef54SJonathan Peyton     kmp_int32 counter = KMP_ATOMIC_DEC(&taskdata->td_untied_count) - 1;
7273041982dSJonathan Peyton     KA_TRACE(
7283041982dSJonathan Peyton         20,
7293041982dSJonathan Peyton         ("__kmp_task_finish: T#%d untied_count (%d) decremented for task %p\n",
7307cc577a4SJonathan Peyton          gtid, counter, taskdata));
7317cc577a4SJonathan Peyton     if (counter > 0) {
7323041982dSJonathan Peyton       // untied task is not done, to be continued possibly by other thread, do
7333041982dSJonathan Peyton       // not free it now
7347cc577a4SJonathan Peyton       if (resumed_task == NULL) {
7357cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(taskdata->td_flags.task_serial);
7363041982dSJonathan Peyton         resumed_task = taskdata->td_parent; // In a serialized task, the resumed
7373041982dSJonathan Peyton         // task is the parent
7387cc577a4SJonathan Peyton       }
7397cc577a4SJonathan Peyton       thread->th.th_current_task = resumed_task; // restore current_task
7407cc577a4SJonathan Peyton       resumed_task->td_flags.executing = 1; // resume previous task
7413041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_task_finish(exit): T#%d partially done task %p, "
7423041982dSJonathan Peyton                     "resuming task %p\n",
7437cc577a4SJonathan Peyton                     gtid, taskdata, resumed_task));
7447cc577a4SJonathan Peyton       return;
7457cc577a4SJonathan Peyton     }
7467cc577a4SJonathan Peyton   }
74786ed6aa6SJoachim Protze #if OMPT_SUPPORT
74886ed6aa6SJoachim Protze   if (ompt)
74986ed6aa6SJoachim Protze     __ompt_task_finish(task, resumed_task);
75086ed6aa6SJoachim Protze #endif
7517cc577a4SJonathan Peyton 
7527cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
7537cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
7547cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.started == 1);
7557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
7567cc577a4SJonathan Peyton 
7573041982dSJonathan Peyton   // Only need to keep track of count if team parallel and tasking not
7583041982dSJonathan Peyton   // serialized
7597cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
7607cc577a4SJonathan Peyton     // Predecrement simulated by "- 1" calculation
7613041982dSJonathan Peyton     children =
76237e2ef54SJonathan Peyton         KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
7637cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(children >= 0);
7647cc577a4SJonathan Peyton #if OMP_40_ENABLED
7657cc577a4SJonathan Peyton     if (taskdata->td_taskgroup)
76637e2ef54SJonathan Peyton       KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
7677cc577a4SJonathan Peyton #if OMP_45_ENABLED
7687cc577a4SJonathan Peyton   }
7697cc577a4SJonathan Peyton   // if we found proxy tasks there could exist a dependency chain
7707cc577a4SJonathan Peyton   // with the proxy task as origin
7713041982dSJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser) ||
7723041982dSJonathan Peyton       (task_team && task_team->tt.tt_found_proxy_tasks)) {
7737cc577a4SJonathan Peyton #endif
7747cc577a4SJonathan Peyton     __kmp_release_deps(gtid, taskdata);
7757cc577a4SJonathan Peyton #endif
7767cc577a4SJonathan Peyton   }
7777cc577a4SJonathan Peyton 
7783041982dSJonathan Peyton   // td_flags.executing must be marked as 0 after __kmp_release_deps has been
7793041982dSJonathan Peyton   // called. Othertwise, if a task is executed immediately from the release_deps
7803041982dSJonathan Peyton   // code, the flag will be reset to 1 again by this same function
7817cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.executing == 1);
7827cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0; // suspend the finishing task
7837cc577a4SJonathan Peyton 
7843041982dSJonathan Peyton   KA_TRACE(
7853041982dSJonathan Peyton       20, ("__kmp_task_finish: T#%d finished task %p, %d incomplete children\n",
7867cc577a4SJonathan Peyton            gtid, taskdata, children));
7877cc577a4SJonathan Peyton 
7887cc577a4SJonathan Peyton #if OMP_40_ENABLED
7897cc577a4SJonathan Peyton   /* If the tasks' destructor thunk flag has been set, we need to invoke the
7903041982dSJonathan Peyton      destructor thunk that has been generated by the compiler. The code is
7913041982dSJonathan Peyton      placed here, since at this point other tasks might have been released
7927cc577a4SJonathan Peyton      hence overlapping the destructor invokations with some other work in the
7933041982dSJonathan Peyton      released tasks.  The OpenMP spec is not specific on when the destructors
7943041982dSJonathan Peyton      are invoked, so we should be free to choose. */
7957cc577a4SJonathan Peyton   if (taskdata->td_flags.destructors_thunk) {
7967cc577a4SJonathan Peyton     kmp_routine_entry_t destr_thunk = task->data1.destructors;
7977cc577a4SJonathan Peyton     KMP_ASSERT(destr_thunk);
7987cc577a4SJonathan Peyton     destr_thunk(gtid, task);
7997cc577a4SJonathan Peyton   }
8007cc577a4SJonathan Peyton #endif // OMP_40_ENABLED
8017cc577a4SJonathan Peyton 
8027cc577a4SJonathan Peyton   // bookkeeping for resuming task:
8037cc577a4SJonathan Peyton   // GEH - note tasking_ser => task_serial
8043041982dSJonathan Peyton   KMP_DEBUG_ASSERT(
8053041982dSJonathan Peyton       (taskdata->td_flags.tasking_ser || taskdata->td_flags.task_serial) ==
8067cc577a4SJonathan Peyton       taskdata->td_flags.task_serial);
8073041982dSJonathan Peyton   if (taskdata->td_flags.task_serial) {
8087cc577a4SJonathan Peyton     if (resumed_task == NULL) {
8093041982dSJonathan Peyton       resumed_task = taskdata->td_parent; // In a serialized task, the resumed
8103041982dSJonathan Peyton       // task is the parent
8117cc577a4SJonathan Peyton     }
8123041982dSJonathan Peyton   } else {
8133041982dSJonathan Peyton     KMP_DEBUG_ASSERT(resumed_task !=
8143041982dSJonathan Peyton                      NULL); // verify that resumed task is passed as arguemnt
8157cc577a4SJonathan Peyton   }
8167cc577a4SJonathan Peyton 
8177cc577a4SJonathan Peyton   // Free this task and then ancestor tasks if they have no children.
8187cc577a4SJonathan Peyton   // Restore th_current_task first as suggested by John:
8197cc577a4SJonathan Peyton   // johnmc: if an asynchronous inquiry peers into the runtime system
8207cc577a4SJonathan Peyton   // it doesn't see the freed task as the current task.
8217cc577a4SJonathan Peyton   thread->th.th_current_task = resumed_task;
8227cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
8237cc577a4SJonathan Peyton 
8247cc577a4SJonathan Peyton   // TODO: GEH - make sure root team implicit task is initialized properly.
8257cc577a4SJonathan Peyton   // KMP_DEBUG_ASSERT( resumed_task->td_flags.executing == 0 );
8267cc577a4SJonathan Peyton   resumed_task->td_flags.executing = 1; // resume previous task
8277cc577a4SJonathan Peyton 
8283041982dSJonathan Peyton   KA_TRACE(
8293041982dSJonathan Peyton       10, ("__kmp_task_finish(exit): T#%d finished task %p, resuming task %p\n",
8307cc577a4SJonathan Peyton            gtid, taskdata, resumed_task));
8317cc577a4SJonathan Peyton 
8327cc577a4SJonathan Peyton   return;
8337cc577a4SJonathan Peyton }
8347cc577a4SJonathan Peyton 
83582e94a59SJoachim Protze template <bool ompt>
83682e94a59SJoachim Protze static void __kmpc_omp_task_complete_if0_template(ident_t *loc_ref,
83782e94a59SJoachim Protze                                                   kmp_int32 gtid,
8383041982dSJonathan Peyton                                                   kmp_task_t *task) {
8397cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(enter): T#%d loc=%p task=%p\n",
8407cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
8413041982dSJonathan Peyton   // this routine will provide task to resume
84286ed6aa6SJoachim Protze   __kmp_task_finish<ompt>(gtid, task, NULL);
8437cc577a4SJonathan Peyton 
8447cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete_if0(exit): T#%d loc=%p task=%p\n",
8457cc577a4SJonathan Peyton                 gtid, loc_ref, KMP_TASK_TO_TASKDATA(task)));
84682e94a59SJoachim Protze 
84782e94a59SJoachim Protze #if OMPT_SUPPORT
84882e94a59SJoachim Protze   if (ompt) {
849c5836064SJoachim Protze     omp_frame_t *ompt_frame;
85082e94a59SJoachim Protze     __ompt_get_task_info_internal(0, NULL, NULL, &ompt_frame, NULL, NULL);
851c255ca70SJoachim Protze     ompt_frame->enter_frame = NULL;
85282e94a59SJoachim Protze   }
85382e94a59SJoachim Protze #endif
85482e94a59SJoachim Protze 
8557cc577a4SJonathan Peyton   return;
8567cc577a4SJonathan Peyton }
8577cc577a4SJonathan Peyton 
85882e94a59SJoachim Protze #if OMPT_SUPPORT
85982e94a59SJoachim Protze OMPT_NOINLINE
86082e94a59SJoachim Protze void __kmpc_omp_task_complete_if0_ompt(ident_t *loc_ref, kmp_int32 gtid,
86182e94a59SJoachim Protze                                        kmp_task_t *task) {
86282e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<true>(loc_ref, gtid, task);
86382e94a59SJoachim Protze }
86482e94a59SJoachim Protze #endif // OMPT_SUPPORT
86582e94a59SJoachim Protze 
86682e94a59SJoachim Protze // __kmpc_omp_task_complete_if0: report that a task has completed execution
86782e94a59SJoachim Protze //
86882e94a59SJoachim Protze // loc_ref: source location information; points to end of task block.
86982e94a59SJoachim Protze // gtid: global thread number.
87082e94a59SJoachim Protze // task: task thunk for the completed task.
87182e94a59SJoachim Protze void __kmpc_omp_task_complete_if0(ident_t *loc_ref, kmp_int32 gtid,
87282e94a59SJoachim Protze                                   kmp_task_t *task) {
87382e94a59SJoachim Protze #if OMPT_SUPPORT
87482e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
87582e94a59SJoachim Protze     __kmpc_omp_task_complete_if0_ompt(loc_ref, gtid, task);
87682e94a59SJoachim Protze     return;
87782e94a59SJoachim Protze   }
87882e94a59SJoachim Protze #endif
87982e94a59SJoachim Protze   __kmpc_omp_task_complete_if0_template<false>(loc_ref, gtid, task);
88082e94a59SJoachim Protze }
88182e94a59SJoachim Protze 
8827cc577a4SJonathan Peyton #ifdef TASK_UNUSED
8837cc577a4SJonathan Peyton // __kmpc_omp_task_complete: report that a task has completed execution
8847cc577a4SJonathan Peyton // NEVER GENERATED BY COMPILER, DEPRECATED!!!
8853041982dSJonathan Peyton void __kmpc_omp_task_complete(ident_t *loc_ref, kmp_int32 gtid,
8863041982dSJonathan Peyton                               kmp_task_t *task) {
8873041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(enter): T#%d loc=%p task=%p\n", gtid,
8883041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
8897cc577a4SJonathan Peyton 
89086ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task,
89186ed6aa6SJoachim Protze                            NULL); // Not sure how to find task to resume
8927cc577a4SJonathan Peyton 
8933041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_complete(exit): T#%d loc=%p task=%p\n", gtid,
8943041982dSJonathan Peyton                 loc_ref, KMP_TASK_TO_TASKDATA(task)));
8957cc577a4SJonathan Peyton   return;
8967cc577a4SJonathan Peyton }
8977cc577a4SJonathan Peyton #endif // TASK_UNUSED
8987cc577a4SJonathan Peyton 
8993041982dSJonathan Peyton // __kmp_init_implicit_task: Initialize the appropriate fields in the implicit
9003041982dSJonathan Peyton // task for a given thread
9017cc577a4SJonathan Peyton //
9027cc577a4SJonathan Peyton // loc_ref:  reference to source location of parallel region
9037cc577a4SJonathan Peyton // this_thr:  thread data structure corresponding to implicit task
9047cc577a4SJonathan Peyton // team: team for this_thr
9057cc577a4SJonathan Peyton // tid: thread id of given thread within team
9067cc577a4SJonathan Peyton // set_curr_task: TRUE if need to push current task to thread
9073041982dSJonathan Peyton // NOTE: Routine does not set up the implicit task ICVS.  This is assumed to
9083041982dSJonathan Peyton // have already been done elsewhere.
9097cc577a4SJonathan Peyton // TODO: Get better loc_ref.  Value passed in may be NULL
9103041982dSJonathan Peyton void __kmp_init_implicit_task(ident_t *loc_ref, kmp_info_t *this_thr,
9113041982dSJonathan Peyton                               kmp_team_t *team, int tid, int set_curr_task) {
9127cc577a4SJonathan Peyton   kmp_taskdata_t *task = &team->t.t_implicit_task_taskdata[tid];
9137cc577a4SJonathan Peyton 
9143041982dSJonathan Peyton   KF_TRACE(
9153041982dSJonathan Peyton       10,
9163041982dSJonathan Peyton       ("__kmp_init_implicit_task(enter): T#:%d team=%p task=%p, reinit=%s\n",
9177cc577a4SJonathan Peyton        tid, team, task, set_curr_task ? "TRUE" : "FALSE"));
9187cc577a4SJonathan Peyton 
9197cc577a4SJonathan Peyton   task->td_task_id = KMP_GEN_TASK_ID();
9207cc577a4SJonathan Peyton   task->td_team = team;
9213041982dSJonathan Peyton   //    task->td_parent   = NULL;  // fix for CQ230101 (broken parent task info
9223041982dSJonathan Peyton   //    in debugger)
9237cc577a4SJonathan Peyton   task->td_ident = loc_ref;
9247cc577a4SJonathan Peyton   task->td_taskwait_ident = NULL;
9257cc577a4SJonathan Peyton   task->td_taskwait_counter = 0;
9267cc577a4SJonathan Peyton   task->td_taskwait_thread = 0;
9277cc577a4SJonathan Peyton 
9287cc577a4SJonathan Peyton   task->td_flags.tiedness = TASK_TIED;
9297cc577a4SJonathan Peyton   task->td_flags.tasktype = TASK_IMPLICIT;
9307cc577a4SJonathan Peyton #if OMP_45_ENABLED
9317cc577a4SJonathan Peyton   task->td_flags.proxy = TASK_FULL;
9327cc577a4SJonathan Peyton #endif
9337cc577a4SJonathan Peyton 
9347cc577a4SJonathan Peyton   // All implicit tasks are executed immediately, not deferred
9357cc577a4SJonathan Peyton   task->td_flags.task_serial = 1;
9367cc577a4SJonathan Peyton   task->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
9377cc577a4SJonathan Peyton   task->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
9387cc577a4SJonathan Peyton 
9397cc577a4SJonathan Peyton   task->td_flags.started = 1;
9407cc577a4SJonathan Peyton   task->td_flags.executing = 1;
9417cc577a4SJonathan Peyton   task->td_flags.complete = 0;
9427cc577a4SJonathan Peyton   task->td_flags.freed = 0;
9437cc577a4SJonathan Peyton 
9447cc577a4SJonathan Peyton #if OMP_40_ENABLED
9457cc577a4SJonathan Peyton   task->td_depnode = NULL;
9467cc577a4SJonathan Peyton #endif
947a756cb24SAndrey Churbanov   task->td_last_tied = task;
9487cc577a4SJonathan Peyton 
9493041982dSJonathan Peyton   if (set_curr_task) { // only do this init first time thread is created
95037e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_incomplete_child_tasks, 0);
951642688b6SJonathan Peyton     // Not used: don't need to deallocate implicit task
95237e2ef54SJonathan Peyton     KMP_ATOMIC_ST_REL(&task->td_allocated_child_tasks, 0);
9537cc577a4SJonathan Peyton #if OMP_40_ENABLED
9547cc577a4SJonathan Peyton     task->td_taskgroup = NULL; // An implicit task does not have taskgroup
9557cc577a4SJonathan Peyton     task->td_dephash = NULL;
9567cc577a4SJonathan Peyton #endif
9577cc577a4SJonathan Peyton     __kmp_push_current_task_to_thread(this_thr, team, tid);
9587cc577a4SJonathan Peyton   } else {
9597cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_incomplete_child_tasks == 0);
9607cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task->td_allocated_child_tasks == 0);
9617cc577a4SJonathan Peyton   }
9627cc577a4SJonathan Peyton 
9637cc577a4SJonathan Peyton #if OMPT_SUPPORT
964f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
96582e94a59SJoachim Protze     __ompt_task_init(task, tid);
9667cc577a4SJonathan Peyton #endif
9677cc577a4SJonathan Peyton 
9683041982dSJonathan Peyton   KF_TRACE(10, ("__kmp_init_implicit_task(exit): T#:%d team=%p task=%p\n", tid,
9693041982dSJonathan Peyton                 team, task));
9707cc577a4SJonathan Peyton }
9717cc577a4SJonathan Peyton 
9723041982dSJonathan Peyton // __kmp_finish_implicit_task: Release resources associated to implicit tasks
9733041982dSJonathan Peyton // at the end of parallel regions. Some resources are kept for reuse in the next
9743041982dSJonathan Peyton // parallel region.
9757cc577a4SJonathan Peyton //
9763041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
9773041982dSJonathan Peyton void __kmp_finish_implicit_task(kmp_info_t *thread) {
9787cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
9797cc577a4SJonathan Peyton   if (task->td_dephash)
9807cc577a4SJonathan Peyton     __kmp_dephash_free_entries(thread, task->td_dephash);
9817cc577a4SJonathan Peyton }
9827cc577a4SJonathan Peyton 
9833041982dSJonathan Peyton // __kmp_free_implicit_task: Release resources associated to implicit tasks
9843041982dSJonathan Peyton // when these are destroyed regions
9857cc577a4SJonathan Peyton //
9863041982dSJonathan Peyton // thread:  thread data structure corresponding to implicit task
9873041982dSJonathan Peyton void __kmp_free_implicit_task(kmp_info_t *thread) {
9887cc577a4SJonathan Peyton   kmp_taskdata_t *task = thread->th.th_current_task;
989bff8ded9SJonathan Peyton   if (task && task->td_dephash) {
9907cc577a4SJonathan Peyton     __kmp_dephash_free(thread, task->td_dephash);
9917cc577a4SJonathan Peyton     task->td_dephash = NULL;
9927cc577a4SJonathan Peyton   }
993bff8ded9SJonathan Peyton }
9947cc577a4SJonathan Peyton 
9953041982dSJonathan Peyton // Round up a size to a power of two specified by val: Used to insert padding
9963041982dSJonathan Peyton // between structures co-allocated using a single malloc() call
9973041982dSJonathan Peyton static size_t __kmp_round_up_to_val(size_t size, size_t val) {
9987cc577a4SJonathan Peyton   if (size & (val - 1)) {
9997cc577a4SJonathan Peyton     size &= ~(val - 1);
10007cc577a4SJonathan Peyton     if (size <= KMP_SIZE_T_MAX - val) {
10017cc577a4SJonathan Peyton       size += val; // Round up if there is no overflow.
1002bd3a7633SJonathan Peyton     }
1003bd3a7633SJonathan Peyton   }
10047cc577a4SJonathan Peyton   return size;
10057cc577a4SJonathan Peyton } // __kmp_round_up_to_va
10067cc577a4SJonathan Peyton 
10077cc577a4SJonathan Peyton // __kmp_task_alloc: Allocate the taskdata and task data structures for a task
10087cc577a4SJonathan Peyton //
10097cc577a4SJonathan Peyton // loc_ref: source location information
10107cc577a4SJonathan Peyton // gtid: global thread number.
10113041982dSJonathan Peyton // flags: include tiedness & task type (explicit vs. implicit) of the ''new''
10123041982dSJonathan Peyton // task encountered. Converted from kmp_int32 to kmp_tasking_flags_t in routine.
10133041982dSJonathan Peyton // sizeof_kmp_task_t:  Size in bytes of kmp_task_t data structure including
10143041982dSJonathan Peyton // private vars accessed in task.
10153041982dSJonathan Peyton // sizeof_shareds:  Size in bytes of array of pointers to shared vars accessed
10163041982dSJonathan Peyton // in task.
10177cc577a4SJonathan Peyton // task_entry: Pointer to task code entry point generated by compiler.
10187cc577a4SJonathan Peyton // returns: a pointer to the allocated kmp_task_t structure (task).
10193041982dSJonathan Peyton kmp_task_t *__kmp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
10203041982dSJonathan Peyton                              kmp_tasking_flags_t *flags,
10217cc577a4SJonathan Peyton                              size_t sizeof_kmp_task_t, size_t sizeof_shareds,
10223041982dSJonathan Peyton                              kmp_routine_entry_t task_entry) {
10237cc577a4SJonathan Peyton   kmp_task_t *task;
10247cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
10257cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
10267cc577a4SJonathan Peyton   kmp_team_t *team = thread->th.th_team;
10277cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
10287cc577a4SJonathan Peyton   size_t shareds_offset;
10297cc577a4SJonathan Peyton 
103028226e7dSJonathan Peyton   if (!TCR_4(__kmp_init_middle))
103128226e7dSJonathan Peyton     __kmp_middle_initialize();
103228226e7dSJonathan Peyton 
10337cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_task_alloc(enter): T#%d loc=%p, flags=(0x%x) "
10347cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
10357cc577a4SJonathan Peyton                 gtid, loc_ref, *((kmp_int32 *)flags), sizeof_kmp_task_t,
10367cc577a4SJonathan Peyton                 sizeof_shareds, task_entry));
10377cc577a4SJonathan Peyton 
10387cc577a4SJonathan Peyton   if (parent_task->td_flags.final) {
10397cc577a4SJonathan Peyton     if (flags->merged_if0) {
10407cc577a4SJonathan Peyton     }
10417cc577a4SJonathan Peyton     flags->final = 1;
10427cc577a4SJonathan Peyton   }
1043a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED && !team->t.t_serialized) {
1044a756cb24SAndrey Churbanov     // Untied task encountered causes the TSC algorithm to check entire deque of
1045a756cb24SAndrey Churbanov     // the victim thread. If no untied task encountered, then checking the head
1046a756cb24SAndrey Churbanov     // of the deque should be enough.
1047a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(thread->th.th_task_team->tt.tt_untied_task_encountered, 1);
1048a756cb24SAndrey Churbanov   }
10497cc577a4SJonathan Peyton 
10507cc577a4SJonathan Peyton #if OMP_45_ENABLED
10517cc577a4SJonathan Peyton   if (flags->proxy == TASK_PROXY) {
10527cc577a4SJonathan Peyton     flags->tiedness = TASK_UNTIED;
10537cc577a4SJonathan Peyton     flags->merged_if0 = 1;
10547cc577a4SJonathan Peyton 
10553041982dSJonathan Peyton     /* are we running in a sequential parallel or tskm_immediate_exec... we need
10563041982dSJonathan Peyton        tasking support enabled */
10577cc577a4SJonathan Peyton     if ((thread->th.th_task_team) == NULL) {
10587cc577a4SJonathan Peyton       /* This should only happen if the team is serialized
10593041982dSJonathan Peyton           setup a task team and propagate it to the thread */
10607cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(team->t.t_serialized);
10613041982dSJonathan Peyton       KA_TRACE(30,
10623041982dSJonathan Peyton                ("T#%d creating task team in __kmp_task_alloc for proxy task\n",
10633041982dSJonathan Peyton                 gtid));
10643041982dSJonathan Peyton       __kmp_task_team_setup(
10653041982dSJonathan Peyton           thread, team,
10663041982dSJonathan Peyton           1); // 1 indicates setup the current team regardless of nthreads
10677cc577a4SJonathan Peyton       thread->th.th_task_team = team->t.t_task_team[thread->th.th_task_state];
10687cc577a4SJonathan Peyton     }
10697cc577a4SJonathan Peyton     kmp_task_team_t *task_team = thread->th.th_task_team;
10707cc577a4SJonathan Peyton 
10717cc577a4SJonathan Peyton     /* tasking must be enabled now as the task might not be pushed */
10727cc577a4SJonathan Peyton     if (!KMP_TASKING_ENABLED(task_team)) {
10733041982dSJonathan Peyton       KA_TRACE(
10743041982dSJonathan Peyton           30,
10753041982dSJonathan Peyton           ("T#%d enabling tasking in __kmp_task_alloc for proxy task\n", gtid));
10767cc577a4SJonathan Peyton       __kmp_enable_tasking(task_team, thread);
10777cc577a4SJonathan Peyton       kmp_int32 tid = thread->th.th_info.ds.ds_tid;
10787cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
10797cc577a4SJonathan Peyton       // No lock needed since only owner can allocate
10807cc577a4SJonathan Peyton       if (thread_data->td.td_deque == NULL) {
10817cc577a4SJonathan Peyton         __kmp_alloc_task_deque(thread, thread_data);
10827cc577a4SJonathan Peyton       }
10837cc577a4SJonathan Peyton     }
10847cc577a4SJonathan Peyton 
10857cc577a4SJonathan Peyton     if (task_team->tt.tt_found_proxy_tasks == FALSE)
10867cc577a4SJonathan Peyton       TCW_4(task_team->tt.tt_found_proxy_tasks, TRUE);
10877cc577a4SJonathan Peyton   }
10887cc577a4SJonathan Peyton #endif
10897cc577a4SJonathan Peyton 
10907cc577a4SJonathan Peyton   // Calculate shared structure offset including padding after kmp_task_t struct
10917cc577a4SJonathan Peyton   // to align pointers in shared struct
10927cc577a4SJonathan Peyton   shareds_offset = sizeof(kmp_taskdata_t) + sizeof_kmp_task_t;
10937cc577a4SJonathan Peyton   shareds_offset = __kmp_round_up_to_val(shareds_offset, sizeof(void *));
10947cc577a4SJonathan Peyton 
10957cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
10963041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d First malloc size: %ld\n", gtid,
10973041982dSJonathan Peyton                 shareds_offset));
10983041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_alloc: T#%d Second malloc size: %ld\n", gtid,
10993041982dSJonathan Peyton                 sizeof_shareds));
11007cc577a4SJonathan Peyton 
11017cc577a4SJonathan Peyton // Avoid double allocation here by combining shareds with taskdata
11027cc577a4SJonathan Peyton #if USE_FAST_MEMORY
11033041982dSJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, shareds_offset +
11043041982dSJonathan Peyton                                                                sizeof_shareds);
11057cc577a4SJonathan Peyton #else /* ! USE_FAST_MEMORY */
11063041982dSJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, shareds_offset +
11073041982dSJonathan Peyton                                                                sizeof_shareds);
11087cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
11097cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_AFTER(taskdata);
11107cc577a4SJonathan Peyton 
11117cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
11127cc577a4SJonathan Peyton 
11137cc577a4SJonathan Peyton // Make sure task & taskdata are aligned appropriately
11147cc577a4SJonathan Peyton #if KMP_ARCH_X86 || KMP_ARCH_PPC64 || !KMP_HAVE_QUAD
11157cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(double) - 1)) == 0);
11167cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(double) - 1)) == 0);
11177cc577a4SJonathan Peyton #else
11187cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)taskdata) & (sizeof(_Quad) - 1)) == 0);
11197cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT((((kmp_uintptr_t)task) & (sizeof(_Quad) - 1)) == 0);
11207cc577a4SJonathan Peyton #endif
11217cc577a4SJonathan Peyton   if (sizeof_shareds > 0) {
11227cc577a4SJonathan Peyton     // Avoid double allocation here by combining shareds with taskdata
11237cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
11247cc577a4SJonathan Peyton     // Make sure shareds struct is aligned to pointer size
11253041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
11263041982dSJonathan Peyton                      0);
11277cc577a4SJonathan Peyton   } else {
11287cc577a4SJonathan Peyton     task->shareds = NULL;
11297cc577a4SJonathan Peyton   }
11307cc577a4SJonathan Peyton   task->routine = task_entry;
11317cc577a4SJonathan Peyton   task->part_id = 0; // AC: Always start with 0 part id
11327cc577a4SJonathan Peyton 
11337cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
11347cc577a4SJonathan Peyton   taskdata->td_team = team;
11357cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
11367cc577a4SJonathan Peyton   taskdata->td_parent = parent_task;
11377cc577a4SJonathan Peyton   taskdata->td_level = parent_task->td_level + 1; // increment nesting level
113837e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_untied_count, 0);
11397cc577a4SJonathan Peyton   taskdata->td_ident = loc_ref;
11407cc577a4SJonathan Peyton   taskdata->td_taskwait_ident = NULL;
11417cc577a4SJonathan Peyton   taskdata->td_taskwait_counter = 0;
11427cc577a4SJonathan Peyton   taskdata->td_taskwait_thread = 0;
11437cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_parent != NULL);
11447cc577a4SJonathan Peyton #if OMP_45_ENABLED
11457cc577a4SJonathan Peyton   // avoid copying icvs for proxy tasks
11467cc577a4SJonathan Peyton   if (flags->proxy == TASK_FULL)
11477cc577a4SJonathan Peyton #endif
11487cc577a4SJonathan Peyton     copy_icvs(&taskdata->td_icvs, &taskdata->td_parent->td_icvs);
11497cc577a4SJonathan Peyton 
11507cc577a4SJonathan Peyton   taskdata->td_flags.tiedness = flags->tiedness;
11517cc577a4SJonathan Peyton   taskdata->td_flags.final = flags->final;
11527cc577a4SJonathan Peyton   taskdata->td_flags.merged_if0 = flags->merged_if0;
11537cc577a4SJonathan Peyton #if OMP_40_ENABLED
11547cc577a4SJonathan Peyton   taskdata->td_flags.destructors_thunk = flags->destructors_thunk;
11557cc577a4SJonathan Peyton #endif // OMP_40_ENABLED
11567cc577a4SJonathan Peyton #if OMP_45_ENABLED
11577cc577a4SJonathan Peyton   taskdata->td_flags.proxy = flags->proxy;
11587cc577a4SJonathan Peyton   taskdata->td_task_team = thread->th.th_task_team;
11597cc577a4SJonathan Peyton   taskdata->td_size_alloc = shareds_offset + sizeof_shareds;
11607cc577a4SJonathan Peyton #endif
11617cc577a4SJonathan Peyton   taskdata->td_flags.tasktype = TASK_EXPLICIT;
11627cc577a4SJonathan Peyton 
11637cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of tasking_ser flag
11647cc577a4SJonathan Peyton   taskdata->td_flags.tasking_ser = (__kmp_tasking_mode == tskm_immediate_exec);
11657cc577a4SJonathan Peyton 
11667cc577a4SJonathan Peyton   // GEH - TODO: fix this to copy parent task's value of team_serial flag
11677cc577a4SJonathan Peyton   taskdata->td_flags.team_serial = (team->t.t_serialized) ? 1 : 0;
11687cc577a4SJonathan Peyton 
11693041982dSJonathan Peyton   // GEH - Note we serialize the task if the team is serialized to make sure
11703041982dSJonathan Peyton   // implicit parallel region tasks are not left until program termination to
11713041982dSJonathan Peyton   // execute. Also, it helps locality to execute immediately.
11723041982dSJonathan Peyton 
11733041982dSJonathan Peyton   taskdata->td_flags.task_serial =
11743041982dSJonathan Peyton       (parent_task->td_flags.final || taskdata->td_flags.team_serial ||
11753041982dSJonathan Peyton        taskdata->td_flags.tasking_ser);
11767cc577a4SJonathan Peyton 
11777cc577a4SJonathan Peyton   taskdata->td_flags.started = 0;
11787cc577a4SJonathan Peyton   taskdata->td_flags.executing = 0;
11797cc577a4SJonathan Peyton   taskdata->td_flags.complete = 0;
11807cc577a4SJonathan Peyton   taskdata->td_flags.freed = 0;
11817cc577a4SJonathan Peyton 
11827cc577a4SJonathan Peyton   taskdata->td_flags.native = flags->native;
11837cc577a4SJonathan Peyton 
118437e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_incomplete_child_tasks, 0);
118537e2ef54SJonathan Peyton   // start at one because counts current task and children
118637e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&taskdata->td_allocated_child_tasks, 1);
11877cc577a4SJonathan Peyton #if OMP_40_ENABLED
11883041982dSJonathan Peyton   taskdata->td_taskgroup =
11893041982dSJonathan Peyton       parent_task->td_taskgroup; // task inherits taskgroup from the parent task
11907cc577a4SJonathan Peyton   taskdata->td_dephash = NULL;
11917cc577a4SJonathan Peyton   taskdata->td_depnode = NULL;
11927cc577a4SJonathan Peyton #endif
1193a756cb24SAndrey Churbanov   if (flags->tiedness == TASK_UNTIED)
1194a756cb24SAndrey Churbanov     taskdata->td_last_tied = NULL; // will be set when the task is scheduled
1195a756cb24SAndrey Churbanov   else
1196a756cb24SAndrey Churbanov     taskdata->td_last_tied = taskdata;
11977cc577a4SJonathan Peyton 
119886ed6aa6SJoachim Protze #if OMPT_SUPPORT
119986ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled))
120086ed6aa6SJoachim Protze     __ompt_task_init(taskdata, gtid);
120186ed6aa6SJoachim Protze #endif
12023041982dSJonathan Peyton // Only need to keep track of child task counts if team parallel and tasking not
12033041982dSJonathan Peyton // serialized or if it is a proxy task
12047cc577a4SJonathan Peyton #if OMP_45_ENABLED
12053041982dSJonathan Peyton   if (flags->proxy == TASK_PROXY ||
12063041982dSJonathan Peyton       !(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser))
12077cc577a4SJonathan Peyton #else
12087cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser))
12097cc577a4SJonathan Peyton #endif
12107cc577a4SJonathan Peyton   {
121137e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
12127cc577a4SJonathan Peyton #if OMP_40_ENABLED
12137cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
121437e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
12157cc577a4SJonathan Peyton #endif
12163041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
12173041982dSJonathan Peyton     // implicit not deallocated
12187cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT) {
121937e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
12207cc577a4SJonathan Peyton     }
12217cc577a4SJonathan Peyton   }
12227cc577a4SJonathan Peyton 
12237cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_task_alloc(exit): T#%d created task %p parent=%p\n",
12247cc577a4SJonathan Peyton                 gtid, taskdata, taskdata->td_parent));
12257cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(task);
12267cc577a4SJonathan Peyton 
12277cc577a4SJonathan Peyton   return task;
12287cc577a4SJonathan Peyton }
12297cc577a4SJonathan Peyton 
12303041982dSJonathan Peyton kmp_task_t *__kmpc_omp_task_alloc(ident_t *loc_ref, kmp_int32 gtid,
12313041982dSJonathan Peyton                                   kmp_int32 flags, size_t sizeof_kmp_task_t,
12323041982dSJonathan Peyton                                   size_t sizeof_shareds,
12333041982dSJonathan Peyton                                   kmp_routine_entry_t task_entry) {
12347cc577a4SJonathan Peyton   kmp_task_t *retval;
12357cc577a4SJonathan Peyton   kmp_tasking_flags_t *input_flags = (kmp_tasking_flags_t *)&flags;
12367cc577a4SJonathan Peyton 
12377cc577a4SJonathan Peyton   input_flags->native = FALSE;
12387cc577a4SJonathan Peyton // __kmp_task_alloc() sets up all other runtime flags
12397cc577a4SJonathan Peyton 
12407cc577a4SJonathan Peyton #if OMP_45_ENABLED
12417cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s %s) "
12427cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12437cc577a4SJonathan Peyton                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
12443041982dSJonathan Peyton                 input_flags->proxy ? "proxy" : "", sizeof_kmp_task_t,
12453041982dSJonathan Peyton                 sizeof_shareds, task_entry));
12467cc577a4SJonathan Peyton #else
12477cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_alloc(enter): T#%d loc=%p, flags=(%s) "
12487cc577a4SJonathan Peyton                 "sizeof_task=%ld sizeof_shared=%ld entry=%p\n",
12497cc577a4SJonathan Peyton                 gtid, loc_ref, input_flags->tiedness ? "tied  " : "untied",
12507cc577a4SJonathan Peyton                 sizeof_kmp_task_t, sizeof_shareds, task_entry));
12517cc577a4SJonathan Peyton #endif
12527cc577a4SJonathan Peyton 
12537cc577a4SJonathan Peyton   retval = __kmp_task_alloc(loc_ref, gtid, input_flags, sizeof_kmp_task_t,
12547cc577a4SJonathan Peyton                             sizeof_shareds, task_entry);
12557cc577a4SJonathan Peyton 
12567cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmpc_omp_task_alloc(exit): T#%d retval %p\n", gtid, retval));
12577cc577a4SJonathan Peyton 
12587cc577a4SJonathan Peyton   return retval;
12597cc577a4SJonathan Peyton }
12607cc577a4SJonathan Peyton 
12617cc577a4SJonathan Peyton //  __kmp_invoke_task: invoke the specified task
12627cc577a4SJonathan Peyton //
12637cc577a4SJonathan Peyton // gtid: global thread ID of caller
12647cc577a4SJonathan Peyton // task: the task to invoke
12657cc577a4SJonathan Peyton // current_task: the task to resume after task invokation
12663041982dSJonathan Peyton static void __kmp_invoke_task(kmp_int32 gtid, kmp_task_t *task,
12673041982dSJonathan Peyton                               kmp_taskdata_t *current_task) {
12687cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
12697cc577a4SJonathan Peyton #if OMP_40_ENABLED
12707cc577a4SJonathan Peyton   int discard = 0 /* false */;
12717cc577a4SJonathan Peyton #endif
12723041982dSJonathan Peyton   KA_TRACE(
12733041982dSJonathan Peyton       30, ("__kmp_invoke_task(enter): T#%d invoking task %p, current_task=%p\n",
12747cc577a4SJonathan Peyton            gtid, taskdata, current_task));
12757cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task);
12767cc577a4SJonathan Peyton #if OMP_45_ENABLED
12777cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy == TASK_PROXY &&
12783041982dSJonathan Peyton       taskdata->td_flags.complete == 1) {
12797cc577a4SJonathan Peyton     // This is a proxy task that was already completed but it needs to run
12807cc577a4SJonathan Peyton     // its bottom-half finish
12813041982dSJonathan Peyton     KA_TRACE(
12823041982dSJonathan Peyton         30,
12833041982dSJonathan Peyton         ("__kmp_invoke_task: T#%d running bottom finish for proxy task %p\n",
12847cc577a4SJonathan Peyton          gtid, taskdata));
12857cc577a4SJonathan Peyton 
12867cc577a4SJonathan Peyton     __kmp_bottom_half_finish_proxy(gtid, task);
12877cc577a4SJonathan Peyton 
12883041982dSJonathan Peyton     KA_TRACE(30, ("__kmp_invoke_task(exit): T#%d completed bottom finish for "
12893041982dSJonathan Peyton                   "proxy task %p, resuming task %p\n",
12903041982dSJonathan Peyton                   gtid, taskdata, current_task));
12917cc577a4SJonathan Peyton 
12927cc577a4SJonathan Peyton     return;
12937cc577a4SJonathan Peyton   }
12947cc577a4SJonathan Peyton #endif
12957cc577a4SJonathan Peyton 
12967cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
1297*baad3f60SJonathan Peyton   kmp_uint64 cur_time;
12987cc577a4SJonathan Peyton   if (__kmp_forkjoin_frames_mode == 3) {
12993041982dSJonathan Peyton     // Get the current time stamp to measure task execution time to correct
13003041982dSJonathan Peyton     // barrier imbalance time
13017cc577a4SJonathan Peyton     cur_time = __itt_get_timestamp();
13027cc577a4SJonathan Peyton   }
13037cc577a4SJonathan Peyton #endif
13047cc577a4SJonathan Peyton 
13057cc577a4SJonathan Peyton #if OMPT_SUPPORT
130686ed6aa6SJoachim Protze   // For untied tasks, the first task executed only calls __kmpc_omp_task and
130786ed6aa6SJoachim Protze   // does not execute code.
13087cc577a4SJonathan Peyton   ompt_thread_info_t oldInfo;
13097cc577a4SJonathan Peyton   kmp_info_t *thread;
1310f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
13117cc577a4SJonathan Peyton     // Store the threads states and restore them after the task
13127cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
13137cc577a4SJonathan Peyton     oldInfo = thread->th.ompt_thread_info;
13147cc577a4SJonathan Peyton     thread->th.ompt_thread_info.wait_id = 0;
131582e94a59SJoachim Protze     thread->th.ompt_thread_info.state = (thread->th.th_team_serialized)
131682e94a59SJoachim Protze                                             ? omp_state_work_serial
131782e94a59SJoachim Protze                                             : omp_state_work_parallel;
1318c255ca70SJoachim Protze     taskdata->ompt_task_info.frame.exit_frame = OMPT_GET_FRAME_ADDRESS(0);
13197cc577a4SJonathan Peyton   }
13207cc577a4SJonathan Peyton #endif
13217cc577a4SJonathan Peyton 
132286ed6aa6SJoachim Protze #if OMP_45_ENABLED
132386ed6aa6SJoachim Protze   // Proxy tasks are not handled by the runtime
132486ed6aa6SJoachim Protze   if (taskdata->td_flags.proxy != TASK_PROXY) {
132586ed6aa6SJoachim Protze #endif
132686ed6aa6SJoachim Protze     ANNOTATE_HAPPENS_AFTER(task);
132786ed6aa6SJoachim Protze     __kmp_task_start(gtid, task, current_task); // OMPT only if not discarded
132886ed6aa6SJoachim Protze #if OMP_45_ENABLED
132986ed6aa6SJoachim Protze   }
133086ed6aa6SJoachim Protze #endif
133186ed6aa6SJoachim Protze 
13327cc577a4SJonathan Peyton #if OMP_40_ENABLED
13337cc577a4SJonathan Peyton   // TODO: cancel tasks if the parallel region has also been cancelled
13347cc577a4SJonathan Peyton   // TODO: check if this sequence can be hoisted above __kmp_task_start
13357cc577a4SJonathan Peyton   // if cancellation has been enabled for this run ...
13367cc577a4SJonathan Peyton   if (__kmp_omp_cancellation) {
13377cc577a4SJonathan Peyton     kmp_info_t *this_thr = __kmp_threads[gtid];
13387cc577a4SJonathan Peyton     kmp_team_t *this_team = this_thr->th.th_team;
13397cc577a4SJonathan Peyton     kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
13403041982dSJonathan Peyton     if ((taskgroup && taskgroup->cancel_request) ||
13413041982dSJonathan Peyton         (this_team->t.t_cancel_request == cancel_parallel)) {
134282e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
134382e94a59SJoachim Protze       ompt_data_t *task_data;
1344f0a1c65fSJonas Hahnfeld       if (UNLIKELY(ompt_enabled.ompt_callback_cancel)) {
134582e94a59SJoachim Protze         __ompt_get_task_info_internal(0, NULL, &task_data, NULL, NULL, NULL);
134682e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_cancel)(
134782e94a59SJoachim Protze             task_data,
134882e94a59SJoachim Protze             ((taskgroup && taskgroup->cancel_request) ? ompt_cancel_taskgroup
134982e94a59SJoachim Protze                                                       : ompt_cancel_parallel) |
135082e94a59SJoachim Protze                 ompt_cancel_discarded_task,
135182e94a59SJoachim Protze             NULL);
135282e94a59SJoachim Protze       }
135382e94a59SJoachim Protze #endif
13547cc577a4SJonathan Peyton       KMP_COUNT_BLOCK(TASK_cancelled);
13557cc577a4SJonathan Peyton       // this task belongs to a task group and we need to cancel it
13567cc577a4SJonathan Peyton       discard = 1 /* true */;
13577cc577a4SJonathan Peyton     }
13587cc577a4SJonathan Peyton   }
13597cc577a4SJonathan Peyton 
13607cc577a4SJonathan Peyton   // Invoke the task routine and pass in relevant data.
13617cc577a4SJonathan Peyton   // Thunks generated by gcc take a different argument list.
13627cc577a4SJonathan Peyton   if (!discard) {
1363a756cb24SAndrey Churbanov     if (taskdata->td_flags.tiedness == TASK_UNTIED) {
1364a756cb24SAndrey Churbanov       taskdata->td_last_tied = current_task->td_last_tied;
1365a756cb24SAndrey Churbanov       KMP_DEBUG_ASSERT(taskdata->td_last_tied);
1366a756cb24SAndrey Churbanov     }
13677cc577a4SJonathan Peyton #if KMP_STATS_ENABLED
13687cc577a4SJonathan Peyton     KMP_COUNT_BLOCK(TASK_executed);
13697cc577a4SJonathan Peyton     switch (KMP_GET_THREAD_STATE()) {
13703041982dSJonathan Peyton     case FORK_JOIN_BARRIER:
13713041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_join_bar);
13723041982dSJonathan Peyton       break;
13733041982dSJonathan Peyton     case PLAIN_BARRIER:
13743041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_plain_bar);
13753041982dSJonathan Peyton       break;
13763041982dSJonathan Peyton     case TASKYIELD:
13773041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskyield);
13783041982dSJonathan Peyton       break;
13793041982dSJonathan Peyton     case TASKWAIT:
13803041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskwait);
13813041982dSJonathan Peyton       break;
13823041982dSJonathan Peyton     case TASKGROUP:
13833041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_taskgroup);
13843041982dSJonathan Peyton       break;
13853041982dSJonathan Peyton     default:
13863041982dSJonathan Peyton       KMP_PUSH_PARTITIONED_TIMER(OMP_task_immediate);
13873041982dSJonathan Peyton       break;
13887cc577a4SJonathan Peyton     }
13897cc577a4SJonathan Peyton #endif // KMP_STATS_ENABLED
13907cc577a4SJonathan Peyton #endif // OMP_40_ENABLED
13917cc577a4SJonathan Peyton 
139282e94a59SJoachim Protze // OMPT task begin
139382e94a59SJoachim Protze #if OMPT_SUPPORT
1394f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.enabled))
139582e94a59SJoachim Protze       __ompt_task_start(task, current_task, gtid);
13967cc577a4SJonathan Peyton #endif
13977cc577a4SJonathan Peyton 
13987cc577a4SJonathan Peyton #ifdef KMP_GOMP_COMPAT
13997cc577a4SJonathan Peyton     if (taskdata->td_flags.native) {
14007cc577a4SJonathan Peyton       ((void (*)(void *))(*(task->routine)))(task->shareds);
14013041982dSJonathan Peyton     } else
14027cc577a4SJonathan Peyton #endif /* KMP_GOMP_COMPAT */
14037cc577a4SJonathan Peyton     {
14047cc577a4SJonathan Peyton       (*(task->routine))(gtid, task);
14057cc577a4SJonathan Peyton     }
14067cc577a4SJonathan Peyton     KMP_POP_PARTITIONED_TIMER();
14077cc577a4SJonathan Peyton 
14087cc577a4SJonathan Peyton #if OMP_40_ENABLED
14097cc577a4SJonathan Peyton   }
14107cc577a4SJonathan Peyton #endif // OMP_40_ENABLED
14117cc577a4SJonathan Peyton 
14127cc577a4SJonathan Peyton 
14137cc577a4SJonathan Peyton #if OMP_45_ENABLED
14147cc577a4SJonathan Peyton   // Proxy tasks are not handled by the runtime
14157cc577a4SJonathan Peyton   if (taskdata->td_flags.proxy != TASK_PROXY) {
14167cc577a4SJonathan Peyton #endif
14177cc577a4SJonathan Peyton     ANNOTATE_HAPPENS_BEFORE(taskdata->td_parent);
141886ed6aa6SJoachim Protze #if OMPT_SUPPORT
141986ed6aa6SJoachim Protze     if (UNLIKELY(ompt_enabled.enabled)) {
142086ed6aa6SJoachim Protze       thread->th.ompt_thread_info = oldInfo;
142186ed6aa6SJoachim Protze       if (taskdata->td_flags.tiedness == TASK_TIED) {
142286ed6aa6SJoachim Protze         taskdata->ompt_task_info.frame.exit_frame = NULL;
142386ed6aa6SJoachim Protze       }
142486ed6aa6SJoachim Protze       __kmp_task_finish<true>(gtid, task, current_task);
142586ed6aa6SJoachim Protze     } else
142686ed6aa6SJoachim Protze #endif
142786ed6aa6SJoachim Protze       __kmp_task_finish<false>(gtid, task, current_task);
14287cc577a4SJonathan Peyton #if OMP_45_ENABLED
14297cc577a4SJonathan Peyton   }
14307cc577a4SJonathan Peyton #endif
14317cc577a4SJonathan Peyton 
14327cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
14337cc577a4SJonathan Peyton   // Barrier imbalance - correct arrive time after the task finished
14347cc577a4SJonathan Peyton   if (__kmp_forkjoin_frames_mode == 3) {
14357cc577a4SJonathan Peyton     kmp_info_t *this_thr = __kmp_threads[gtid];
14367cc577a4SJonathan Peyton     if (this_thr->th.th_bar_arrive_time) {
14377cc577a4SJonathan Peyton       this_thr->th.th_bar_arrive_time += (__itt_get_timestamp() - cur_time);
14387cc577a4SJonathan Peyton     }
14397cc577a4SJonathan Peyton   }
14407cc577a4SJonathan Peyton #endif
14413041982dSJonathan Peyton   KA_TRACE(
14423041982dSJonathan Peyton       30,
14433041982dSJonathan Peyton       ("__kmp_invoke_task(exit): T#%d completed task %p, resuming task %p\n",
14447cc577a4SJonathan Peyton        gtid, taskdata, current_task));
14457cc577a4SJonathan Peyton   return;
14467cc577a4SJonathan Peyton }
14477cc577a4SJonathan Peyton 
14487cc577a4SJonathan Peyton // __kmpc_omp_task_parts: Schedule a thread-switchable task for execution
14497cc577a4SJonathan Peyton //
14507cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
14517cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
14527cc577a4SJonathan Peyton // new_task: task thunk allocated by __kmp_omp_task_alloc() for the ''new task''
14537cc577a4SJonathan Peyton // Returns:
14543041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
14553041982dSJonathan Peyton //    be resumed later.
14563041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
14573041982dSJonathan Peyton //    resumed later.
14583041982dSJonathan Peyton kmp_int32 __kmpc_omp_task_parts(ident_t *loc_ref, kmp_int32 gtid,
14593041982dSJonathan Peyton                                 kmp_task_t *new_task) {
14607cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
14617cc577a4SJonathan Peyton 
14623041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task_parts(enter): T#%d loc=%p task=%p\n", gtid,
14633041982dSJonathan Peyton                 loc_ref, new_taskdata));
14647cc577a4SJonathan Peyton 
146582e94a59SJoachim Protze #if OMPT_SUPPORT
146682e94a59SJoachim Protze   kmp_taskdata_t *parent;
1467f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
146882e94a59SJoachim Protze     parent = new_taskdata->td_parent;
146982e94a59SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
147082e94a59SJoachim Protze       ompt_data_t task_data = ompt_data_none;
147182e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
147282e94a59SJoachim Protze           parent ? &(parent->ompt_task_info.task_data) : &task_data,
147382e94a59SJoachim Protze           parent ? &(parent->ompt_task_info.frame) : NULL,
147482e94a59SJoachim Protze           &(new_taskdata->ompt_task_info.task_data), ompt_task_explicit, 0,
147582e94a59SJoachim Protze           OMPT_GET_RETURN_ADDRESS(0));
147682e94a59SJoachim Protze     }
147782e94a59SJoachim Protze   }
147882e94a59SJoachim Protze #endif
147982e94a59SJoachim Protze 
14803041982dSJonathan Peyton   /* Should we execute the new task or queue it? For now, let's just always try
14813041982dSJonathan Peyton      to queue it.  If the queue fills up, then we'll execute it.  */
14827cc577a4SJonathan Peyton 
14837cc577a4SJonathan Peyton   if (__kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
14847cc577a4SJonathan Peyton   { // Execute this task immediately
14857cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
14867cc577a4SJonathan Peyton     new_taskdata->td_flags.task_serial = 1;
14877cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
14887cc577a4SJonathan Peyton   }
14897cc577a4SJonathan Peyton 
14903041982dSJonathan Peyton   KA_TRACE(
14913041982dSJonathan Peyton       10,
14923041982dSJonathan Peyton       ("__kmpc_omp_task_parts(exit): T#%d returning TASK_CURRENT_NOT_QUEUED: "
14933041982dSJonathan Peyton        "loc=%p task=%p, return: TASK_CURRENT_NOT_QUEUED\n",
14943041982dSJonathan Peyton        gtid, loc_ref, new_taskdata));
14957cc577a4SJonathan Peyton 
14967cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(new_task);
149782e94a59SJoachim Protze #if OMPT_SUPPORT
1498f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
1499c255ca70SJoachim Protze     parent->ompt_task_info.frame.enter_frame = NULL;
150082e94a59SJoachim Protze   }
150182e94a59SJoachim Protze #endif
15027cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
15037cc577a4SJonathan Peyton }
15047cc577a4SJonathan Peyton 
15057cc577a4SJonathan Peyton // __kmp_omp_task: Schedule a non-thread-switchable task for execution
15063041982dSJonathan Peyton //
15077cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
15087cc577a4SJonathan Peyton // new_task:non-thread-switchable task thunk allocated by __kmp_omp_task_alloc()
15093041982dSJonathan Peyton // serialize_immediate: if TRUE then if the task is executed immediately its
15103041982dSJonathan Peyton // execution will be serialized
15113041982dSJonathan Peyton // Returns:
15123041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
15133041982dSJonathan Peyton //    be resumed later.
15143041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
15153041982dSJonathan Peyton //    resumed later.
15163041982dSJonathan Peyton kmp_int32 __kmp_omp_task(kmp_int32 gtid, kmp_task_t *new_task,
15173041982dSJonathan Peyton                          bool serialize_immediate) {
15187cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
15197cc577a4SJonathan Peyton 
15207cc577a4SJonathan Peyton /* Should we execute the new task or queue it? For now, let's just always try to
15217cc577a4SJonathan Peyton    queue it.  If the queue fills up, then we'll execute it.  */
15227cc577a4SJonathan Peyton #if OMP_45_ENABLED
15233041982dSJonathan Peyton   if (new_taskdata->td_flags.proxy == TASK_PROXY ||
15243041982dSJonathan Peyton       __kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
15257cc577a4SJonathan Peyton #else
15267cc577a4SJonathan Peyton   if (__kmp_push_task(gtid, new_task) == TASK_NOT_PUSHED) // if cannot defer
15277cc577a4SJonathan Peyton #endif
15287cc577a4SJonathan Peyton   { // Execute this task immediately
15297cc577a4SJonathan Peyton     kmp_taskdata_t *current_task = __kmp_threads[gtid]->th.th_current_task;
15307cc577a4SJonathan Peyton     if (serialize_immediate)
15317cc577a4SJonathan Peyton       new_taskdata->td_flags.task_serial = 1;
15327cc577a4SJonathan Peyton     __kmp_invoke_task(gtid, new_task, current_task);
15337cc577a4SJonathan Peyton   }
15347cc577a4SJonathan Peyton 
15357cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_BEFORE(new_task);
15367cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
15377cc577a4SJonathan Peyton }
15387cc577a4SJonathan Peyton 
15393041982dSJonathan Peyton // __kmpc_omp_task: Wrapper around __kmp_omp_task to schedule a
15403041982dSJonathan Peyton // non-thread-switchable task from the parent thread only!
15413041982dSJonathan Peyton //
15427cc577a4SJonathan Peyton // loc_ref: location of original task pragma (ignored)
15437cc577a4SJonathan Peyton // gtid: Global Thread ID of encountering thread
15443041982dSJonathan Peyton // new_task: non-thread-switchable task thunk allocated by
15453041982dSJonathan Peyton // __kmp_omp_task_alloc()
15463041982dSJonathan Peyton // Returns:
15473041982dSJonathan Peyton //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
15483041982dSJonathan Peyton //    be resumed later.
15493041982dSJonathan Peyton //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
15503041982dSJonathan Peyton //    resumed later.
15513041982dSJonathan Peyton kmp_int32 __kmpc_omp_task(ident_t *loc_ref, kmp_int32 gtid,
15523041982dSJonathan Peyton                           kmp_task_t *new_task) {
15537cc577a4SJonathan Peyton   kmp_int32 res;
15547cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
15557cc577a4SJonathan Peyton 
155682e94a59SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
15577cc577a4SJonathan Peyton   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
15587cc577a4SJonathan Peyton #endif
15593041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
15603041982dSJonathan Peyton                 new_taskdata));
15617cc577a4SJonathan Peyton 
156282e94a59SJoachim Protze #if OMPT_SUPPORT
156382e94a59SJoachim Protze   kmp_taskdata_t *parent = NULL;
156486ed6aa6SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
156586ed6aa6SJoachim Protze     if (!new_taskdata->td_flags.started) {
156682e94a59SJoachim Protze       OMPT_STORE_RETURN_ADDRESS(gtid);
156782e94a59SJoachim Protze       parent = new_taskdata->td_parent;
156886ed6aa6SJoachim Protze       if (!parent->ompt_task_info.frame.enter_frame) {
1569c255ca70SJoachim Protze         parent->ompt_task_info.frame.enter_frame = OMPT_GET_FRAME_ADDRESS(1);
157086ed6aa6SJoachim Protze       }
157182e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_task_create) {
157282e94a59SJoachim Protze         ompt_data_t task_data = ompt_data_none;
157382e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_task_create)(
157482e94a59SJoachim Protze             parent ? &(parent->ompt_task_info.task_data) : &task_data,
157582e94a59SJoachim Protze             parent ? &(parent->ompt_task_info.frame) : NULL,
157682e94a59SJoachim Protze             &(new_taskdata->ompt_task_info.task_data),
157782e94a59SJoachim Protze             ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
157882e94a59SJoachim Protze             OMPT_LOAD_RETURN_ADDRESS(gtid));
157982e94a59SJoachim Protze       }
158086ed6aa6SJoachim Protze     } else {
158186ed6aa6SJoachim Protze       // We are scheduling the continuation of an UNTIED task.
158286ed6aa6SJoachim Protze       // Scheduling back to the parent task.
158386ed6aa6SJoachim Protze       __ompt_task_finish(new_task,
158486ed6aa6SJoachim Protze                          new_taskdata->ompt_task_info.scheduling_parent,
158586ed6aa6SJoachim Protze                          ompt_task_others);
158686ed6aa6SJoachim Protze       new_taskdata->ompt_task_info.frame.exit_frame = NULL;
158786ed6aa6SJoachim Protze     }
158882e94a59SJoachim Protze   }
158982e94a59SJoachim Protze #endif
159082e94a59SJoachim Protze 
15917cc577a4SJonathan Peyton   res = __kmp_omp_task(gtid, new_task, true);
15927cc577a4SJonathan Peyton 
15933041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
15943041982dSJonathan Peyton                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
15957cc577a4SJonathan Peyton                 gtid, loc_ref, new_taskdata));
159682e94a59SJoachim Protze #if OMPT_SUPPORT
1597f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
1598c255ca70SJoachim Protze     parent->ompt_task_info.frame.enter_frame = NULL;
159982e94a59SJoachim Protze   }
160082e94a59SJoachim Protze #endif
16017cc577a4SJonathan Peyton   return res;
16027cc577a4SJonathan Peyton }
16037cc577a4SJonathan Peyton 
1604cdaefac5SJoachim Protze // __kmp_omp_taskloop_task: Wrapper around __kmp_omp_task to schedule
1605cdaefac5SJoachim Protze // a taskloop task with the correct OMPT return address
1606cdaefac5SJoachim Protze //
1607cdaefac5SJoachim Protze // loc_ref: location of original task pragma (ignored)
1608cdaefac5SJoachim Protze // gtid: Global Thread ID of encountering thread
1609cdaefac5SJoachim Protze // new_task: non-thread-switchable task thunk allocated by
1610cdaefac5SJoachim Protze // __kmp_omp_task_alloc()
1611cdaefac5SJoachim Protze // codeptr_ra: return address for OMPT callback
1612cdaefac5SJoachim Protze // Returns:
1613cdaefac5SJoachim Protze //    TASK_CURRENT_NOT_QUEUED (0) if did not suspend and queue current task to
1614cdaefac5SJoachim Protze //    be resumed later.
1615cdaefac5SJoachim Protze //    TASK_CURRENT_QUEUED (1) if suspended and queued the current task to be
1616cdaefac5SJoachim Protze //    resumed later.
1617cdaefac5SJoachim Protze kmp_int32 __kmp_omp_taskloop_task(ident_t *loc_ref, kmp_int32 gtid,
1618cdaefac5SJoachim Protze                                   kmp_task_t *new_task, void *codeptr_ra) {
1619cdaefac5SJoachim Protze   kmp_int32 res;
1620cdaefac5SJoachim Protze   KMP_SET_THREAD_STATE_BLOCK(EXPLICIT_TASK);
1621cdaefac5SJoachim Protze 
1622cdaefac5SJoachim Protze #if KMP_DEBUG || OMPT_SUPPORT
1623cdaefac5SJoachim Protze   kmp_taskdata_t *new_taskdata = KMP_TASK_TO_TASKDATA(new_task);
1624cdaefac5SJoachim Protze #endif
1625cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(enter): T#%d loc=%p task=%p\n", gtid, loc_ref,
1626cdaefac5SJoachim Protze                 new_taskdata));
1627cdaefac5SJoachim Protze 
1628cdaefac5SJoachim Protze #if OMPT_SUPPORT
1629cdaefac5SJoachim Protze   kmp_taskdata_t *parent = NULL;
1630cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && !new_taskdata->td_flags.started)) {
1631cdaefac5SJoachim Protze     parent = new_taskdata->td_parent;
1632cdaefac5SJoachim Protze     if (!parent->ompt_task_info.frame.enter_frame)
1633cdaefac5SJoachim Protze       parent->ompt_task_info.frame.enter_frame = OMPT_GET_FRAME_ADDRESS(1);
1634cdaefac5SJoachim Protze     if (ompt_enabled.ompt_callback_task_create) {
1635cdaefac5SJoachim Protze       ompt_data_t task_data = ompt_data_none;
1636cdaefac5SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_task_create)(
1637cdaefac5SJoachim Protze           parent ? &(parent->ompt_task_info.task_data) : &task_data,
1638cdaefac5SJoachim Protze           parent ? &(parent->ompt_task_info.frame) : NULL,
1639cdaefac5SJoachim Protze           &(new_taskdata->ompt_task_info.task_data),
1640cdaefac5SJoachim Protze           ompt_task_explicit | TASK_TYPE_DETAILS_FORMAT(new_taskdata), 0,
1641cdaefac5SJoachim Protze           codeptr_ra);
1642cdaefac5SJoachim Protze     }
1643cdaefac5SJoachim Protze   }
1644cdaefac5SJoachim Protze #endif
1645cdaefac5SJoachim Protze 
1646cdaefac5SJoachim Protze   res = __kmp_omp_task(gtid, new_task, true);
1647cdaefac5SJoachim Protze 
1648cdaefac5SJoachim Protze   KA_TRACE(10, ("__kmpc_omp_task(exit): T#%d returning "
1649cdaefac5SJoachim Protze                 "TASK_CURRENT_NOT_QUEUED: loc=%p task=%p\n",
1650cdaefac5SJoachim Protze                 gtid, loc_ref, new_taskdata));
1651cdaefac5SJoachim Protze #if OMPT_SUPPORT
1652cdaefac5SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled && parent != NULL)) {
1653cdaefac5SJoachim Protze     parent->ompt_task_info.frame.enter_frame = NULL;
1654cdaefac5SJoachim Protze   }
1655cdaefac5SJoachim Protze #endif
1656cdaefac5SJoachim Protze   return res;
1657cdaefac5SJoachim Protze }
1658cdaefac5SJoachim Protze 
165982e94a59SJoachim Protze template <bool ompt>
166082e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_template(ident_t *loc_ref, kmp_int32 gtid,
166182e94a59SJoachim Protze                                               void *frame_address,
166282e94a59SJoachim Protze                                               void *return_address) {
16637cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
16647cc577a4SJonathan Peyton   kmp_info_t *thread;
16657cc577a4SJonathan Peyton   int thread_finished = FALSE;
16667cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKWAIT);
16677cc577a4SJonathan Peyton 
16687cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(enter): T#%d loc=%p\n", gtid, loc_ref));
16697cc577a4SJonathan Peyton 
16707cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
16717cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
16727cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
16737cc577a4SJonathan Peyton 
167482e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
167582e94a59SJoachim Protze     ompt_data_t *my_task_data;
167682e94a59SJoachim Protze     ompt_data_t *my_parallel_data;
16777cc577a4SJonathan Peyton 
167882e94a59SJoachim Protze     if (ompt) {
167982e94a59SJoachim Protze       my_task_data = &(taskdata->ompt_task_info.task_data);
168082e94a59SJoachim Protze       my_parallel_data = OMPT_CUR_TEAM_DATA(thread);
168182e94a59SJoachim Protze 
1682c255ca70SJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = frame_address;
168382e94a59SJoachim Protze 
168482e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
168582e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
168682e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
168782e94a59SJoachim Protze             my_task_data, return_address);
168882e94a59SJoachim Protze       }
168982e94a59SJoachim Protze 
169082e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
169182e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
169282e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_begin, my_parallel_data,
169382e94a59SJoachim Protze             my_task_data, return_address);
16947cc577a4SJonathan Peyton       }
16957cc577a4SJonathan Peyton     }
169682e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
16977cc577a4SJonathan Peyton 
16983041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
16993041982dSJonathan Peyton // taskwait.
17007cc577a4SJonathan Peyton #if USE_ITT_BUILD
17017cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
17027cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
17037cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
17047cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
17057cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
17067cc577a4SJonathan Peyton 
17077cc577a4SJonathan Peyton #if USE_ITT_BUILD
17087cc577a4SJonathan Peyton     void *itt_sync_obj = __kmp_itt_taskwait_object(gtid);
17097cc577a4SJonathan Peyton     if (itt_sync_obj != NULL)
17107cc577a4SJonathan Peyton       __kmp_itt_taskwait_starting(gtid, itt_sync_obj);
17117cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
17127cc577a4SJonathan Peyton 
17133041982dSJonathan Peyton     bool must_wait =
17143041982dSJonathan Peyton         !taskdata->td_flags.team_serial && !taskdata->td_flags.final;
17157cc577a4SJonathan Peyton 
17167cc577a4SJonathan Peyton #if OMP_45_ENABLED
17173041982dSJonathan Peyton     must_wait = must_wait || (thread->th.th_task_team != NULL &&
17183041982dSJonathan Peyton                               thread->th.th_task_team->tt.tt_found_proxy_tasks);
17197cc577a4SJonathan Peyton #endif
17203041982dSJonathan Peyton     if (must_wait) {
172137e2ef54SJonathan Peyton       kmp_flag_32 flag(RCAST(std::atomic<kmp_uint32> *,
172237e2ef54SJonathan Peyton                              &(taskdata->td_incomplete_child_tasks)),
1723c47afcd9SAndrey Churbanov                        0U);
172437e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) != 0) {
17253041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
17263041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
17273041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
17287cc577a4SJonathan Peyton       }
17297cc577a4SJonathan Peyton     }
17307cc577a4SJonathan Peyton #if USE_ITT_BUILD
17317cc577a4SJonathan Peyton     if (itt_sync_obj != NULL)
17327cc577a4SJonathan Peyton       __kmp_itt_taskwait_finished(gtid, itt_sync_obj);
17337cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
17347cc577a4SJonathan Peyton 
17353041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
17363041982dSJonathan Peyton     // negated.
17377cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
17387cc577a4SJonathan Peyton 
173982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
174082e94a59SJoachim Protze     if (ompt) {
174182e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region_wait) {
174282e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
174382e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
174482e94a59SJoachim Protze             my_task_data, return_address);
174582e94a59SJoachim Protze       }
174682e94a59SJoachim Protze       if (ompt_enabled.ompt_callback_sync_region) {
174782e94a59SJoachim Protze         ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
174882e94a59SJoachim Protze             ompt_sync_region_taskwait, ompt_scope_end, my_parallel_data,
174982e94a59SJoachim Protze             my_task_data, return_address);
17507cc577a4SJonathan Peyton       }
1751c255ca70SJoachim Protze       taskdata->ompt_task_info.frame.enter_frame = NULL;
17527cc577a4SJonathan Peyton     }
175382e94a59SJoachim Protze #endif // OMPT_SUPPORT && OMPT_OPTIONAL
175482e94a59SJoachim Protze 
17557cc577a4SJonathan Peyton     ANNOTATE_HAPPENS_AFTER(taskdata);
17567cc577a4SJonathan Peyton   }
17577cc577a4SJonathan Peyton 
17587cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskwait(exit): T#%d task %p finished waiting, "
17593041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
17603041982dSJonathan Peyton                 gtid, taskdata));
17617cc577a4SJonathan Peyton 
17627cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
17637cc577a4SJonathan Peyton }
17647cc577a4SJonathan Peyton 
176582e94a59SJoachim Protze #if OMPT_SUPPORT
176682e94a59SJoachim Protze OMPT_NOINLINE
176782e94a59SJoachim Protze static kmp_int32 __kmpc_omp_taskwait_ompt(ident_t *loc_ref, kmp_int32 gtid,
176882e94a59SJoachim Protze                                           void *frame_address,
176982e94a59SJoachim Protze                                           void *return_address) {
177082e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<true>(loc_ref, gtid, frame_address,
177182e94a59SJoachim Protze                                             return_address);
177282e94a59SJoachim Protze }
177382e94a59SJoachim Protze #endif // OMPT_SUPPORT
177482e94a59SJoachim Protze 
177582e94a59SJoachim Protze // __kmpc_omp_taskwait: Wait until all tasks generated by the current task are
177682e94a59SJoachim Protze // complete
177782e94a59SJoachim Protze kmp_int32 __kmpc_omp_taskwait(ident_t *loc_ref, kmp_int32 gtid) {
177882e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
177982e94a59SJoachim Protze   if (UNLIKELY(ompt_enabled.enabled)) {
178082e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
1781f0a1c65fSJonas Hahnfeld     return __kmpc_omp_taskwait_ompt(loc_ref, gtid, OMPT_GET_FRAME_ADDRESS(1),
178282e94a59SJoachim Protze                                     OMPT_LOAD_RETURN_ADDRESS(gtid));
178382e94a59SJoachim Protze   }
178482e94a59SJoachim Protze #endif
178582e94a59SJoachim Protze   return __kmpc_omp_taskwait_template<false>(loc_ref, gtid, NULL, NULL);
178682e94a59SJoachim Protze }
178782e94a59SJoachim Protze 
17887cc577a4SJonathan Peyton // __kmpc_omp_taskyield: switch to a different task
17893041982dSJonathan Peyton kmp_int32 __kmpc_omp_taskyield(ident_t *loc_ref, kmp_int32 gtid, int end_part) {
17907cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
17917cc577a4SJonathan Peyton   kmp_info_t *thread;
17927cc577a4SJonathan Peyton   int thread_finished = FALSE;
17937cc577a4SJonathan Peyton 
17947cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKYIELD);
17957cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKYIELD);
17967cc577a4SJonathan Peyton 
17977cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(enter): T#%d loc=%p end_part = %d\n",
17987cc577a4SJonathan Peyton                 gtid, loc_ref, end_part));
17997cc577a4SJonathan Peyton 
18007cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec && __kmp_init_parallel) {
18017cc577a4SJonathan Peyton     thread = __kmp_threads[gtid];
18027cc577a4SJonathan Peyton     taskdata = thread->th.th_current_task;
18037cc577a4SJonathan Peyton // Should we model this as a task wait or not?
18043041982dSJonathan Peyton // Debugger: The taskwait is active. Store location and thread encountered the
18053041982dSJonathan Peyton // taskwait.
18067cc577a4SJonathan Peyton #if USE_ITT_BUILD
18077cc577a4SJonathan Peyton // Note: These values are used by ITT events as well.
18087cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
18097cc577a4SJonathan Peyton     taskdata->td_taskwait_counter += 1;
18107cc577a4SJonathan Peyton     taskdata->td_taskwait_ident = loc_ref;
18117cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = gtid + 1;
18127cc577a4SJonathan Peyton 
18137cc577a4SJonathan Peyton #if USE_ITT_BUILD
18147cc577a4SJonathan Peyton     void *itt_sync_obj = __kmp_itt_taskwait_object(gtid);
18157cc577a4SJonathan Peyton     if (itt_sync_obj != NULL)
18167cc577a4SJonathan Peyton       __kmp_itt_taskwait_starting(gtid, itt_sync_obj);
18177cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
18187cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial) {
18197cc577a4SJonathan Peyton       kmp_task_team_t *task_team = thread->th.th_task_team;
18207cc577a4SJonathan Peyton       if (task_team != NULL) {
18217cc577a4SJonathan Peyton         if (KMP_TASKING_ENABLED(task_team)) {
182282e94a59SJoachim Protze #if OMPT_SUPPORT
1823f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
182482e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 1;
182582e94a59SJoachim Protze #endif
18263041982dSJonathan Peyton           __kmp_execute_tasks_32(
18273041982dSJonathan Peyton               thread, gtid, NULL, FALSE,
18283041982dSJonathan Peyton               &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
18293041982dSJonathan Peyton               __kmp_task_stealing_constraint);
183082e94a59SJoachim Protze #if OMPT_SUPPORT
1831f0a1c65fSJonas Hahnfeld           if (UNLIKELY(ompt_enabled.enabled))
183282e94a59SJoachim Protze             thread->th.ompt_thread_info.ompt_task_yielded = 0;
183382e94a59SJoachim Protze #endif
18347cc577a4SJonathan Peyton         }
18357cc577a4SJonathan Peyton       }
18367cc577a4SJonathan Peyton     }
18377cc577a4SJonathan Peyton #if USE_ITT_BUILD
18387cc577a4SJonathan Peyton     if (itt_sync_obj != NULL)
18397cc577a4SJonathan Peyton       __kmp_itt_taskwait_finished(gtid, itt_sync_obj);
18407cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
18417cc577a4SJonathan Peyton 
18423041982dSJonathan Peyton     // Debugger:  The taskwait is completed. Location remains, but thread is
18433041982dSJonathan Peyton     // negated.
18447cc577a4SJonathan Peyton     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread;
18457cc577a4SJonathan Peyton   }
18467cc577a4SJonathan Peyton 
18477cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_omp_taskyield(exit): T#%d task %p resuming, "
18483041982dSJonathan Peyton                 "returning TASK_CURRENT_NOT_QUEUED\n",
18493041982dSJonathan Peyton                 gtid, taskdata));
18507cc577a4SJonathan Peyton 
18517cc577a4SJonathan Peyton   return TASK_CURRENT_NOT_QUEUED;
18527cc577a4SJonathan Peyton }
18537cc577a4SJonathan Peyton 
185472ba2109SAndrey Churbanov // TODO: change to OMP_50_ENABLED, need to change build tools for this to work
185572ba2109SAndrey Churbanov #if OMP_45_ENABLED
185672ba2109SAndrey Churbanov // Task Reduction implementation
185772ba2109SAndrey Churbanov 
185872ba2109SAndrey Churbanov typedef struct kmp_task_red_flags {
185972ba2109SAndrey Churbanov   unsigned lazy_priv : 1; // hint: (1) use lazy allocation (big objects)
186072ba2109SAndrey Churbanov   unsigned reserved31 : 31;
186172ba2109SAndrey Churbanov } kmp_task_red_flags_t;
186272ba2109SAndrey Churbanov 
186372ba2109SAndrey Churbanov // internal structure for reduction data item related info
186472ba2109SAndrey Churbanov typedef struct kmp_task_red_data {
186572ba2109SAndrey Churbanov   void *reduce_shar; // shared reduction item
186672ba2109SAndrey Churbanov   size_t reduce_size; // size of data item
186772ba2109SAndrey Churbanov   void *reduce_priv; // thread specific data
186872ba2109SAndrey Churbanov   void *reduce_pend; // end of private data for comparison op
186972ba2109SAndrey Churbanov   void *reduce_init; // data initialization routine
187072ba2109SAndrey Churbanov   void *reduce_fini; // data finalization routine
187172ba2109SAndrey Churbanov   void *reduce_comb; // data combiner routine
187272ba2109SAndrey Churbanov   kmp_task_red_flags_t flags; // flags for additional info from compiler
187372ba2109SAndrey Churbanov } kmp_task_red_data_t;
187472ba2109SAndrey Churbanov 
187572ba2109SAndrey Churbanov // structure sent us by compiler - one per reduction item
187672ba2109SAndrey Churbanov typedef struct kmp_task_red_input {
187772ba2109SAndrey Churbanov   void *reduce_shar; // shared reduction item
187872ba2109SAndrey Churbanov   size_t reduce_size; // size of data item
187972ba2109SAndrey Churbanov   void *reduce_init; // data initialization routine
188072ba2109SAndrey Churbanov   void *reduce_fini; // data finalization routine
188172ba2109SAndrey Churbanov   void *reduce_comb; // data combiner routine
188272ba2109SAndrey Churbanov   kmp_task_red_flags_t flags; // flags for additional info from compiler
188372ba2109SAndrey Churbanov } kmp_task_red_input_t;
188472ba2109SAndrey Churbanov 
188572ba2109SAndrey Churbanov /*!
188672ba2109SAndrey Churbanov @ingroup TASKING
188772ba2109SAndrey Churbanov @param gtid      Global thread ID
188872ba2109SAndrey Churbanov @param num       Number of data items to reduce
188972ba2109SAndrey Churbanov @param data      Array of data for reduction
189072ba2109SAndrey Churbanov @return The taskgroup identifier
189172ba2109SAndrey Churbanov 
189272ba2109SAndrey Churbanov Initialize task reduction for the taskgroup.
189372ba2109SAndrey Churbanov */
18943041982dSJonathan Peyton void *__kmpc_task_reduction_init(int gtid, int num, void *data) {
189572ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
189672ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = thread->th.th_current_task->td_taskgroup;
189772ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
189872ba2109SAndrey Churbanov   kmp_task_red_input_t *input = (kmp_task_red_input_t *)data;
189972ba2109SAndrey Churbanov   kmp_task_red_data_t *arr;
190072ba2109SAndrey Churbanov 
190172ba2109SAndrey Churbanov   // check input data just in case
190272ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
190372ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
190472ba2109SAndrey Churbanov   KMP_ASSERT(num > 0);
190572ba2109SAndrey Churbanov   if (nth == 1) {
190672ba2109SAndrey Churbanov     KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, tg %p, exiting nth=1\n",
190772ba2109SAndrey Churbanov                   gtid, tg));
190872ba2109SAndrey Churbanov     return (void *)tg;
190972ba2109SAndrey Churbanov   }
191072ba2109SAndrey Churbanov   KA_TRACE(10, ("__kmpc_task_reduction_init: T#%d, taskgroup %p, #items %d\n",
191172ba2109SAndrey Churbanov                 gtid, tg, num));
19123041982dSJonathan Peyton   arr = (kmp_task_red_data_t *)__kmp_thread_malloc(
19133041982dSJonathan Peyton       thread, num * sizeof(kmp_task_red_data_t));
191472ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
191572ba2109SAndrey Churbanov     void (*f_init)(void *) = (void (*)(void *))(input[i].reduce_init);
191672ba2109SAndrey Churbanov     size_t size = input[i].reduce_size - 1;
191772ba2109SAndrey Churbanov     // round the size up to cache line per thread-specific item
191872ba2109SAndrey Churbanov     size += CACHE_LINE - size % CACHE_LINE;
191972ba2109SAndrey Churbanov     KMP_ASSERT(input[i].reduce_comb != NULL); // combiner is mandatory
192072ba2109SAndrey Churbanov     arr[i].reduce_shar = input[i].reduce_shar;
192172ba2109SAndrey Churbanov     arr[i].reduce_size = size;
192272ba2109SAndrey Churbanov     arr[i].reduce_init = input[i].reduce_init;
192372ba2109SAndrey Churbanov     arr[i].reduce_fini = input[i].reduce_fini;
192472ba2109SAndrey Churbanov     arr[i].reduce_comb = input[i].reduce_comb;
192572ba2109SAndrey Churbanov     arr[i].flags = input[i].flags;
192672ba2109SAndrey Churbanov     if (!input[i].flags.lazy_priv) {
192772ba2109SAndrey Churbanov       // allocate cache-line aligned block and fill it with zeros
192872ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * size);
192972ba2109SAndrey Churbanov       arr[i].reduce_pend = (char *)(arr[i].reduce_priv) + nth * size;
193072ba2109SAndrey Churbanov       if (f_init != NULL) {
193172ba2109SAndrey Churbanov         // initialize thread-specific items
193272ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j) {
193372ba2109SAndrey Churbanov           f_init((char *)(arr[i].reduce_priv) + j * size);
193472ba2109SAndrey Churbanov         }
193572ba2109SAndrey Churbanov       }
193672ba2109SAndrey Churbanov     } else {
193772ba2109SAndrey Churbanov       // only allocate space for pointers now,
193872ba2109SAndrey Churbanov       // objects will be lazily allocated/initialized once requested
193972ba2109SAndrey Churbanov       arr[i].reduce_priv = __kmp_allocate(nth * sizeof(void *));
194072ba2109SAndrey Churbanov     }
194172ba2109SAndrey Churbanov   }
194272ba2109SAndrey Churbanov   tg->reduce_data = (void *)arr;
194372ba2109SAndrey Churbanov   tg->reduce_num_data = num;
194472ba2109SAndrey Churbanov   return (void *)tg;
194572ba2109SAndrey Churbanov }
194672ba2109SAndrey Churbanov 
194772ba2109SAndrey Churbanov /*!
194872ba2109SAndrey Churbanov @ingroup TASKING
194972ba2109SAndrey Churbanov @param gtid    Global thread ID
195072ba2109SAndrey Churbanov @param tskgrp  The taskgroup ID (optional)
195172ba2109SAndrey Churbanov @param data    Shared location of the item
195272ba2109SAndrey Churbanov @return The pointer to per-thread data
195372ba2109SAndrey Churbanov 
195472ba2109SAndrey Churbanov Get thread-specific location of data item
195572ba2109SAndrey Churbanov */
19563041982dSJonathan Peyton void *__kmpc_task_reduction_get_th_data(int gtid, void *tskgrp, void *data) {
195772ba2109SAndrey Churbanov   kmp_info_t *thread = __kmp_threads[gtid];
195872ba2109SAndrey Churbanov   kmp_int32 nth = thread->th.th_team_nproc;
195972ba2109SAndrey Churbanov   if (nth == 1)
196072ba2109SAndrey Churbanov     return data; // nothing to do
196172ba2109SAndrey Churbanov 
196272ba2109SAndrey Churbanov   kmp_taskgroup_t *tg = (kmp_taskgroup_t *)tskgrp;
196372ba2109SAndrey Churbanov   if (tg == NULL)
196472ba2109SAndrey Churbanov     tg = thread->th.th_current_task->td_taskgroup;
196572ba2109SAndrey Churbanov   KMP_ASSERT(tg != NULL);
196672ba2109SAndrey Churbanov   kmp_task_red_data_t *arr = (kmp_task_red_data_t *)(tg->reduce_data);
196772ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
196872ba2109SAndrey Churbanov   kmp_int32 tid = thread->th.th_info.ds.ds_tid;
196972ba2109SAndrey Churbanov 
197072ba2109SAndrey Churbanov   KMP_ASSERT(data != NULL);
197172ba2109SAndrey Churbanov   while (tg != NULL) {
197272ba2109SAndrey Churbanov     for (int i = 0; i < num; ++i) {
197372ba2109SAndrey Churbanov       if (!arr[i].flags.lazy_priv) {
197472ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar ||
197572ba2109SAndrey Churbanov             (data >= arr[i].reduce_priv && data < arr[i].reduce_pend))
197672ba2109SAndrey Churbanov           return (char *)(arr[i].reduce_priv) + tid * arr[i].reduce_size;
197772ba2109SAndrey Churbanov       } else {
197872ba2109SAndrey Churbanov         // check shared location first
197972ba2109SAndrey Churbanov         void **p_priv = (void **)(arr[i].reduce_priv);
198072ba2109SAndrey Churbanov         if (data == arr[i].reduce_shar)
198172ba2109SAndrey Churbanov           goto found;
198272ba2109SAndrey Churbanov         // check if we get some thread specific location as parameter
198372ba2109SAndrey Churbanov         for (int j = 0; j < nth; ++j)
198472ba2109SAndrey Churbanov           if (data == p_priv[j])
198572ba2109SAndrey Churbanov             goto found;
198672ba2109SAndrey Churbanov         continue; // not found, continue search
198772ba2109SAndrey Churbanov       found:
198872ba2109SAndrey Churbanov         if (p_priv[tid] == NULL) {
198972ba2109SAndrey Churbanov           // allocate thread specific object lazily
199072ba2109SAndrey Churbanov           void (*f_init)(void *) = (void (*)(void *))(arr[i].reduce_init);
199172ba2109SAndrey Churbanov           p_priv[tid] = __kmp_allocate(arr[i].reduce_size);
199272ba2109SAndrey Churbanov           if (f_init != NULL) {
199372ba2109SAndrey Churbanov             f_init(p_priv[tid]);
199472ba2109SAndrey Churbanov           }
199572ba2109SAndrey Churbanov         }
199672ba2109SAndrey Churbanov         return p_priv[tid];
199772ba2109SAndrey Churbanov       }
199872ba2109SAndrey Churbanov     }
199972ba2109SAndrey Churbanov     tg = tg->parent;
200072ba2109SAndrey Churbanov     arr = (kmp_task_red_data_t *)(tg->reduce_data);
200172ba2109SAndrey Churbanov     num = tg->reduce_num_data;
200272ba2109SAndrey Churbanov   }
200372ba2109SAndrey Churbanov   KMP_ASSERT2(0, "Unknown task reduction item");
200472ba2109SAndrey Churbanov   return NULL; // ERROR, this line never executed
200572ba2109SAndrey Churbanov }
200672ba2109SAndrey Churbanov 
200772ba2109SAndrey Churbanov // Finalize task reduction.
200872ba2109SAndrey Churbanov // Called from __kmpc_end_taskgroup()
20093041982dSJonathan Peyton static void __kmp_task_reduction_fini(kmp_info_t *th, kmp_taskgroup_t *tg) {
201072ba2109SAndrey Churbanov   kmp_int32 nth = th->th.th_team_nproc;
201172ba2109SAndrey Churbanov   KMP_DEBUG_ASSERT(nth > 1); // should not be called if nth == 1
201272ba2109SAndrey Churbanov   kmp_task_red_data_t *arr = (kmp_task_red_data_t *)tg->reduce_data;
201372ba2109SAndrey Churbanov   kmp_int32 num = tg->reduce_num_data;
201472ba2109SAndrey Churbanov   for (int i = 0; i < num; ++i) {
201572ba2109SAndrey Churbanov     void *sh_data = arr[i].reduce_shar;
201672ba2109SAndrey Churbanov     void (*f_fini)(void *) = (void (*)(void *))(arr[i].reduce_fini);
20173041982dSJonathan Peyton     void (*f_comb)(void *, void *) =
20183041982dSJonathan Peyton         (void (*)(void *, void *))(arr[i].reduce_comb);
201972ba2109SAndrey Churbanov     if (!arr[i].flags.lazy_priv) {
202072ba2109SAndrey Churbanov       void *pr_data = arr[i].reduce_priv;
202172ba2109SAndrey Churbanov       size_t size = arr[i].reduce_size;
202272ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
202372ba2109SAndrey Churbanov         void *priv_data = (char *)pr_data + j * size;
202472ba2109SAndrey Churbanov         f_comb(sh_data, priv_data); // combine results
202572ba2109SAndrey Churbanov         if (f_fini)
202672ba2109SAndrey Churbanov           f_fini(priv_data); // finalize if needed
202772ba2109SAndrey Churbanov       }
202872ba2109SAndrey Churbanov     } else {
202972ba2109SAndrey Churbanov       void **pr_data = (void **)(arr[i].reduce_priv);
203072ba2109SAndrey Churbanov       for (int j = 0; j < nth; ++j) {
203172ba2109SAndrey Churbanov         if (pr_data[j] != NULL) {
203272ba2109SAndrey Churbanov           f_comb(sh_data, pr_data[j]); // combine results
203372ba2109SAndrey Churbanov           if (f_fini)
203472ba2109SAndrey Churbanov             f_fini(pr_data[j]); // finalize if needed
203572ba2109SAndrey Churbanov           __kmp_free(pr_data[j]);
203672ba2109SAndrey Churbanov         }
203772ba2109SAndrey Churbanov       }
203872ba2109SAndrey Churbanov     }
203972ba2109SAndrey Churbanov     __kmp_free(arr[i].reduce_priv);
204072ba2109SAndrey Churbanov   }
204172ba2109SAndrey Churbanov   __kmp_thread_free(th, arr);
204272ba2109SAndrey Churbanov   tg->reduce_data = NULL;
204372ba2109SAndrey Churbanov   tg->reduce_num_data = 0;
204472ba2109SAndrey Churbanov }
204572ba2109SAndrey Churbanov #endif
20467cc577a4SJonathan Peyton 
20477cc577a4SJonathan Peyton #if OMP_40_ENABLED
20487cc577a4SJonathan Peyton // __kmpc_taskgroup: Start a new taskgroup
20493041982dSJonathan Peyton void __kmpc_taskgroup(ident_t *loc, int gtid) {
20507cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
20517cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
20527cc577a4SJonathan Peyton   kmp_taskgroup_t *tg_new =
20537cc577a4SJonathan Peyton       (kmp_taskgroup_t *)__kmp_thread_malloc(thread, sizeof(kmp_taskgroup_t));
20547cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_taskgroup: T#%d loc=%p group=%p\n", gtid, loc, tg_new));
205537e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->count, 0);
205637e2ef54SJonathan Peyton   KMP_ATOMIC_ST_RLX(&tg_new->cancel_request, cancel_noreq);
20577cc577a4SJonathan Peyton   tg_new->parent = taskdata->td_taskgroup;
205872ba2109SAndrey Churbanov // TODO: change to OMP_50_ENABLED, need to change build tools for this to work
205972ba2109SAndrey Churbanov #if OMP_45_ENABLED
206072ba2109SAndrey Churbanov   tg_new->reduce_data = NULL;
206172ba2109SAndrey Churbanov   tg_new->reduce_num_data = 0;
206272ba2109SAndrey Churbanov #endif
20637cc577a4SJonathan Peyton   taskdata->td_taskgroup = tg_new;
206482e94a59SJoachim Protze 
206582e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2066f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
206782e94a59SJoachim Protze     void *codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
206882e94a59SJoachim Protze     if (!codeptr)
206982e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
207082e94a59SJoachim Protze     kmp_team_t *team = thread->th.th_team;
207182e94a59SJoachim Protze     ompt_data_t my_task_data = taskdata->ompt_task_info.task_data;
207282e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
207382e94a59SJoachim Protze     ompt_data_t my_parallel_data = team->t.ompt_team_info.parallel_data;
207482e94a59SJoachim Protze 
207582e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
207682e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
207782e94a59SJoachim Protze         &(my_task_data), codeptr);
207882e94a59SJoachim Protze   }
207982e94a59SJoachim Protze #endif
20807cc577a4SJonathan Peyton }
20817cc577a4SJonathan Peyton 
20827cc577a4SJonathan Peyton // __kmpc_end_taskgroup: Wait until all tasks generated by the current task
20837cc577a4SJonathan Peyton //                       and its descendants are complete
20843041982dSJonathan Peyton void __kmpc_end_taskgroup(ident_t *loc, int gtid) {
20857cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
20867cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = thread->th.th_current_task;
20877cc577a4SJonathan Peyton   kmp_taskgroup_t *taskgroup = taskdata->td_taskgroup;
20887cc577a4SJonathan Peyton   int thread_finished = FALSE;
20897cc577a4SJonathan Peyton 
209082e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
209182e94a59SJoachim Protze   kmp_team_t *team;
209282e94a59SJoachim Protze   ompt_data_t my_task_data;
209382e94a59SJoachim Protze   ompt_data_t my_parallel_data;
209482e94a59SJoachim Protze   void *codeptr;
2095f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled)) {
209682e94a59SJoachim Protze     team = thread->th.th_team;
209782e94a59SJoachim Protze     my_task_data = taskdata->ompt_task_info.task_data;
209882e94a59SJoachim Protze     // FIXME: I think this is wrong for lwt!
209982e94a59SJoachim Protze     my_parallel_data = team->t.ompt_team_info.parallel_data;
210082e94a59SJoachim Protze     codeptr = OMPT_LOAD_RETURN_ADDRESS(gtid);
210182e94a59SJoachim Protze     if (!codeptr)
210282e94a59SJoachim Protze       codeptr = OMPT_GET_RETURN_ADDRESS(0);
210382e94a59SJoachim Protze   }
210482e94a59SJoachim Protze #endif
210582e94a59SJoachim Protze 
21067cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(enter): T#%d loc=%p\n", gtid, loc));
21077cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup != NULL);
21087cc577a4SJonathan Peyton   KMP_SET_THREAD_STATE_BLOCK(TASKGROUP);
21097cc577a4SJonathan Peyton 
21107cc577a4SJonathan Peyton   if (__kmp_tasking_mode != tskm_immediate_exec) {
2111a756cb24SAndrey Churbanov     // mark task as waiting not on a barrier
2112a756cb24SAndrey Churbanov     taskdata->td_taskwait_counter += 1;
2113a756cb24SAndrey Churbanov     taskdata->td_taskwait_ident = loc;
2114a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = gtid + 1;
21157cc577a4SJonathan Peyton #if USE_ITT_BUILD
21163041982dSJonathan Peyton     // For ITT the taskgroup wait is similar to taskwait until we need to
21173041982dSJonathan Peyton     // distinguish them
21187cc577a4SJonathan Peyton     void *itt_sync_obj = __kmp_itt_taskwait_object(gtid);
21197cc577a4SJonathan Peyton     if (itt_sync_obj != NULL)
21207cc577a4SJonathan Peyton       __kmp_itt_taskwait_starting(gtid, itt_sync_obj);
21217cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
21227cc577a4SJonathan Peyton 
212382e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2124f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
212582e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
212682e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_begin, &(my_parallel_data),
212782e94a59SJoachim Protze           &(my_task_data), codeptr);
212882e94a59SJoachim Protze     }
212982e94a59SJoachim Protze #endif
213082e94a59SJoachim Protze 
21317cc577a4SJonathan Peyton #if OMP_45_ENABLED
21323041982dSJonathan Peyton     if (!taskdata->td_flags.team_serial ||
21333041982dSJonathan Peyton         (thread->th.th_task_team != NULL &&
21343041982dSJonathan Peyton          thread->th.th_task_team->tt.tt_found_proxy_tasks))
21357cc577a4SJonathan Peyton #else
21367cc577a4SJonathan Peyton     if (!taskdata->td_flags.team_serial)
21377cc577a4SJonathan Peyton #endif
21387cc577a4SJonathan Peyton     {
213937e2ef54SJonathan Peyton       kmp_flag_32 flag(RCAST(std::atomic<kmp_uint32> *, &(taskgroup->count)),
214037e2ef54SJonathan Peyton                        0U);
214137e2ef54SJonathan Peyton       while (KMP_ATOMIC_LD_ACQ(&taskgroup->count) != 0) {
21423041982dSJonathan Peyton         flag.execute_tasks(thread, gtid, FALSE,
21433041982dSJonathan Peyton                            &thread_finished USE_ITT_BUILD_ARG(itt_sync_obj),
21443041982dSJonathan Peyton                            __kmp_task_stealing_constraint);
21457cc577a4SJonathan Peyton       }
21467cc577a4SJonathan Peyton     }
2147a756cb24SAndrey Churbanov     taskdata->td_taskwait_thread = -taskdata->td_taskwait_thread; // end waiting
21487cc577a4SJonathan Peyton 
214982e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2150f0a1c65fSJonas Hahnfeld     if (UNLIKELY(ompt_enabled.ompt_callback_sync_region_wait)) {
215182e94a59SJoachim Protze       ompt_callbacks.ompt_callback(ompt_callback_sync_region_wait)(
215282e94a59SJoachim Protze           ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
215382e94a59SJoachim Protze           &(my_task_data), codeptr);
215482e94a59SJoachim Protze     }
215582e94a59SJoachim Protze #endif
215682e94a59SJoachim Protze 
21577cc577a4SJonathan Peyton #if USE_ITT_BUILD
21587cc577a4SJonathan Peyton     if (itt_sync_obj != NULL)
21597cc577a4SJonathan Peyton       __kmp_itt_taskwait_finished(gtid, itt_sync_obj);
21607cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
21617cc577a4SJonathan Peyton   }
21627cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskgroup->count == 0);
21637cc577a4SJonathan Peyton 
216472ba2109SAndrey Churbanov // TODO: change to OMP_50_ENABLED, need to change build tools for this to work
216572ba2109SAndrey Churbanov #if OMP_45_ENABLED
216672ba2109SAndrey Churbanov   if (taskgroup->reduce_data != NULL) // need to reduce?
216772ba2109SAndrey Churbanov     __kmp_task_reduction_fini(thread, taskgroup);
216872ba2109SAndrey Churbanov #endif
21697cc577a4SJonathan Peyton   // Restore parent taskgroup for the current task
21707cc577a4SJonathan Peyton   taskdata->td_taskgroup = taskgroup->parent;
21717cc577a4SJonathan Peyton   __kmp_thread_free(thread, taskgroup);
21727cc577a4SJonathan Peyton 
21733041982dSJonathan Peyton   KA_TRACE(10, ("__kmpc_end_taskgroup(exit): T#%d task %p finished waiting\n",
21743041982dSJonathan Peyton                 gtid, taskdata));
21757cc577a4SJonathan Peyton   ANNOTATE_HAPPENS_AFTER(taskdata);
217682e94a59SJoachim Protze 
217782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
2178f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.ompt_callback_sync_region)) {
217982e94a59SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_sync_region)(
218082e94a59SJoachim Protze         ompt_sync_region_taskgroup, ompt_scope_end, &(my_parallel_data),
218182e94a59SJoachim Protze         &(my_task_data), codeptr);
218282e94a59SJoachim Protze   }
218382e94a59SJoachim Protze #endif
21847cc577a4SJonathan Peyton }
21857cc577a4SJonathan Peyton #endif
21867cc577a4SJonathan Peyton 
21877cc577a4SJonathan Peyton // __kmp_remove_my_task: remove a task from my own deque
21883041982dSJonathan Peyton static kmp_task_t *__kmp_remove_my_task(kmp_info_t *thread, kmp_int32 gtid,
21893041982dSJonathan Peyton                                         kmp_task_team_t *task_team,
21903041982dSJonathan Peyton                                         kmp_int32 is_constrained) {
21917cc577a4SJonathan Peyton   kmp_task_t *task;
21927cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
21937cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data;
21947cc577a4SJonathan Peyton   kmp_uint32 tail;
21957cc577a4SJonathan Peyton 
21967cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
21973041982dSJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_threads_data !=
21983041982dSJonathan Peyton                    NULL); // Caller should check this condition
21997cc577a4SJonathan Peyton 
22007cc577a4SJonathan Peyton   thread_data = &task_team->tt.tt_threads_data[__kmp_tid_from_gtid(gtid)];
22017cc577a4SJonathan Peyton 
22027cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(enter): T#%d ntasks=%d head=%u tail=%u\n",
22033041982dSJonathan Peyton                 gtid, thread_data->td.td_deque_ntasks,
22043041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
22057cc577a4SJonathan Peyton 
22067cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
22073041982dSJonathan Peyton     KA_TRACE(10,
22083041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #1): T#%d No tasks to remove: "
22093041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
22103041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
22113041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
22127cc577a4SJonathan Peyton     return NULL;
22137cc577a4SJonathan Peyton   }
22147cc577a4SJonathan Peyton 
22157cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
22167cc577a4SJonathan Peyton 
22177cc577a4SJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) == 0) {
22187cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
22193041982dSJonathan Peyton     KA_TRACE(10,
22203041982dSJonathan Peyton              ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
22213041982dSJonathan Peyton               "ntasks=%d head=%u tail=%u\n",
22223041982dSJonathan Peyton               gtid, thread_data->td.td_deque_ntasks,
22233041982dSJonathan Peyton               thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
22247cc577a4SJonathan Peyton     return NULL;
22257cc577a4SJonathan Peyton   }
22267cc577a4SJonathan Peyton 
22273041982dSJonathan Peyton   tail = (thread_data->td.td_deque_tail - 1) &
22283041982dSJonathan Peyton          TASK_DEQUE_MASK(thread_data->td); // Wrap index.
22297cc577a4SJonathan Peyton   taskdata = thread_data->td.td_deque[tail];
22307cc577a4SJonathan Peyton 
22317cc577a4SJonathan Peyton   if (is_constrained && (taskdata->td_flags.tiedness == TASK_TIED)) {
2232a756cb24SAndrey Churbanov     // we need to check if the candidate obeys task scheduling constraint (TSC)
2233a756cb24SAndrey Churbanov     // only descendant of all deferred tied tasks can be scheduled, checking
2234a756cb24SAndrey Churbanov     // the last one is enough, as it in turn is the descendant of all others
2235a756cb24SAndrey Churbanov     kmp_taskdata_t *current = thread->th.th_current_task->td_last_tied;
2236a756cb24SAndrey Churbanov     KMP_DEBUG_ASSERT(current != NULL);
2237a756cb24SAndrey Churbanov     // check if last tied task is not suspended on barrier
2238a756cb24SAndrey Churbanov     if (current->td_flags.tasktype == TASK_EXPLICIT ||
2239a756cb24SAndrey Churbanov         current->td_taskwait_thread > 0) { // <= 0 on barrier
22407cc577a4SJonathan Peyton       kmp_int32 level = current->td_level;
22417cc577a4SJonathan Peyton       kmp_taskdata_t *parent = taskdata->td_parent;
22427cc577a4SJonathan Peyton       while (parent != current && parent->td_level > level) {
22433041982dSJonathan Peyton         parent = parent->td_parent; // check generation up to the level of the
22443041982dSJonathan Peyton         // current task
22457cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(parent != NULL);
22467cc577a4SJonathan Peyton       }
22477cc577a4SJonathan Peyton       if (parent != current) {
2248a756cb24SAndrey Churbanov         // The TSC does not allow to steal victim task
22497cc577a4SJonathan Peyton         __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
2250a756cb24SAndrey Churbanov         KA_TRACE(10, ("__kmp_remove_my_task(exit #2): T#%d No tasks to remove: "
22513041982dSJonathan Peyton                       "ntasks=%d head=%u tail=%u\n",
22523041982dSJonathan Peyton                       gtid, thread_data->td.td_deque_ntasks,
2253a756cb24SAndrey Churbanov                       thread_data->td.td_deque_head,
2254a756cb24SAndrey Churbanov                       thread_data->td.td_deque_tail));
22557cc577a4SJonathan Peyton         return NULL;
22567cc577a4SJonathan Peyton       }
22577cc577a4SJonathan Peyton     }
2258a756cb24SAndrey Churbanov   }
22597cc577a4SJonathan Peyton 
22607cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = tail;
22617cc577a4SJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks, thread_data->td.td_deque_ntasks - 1);
22627cc577a4SJonathan Peyton 
22637cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
22647cc577a4SJonathan Peyton 
22653041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_remove_my_task(exit #2): T#%d task %p removed: "
22663041982dSJonathan Peyton                 "ntasks=%d head=%u tail=%u\n",
22673041982dSJonathan Peyton                 gtid, taskdata, thread_data->td.td_deque_ntasks,
22683041982dSJonathan Peyton                 thread_data->td.td_deque_head, thread_data->td.td_deque_tail));
22697cc577a4SJonathan Peyton 
22707cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
22717cc577a4SJonathan Peyton   return task;
22727cc577a4SJonathan Peyton }
22737cc577a4SJonathan Peyton 
22747cc577a4SJonathan Peyton // __kmp_steal_task: remove a task from another thread's deque
22757cc577a4SJonathan Peyton // Assume that calling thread has already checked existence of
22767cc577a4SJonathan Peyton // task_team thread_data before calling this routine.
2277a756cb24SAndrey Churbanov static kmp_task_t *__kmp_steal_task(kmp_info_t *victim_thr, kmp_int32 gtid,
2278c47afcd9SAndrey Churbanov                                     kmp_task_team_t *task_team,
227937e2ef54SJonathan Peyton                                     std::atomic<kmp_int32> *unfinished_threads,
2280c47afcd9SAndrey Churbanov                                     int *thread_finished,
2281c47afcd9SAndrey Churbanov                                     kmp_int32 is_constrained) {
22827cc577a4SJonathan Peyton   kmp_task_t *task;
22837cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
2284a756cb24SAndrey Churbanov   kmp_taskdata_t *current;
22857cc577a4SJonathan Peyton   kmp_thread_data_t *victim_td, *threads_data;
2286a756cb24SAndrey Churbanov   kmp_int32 level, target;
22877cc577a4SJonathan Peyton   kmp_int32 victim_tid;
22887cc577a4SJonathan Peyton 
22897cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
22907cc577a4SJonathan Peyton 
22917cc577a4SJonathan Peyton   threads_data = task_team->tt.tt_threads_data;
22927cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL); // Caller should check this condition
22937cc577a4SJonathan Peyton 
2294a756cb24SAndrey Churbanov   victim_tid = victim_thr->th.th_info.ds.ds_tid;
22957cc577a4SJonathan Peyton   victim_td = &threads_data[victim_tid];
22967cc577a4SJonathan Peyton 
22973041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_steal_task(enter): T#%d try to steal from T#%d: "
2298a756cb24SAndrey Churbanov                 "task_team=%p ntasks=%d head=%u tail=%u\n",
2299a756cb24SAndrey Churbanov                 gtid, __kmp_gtid_from_thread(victim_thr), task_team,
23003041982dSJonathan Peyton                 victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
23013041982dSJonathan Peyton                 victim_td->td.td_deque_tail));
23027cc577a4SJonathan Peyton 
2303a756cb24SAndrey Churbanov   if (TCR_4(victim_td->td.td_deque_ntasks) == 0) {
23043041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #1): T#%d could not steal from T#%d: "
2305a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2306a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team,
23073041982dSJonathan Peyton                   victim_td->td.td_deque_ntasks, victim_td->td.td_deque_head,
23083041982dSJonathan Peyton                   victim_td->td.td_deque_tail));
23097cc577a4SJonathan Peyton     return NULL;
23107cc577a4SJonathan Peyton   }
23117cc577a4SJonathan Peyton 
23127cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&victim_td->td.td_deque_lock);
23137cc577a4SJonathan Peyton 
2314a756cb24SAndrey Churbanov   int ntasks = TCR_4(victim_td->td.td_deque_ntasks);
23157cc577a4SJonathan Peyton   // Check again after we acquire the lock
2316a756cb24SAndrey Churbanov   if (ntasks == 0) {
23177cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
23183041982dSJonathan Peyton     KA_TRACE(10, ("__kmp_steal_task(exit #2): T#%d could not steal from T#%d: "
2319a756cb24SAndrey Churbanov                   "task_team=%p ntasks=%d head=%u tail=%u\n",
2320a756cb24SAndrey Churbanov                   gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2321a756cb24SAndrey Churbanov                   victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
23227cc577a4SJonathan Peyton     return NULL;
23237cc577a4SJonathan Peyton   }
23247cc577a4SJonathan Peyton 
23257cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(victim_td->td.td_deque != NULL);
23267cc577a4SJonathan Peyton 
23277cc577a4SJonathan Peyton   taskdata = victim_td->td.td_deque[victim_td->td.td_deque_head];
2328a756cb24SAndrey Churbanov   if (is_constrained && (taskdata->td_flags.tiedness == TASK_TIED)) {
2329a756cb24SAndrey Churbanov     // we need to check if the candidate obeys task scheduling constraint (TSC)
2330a756cb24SAndrey Churbanov     // only descendant of all deferred tied tasks can be scheduled, checking
2331a756cb24SAndrey Churbanov     // the last one is enough, as it in turn is the descendant of all others
2332a756cb24SAndrey Churbanov     current = __kmp_threads[gtid]->th.th_current_task->td_last_tied;
2333a756cb24SAndrey Churbanov     KMP_DEBUG_ASSERT(current != NULL);
2334a756cb24SAndrey Churbanov     // check if last tied task is not suspended on barrier
2335a756cb24SAndrey Churbanov     if (current->td_flags.tasktype == TASK_EXPLICIT ||
2336a756cb24SAndrey Churbanov         current->td_taskwait_thread > 0) { // <= 0 on barrier
2337a756cb24SAndrey Churbanov       level = current->td_level;
23387cc577a4SJonathan Peyton       kmp_taskdata_t *parent = taskdata->td_parent;
23397cc577a4SJonathan Peyton       while (parent != current && parent->td_level > level) {
23403041982dSJonathan Peyton         parent = parent->td_parent; // check generation up to the level of the
23413041982dSJonathan Peyton         // current task
23427cc577a4SJonathan Peyton         KMP_DEBUG_ASSERT(parent != NULL);
23437cc577a4SJonathan Peyton       }
23447cc577a4SJonathan Peyton       if (parent != current) {
2345a756cb24SAndrey Churbanov         if (!task_team->tt.tt_untied_task_encountered) {
2346a756cb24SAndrey Churbanov           // The TSC does not allow to steal victim task
23477cc577a4SJonathan Peyton           __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2348a756cb24SAndrey Churbanov           KA_TRACE(10,
2349a756cb24SAndrey Churbanov                    ("__kmp_steal_task(exit #3): T#%d could not steal from "
2350a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2351a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
23527cc577a4SJonathan Peyton                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
23537cc577a4SJonathan Peyton           return NULL;
23547cc577a4SJonathan Peyton         }
2355a756cb24SAndrey Churbanov         taskdata = NULL; // will check other tasks in victim's deque
23567cc577a4SJonathan Peyton       }
2357a756cb24SAndrey Churbanov     }
2358a756cb24SAndrey Churbanov   }
2359a756cb24SAndrey Churbanov   if (taskdata != NULL) {
23607cc577a4SJonathan Peyton     // Bump head pointer and Wrap.
23613041982dSJonathan Peyton     victim_td->td.td_deque_head =
23623041982dSJonathan Peyton         (victim_td->td.td_deque_head + 1) & TASK_DEQUE_MASK(victim_td->td);
2363a756cb24SAndrey Churbanov   } else {
2364a756cb24SAndrey Churbanov     int i;
2365a756cb24SAndrey Churbanov     // walk through victim's deque trying to steal any task
2366a756cb24SAndrey Churbanov     target = victim_td->td.td_deque_head;
2367a756cb24SAndrey Churbanov     for (i = 1; i < ntasks; ++i) {
2368a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2369a756cb24SAndrey Churbanov       taskdata = victim_td->td.td_deque[target];
2370a756cb24SAndrey Churbanov       if (taskdata->td_flags.tiedness == TASK_TIED) {
2371a756cb24SAndrey Churbanov         // check if the candidate obeys the TSC
2372a756cb24SAndrey Churbanov         kmp_taskdata_t *parent = taskdata->td_parent;
2373a756cb24SAndrey Churbanov         // check generation up to the level of the current task
2374a756cb24SAndrey Churbanov         while (parent != current && parent->td_level > level) {
2375a756cb24SAndrey Churbanov           parent = parent->td_parent;
2376a756cb24SAndrey Churbanov           KMP_DEBUG_ASSERT(parent != NULL);
2377a756cb24SAndrey Churbanov         }
2378a756cb24SAndrey Churbanov         if (parent != current) {
2379a756cb24SAndrey Churbanov           // The TSC does not allow to steal the candidate
2380a756cb24SAndrey Churbanov           taskdata = NULL;
2381a756cb24SAndrey Churbanov           continue;
2382a756cb24SAndrey Churbanov         } else {
2383a756cb24SAndrey Churbanov           // found victim tied task
2384a756cb24SAndrey Churbanov           break;
2385a756cb24SAndrey Churbanov         }
2386a756cb24SAndrey Churbanov       } else {
2387a756cb24SAndrey Churbanov         // found victim untied task
2388a756cb24SAndrey Churbanov         break;
2389a756cb24SAndrey Churbanov       }
2390a756cb24SAndrey Churbanov     }
2391a756cb24SAndrey Churbanov     if (taskdata == NULL) {
2392a756cb24SAndrey Churbanov       // No appropriate candidate to steal found
2393a756cb24SAndrey Churbanov       __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
2394a756cb24SAndrey Churbanov       KA_TRACE(10, ("__kmp_steal_task(exit #4): T#%d could not steal from "
2395a756cb24SAndrey Churbanov                     "T#%d: task_team=%p ntasks=%d head=%u tail=%u\n",
2396a756cb24SAndrey Churbanov                     gtid, __kmp_gtid_from_thread(victim_thr), task_team, ntasks,
2397a756cb24SAndrey Churbanov                     victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
2398a756cb24SAndrey Churbanov       return NULL;
2399a756cb24SAndrey Churbanov     }
2400a756cb24SAndrey Churbanov     int prev = target;
2401a756cb24SAndrey Churbanov     for (i = i + 1; i < ntasks; ++i) {
2402a756cb24SAndrey Churbanov       // shift remaining tasks in the deque left by 1
2403a756cb24SAndrey Churbanov       target = (target + 1) & TASK_DEQUE_MASK(victim_td->td);
2404a756cb24SAndrey Churbanov       victim_td->td.td_deque[prev] = victim_td->td.td_deque[target];
2405a756cb24SAndrey Churbanov       prev = target;
2406a756cb24SAndrey Churbanov     }
2407*baad3f60SJonathan Peyton     KMP_DEBUG_ASSERT(
2408*baad3f60SJonathan Peyton         victim_td->td.td_deque_tail ==
2409*baad3f60SJonathan Peyton         (kmp_uint32)((target + 1) & TASK_DEQUE_MASK(victim_td->td)));
2410a756cb24SAndrey Churbanov     victim_td->td.td_deque_tail = target; // tail -= 1 (wrapped))
2411a756cb24SAndrey Churbanov   }
24127cc577a4SJonathan Peyton   if (*thread_finished) {
24133041982dSJonathan Peyton     // We need to un-mark this victim as a finished victim.  This must be done
24143041982dSJonathan Peyton     // before releasing the lock, or else other threads (starting with the
24153041982dSJonathan Peyton     // master victim) might be prematurely released from the barrier!!!
2416c47afcd9SAndrey Churbanov     kmp_int32 count;
24177cc577a4SJonathan Peyton 
241837e2ef54SJonathan Peyton     count = KMP_ATOMIC_INC(unfinished_threads);
24197cc577a4SJonathan Peyton 
24203041982dSJonathan Peyton     KA_TRACE(
24213041982dSJonathan Peyton         20,
24223041982dSJonathan Peyton         ("__kmp_steal_task: T#%d inc unfinished_threads to %d: task_team=%p\n",
24237cc577a4SJonathan Peyton          gtid, count + 1, task_team));
24247cc577a4SJonathan Peyton 
24257cc577a4SJonathan Peyton     *thread_finished = FALSE;
24267cc577a4SJonathan Peyton   }
2427a756cb24SAndrey Churbanov   TCW_4(victim_td->td.td_deque_ntasks, ntasks - 1);
24283041982dSJonathan Peyton 
24297cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&victim_td->td.td_deque_lock);
24307cc577a4SJonathan Peyton 
24317cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(TASK_stolen);
2432a756cb24SAndrey Churbanov   KA_TRACE(10,
2433a756cb24SAndrey Churbanov            ("__kmp_steal_task(exit #5): T#%d stole task %p from T#%d: "
2434a756cb24SAndrey Churbanov             "task_team=%p ntasks=%d head=%u tail=%u\n",
2435a756cb24SAndrey Churbanov             gtid, taskdata, __kmp_gtid_from_thread(victim_thr), task_team,
2436a756cb24SAndrey Churbanov             ntasks, victim_td->td.td_deque_head, victim_td->td.td_deque_tail));
24377cc577a4SJonathan Peyton 
24387cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
24397cc577a4SJonathan Peyton   return task;
24407cc577a4SJonathan Peyton }
24417cc577a4SJonathan Peyton 
24423041982dSJonathan Peyton // __kmp_execute_tasks_template: Choose and execute tasks until either the
24433041982dSJonathan Peyton // condition is statisfied (return true) or there are none left (return false).
24443041982dSJonathan Peyton //
24457cc577a4SJonathan Peyton // final_spin is TRUE if this is the spin at the release barrier.
24467cc577a4SJonathan Peyton // thread_finished indicates whether the thread is finished executing all
24477cc577a4SJonathan Peyton // the tasks it has on its deque, and is at the release barrier.
24487cc577a4SJonathan Peyton // spinner is the location on which to spin.
24497cc577a4SJonathan Peyton // spinner == NULL means only execute a single task and return.
24507cc577a4SJonathan Peyton // checker is the value to check to terminate the spin.
24517cc577a4SJonathan Peyton template <class C>
24523041982dSJonathan Peyton static inline int __kmp_execute_tasks_template(
24533041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, C *flag, int final_spin,
24543041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
24553041982dSJonathan Peyton     kmp_int32 is_constrained) {
24567cc577a4SJonathan Peyton   kmp_task_team_t *task_team = thread->th.th_task_team;
24577cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
24587cc577a4SJonathan Peyton   kmp_task_t *task;
24597cc577a4SJonathan Peyton   kmp_info_t *other_thread;
24607cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
246137e2ef54SJonathan Peyton   std::atomic<kmp_int32> *unfinished_threads;
2462a756cb24SAndrey Churbanov   kmp_int32 nthreads, victim_tid = -2, use_own_tasks = 1, new_victim = 0,
24633041982dSJonathan Peyton                       tid = thread->th.th_info.ds.ds_tid;
24647cc577a4SJonathan Peyton 
24657cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
24667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread == __kmp_threads[gtid]);
24677cc577a4SJonathan Peyton 
24683041982dSJonathan Peyton   if (task_team == NULL)
24693041982dSJonathan Peyton     return FALSE;
24707cc577a4SJonathan Peyton 
24713041982dSJonathan Peyton   KA_TRACE(15, ("__kmp_execute_tasks_template(enter): T#%d final_spin=%d "
24723041982dSJonathan Peyton                 "*thread_finished=%d\n",
24737cc577a4SJonathan Peyton                 gtid, final_spin, *thread_finished));
24747cc577a4SJonathan Peyton 
2475581490e7SAndrey Churbanov   thread->th.th_reap_state = KMP_NOT_SAFE_TO_REAP;
24767cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
24777cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
24787cc577a4SJonathan Peyton 
24797cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
24807cc577a4SJonathan Peyton   unfinished_threads = &(task_team->tt.tt_unfinished_threads);
24817cc577a4SJonathan Peyton #if OMP_45_ENABLED
24827cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 1 || task_team->tt.tt_found_proxy_tasks);
24837cc577a4SJonathan Peyton #else
24847cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 1);
24857cc577a4SJonathan Peyton #endif
248637e2ef54SJonathan Peyton   KMP_DEBUG_ASSERT(*unfinished_threads >= 0);
24877cc577a4SJonathan Peyton 
24883041982dSJonathan Peyton   while (1) { // Outer loop keeps trying to find tasks in case of single thread
24893041982dSJonathan Peyton     // getting tasks from target constructs
24907cc577a4SJonathan Peyton     while (1) { // Inner loop to find a task and execute it
24917cc577a4SJonathan Peyton       task = NULL;
24927cc577a4SJonathan Peyton       if (use_own_tasks) { // check on own queue first
24937cc577a4SJonathan Peyton         task = __kmp_remove_my_task(thread, gtid, task_team, is_constrained);
24947cc577a4SJonathan Peyton       }
24957cc577a4SJonathan Peyton       if ((task == NULL) && (nthreads > 1)) { // Steal a task
24967cc577a4SJonathan Peyton         int asleep = 1;
24977cc577a4SJonathan Peyton         use_own_tasks = 0;
24987cc577a4SJonathan Peyton         // Try to steal from the last place I stole from successfully.
2499a756cb24SAndrey Churbanov         if (victim_tid == -2) { // haven't stolen anything yet
2500a756cb24SAndrey Churbanov           victim_tid = threads_data[tid].td.td_deque_last_stolen;
2501a756cb24SAndrey Churbanov           if (victim_tid !=
25023041982dSJonathan Peyton               -1) // if we have a last stolen from victim, get the thread
2503a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
25047cc577a4SJonathan Peyton         }
2505a756cb24SAndrey Churbanov         if (victim_tid != -1) { // found last victim
25067cc577a4SJonathan Peyton           asleep = 0;
25073041982dSJonathan Peyton         } else if (!new_victim) { // no recent steals and we haven't already
25083041982dSJonathan Peyton           // used a new victim; select a random thread
25097cc577a4SJonathan Peyton           do { // Find a different thread to steal work from.
25103041982dSJonathan Peyton             // Pick a random thread. Initial plan was to cycle through all the
25113041982dSJonathan Peyton             // threads, and only return if we tried to steal from every thread,
25123041982dSJonathan Peyton             // and failed.  Arch says that's not such a great idea.
2513a756cb24SAndrey Churbanov             victim_tid = __kmp_get_random(thread) % (nthreads - 1);
2514a756cb24SAndrey Churbanov             if (victim_tid >= tid) {
2515a756cb24SAndrey Churbanov               ++victim_tid; // Adjusts random distribution to exclude self
25167cc577a4SJonathan Peyton             }
25177cc577a4SJonathan Peyton             // Found a potential victim
2518a756cb24SAndrey Churbanov             other_thread = threads_data[victim_tid].td.td_thr;
25193041982dSJonathan Peyton             // There is a slight chance that __kmp_enable_tasking() did not wake
25203041982dSJonathan Peyton             // up all threads waiting at the barrier.  If victim is sleeping,
25213041982dSJonathan Peyton             // then wake it up. Since we were going to pay the cache miss
25223041982dSJonathan Peyton             // penalty for referencing another thread's kmp_info_t struct
25233041982dSJonathan Peyton             // anyway,
25243041982dSJonathan Peyton             // the check shouldn't cost too much performance at this point. In
25253041982dSJonathan Peyton             // extra barrier mode, tasks do not sleep at the separate tasking
25263041982dSJonathan Peyton             // barrier, so this isn't a problem.
25277cc577a4SJonathan Peyton             asleep = 0;
25287cc577a4SJonathan Peyton             if ((__kmp_tasking_mode == tskm_task_teams) &&
25297cc577a4SJonathan Peyton                 (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) &&
2530c47afcd9SAndrey Churbanov                 (TCR_PTR(CCAST(void *, other_thread->th.th_sleep_loc)) !=
2531c47afcd9SAndrey Churbanov                  NULL)) {
25327cc577a4SJonathan Peyton               asleep = 1;
25333041982dSJonathan Peyton               __kmp_null_resume_wrapper(__kmp_gtid_from_thread(other_thread),
25343041982dSJonathan Peyton                                         other_thread->th.th_sleep_loc);
25353041982dSJonathan Peyton               // A sleeping thread should not have any tasks on it's queue.
25363041982dSJonathan Peyton               // There is a slight possibility that it resumes, steals a task
25373041982dSJonathan Peyton               // from another thread, which spawns more tasks, all in the time
25383041982dSJonathan Peyton               // that it takes this thread to check => don't write an assertion
25393041982dSJonathan Peyton               // that the victim's queue is empty.  Try stealing from a
25403041982dSJonathan Peyton               // different thread.
25417cc577a4SJonathan Peyton             }
25427cc577a4SJonathan Peyton           } while (asleep);
25437cc577a4SJonathan Peyton         }
25447cc577a4SJonathan Peyton 
25457cc577a4SJonathan Peyton         if (!asleep) {
25467cc577a4SJonathan Peyton           // We have a victim to try to steal from
25473041982dSJonathan Peyton           task = __kmp_steal_task(other_thread, gtid, task_team,
25483041982dSJonathan Peyton                                   unfinished_threads, thread_finished,
25493041982dSJonathan Peyton                                   is_constrained);
25507cc577a4SJonathan Peyton         }
25517cc577a4SJonathan Peyton         if (task != NULL) { // set last stolen to victim
2552a756cb24SAndrey Churbanov           if (threads_data[tid].td.td_deque_last_stolen != victim_tid) {
2553a756cb24SAndrey Churbanov             threads_data[tid].td.td_deque_last_stolen = victim_tid;
25543041982dSJonathan Peyton             // The pre-refactored code did not try more than 1 successful new
25553041982dSJonathan Peyton             // vicitm, unless the last one generated more local tasks;
25563041982dSJonathan Peyton             // new_victim keeps track of this
25577cc577a4SJonathan Peyton             new_victim = 1;
25587cc577a4SJonathan Peyton           }
25593041982dSJonathan Peyton         } else { // No tasks found; unset last_stolen
25607cc577a4SJonathan Peyton           KMP_CHECK_UPDATE(threads_data[tid].td.td_deque_last_stolen, -1);
2561a756cb24SAndrey Churbanov           victim_tid = -2; // no successful victim found
25627cc577a4SJonathan Peyton         }
25637cc577a4SJonathan Peyton       }
25647cc577a4SJonathan Peyton 
25657cc577a4SJonathan Peyton       if (task == NULL) // break out of tasking loop
25667cc577a4SJonathan Peyton         break;
25677cc577a4SJonathan Peyton 
25687cc577a4SJonathan Peyton // Found a task; execute it
25697cc577a4SJonathan Peyton #if USE_ITT_BUILD && USE_ITT_NOTIFY
25707cc577a4SJonathan Peyton       if (__itt_sync_create_ptr || KMP_ITT_DEBUG) {
25713041982dSJonathan Peyton         if (itt_sync_obj == NULL) { // we are at fork barrier where we could not
25723041982dSJonathan Peyton           // get the object reliably
25737cc577a4SJonathan Peyton           itt_sync_obj = __kmp_itt_barrier_object(gtid, bs_forkjoin_barrier);
25747cc577a4SJonathan Peyton         }
25757cc577a4SJonathan Peyton         __kmp_itt_task_starting(itt_sync_obj);
25767cc577a4SJonathan Peyton       }
25777cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD && USE_ITT_NOTIFY */
25787cc577a4SJonathan Peyton       __kmp_invoke_task(gtid, task, current_task);
25797cc577a4SJonathan Peyton #if USE_ITT_BUILD
25803041982dSJonathan Peyton       if (itt_sync_obj != NULL)
25813041982dSJonathan Peyton         __kmp_itt_task_finished(itt_sync_obj);
25827cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
25833041982dSJonathan Peyton       // If this thread is only partway through the barrier and the condition is
25843041982dSJonathan Peyton       // met, then return now, so that the barrier gather/release pattern can
25853041982dSJonathan Peyton       // proceed. If this thread is in the last spin loop in the barrier,
25863041982dSJonathan Peyton       // waiting to be released, we know that the termination condition will not
25873041982dSJonathan Peyton       // be satisified, so don't waste any cycles checking it.
25887cc577a4SJonathan Peyton       if (flag == NULL || (!final_spin && flag->done_check())) {
25893041982dSJonathan Peyton         KA_TRACE(
25903041982dSJonathan Peyton             15,
25913041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
25923041982dSJonathan Peyton              gtid));
25937cc577a4SJonathan Peyton         return TRUE;
25947cc577a4SJonathan Peyton       }
25957cc577a4SJonathan Peyton       if (thread->th.th_task_team == NULL) {
25967cc577a4SJonathan Peyton         break;
25977cc577a4SJonathan Peyton       }
25983041982dSJonathan Peyton       // Yield before executing next task
25993041982dSJonathan Peyton       KMP_YIELD(__kmp_library == library_throughput);
26003041982dSJonathan Peyton       // If execution of a stolen task results in more tasks being placed on our
26013041982dSJonathan Peyton       // run queue, reset use_own_tasks
26027cc577a4SJonathan Peyton       if (!use_own_tasks && TCR_4(threads_data[tid].td.td_deque_ntasks) != 0) {
26033041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d stolen task spawned "
26043041982dSJonathan Peyton                       "other tasks, restart\n",
26053041982dSJonathan Peyton                       gtid));
26067cc577a4SJonathan Peyton         use_own_tasks = 1;
26077cc577a4SJonathan Peyton         new_victim = 0;
26087cc577a4SJonathan Peyton       }
26097cc577a4SJonathan Peyton     }
26107cc577a4SJonathan Peyton 
26113041982dSJonathan Peyton // The task source has been exhausted. If in final spin loop of barrier, check
26123041982dSJonathan Peyton // if termination condition is satisfied.
26137cc577a4SJonathan Peyton #if OMP_45_ENABLED
26143041982dSJonathan Peyton     // The work queue may be empty but there might be proxy tasks still
26153041982dSJonathan Peyton     // executing
261637e2ef54SJonathan Peyton     if (final_spin &&
261737e2ef54SJonathan Peyton         KMP_ATOMIC_LD_ACQ(&current_task->td_incomplete_child_tasks) == 0)
26187cc577a4SJonathan Peyton #else
26197cc577a4SJonathan Peyton     if (final_spin)
26207cc577a4SJonathan Peyton #endif
26217cc577a4SJonathan Peyton     {
26223041982dSJonathan Peyton       // First, decrement the #unfinished threads, if that has not already been
26233041982dSJonathan Peyton       // done.  This decrement might be to the spin location, and result in the
26243041982dSJonathan Peyton       // termination condition being satisfied.
26257cc577a4SJonathan Peyton       if (!*thread_finished) {
2626c47afcd9SAndrey Churbanov         kmp_int32 count;
26277cc577a4SJonathan Peyton 
262837e2ef54SJonathan Peyton         count = KMP_ATOMIC_DEC(unfinished_threads) - 1;
26293041982dSJonathan Peyton         KA_TRACE(20, ("__kmp_execute_tasks_template: T#%d dec "
26303041982dSJonathan Peyton                       "unfinished_threads to %d task_team=%p\n",
26317cc577a4SJonathan Peyton                       gtid, count, task_team));
26327cc577a4SJonathan Peyton         *thread_finished = TRUE;
26337cc577a4SJonathan Peyton       }
26347cc577a4SJonathan Peyton 
26357cc577a4SJonathan Peyton       // It is now unsafe to reference thread->th.th_team !!!
26363041982dSJonathan Peyton       // Decrementing task_team->tt.tt_unfinished_threads can allow the master
26373041982dSJonathan Peyton       // thread to pass through the barrier, where it might reset each thread's
26383041982dSJonathan Peyton       // th.th_team field for the next parallel region. If we can steal more
26393041982dSJonathan Peyton       // work, we know that this has not happened yet.
26407cc577a4SJonathan Peyton       if (flag != NULL && flag->done_check()) {
26413041982dSJonathan Peyton         KA_TRACE(
26423041982dSJonathan Peyton             15,
26433041982dSJonathan Peyton             ("__kmp_execute_tasks_template: T#%d spin condition satisfied\n",
26443041982dSJonathan Peyton              gtid));
26457cc577a4SJonathan Peyton         return TRUE;
26467cc577a4SJonathan Peyton       }
26477cc577a4SJonathan Peyton     }
26487cc577a4SJonathan Peyton 
26493041982dSJonathan Peyton     // If this thread's task team is NULL, master has recognized that there are
26503041982dSJonathan Peyton     // no more tasks; bail out
26517cc577a4SJonathan Peyton     if (thread->th.th_task_team == NULL) {
26523041982dSJonathan Peyton       KA_TRACE(15,
26533041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d no more tasks\n", gtid));
26547cc577a4SJonathan Peyton       return FALSE;
26557cc577a4SJonathan Peyton     }
26567cc577a4SJonathan Peyton 
26577cc577a4SJonathan Peyton #if OMP_45_ENABLED
26583041982dSJonathan Peyton     // We could be getting tasks from target constructs; if this is the only
26593041982dSJonathan Peyton     // thread, keep trying to execute tasks from own queue
26607cc577a4SJonathan Peyton     if (nthreads == 1)
26617cc577a4SJonathan Peyton       use_own_tasks = 1;
26627cc577a4SJonathan Peyton     else
26637cc577a4SJonathan Peyton #endif
26647cc577a4SJonathan Peyton     {
26653041982dSJonathan Peyton       KA_TRACE(15,
26663041982dSJonathan Peyton                ("__kmp_execute_tasks_template: T#%d can't find work\n", gtid));
26677cc577a4SJonathan Peyton       return FALSE;
26687cc577a4SJonathan Peyton     }
26697cc577a4SJonathan Peyton   }
26707cc577a4SJonathan Peyton }
26717cc577a4SJonathan Peyton 
26723041982dSJonathan Peyton int __kmp_execute_tasks_32(
26733041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_32 *flag, int final_spin,
26743041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
26753041982dSJonathan Peyton     kmp_int32 is_constrained) {
26763041982dSJonathan Peyton   return __kmp_execute_tasks_template(
26773041982dSJonathan Peyton       thread, gtid, flag, final_spin,
26783041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
26797cc577a4SJonathan Peyton }
26807cc577a4SJonathan Peyton 
26813041982dSJonathan Peyton int __kmp_execute_tasks_64(
26823041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_64 *flag, int final_spin,
26833041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
26843041982dSJonathan Peyton     kmp_int32 is_constrained) {
26853041982dSJonathan Peyton   return __kmp_execute_tasks_template(
26863041982dSJonathan Peyton       thread, gtid, flag, final_spin,
26873041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
26887cc577a4SJonathan Peyton }
26897cc577a4SJonathan Peyton 
26903041982dSJonathan Peyton int __kmp_execute_tasks_oncore(
26913041982dSJonathan Peyton     kmp_info_t *thread, kmp_int32 gtid, kmp_flag_oncore *flag, int final_spin,
26923041982dSJonathan Peyton     int *thread_finished USE_ITT_BUILD_ARG(void *itt_sync_obj),
26933041982dSJonathan Peyton     kmp_int32 is_constrained) {
26943041982dSJonathan Peyton   return __kmp_execute_tasks_template(
26953041982dSJonathan Peyton       thread, gtid, flag, final_spin,
26963041982dSJonathan Peyton       thread_finished USE_ITT_BUILD_ARG(itt_sync_obj), is_constrained);
26977cc577a4SJonathan Peyton }
26987cc577a4SJonathan Peyton 
26997cc577a4SJonathan Peyton // __kmp_enable_tasking: Allocate task team and resume threads sleeping at the
27007cc577a4SJonathan Peyton // next barrier so they can assist in executing enqueued tasks.
27017cc577a4SJonathan Peyton // First thread in allocates the task team atomically.
27023041982dSJonathan Peyton static void __kmp_enable_tasking(kmp_task_team_t *task_team,
27033041982dSJonathan Peyton                                  kmp_info_t *this_thr) {
27047cc577a4SJonathan Peyton   kmp_thread_data_t *threads_data;
27057cc577a4SJonathan Peyton   int nthreads, i, is_init_thread;
27067cc577a4SJonathan Peyton 
27077cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(enter): T#%d\n",
27087cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
27097cc577a4SJonathan Peyton 
27107cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
27117cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(this_thr->th.th_team != NULL);
27127cc577a4SJonathan Peyton 
27137cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
27147cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads > 0);
27157cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(nthreads == this_thr->th.th_team->t.t_nproc);
27167cc577a4SJonathan Peyton 
27177cc577a4SJonathan Peyton   // Allocate or increase the size of threads_data if necessary
27187cc577a4SJonathan Peyton   is_init_thread = __kmp_realloc_task_threads_data(this_thr, task_team);
27197cc577a4SJonathan Peyton 
27207cc577a4SJonathan Peyton   if (!is_init_thread) {
27217cc577a4SJonathan Peyton     // Some other thread already set up the array.
27223041982dSJonathan Peyton     KA_TRACE(
27233041982dSJonathan Peyton         20,
27243041982dSJonathan Peyton         ("__kmp_enable_tasking(exit): T#%d: threads array already set up.\n",
27257cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr)));
27267cc577a4SJonathan Peyton     return;
27277cc577a4SJonathan Peyton   }
27287cc577a4SJonathan Peyton   threads_data = (kmp_thread_data_t *)TCR_PTR(task_team->tt.tt_threads_data);
27297cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(threads_data != NULL);
27307cc577a4SJonathan Peyton 
27317cc577a4SJonathan Peyton   if ((__kmp_tasking_mode == tskm_task_teams) &&
27323041982dSJonathan Peyton       (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME)) {
27337cc577a4SJonathan Peyton     // Release any threads sleeping at the barrier, so that they can steal
27347cc577a4SJonathan Peyton     // tasks and execute them.  In extra barrier mode, tasks do not sleep
27357cc577a4SJonathan Peyton     // at the separate tasking barrier, so this isn't a problem.
27367cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
27377cc577a4SJonathan Peyton       volatile void *sleep_loc;
27387cc577a4SJonathan Peyton       kmp_info_t *thread = threads_data[i].td.td_thr;
27397cc577a4SJonathan Peyton 
27407cc577a4SJonathan Peyton       if (i == this_thr->th.th_info.ds.ds_tid) {
27417cc577a4SJonathan Peyton         continue;
27427cc577a4SJonathan Peyton       }
27437cc577a4SJonathan Peyton       // Since we haven't locked the thread's suspend mutex lock at this
27447cc577a4SJonathan Peyton       // point, there is a small window where a thread might be putting
27457cc577a4SJonathan Peyton       // itself to sleep, but hasn't set the th_sleep_loc field yet.
27467cc577a4SJonathan Peyton       // To work around this, __kmp_execute_tasks_template() periodically checks
27473041982dSJonathan Peyton       // see if other threads are sleeping (using the same random mechanism that
27483041982dSJonathan Peyton       // is used for task stealing) and awakens them if they are.
2749c47afcd9SAndrey Churbanov       if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
2750c47afcd9SAndrey Churbanov           NULL) {
27517cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d waking up thread T#%d\n",
27527cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
27537cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
27547cc577a4SJonathan Peyton         __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
27553041982dSJonathan Peyton       } else {
27567cc577a4SJonathan Peyton         KF_TRACE(50, ("__kmp_enable_tasking: T#%d don't wake up thread T#%d\n",
27577cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(this_thr),
27587cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
27597cc577a4SJonathan Peyton       }
27607cc577a4SJonathan Peyton     }
27617cc577a4SJonathan Peyton   }
27627cc577a4SJonathan Peyton 
27637cc577a4SJonathan Peyton   KA_TRACE(10, ("__kmp_enable_tasking(exit): T#%d\n",
27647cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(this_thr)));
27657cc577a4SJonathan Peyton }
27667cc577a4SJonathan Peyton 
27677cc577a4SJonathan Peyton /* // TODO: Check the comment consistency
27687cc577a4SJonathan Peyton  * Utility routines for "task teams".  A task team (kmp_task_t) is kind of
27697cc577a4SJonathan Peyton  * like a shadow of the kmp_team_t data struct, with a different lifetime.
27707cc577a4SJonathan Peyton  * After a child * thread checks into a barrier and calls __kmp_release() from
27717cc577a4SJonathan Peyton  * the particular variant of __kmp_<barrier_kind>_barrier_gather(), it can no
27727cc577a4SJonathan Peyton  * longer assume that the kmp_team_t structure is intact (at any moment, the
27737cc577a4SJonathan Peyton  * master thread may exit the barrier code and free the team data structure,
27747cc577a4SJonathan Peyton  * and return the threads to the thread pool).
27757cc577a4SJonathan Peyton  *
27767cc577a4SJonathan Peyton  * This does not work with the the tasking code, as the thread is still
27777cc577a4SJonathan Peyton  * expected to participate in the execution of any tasks that may have been
27787cc577a4SJonathan Peyton  * spawned my a member of the team, and the thread still needs access to all
27797cc577a4SJonathan Peyton  * to each thread in the team, so that it can steal work from it.
27807cc577a4SJonathan Peyton  *
27817cc577a4SJonathan Peyton  * Enter the existence of the kmp_task_team_t struct.  It employs a reference
27827cc577a4SJonathan Peyton  * counting mechanims, and is allocated by the master thread before calling
27837cc577a4SJonathan Peyton  * __kmp_<barrier_kind>_release, and then is release by the last thread to
27847cc577a4SJonathan Peyton  * exit __kmp_<barrier_kind>_release at the next barrier.  I.e. the lifetimes
27857cc577a4SJonathan Peyton  * of the kmp_task_team_t structs for consecutive barriers can overlap
27867cc577a4SJonathan Peyton  * (and will, unless the master thread is the last thread to exit the barrier
27877cc577a4SJonathan Peyton  * release phase, which is not typical).
27887cc577a4SJonathan Peyton  *
27897cc577a4SJonathan Peyton  * The existence of such a struct is useful outside the context of tasking,
27907cc577a4SJonathan Peyton  * but for now, I'm trying to keep it specific to the OMP_30_ENABLED macro,
27917cc577a4SJonathan Peyton  * so that any performance differences show up when comparing the 2.5 vs. 3.0
27927cc577a4SJonathan Peyton  * libraries.
27937cc577a4SJonathan Peyton  *
27947cc577a4SJonathan Peyton  * We currently use the existence of the threads array as an indicator that
27957cc577a4SJonathan Peyton  * tasks were spawned since the last barrier.  If the structure is to be
27967cc577a4SJonathan Peyton  * useful outside the context of tasking, then this will have to change, but
27977cc577a4SJonathan Peyton  * not settting the field minimizes the performance impact of tasking on
27987cc577a4SJonathan Peyton  * barriers, when no explicit tasks were spawned (pushed, actually).
27997cc577a4SJonathan Peyton  */
28007cc577a4SJonathan Peyton 
28013041982dSJonathan Peyton static kmp_task_team_t *__kmp_free_task_teams =
28023041982dSJonathan Peyton     NULL; // Free list for task_team data structures
28037cc577a4SJonathan Peyton // Lock for task team data structures
2804eaa9e40cSJonathan Peyton kmp_bootstrap_lock_t __kmp_task_team_lock =
28053041982dSJonathan Peyton     KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_task_team_lock);
28067cc577a4SJonathan Peyton 
28077cc577a4SJonathan Peyton // __kmp_alloc_task_deque:
28087cc577a4SJonathan Peyton // Allocates a task deque for a particular thread, and initialize the necessary
28097cc577a4SJonathan Peyton // data structures relating to the deque.  This only happens once per thread
28103041982dSJonathan Peyton // per task team since task teams are recycled. No lock is needed during
28113041982dSJonathan Peyton // allocation since each thread allocates its own deque.
28123041982dSJonathan Peyton static void __kmp_alloc_task_deque(kmp_info_t *thread,
28133041982dSJonathan Peyton                                    kmp_thread_data_t *thread_data) {
28147cc577a4SJonathan Peyton   __kmp_init_bootstrap_lock(&thread_data->td.td_deque_lock);
28157cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque == NULL);
28167cc577a4SJonathan Peyton 
28177cc577a4SJonathan Peyton   // Initialize last stolen task field to "none"
28187cc577a4SJonathan Peyton   thread_data->td.td_deque_last_stolen = -1;
28197cc577a4SJonathan Peyton 
28207cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(TCR_4(thread_data->td.td_deque_ntasks) == 0);
28217cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_head == 0);
28227cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(thread_data->td.td_deque_tail == 0);
28237cc577a4SJonathan Peyton 
28243041982dSJonathan Peyton   KE_TRACE(
28253041982dSJonathan Peyton       10,
28263041982dSJonathan Peyton       ("__kmp_alloc_task_deque: T#%d allocating deque[%d] for thread_data %p\n",
28277cc577a4SJonathan Peyton        __kmp_gtid_from_thread(thread), INITIAL_TASK_DEQUE_SIZE, thread_data));
28287cc577a4SJonathan Peyton   // Allocate space for task deque, and zero the deque
28297cc577a4SJonathan Peyton   // Cannot use __kmp_thread_calloc() because threads not around for
28307cc577a4SJonathan Peyton   // kmp_reap_task_team( ).
28313041982dSJonathan Peyton   thread_data->td.td_deque = (kmp_taskdata_t **)__kmp_allocate(
28323041982dSJonathan Peyton       INITIAL_TASK_DEQUE_SIZE * sizeof(kmp_taskdata_t *));
28337cc577a4SJonathan Peyton   thread_data->td.td_deque_size = INITIAL_TASK_DEQUE_SIZE;
28347cc577a4SJonathan Peyton }
28357cc577a4SJonathan Peyton 
28367cc577a4SJonathan Peyton // __kmp_realloc_task_deque:
28373041982dSJonathan Peyton // Re-allocates a task deque for a particular thread, copies the content from
28383041982dSJonathan Peyton // the old deque and adjusts the necessary data structures relating to the
28393041982dSJonathan Peyton // deque. This operation must be done with a the deque_lock being held
28403041982dSJonathan Peyton static void __kmp_realloc_task_deque(kmp_info_t *thread,
28413041982dSJonathan Peyton                                      kmp_thread_data_t *thread_data) {
28427cc577a4SJonathan Peyton   kmp_int32 size = TASK_DEQUE_SIZE(thread_data->td);
28437cc577a4SJonathan Peyton   kmp_int32 new_size = 2 * size;
28447cc577a4SJonathan Peyton 
28453041982dSJonathan Peyton   KE_TRACE(10, ("__kmp_realloc_task_deque: T#%d reallocating deque[from %d to "
28463041982dSJonathan Peyton                 "%d] for thread_data %p\n",
28477cc577a4SJonathan Peyton                 __kmp_gtid_from_thread(thread), size, new_size, thread_data));
28487cc577a4SJonathan Peyton 
28493041982dSJonathan Peyton   kmp_taskdata_t **new_deque =
28503041982dSJonathan Peyton       (kmp_taskdata_t **)__kmp_allocate(new_size * sizeof(kmp_taskdata_t *));
28517cc577a4SJonathan Peyton 
28527cc577a4SJonathan Peyton   int i, j;
28533041982dSJonathan Peyton   for (i = thread_data->td.td_deque_head, j = 0; j < size;
28543041982dSJonathan Peyton        i = (i + 1) & TASK_DEQUE_MASK(thread_data->td), j++)
28557cc577a4SJonathan Peyton     new_deque[j] = thread_data->td.td_deque[i];
28567cc577a4SJonathan Peyton 
28577cc577a4SJonathan Peyton   __kmp_free(thread_data->td.td_deque);
28587cc577a4SJonathan Peyton 
28597cc577a4SJonathan Peyton   thread_data->td.td_deque_head = 0;
28607cc577a4SJonathan Peyton   thread_data->td.td_deque_tail = size;
28617cc577a4SJonathan Peyton   thread_data->td.td_deque = new_deque;
28627cc577a4SJonathan Peyton   thread_data->td.td_deque_size = new_size;
28637cc577a4SJonathan Peyton }
28647cc577a4SJonathan Peyton 
28657cc577a4SJonathan Peyton // __kmp_free_task_deque:
28663041982dSJonathan Peyton // Deallocates a task deque for a particular thread. Happens at library
28673041982dSJonathan Peyton // deallocation so don't need to reset all thread data fields.
28683041982dSJonathan Peyton static void __kmp_free_task_deque(kmp_thread_data_t *thread_data) {
28697cc577a4SJonathan Peyton   if (thread_data->td.td_deque != NULL) {
28701b536724SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
28717cc577a4SJonathan Peyton     TCW_4(thread_data->td.td_deque_ntasks, 0);
28727cc577a4SJonathan Peyton     __kmp_free(thread_data->td.td_deque);
28737cc577a4SJonathan Peyton     thread_data->td.td_deque = NULL;
28747cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
28751b536724SJonathan Peyton   }
28767cc577a4SJonathan Peyton 
28777cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
28787cc577a4SJonathan Peyton   // GEH: Figure out what to do here for td_susp_tied_tasks
28797cc577a4SJonathan Peyton   if (thread_data->td.td_susp_tied_tasks.ts_entries != TASK_STACK_EMPTY) {
28807cc577a4SJonathan Peyton     __kmp_free_task_stack(__kmp_thread_from_gtid(gtid), thread_data);
28817cc577a4SJonathan Peyton   }
28827cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
28837cc577a4SJonathan Peyton }
28847cc577a4SJonathan Peyton 
28857cc577a4SJonathan Peyton // __kmp_realloc_task_threads_data:
28863041982dSJonathan Peyton // Allocates a threads_data array for a task team, either by allocating an
28873041982dSJonathan Peyton // initial array or enlarging an existing array.  Only the first thread to get
28883041982dSJonathan Peyton // the lock allocs or enlarges the array and re-initializes the array eleemnts.
28897cc577a4SJonathan Peyton // That thread returns "TRUE", the rest return "FALSE".
28907cc577a4SJonathan Peyton // Assumes that the new array size is given by task_team -> tt.tt_nproc.
28917cc577a4SJonathan Peyton // The current size is given by task_team -> tt.tt_max_threads.
28923041982dSJonathan Peyton static int __kmp_realloc_task_threads_data(kmp_info_t *thread,
28933041982dSJonathan Peyton                                            kmp_task_team_t *task_team) {
28947cc577a4SJonathan Peyton   kmp_thread_data_t **threads_data_p;
28957cc577a4SJonathan Peyton   kmp_int32 nthreads, maxthreads;
28967cc577a4SJonathan Peyton   int is_init_thread = FALSE;
28977cc577a4SJonathan Peyton 
28987cc577a4SJonathan Peyton   if (TCR_4(task_team->tt.tt_found_tasks)) {
28997cc577a4SJonathan Peyton     // Already reallocated and initialized.
29007cc577a4SJonathan Peyton     return FALSE;
29017cc577a4SJonathan Peyton   }
29027cc577a4SJonathan Peyton 
29037cc577a4SJonathan Peyton   threads_data_p = &task_team->tt.tt_threads_data;
29047cc577a4SJonathan Peyton   nthreads = task_team->tt.tt_nproc;
29057cc577a4SJonathan Peyton   maxthreads = task_team->tt.tt_max_threads;
29067cc577a4SJonathan Peyton 
29073041982dSJonathan Peyton   // All threads must lock when they encounter the first task of the implicit
29083041982dSJonathan Peyton   // task region to make sure threads_data fields are (re)initialized before
29093041982dSJonathan Peyton   // used.
29107cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
29117cc577a4SJonathan Peyton 
29127cc577a4SJonathan Peyton   if (!TCR_4(task_team->tt.tt_found_tasks)) {
29137cc577a4SJonathan Peyton     // first thread to enable tasking
29147cc577a4SJonathan Peyton     kmp_team_t *team = thread->th.th_team;
29157cc577a4SJonathan Peyton     int i;
29167cc577a4SJonathan Peyton 
29177cc577a4SJonathan Peyton     is_init_thread = TRUE;
29187cc577a4SJonathan Peyton     if (maxthreads < nthreads) {
29197cc577a4SJonathan Peyton 
29207cc577a4SJonathan Peyton       if (*threads_data_p != NULL) {
29217cc577a4SJonathan Peyton         kmp_thread_data_t *old_data = *threads_data_p;
29227cc577a4SJonathan Peyton         kmp_thread_data_t *new_data = NULL;
29237cc577a4SJonathan Peyton 
29243041982dSJonathan Peyton         KE_TRACE(
29253041982dSJonathan Peyton             10,
29263041982dSJonathan Peyton             ("__kmp_realloc_task_threads_data: T#%d reallocating "
29277cc577a4SJonathan Peyton              "threads data for task_team %p, new_size = %d, old_size = %d\n",
29283041982dSJonathan Peyton              __kmp_gtid_from_thread(thread), task_team, nthreads, maxthreads));
29297cc577a4SJonathan Peyton         // Reallocate threads_data to have more elements than current array
29307cc577a4SJonathan Peyton         // Cannot use __kmp_thread_realloc() because threads not around for
29317cc577a4SJonathan Peyton         // kmp_reap_task_team( ).  Note all new array entries are initialized
29327cc577a4SJonathan Peyton         // to zero by __kmp_allocate().
29333041982dSJonathan Peyton         new_data = (kmp_thread_data_t *)__kmp_allocate(
29343041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
29357cc577a4SJonathan Peyton         // copy old data to new data
29367cc577a4SJonathan Peyton         KMP_MEMCPY_S((void *)new_data, nthreads * sizeof(kmp_thread_data_t),
293771483f2dSAndrey Churbanov                      (void *)old_data, maxthreads * sizeof(kmp_thread_data_t));
29387cc577a4SJonathan Peyton 
29397cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
29407cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
29417cc577a4SJonathan Peyton         for (i = maxthreads; i < nthreads; i++) {
29427cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
29437cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
29447cc577a4SJonathan Peyton         }
29457cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
29467cc577a4SJonathan Peyton         // Install the new data and free the old data
29477cc577a4SJonathan Peyton         (*threads_data_p) = new_data;
29487cc577a4SJonathan Peyton         __kmp_free(old_data);
29493041982dSJonathan Peyton       } else {
29507cc577a4SJonathan Peyton         KE_TRACE(10, ("__kmp_realloc_task_threads_data: T#%d allocating "
29517cc577a4SJonathan Peyton                       "threads data for task_team %p, size = %d\n",
29527cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread), task_team, nthreads));
29537cc577a4SJonathan Peyton         // Make the initial allocate for threads_data array, and zero entries
29547cc577a4SJonathan Peyton         // Cannot use __kmp_thread_calloc() because threads not around for
29557cc577a4SJonathan Peyton         // kmp_reap_task_team( ).
29567cc577a4SJonathan Peyton         ANNOTATE_IGNORE_WRITES_BEGIN();
29573041982dSJonathan Peyton         *threads_data_p = (kmp_thread_data_t *)__kmp_allocate(
29583041982dSJonathan Peyton             nthreads * sizeof(kmp_thread_data_t));
29597cc577a4SJonathan Peyton         ANNOTATE_IGNORE_WRITES_END();
29607cc577a4SJonathan Peyton #ifdef BUILD_TIED_TASK_STACK
29617cc577a4SJonathan Peyton         // GEH: Figure out if this is the right thing to do
29627cc577a4SJonathan Peyton         for (i = 0; i < nthreads; i++) {
29637cc577a4SJonathan Peyton           kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
29647cc577a4SJonathan Peyton           __kmp_init_task_stack(__kmp_gtid_from_thread(thread), thread_data);
29657cc577a4SJonathan Peyton         }
29667cc577a4SJonathan Peyton #endif // BUILD_TIED_TASK_STACK
29677cc577a4SJonathan Peyton       }
29687cc577a4SJonathan Peyton       task_team->tt.tt_max_threads = nthreads;
29693041982dSJonathan Peyton     } else {
29707cc577a4SJonathan Peyton       // If array has (more than) enough elements, go ahead and use it
29717cc577a4SJonathan Peyton       KMP_DEBUG_ASSERT(*threads_data_p != NULL);
29727cc577a4SJonathan Peyton     }
29737cc577a4SJonathan Peyton 
29747cc577a4SJonathan Peyton     // initialize threads_data pointers back to thread_info structures
29757cc577a4SJonathan Peyton     for (i = 0; i < nthreads; i++) {
29767cc577a4SJonathan Peyton       kmp_thread_data_t *thread_data = &(*threads_data_p)[i];
29777cc577a4SJonathan Peyton       thread_data->td.td_thr = team->t.t_threads[i];
29787cc577a4SJonathan Peyton 
29797cc577a4SJonathan Peyton       if (thread_data->td.td_deque_last_stolen >= nthreads) {
29807cc577a4SJonathan Peyton         // The last stolen field survives across teams / barrier, and the number
29817cc577a4SJonathan Peyton         // of threads may have changed.  It's possible (likely?) that a new
29823041982dSJonathan Peyton         // parallel region will exhibit the same behavior as previous region.
29837cc577a4SJonathan Peyton         thread_data->td.td_deque_last_stolen = -1;
29847cc577a4SJonathan Peyton       }
29857cc577a4SJonathan Peyton     }
29867cc577a4SJonathan Peyton 
29877cc577a4SJonathan Peyton     KMP_MB();
29887cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_tasks, TRUE);
29897cc577a4SJonathan Peyton   }
29907cc577a4SJonathan Peyton 
29917cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
29927cc577a4SJonathan Peyton   return is_init_thread;
29937cc577a4SJonathan Peyton }
29947cc577a4SJonathan Peyton 
29957cc577a4SJonathan Peyton // __kmp_free_task_threads_data:
29967cc577a4SJonathan Peyton // Deallocates a threads_data array for a task team, including any attached
29977cc577a4SJonathan Peyton // tasking deques.  Only occurs at library shutdown.
29983041982dSJonathan Peyton static void __kmp_free_task_threads_data(kmp_task_team_t *task_team) {
29997cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&task_team->tt.tt_threads_lock);
30007cc577a4SJonathan Peyton   if (task_team->tt.tt_threads_data != NULL) {
30017cc577a4SJonathan Peyton     int i;
30027cc577a4SJonathan Peyton     for (i = 0; i < task_team->tt.tt_max_threads; i++) {
30037cc577a4SJonathan Peyton       __kmp_free_task_deque(&task_team->tt.tt_threads_data[i]);
30047cc577a4SJonathan Peyton     }
30057cc577a4SJonathan Peyton     __kmp_free(task_team->tt.tt_threads_data);
30067cc577a4SJonathan Peyton     task_team->tt.tt_threads_data = NULL;
30077cc577a4SJonathan Peyton   }
30087cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&task_team->tt.tt_threads_lock);
30097cc577a4SJonathan Peyton }
30107cc577a4SJonathan Peyton 
30117cc577a4SJonathan Peyton // __kmp_allocate_task_team:
30127cc577a4SJonathan Peyton // Allocates a task team associated with a specific team, taking it from
30133041982dSJonathan Peyton // the global task team free list if possible.  Also initializes data
30143041982dSJonathan Peyton // structures.
30153041982dSJonathan Peyton static kmp_task_team_t *__kmp_allocate_task_team(kmp_info_t *thread,
30163041982dSJonathan Peyton                                                  kmp_team_t *team) {
30177cc577a4SJonathan Peyton   kmp_task_team_t *task_team = NULL;
30187cc577a4SJonathan Peyton   int nthreads;
30197cc577a4SJonathan Peyton 
30207cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d entering; team = %p\n",
30217cc577a4SJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), team));
30227cc577a4SJonathan Peyton 
30237cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
30247cc577a4SJonathan Peyton     // Take a task team from the task team pool
30257cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
30267cc577a4SJonathan Peyton     if (__kmp_free_task_teams != NULL) {
30277cc577a4SJonathan Peyton       task_team = __kmp_free_task_teams;
30287cc577a4SJonathan Peyton       TCW_PTR(__kmp_free_task_teams, task_team->tt.tt_next);
30297cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
30307cc577a4SJonathan Peyton     }
30317cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
30327cc577a4SJonathan Peyton   }
30337cc577a4SJonathan Peyton 
30347cc577a4SJonathan Peyton   if (task_team == NULL) {
30357cc577a4SJonathan Peyton     KE_TRACE(10, ("__kmp_allocate_task_team: T#%d allocating "
30367cc577a4SJonathan Peyton                   "task team for team %p\n",
30377cc577a4SJonathan Peyton                   __kmp_gtid_from_thread(thread), team));
30387cc577a4SJonathan Peyton     // Allocate a new task team if one is not available.
30397cc577a4SJonathan Peyton     // Cannot use __kmp_thread_malloc() because threads not around for
30407cc577a4SJonathan Peyton     // kmp_reap_task_team( ).
30417cc577a4SJonathan Peyton     task_team = (kmp_task_team_t *)__kmp_allocate(sizeof(kmp_task_team_t));
30427cc577a4SJonathan Peyton     __kmp_init_bootstrap_lock(&task_team->tt.tt_threads_lock);
30433041982dSJonathan Peyton     // AC: __kmp_allocate zeroes returned memory
30443041982dSJonathan Peyton     // task_team -> tt.tt_threads_data = NULL;
30457cc577a4SJonathan Peyton     // task_team -> tt.tt_max_threads = 0;
30467cc577a4SJonathan Peyton     // task_team -> tt.tt_next = NULL;
30477cc577a4SJonathan Peyton   }
30487cc577a4SJonathan Peyton 
30497cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_tasks, FALSE);
30507cc577a4SJonathan Peyton #if OMP_45_ENABLED
30517cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
30527cc577a4SJonathan Peyton #endif
30537cc577a4SJonathan Peyton   task_team->tt.tt_nproc = nthreads = team->t.t_nproc;
30547cc577a4SJonathan Peyton 
305537e2ef54SJonathan Peyton   KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads, nthreads);
30567cc577a4SJonathan Peyton   TCW_4(task_team->tt.tt_active, TRUE);
30577cc577a4SJonathan Peyton 
30583041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_allocate_task_team: T#%d exiting; task_team = %p "
30593041982dSJonathan Peyton                 "unfinished_threads init'd to %d\n",
30603041982dSJonathan Peyton                 (thread ? __kmp_gtid_from_thread(thread) : -1), task_team,
306137e2ef54SJonathan Peyton                 KMP_ATOMIC_LD_RLX(&task_team->tt.tt_unfinished_threads)));
30627cc577a4SJonathan Peyton   return task_team;
30637cc577a4SJonathan Peyton }
30647cc577a4SJonathan Peyton 
30657cc577a4SJonathan Peyton // __kmp_free_task_team:
30667cc577a4SJonathan Peyton // Frees the task team associated with a specific thread, and adds it
30677cc577a4SJonathan Peyton // to the global task team free list.
30683041982dSJonathan Peyton void __kmp_free_task_team(kmp_info_t *thread, kmp_task_team_t *task_team) {
30697cc577a4SJonathan Peyton   KA_TRACE(20, ("__kmp_free_task_team: T#%d task_team = %p\n",
30707cc577a4SJonathan Peyton                 thread ? __kmp_gtid_from_thread(thread) : -1, task_team));
30717cc577a4SJonathan Peyton 
30727cc577a4SJonathan Peyton   // Put task team back on free list
30737cc577a4SJonathan Peyton   __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
30747cc577a4SJonathan Peyton 
30757cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team->tt.tt_next == NULL);
30767cc577a4SJonathan Peyton   task_team->tt.tt_next = __kmp_free_task_teams;
30777cc577a4SJonathan Peyton   TCW_PTR(__kmp_free_task_teams, task_team);
30787cc577a4SJonathan Peyton 
30797cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
30807cc577a4SJonathan Peyton }
30817cc577a4SJonathan Peyton 
30827cc577a4SJonathan Peyton // __kmp_reap_task_teams:
30837cc577a4SJonathan Peyton // Free all the task teams on the task team free list.
30847cc577a4SJonathan Peyton // Should only be done during library shutdown.
30853041982dSJonathan Peyton // Cannot do anything that needs a thread structure or gtid since they are
30863041982dSJonathan Peyton // already gone.
30873041982dSJonathan Peyton void __kmp_reap_task_teams(void) {
30887cc577a4SJonathan Peyton   kmp_task_team_t *task_team;
30897cc577a4SJonathan Peyton 
30907cc577a4SJonathan Peyton   if (TCR_PTR(__kmp_free_task_teams) != NULL) {
30917cc577a4SJonathan Peyton     // Free all task_teams on the free list
30927cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&__kmp_task_team_lock);
30937cc577a4SJonathan Peyton     while ((task_team = __kmp_free_task_teams) != NULL) {
30947cc577a4SJonathan Peyton       __kmp_free_task_teams = task_team->tt.tt_next;
30957cc577a4SJonathan Peyton       task_team->tt.tt_next = NULL;
30967cc577a4SJonathan Peyton 
30977cc577a4SJonathan Peyton       // Free threads_data if necessary
30987cc577a4SJonathan Peyton       if (task_team->tt.tt_threads_data != NULL) {
30997cc577a4SJonathan Peyton         __kmp_free_task_threads_data(task_team);
31007cc577a4SJonathan Peyton       }
31017cc577a4SJonathan Peyton       __kmp_free(task_team);
31027cc577a4SJonathan Peyton     }
31037cc577a4SJonathan Peyton     __kmp_release_bootstrap_lock(&__kmp_task_team_lock);
31047cc577a4SJonathan Peyton   }
31057cc577a4SJonathan Peyton }
31067cc577a4SJonathan Peyton 
31077cc577a4SJonathan Peyton // __kmp_wait_to_unref_task_teams:
31087cc577a4SJonathan Peyton // Some threads could still be in the fork barrier release code, possibly
31097cc577a4SJonathan Peyton // trying to steal tasks.  Wait for each thread to unreference its task team.
31103041982dSJonathan Peyton void __kmp_wait_to_unref_task_teams(void) {
31117cc577a4SJonathan Peyton   kmp_info_t *thread;
31127cc577a4SJonathan Peyton   kmp_uint32 spins;
31137cc577a4SJonathan Peyton   int done;
31147cc577a4SJonathan Peyton 
31157cc577a4SJonathan Peyton   KMP_INIT_YIELD(spins);
31167cc577a4SJonathan Peyton 
31177cc577a4SJonathan Peyton   for (;;) {
31187cc577a4SJonathan Peyton     done = TRUE;
31197cc577a4SJonathan Peyton 
31207cc577a4SJonathan Peyton     // TODO: GEH - this may be is wrong because some sync would be necessary
31213041982dSJonathan Peyton     // in case threads are added to the pool during the traversal. Need to
31223041982dSJonathan Peyton     // verify that lock for thread pool is held when calling this routine.
3123c47afcd9SAndrey Churbanov     for (thread = CCAST(kmp_info_t *, __kmp_thread_pool); thread != NULL;
31243041982dSJonathan Peyton          thread = thread->th.th_next_pool) {
31257cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
31267cc577a4SJonathan Peyton       DWORD exit_val;
31277cc577a4SJonathan Peyton #endif
31287cc577a4SJonathan Peyton       if (TCR_PTR(thread->th.th_task_team) == NULL) {
31297cc577a4SJonathan Peyton         KA_TRACE(10, ("__kmp_wait_to_unref_task_team: T#%d task_team == NULL\n",
31307cc577a4SJonathan Peyton                       __kmp_gtid_from_thread(thread)));
31317cc577a4SJonathan Peyton         continue;
31327cc577a4SJonathan Peyton       }
31337cc577a4SJonathan Peyton #if KMP_OS_WINDOWS
31347cc577a4SJonathan Peyton       // TODO: GEH - add this check for Linux* OS / OS X* as well?
31357cc577a4SJonathan Peyton       if (!__kmp_is_thread_alive(thread, &exit_val)) {
31367cc577a4SJonathan Peyton         thread->th.th_task_team = NULL;
31377cc577a4SJonathan Peyton         continue;
31387cc577a4SJonathan Peyton       }
31397cc577a4SJonathan Peyton #endif
31407cc577a4SJonathan Peyton 
31417cc577a4SJonathan Peyton       done = FALSE; // Because th_task_team pointer is not NULL for this thread
31427cc577a4SJonathan Peyton 
31433041982dSJonathan Peyton       KA_TRACE(10, ("__kmp_wait_to_unref_task_team: Waiting for T#%d to "
31443041982dSJonathan Peyton                     "unreference task_team\n",
31457cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(thread)));
31467cc577a4SJonathan Peyton 
31477cc577a4SJonathan Peyton       if (__kmp_dflt_blocktime != KMP_MAX_BLOCKTIME) {
31487cc577a4SJonathan Peyton         volatile void *sleep_loc;
31497cc577a4SJonathan Peyton         // If the thread is sleeping, awaken it.
3150c47afcd9SAndrey Churbanov         if ((sleep_loc = TCR_PTR(CCAST(void *, thread->th.th_sleep_loc))) !=
3151c47afcd9SAndrey Churbanov             NULL) {
31523041982dSJonathan Peyton           KA_TRACE(
31533041982dSJonathan Peyton               10,
31543041982dSJonathan Peyton               ("__kmp_wait_to_unref_task_team: T#%d waking up thread T#%d\n",
31557cc577a4SJonathan Peyton                __kmp_gtid_from_thread(thread), __kmp_gtid_from_thread(thread)));
31567cc577a4SJonathan Peyton           __kmp_null_resume_wrapper(__kmp_gtid_from_thread(thread), sleep_loc);
31577cc577a4SJonathan Peyton         }
31587cc577a4SJonathan Peyton       }
31597cc577a4SJonathan Peyton     }
31607cc577a4SJonathan Peyton     if (done) {
31617cc577a4SJonathan Peyton       break;
31627cc577a4SJonathan Peyton     }
31637cc577a4SJonathan Peyton 
31643041982dSJonathan Peyton     // If we are oversubscribed, or have waited a bit (and library mode is
31653041982dSJonathan Peyton     // throughput), yield. Pause is in the following code.
31667cc577a4SJonathan Peyton     KMP_YIELD(TCR_4(__kmp_nth) > __kmp_avail_proc);
31677cc577a4SJonathan Peyton     KMP_YIELD_SPIN(spins); // Yields only if KMP_LIBRARY=throughput
31687cc577a4SJonathan Peyton   }
31697cc577a4SJonathan Peyton }
31707cc577a4SJonathan Peyton 
31717cc577a4SJonathan Peyton // __kmp_task_team_setup:  Create a task_team for the current team, but use
31727cc577a4SJonathan Peyton // an already created, unused one if it already exists.
31733041982dSJonathan Peyton void __kmp_task_team_setup(kmp_info_t *this_thr, kmp_team_t *team, int always) {
31747cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
31757cc577a4SJonathan Peyton 
31763041982dSJonathan Peyton   // If this task_team hasn't been created yet, allocate it. It will be used in
31773041982dSJonathan Peyton   // the region after the next.
31783041982dSJonathan Peyton   // If it exists, it is the current task team and shouldn't be touched yet as
31793041982dSJonathan Peyton   // it may still be in use.
31803041982dSJonathan Peyton   if (team->t.t_task_team[this_thr->th.th_task_state] == NULL &&
31813041982dSJonathan Peyton       (always || team->t.t_nproc > 1)) {
31823041982dSJonathan Peyton     team->t.t_task_team[this_thr->th.th_task_state] =
31833041982dSJonathan Peyton         __kmp_allocate_task_team(this_thr, team);
31843041982dSJonathan Peyton     KA_TRACE(20, ("__kmp_task_team_setup: Master T#%d created new task_team %p "
31853041982dSJonathan Peyton                   "for team %d at parity=%d\n",
31863041982dSJonathan Peyton                   __kmp_gtid_from_thread(this_thr),
31873041982dSJonathan Peyton                   team->t.t_task_team[this_thr->th.th_task_state],
31883041982dSJonathan Peyton                   ((team != NULL) ? team->t.t_id : -1),
31893041982dSJonathan Peyton                   this_thr->th.th_task_state));
31907cc577a4SJonathan Peyton   }
31917cc577a4SJonathan Peyton 
31923041982dSJonathan Peyton   // After threads exit the release, they will call sync, and then point to this
31933041982dSJonathan Peyton   // other task_team; make sure it is allocated and properly initialized. As
31943041982dSJonathan Peyton   // threads spin in the barrier release phase, they will continue to use the
31953041982dSJonathan Peyton   // previous task_team struct(above), until they receive the signal to stop
31963041982dSJonathan Peyton   // checking for tasks (they can't safely reference the kmp_team_t struct,
31973041982dSJonathan Peyton   // which could be reallocated by the master thread). No task teams are formed
31983041982dSJonathan Peyton   // for serialized teams.
31997cc577a4SJonathan Peyton   if (team->t.t_nproc > 1) {
32007cc577a4SJonathan Peyton     int other_team = 1 - this_thr->th.th_task_state;
32017cc577a4SJonathan Peyton     if (team->t.t_task_team[other_team] == NULL) { // setup other team as well
32023041982dSJonathan Peyton       team->t.t_task_team[other_team] =
32033041982dSJonathan Peyton           __kmp_allocate_task_team(this_thr, team);
32043041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_task_team_setup: Master T#%d created second new "
32053041982dSJonathan Peyton                     "task_team %p for team %d at parity=%d\n",
32063041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
32073041982dSJonathan Peyton                     team->t.t_task_team[other_team],
32087cc577a4SJonathan Peyton                     ((team != NULL) ? team->t.t_id : -1), other_team));
32093041982dSJonathan Peyton     } else { // Leave the old task team struct in place for the upcoming region;
32103041982dSJonathan Peyton       // adjust as needed
32117cc577a4SJonathan Peyton       kmp_task_team_t *task_team = team->t.t_task_team[other_team];
32123041982dSJonathan Peyton       if (!task_team->tt.tt_active ||
32133041982dSJonathan Peyton           team->t.t_nproc != task_team->tt.tt_nproc) {
32147cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_nproc, team->t.t_nproc);
32157cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_tasks, FALSE);
32167cc577a4SJonathan Peyton #if OMP_45_ENABLED
32177cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_found_proxy_tasks, FALSE);
32187cc577a4SJonathan Peyton #endif
321937e2ef54SJonathan Peyton         KMP_ATOMIC_ST_REL(&task_team->tt.tt_unfinished_threads,
322037e2ef54SJonathan Peyton                           team->t.t_nproc);
32217cc577a4SJonathan Peyton         TCW_4(task_team->tt.tt_active, TRUE);
32227cc577a4SJonathan Peyton       }
32233041982dSJonathan Peyton       // if team size has changed, the first thread to enable tasking will
32243041982dSJonathan Peyton       // realloc threads_data if necessary
32253041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_task_team_setup: Master T#%d reset next task_team "
32263041982dSJonathan Peyton                     "%p for team %d at parity=%d\n",
32273041982dSJonathan Peyton                     __kmp_gtid_from_thread(this_thr),
32283041982dSJonathan Peyton                     team->t.t_task_team[other_team],
32297cc577a4SJonathan Peyton                     ((team != NULL) ? team->t.t_id : -1), other_team));
32307cc577a4SJonathan Peyton     }
32317cc577a4SJonathan Peyton   }
32327cc577a4SJonathan Peyton }
32337cc577a4SJonathan Peyton 
32347cc577a4SJonathan Peyton // __kmp_task_team_sync: Propagation of task team data from team to threads
32357cc577a4SJonathan Peyton // which happens just after the release phase of a team barrier.  This may be
32367cc577a4SJonathan Peyton // called by any thread, but only for teams with # threads > 1.
32373041982dSJonathan Peyton void __kmp_task_team_sync(kmp_info_t *this_thr, kmp_team_t *team) {
32387cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
32397cc577a4SJonathan Peyton 
32403041982dSJonathan Peyton   // Toggle the th_task_state field, to switch which task_team this thread
32413041982dSJonathan Peyton   // refers to
32427cc577a4SJonathan Peyton   this_thr->th.th_task_state = 1 - this_thr->th.th_task_state;
32433041982dSJonathan Peyton   // It is now safe to propagate the task team pointer from the team struct to
32443041982dSJonathan Peyton   // the current thread.
32453041982dSJonathan Peyton   TCW_PTR(this_thr->th.th_task_team,
32463041982dSJonathan Peyton           team->t.t_task_team[this_thr->th.th_task_state]);
32473041982dSJonathan Peyton   KA_TRACE(20,
32483041982dSJonathan Peyton            ("__kmp_task_team_sync: Thread T#%d task team switched to task_team "
32493041982dSJonathan Peyton             "%p from Team #%d (parity=%d)\n",
32507cc577a4SJonathan Peyton             __kmp_gtid_from_thread(this_thr), this_thr->th.th_task_team,
32517cc577a4SJonathan Peyton             ((team != NULL) ? team->t.t_id : -1), this_thr->th.th_task_state));
32527cc577a4SJonathan Peyton }
32537cc577a4SJonathan Peyton 
32543041982dSJonathan Peyton // __kmp_task_team_wait: Master thread waits for outstanding tasks after the
32553041982dSJonathan Peyton // barrier gather phase. Only called by master thread if #threads in team > 1 or
32563041982dSJonathan Peyton // if proxy tasks were created.
32573041982dSJonathan Peyton //
32583041982dSJonathan Peyton // wait is a flag that defaults to 1 (see kmp.h), but waiting can be turned off
32593041982dSJonathan Peyton // by passing in 0 optionally as the last argument. When wait is zero, master
32603041982dSJonathan Peyton // thread does not wait for unfinished_threads to reach 0.
32613041982dSJonathan Peyton void __kmp_task_team_wait(
32623041982dSJonathan Peyton     kmp_info_t *this_thr,
32633041982dSJonathan Peyton     kmp_team_t *team USE_ITT_BUILD_ARG(void *itt_sync_obj), int wait) {
32647cc577a4SJonathan Peyton   kmp_task_team_t *task_team = team->t.t_task_team[this_thr->th.th_task_state];
32657cc577a4SJonathan Peyton 
32667cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode != tskm_immediate_exec);
32677cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team == this_thr->th.th_task_team);
32687cc577a4SJonathan Peyton 
32697cc577a4SJonathan Peyton   if ((task_team != NULL) && KMP_TASKING_ENABLED(task_team)) {
32707cc577a4SJonathan Peyton     if (wait) {
32713041982dSJonathan Peyton       KA_TRACE(20, ("__kmp_task_team_wait: Master T#%d waiting for all tasks "
32723041982dSJonathan Peyton                     "(for unfinished_threads to reach 0) on task_team = %p\n",
32737cc577a4SJonathan Peyton                     __kmp_gtid_from_thread(this_thr), task_team));
32743041982dSJonathan Peyton       // Worker threads may have dropped through to release phase, but could
32753041982dSJonathan Peyton       // still be executing tasks. Wait here for tasks to complete. To avoid
32763041982dSJonathan Peyton       // memory contention, only master thread checks termination condition.
327737e2ef54SJonathan Peyton       kmp_flag_32 flag(RCAST(std::atomic<kmp_uint32> *,
327837e2ef54SJonathan Peyton                              &task_team->tt.tt_unfinished_threads),
3279c47afcd9SAndrey Churbanov                        0U);
32803041982dSJonathan Peyton       flag.wait(this_thr, TRUE USE_ITT_BUILD_ARG(itt_sync_obj));
32817cc577a4SJonathan Peyton     }
32823041982dSJonathan Peyton     // Deactivate the old task team, so that the worker threads will stop
32833041982dSJonathan Peyton     // referencing it while spinning.
32843041982dSJonathan Peyton     KA_TRACE(
32853041982dSJonathan Peyton         20,
32863041982dSJonathan Peyton         ("__kmp_task_team_wait: Master T#%d deactivating task_team %p: "
32877cc577a4SJonathan Peyton          "setting active to false, setting local and team's pointer to NULL\n",
32887cc577a4SJonathan Peyton          __kmp_gtid_from_thread(this_thr), task_team));
32897cc577a4SJonathan Peyton #if OMP_45_ENABLED
32903041982dSJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1 ||
32913041982dSJonathan Peyton                      task_team->tt.tt_found_proxy_tasks == TRUE);
32927cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_found_proxy_tasks, FALSE);
32937cc577a4SJonathan Peyton #else
32947cc577a4SJonathan Peyton     KMP_DEBUG_ASSERT(task_team->tt.tt_nproc > 1);
32957cc577a4SJonathan Peyton #endif
3296a756cb24SAndrey Churbanov     KMP_CHECK_UPDATE(task_team->tt.tt_untied_task_encountered, 0);
32977cc577a4SJonathan Peyton     TCW_SYNC_4(task_team->tt.tt_active, FALSE);
32987cc577a4SJonathan Peyton     KMP_MB();
32997cc577a4SJonathan Peyton 
33007cc577a4SJonathan Peyton     TCW_PTR(this_thr->th.th_task_team, NULL);
33017cc577a4SJonathan Peyton   }
33027cc577a4SJonathan Peyton }
33037cc577a4SJonathan Peyton 
33047cc577a4SJonathan Peyton // __kmp_tasking_barrier:
33057cc577a4SJonathan Peyton // This routine may only called when __kmp_tasking_mode == tskm_extra_barrier.
33063041982dSJonathan Peyton // Internal function to execute all tasks prior to a regular barrier or a join
33073041982dSJonathan Peyton // barrier. It is a full barrier itself, which unfortunately turns regular
33083041982dSJonathan Peyton // barriers into double barriers and join barriers into 1 1/2 barriers.
33093041982dSJonathan Peyton void __kmp_tasking_barrier(kmp_team_t *team, kmp_info_t *thread, int gtid) {
331037e2ef54SJonathan Peyton   std::atomic<kmp_uint32> *spin = RCAST(
331137e2ef54SJonathan Peyton       std::atomic<kmp_uint32> *,
3312c47afcd9SAndrey Churbanov       &team->t.t_task_team[thread->th.th_task_state]->tt.tt_unfinished_threads);
33137cc577a4SJonathan Peyton   int flag = FALSE;
33147cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(__kmp_tasking_mode == tskm_extra_barrier);
33157cc577a4SJonathan Peyton 
33167cc577a4SJonathan Peyton #if USE_ITT_BUILD
331737e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_INIT(spin, NULL);
33187cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
33197cc577a4SJonathan Peyton   kmp_flag_32 spin_flag(spin, 0U);
33203041982dSJonathan Peyton   while (!spin_flag.execute_tasks(thread, gtid, TRUE,
33213041982dSJonathan Peyton                                   &flag USE_ITT_BUILD_ARG(NULL), 0)) {
33227cc577a4SJonathan Peyton #if USE_ITT_BUILD
33237cc577a4SJonathan Peyton     // TODO: What about itt_sync_obj??
332437e2ef54SJonathan Peyton     KMP_FSYNC_SPIN_PREPARE(RCAST(void *, spin));
33257cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
33267cc577a4SJonathan Peyton 
33277cc577a4SJonathan Peyton     if (TCR_4(__kmp_global.g.g_done)) {
33287cc577a4SJonathan Peyton       if (__kmp_global.g.g_abort)
33297cc577a4SJonathan Peyton         __kmp_abort_thread();
33307cc577a4SJonathan Peyton       break;
33317cc577a4SJonathan Peyton     }
33327cc577a4SJonathan Peyton     KMP_YIELD(TRUE); // GH: We always yield here
33337cc577a4SJonathan Peyton   }
33347cc577a4SJonathan Peyton #if USE_ITT_BUILD
333537e2ef54SJonathan Peyton   KMP_FSYNC_SPIN_ACQUIRED(RCAST(void *, spin));
33367cc577a4SJonathan Peyton #endif /* USE_ITT_BUILD */
33377cc577a4SJonathan Peyton }
33387cc577a4SJonathan Peyton 
33397cc577a4SJonathan Peyton #if OMP_45_ENABLED
33407cc577a4SJonathan Peyton 
33413041982dSJonathan Peyton // __kmp_give_task puts a task into a given thread queue if:
33423041982dSJonathan Peyton //  - the queue for that thread was created
33433041982dSJonathan Peyton //  - there's space in that queue
33443041982dSJonathan Peyton // Because of this, __kmp_push_task needs to check if there's space after
33453041982dSJonathan Peyton // getting the lock
33463041982dSJonathan Peyton static bool __kmp_give_task(kmp_info_t *thread, kmp_int32 tid, kmp_task_t *task,
33473041982dSJonathan Peyton                             kmp_int32 pass) {
33487cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
33497cc577a4SJonathan Peyton   kmp_task_team_t *task_team = taskdata->td_task_team;
33507cc577a4SJonathan Peyton 
33513041982dSJonathan Peyton   KA_TRACE(20, ("__kmp_give_task: trying to give task %p to thread %d.\n",
33523041982dSJonathan Peyton                 taskdata, tid));
33537cc577a4SJonathan Peyton 
33547cc577a4SJonathan Peyton   // If task_team is NULL something went really bad...
33557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(task_team != NULL);
33567cc577a4SJonathan Peyton 
33577cc577a4SJonathan Peyton   bool result = false;
33587cc577a4SJonathan Peyton   kmp_thread_data_t *thread_data = &task_team->tt.tt_threads_data[tid];
33597cc577a4SJonathan Peyton 
33607cc577a4SJonathan Peyton   if (thread_data->td.td_deque == NULL) {
33617cc577a4SJonathan Peyton     // There's no queue in this thread, go find another one
33627cc577a4SJonathan Peyton     // We're guaranteed that at least one thread has a queue
33633041982dSJonathan Peyton     KA_TRACE(30,
33643041982dSJonathan Peyton              ("__kmp_give_task: thread %d has no queue while giving task %p.\n",
33653041982dSJonathan Peyton               tid, taskdata));
33667cc577a4SJonathan Peyton     return result;
33677cc577a4SJonathan Peyton   }
33687cc577a4SJonathan Peyton 
33693041982dSJonathan Peyton   if (TCR_4(thread_data->td.td_deque_ntasks) >=
33703041982dSJonathan Peyton       TASK_DEQUE_SIZE(thread_data->td)) {
33713041982dSJonathan Peyton     KA_TRACE(
33723041982dSJonathan Peyton         30,
33733041982dSJonathan Peyton         ("__kmp_give_task: queue is full while giving task %p to thread %d.\n",
33743041982dSJonathan Peyton          taskdata, tid));
33757cc577a4SJonathan Peyton 
33763041982dSJonathan Peyton     // if this deque is bigger than the pass ratio give a chance to another
33773041982dSJonathan Peyton     // thread
33783041982dSJonathan Peyton     if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
33793041982dSJonathan Peyton       return result;
33807cc577a4SJonathan Peyton 
33817cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
33827cc577a4SJonathan Peyton     __kmp_realloc_task_deque(thread, thread_data);
33837cc577a4SJonathan Peyton 
33847cc577a4SJonathan Peyton   } else {
33857cc577a4SJonathan Peyton 
33867cc577a4SJonathan Peyton     __kmp_acquire_bootstrap_lock(&thread_data->td.td_deque_lock);
33877cc577a4SJonathan Peyton 
33883041982dSJonathan Peyton     if (TCR_4(thread_data->td.td_deque_ntasks) >=
33893041982dSJonathan Peyton         TASK_DEQUE_SIZE(thread_data->td)) {
33903041982dSJonathan Peyton       KA_TRACE(30, ("__kmp_give_task: queue is full while giving task %p to "
33913041982dSJonathan Peyton                     "thread %d.\n",
33923041982dSJonathan Peyton                     taskdata, tid));
33937cc577a4SJonathan Peyton 
33943041982dSJonathan Peyton       // if this deque is bigger than the pass ratio give a chance to another
33953041982dSJonathan Peyton       // thread
33967cc577a4SJonathan Peyton       if (TASK_DEQUE_SIZE(thread_data->td) / INITIAL_TASK_DEQUE_SIZE >= pass)
33977cc577a4SJonathan Peyton         goto release_and_exit;
33987cc577a4SJonathan Peyton 
33997cc577a4SJonathan Peyton       __kmp_realloc_task_deque(thread, thread_data);
34007cc577a4SJonathan Peyton     }
34017cc577a4SJonathan Peyton   }
34027cc577a4SJonathan Peyton 
34037cc577a4SJonathan Peyton   // lock is held here, and there is space in the deque
34047cc577a4SJonathan Peyton 
34057cc577a4SJonathan Peyton   thread_data->td.td_deque[thread_data->td.td_deque_tail] = taskdata;
34067cc577a4SJonathan Peyton   // Wrap index.
34073041982dSJonathan Peyton   thread_data->td.td_deque_tail =
34083041982dSJonathan Peyton       (thread_data->td.td_deque_tail + 1) & TASK_DEQUE_MASK(thread_data->td);
34093041982dSJonathan Peyton   TCW_4(thread_data->td.td_deque_ntasks,
34103041982dSJonathan Peyton         TCR_4(thread_data->td.td_deque_ntasks) + 1);
34117cc577a4SJonathan Peyton 
34127cc577a4SJonathan Peyton   result = true;
34133041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_give_task: successfully gave task %p to thread %d.\n",
34143041982dSJonathan Peyton                 taskdata, tid));
34157cc577a4SJonathan Peyton 
34167cc577a4SJonathan Peyton release_and_exit:
34177cc577a4SJonathan Peyton   __kmp_release_bootstrap_lock(&thread_data->td.td_deque_lock);
34187cc577a4SJonathan Peyton 
34197cc577a4SJonathan Peyton   return result;
34207cc577a4SJonathan Peyton }
34217cc577a4SJonathan Peyton 
34223041982dSJonathan Peyton /* The finish of the proxy tasks is divided in two pieces:
34237cc577a4SJonathan Peyton     - the top half is the one that can be done from a thread outside the team
34247cc577a4SJonathan Peyton     - the bottom half must be run from a them within the team
34257cc577a4SJonathan Peyton 
34263041982dSJonathan Peyton    In order to run the bottom half the task gets queued back into one of the
34273041982dSJonathan Peyton    threads of the team. Once the td_incomplete_child_task counter of the parent
34283041982dSJonathan Peyton    is decremented the threads can leave the barriers. So, the bottom half needs
34293041982dSJonathan Peyton    to be queued before the counter is decremented. The top half is therefore
34303041982dSJonathan Peyton    divided in two parts:
34317cc577a4SJonathan Peyton     - things that can be run before queuing the bottom half
34327cc577a4SJonathan Peyton     - things that must be run after queuing the bottom half
34337cc577a4SJonathan Peyton 
34343041982dSJonathan Peyton    This creates a second race as the bottom half can free the task before the
34353041982dSJonathan Peyton    second top half is executed. To avoid this we use the
34363041982dSJonathan Peyton    td_incomplete_child_task of the proxy task to synchronize the top and bottom
34373041982dSJonathan Peyton    half. */
34383041982dSJonathan Peyton static void __kmp_first_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
34397cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.tasktype == TASK_EXPLICIT);
34407cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
34417cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete == 0);
34427cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.freed == 0);
34437cc577a4SJonathan Peyton 
34447cc577a4SJonathan Peyton   taskdata->td_flags.complete = 1; // mark the task as completed
34457cc577a4SJonathan Peyton 
34467cc577a4SJonathan Peyton   if (taskdata->td_taskgroup)
344737e2ef54SJonathan Peyton     KMP_ATOMIC_DEC(&taskdata->td_taskgroup->count);
34487cc577a4SJonathan Peyton 
34493041982dSJonathan Peyton   // Create an imaginary children for this task so the bottom half cannot
34503041982dSJonathan Peyton   // release the task before we have completed the second top half
345137e2ef54SJonathan Peyton   KMP_ATOMIC_INC(&taskdata->td_incomplete_child_tasks);
34527cc577a4SJonathan Peyton }
34537cc577a4SJonathan Peyton 
34543041982dSJonathan Peyton static void __kmp_second_top_half_finish_proxy(kmp_taskdata_t *taskdata) {
34557cc577a4SJonathan Peyton   kmp_int32 children = 0;
34567cc577a4SJonathan Peyton 
34577cc577a4SJonathan Peyton   // Predecrement simulated by "- 1" calculation
34583041982dSJonathan Peyton   children =
345937e2ef54SJonathan Peyton       KMP_ATOMIC_DEC(&taskdata->td_parent->td_incomplete_child_tasks) - 1;
34607cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(children >= 0);
34617cc577a4SJonathan Peyton 
34627cc577a4SJonathan Peyton   // Remove the imaginary children
346337e2ef54SJonathan Peyton   KMP_ATOMIC_DEC(&taskdata->td_incomplete_child_tasks);
34647cc577a4SJonathan Peyton }
34657cc577a4SJonathan Peyton 
34663041982dSJonathan Peyton static void __kmp_bottom_half_finish_proxy(kmp_int32 gtid, kmp_task_t *ptask) {
34677cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
34687cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
34697cc577a4SJonathan Peyton 
34707cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
34713041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.complete ==
34723041982dSJonathan Peyton                    1); // top half must run before bottom half
34737cc577a4SJonathan Peyton 
34747cc577a4SJonathan Peyton   // We need to wait to make sure the top half is finished
34757cc577a4SJonathan Peyton   // Spinning here should be ok as this should happen quickly
347637e2ef54SJonathan Peyton   while (KMP_ATOMIC_LD_ACQ(&taskdata->td_incomplete_child_tasks) > 0)
34773041982dSJonathan Peyton     ;
34787cc577a4SJonathan Peyton 
34797cc577a4SJonathan Peyton   __kmp_release_deps(gtid, taskdata);
34807cc577a4SJonathan Peyton   __kmp_free_task_and_ancestors(gtid, taskdata, thread);
34817cc577a4SJonathan Peyton }
34827cc577a4SJonathan Peyton 
34837cc577a4SJonathan Peyton /*!
34847cc577a4SJonathan Peyton @ingroup TASKING
34857cc577a4SJonathan Peyton @param gtid Global Thread ID of encountering thread
34867cc577a4SJonathan Peyton @param ptask Task which execution is completed
34877cc577a4SJonathan Peyton 
34883041982dSJonathan Peyton Execute the completation of a proxy task from a thread of that is part of the
34893041982dSJonathan Peyton team. Run first and bottom halves directly.
34907cc577a4SJonathan Peyton */
34913041982dSJonathan Peyton void __kmpc_proxy_task_completed(kmp_int32 gtid, kmp_task_t *ptask) {
34927cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
34937cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
34943041982dSJonathan Peyton   KA_TRACE(
34953041982dSJonathan Peyton       10, ("__kmp_proxy_task_completed(enter): T#%d proxy task %p completing\n",
34963041982dSJonathan Peyton            gtid, taskdata));
34977cc577a4SJonathan Peyton 
34987cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
34997cc577a4SJonathan Peyton 
35007cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
35017cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
35027cc577a4SJonathan Peyton   __kmp_bottom_half_finish_proxy(gtid, ptask);
35037cc577a4SJonathan Peyton 
35043041982dSJonathan Peyton   KA_TRACE(10,
35053041982dSJonathan Peyton            ("__kmp_proxy_task_completed(exit): T#%d proxy task %p completing\n",
35063041982dSJonathan Peyton             gtid, taskdata));
35077cc577a4SJonathan Peyton }
35087cc577a4SJonathan Peyton 
35097cc577a4SJonathan Peyton /*!
35107cc577a4SJonathan Peyton @ingroup TASKING
35117cc577a4SJonathan Peyton @param ptask Task which execution is completed
35127cc577a4SJonathan Peyton 
35133041982dSJonathan Peyton Execute the completation of a proxy task from a thread that could not belong to
35143041982dSJonathan Peyton the team.
35157cc577a4SJonathan Peyton */
35163041982dSJonathan Peyton void __kmpc_proxy_task_completed_ooo(kmp_task_t *ptask) {
35177cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(ptask != NULL);
35187cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(ptask);
35197cc577a4SJonathan Peyton 
35203041982dSJonathan Peyton   KA_TRACE(
35213041982dSJonathan Peyton       10,
35223041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(enter): proxy task completing ooo %p\n",
35233041982dSJonathan Peyton        taskdata));
35247cc577a4SJonathan Peyton 
35257cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata->td_flags.proxy == TASK_PROXY);
35267cc577a4SJonathan Peyton 
35277cc577a4SJonathan Peyton   __kmp_first_top_half_finish_proxy(taskdata);
35287cc577a4SJonathan Peyton 
35293041982dSJonathan Peyton   // Enqueue task to complete bottom half completion from a thread within the
35303041982dSJonathan Peyton   // corresponding team
35317cc577a4SJonathan Peyton   kmp_team_t *team = taskdata->td_team;
35327cc577a4SJonathan Peyton   kmp_int32 nthreads = team->t.t_nproc;
35337cc577a4SJonathan Peyton   kmp_info_t *thread;
35347cc577a4SJonathan Peyton 
35353041982dSJonathan Peyton   // This should be similar to start_k = __kmp_get_random( thread ) % nthreads
35363041982dSJonathan Peyton   // but we cannot use __kmp_get_random here
35377cc577a4SJonathan Peyton   kmp_int32 start_k = 0;
35387cc577a4SJonathan Peyton   kmp_int32 pass = 1;
35397cc577a4SJonathan Peyton   kmp_int32 k = start_k;
35407cc577a4SJonathan Peyton 
35417cc577a4SJonathan Peyton   do {
35427cc577a4SJonathan Peyton     // For now we're just linearly trying to find a thread
35437cc577a4SJonathan Peyton     thread = team->t.t_threads[k];
35447cc577a4SJonathan Peyton     k = (k + 1) % nthreads;
35457cc577a4SJonathan Peyton 
35467cc577a4SJonathan Peyton     // we did a full pass through all the threads
35473041982dSJonathan Peyton     if (k == start_k)
35483041982dSJonathan Peyton       pass = pass << 1;
35497cc577a4SJonathan Peyton 
35507cc577a4SJonathan Peyton   } while (!__kmp_give_task(thread, k, ptask, pass));
35517cc577a4SJonathan Peyton 
35527cc577a4SJonathan Peyton   __kmp_second_top_half_finish_proxy(taskdata);
35537cc577a4SJonathan Peyton 
35543041982dSJonathan Peyton   KA_TRACE(
35553041982dSJonathan Peyton       10,
35563041982dSJonathan Peyton       ("__kmp_proxy_task_completed_ooo(exit): proxy task completing ooo %p\n",
35573041982dSJonathan Peyton        taskdata));
35587cc577a4SJonathan Peyton }
35597cc577a4SJonathan Peyton 
35603041982dSJonathan Peyton // __kmp_task_dup_alloc: Allocate the taskdata and make a copy of source task
35613041982dSJonathan Peyton // for taskloop
35627cc577a4SJonathan Peyton //
35637cc577a4SJonathan Peyton // thread:   allocating thread
35647cc577a4SJonathan Peyton // task_src: pointer to source task to be duplicated
35657cc577a4SJonathan Peyton // returns:  a pointer to the allocated kmp_task_t structure (task).
35663041982dSJonathan Peyton kmp_task_t *__kmp_task_dup_alloc(kmp_info_t *thread, kmp_task_t *task_src) {
35677cc577a4SJonathan Peyton   kmp_task_t *task;
35687cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata;
35697cc577a4SJonathan Peyton   kmp_taskdata_t *taskdata_src;
35707cc577a4SJonathan Peyton   kmp_taskdata_t *parent_task = thread->th.th_current_task;
35717cc577a4SJonathan Peyton   size_t shareds_offset;
35727cc577a4SJonathan Peyton   size_t task_size;
35737cc577a4SJonathan Peyton 
35743041982dSJonathan Peyton   KA_TRACE(10, ("__kmp_task_dup_alloc(enter): Th %p, source task %p\n", thread,
35753041982dSJonathan Peyton                 task_src));
35767cc577a4SJonathan Peyton   taskdata_src = KMP_TASK_TO_TASKDATA(task_src);
35773041982dSJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.proxy ==
35783041982dSJonathan Peyton                    TASK_FULL); // it should not be proxy task
35797cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(taskdata_src->td_flags.tasktype == TASK_EXPLICIT);
35807cc577a4SJonathan Peyton   task_size = taskdata_src->td_size_alloc;
35817cc577a4SJonathan Peyton 
35827cc577a4SJonathan Peyton   // Allocate a kmp_taskdata_t block and a kmp_task_t block.
35833041982dSJonathan Peyton   KA_TRACE(30, ("__kmp_task_dup_alloc: Th %p, malloc size %ld\n", thread,
35843041982dSJonathan Peyton                 task_size));
35857cc577a4SJonathan Peyton #if USE_FAST_MEMORY
35867cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_fast_allocate(thread, task_size);
35877cc577a4SJonathan Peyton #else
35887cc577a4SJonathan Peyton   taskdata = (kmp_taskdata_t *)__kmp_thread_malloc(thread, task_size);
35897cc577a4SJonathan Peyton #endif /* USE_FAST_MEMORY */
35907cc577a4SJonathan Peyton   KMP_MEMCPY(taskdata, taskdata_src, task_size);
35917cc577a4SJonathan Peyton 
35927cc577a4SJonathan Peyton   task = KMP_TASKDATA_TO_TASK(taskdata);
35937cc577a4SJonathan Peyton 
35947cc577a4SJonathan Peyton   // Initialize new task (only specific fields not affected by memcpy)
35957cc577a4SJonathan Peyton   taskdata->td_task_id = KMP_GEN_TASK_ID();
35967cc577a4SJonathan Peyton   if (task->shareds != NULL) { // need setup shareds pointer
35977cc577a4SJonathan Peyton     shareds_offset = (char *)task_src->shareds - (char *)taskdata_src;
35987cc577a4SJonathan Peyton     task->shareds = &((char *)taskdata)[shareds_offset];
35993041982dSJonathan Peyton     KMP_DEBUG_ASSERT((((kmp_uintptr_t)task->shareds) & (sizeof(void *) - 1)) ==
36003041982dSJonathan Peyton                      0);
36017cc577a4SJonathan Peyton   }
36027cc577a4SJonathan Peyton   taskdata->td_alloc_thread = thread;
360393e17cfeSJonathan Peyton   taskdata->td_parent = parent_task;
36043041982dSJonathan Peyton   taskdata->td_taskgroup =
36053041982dSJonathan Peyton       parent_task
36063041982dSJonathan Peyton           ->td_taskgroup; // task inherits the taskgroup from the parent task
36077cc577a4SJonathan Peyton 
36083041982dSJonathan Peyton   // Only need to keep track of child task counts if team parallel and tasking
36093041982dSJonathan Peyton   // not serialized
36107cc577a4SJonathan Peyton   if (!(taskdata->td_flags.team_serial || taskdata->td_flags.tasking_ser)) {
361137e2ef54SJonathan Peyton     KMP_ATOMIC_INC(&parent_task->td_incomplete_child_tasks);
36127cc577a4SJonathan Peyton     if (parent_task->td_taskgroup)
361337e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&parent_task->td_taskgroup->count);
36143041982dSJonathan Peyton     // Only need to keep track of allocated child tasks for explicit tasks since
36153041982dSJonathan Peyton     // implicit not deallocated
36167cc577a4SJonathan Peyton     if (taskdata->td_parent->td_flags.tasktype == TASK_EXPLICIT)
361737e2ef54SJonathan Peyton       KMP_ATOMIC_INC(&taskdata->td_parent->td_allocated_child_tasks);
36187cc577a4SJonathan Peyton   }
36197cc577a4SJonathan Peyton 
36203041982dSJonathan Peyton   KA_TRACE(20,
36213041982dSJonathan Peyton            ("__kmp_task_dup_alloc(exit): Th %p, created task %p, parent=%p\n",
36227cc577a4SJonathan Peyton             thread, taskdata, taskdata->td_parent));
36237cc577a4SJonathan Peyton #if OMPT_SUPPORT
3624f0a1c65fSJonas Hahnfeld   if (UNLIKELY(ompt_enabled.enabled))
362582e94a59SJoachim Protze     __ompt_task_init(taskdata, thread->th.th_info.ds.ds_gtid);
36267cc577a4SJonathan Peyton #endif
36277cc577a4SJonathan Peyton   return task;
36287cc577a4SJonathan Peyton }
36297cc577a4SJonathan Peyton 
36307cc577a4SJonathan Peyton // Routine optionally generated by the compiler for setting the lastprivate flag
36317cc577a4SJonathan Peyton // and calling needed constructors for private/firstprivate objects
36327cc577a4SJonathan Peyton // (used to form taskloop tasks from pattern task)
363393e17cfeSJonathan Peyton // Parameters: dest task, src task, lastprivate flag.
36347cc577a4SJonathan Peyton typedef void (*p_task_dup_t)(kmp_task_t *, kmp_task_t *, kmp_int32);
36357cc577a4SJonathan Peyton 
363627a677fcSJonathan Peyton KMP_BUILD_ASSERT(sizeof(long) == 4 || sizeof(long) == 8);
363727a677fcSJonathan Peyton 
363827a677fcSJonathan Peyton // class to encapsulate manipulating loop bounds in a taskloop task.
363927a677fcSJonathan Peyton // this abstracts away the Intel vs GOMP taskloop interface for setting/getting
364027a677fcSJonathan Peyton // the loop bound variables.
364127a677fcSJonathan Peyton class kmp_taskloop_bounds_t {
364227a677fcSJonathan Peyton   kmp_task_t *task;
364327a677fcSJonathan Peyton   const kmp_taskdata_t *taskdata;
364427a677fcSJonathan Peyton   size_t lower_offset;
364527a677fcSJonathan Peyton   size_t upper_offset;
364627a677fcSJonathan Peyton 
364727a677fcSJonathan Peyton public:
364827a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, kmp_uint64 *lb, kmp_uint64 *ub)
364927a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(task)),
365027a677fcSJonathan Peyton         lower_offset((char *)lb - (char *)task),
365127a677fcSJonathan Peyton         upper_offset((char *)ub - (char *)task) {
365227a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)lb > (char *)_task);
365327a677fcSJonathan Peyton     KMP_DEBUG_ASSERT((char *)ub > (char *)_task);
365427a677fcSJonathan Peyton   }
365527a677fcSJonathan Peyton   kmp_taskloop_bounds_t(kmp_task_t *_task, const kmp_taskloop_bounds_t &bounds)
365627a677fcSJonathan Peyton       : task(_task), taskdata(KMP_TASK_TO_TASKDATA(_task)),
365727a677fcSJonathan Peyton         lower_offset(bounds.lower_offset), upper_offset(bounds.upper_offset) {}
365827a677fcSJonathan Peyton   size_t get_lower_offset() const { return lower_offset; }
365927a677fcSJonathan Peyton   size_t get_upper_offset() const { return upper_offset; }
366027a677fcSJonathan Peyton   kmp_uint64 get_lb() const {
366127a677fcSJonathan Peyton     kmp_int64 retval;
366227a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
366327a677fcSJonathan Peyton     // Intel task just returns the lower bound normally
366427a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
366527a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + lower_offset);
366627a677fcSJonathan Peyton     } else {
366727a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
366827a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
366927a677fcSJonathan Peyton         kmp_int32 *lb = RCAST(kmp_int32 *, task->shareds);
367027a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
367127a677fcSJonathan Peyton       } else {
367227a677fcSJonathan Peyton         kmp_int64 *lb = RCAST(kmp_int64 *, task->shareds);
367327a677fcSJonathan Peyton         retval = (kmp_int64)*lb;
367427a677fcSJonathan Peyton       }
367527a677fcSJonathan Peyton     }
367627a677fcSJonathan Peyton #else
367727a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + lower_offset);
367827a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
367927a677fcSJonathan Peyton     return retval;
368027a677fcSJonathan Peyton   }
368127a677fcSJonathan Peyton   kmp_uint64 get_ub() const {
368227a677fcSJonathan Peyton     kmp_int64 retval;
368327a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
368427a677fcSJonathan Peyton     // Intel task just returns the upper bound normally
368527a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
368627a677fcSJonathan Peyton       retval = *(kmp_int64 *)((char *)task + upper_offset);
368727a677fcSJonathan Peyton     } else {
368827a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
368927a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
369027a677fcSJonathan Peyton         kmp_int32 *ub = RCAST(kmp_int32 *, task->shareds) + 1;
369127a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
369227a677fcSJonathan Peyton       } else {
369327a677fcSJonathan Peyton         kmp_int64 *ub = RCAST(kmp_int64 *, task->shareds) + 1;
369427a677fcSJonathan Peyton         retval = (kmp_int64)*ub;
369527a677fcSJonathan Peyton       }
369627a677fcSJonathan Peyton     }
369727a677fcSJonathan Peyton #else
369827a677fcSJonathan Peyton     retval = *(kmp_int64 *)((char *)task + upper_offset);
369927a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
370027a677fcSJonathan Peyton     return retval;
370127a677fcSJonathan Peyton   }
370227a677fcSJonathan Peyton   void set_lb(kmp_uint64 lb) {
370327a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
370427a677fcSJonathan Peyton     // Intel task just sets the lower bound normally
370527a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
370627a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + lower_offset) = lb;
370727a677fcSJonathan Peyton     } else {
370827a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
370927a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
371027a677fcSJonathan Peyton         kmp_uint32 *lower = RCAST(kmp_uint32 *, task->shareds);
371127a677fcSJonathan Peyton         *lower = (kmp_uint32)lb;
371227a677fcSJonathan Peyton       } else {
371327a677fcSJonathan Peyton         kmp_uint64 *lower = RCAST(kmp_uint64 *, task->shareds);
371427a677fcSJonathan Peyton         *lower = (kmp_uint64)lb;
371527a677fcSJonathan Peyton       }
371627a677fcSJonathan Peyton     }
371727a677fcSJonathan Peyton #else
371827a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + lower_offset) = lb;
371927a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
372027a677fcSJonathan Peyton   }
372127a677fcSJonathan Peyton   void set_ub(kmp_uint64 ub) {
372227a677fcSJonathan Peyton #if defined(KMP_GOMP_COMPAT)
372327a677fcSJonathan Peyton     // Intel task just sets the upper bound normally
372427a677fcSJonathan Peyton     if (!taskdata->td_flags.native) {
372527a677fcSJonathan Peyton       *(kmp_uint64 *)((char *)task + upper_offset) = ub;
372627a677fcSJonathan Peyton     } else {
372727a677fcSJonathan Peyton       // GOMP task has to take into account the sizeof(long)
372827a677fcSJonathan Peyton       if (taskdata->td_size_loop_bounds == 4) {
372927a677fcSJonathan Peyton         kmp_uint32 *upper = RCAST(kmp_uint32 *, task->shareds) + 1;
373027a677fcSJonathan Peyton         *upper = (kmp_uint32)ub;
373127a677fcSJonathan Peyton       } else {
373227a677fcSJonathan Peyton         kmp_uint64 *upper = RCAST(kmp_uint64 *, task->shareds) + 1;
373327a677fcSJonathan Peyton         *upper = (kmp_uint64)ub;
373427a677fcSJonathan Peyton       }
373527a677fcSJonathan Peyton     }
373627a677fcSJonathan Peyton #else
373727a677fcSJonathan Peyton     *(kmp_uint64 *)((char *)task + upper_offset) = ub;
373827a677fcSJonathan Peyton #endif // defined(KMP_GOMP_COMPAT)
373927a677fcSJonathan Peyton   }
374027a677fcSJonathan Peyton };
374127a677fcSJonathan Peyton 
37427cc577a4SJonathan Peyton // __kmp_taskloop_linear: Start tasks of the taskloop linearly
37437cc577a4SJonathan Peyton //
37447cc577a4SJonathan Peyton // loc        Source location information
37457cc577a4SJonathan Peyton // gtid       Global thread ID
374693e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
374793e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
374893e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
37497cc577a4SJonathan Peyton // st         Loop stride
375093e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
375193e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
375293e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
375393e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
375493e17cfeSJonathan Peyton // tc         Iterations count
37557cc577a4SJonathan Peyton // task_dup   Tasks duplication routine
3756cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
37573041982dSJonathan Peyton void __kmp_taskloop_linear(ident_t *loc, int gtid, kmp_task_t *task,
37587cc577a4SJonathan Peyton                            kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
375993e17cfeSJonathan Peyton                            kmp_uint64 ub_glob, kmp_uint64 num_tasks,
376093e17cfeSJonathan Peyton                            kmp_uint64 grainsize, kmp_uint64 extras,
3761cdaefac5SJoachim Protze                            kmp_uint64 tc,
3762cdaefac5SJoachim Protze #if OMPT_SUPPORT
3763cdaefac5SJoachim Protze                            void *codeptr_ra,
3764cdaefac5SJoachim Protze #endif
3765cdaefac5SJoachim Protze                            void *task_dup) {
37667cc577a4SJonathan Peyton   KMP_COUNT_BLOCK(OMP_TASKLOOP);
37677cc577a4SJonathan Peyton   KMP_TIME_PARTITIONED_BLOCK(OMP_taskloop_scheduling);
37687cc577a4SJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
376927a677fcSJonathan Peyton   // compiler provides global bounds here
377027a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
377127a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
377227a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
377393e17cfeSJonathan Peyton   kmp_uint64 i;
37747cc577a4SJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
37757cc577a4SJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
37767cc577a4SJonathan Peyton   kmp_task_t *next_task;
37777cc577a4SJonathan Peyton   kmp_int32 lastpriv = 0;
37787cc577a4SJonathan Peyton 
377993e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize + extras);
378093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
378193e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
378293e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_linear: T#%d: %lld tasks, grainsize %lld, "
3783d74d8902SJonathan Peyton                 "extras %lld, i=%lld,%lld(%d)%lld, dup %p\n",
3784d74d8902SJonathan Peyton                 gtid, num_tasks, grainsize, extras, lower, upper, ub_glob, st,
3785d74d8902SJonathan Peyton                 task_dup));
378693e17cfeSJonathan Peyton 
378793e17cfeSJonathan Peyton   // Launch num_tasks tasks, assign grainsize iterations each task
378893e17cfeSJonathan Peyton   for (i = 0; i < num_tasks; ++i) {
378993e17cfeSJonathan Peyton     kmp_uint64 chunk_minus_1;
379093e17cfeSJonathan Peyton     if (extras == 0) {
379193e17cfeSJonathan Peyton       chunk_minus_1 = grainsize - 1;
379293e17cfeSJonathan Peyton     } else {
379393e17cfeSJonathan Peyton       chunk_minus_1 = grainsize;
379493e17cfeSJonathan Peyton       --extras; // first extras iterations get bigger chunk (grainsize+1)
379593e17cfeSJonathan Peyton     }
379693e17cfeSJonathan Peyton     upper = lower + st * chunk_minus_1;
379793e17cfeSJonathan Peyton     if (i == num_tasks - 1) {
379893e17cfeSJonathan Peyton       // schedule the last task, set lastprivate flag if needed
379993e17cfeSJonathan Peyton       if (st == 1) { // most common case
380093e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper == *ub);
380193e17cfeSJonathan Peyton         if (upper == ub_glob)
380293e17cfeSJonathan Peyton           lastpriv = 1;
380393e17cfeSJonathan Peyton       } else if (st > 0) { // positive loop stride
380493e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT((kmp_uint64)st > *ub - upper);
380593e17cfeSJonathan Peyton         if ((kmp_uint64)st > ub_glob - upper)
380693e17cfeSJonathan Peyton           lastpriv = 1;
380793e17cfeSJonathan Peyton       } else { // negative loop stride
380893e17cfeSJonathan Peyton         KMP_DEBUG_ASSERT(upper + st < *ub);
380993e17cfeSJonathan Peyton         if (upper - ub_glob < (kmp_uint64)(-st))
381093e17cfeSJonathan Peyton           lastpriv = 1;
381193e17cfeSJonathan Peyton       }
381293e17cfeSJonathan Peyton     }
381393e17cfeSJonathan Peyton     next_task = __kmp_task_dup_alloc(thread, task); // allocate new task
381427a677fcSJonathan Peyton     kmp_taskdata_t *next_taskdata = KMP_TASK_TO_TASKDATA(next_task);
381527a677fcSJonathan Peyton     kmp_taskloop_bounds_t next_task_bounds =
381627a677fcSJonathan Peyton         kmp_taskloop_bounds_t(next_task, task_bounds);
381727a677fcSJonathan Peyton 
381893e17cfeSJonathan Peyton     // adjust task-specific bounds
381927a677fcSJonathan Peyton     next_task_bounds.set_lb(lower);
382027a677fcSJonathan Peyton     if (next_taskdata->td_flags.native) {
382127a677fcSJonathan Peyton       next_task_bounds.set_ub(upper + (st > 0 ? 1 : -1));
382227a677fcSJonathan Peyton     } else {
382327a677fcSJonathan Peyton       next_task_bounds.set_ub(upper);
382427a677fcSJonathan Peyton     }
382593e17cfeSJonathan Peyton     if (ptask_dup != NULL) // set lastprivate flag, construct fistprivates, etc.
382693e17cfeSJonathan Peyton       ptask_dup(next_task, task, lastpriv);
382727a677fcSJonathan Peyton     KA_TRACE(40,
382827a677fcSJonathan Peyton              ("__kmp_taskloop_linear: T#%d; task #%llu: task %p: lower %lld, "
382927a677fcSJonathan Peyton               "upper %lld stride %lld, (offsets %p %p)\n",
383027a677fcSJonathan Peyton               gtid, i, next_task, lower, upper, st,
383127a677fcSJonathan Peyton               next_task_bounds.get_lower_offset(),
383227a677fcSJonathan Peyton               next_task_bounds.get_upper_offset()));
3833cdaefac5SJoachim Protze #if OMPT_SUPPORT
3834cdaefac5SJoachim Protze     __kmp_omp_taskloop_task(NULL, gtid, next_task,
3835cdaefac5SJoachim Protze                            codeptr_ra); // schedule new task
3836cdaefac5SJoachim Protze #else
383793e17cfeSJonathan Peyton     __kmp_omp_task(gtid, next_task, true); // schedule new task
3838cdaefac5SJoachim Protze #endif
383993e17cfeSJonathan Peyton     lower = upper + st; // adjust lower bound for the next iteration
384093e17cfeSJonathan Peyton   }
384193e17cfeSJonathan Peyton   // free the pattern task and exit
384293e17cfeSJonathan Peyton   __kmp_task_start(gtid, task, current_task); // make internal bookkeeping
384393e17cfeSJonathan Peyton   // do not execute the pattern task, just do internal bookkeeping
384486ed6aa6SJoachim Protze   __kmp_task_finish<false>(gtid, task, current_task);
384593e17cfeSJonathan Peyton }
384693e17cfeSJonathan Peyton 
384793e17cfeSJonathan Peyton // Structure to keep taskloop parameters for auxiliary task
384893e17cfeSJonathan Peyton // kept in the shareds of the task structure.
384993e17cfeSJonathan Peyton typedef struct __taskloop_params {
385093e17cfeSJonathan Peyton   kmp_task_t *task;
385193e17cfeSJonathan Peyton   kmp_uint64 *lb;
385293e17cfeSJonathan Peyton   kmp_uint64 *ub;
385393e17cfeSJonathan Peyton   void *task_dup;
385493e17cfeSJonathan Peyton   kmp_int64 st;
385593e17cfeSJonathan Peyton   kmp_uint64 ub_glob;
385693e17cfeSJonathan Peyton   kmp_uint64 num_tasks;
385793e17cfeSJonathan Peyton   kmp_uint64 grainsize;
385893e17cfeSJonathan Peyton   kmp_uint64 extras;
385993e17cfeSJonathan Peyton   kmp_uint64 tc;
386093e17cfeSJonathan Peyton   kmp_uint64 num_t_min;
3861cdaefac5SJoachim Protze #if OMPT_SUPPORT
3862cdaefac5SJoachim Protze   void *codeptr_ra;
3863cdaefac5SJoachim Protze #endif
386493e17cfeSJonathan Peyton } __taskloop_params_t;
386593e17cfeSJonathan Peyton 
386693e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *, int, kmp_task_t *, kmp_uint64 *,
386793e17cfeSJonathan Peyton                           kmp_uint64 *, kmp_int64, kmp_uint64, kmp_uint64,
386893e17cfeSJonathan Peyton                           kmp_uint64, kmp_uint64, kmp_uint64, kmp_uint64,
3869cdaefac5SJoachim Protze #if OMPT_SUPPORT
3870cdaefac5SJoachim Protze                           void *,
3871cdaefac5SJoachim Protze #endif
387293e17cfeSJonathan Peyton                           void *);
387393e17cfeSJonathan Peyton 
387493e17cfeSJonathan Peyton // Execute part of the the taskloop submitted as a task.
387593e17cfeSJonathan Peyton int __kmp_taskloop_task(int gtid, void *ptask) {
3876d74d8902SJonathan Peyton   __taskloop_params_t *p =
3877d74d8902SJonathan Peyton       (__taskloop_params_t *)((kmp_task_t *)ptask)->shareds;
387893e17cfeSJonathan Peyton   kmp_task_t *task = p->task;
387993e17cfeSJonathan Peyton   kmp_uint64 *lb = p->lb;
388093e17cfeSJonathan Peyton   kmp_uint64 *ub = p->ub;
388193e17cfeSJonathan Peyton   void *task_dup = p->task_dup;
388293e17cfeSJonathan Peyton   //  p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
388393e17cfeSJonathan Peyton   kmp_int64 st = p->st;
388493e17cfeSJonathan Peyton   kmp_uint64 ub_glob = p->ub_glob;
388593e17cfeSJonathan Peyton   kmp_uint64 num_tasks = p->num_tasks;
388693e17cfeSJonathan Peyton   kmp_uint64 grainsize = p->grainsize;
388793e17cfeSJonathan Peyton   kmp_uint64 extras = p->extras;
388893e17cfeSJonathan Peyton   kmp_uint64 tc = p->tc;
388993e17cfeSJonathan Peyton   kmp_uint64 num_t_min = p->num_t_min;
3890cdaefac5SJoachim Protze #if OMPT_SUPPORT
3891cdaefac5SJoachim Protze   void *codeptr_ra = p->codeptr_ra;
3892cdaefac5SJoachim Protze #endif
389393e17cfeSJonathan Peyton #if KMP_DEBUG
389493e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
389593e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
389693e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_task: T#%d, task %p: %lld tasks, grainsize"
3897d74d8902SJonathan Peyton                 " %lld, extras %lld, i=%lld,%lld(%d), dup %p\n",
3898d74d8902SJonathan Peyton                 gtid, taskdata, num_tasks, grainsize, extras, *lb, *ub, st,
3899d74d8902SJonathan Peyton                 task_dup));
390093e17cfeSJonathan Peyton #endif
390193e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks * 2 + 1 > num_t_min);
390293e17cfeSJonathan Peyton   if (num_tasks > num_t_min)
390393e17cfeSJonathan Peyton     __kmp_taskloop_recur(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
3904cdaefac5SJoachim Protze                          grainsize, extras, tc, num_t_min,
3905cdaefac5SJoachim Protze #if OMPT_SUPPORT
3906cdaefac5SJoachim Protze                          codeptr_ra,
3907cdaefac5SJoachim Protze #endif
3908cdaefac5SJoachim Protze                          task_dup);
390993e17cfeSJonathan Peyton   else
391093e17cfeSJonathan Peyton     __kmp_taskloop_linear(NULL, gtid, task, lb, ub, st, ub_glob, num_tasks,
3911cdaefac5SJoachim Protze                           grainsize, extras, tc,
3912cdaefac5SJoachim Protze #if OMPT_SUPPORT
3913cdaefac5SJoachim Protze                           codeptr_ra,
3914cdaefac5SJoachim Protze #endif
3915cdaefac5SJoachim Protze                           task_dup);
391693e17cfeSJonathan Peyton 
391793e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmp_taskloop_task(exit): T#%d\n", gtid));
391893e17cfeSJonathan Peyton   return 0;
391993e17cfeSJonathan Peyton }
392093e17cfeSJonathan Peyton 
392193e17cfeSJonathan Peyton // Schedule part of the the taskloop as a task,
392293e17cfeSJonathan Peyton // execute the rest of the the taskloop.
392393e17cfeSJonathan Peyton //
392493e17cfeSJonathan Peyton // loc        Source location information
392593e17cfeSJonathan Peyton // gtid       Global thread ID
392693e17cfeSJonathan Peyton // task       Pattern task, exposes the loop iteration range
392793e17cfeSJonathan Peyton // lb         Pointer to loop lower bound in task structure
392893e17cfeSJonathan Peyton // ub         Pointer to loop upper bound in task structure
392993e17cfeSJonathan Peyton // st         Loop stride
393093e17cfeSJonathan Peyton // ub_glob    Global upper bound (used for lastprivate check)
393193e17cfeSJonathan Peyton // num_tasks  Number of tasks to execute
393293e17cfeSJonathan Peyton // grainsize  Number of loop iterations per task
393393e17cfeSJonathan Peyton // extras     Number of chunks with grainsize+1 iterations
393493e17cfeSJonathan Peyton // tc         Iterations count
393593e17cfeSJonathan Peyton // num_t_min  Threashold to launch tasks recursively
393693e17cfeSJonathan Peyton // task_dup   Tasks duplication routine
3937cdaefac5SJoachim Protze // codeptr_ra Return address for OMPT events
393893e17cfeSJonathan Peyton void __kmp_taskloop_recur(ident_t *loc, int gtid, kmp_task_t *task,
393993e17cfeSJonathan Peyton                           kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st,
394093e17cfeSJonathan Peyton                           kmp_uint64 ub_glob, kmp_uint64 num_tasks,
394193e17cfeSJonathan Peyton                           kmp_uint64 grainsize, kmp_uint64 extras,
3942cdaefac5SJoachim Protze                           kmp_uint64 tc, kmp_uint64 num_t_min,
3943cdaefac5SJoachim Protze #if OMPT_SUPPORT
3944cdaefac5SJoachim Protze                           void *codeptr_ra,
3945cdaefac5SJoachim Protze #endif
3946cdaefac5SJoachim Protze                           void *task_dup) {
394793e17cfeSJonathan Peyton #if KMP_DEBUG
394893e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
394993e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
395093e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > num_t_min);
395193e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmp_taskloop_recur: T#%d, task %p: %lld tasks, grainsize"
3952d74d8902SJonathan Peyton                 " %lld, extras %lld, i=%lld,%lld(%d), dup %p\n",
3953d74d8902SJonathan Peyton                 gtid, taskdata, num_tasks, grainsize, extras, *lb, *ub, st,
3954d74d8902SJonathan Peyton                 task_dup));
395593e17cfeSJonathan Peyton #endif
395693e17cfeSJonathan Peyton   p_task_dup_t ptask_dup = (p_task_dup_t)task_dup;
395793e17cfeSJonathan Peyton   kmp_uint64 lower = *lb;
395893e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
395993e17cfeSJonathan Peyton   //  kmp_taskdata_t *current_task = thread->th.th_current_task;
396093e17cfeSJonathan Peyton   kmp_task_t *next_task;
396193e17cfeSJonathan Peyton   size_t lower_offset =
396293e17cfeSJonathan Peyton       (char *)lb - (char *)task; // remember offset of lb in the task structure
396393e17cfeSJonathan Peyton   size_t upper_offset =
396493e17cfeSJonathan Peyton       (char *)ub - (char *)task; // remember offset of ub in the task structure
396593e17cfeSJonathan Peyton 
396693e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize + extras);
396793e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
396893e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
396993e17cfeSJonathan Peyton 
397093e17cfeSJonathan Peyton   // split the loop in two halves
397193e17cfeSJonathan Peyton   kmp_uint64 lb1, ub0, tc0, tc1, ext0, ext1;
397293e17cfeSJonathan Peyton   kmp_uint64 gr_size0 = grainsize;
397393e17cfeSJonathan Peyton   kmp_uint64 n_tsk0 = num_tasks >> 1; // num_tasks/2 to execute
397493e17cfeSJonathan Peyton   kmp_uint64 n_tsk1 = num_tasks - n_tsk0; // to schedule as a task
397593e17cfeSJonathan Peyton   if (n_tsk0 <= extras) {
397693e17cfeSJonathan Peyton     gr_size0++; // integrate extras into grainsize
397793e17cfeSJonathan Peyton     ext0 = 0; // no extra iters in 1st half
397893e17cfeSJonathan Peyton     ext1 = extras - n_tsk0; // remaining extras
397993e17cfeSJonathan Peyton     tc0 = gr_size0 * n_tsk0;
398093e17cfeSJonathan Peyton     tc1 = tc - tc0;
398193e17cfeSJonathan Peyton   } else { // n_tsk0 > extras
398293e17cfeSJonathan Peyton     ext1 = 0; // no extra iters in 2nd half
398393e17cfeSJonathan Peyton     ext0 = extras;
398493e17cfeSJonathan Peyton     tc1 = grainsize * n_tsk1;
398593e17cfeSJonathan Peyton     tc0 = tc - tc1;
398693e17cfeSJonathan Peyton   }
398793e17cfeSJonathan Peyton   ub0 = lower + st * (tc0 - 1);
398893e17cfeSJonathan Peyton   lb1 = ub0 + st;
398993e17cfeSJonathan Peyton 
399093e17cfeSJonathan Peyton   // create pattern task for 2nd half of the loop
399193e17cfeSJonathan Peyton   next_task = __kmp_task_dup_alloc(thread, task); // duplicate the task
399293e17cfeSJonathan Peyton   // adjust lower bound (upper bound is not changed) for the 2nd half
399393e17cfeSJonathan Peyton   *(kmp_uint64 *)((char *)next_task + lower_offset) = lb1;
399493e17cfeSJonathan Peyton   if (ptask_dup != NULL) // construct fistprivates, etc.
399593e17cfeSJonathan Peyton     ptask_dup(next_task, task, 0);
399693e17cfeSJonathan Peyton   *ub = ub0; // adjust upper bound for the 1st half
399793e17cfeSJonathan Peyton 
399893e17cfeSJonathan Peyton   // create auxiliary task for 2nd half of the loop
399993e17cfeSJonathan Peyton   kmp_task_t *new_task =
400093e17cfeSJonathan Peyton       __kmpc_omp_task_alloc(loc, gtid, 1, 3 * sizeof(void *),
400193e17cfeSJonathan Peyton                             sizeof(__taskloop_params_t), &__kmp_taskloop_task);
400293e17cfeSJonathan Peyton   __taskloop_params_t *p = (__taskloop_params_t *)new_task->shareds;
400393e17cfeSJonathan Peyton   p->task = next_task;
400493e17cfeSJonathan Peyton   p->lb = (kmp_uint64 *)((char *)next_task + lower_offset);
400593e17cfeSJonathan Peyton   p->ub = (kmp_uint64 *)((char *)next_task + upper_offset);
400693e17cfeSJonathan Peyton   p->task_dup = task_dup;
400793e17cfeSJonathan Peyton   p->st = st;
400893e17cfeSJonathan Peyton   p->ub_glob = ub_glob;
400993e17cfeSJonathan Peyton   p->num_tasks = n_tsk1;
401093e17cfeSJonathan Peyton   p->grainsize = grainsize;
401193e17cfeSJonathan Peyton   p->extras = ext1;
401293e17cfeSJonathan Peyton   p->tc = tc1;
401393e17cfeSJonathan Peyton   p->num_t_min = num_t_min;
4014cdaefac5SJoachim Protze #if OMPT_SUPPORT
4015cdaefac5SJoachim Protze   p->codeptr_ra = codeptr_ra;
4016cdaefac5SJoachim Protze #endif
4017cdaefac5SJoachim Protze 
4018cdaefac5SJoachim Protze #if OMPT_SUPPORT
4019cdaefac5SJoachim Protze   // schedule new task with correct return address for OMPT events
4020cdaefac5SJoachim Protze   __kmp_omp_taskloop_task(NULL, gtid, new_task, codeptr_ra);
4021cdaefac5SJoachim Protze #else
4022f729df82SGheorghe-Teodor Bercea   __kmp_omp_task(gtid, new_task, true); // schedule new task
4023cdaefac5SJoachim Protze #endif
402493e17cfeSJonathan Peyton 
402593e17cfeSJonathan Peyton   // execute the 1st half of current subrange
402693e17cfeSJonathan Peyton   if (n_tsk0 > num_t_min)
4027d74d8902SJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0, gr_size0,
4028cdaefac5SJoachim Protze                          ext0, tc0, num_t_min,
4029cdaefac5SJoachim Protze #if OMPT_SUPPORT
4030cdaefac5SJoachim Protze                          codeptr_ra,
4031cdaefac5SJoachim Protze #endif
4032cdaefac5SJoachim Protze                          task_dup);
403393e17cfeSJonathan Peyton   else
403493e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, n_tsk0,
4035cdaefac5SJoachim Protze                           gr_size0, ext0, tc0,
4036cdaefac5SJoachim Protze #if OMPT_SUPPORT
4037cdaefac5SJoachim Protze                           codeptr_ra,
4038cdaefac5SJoachim Protze #endif
4039cdaefac5SJoachim Protze                           task_dup);
404093e17cfeSJonathan Peyton 
404193e17cfeSJonathan Peyton   KA_TRACE(40, ("__kmpc_taskloop_recur(exit): T#%d\n", gtid));
404293e17cfeSJonathan Peyton }
404393e17cfeSJonathan Peyton 
404493e17cfeSJonathan Peyton /*!
404593e17cfeSJonathan Peyton @ingroup TASKING
404693e17cfeSJonathan Peyton @param loc       Source location information
404793e17cfeSJonathan Peyton @param gtid      Global thread ID
404893e17cfeSJonathan Peyton @param task      Task structure
404993e17cfeSJonathan Peyton @param if_val    Value of the if clause
405093e17cfeSJonathan Peyton @param lb        Pointer to loop lower bound in task structure
405193e17cfeSJonathan Peyton @param ub        Pointer to loop upper bound in task structure
405293e17cfeSJonathan Peyton @param st        Loop stride
405393e17cfeSJonathan Peyton @param nogroup   Flag, 1 if nogroup clause specified, 0 otherwise
405493e17cfeSJonathan Peyton @param sched     Schedule specified 0/1/2 for none/grainsize/num_tasks
405593e17cfeSJonathan Peyton @param grainsize Schedule value if specified
405693e17cfeSJonathan Peyton @param task_dup  Tasks duplication routine
405793e17cfeSJonathan Peyton 
405893e17cfeSJonathan Peyton Execute the taskloop construct.
405993e17cfeSJonathan Peyton */
406093e17cfeSJonathan Peyton void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int if_val,
406193e17cfeSJonathan Peyton                      kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup,
406293e17cfeSJonathan Peyton                      int sched, kmp_uint64 grainsize, void *task_dup) {
406393e17cfeSJonathan Peyton   kmp_taskdata_t *taskdata = KMP_TASK_TO_TASKDATA(task);
406493e17cfeSJonathan Peyton   KMP_DEBUG_ASSERT(task != NULL);
406593e17cfeSJonathan Peyton 
406682e94a59SJoachim Protze   if (nogroup == 0) {
406782e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
406882e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
406982e94a59SJoachim Protze #endif
407093e17cfeSJonathan Peyton     __kmpc_taskgroup(loc, gtid);
407182e94a59SJoachim Protze   }
407293e17cfeSJonathan Peyton 
407393e17cfeSJonathan Peyton   // =========================================================================
407493e17cfeSJonathan Peyton   // calculate loop parameters
407527a677fcSJonathan Peyton   kmp_taskloop_bounds_t task_bounds(task, lb, ub);
407693e17cfeSJonathan Peyton   kmp_uint64 tc;
407727a677fcSJonathan Peyton   // compiler provides global bounds here
407827a677fcSJonathan Peyton   kmp_uint64 lower = task_bounds.get_lb();
407927a677fcSJonathan Peyton   kmp_uint64 upper = task_bounds.get_ub();
408093e17cfeSJonathan Peyton   kmp_uint64 ub_glob = upper; // global upper used to calc lastprivate flag
408193e17cfeSJonathan Peyton   kmp_uint64 num_tasks = 0, extras = 0;
408293e17cfeSJonathan Peyton   kmp_uint64 num_tasks_min = __kmp_taskloop_min_tasks;
408393e17cfeSJonathan Peyton   kmp_info_t *thread = __kmp_threads[gtid];
408493e17cfeSJonathan Peyton   kmp_taskdata_t *current_task = thread->th.th_current_task;
408593e17cfeSJonathan Peyton 
408627a677fcSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop: T#%d, task %p, lb %lld, ub %lld, st %lld, "
408727a677fcSJonathan Peyton                 "grain %llu(%d), dup %p\n",
408827a677fcSJonathan Peyton                 gtid, taskdata, lower, upper, st, grainsize, sched, task_dup));
408927a677fcSJonathan Peyton 
40907cc577a4SJonathan Peyton   // compute trip count
40917cc577a4SJonathan Peyton   if (st == 1) { // most common case
40927cc577a4SJonathan Peyton     tc = upper - lower + 1;
40937cc577a4SJonathan Peyton   } else if (st < 0) {
40947cc577a4SJonathan Peyton     tc = (lower - upper) / (-st) + 1;
40957cc577a4SJonathan Peyton   } else { // st > 0
40967cc577a4SJonathan Peyton     tc = (upper - lower) / st + 1;
40977cc577a4SJonathan Peyton   }
40987cc577a4SJonathan Peyton   if (tc == 0) {
40997cc577a4SJonathan Peyton     KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d zero-trip loop\n", gtid));
41007cc577a4SJonathan Peyton     // free the pattern task and exit
41017cc577a4SJonathan Peyton     __kmp_task_start(gtid, task, current_task);
41027cc577a4SJonathan Peyton     // do not execute anything for zero-trip loop
410386ed6aa6SJoachim Protze     __kmp_task_finish<false>(gtid, task, current_task);
41047cc577a4SJonathan Peyton     return;
41057cc577a4SJonathan Peyton   }
4106cdaefac5SJoachim Protze 
4107cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4108cdaefac5SJoachim Protze   ompt_team_info_t *team_info = __ompt_get_teaminfo(0, NULL);
4109cdaefac5SJoachim Protze   ompt_task_info_t *task_info = __ompt_get_task_info_object(0);
4110cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4111cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4112cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_begin, &(team_info->parallel_data),
4113cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4114cdaefac5SJoachim Protze   }
4115cdaefac5SJoachim Protze #endif
4116cdaefac5SJoachim Protze 
411793e17cfeSJonathan Peyton   if (num_tasks_min == 0)
411893e17cfeSJonathan Peyton     // TODO: can we choose better default heuristic?
4119d74d8902SJonathan Peyton     num_tasks_min =
4120d74d8902SJonathan Peyton         KMP_MIN(thread->th.th_team_nproc * 10, INITIAL_TASK_DEQUE_SIZE);
41217cc577a4SJonathan Peyton 
41227cc577a4SJonathan Peyton   // compute num_tasks/grainsize based on the input provided
41237cc577a4SJonathan Peyton   switch (sched) {
41247cc577a4SJonathan Peyton   case 0: // no schedule clause specified, we can choose the default
41257cc577a4SJonathan Peyton     // let's try to schedule (team_size*10) tasks
41267cc577a4SJonathan Peyton     grainsize = thread->th.th_team_nproc * 10;
41277cc577a4SJonathan Peyton   case 2: // num_tasks provided
41287cc577a4SJonathan Peyton     if (grainsize > tc) {
41297cc577a4SJonathan Peyton       num_tasks = tc; // too big num_tasks requested, adjust values
41307cc577a4SJonathan Peyton       grainsize = 1;
41317cc577a4SJonathan Peyton       extras = 0;
41327cc577a4SJonathan Peyton     } else {
41337cc577a4SJonathan Peyton       num_tasks = grainsize;
41347cc577a4SJonathan Peyton       grainsize = tc / num_tasks;
41357cc577a4SJonathan Peyton       extras = tc % num_tasks;
41367cc577a4SJonathan Peyton     }
41377cc577a4SJonathan Peyton     break;
41387cc577a4SJonathan Peyton   case 1: // grainsize provided
41397cc577a4SJonathan Peyton     if (grainsize > tc) {
41407cc577a4SJonathan Peyton       num_tasks = 1; // too big grainsize requested, adjust values
41417cc577a4SJonathan Peyton       grainsize = tc;
41427cc577a4SJonathan Peyton       extras = 0;
41437cc577a4SJonathan Peyton     } else {
41447cc577a4SJonathan Peyton       num_tasks = tc / grainsize;
414593e17cfeSJonathan Peyton       // adjust grainsize for balanced distribution of iterations
414693e17cfeSJonathan Peyton       grainsize = tc / num_tasks;
41477cc577a4SJonathan Peyton       extras = tc % num_tasks;
41487cc577a4SJonathan Peyton     }
41497cc577a4SJonathan Peyton     break;
41507cc577a4SJonathan Peyton   default:
41517cc577a4SJonathan Peyton     KMP_ASSERT2(0, "unknown scheduling of taskloop");
41527cc577a4SJonathan Peyton   }
41537cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(tc == num_tasks * grainsize + extras);
41547cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > extras);
41557cc577a4SJonathan Peyton   KMP_DEBUG_ASSERT(num_tasks > 0);
415693e17cfeSJonathan Peyton   // =========================================================================
41577cc577a4SJonathan Peyton 
41587cc577a4SJonathan Peyton   // check if clause value first
415927a677fcSJonathan Peyton   // Also require GOMP_taskloop to reduce to linear (taskdata->td_flags.native)
41607cc577a4SJonathan Peyton   if (if_val == 0) { // if(0) specified, mark task as serial
41617cc577a4SJonathan Peyton     taskdata->td_flags.task_serial = 1;
41627cc577a4SJonathan Peyton     taskdata->td_flags.tiedness = TASK_TIED; // AC: serial task cannot be untied
416393e17cfeSJonathan Peyton     // always start serial tasks linearly
416493e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4165cdaefac5SJoachim Protze                           grainsize, extras, tc,
4166cdaefac5SJoachim Protze #if OMPT_SUPPORT
4167cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4168cdaefac5SJoachim Protze #endif
4169cdaefac5SJoachim Protze                           task_dup);
417027a677fcSJonathan Peyton     // !taskdata->td_flags.native => currently force linear spawning of tasks
417127a677fcSJonathan Peyton     // for GOMP_taskloop
417227a677fcSJonathan Peyton   } else if (num_tasks > num_tasks_min && !taskdata->td_flags.native) {
417393e17cfeSJonathan Peyton     KA_TRACE(20, ("__kmpc_taskloop: T#%d, go recursive: tc %llu, #tasks %llu"
4174d74d8902SJonathan Peyton                   "(%lld), grain %llu, extras %llu\n",
4175d74d8902SJonathan Peyton                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras));
417693e17cfeSJonathan Peyton     __kmp_taskloop_recur(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4177cdaefac5SJoachim Protze                          grainsize, extras, tc, num_tasks_min,
4178cdaefac5SJoachim Protze #if OMPT_SUPPORT
4179cdaefac5SJoachim Protze                          OMPT_GET_RETURN_ADDRESS(0),
4180cdaefac5SJoachim Protze #endif
4181cdaefac5SJoachim Protze                          task_dup);
418293e17cfeSJonathan Peyton   } else {
418393e17cfeSJonathan Peyton     KA_TRACE(20, ("__kmpc_taskloop: T#%d, go linear: tc %llu, #tasks %llu"
4184d74d8902SJonathan Peyton                   "(%lld), grain %llu, extras %llu\n",
4185d74d8902SJonathan Peyton                   gtid, tc, num_tasks, num_tasks_min, grainsize, extras));
418693e17cfeSJonathan Peyton     __kmp_taskloop_linear(loc, gtid, task, lb, ub, st, ub_glob, num_tasks,
4187cdaefac5SJoachim Protze                           grainsize, extras, tc,
4188cdaefac5SJoachim Protze #if OMPT_SUPPORT
4189cdaefac5SJoachim Protze                           OMPT_GET_RETURN_ADDRESS(0),
4190cdaefac5SJoachim Protze #endif
4191cdaefac5SJoachim Protze                           task_dup);
41927cc577a4SJonathan Peyton   }
41937cc577a4SJonathan Peyton 
4194cdaefac5SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
4195cdaefac5SJoachim Protze   if (ompt_enabled.ompt_callback_work) {
4196cdaefac5SJoachim Protze     ompt_callbacks.ompt_callback(ompt_callback_work)(
4197cdaefac5SJoachim Protze         ompt_work_taskloop, ompt_scope_end, &(team_info->parallel_data),
4198cdaefac5SJoachim Protze         &(task_info->task_data), tc, OMPT_GET_RETURN_ADDRESS(0));
4199cdaefac5SJoachim Protze   }
4200cdaefac5SJoachim Protze #endif
4201cdaefac5SJoachim Protze 
420282e94a59SJoachim Protze   if (nogroup == 0) {
420382e94a59SJoachim Protze #if OMPT_SUPPORT && OMPT_OPTIONAL
420482e94a59SJoachim Protze     OMPT_STORE_RETURN_ADDRESS(gtid);
420582e94a59SJoachim Protze #endif
42067cc577a4SJonathan Peyton     __kmpc_end_taskgroup(loc, gtid);
420782e94a59SJoachim Protze   }
420893e17cfeSJonathan Peyton   KA_TRACE(20, ("__kmpc_taskloop(exit): T#%d\n", gtid));
42097cc577a4SJonathan Peyton }
42107cc577a4SJonathan Peyton 
42117cc577a4SJonathan Peyton #endif
4212