Optional events for master and worksharing constructs.

Events are not used for AD and disabled by default.
Support events for worksharing constructs in the macro backend.

Merge branch 'feature/optionalEvents' into develop

Author: jblueh

.gitlab-ci.yml

@@ -16,6 +16,9 @@ gcc-macro:
 
 clang-macro:
   image: fedora:41
+  parallel:
+    matrix:
+      - FLAGS: ["", "-DOPDI_BACKEND_GENERATE_MASTER_EVENTS=1 -DOPDI_BACKEND_GENERATE_WORK_EVENTS=1"]
   script:
     - dnf install -y diffutils binutils clang git
     - git clone --depth 1 --branch develop https://github.com/SciCompKL/CoDiPack.git
@@ -29,7 +32,7 @@ clang-ompt:
   image: fedora:41
   parallel:
     matrix:
-      - FLAGS: ["-DOPDI_OMPT_BACKEND_IMPLICIT_TASK_END_SOURCE=1", "-DOPDI_OMPT_BACKEND_IMPLICIT_TASK_END_SOURCE=2"]
+      - FLAGS: ["-DOPDI_OMPT_BACKEND_IMPLICIT_TASK_END_SOURCE=1", "-DOPDI_OMPT_BACKEND_IMPLICIT_TASK_END_SOURCE=2", "-DOPDI_BACKEND_GENERATE_MASTER_EVENTS=1 -DOPDI_BACKEND_GENERATE_WORK_EVENTS=1"]
   script:
     - dnf install -y diffutils binutils clang git
     - git clone --depth 1 --branch develop https://github.com/SciCompKL/CoDiPack.git

include/opdi/backend/macro/macros.hpp

@@ -27,6 +27,7 @@
 
 #include <omp.h>
 
+#include "../../config.hpp"
 #include "../../helpers/macros.hpp"
 
 #include "implicitBarrierTools.hpp"
@@ -46,22 +47,33 @@
     opdi::logic->onParallelEnd(opdiInternalParallelData); \
   }
 
+#if OPDI_BACKEND_GENERATE_WORK_EVENTS
+  #define OPDI_WORK(type, endpoint) opdi::logic->onWork(kind, endpoint)
+#else
+  #define OPDI_WORK(type, endpoint) /* empty */
+#endif
+
 #define OPDI_FOR(...) \
   opdi::ImplicitBarrierTools::beginRegionWithImplicitBarrier(); \
+  OPDI_WORK(opdi::LogicInterface::WorksharingKind::Loop, opdi::LogicInterface::ScopeEndpoint::Begin); \
   OPDI_PRAGMA(omp for __VA_ARGS__ private(opdi::internalLoopProbe))
 
 #define OPDI_END_FOR \
+  OPDI_WORK(opdi::LogicInterface::WorksharingKind::Loop, opdi::LogicInterface::ScopeEndpoint::End); \
   opdi::ImplicitBarrierTools::endRegionWithImplicitBarrier();
 
 #define OPDI_SECTIONS(...) \
   opdi::ImplicitBarrierTools::beginRegionWithImplicitBarrier(); \
+  OPDI_WORK(opdi::LogicInterface::WorksharingKind::Sections, opdi::LogicInterface::ScopeEndpoint::Begin); \
   OPDI_PRAGMA(omp sections private(opdi::internalSectionsProbe) __VA_ARGS__)
 
 #define OPDI_END_SECTIONS \
+  OPDI_WORK(opdi::LogicInterface::WorksharingKind::Sections, opdi::LogicInterface::ScopeEndpoint::End); \
   opdi::ImplicitBarrierTools::endRegionWithImplicitBarrier();
 
 #define OPDI_SINGLE(...) \
   { \
+    OPDI_WORK(opdi::LogicInterface::WorksharingKind::Single, opdi::LogicInterface::ScopeEndpoint::Begin); \
     bool constexpr opdiInternalBarrierIndicator = true; \
     void* opdiInternalTapePosition1 = opdi::tool->allocPosition(); \
     opdi::tool->getTapePosition(opdi::tool->getThreadLocalTape(), opdiInternalTapePosition1); \
@@ -78,6 +90,7 @@
 
 #define OPDI_SINGLE_NOWAIT(...) \
   { \
+    OPDI_WORK(opdi::LogicInterface::WorksharingKind::Single, opdi::LogicInterface::ScopeEndpoint::Begin); \
     bool constexpr opdiInternalBarrierIndicator = false; \
     void* opdiInternalTapePosition1 = opdi::tool->allocPosition(); \
     void* opdiInternalTapePosition2 = opdi::tool->allocPosition(); /* for consistency with the end macro */ \
@@ -100,6 +113,7 @@
     } \
     opdi::tool->freePosition(opdiInternalTapePosition1); \
     opdi::tool->freePosition(opdiInternalTapePosition2); \
+    OPDI_WORK(opdi::LogicInterface::WorksharingKind::Single, opdi::LogicInterface::ScopeEndpoint::End); \
     opdi::ImplicitBarrierTools::implicitBarrierStack.top() = opdiInternalBarrierIndicator; \
     opdi::ImplicitBarrierTools::endRegionWithImplicitBarrier(); \
   }
@@ -144,14 +158,21 @@
 
 #define OPDI_END_SECTION
 
-#define OPDI_MASTER(...) \
-  OPDI_PRAGMA(omp master __VA_ARGS__) \
-  { \
-    opdi::logic->onMaster(opdi::LogicInterface::ScopeEndpoint::Begin);
+#if OPDI_BACKEND_GENERATE_MASTER_EVENTS
+  #define OPDI_MASTER(...) \
+    OPDI_PRAGMA(omp master __VA_ARGS__) \
+    { \
+      opdi::logic->onMaster(opdi::LogicInterface::ScopeEndpoint::Begin);
 
-#define OPDI_END_MASTER \
-    opdi::logic->onMaster(opdi::LogicInterface::ScopeEndpoint::End); \
-  }
+  #define OPDI_END_MASTER \
+      opdi::logic->onMaster(opdi::LogicInterface::ScopeEndpoint::End); \
+    }
+#else
+  #define OPDI_MASTER(...) \
+    OPDI_PRAGMA(omp master __VA_ARGS__) \
+
+  #define OPDI_END_MASTER /* empty */
+#endif
 
 // standalone macros
 

include/opdi/backend/ompt/masterCallbacks.hpp

@@ -25,6 +25,7 @@
 
 #pragma once
 
+#include "../../config.hpp"
 #include "../../helpers/exceptions.hpp"
 #include "../../helpers/macros.hpp"
 #include "../../logic/logicInterface.hpp"

include/opdi/backend/ompt/omptBackend.hpp

@@ -101,11 +101,15 @@ namespace opdi {
         // initialize callback structures
         ParallelCallbacks::init();
         ImplicitTaskCallbacks::init();
-        WorkCallbacks::init();
+        #if OPDI_BACKEND_GENERATE_WORK_EVENTS
+          WorkCallbacks::init();
+        #endif
         SyncRegionCallbacks::init();
         MutexCallbacks::init();
         ReductionCallbacks::init();
-        MasterCallbacks::init();
+        #if OPDI_BACKEND_GENERATE_MASTER_EVENTS
+          MasterCallbacks::init();
+        #endif
 
         return 1; // success
       }
@@ -115,11 +119,15 @@ namespace opdi {
         OPDI_UNUSED(toolData);
 
         // finalize callback structures
-        MasterCallbacks::finalize();
+        #if OPDI_BACKEND_GENERATE_MASTER_EVENTS
+          MasterCallbacks::finalize();
+        #endif
         ReductionCallbacks::finalize();
         MutexCallbacks::finalize();
         SyncRegionCallbacks::finalize();
-        WorkCallbacks::finalize();
+        #if OPDI_BACKEND_GENERATE_WORK_EVENTS
+          WorkCallbacks::finalize();
+        #endif
         ImplicitTaskCallbacks::finalize();
         ParallelCallbacks::finalize();
       }

include/opdi/config.hpp

@@ -46,6 +46,14 @@
 
 /* ----- backend configuration ----- */
 
+#ifndef OPDI_BACKEND_GENERATE_MASTER_EVENTS
+  #define OPDI_BACKEND_GENERATE_MASTER_EVENTS 0
+#endif
+
+#ifndef OPDI_BACKEND_GENERATE_WORK_EVENTS
+  #define OPDI_BACKEND_GENERATE_WORK_EVENTS 0
+#endif
+
 #ifndef OPDI_OMPT_BACKEND_IMPLICIT_TASK_END_SOURCE
   #define OPDI_OMPT_BACKEND_IMPLICIT_TASK_END_SOURCE OPDI_OMPT_IMPLICIT_TASK_END
 #endif