[Immediate] Move SwiftMaterializationUnit to public library

Author: Zak Kent

include/swift/Immediate/SwiftMaterializationUnit.h

@@ -0,0 +1,129 @@
+//===--- SwiftMaterializationUnit.h - JIT Swift ASTs ------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+// Defines the `SwiftMaterializationUnit` class, which allows you to JIT
+// individual Swift AST declarations.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_IMMEDIATE_SWIFTMATERIALIZATIONUNIT_H
+#define SWIFT_IMMEDIATE_SWIFTMATERIALIZATIONUNIT_H
+
+#include <memory>
+
+#include "llvm/ADT/StringRef.h"
+#include "llvm/ExecutionEngine/JITLink/JITLink.h"
+#include "llvm/ExecutionEngine/Orc/Core.h"
+#include "llvm/ExecutionEngine/Orc/EPCIndirectionUtils.h"
+#include "llvm/ExecutionEngine/Orc/IndirectionUtils.h"
+#include "llvm/ExecutionEngine/Orc/LLJIT.h"
+#include "llvm/ExecutionEngine/Orc/LazyReexports.h"
+#include "llvm/ExecutionEngine/Orc/SymbolStringPool.h"
+
+#include "swift/AST/TBDGenRequests.h"
+
+namespace swift {
+
+class CompilerInstance;
+
+class SwiftJIT {
+public:
+  SwiftJIT(const SwiftJIT &) = delete;
+  SwiftJIT(SwiftJIT &&) = delete;
+  SwiftJIT &operator=(const SwiftJIT &) = delete;
+  SwiftJIT &operator=(SwiftJIT &&) = delete;
+
+  /// Attempt to create and initialize a new `SwiftJIT` with lazy compilation
+  /// enabled and an attached generator to search for symbols defined in the
+  /// current process.
+  static llvm::Expected<std::unique_ptr<SwiftJIT>> Create(CompilerInstance &CI);
+
+  ~SwiftJIT();
+  llvm::orc::LLJIT &getJIT();
+
+  llvm::orc::JITDylib &getMainJITDylib();
+
+  /// Register a the materialization unit `MU` with the `JITDylib``JD` and
+  /// create lazy reexports for all functions defined in the interface of `MU`
+  llvm::Error addSwift(llvm::orc::JITDylib &JD,
+                       std::unique_ptr<llvm::orc::MaterializationUnit> MU);
+
+  llvm::Error initialize(llvm::orc::JITDylib &JD);
+
+  llvm::Error deinitialize(llvm::orc::JITDylib &JD);
+
+  llvm::Expected<llvm::orc::ExecutorAddr> lookup(llvm::StringRef Name);
+
+  llvm::Expected<llvm::orc::ExecutorAddr>
+  lookupLinkerMangled(llvm::StringRef Name);
+
+  llvm::orc::SymbolStringPtr mangleAndIntern(llvm::StringRef Name);
+
+  llvm::orc::SymbolStringPtr intern(llvm::StringRef Name);
+
+  llvm::orc::IRCompileLayer &getIRCompileLayer();
+
+  llvm::orc::ObjectTransformLayer &getObjTransformLayer();
+
+private:
+  static llvm::Expected<std::unique_ptr<llvm::orc::LLJIT>>
+  CreateLLJIT(CompilerInstance &CI);
+
+  /// An ORC layer to rename the names of function bodies to support lazy
+  /// reexports
+  class Plugin : public llvm::orc::ObjectLinkingLayer::Plugin {
+    void
+    modifyPassConfig(llvm::orc::MaterializationResponsibility &MR,
+                     llvm::jitlink::LinkGraph &G,
+                     llvm::jitlink::PassConfiguration &PassConfig) override;
+
+    llvm::Error
+    notifyFailed(llvm::orc::MaterializationResponsibility &MR) override;
+
+    llvm::Error notifyRemovingResources(llvm::orc::ResourceKey K) override;
+
+    void notifyTransferringResources(llvm::orc::ResourceKey DstKey,
+                                     llvm::orc::ResourceKey SrcKey) override;
+  };
+
+  static void handleLazyCompilationFailure();
+
+  SwiftJIT(std::unique_ptr<llvm::orc::LLJIT> J,
+           std::unique_ptr<llvm::orc::EPCIndirectionUtils> EPCIU);
+
+  std::unique_ptr<llvm::orc::LLJIT> J;
+  std::unique_ptr<llvm::orc::EPCIndirectionUtils> EPCIU;
+  llvm::orc::LazyCallThroughManager &LCTM;
+  std::unique_ptr<llvm::orc::IndirectStubsManager> ISM;
+};
+
+class SwiftMaterializationUnit : public llvm::orc::MaterializationUnit {
+public:
+  static std::unique_ptr<SwiftMaterializationUnit> Create(SwiftJIT &JIT,
+                                                          CompilerInstance &CI);
+  llvm::StringRef getName() const override;
+
+private:
+  SwiftMaterializationUnit(SwiftJIT &JIT, CompilerInstance &CI,
+                           SymbolSourceMap Sources,
+                           llvm::orc::SymbolFlagsMap Symbols);
+  void materialize(
+      std::unique_ptr<llvm::orc::MaterializationResponsibility> MR) override;
+  void discard(const llvm::orc::JITDylib &JD,
+               const llvm::orc::SymbolStringPtr &Sym) override;
+  SymbolSourceMap Sources;
+  SwiftJIT &JIT;
+  CompilerInstance &CI;
+};
+} // namespace swift
+
+#endif // SWIFT_IMMEDIATE_SWIFTMATERIALIZATIONUNIT_H

lib/Immediate/CMakeLists.txt

@@ -1,4 +1,5 @@
 add_swift_host_library(swiftImmediate STATIC
+  SwiftMaterializationUnit.cpp
   Immediate.cpp
   LLVM_LINK_COMPONENTS
     executionengine