[OpenMP][OMPT] Add OMPT support for `generic-elf-64bit` plugin

[mhalk]

Summary

Fixes: https://github.com/llvm/llvm-project/issues/64487
Connect OMPT during plugin initialization and enable corresponding tests.
Avoid linking OMPT when corresponding support is disabled.

Depends on D158542

[mhalk]

Added dependency to commit message.

[mhalk]

Rebased + added condition for linking OMPT library

[mhalk]

openmp/libomptarget/plugins-nextgen/CMakeLists.txt

59–61

Mimicked the behavior we already use for other plugins.
Now we do not link OMPT anymore, when its support was actually disabled.
(using -DLIBOMP_OMPT_SUPPORT -OR- -DLIBOMPTARGET_OMPT_SUPPORT set to OFF)

Could someone confirm please, that this is sane?

[dhruvachak]

openmp/libomptarget/plugins-nextgen/CMakeLists.txt

59–61

Mimicked the behavior we already use for other plugins.
Now we do not link OMPT anymore, when its support was actually disabled.
(using -DLIBOMP_OMPT_SUPPORT -OR- -DLIBOMPTARGET_OMPT_SUPPORT set to OFF)

Could someone confirm please, that this is sane?

Seems ok to me.

[mhalk]

openmp/libomptarget/plugins-nextgen/CMakeLists.txt

59–61

Thank you very much!

openmp/libomptarget/plugins-nextgen/CMakeLists.txt

add_llvm_library("omptarget.rtl.${tmachine_libname}"
       ADDITIONAL_HEADER_DIRS
       ${LIBOMPTARGET_INCLUDE_DIR}
       ${LIBOMPTARGET_DEP_LIBFFI_INCLUDE_DIR}
 
         LINK_LIBS
         PRIVATE
         elf_common
         MemoryManager
-        OMPT
         PluginInterface
         ${LIBOMPTARGET_DEP_LIBFFI_LIBRARIES}
         ${OPENMP_PTHREAD_LIB}
 
       NO_INSTALL_RPATH
     )
 
+    if ((OMPT_TARGET_DEFAULT) AND (LIBOMPTARGET_OMPT_SUPPORT))
+      target_link_libraries("omptarget.rtl.${tmachine_libname}" PRIVATE OMPT)
+    endif()
+
     if (LIBOMP_HAVE_VERSION_SCRIPT_FLAG)
       target_link_libraries("omptarget.rtl.${tmachine_libname}" PRIVATE
         "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/../exports")
     endif()
 
     # Install plugin under the lib destination folder.
     install(TARGETS "omptarget.rtl.${tmachine_libname}"
       LIBRARY DESTINATION "${OPENMP_INSTALL_LIBDIR}")

openmp/libomptarget/plugins-nextgen/generic-elf-64bit/src/rtl.cpp

 #include <cstddef>
 #include <ffi.h>
 #include <string>
 #include <unordered_map>
 
 #include "Debug.h"
 #include "Environment.h"
 #include "GlobalHandler.h"
+#include "OmptCallback.h"
 #include "PluginInterface.h"
 #include "omptarget.h"
 
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/Frontend/OpenMP/OMPConstants.h"
 #include "llvm/Frontend/OpenMP/OMPGridValues.h"
 #include "llvm/Support/DynamicLibrary.h"
 
struct GenELF64PluginTy final : public GenericPluginTy {
   /// Create the GenELF64 plugin.
   GenELF64PluginTy() : GenericPluginTy(getTripleArch()) {}
 
   /// This class should not be copied.
   GenELF64PluginTy(const GenELF64PluginTy &) = delete;
   GenELF64PluginTy(GenELF64PluginTy &&) = delete;
 
   /// Initialize the plugin and return the number of devices.
-  Expected<int32_t> initImpl() override { return NUM_DEVICES; }
+  Expected<int32_t> initImpl() override {
+#ifdef OMPT_SUPPORT
+    ompt::connectLibrary();
+#endif
+
+    return NUM_DEVICES;
+  }
 
   /// Deinitialize the plugin.
   Error deinitImpl() override { return Plugin::success(); }
 
   /// Get the ELF code to recognize the compatible binary images.
   uint16_t getMagicElfBits() const override { return TARGET_ELF_ID; }
 
   /// This plugin does not support exchanging data between two devices.

openmp/libomptarget/test/ompt/veccopy.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
 // UNSUPPORTED: aarch64-unknown-linux-gnu
 // UNSUPPORTED: aarch64-unknown-linux-gnu-LTO
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that registers non-EMI callbacks
  */
 
 #include <omp.h>
 #include <stdio.h>
 

openmp/libomptarget/test/ompt/veccopy_data.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
 // UNSUPPORTED: aarch64-unknown-linux-gnu
 // UNSUPPORTED: aarch64-unknown-linux-gnu-LTO
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that registers EMI callbacks.
  * Explicitly testing for an initialized device num and
  * #pragma omp target [data enter / data exit / update]
  * The latter with the addition of a nowait clause.
  */
 

openmp/libomptarget/test/ompt/veccopy_disallow_both.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
 // UNSUPPORTED: aarch64-unknown-linux-gnu
 // UNSUPPORTED: aarch64-unknown-linux-gnu-LTO
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that shows that both EMI and non-EMI
  * callbacks cannot be registered for the same type. In the
  * current implementation, the EMI callback overrides the non-EMI
  * callback.
  */
 

openmp/libomptarget/test/ompt/veccopy_emi.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
 // UNSUPPORTED: aarch64-unknown-linux-gnu
 // UNSUPPORTED: aarch64-unknown-linux-gnu-LTO
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that registers EMI callbacks
  */
 
 #include <assert.h>
 #include <omp.h>
 #include <stdio.h>

openmp/libomptarget/test/ompt/veccopy_emi_map.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
 // UNSUPPORTED: aarch64-unknown-linux-gnu
 // UNSUPPORTED: aarch64-unknown-linux-gnu-LTO
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that shows that map-EMI callbacks are not supported.
  */
 
 #include <assert.h>
 #include <omp.h>
 #include <stdio.h>

openmp/libomptarget/test/ompt/veccopy_map.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
 // UNSUPPORTED: aarch64-unknown-linux-gnu
 // UNSUPPORTED: aarch64-unknown-linux-gnu-LTO
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that shows that map callbacks are not supported.
  */
 
 #include <omp.h>
 #include <stdio.h>
 

openmp/libomptarget/test/ompt/veccopy_no_device_init.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that shows that if no device init callback
  * is registered, the other callbacks won't be activated.
  */
 
 #include <omp.h>
 #include <stdio.h>

openmp/libomptarget/test/ompt/veccopy_wrong_return.c

 // RUN: %libomptarget-compile-run-and-check-generic
 // REQUIRES: ompt
-// UNSUPPORTED: x86_64-pc-linux-gnu
-// UNSUPPORTED: x86_64-pc-linux-gnu-oldDriver
-// UNSUPPORTED: x86_64-pc-linux-gnu-LTO
 
 /*
  * Example OpenMP program that shows that if the initialize function
  * returns the wrong status code, the callbacks won't be activated.
  */
 
 #include <omp.h>
 #include <stdio.h>