1//===--- OrcIncrementalExecutor.cpp - Orc Incremental Execution -*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements an Orc-based incremental code execution.
10//
11//===----------------------------------------------------------------------===//
12
13#include "OrcIncrementalExecutor.h"
14#include "clang/Interpreter/PartialTranslationUnit.h"
15
16#include "llvm/ExecutionEngine/Orc/EPCDynamicLibrarySearchGenerator.h"
17#include "llvm/ExecutionEngine/Orc/ExecutionUtils.h"
18#include "llvm/ExecutionEngine/Orc/JITTargetMachineBuilder.h"
19#include "llvm/ExecutionEngine/Orc/LLJIT.h"
20#include "llvm/ExecutionEngine/Orc/Shared/OrcRTBridge.h"
21#include "llvm/ExecutionEngine/Orc/Shared/SimpleRemoteEPCUtils.h"
22#include "llvm/ExecutionEngine/Orc/TargetProcess/JITLoaderGDB.h"
23#include "llvm/Support/Error.h"
24#include "llvm/Support/raw_ostream.h"
25
26#ifdef LLVM_ON_UNIX
27#include <netdb.h>
28#include <netinet/in.h>
29#include <sys/socket.h>
30#include <unistd.h>
31#endif // LLVM_ON_UNIX
32
33// Force linking some of the runtimes that helps attaching to a debugger.
34LLVM_ATTRIBUTE_USED void linkComponents() {
35 llvm::errs() << (void *)&llvm_orc_registerJITLoaderGDBAllocAction;
36}
37
38namespace clang {
39OrcIncrementalExecutor::OrcIncrementalExecutor(
40 llvm::orc::ThreadSafeContext &TSC)
41 : TSCtx(TSC) {}
42
43OrcIncrementalExecutor::OrcIncrementalExecutor(
44 llvm::orc::ThreadSafeContext &TSC, llvm::orc::LLJITBuilder &JITBuilder,
45 llvm::Error &Err)
46 : TSCtx(TSC) {
47 using namespace llvm::orc;
48 llvm::ErrorAsOutParameter EAO(&Err);
49
50 if (auto JitOrErr = JITBuilder.create())
51 Jit = std::move(*JitOrErr);
52 else {
53 Err = JitOrErr.takeError();
54 return;
55 }
56}
57
58OrcIncrementalExecutor::~OrcIncrementalExecutor() {}
59
60llvm::Error OrcIncrementalExecutor::addModule(PartialTranslationUnit &PTU) {
61 llvm::orc::ResourceTrackerSP RT =
62 Jit->getMainJITDylib().createResourceTracker();
63 ResourceTrackers[&PTU] = RT;
64
65 return Jit->addIRModule(RT, TSM: {std::move(PTU.TheModule), TSCtx});
66}
67
68llvm::Error OrcIncrementalExecutor::removeModule(PartialTranslationUnit &PTU) {
69
70 llvm::orc::ResourceTrackerSP RT = std::move(ResourceTrackers[&PTU]);
71 if (!RT)
72 return llvm::Error::success();
73
74 ResourceTrackers.erase(Val: &PTU);
75 if (llvm::Error Err = RT->remove())
76 return Err;
77 return llvm::Error::success();
78}
79
80// Clean up the JIT instance.
81llvm::Error OrcIncrementalExecutor::cleanUp() {
82 // This calls the global dtors of registered modules.
83 return Jit->deinitialize(JD&: Jit->getMainJITDylib());
84}
85
86llvm::Error OrcIncrementalExecutor::runCtors() const {
87 return Jit->initialize(JD&: Jit->getMainJITDylib());
88}
89
90llvm::Expected<llvm::orc::ExecutorAddr>
91OrcIncrementalExecutor::getSymbolAddress(llvm::StringRef Name,
92 SymbolNameKind NameKind) const {
93 using namespace llvm::orc;
94 auto SO = makeJITDylibSearchOrder(JDs: {&Jit->getMainJITDylib(),
95 Jit->getPlatformJITDylib().get(),
96 Jit->getProcessSymbolsJITDylib().get()});
97
98 ExecutionSession &ES = Jit->getExecutionSession();
99
100 auto SymOrErr = ES.lookup(SearchOrder: SO, Symbol: (NameKind == SymbolNameKind::LinkerName)
101 ? ES.intern(SymName: Name)
102 : Jit->mangleAndIntern(UnmangledName: Name));
103 if (auto Err = SymOrErr.takeError())
104 return std::move(Err);
105 return SymOrErr->getAddress();
106}
107
108llvm::Error OrcIncrementalExecutor::LoadDynamicLibrary(const char *name) {
109 // FIXME: Eventually we should put each library in its own JITDylib and
110 // turn off process symbols by default.
111 llvm::orc::ExecutionSession &ES = Jit->getExecutionSession();
112 auto DLSGOrErr = llvm::orc::EPCDynamicLibrarySearchGenerator::Load(ES, LibraryPath: name);
113 if (!DLSGOrErr)
114 return DLSGOrErr.takeError();
115
116 Jit->getProcessSymbolsJITDylib()->addGenerator(DefGenerator: std::move(*DLSGOrErr));
117
118 return llvm::Error::success();
119}
120
121} // namespace clang
122