[OMPT] Return appropiate values for ompt runtime entry points when the current thread is not an OpenMP thread

[sconvent]

Summary

When the current thread is not an (initialized) OpenMP thread, the runtime entry points return values that correspond to "not available" or similar

[sconvent]

Fix formatting

[omalyshe]

Should we add a test for the case ompt_* calls from non-OpenMP thread?

[Hahnfeld]

In D41167#955387, @omalyshe wrote:

Should we add a test for the case ompt_* calls from non-OpenMP thread?

Yes, I think this would be good.

[sconvent]

Added testcase

[protze.joachim]

LGTM

openmp/trunk/runtime/src/ompt-general.cpp

 #endif
 }
 
 OMPT_API_ROUTINE int ompt_get_place_num(void) {
 // copied from kmp_ftn_entry.h (but modified)
 #if !KMP_AFFINITY_SUPPORTED
   return -1;
 #else
+  if (__kmp_get_gtid() < 0)
+    return -1;
+
   int gtid;
   kmp_info_t *thread;
   if (!KMP_AFFINITY_CAPABLE())
     return -1;
   gtid = __kmp_entry_gtid();
   thread = __kmp_thread_from_gtid(gtid);
   if (thread == NULL || thread->th.th_current_place < 0)
     return -1;
   return thread->th.th_current_place;
 #endif
 }
 
 OMPT_API_ROUTINE int ompt_get_partition_place_nums(int place_nums_size,
                                                    int *place_nums) {
 // copied from kmp_ftn_entry.h (but modified)
 #if !KMP_AFFINITY_SUPPORTED
   return 0;
 #else
+  if (__kmp_get_gtid() < 0)
+    return 0;
+
   int i, gtid, place_num, first_place, last_place, start, end;
   kmp_info_t *thread;
   if (!KMP_AFFINITY_CAPABLE())
     return 0;
   gtid = __kmp_entry_gtid();
   thread = __kmp_thread_from_gtid(gtid);
   if (thread == NULL)
     return 0;

 }
 
 /*****************************************************************************
  * places
  ****************************************************************************/
 
 OMPT_API_ROUTINE int ompt_get_proc_id(void) {
 #if KMP_OS_LINUX
+  if (__kmp_get_gtid() < 0)
+    return -1;
+
   return sched_getcpu();
 #else
   return -1;
 #endif
 }
 
 /*****************************************************************************
  * compatability

openmp/trunk/runtime/src/ompt-specific.cpp

 
 //----------------------------------------------------------
 // parallel region support
 //----------------------------------------------------------
 
 int __ompt_get_parallel_info_internal(int ancestor_level,
                                       ompt_data_t **parallel_data,
                                       int *team_size) {
+  if (__kmp_get_gtid() >= 0) {
     ompt_team_info_t *info;
     if (team_size) {
       info = __ompt_get_teaminfo(ancestor_level, team_size);
     } else {
       info = __ompt_get_teaminfo(ancestor_level, NULL);
     }
     if (parallel_data) {
       *parallel_data = info ? &(info->parallel_data) : NULL;
     }
     return info ? 2 : 0;
+  } else {
+    return 0;
+  }
 }
 
 //----------------------------------------------------------
 // lightweight task team support
 //----------------------------------------------------------
 
 void __ompt_lw_taskteam_init(ompt_lw_taskteam_t *lwt, kmp_info_t *thr, int gtid,
                              ompt_data_t *ompt_pid, void *codeptr) {

 // task support
 //----------------------------------------------------------
 
 int __ompt_get_task_info_internal(int ancestor_level, int *type,
                                   ompt_data_t **task_data,
                                   ompt_frame_t **task_frame,
                                   ompt_data_t **parallel_data,
                                   int *thread_num) {
+  if (__kmp_get_gtid() < 0)
+    return 0;
+
   if (ancestor_level < 0)
     return 0;
 
   // copied from __ompt_get_scheduling_taskinfo
   ompt_task_info_t *info = NULL;
   ompt_team_info_t *team_info = NULL;
   kmp_info_t *thr = ompt_get_thread();
 

openmp/trunk/runtime/test/ompt/misc/api_calls_from_other_thread.cpp

+// RUN: env OMP_PLACES=cores %libomp-cxx-compile-and-run | FileCheck %s
+// REQUIRES: ompt, linux
+
+#include <thread>
+#include "callback.h"
+
+void f() {
+    ompt_data_t* tdata = ompt_get_thread_data();
+    uint64_t tvalue = tdata ? tdata->value : 0;
+
+    printf("%" PRIu64 ": ompt_get_num_places()=%d\n", tvalue, ompt_get_num_places());
+
+    printf("%" PRIu64 ": ompt_get_place_proc_ids()=%d\n", tvalue, ompt_get_place_proc_ids(0, 0, NULL));
+
+    printf("%" PRIu64 ": ompt_get_place_num()=%d\n", tvalue, ompt_get_place_num());
+
+    printf("%" PRIu64 ": ompt_get_partition_place_nums()=%d\n", tvalue, ompt_get_partition_place_nums(0, NULL));
+
+    printf("%" PRIu64 ": ompt_get_proc_id()=%d\n", tvalue, ompt_get_proc_id());
+
+    printf("%" PRIu64 ": ompt_get_num_procs()=%d\n", tvalue, ompt_get_num_procs());
+}
+
+
+int main()
+{
+  #pragma omp parallel num_threads(1)
+  {}
+
+  std::thread t1(f);
+  t1.join();
+
+  // Check if libomp supports the callbacks for this test.
+
+  // CHECK: 0: NULL_POINTER=[[NULL:.*$]]
+
+  // CHECK: {{^}}[[MASTER_ID:[0-9]+]]: ompt_get_num_places()=0
+
+  // CHECK: {{^}}[[MASTER_ID]]: ompt_get_place_proc_ids()=0
+
+  // CHECK: {{^}}[[MASTER_ID]]: ompt_get_place_num()=-1
+
+  // CHECK: {{^}}[[MASTER_ID]]: ompt_get_partition_place_nums()=0
+
+  // CHECK: {{^}}[[MASTER_ID]]: ompt_get_proc_id()=-1
+
+  // CHECK: {{^}}[[MASTER_ID]]: ompt_get_num_procs()={{[0-9]+}}
+
+
+  return 0;
+}