add basic control_tool functionality

Author: sconvent

runtime/src/include/45/omp.h.var

@@ -182,6 +182,16 @@
     extern void   __KAI_KMPC_CONVENTION  kmp_set_warnings_on(void);
     extern void   __KAI_KMPC_CONVENTION  kmp_set_warnings_off(void);
 
+    /* OpenMP 5.0 Tool Control */
+    typedef enum omp_control_tool_result_t {
+        omp_control_tool_notool = -2,
+        omp_control_tool_nocallback = -1,
+        omp_control_tool_success = 0,
+        omp_control_tool_ignored = 1
+    } omp_control_tool_result_t;
+    
+    extern int __KAI_KMPC_CONVENTION omp_control_tool(int, int, void*);
+
 #   undef __KAI_KMPC_CONVENTION
 
     /* Warning:

runtime/src/include/45/ompt.h.var

@@ -91,7 +91,7 @@
     /*macro (ompt_callback_target_data_op         ompt_callback_target_data_op_t, 9)*/ /* target data op*/          \
     /*macro (ompt_callback_target_submit,         ompt_callback_target_submit_t, 10)*/ /* target  submit*/          \
                                                                                                                 \
-    /*macro (ompt_callback_control_tool,          ompt_callback_control_tool_t,  11)*/ /* control tool */           \
+    macro (ompt_callback_control_tool,          ompt_callback_control_tool_t,  11) /* control tool */           \
                                                                                                                 \
     /*macro (ompt_callback_device_initialize,     ompt_callback_device_initialize_t, 12)*/ /* device initialize */  \
                                                                                                                 \
@@ -129,7 +129,7 @@
                                                                                                                 \
                                                                                                                 \
     /*--- Old Events --- */                                                                                     \
-    macro (ompt_event_control,                  ompt_control_callback_t,       29) /* support control calls */  \
+    //macro (ompt_event_control,                  ompt_control_callback_t,       29) /* support control calls */  \
 
 
 
@@ -368,10 +368,12 @@ typedef void (*ompt_callback_task_dependence_t) (
     ompt_data_t *sink_task_data
 );
 
-/* program */
-typedef void (*ompt_control_callback_t) (
+/* control_tool */
+typedef int (*ompt_callback_control_tool_t) (
     uint64_t command,                 /* command of control call      */
-    uint64_t modifier                 /* modifier of control call     */
+    uint64_t modifier,                /* modifier of control call     */
+    void *arg,
+    const void *codeptr_ra
 );
 
 typedef void (*ompt_callback_t)(void);

runtime/src/ompt-event-specific.h

@@ -47,7 +47,7 @@
 #define ompt_callback_thread_begin_implemented          ompt_event_MAY_ALWAYS
 #define ompt_callback_thread_end_implemented            ompt_event_MAY_ALWAYS
 
-#define ompt_event_control_implemented                  ompt_event_MAY_ALWAYS
+#define ompt_callback_control_tool_implemented          ompt_event_MAY_ALWAYS
 
 #define ompt_callback_implicit_task_implemented         ompt_event_MAY_ALWAYS
 

runtime/src/ompt-general.cpp

@@ -485,10 +485,25 @@ OMPT_API_ROUTINE int ompt_get_ompt_version()
  | control
  ---------------------------------------------------------------------------*/
 
-_OMP_EXTERN void ompt_control(uint64_t command, uint64_t modifier)
+_OMP_EXTERN int omp_control_tool(uint64_t command, uint64_t modifier, void *arg)
 {
-    if (ompt_enabled && ompt_callbacks.ompt_callback(ompt_event_control)) {
-        ompt_callbacks.ompt_callback(ompt_event_control)(command, modifier);
+    if(ompt_enabled){
+        if (ompt_callbacks.ompt_callback(ompt_callback_control_tool)) {
+            return ompt_callbacks.ompt_callback(ompt_callback_control_tool)(
+                command,
+                modifier,
+                arg,
+                OMPT_GET_RETURN_ADDRESS(0));
+        }
+        else {
+            //TODO: replace hardcoded number by enum entry
+            return -1;
+        }
+    }
+    else {
+        //TODO: return value?
+        //TODO: replace hardcoded number by enum entry
+        return -2;
     }
 }
 

runtime/test/ompt/callback.h

@@ -565,6 +565,17 @@ on_ompt_callback_thread_end(
   //printf("%" PRIu64 ": ompt_event_thread_end: thread_type=%s=%d, thread_id=%" PRIu64 "\n", ompt_get_thread_data()->value, ompt_thread_type_t_values[thread_type], thread_type, thread_data->value);
 }
 
+static int
+on_ompt_callback_control_tool(
+  uint64_t command,
+  uint64_t modifier,
+  void *arg,
+  const void *codeptr_ra)
+{
+  printf("%" PRIu64 ": ompt_event_control_tool: command=%" PRIu64 ", modifier=%" PRIu64 ", arg=%p, codeptr_ra=%p\n", ompt_get_thread_data()->value, command, modifier, arg, codeptr_ra);
+  return 0; //success
+}
+
 #define register_callback_t(name, type)                       \
 do{                                                           \
   type f_##name = &on_##name;                                 \
@@ -591,7 +602,7 @@ int ompt_initialize(
   register_callback(ompt_callback_nest_lock);
   register_callback(ompt_callback_sync_region);
   register_callback_t(ompt_callback_sync_region_wait, ompt_callback_sync_region_t);
-//  register_callback(ompt_event_control);
+  register_callback(ompt_callback_control_tool);
   register_callback(ompt_callback_flush);
   register_callback(ompt_callback_cancel);
   register_callback(ompt_callback_idle);

runtime/test/ompt/misc/control_tool.c

@@ -0,0 +1,21 @@
+// RUN: %libomp-compile-and-run | FileCheck %s
+// REQUIRES: ompt
+#include "callback.h"
+#include <omp.h>
+
+int main()
+{
+  #pragma omp parallel num_threads(1)
+  {
+    omp_control_tool(0, 0, NULL);
+  }
+
+  // Check if libomp supports the callbacks for this test.
+  // CHECK-NOT: {{^}}0: Could not register callback 'ompt_callback_control_tool'
+
+  // CHECK: 0: NULL_POINTER=[[NULL:.*$]]
+
+  // CHECK: {{^}}[[MASTER_ID:[0-9]+]]: ompt_event_control_tool: command=0, modifier=0, arg=(nil), codeptr_ra={{0x[0-f]*}}
+
+  return 0;
+}