[SYCL][Fusion][NoSTL] Hide JITContext behind interface (intel#12189)

Do not allocate the `JITContext` in the `jit_compiler` class; instead
make it an independent singleton inside the kernel fusion library.

*This PR is the start of a series of changes to remove uses of STL
classes in the kernel fusion interface to prevent ABI issues in the
future.*

Signed-off-by: Julian Oppermann <julian.oppermann@codeplay.com>

Author: jopperm

sycl-fusion/jit-compiler/CMakeLists.txt

@@ -1,11 +1,11 @@
 
 add_llvm_library(sycl-fusion
    lib/KernelFusion.cpp
-   lib/JITContext.cpp
    lib/translation/KernelTranslation.cpp
    lib/translation/SPIRVLLVMTranslation.cpp
    lib/fusion/FusionPipeline.cpp
    lib/fusion/FusionHelper.cpp
+   lib/fusion/JITContext.cpp
    lib/fusion/ModuleHelper.cpp
    lib/helper/ConfigHelper.cpp
 

sycl-fusion/jit-compiler/include/KernelFusion.h

@@ -9,7 +9,6 @@
 #ifndef SYCL_FUSION_JIT_COMPILER_KERNELFUSION_H
 #define SYCL_FUSION_JIT_COMPILER_KERNELFUSION_H
 
-#include "JITContext.h"
 #include "Kernel.h"
 #include "Options.h"
 #include "Parameter.h"
@@ -55,16 +54,14 @@ class FusionResult {
 class KernelFusion {
 
 public:
-  static FusionResult
-  fuseKernels(JITContext &JITCtx, Config &&JITConfig,
-              const std::vector<SYCLKernelInfo> &KernelInformation,
-              const std::vector<std::string> &KernelsToFuse,
-              const std::string &FusedKernelName,
-              jit_compiler::ParamIdentList &Identities,
-              BarrierFlags BarriersFlags,
-              const std::vector<jit_compiler::ParameterInternalization>
-                  &Internalization,
-              const std::vector<jit_compiler::JITConstant> &JITConstants);
+  static FusionResult fuseKernels(
+      Config &&JITConfig, const std::vector<SYCLKernelInfo> &KernelInformation,
+      const std::vector<std::string> &KernelsToFuse,
+      const std::string &FusedKernelName,
+      jit_compiler::ParamIdentList &Identities, BarrierFlags BarriersFlags,
+      const std::vector<jit_compiler::ParameterInternalization>
+          &Internalization,
+      const std::vector<jit_compiler::JITConstant> &JITConstants);
 };
 
 } // namespace jit_compiler

sycl-fusion/jit-compiler/lib/KernelFusion.cpp

@@ -72,8 +72,7 @@ static bool isTargetFormatSupported(BinaryFormat TargetFormat) {
 }
 
 FusionResult KernelFusion::fuseKernels(
-    JITContext &JITCtx, Config &&JITConfig,
-    const std::vector<SYCLKernelInfo> &KernelInformation,
+    Config &&JITConfig, const std::vector<SYCLKernelInfo> &KernelInformation,
     const std::vector<std::string> &KernelsToFuse,
     const std::string &FusedKernelName, ParamIdentList &Identities,
     BarrierFlags BarriersFlags,
@@ -103,6 +102,7 @@ FusionResult KernelFusion::fuseKernels(
         "Fusion output target format not supported by this build");
   }
 
+  auto &JITCtx = JITContext::getInstance();
   bool CachingEnabled = ConfigHelper::get<option::JITEnableCaching>();
   CacheKeyT CacheKey{TargetArch,
                      KernelsToFuse,

sycl-fusion/jit-compiler/include/Hashing.h renamed to sycl-fusion/jit-compiler/lib/fusion/Hashing.h

@@ -6,8 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SYCL_FUSION_JIT_COMPILER_HASHING_H
-#define SYCL_FUSION_JIT_COMPILER_HASHING_H
+#ifndef SYCL_FUSION_JIT_COMPILER_FUSION_HASHING_H
+#define SYCL_FUSION_JIT_COMPILER_FUSION_HASHING_H
 
 #include "Kernel.h"
 #include "Parameter.h"
@@ -57,4 +57,4 @@ template <typename... T> struct hash<tuple<T...>> {
 };
 } // namespace std
 
-#endif // SYCL_FUSION_JIT_COMPILER_HASHING_H
+#endif // SYCL_FUSION_JIT_COMPILER_FUSION_HASHING_H

sycl-fusion/jit-compiler/lib/JITContext.cpp renamed to sycl-fusion/jit-compiler/lib/fusion/JITContext.cpp

@@ -25,8 +25,6 @@ BinaryFormat KernelBinary::format() const { return Format; }
 
 JITContext::JITContext() : LLVMCtx{new llvm::LLVMContext}, Binaries{} {}
 
-JITContext::~JITContext() = default;
-
 llvm::LLVMContext *JITContext::getLLVMContext() { return LLVMCtx.get(); }
 
 std::optional<SYCLKernelInfo>

sycl-fusion/jit-compiler/include/JITContext.h renamed to sycl-fusion/jit-compiler/lib/fusion/JITContext.h

@@ -6,8 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SYCL_FUSION_JIT_COMPILER_JITCONTEXT_H
-#define SYCL_FUSION_JIT_COMPILER_JITCONTEXT_H
+#ifndef SYCL_FUSION_JIT_COMPILER_FUSION_JITCONTEXT_H
+#define SYCL_FUSION_JIT_COMPILER_FUSION_JITCONTEXT_H
 
 #include <memory>
 #include <mutex>
@@ -61,9 +61,10 @@ class KernelBinary {
 class JITContext {
 
 public:
-  JITContext();
-
-  ~JITContext();
+  static JITContext &getInstance() {
+    static JITContext Instance{};
+    return Instance;
+  }
 
   llvm::LLVMContext *getLLVMContext();
 
@@ -77,6 +78,13 @@ class JITContext {
   void addCacheEntry(CacheKeyT &Identifier, SYCLKernelInfo &Kernel);
 
 private:
+  JITContext();
+  ~JITContext() = default;
+  JITContext(const JITContext &) = delete;
+  JITContext(JITContext &&) = delete;
+  JITContext &operator=(const JITContext &) = delete;
+  JITContext &operator=(const JITContext &&) = delete;
+
   // FIXME: Change this to std::shared_mutex after switching to C++17.
   using MutexT = std::shared_timed_mutex;
 
@@ -96,4 +104,4 @@ class JITContext {
 };
 } // namespace jit_compiler
 
-#endif // SYCL_FUSION_JIT_COMPILER_JITCONTEXT_H
+#endif // SYCL_FUSION_JIT_COMPILER_FUSION_JITCONTEXT_H

sycl-fusion/jit-compiler/lib/translation/KernelTranslation.h

@@ -8,8 +8,8 @@
 #ifndef SYCL_FUSION_JIT_COMPILER_TRANSLATION_KERNELTRANSLATION_H
 #define SYCL_FUSION_JIT_COMPILER_TRANSLATION_KERNELTRANSLATION_H
 
-#include "JITContext.h"
 #include "Kernel.h"
+#include "fusion/JITContext.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/IR/Module.h"
 #include "llvm/Support/Error.h"

sycl-fusion/jit-compiler/lib/translation/SPIRVLLVMTranslation.h

@@ -9,9 +9,9 @@
 #ifndef SYCL_FUSION_JIT_COMPILER_TRANSLATION_SPIRVLLVMTRANSLATION_H
 #define SYCL_FUSION_JIT_COMPILER_TRANSLATION_SPIRVLLVMTRANSLATION_H
 
-#include "JITContext.h"
 #include "Kernel.h"
 #include "LLVMSPIRVOpts.h"
+#include "fusion/JITContext.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/IR/Module.h"
 #include <llvm/Support/Error.h>

sycl/source/detail/jit_compiler.cpp

@@ -22,10 +22,6 @@ namespace sycl {
 inline namespace _V1 {
 namespace detail {
 
-jit_compiler::jit_compiler() : MJITContext{new ::jit_compiler::JITContext{}} {}
-
-jit_compiler::~jit_compiler() = default;
-
 static ::jit_compiler::BinaryFormat
 translateBinaryImageFormat(pi::PiDeviceBinaryType Type) {
   switch (Type) {
@@ -836,7 +832,7 @@ jit_compiler::fuseKernels(QueueImplPtr Queue,
   JITConfig.set<::jit_compiler::option::JITTargetInfo>(TargetInfo);
 
   auto FusionResult = ::jit_compiler::KernelFusion::fuseKernels(
-      *MJITContext, std::move(JITConfig), InputKernelInfo, InputKernelNames,
+      std::move(JITConfig), InputKernelInfo, InputKernelNames,
       FusedKernelName.str(), ParamIdentities, BarrierFlags, InternalizeParams,
       JITConstants);
 

sycl/source/detail/jit_compiler.hpp

@@ -42,8 +42,8 @@ class jit_compiler {
   }
 
 private:
-  jit_compiler();
-  ~jit_compiler();
+  jit_compiler() = default;
+  ~jit_compiler() = default;
   jit_compiler(const jit_compiler &) = delete;
   jit_compiler(jit_compiler &&) = delete;
   jit_compiler &operator=(const jit_compiler &) = delete;
@@ -61,8 +61,6 @@ class jit_compiler {
 
   // Manages the lifetime of the PI structs for device binaries.
   std::vector<DeviceBinariesCollection> JITDeviceBinaries;
-
-  std::unique_ptr<::jit_compiler::JITContext> MJITContext;
 };
 
 } // namespace detail