[interpreter] Add support for SYCL with adaptiveCpp

AdaptiveCpp requires NullDerefProtectionTransformer to be turned
off to function properly

Author: devajithvs

bindings/pyroot/pythonizations/test/import_load_libs.py

@@ -29,6 +29,9 @@ class ImportLoadLibs(unittest.TestCase):
         "librt",
         "libncurses.*",
         "libtinfo",  # by libncurses (on some older platforms)
+        # adaptivecpp and dependencies
+        "libacpp-rt",
+        "libgomp",
         # libTree and dependencies
         "libTree",
         "libThread",

cmake/modules/SearchInstalledSoftware.cmake

@@ -1649,6 +1649,9 @@ if(experimental_adaptivecpp)
     ROOT_CHECK_CONNECTION_AND_DISABLE_OPTION("experimental_adaptivecpp")
   endif()
   include(SetupAdaptiveCpp)
+
+  add_compile_definitions(CLING_WITH_ADAPTIVECPP)
+
   set(HIPSYCL_NO_FIBERS ON)
   set(WITH_OPENCL_BACKEND OFF)
   set(WITH_LEVEL_ZERO_BACKEND OFF)

core/metacling/src/CMakeLists.txt

@@ -114,7 +114,8 @@ if (clad)
   else()
     set(CLING_PLUGIN_LINK_LIBS -Wl,--whole-archive cladPlugin cladDifferentiator -Wl,--no-whole-archive)
   endif()
-  if(TARGET clang)
+  # This will cause a cyclic dependency in adaptiveCpp, as it requires clang to build
+  if(TARGET clang AND NOT experimental_adaptivecpp)
     # Link our clad libraries to clang. If users use the clang from ROOT they will
     # also be able to use clad out of the box.
     add_dependencies(clang clad)

core/metacling/src/TCling.cxx

@@ -1437,6 +1437,15 @@ TCling::TCling(const char *name, const char *title, const char* const argv[], vo
       clingArgsStorage.push_back("-mllvm");
       clingArgsStorage.push_back("-optimize-regalloc=0");
 #endif
+
+#ifdef CLING_WITH_ADAPTIVECPP
+      std::string acppInclude(TROOT::GetIncludeDir() + "/AdaptiveCpp");
+
+      clingArgsStorage.push_back("-isystem");
+      clingArgsStorage.push_back(acppInclude);
+      clingArgsStorage.push_back("-mllvm");
+      clingArgsStorage.push_back("-acpp-sscp");
+#endif
    }
 
    // Process externally passed arguments if present.

interpreter/CMakeLists.txt

@@ -53,7 +53,11 @@ set(LLVM_FORCE_USE_OLD_TOOLCHAIN ON CACHE BOOL "")
 # found before (because the user turned on cuda or tmva-gpu), this will not have
 # an effect, which is fine.
 # (Note that the option is very counter-intuitive: We turn *on* disabling it...)
-set(CMAKE_DISABLE_FIND_PACKAGE_CUDA ON)
+# Except when we want to build cling with adaptiveCpp, in which case adaptiveCpp
+# needs to find CUDA in order to build the backend.
+if(NOT experimental_adaptivecpp)
+  set(CMAKE_DISABLE_FIND_PACKAGE_CUDA ON)
+endif()
 
 # will be set again in case NOT builtin_llvm
 set(LLVM_DIR "${CMAKE_CURRENT_BINARY_DIR}/llvm-project/llvm")

interpreter/cling/lib/Interpreter/BackendPasses.cpp

@@ -36,6 +36,10 @@
 
 #include <optional>
 
+#ifdef CLING_WITH_ADAPTIVECPP
+llvm::PassPluginLibraryInfo getAdaptiveCppPluginInfo();
+#endif
+
 using namespace cling;
 using namespace clang;
 using namespace llvm;
@@ -511,6 +515,10 @@ void BackendPasses::CreatePasses(int OptLevel, llvm::ModulePassManager& MPM,
   std::optional<PGOOptions> PGOOpt;
   PassBuilder PB(&m_TM, PTO, PGOOpt, &PIC);
 
+#ifdef CLING_WITH_ADAPTIVECPP
+  getAdaptiveCppPluginInfo().RegisterPassBuilderCallbacks(PB);
+#endif
+
   // Attempt to load pass plugins and register their callbacks with PB.
   for (auto& PluginFN : m_CGOpts.PassPlugins) {
     auto PassPlugin = PassPlugin::Load(PluginFN);

interpreter/cling/lib/Interpreter/CIFactory.cpp

@@ -1391,6 +1391,11 @@ namespace {
       argvCompile.push_back("-fno-omit-frame-pointer");
     }
 
+#ifdef CLING_WITH_ADAPTIVECPP
+    argvCompile.push_back("-D__ACPP_ENABLE_LLVM_SSCP_TARGET__");
+    argvCompile.push_back("-Xclang");
+    argvCompile.push_back("-disable-O0-optnone");
+#endif
     // Add host specific includes, -resource-dir if necessary, and -isysroot
     std::string ClingBin = GetExecutablePath(argv[0]);
     AddHostArguments(ClingBin, argvCompile, LLVMDir, COpts);

interpreter/cling/lib/Interpreter/CMakeLists.txt

@@ -23,6 +23,18 @@ set(LIBS
   clangLex
 )
 
+if(experimental_adaptivecpp)
+  list(APPEND LIBS AdaptiveCpp acpp-rt)
+
+  set(ACPP_EXPORTS acpp-rt acpp-common)
+
+  foreach(target IN LISTS ACPP_EXPORTS)
+    install(TARGETS ${target} EXPORT ClingTargets)
+  endforeach()
+
+  set_property(GLOBAL APPEND PROPERTY CLING_EXPORTS ${ACPP_EXPORTS})
+endif()
+
 set(LLVM_LINK_COMPONENTS
   analysis
   core

interpreter/cling/lib/Interpreter/IncrementalParser.cpp

@@ -1033,9 +1033,11 @@ namespace cling {
       // Don't protect against crashes if we cannot run anything.
       // cling might also be in a PCH-generation mode; don't inject our Sema
       // pointer into the PCH.
+#ifndef CLING_WITH_ADAPTIVECPP
       if (!isCUDADevice && m_Interpreter->getOptions().PtrCheck)
         ASTTransformers.emplace_back(
             new NullDerefProtectionTransformer(m_Interpreter));
+#endif
       if (isCUDADevice)
         ASTTransformers.emplace_back(
             new DeviceKernelInliner(TheSema));

roottest/cling/exception/CMakeLists.txt

@@ -1,4 +1,4 @@
-if(NOT MSVC OR win_broken_tests)
+if((NOT MSVC OR win_broken_tests) AND NOT experimental_adaptivecpp)
   if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64.*|x86.*|amd64.*|AMD64.*|i686.*|i386.*")
     # All platforms except of ARM/AARCH64
     ROOTTEST_ADD_TEST(nullderef-macro
@@ -9,7 +9,7 @@ if(NOT MSVC OR win_broken_tests)
   endif()
 endif()
 
-if(NOT (APPLE AND CMAKE_SYSTEM_PROCESSOR MATCHES arm64) OR M1_BROKEN_TESTS)
+if((NOT (APPLE AND CMAKE_SYSTEM_PROCESSOR MATCHES arm64) OR M1_BROKEN_TESTS) AND NOT experimental_adaptivecpp)
   ROOTTEST_ADD_TEST(nullderef-e
                     COMMAND ${ROOT_root_CMD} -l -b -q --ptrcheck -e "int*p=nullptr" -e "*p"
                     PASSRC 1