addition of oop jit execution

Author: kr-2003

.github/actions/Build_LLVM/action.yml

@@ -49,6 +49,10 @@ runs:
             git apply -v ../patches/llvm/clang${{ matrix.clang-runtime }}-*.patch
             echo "Apply clang${{ matrix.clang-runtime }}-*.patch patches:"
           fi
+          if [[ "${{ matrix.llvm_enable_runtimes }}" == "clang;compile-rt" ]]; then
+            git apply -v ../patches/llvm/out-of-process-jit-execution.patch
+            echo "Apply out-of-process-jit-execution.patch:"
+          fi
           cd build
           cmake -DLLVM_ENABLE_PROJECTS="${{ matrix.llvm_enable_projects}}" \
                 -DLLVM_TARGETS_TO_BUILD="${{ matrix.llvm_targets_to_build }}"  \
@@ -64,6 +68,13 @@ runs:
                 -DLLVM_INCLUDE_TESTS=OFF                        \
                 ../llvm
           ninja clang clangInterpreter clangStaticAnalyzerCore -j ${{ env.ncpus }}
+          if [[ "${{ matrix.llvm_enable_runtimes }}" == "clang;compile-rt" ]]; then
+            if [[ "${{ runner.os }}" == "Linux" ]]; then
+              ninja clang clang-repl llvm-jitlink-executor orc_rt -j $(nproc --all)
+            elif [[ "${{ runner.os }}" == "macOS" ]]; then
+              ninja clang clang-repl llvm-jitlink-executor orc_rt -j $(nproc --all)
+            fi
+          fi
           cd ./tools/
           rm -rf $(find . -maxdepth 1 ! -name "clang" ! -name ".")
           cd ..

.github/workflows/MacOS-arm.yml

@@ -28,7 +28,7 @@ jobs:
             clang-runtime: '20'
             cling: Off
             cppyy: Off
-            llvm_enable_projects: "clang"
+            llvm_enable_projects: "clang;compiler-rt"
             llvm_targets_to_build: "host"
           - name: osx15-arm-clang-clang-repl-19-cppyy
             os: macos-15

.github/workflows/MacOS.yml

@@ -28,7 +28,7 @@ jobs:
             clang-runtime: '20'
             cling: Off
             cppyy: Off
-            llvm_enable_projects: "clang"
+            llvm_enable_projects: "clang;compiler-rt"
             llvm_targets_to_build: "host"
           - name: osx13-x86-clang-clang-repl-19-cppyy
             os: macos-13

.github/workflows/Ubuntu-arm.yml

@@ -28,7 +28,7 @@ jobs:
             clang-runtime: '20'
             cling: Off
             cppyy: Off
-            llvm_enable_projects: "clang"
+            llvm_enable_projects: "clang;compiler-rt"
             llvm_targets_to_build: "host;NVPTX"
             coverage: true
           - name: ubu24-arm-gcc12-clang-repl-20

.github/workflows/Ubuntu.yml

@@ -28,7 +28,7 @@ jobs:
             clang-runtime: '20'
             cling: Off
             cppyy: Off
-            llvm_enable_projects: "clang"
+            llvm_enable_projects: "clang;compiler-rt"
             llvm_targets_to_build: "host;NVPTX"
           - name: ubu24-x86-gcc12-clang-repl-19-cppyy
             os: ubuntu-24.04

CMakeLists.txt

@@ -305,6 +305,9 @@ else()
   message(FATAL_ERROR "We need either CPPINTEROP_USE_CLING or CPPINTEROP_USE_REPL")
 endif()
 
+string(REGEX REPLACE "/build/lib/cmake/llvm$" "" LLVM_SOURCE_DIR "${LLVM_DIR}")
+add_definitions(-DLLVM_SOURCE_DIR="${LLVM_SOURCE_DIR}")
+
 include_directories(SYSTEM ${CLANG_INCLUDE_DIRS})
 include_directories(SYSTEM ${LLVM_INCLUDE_DIRS})
 separate_arguments(LLVM_DEFINITIONS_LIST NATIVE_COMMAND ${LLVM_DEFINITIONS})

README.md

@@ -125,6 +125,13 @@ git apply -v clang{version}-*.patch
 
 on Windows.
 
+If you want to have out-of-process JIT execution enabled in CppInterOp, then apply this patch on Linux and MacOS environment. 
+> Note that this patch will not work for Windows because out-of-process JIT execution is currently implemented for Linux and MacOS only.
+
+```bash
+git apply -v ../CppInterOp/patches/llvm/out-of-process-jit-execution.patch
+```
+
 ##### Build Clang-REPL
 
 Clang-REPL is an interpreter that CppInterOp works alongside. Build Clang (and
@@ -180,6 +187,30 @@ $env:LLVM_DIR= $PWD.Path
 cd ..\
 ```
 
+##### Build Clang-REPL with Out-of-Process JIT Execution
+
+To have ``Out-of-Process JIT Execution`` enabled, run following commands to build clang and clang-repl to support this feature:
+> Only for Linux and Macos
+```bash
+mkdir build 
+cd build 
+cmake -DLLVM_ENABLE_PROJECTS="clang;compiler-rt                     \
+                -DLLVM_TARGETS_TO_BUILD="host;NVPTX"                \
+                -DCMAKE_BUILD_TYPE=Release                          \
+                -DLLVM_ENABLE_ASSERTIONS=ON                         \
+                -DCLANG_ENABLE_STATIC_ANALYZER=OFF                  \
+                -DCLANG_ENABLE_ARCMT=OFF                            \
+                -DCLANG_ENABLE_FORMAT=OFF                           \
+                -DCLANG_ENABLE_BOOTSTRAP=OFF                        \
+                ../llvm
+
+## For Linux
+cmake --build . --target clang clang-repl llvm-jitlink-executor orc_rt --parallel $(nproc --all)
+
+## For MacOS
+cmake --build . --target clang clang-repl llvm-jitlink-executor orc_rt_osx --parallel $(nproc --all)
+```
+
 #### Build Cling and related dependencies
 
 Besides the Clang-REPL interpreter, CppInterOp also works alongside the Cling

include/CppInterOp/CppInterOp.h

@@ -609,7 +609,7 @@ CPPINTEROP_API void GetOperator(TCppScope_t scope, Operator op,
 ///\returns nullptr on failure.
 CPPINTEROP_API TInterp_t
 CreateInterpreter(const std::vector<const char*>& Args = {},
-                  const std::vector<const char*>& GpuArgs = {}, bool is_out_of_process = false);
+                  const std::vector<const char*>& GpuArgs = {}, bool outOfProcess = false);
 
 /// Deletes an instance of an interpreter.
 ///\param[in] I - the interpreter to be deleted, if nullptr, deletes the last.

lib/CppInterOp/Compatibility.h

@@ -214,7 +214,7 @@ static llvm::ExitOnError ExitOnError;
 namespace compat {
 
 inline std::unique_ptr<clang::Interpreter>
-createClangInterpreter(std::vector<const char*>& args, bool is_out_of_process) {
+createClangInterpreter(std::vector<const char*>& args, bool outOfProcess) {
   auto has_arg = [](const char* x, llvm::StringRef match = "cuda") {
     llvm::StringRef Arg = x;
     Arg = Arg.trim().ltrim('-');
@@ -255,7 +255,7 @@ createClangInterpreter(std::vector<const char*>& args, bool is_out_of_process) {
 
   std::unique_ptr<llvm::orc::LLJITBuilder> JB;
 
-  if(is_out_of_process) {
+  if(outOfProcess) {
       std::string OOPExecutor = "/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/llvm-project-test/build/bin/llvm-jitlink-executor";
       bool UseSharedMemory = false;
       std::string SlabAllocateSizeString = "";
@@ -283,24 +283,7 @@ createClangInterpreter(std::vector<const char*>& args, bool is_out_of_process) {
                                 "Failed to build Interpreter:");
     return nullptr;
   }
-  // auto interpreter = std::move(*innerOrErr);
-
-  // // Add your hardcoded static library
-  // auto JOrErr = interpreter->getExecutionEngine();
-  // if (!JOrErr) {
-  //   llvm::logAllUnhandledErrors(JOrErr.takeError(), llvm::errs(),
-  //                              "Failed to get execution engine:");
-  //   return nullptr;
-  // }
-  // auto& J = *JOrErr;
-  // std::string libpath = "/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/llvm-project-test/build/lib/libclangInterpreter.a";
-  // auto generator = ExitOnError(
-  //     llvm::orc::StaticLibraryDefinitionGenerator::Load(
-  //         J.getObjLinkingLayer(), 
-  //         libpath.c_str()
-  //     )
-  // );
-  // J.getMainJITDylib().addGenerator(std::move(generator));
+
   if (CudaEnabled) {
     if (auto Err = (*innerOrErr)->LoadDynamicLibrary("libcudart.so")) {
       llvm::logAllUnhandledErrors(std::move(Err), llvm::errs(),
@@ -310,7 +293,6 @@ createClangInterpreter(std::vector<const char*>& args, bool is_out_of_process) {
   }
 
   return std::move(*innerOrErr);
-  // return interpreter;
 }
 
 inline void maybeMangleDeclName(const clang::GlobalDecl& GD,

lib/CppInterOp/CppInterOpInterpreter.h

@@ -150,15 +150,15 @@ class Interpreter {
   create(int argc, const char* const* argv, const char* llvmdir = nullptr,
          const std::vector<std::shared_ptr<clang::ModuleFileExtension>>&
              moduleExtensions = {},
-         void* extraLibHandle = nullptr, bool noRuntime = true, bool is_out_of_process = false) {
+         void* extraLibHandle = nullptr, bool noRuntime = true, bool outOfProcess = false) {
     // Initialize all targets (required for device offloading)
     llvm::InitializeAllTargetInfos();
     llvm::InitializeAllTargets();
     llvm::InitializeAllTargetMCs();
     llvm::InitializeAllAsmPrinters();
 
     std::vector<const char*> vargs(argv + 1, argv + argc);
-    auto CI = compat::createClangInterpreter(vargs, is_out_of_process);
+    auto CI = compat::createClangInterpreter(vargs, outOfProcess);
     if (!CI) {
       llvm::errs() << "Interpreter creation failed\n";
       return nullptr;