[OMPT] Fix use of 'DEBUG_PREFIX' in the OMPT headers

[jhuber6]

Summary

This is the only place that defines this prefix in a header file and
was thus overriding and redefining other users of it. If we must use it
in a header file, at least repsect its old values.

[tianshilei1992]

In addition to this, we also have definition of the macro in CMake files. I think we need to define them in a unified manner: either all in CMake file, or in header.

[jhuber6]

In D155316#4501661, @tianshilei1992 wrote:

In addition to this, we also have definition of the macro in CMake files. I think we need to define them in a unified manner: either all in CMake file, or in header.

I've wanted to do a complete overhaul of libomptarget diagnostics for awhile now. This is just the fast way to get something nominally functional. In the future we probably want routines that map into the LLVM libraries for formatting and printing.

[jhuber6]

Fix the .cpp file as well

[tianshilei1992]

LG. Let's make things better in the followup patch.

[tianshilei1992]

It seems like this patch introduced some new warnings:

In file included from /home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/plugins-nextgen/cuda/src/rtl.cpp:22:
/home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/include/OmptCallback.h:87:9: warning: pragma pop_macro could not pop 'DEBUG_PREFIX', no matching push_macro [-Wignored-pragmas]
   87 | #pragma pop_macro("DEBUG_PREFIX")
      |         ^
1 warning generated.
[46/54] Building CXX object libomptarget/plugins-nextgen/amdgpu/CMakeFiles/omptarget.rtl.amdgpu.dir/src/rtl.cpp.o
In file included from /home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/plugins-nextgen/amdgpu/src/rtl.cpp:26:
/home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/include/OmptCallback.h:87:9: warning: pragma pop_macro could not pop 'DEBUG_PREFIX', no matching push_macro [-Wignored-pragmas]
   87 | #pragma pop_macro("DEBUG_PREFIX")
      |         ^
1 warning generated.

[jhuber6]

In D155316#4504378, @tianshilei1992 wrote:

It seems like this patch introduced some new warnings:

In file included from /home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/plugins-nextgen/cuda/src/rtl.cpp:22:
/home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/include/OmptCallback.h:87:9: warning: pragma pop_macro could not pop 'DEBUG_PREFIX', no matching push_macro [-Wignored-pragmas]
   87 | #pragma pop_macro("DEBUG_PREFIX")
      |         ^
1 warning generated.
[46/54] Building CXX object libomptarget/plugins-nextgen/amdgpu/CMakeFiles/omptarget.rtl.amdgpu.dir/src/rtl.cpp.o
In file included from /home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/plugins-nextgen/amdgpu/src/rtl.cpp:26:
/home/ac.shilei.tian/Documents/vscode/llvm-project/openmp/libomptarget/include/OmptCallback.h:87:9: warning: pragma pop_macro could not pop 'DEBUG_PREFIX', no matching push_macro [-Wignored-pragmas]
   87 | #pragma pop_macro("DEBUG_PREFIX")
      |         ^
1 warning generated.

Duh, forgot there was a second header guard for OMPT_SUPPORT. Didn't get that locally since I guess it's on. Simply needs to be moved before the penultimate #endif.

openmp/libomptarget/include/OmptCallback.h

 
 #ifndef _OMPTCALLBACK_H
 #define _OMPTCALLBACK_H
 
 #ifdef OMPT_SUPPORT
 
 #include "omp-tools.h"
 
+#pragma push_macro("DEBUG_PREFIX")
+#undef DEBUG_PREFIX
 #define DEBUG_PREFIX "OMPT"
 
 #define FOREACH_OMPT_TARGET_CALLBACK(macro)                                    \
   FOREACH_OMPT_DEVICE_EVENT(macro)                                             \
   FOREACH_OMPT_NOEMI_EVENT(macro)                                              \
   FOREACH_OMPT_EMI_EVENT(macro)
 
 #define performOmptCallback(CallbackName, ...)                                 \

 
 } // namespace ompt
 } // namespace target
 } // namespace omp
 } // namespace llvm
 
 #endif // OMPT_SUPPORT
 
+#pragma pop_macro("DEBUG_PREFIX")
+
 #endif // _OMPTCALLBACK_H

openmp/libomptarget/include/OmptConnector.h

 #include <memory>
 #include <string>
 
 #include "omp-tools.h"
 
 #include "Debug.h"
 #include "omptarget.h"
 
+#pragma push_macro("DEBUG_PREFIX")
+#undef DEBUG_PREFIX
 #define DEBUG_PREFIX "OMPT"
-#define LIBOMPTARGET_STRINGIFY(s) #s
 
 /// Type for the function to be invoked for connecting two libraries.
 typedef void (*OmptConnectRtnTy)(ompt_start_tool_result_t *result);
 
 /// Establish connection between openmp runtime libraries
 ///
 /// This class is used to communicate between an OMPT implementation in
 /// libomptarget and libomp. It is also used to communicate between an
private:
   /// Handle of connect routine provided by source library
   OmptConnectRtnTy LibConnHandle;
   /// Name of connect routine provided by source library
   std::string LibIdent;
 };
 
 #endif // OMPT_SUPPORT
 
+#pragma pop_macro("DEBUG_PREFIX")
+
 #endif // _OMPTCONNECTOR_H

openmp/libomptarget/src/OmptCallback.cpp

 #include <cstdlib>
 #include <cstring>
 #include <memory>
 
 #include "Debug.h"
 #include "OmptCallback.h"
 #include "OmptConnector.h"
 
+#undef DEBUG_PREFIX
+#define DEBUG_PREFIX "OMPT"
+
 using namespace llvm::omp::target::ompt;
 
 // Define OMPT callback functions (bound to actual callbacks later on)
 #define defineOmptCallback(Name, Type, Code)                                   \
   Name##_t llvm::omp::target::ompt::Name##_fn = nullptr;
 FOREACH_OMPT_NOEMI_EVENT(defineOmptCallback)
 FOREACH_OMPT_EMI_EVENT(defineOmptCallback)
 #undef defineOmptCallback

 LibomptargetRtlFinalizer *LibraryFinalizer = nullptr;
 
 ompt_get_callback_t llvm::omp::target::ompt::lookupCallbackByCode = nullptr;
 ompt_function_lookup_t llvm::omp::target::ompt::lookupCallbackByName = nullptr;
 
 int llvm::omp::target::ompt::initializeLibrary(ompt_function_lookup_t lookup,
                                                int initial_device_num,
                                                ompt_data_t *tool_data) {
-  DP("OMPT: Executing initializeLibrary (libomp)\n");
+  DP("Executing initializeLibrary (libomp)\n");
 #define bindOmptFunctionName(OmptFunction, DestinationFunction)                \
   DestinationFunction = (OmptFunction##_t)lookup(#OmptFunction);               \
-  DP("OMPT: initializeLibrary (libomp) bound %s=%p\n", #DestinationFunction,   \
+  DP("initializeLibrary (libomp) bound %s=%p\n", #DestinationFunction,         \
      ((void *)(uint64_t)DestinationFunction));
 
   bindOmptFunctionName(ompt_get_callback, lookupCallbackByCode);
 #undef bindOmptFunctionName
 
   // Store pointer of 'ompt_libomp_target_fn_lookup' for use by libomptarget
   lookupCallbackByName = lookup;
 
   assert(lookupCallbackByCode && "lookupCallbackByCode should be non-null");
   assert(lookupCallbackByName && "lookupCallbackByName should be non-null");
   assert(LibraryFinalizer == nullptr &&
          "LibraryFinalizer should not be initialized yet");
 
   LibraryFinalizer = new LibomptargetRtlFinalizer();
 
   return 0;
 }
 
 void llvm::omp::target::ompt::finalizeLibrary(ompt_data_t *data) {
-  DP("OMPT: Executing finalizeLibrary (libomp)\n");
+  DP("Executing finalizeLibrary (libomp)\n");
   // Before disabling OMPT, call the (plugin) finalizations that were registered
   // with this library
   LibraryFinalizer->finalize();
   delete LibraryFinalizer;
 }
 
 void llvm::omp::target::ompt::connectLibrary() {
-  DP("OMPT: Entering connectLibrary (libomp)\n");
+  DP("Entering connectLibrary (libomp)\n");
   // Connect with libomp
   static OmptLibraryConnectorTy LibompConnector("libomp");
   static ompt_start_tool_result_t OmptResult;
 
   // Initialize OmptResult with the init and fini functions that will be
   // called by the connector
   OmptResult.initialize = ompt::initializeLibrary;
   OmptResult.finalize = ompt::finalizeLibrary;
   OmptResult.tool_data.value = 0;
 
   // Now call connect that causes the above init/fini functions to be called
   LibompConnector.connect(&OmptResult);
 
 #define bindOmptCallback(Name, Type, Code)                                     \
   if (lookupCallbackByCode)                                                    \
     lookupCallbackByCode(                                                      \
         (ompt_callbacks_t)(Code),                                              \
         (ompt_callback_t *)&(llvm::omp::target::ompt::Name##_fn));
   FOREACH_OMPT_NOEMI_EVENT(bindOmptCallback)
   FOREACH_OMPT_EMI_EVENT(bindOmptCallback)
 #undef bindOmptCallback
 
-  DP("OMPT: Exiting connectLibrary (libomp)\n");
+  DP("Exiting connectLibrary (libomp)\n");
 }
 
 extern "C" {
 /// Used for connecting libomptarget with a plugin
 void ompt_libomptarget_connect(ompt_start_tool_result_t *result) {
-  DP("OMPT: Enter ompt_libomptarget_connect\n");
+  DP("Enter ompt_libomptarget_connect\n");
   if (result && LibraryFinalizer) {
     // Cache each fini function, so that they can be invoked on exit
     LibraryFinalizer->registerRtl(result->finalize);
     // Invoke the provided init function with the lookup function maintained
     // in this library so that callbacks maintained by this library are
     // retrieved.
     result->initialize(lookupCallbackByName,
                        /* initial_device_num */ 0, /* tool_data */ nullptr);
   }
-  DP("OMPT: Leave ompt_libomptarget_connect\n");
+  DP("Leave ompt_libomptarget_connect\n");
 }
 }
 #else
 extern "C" {
 /// Dummy definition when OMPT is disabled
 void ompt_libomptarget_connect() {}
 }
 #endif // OMPT_SUPPORT