xref: /freebsd/contrib/llvm-project/llvm/tools/lli/lli.cpp (revision 1db9f3b21e39176dd5b67cf8ac378633b172463e)
10b57cec5SDimitry Andric //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This utility provides a simple wrapper around the LLVM Execution Engines,
100b57cec5SDimitry Andric // which allow the direct execution of LLVM programs through a Just-In-Time
110b57cec5SDimitry Andric // compiler, or through an interpreter if no JIT is available for this platform.
120b57cec5SDimitry Andric //
130b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
140b57cec5SDimitry Andric 
15fe6060f1SDimitry Andric #include "ExecutionUtils.h"
16349cc55cSDimitry Andric #include "ForwardingMemoryManager.h"
170b57cec5SDimitry Andric #include "llvm/ADT/StringExtras.h"
180b57cec5SDimitry Andric #include "llvm/Bitcode/BitcodeReader.h"
195ffd83dbSDimitry Andric #include "llvm/CodeGen/CommandFlags.h"
200b57cec5SDimitry Andric #include "llvm/CodeGen/LinkAllCodegenComponents.h"
210b57cec5SDimitry Andric #include "llvm/Config/llvm-config.h"
220b57cec5SDimitry Andric #include "llvm/ExecutionEngine/GenericValue.h"
230b57cec5SDimitry Andric #include "llvm/ExecutionEngine/Interpreter.h"
240b57cec5SDimitry Andric #include "llvm/ExecutionEngine/JITEventListener.h"
25fe6060f1SDimitry Andric #include "llvm/ExecutionEngine/JITSymbol.h"
260b57cec5SDimitry Andric #include "llvm/ExecutionEngine/MCJIT.h"
270b57cec5SDimitry Andric #include "llvm/ExecutionEngine/ObjectCache.h"
285ffd83dbSDimitry Andric #include "llvm/ExecutionEngine/Orc/DebugUtils.h"
295f757f3fSDimitry Andric #include "llvm/ExecutionEngine/Orc/Debugging/DebuggerSupport.h"
3081ad6265SDimitry Andric #include "llvm/ExecutionEngine/Orc/EPCDynamicLibrarySearchGenerator.h"
31fe6060f1SDimitry Andric #include "llvm/ExecutionEngine/Orc/EPCEHFrameRegistrar.h"
32349cc55cSDimitry Andric #include "llvm/ExecutionEngine/Orc/EPCGenericRTDyldMemoryManager.h"
330b57cec5SDimitry Andric #include "llvm/ExecutionEngine/Orc/ExecutionUtils.h"
340b57cec5SDimitry Andric #include "llvm/ExecutionEngine/Orc/JITTargetMachineBuilder.h"
350b57cec5SDimitry Andric #include "llvm/ExecutionEngine/Orc/LLJIT.h"
365ffd83dbSDimitry Andric #include "llvm/ExecutionEngine/Orc/RTDyldObjectLinkingLayer.h"
37349cc55cSDimitry Andric #include "llvm/ExecutionEngine/Orc/SimpleRemoteEPC.h"
38fe6060f1SDimitry Andric #include "llvm/ExecutionEngine/Orc/SymbolStringPool.h"
39fe6060f1SDimitry Andric #include "llvm/ExecutionEngine/Orc/TargetProcess/JITLoaderGDB.h"
40fe6060f1SDimitry Andric #include "llvm/ExecutionEngine/Orc/TargetProcess/RegisterEHFrames.h"
41e8d8bef9SDimitry Andric #include "llvm/ExecutionEngine/Orc/TargetProcess/TargetExecutionUtils.h"
420b57cec5SDimitry Andric #include "llvm/ExecutionEngine/SectionMemoryManager.h"
430b57cec5SDimitry Andric #include "llvm/IR/IRBuilder.h"
440b57cec5SDimitry Andric #include "llvm/IR/LLVMContext.h"
450b57cec5SDimitry Andric #include "llvm/IR/Module.h"
460b57cec5SDimitry Andric #include "llvm/IR/Type.h"
470b57cec5SDimitry Andric #include "llvm/IR/Verifier.h"
480b57cec5SDimitry Andric #include "llvm/IRReader/IRReader.h"
490b57cec5SDimitry Andric #include "llvm/Object/Archive.h"
500b57cec5SDimitry Andric #include "llvm/Object/ObjectFile.h"
510b57cec5SDimitry Andric #include "llvm/Support/CommandLine.h"
520b57cec5SDimitry Andric #include "llvm/Support/Debug.h"
530b57cec5SDimitry Andric #include "llvm/Support/DynamicLibrary.h"
540b57cec5SDimitry Andric #include "llvm/Support/Format.h"
550b57cec5SDimitry Andric #include "llvm/Support/InitLLVM.h"
560b57cec5SDimitry Andric #include "llvm/Support/MathExtras.h"
570b57cec5SDimitry Andric #include "llvm/Support/Memory.h"
580b57cec5SDimitry Andric #include "llvm/Support/MemoryBuffer.h"
590b57cec5SDimitry Andric #include "llvm/Support/Path.h"
600b57cec5SDimitry Andric #include "llvm/Support/PluginLoader.h"
610b57cec5SDimitry Andric #include "llvm/Support/Process.h"
620b57cec5SDimitry Andric #include "llvm/Support/Program.h"
630b57cec5SDimitry Andric #include "llvm/Support/SourceMgr.h"
640b57cec5SDimitry Andric #include "llvm/Support/TargetSelect.h"
650b57cec5SDimitry Andric #include "llvm/Support/WithColor.h"
660b57cec5SDimitry Andric #include "llvm/Support/raw_ostream.h"
6706c3fb27SDimitry Andric #include "llvm/TargetParser/Triple.h"
680b57cec5SDimitry Andric #include "llvm/Transforms/Instrumentation.h"
690b57cec5SDimitry Andric #include <cerrno>
70bdd1243dSDimitry Andric #include <optional>
710b57cec5SDimitry Andric 
72349cc55cSDimitry Andric #if !defined(_MSC_VER) && !defined(__MINGW32__)
73349cc55cSDimitry Andric #include <unistd.h>
74349cc55cSDimitry Andric #else
75349cc55cSDimitry Andric #include <io.h>
76349cc55cSDimitry Andric #endif
77349cc55cSDimitry Andric 
780b57cec5SDimitry Andric #ifdef __CYGWIN__
790b57cec5SDimitry Andric #include <cygwin/version.h>
800b57cec5SDimitry Andric #if defined(CYGWIN_VERSION_DLL_MAJOR) && CYGWIN_VERSION_DLL_MAJOR<1007
810b57cec5SDimitry Andric #define DO_NOTHING_ATEXIT 1
820b57cec5SDimitry Andric #endif
830b57cec5SDimitry Andric #endif
840b57cec5SDimitry Andric 
850b57cec5SDimitry Andric using namespace llvm;
860b57cec5SDimitry Andric 
875ffd83dbSDimitry Andric static codegen::RegisterCodeGenFlags CGF;
885ffd83dbSDimitry Andric 
890b57cec5SDimitry Andric #define DEBUG_TYPE "lli"
900b57cec5SDimitry Andric 
910b57cec5SDimitry Andric namespace {
920b57cec5SDimitry Andric 
93fe6060f1SDimitry Andric   enum class JITKind { MCJIT, Orc, OrcLazy };
94fe6060f1SDimitry Andric   enum class JITLinkerKind { Default, RuntimeDyld, JITLink };
950b57cec5SDimitry Andric 
960b57cec5SDimitry Andric   cl::opt<std::string>
970b57cec5SDimitry Andric   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
980b57cec5SDimitry Andric 
990b57cec5SDimitry Andric   cl::list<std::string>
1000b57cec5SDimitry Andric   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
1010b57cec5SDimitry Andric 
1020b57cec5SDimitry Andric   cl::opt<bool> ForceInterpreter("force-interpreter",
1030b57cec5SDimitry Andric                                  cl::desc("Force interpretation: disable JIT"),
1040b57cec5SDimitry Andric                                  cl::init(false));
1050b57cec5SDimitry Andric 
1060b57cec5SDimitry Andric   cl::opt<JITKind> UseJITKind(
1070b57cec5SDimitry Andric       "jit-kind", cl::desc("Choose underlying JIT kind."),
108fe6060f1SDimitry Andric       cl::init(JITKind::Orc),
1090b57cec5SDimitry Andric       cl::values(clEnumValN(JITKind::MCJIT, "mcjit", "MCJIT"),
110fe6060f1SDimitry Andric                  clEnumValN(JITKind::Orc, "orc", "Orc JIT"),
1110b57cec5SDimitry Andric                  clEnumValN(JITKind::OrcLazy, "orc-lazy",
1120b57cec5SDimitry Andric                             "Orc-based lazy JIT.")));
1130b57cec5SDimitry Andric 
114fe6060f1SDimitry Andric   cl::opt<JITLinkerKind>
115fe6060f1SDimitry Andric       JITLinker("jit-linker", cl::desc("Choose the dynamic linker/loader."),
116fe6060f1SDimitry Andric                 cl::init(JITLinkerKind::Default),
117fe6060f1SDimitry Andric                 cl::values(clEnumValN(JITLinkerKind::Default, "default",
118fe6060f1SDimitry Andric                                       "Default for platform and JIT-kind"),
119fe6060f1SDimitry Andric                            clEnumValN(JITLinkerKind::RuntimeDyld, "rtdyld",
120fe6060f1SDimitry Andric                                       "RuntimeDyld"),
121fe6060f1SDimitry Andric                            clEnumValN(JITLinkerKind::JITLink, "jitlink",
122fe6060f1SDimitry Andric                                       "Orc-specific linker")));
12381ad6265SDimitry Andric   cl::opt<std::string> OrcRuntime("orc-runtime",
12481ad6265SDimitry Andric                                   cl::desc("Use ORC runtime from given path"),
12581ad6265SDimitry Andric                                   cl::init(""));
126fe6060f1SDimitry Andric 
1270b57cec5SDimitry Andric   cl::opt<unsigned>
1280b57cec5SDimitry Andric   LazyJITCompileThreads("compile-threads",
1290b57cec5SDimitry Andric                         cl::desc("Choose the number of compile threads "
1300b57cec5SDimitry Andric                                  "(jit-kind=orc-lazy only)"),
1310b57cec5SDimitry Andric                         cl::init(0));
1320b57cec5SDimitry Andric 
1330b57cec5SDimitry Andric   cl::list<std::string>
1340b57cec5SDimitry Andric   ThreadEntryPoints("thread-entry",
1350b57cec5SDimitry Andric                     cl::desc("calls the given entry-point on a new thread "
1360b57cec5SDimitry Andric                              "(jit-kind=orc-lazy only)"));
1370b57cec5SDimitry Andric 
1380b57cec5SDimitry Andric   cl::opt<bool> PerModuleLazy(
1390b57cec5SDimitry Andric       "per-module-lazy",
1400b57cec5SDimitry Andric       cl::desc("Performs lazy compilation on whole module boundaries "
1410b57cec5SDimitry Andric                "rather than individual functions"),
1420b57cec5SDimitry Andric       cl::init(false));
1430b57cec5SDimitry Andric 
1440b57cec5SDimitry Andric   cl::list<std::string>
1450b57cec5SDimitry Andric       JITDylibs("jd",
1460b57cec5SDimitry Andric                 cl::desc("Specifies the JITDylib to be used for any subsequent "
1470b57cec5SDimitry Andric                          "-extra-module arguments."));
1480b57cec5SDimitry Andric 
1495ffd83dbSDimitry Andric   cl::list<std::string>
15081ad6265SDimitry Andric       Dylibs("dlopen", cl::desc("Dynamic libraries to load before linking"));
1515ffd83dbSDimitry Andric 
1520b57cec5SDimitry Andric   // The MCJIT supports building for a target address space separate from
1530b57cec5SDimitry Andric   // the JIT compilation process. Use a forked process and a copying
1540b57cec5SDimitry Andric   // memory manager with IPC to execute using this functionality.
1550b57cec5SDimitry Andric   cl::opt<bool> RemoteMCJIT("remote-mcjit",
1560b57cec5SDimitry Andric     cl::desc("Execute MCJIT'ed code in a separate process."),
1570b57cec5SDimitry Andric     cl::init(false));
1580b57cec5SDimitry Andric 
1590b57cec5SDimitry Andric   // Manually specify the child process for remote execution. This overrides
1600b57cec5SDimitry Andric   // the simulated remote execution that allocates address space for child
1610b57cec5SDimitry Andric   // execution. The child process will be executed and will communicate with
1620b57cec5SDimitry Andric   // lli via stdin/stdout pipes.
1630b57cec5SDimitry Andric   cl::opt<std::string>
1640b57cec5SDimitry Andric   ChildExecPath("mcjit-remote-process",
1650b57cec5SDimitry Andric                 cl::desc("Specify the filename of the process to launch "
1660b57cec5SDimitry Andric                          "for remote MCJIT execution.  If none is specified,"
1670b57cec5SDimitry Andric                          "\n\tremote execution will be simulated in-process."),
1680b57cec5SDimitry Andric                 cl::value_desc("filename"), cl::init(""));
1690b57cec5SDimitry Andric 
1700b57cec5SDimitry Andric   // Determine optimization level.
17181ad6265SDimitry Andric   cl::opt<char> OptLevel("O",
1720b57cec5SDimitry Andric                          cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
1730b57cec5SDimitry Andric                                   "(default = '-O2')"),
174bdd1243dSDimitry Andric                          cl::Prefix, cl::init('2'));
1750b57cec5SDimitry Andric 
1760b57cec5SDimitry Andric   cl::opt<std::string>
1770b57cec5SDimitry Andric   TargetTriple("mtriple", cl::desc("Override target triple for module"));
1780b57cec5SDimitry Andric 
1790b57cec5SDimitry Andric   cl::opt<std::string>
1800b57cec5SDimitry Andric   EntryFunc("entry-function",
1810b57cec5SDimitry Andric             cl::desc("Specify the entry function (default = 'main') "
1820b57cec5SDimitry Andric                      "of the executable"),
1830b57cec5SDimitry Andric             cl::value_desc("function"),
1840b57cec5SDimitry Andric             cl::init("main"));
1850b57cec5SDimitry Andric 
1860b57cec5SDimitry Andric   cl::list<std::string>
1870b57cec5SDimitry Andric   ExtraModules("extra-module",
1880b57cec5SDimitry Andric          cl::desc("Extra modules to be loaded"),
1890b57cec5SDimitry Andric          cl::value_desc("input bitcode"));
1900b57cec5SDimitry Andric 
1910b57cec5SDimitry Andric   cl::list<std::string>
1920b57cec5SDimitry Andric   ExtraObjects("extra-object",
1930b57cec5SDimitry Andric          cl::desc("Extra object files to be loaded"),
1940b57cec5SDimitry Andric          cl::value_desc("input object"));
1950b57cec5SDimitry Andric 
1960b57cec5SDimitry Andric   cl::list<std::string>
1970b57cec5SDimitry Andric   ExtraArchives("extra-archive",
1980b57cec5SDimitry Andric          cl::desc("Extra archive files to be loaded"),
1990b57cec5SDimitry Andric          cl::value_desc("input archive"));
2000b57cec5SDimitry Andric 
2010b57cec5SDimitry Andric   cl::opt<bool>
2020b57cec5SDimitry Andric   EnableCacheManager("enable-cache-manager",
2030b57cec5SDimitry Andric         cl::desc("Use cache manager to save/load modules"),
2040b57cec5SDimitry Andric         cl::init(false));
2050b57cec5SDimitry Andric 
2060b57cec5SDimitry Andric   cl::opt<std::string>
2070b57cec5SDimitry Andric   ObjectCacheDir("object-cache-dir",
2080b57cec5SDimitry Andric                   cl::desc("Directory to store cached object files "
2090b57cec5SDimitry Andric                            "(must be user writable)"),
2100b57cec5SDimitry Andric                   cl::init(""));
2110b57cec5SDimitry Andric 
2120b57cec5SDimitry Andric   cl::opt<std::string>
2130b57cec5SDimitry Andric   FakeArgv0("fake-argv0",
2140b57cec5SDimitry Andric             cl::desc("Override the 'argv[0]' value passed into the executing"
2150b57cec5SDimitry Andric                      " program"), cl::value_desc("executable"));
2160b57cec5SDimitry Andric 
2170b57cec5SDimitry Andric   cl::opt<bool>
2180b57cec5SDimitry Andric   DisableCoreFiles("disable-core-files", cl::Hidden,
2190b57cec5SDimitry Andric                    cl::desc("Disable emission of core files if possible"));
2200b57cec5SDimitry Andric 
2210b57cec5SDimitry Andric   cl::opt<bool>
2220b57cec5SDimitry Andric   NoLazyCompilation("disable-lazy-compilation",
2230b57cec5SDimitry Andric                   cl::desc("Disable JIT lazy compilation"),
2240b57cec5SDimitry Andric                   cl::init(false));
2250b57cec5SDimitry Andric 
2260b57cec5SDimitry Andric   cl::opt<bool>
2270b57cec5SDimitry Andric   GenerateSoftFloatCalls("soft-float",
2280b57cec5SDimitry Andric     cl::desc("Generate software floating point library calls"),
2290b57cec5SDimitry Andric     cl::init(false));
2300b57cec5SDimitry Andric 
23113138422SDimitry Andric   cl::opt<bool> NoProcessSymbols(
23213138422SDimitry Andric       "no-process-syms",
23313138422SDimitry Andric       cl::desc("Do not resolve lli process symbols in JIT'd code"),
23413138422SDimitry Andric       cl::init(false));
23513138422SDimitry Andric 
23606c3fb27SDimitry Andric   enum class LLJITPlatform { Inactive, Auto, ExecutorNative, GenericIR };
2375ffd83dbSDimitry Andric 
23806c3fb27SDimitry Andric   cl::opt<LLJITPlatform> Platform(
23906c3fb27SDimitry Andric       "lljit-platform", cl::desc("Platform to use with LLJIT"),
24006c3fb27SDimitry Andric       cl::init(LLJITPlatform::Auto),
24106c3fb27SDimitry Andric       cl::values(clEnumValN(LLJITPlatform::Auto, "Auto",
24206c3fb27SDimitry Andric                             "Like 'ExecutorNative' if ORC runtime "
24306c3fb27SDimitry Andric                             "provided, otherwise like 'GenericIR'"),
24406c3fb27SDimitry Andric                  clEnumValN(LLJITPlatform::ExecutorNative, "ExecutorNative",
24506c3fb27SDimitry Andric                             "Use the native platform for the executor."
24606c3fb27SDimitry Andric                             "Requires -orc-runtime"),
2475ffd83dbSDimitry Andric                  clEnumValN(LLJITPlatform::GenericIR, "GenericIR",
2485ffd83dbSDimitry Andric                             "Use LLJITGenericIRPlatform"),
249fe6060f1SDimitry Andric                  clEnumValN(LLJITPlatform::Inactive, "Inactive",
250fe6060f1SDimitry Andric                             "Disable platform support explicitly")),
2515ffd83dbSDimitry Andric       cl::Hidden);
2525ffd83dbSDimitry Andric 
2530b57cec5SDimitry Andric   enum class DumpKind {
2540b57cec5SDimitry Andric     NoDump,
2550b57cec5SDimitry Andric     DumpFuncsToStdOut,
2560b57cec5SDimitry Andric     DumpModsToStdOut,
2570b57cec5SDimitry Andric     DumpModsToDisk
2580b57cec5SDimitry Andric   };
2590b57cec5SDimitry Andric 
2600b57cec5SDimitry Andric   cl::opt<DumpKind> OrcDumpKind(
2610b57cec5SDimitry Andric       "orc-lazy-debug", cl::desc("Debug dumping for the orc-lazy JIT."),
2620b57cec5SDimitry Andric       cl::init(DumpKind::NoDump),
2630b57cec5SDimitry Andric       cl::values(clEnumValN(DumpKind::NoDump, "no-dump",
2640b57cec5SDimitry Andric                             "Don't dump anything."),
2650b57cec5SDimitry Andric                  clEnumValN(DumpKind::DumpFuncsToStdOut, "funcs-to-stdout",
2660b57cec5SDimitry Andric                             "Dump function names to stdout."),
2670b57cec5SDimitry Andric                  clEnumValN(DumpKind::DumpModsToStdOut, "mods-to-stdout",
2680b57cec5SDimitry Andric                             "Dump modules to stdout."),
2690b57cec5SDimitry Andric                  clEnumValN(DumpKind::DumpModsToDisk, "mods-to-disk",
2700b57cec5SDimitry Andric                             "Dump modules to the current "
2710b57cec5SDimitry Andric                             "working directory. (WARNING: "
2720b57cec5SDimitry Andric                             "will overwrite existing files).")),
2730b57cec5SDimitry Andric       cl::Hidden);
2740b57cec5SDimitry Andric 
275fe6060f1SDimitry Andric   cl::list<BuiltinFunctionKind> GenerateBuiltinFunctions(
276fe6060f1SDimitry Andric       "generate",
277fe6060f1SDimitry Andric       cl::desc("Provide built-in functions for access by JITed code "
278fe6060f1SDimitry Andric                "(jit-kind=orc-lazy only)"),
279fe6060f1SDimitry Andric       cl::values(clEnumValN(BuiltinFunctionKind::DumpDebugDescriptor,
280fe6060f1SDimitry Andric                             "__dump_jit_debug_descriptor",
281fe6060f1SDimitry Andric                             "Dump __jit_debug_descriptor contents to stdout"),
282fe6060f1SDimitry Andric                  clEnumValN(BuiltinFunctionKind::DumpDebugObjects,
283fe6060f1SDimitry Andric                             "__dump_jit_debug_objects",
284fe6060f1SDimitry Andric                             "Dump __jit_debug_descriptor in-memory debug "
285fe6060f1SDimitry Andric                             "objects as tool output")),
286fe6060f1SDimitry Andric       cl::Hidden);
287fe6060f1SDimitry Andric 
2880b57cec5SDimitry Andric   ExitOnError ExitOnErr;
2890b57cec5SDimitry Andric }
2900b57cec5SDimitry Andric 
291fe6060f1SDimitry Andric LLVM_ATTRIBUTE_USED void linkComponents() {
292fe6060f1SDimitry Andric   errs() << (void *)&llvm_orc_registerEHFrameSectionWrapper
293fe6060f1SDimitry Andric          << (void *)&llvm_orc_deregisterEHFrameSectionWrapper
29461cfbce3SDimitry Andric          << (void *)&llvm_orc_registerJITLoaderGDBWrapper
29561cfbce3SDimitry Andric          << (void *)&llvm_orc_registerJITLoaderGDBAllocAction;
296fe6060f1SDimitry Andric }
297fe6060f1SDimitry Andric 
2980b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
2990b57cec5SDimitry Andric // Object cache
3000b57cec5SDimitry Andric //
3010b57cec5SDimitry Andric // This object cache implementation writes cached objects to disk to the
3020b57cec5SDimitry Andric // directory specified by CacheDir, using a filename provided in the module
3030b57cec5SDimitry Andric // descriptor. The cache tries to load a saved object using that path if the
3040b57cec5SDimitry Andric // file exists. CacheDir defaults to "", in which case objects are cached
3050b57cec5SDimitry Andric // alongside their originating bitcodes.
3060b57cec5SDimitry Andric //
3070b57cec5SDimitry Andric class LLIObjectCache : public ObjectCache {
3080b57cec5SDimitry Andric public:
3090b57cec5SDimitry Andric   LLIObjectCache(const std::string& CacheDir) : CacheDir(CacheDir) {
3100b57cec5SDimitry Andric     // Add trailing '/' to cache dir if necessary.
3110b57cec5SDimitry Andric     if (!this->CacheDir.empty() &&
3120b57cec5SDimitry Andric         this->CacheDir[this->CacheDir.size() - 1] != '/')
3130b57cec5SDimitry Andric       this->CacheDir += '/';
3140b57cec5SDimitry Andric   }
3150b57cec5SDimitry Andric   ~LLIObjectCache() override {}
3160b57cec5SDimitry Andric 
3170b57cec5SDimitry Andric   void notifyObjectCompiled(const Module *M, MemoryBufferRef Obj) override {
3180b57cec5SDimitry Andric     const std::string &ModuleID = M->getModuleIdentifier();
3190b57cec5SDimitry Andric     std::string CacheName;
3200b57cec5SDimitry Andric     if (!getCacheFilename(ModuleID, CacheName))
3210b57cec5SDimitry Andric       return;
3220b57cec5SDimitry Andric     if (!CacheDir.empty()) { // Create user-defined cache dir.
3230b57cec5SDimitry Andric       SmallString<128> dir(sys::path::parent_path(CacheName));
3240b57cec5SDimitry Andric       sys::fs::create_directories(Twine(dir));
3250b57cec5SDimitry Andric     }
3265ffd83dbSDimitry Andric 
3270b57cec5SDimitry Andric     std::error_code EC;
3288bcb0991SDimitry Andric     raw_fd_ostream outfile(CacheName, EC, sys::fs::OF_None);
3290b57cec5SDimitry Andric     outfile.write(Obj.getBufferStart(), Obj.getBufferSize());
3300b57cec5SDimitry Andric     outfile.close();
3310b57cec5SDimitry Andric   }
3320b57cec5SDimitry Andric 
3330b57cec5SDimitry Andric   std::unique_ptr<MemoryBuffer> getObject(const Module* M) override {
3340b57cec5SDimitry Andric     const std::string &ModuleID = M->getModuleIdentifier();
3350b57cec5SDimitry Andric     std::string CacheName;
3360b57cec5SDimitry Andric     if (!getCacheFilename(ModuleID, CacheName))
3370b57cec5SDimitry Andric       return nullptr;
3380b57cec5SDimitry Andric     // Load the object from the cache filename
3390b57cec5SDimitry Andric     ErrorOr<std::unique_ptr<MemoryBuffer>> IRObjectBuffer =
340fe6060f1SDimitry Andric         MemoryBuffer::getFile(CacheName, /*IsText=*/false,
341fe6060f1SDimitry Andric                               /*RequiresNullTerminator=*/false);
3420b57cec5SDimitry Andric     // If the file isn't there, that's OK.
3430b57cec5SDimitry Andric     if (!IRObjectBuffer)
3440b57cec5SDimitry Andric       return nullptr;
3450b57cec5SDimitry Andric     // MCJIT will want to write into this buffer, and we don't want that
3460b57cec5SDimitry Andric     // because the file has probably just been mmapped.  Instead we make
3470b57cec5SDimitry Andric     // a copy.  The filed-based buffer will be released when it goes
3480b57cec5SDimitry Andric     // out of scope.
3490b57cec5SDimitry Andric     return MemoryBuffer::getMemBufferCopy(IRObjectBuffer.get()->getBuffer());
3500b57cec5SDimitry Andric   }
3510b57cec5SDimitry Andric 
3520b57cec5SDimitry Andric private:
3530b57cec5SDimitry Andric   std::string CacheDir;
3540b57cec5SDimitry Andric 
3550b57cec5SDimitry Andric   bool getCacheFilename(const std::string &ModID, std::string &CacheName) {
3560b57cec5SDimitry Andric     std::string Prefix("file:");
3570b57cec5SDimitry Andric     size_t PrefixLength = Prefix.length();
3580b57cec5SDimitry Andric     if (ModID.substr(0, PrefixLength) != Prefix)
3590b57cec5SDimitry Andric       return false;
3605ffd83dbSDimitry Andric 
3610b57cec5SDimitry Andric     std::string CacheSubdir = ModID.substr(PrefixLength);
362349cc55cSDimitry Andric     // Transform "X:\foo" => "/X\foo" for convenience on Windows.
363349cc55cSDimitry Andric     if (is_style_windows(llvm::sys::path::Style::native) &&
364349cc55cSDimitry Andric         isalpha(CacheSubdir[0]) && CacheSubdir[1] == ':') {
3650b57cec5SDimitry Andric       CacheSubdir[1] = CacheSubdir[0];
3660b57cec5SDimitry Andric       CacheSubdir[0] = '/';
3670b57cec5SDimitry Andric     }
3685ffd83dbSDimitry Andric 
3690b57cec5SDimitry Andric     CacheName = CacheDir + CacheSubdir;
3700b57cec5SDimitry Andric     size_t pos = CacheName.rfind('.');
3710b57cec5SDimitry Andric     CacheName.replace(pos, CacheName.length() - pos, ".o");
3720b57cec5SDimitry Andric     return true;
3730b57cec5SDimitry Andric   }
3740b57cec5SDimitry Andric };
3750b57cec5SDimitry Andric 
3760b57cec5SDimitry Andric // On Mingw and Cygwin, an external symbol named '__main' is called from the
3770b57cec5SDimitry Andric // generated 'main' function to allow static initialization.  To avoid linking
3780b57cec5SDimitry Andric // problems with remote targets (because lli's remote target support does not
3790b57cec5SDimitry Andric // currently handle external linking) we add a secondary module which defines
3800b57cec5SDimitry Andric // an empty '__main' function.
3810b57cec5SDimitry Andric static void addCygMingExtraModule(ExecutionEngine &EE, LLVMContext &Context,
3820b57cec5SDimitry Andric                                   StringRef TargetTripleStr) {
3830b57cec5SDimitry Andric   IRBuilder<> Builder(Context);
3840b57cec5SDimitry Andric   Triple TargetTriple(TargetTripleStr);
3850b57cec5SDimitry Andric 
3860b57cec5SDimitry Andric   // Create a new module.
3878bcb0991SDimitry Andric   std::unique_ptr<Module> M = std::make_unique<Module>("CygMingHelper", Context);
3880b57cec5SDimitry Andric   M->setTargetTriple(TargetTripleStr);
3890b57cec5SDimitry Andric 
3900b57cec5SDimitry Andric   // Create an empty function named "__main".
3910b57cec5SDimitry Andric   Type *ReturnTy;
3920b57cec5SDimitry Andric   if (TargetTriple.isArch64Bit())
3930b57cec5SDimitry Andric     ReturnTy = Type::getInt64Ty(Context);
3940b57cec5SDimitry Andric   else
3950b57cec5SDimitry Andric     ReturnTy = Type::getInt32Ty(Context);
3960b57cec5SDimitry Andric   Function *Result =
3970b57cec5SDimitry Andric       Function::Create(FunctionType::get(ReturnTy, {}, false),
3980b57cec5SDimitry Andric                        GlobalValue::ExternalLinkage, "__main", M.get());
3990b57cec5SDimitry Andric 
4000b57cec5SDimitry Andric   BasicBlock *BB = BasicBlock::Create(Context, "__main", Result);
4010b57cec5SDimitry Andric   Builder.SetInsertPoint(BB);
4020b57cec5SDimitry Andric   Value *ReturnVal = ConstantInt::get(ReturnTy, 0);
4030b57cec5SDimitry Andric   Builder.CreateRet(ReturnVal);
4040b57cec5SDimitry Andric 
4050b57cec5SDimitry Andric   // Add this new module to the ExecutionEngine.
4060b57cec5SDimitry Andric   EE.addModule(std::move(M));
4070b57cec5SDimitry Andric }
4080b57cec5SDimitry Andric 
4095f757f3fSDimitry Andric CodeGenOptLevel getOptLevel() {
410bdd1243dSDimitry Andric   if (auto Level = CodeGenOpt::parseLevel(OptLevel))
411bdd1243dSDimitry Andric     return *Level;
4120b57cec5SDimitry Andric   WithColor::error(errs(), "lli") << "invalid optimization level.\n";
4130b57cec5SDimitry Andric   exit(1);
4140b57cec5SDimitry Andric }
4150b57cec5SDimitry Andric 
416349cc55cSDimitry Andric [[noreturn]] static void reportError(SMDiagnostic Err, const char *ProgName) {
4170b57cec5SDimitry Andric   Err.print(ProgName, errs());
4180b57cec5SDimitry Andric   exit(1);
4190b57cec5SDimitry Andric }
4200b57cec5SDimitry Andric 
4215ffd83dbSDimitry Andric Error loadDylibs();
422fe6060f1SDimitry Andric int runOrcJIT(const char *ProgName);
4230b57cec5SDimitry Andric void disallowOrcOptions();
424349cc55cSDimitry Andric Expected<std::unique_ptr<orc::ExecutorProcessControl>> launchRemote();
4250b57cec5SDimitry Andric 
4260b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
4270b57cec5SDimitry Andric // main Driver function
4280b57cec5SDimitry Andric //
4290b57cec5SDimitry Andric int main(int argc, char **argv, char * const *envp) {
4300b57cec5SDimitry Andric   InitLLVM X(argc, argv);
4310b57cec5SDimitry Andric 
4320b57cec5SDimitry Andric   if (argc > 1)
4330b57cec5SDimitry Andric     ExitOnErr.setBanner(std::string(argv[0]) + ": ");
4340b57cec5SDimitry Andric 
4350b57cec5SDimitry Andric   // If we have a native target, initialize it to ensure it is linked in and
4360b57cec5SDimitry Andric   // usable by the JIT.
4370b57cec5SDimitry Andric   InitializeNativeTarget();
4380b57cec5SDimitry Andric   InitializeNativeTargetAsmPrinter();
4390b57cec5SDimitry Andric   InitializeNativeTargetAsmParser();
4400b57cec5SDimitry Andric 
4410b57cec5SDimitry Andric   cl::ParseCommandLineOptions(argc, argv,
4420b57cec5SDimitry Andric                               "llvm interpreter & dynamic compiler\n");
4430b57cec5SDimitry Andric 
4440b57cec5SDimitry Andric   // If the user doesn't want core files, disable them.
4450b57cec5SDimitry Andric   if (DisableCoreFiles)
4460b57cec5SDimitry Andric     sys::Process::PreventCoreFiles();
4470b57cec5SDimitry Andric 
4485ffd83dbSDimitry Andric   ExitOnErr(loadDylibs());
4495ffd83dbSDimitry Andric 
4505f757f3fSDimitry Andric   if (EntryFunc.empty()) {
4515f757f3fSDimitry Andric     WithColor::error(errs(), argv[0])
4525f757f3fSDimitry Andric         << "--entry-function name cannot be empty\n";
4535f757f3fSDimitry Andric     exit(1);
4545f757f3fSDimitry Andric   }
4555f757f3fSDimitry Andric 
4565f757f3fSDimitry Andric   if (UseJITKind == JITKind::MCJIT || ForceInterpreter)
4570b57cec5SDimitry Andric     disallowOrcOptions();
458fe6060f1SDimitry Andric   else
459fe6060f1SDimitry Andric     return runOrcJIT(argv[0]);
4600b57cec5SDimitry Andric 
461fe6060f1SDimitry Andric   // Old lli implementation based on ExecutionEngine and MCJIT.
4620b57cec5SDimitry Andric   LLVMContext Context;
4630b57cec5SDimitry Andric 
4640b57cec5SDimitry Andric   // Load the bitcode...
4650b57cec5SDimitry Andric   SMDiagnostic Err;
4660b57cec5SDimitry Andric   std::unique_ptr<Module> Owner = parseIRFile(InputFile, Err, Context);
4670b57cec5SDimitry Andric   Module *Mod = Owner.get();
4680b57cec5SDimitry Andric   if (!Mod)
4690b57cec5SDimitry Andric     reportError(Err, argv[0]);
4700b57cec5SDimitry Andric 
4710b57cec5SDimitry Andric   if (EnableCacheManager) {
4720b57cec5SDimitry Andric     std::string CacheName("file:");
4730b57cec5SDimitry Andric     CacheName.append(InputFile);
4740b57cec5SDimitry Andric     Mod->setModuleIdentifier(CacheName);
4750b57cec5SDimitry Andric   }
4760b57cec5SDimitry Andric 
4770b57cec5SDimitry Andric   // If not jitting lazily, load the whole bitcode file eagerly too.
4780b57cec5SDimitry Andric   if (NoLazyCompilation) {
4790b57cec5SDimitry Andric     // Use *argv instead of argv[0] to work around a wrong GCC warning.
4800b57cec5SDimitry Andric     ExitOnError ExitOnErr(std::string(*argv) +
4810b57cec5SDimitry Andric                           ": bitcode didn't read correctly: ");
4820b57cec5SDimitry Andric     ExitOnErr(Mod->materializeAll());
4830b57cec5SDimitry Andric   }
4840b57cec5SDimitry Andric 
4850b57cec5SDimitry Andric   std::string ErrorMsg;
4860b57cec5SDimitry Andric   EngineBuilder builder(std::move(Owner));
4875ffd83dbSDimitry Andric   builder.setMArch(codegen::getMArch());
4885ffd83dbSDimitry Andric   builder.setMCPU(codegen::getCPUStr());
4895ffd83dbSDimitry Andric   builder.setMAttrs(codegen::getFeatureList());
4905ffd83dbSDimitry Andric   if (auto RM = codegen::getExplicitRelocModel())
491bdd1243dSDimitry Andric     builder.setRelocationModel(*RM);
4925ffd83dbSDimitry Andric   if (auto CM = codegen::getExplicitCodeModel())
493bdd1243dSDimitry Andric     builder.setCodeModel(*CM);
4940b57cec5SDimitry Andric   builder.setErrorStr(&ErrorMsg);
4950b57cec5SDimitry Andric   builder.setEngineKind(ForceInterpreter
4960b57cec5SDimitry Andric                         ? EngineKind::Interpreter
4970b57cec5SDimitry Andric                         : EngineKind::JIT);
4980b57cec5SDimitry Andric 
4990b57cec5SDimitry Andric   // If we are supposed to override the target triple, do so now.
5000b57cec5SDimitry Andric   if (!TargetTriple.empty())
5010b57cec5SDimitry Andric     Mod->setTargetTriple(Triple::normalize(TargetTriple));
5020b57cec5SDimitry Andric 
5030b57cec5SDimitry Andric   // Enable MCJIT if desired.
5040b57cec5SDimitry Andric   RTDyldMemoryManager *RTDyldMM = nullptr;
5050b57cec5SDimitry Andric   if (!ForceInterpreter) {
5060b57cec5SDimitry Andric     if (RemoteMCJIT)
5070b57cec5SDimitry Andric       RTDyldMM = new ForwardingMemoryManager();
5080b57cec5SDimitry Andric     else
5090b57cec5SDimitry Andric       RTDyldMM = new SectionMemoryManager();
5100b57cec5SDimitry Andric 
5110b57cec5SDimitry Andric     // Deliberately construct a temp std::unique_ptr to pass in. Do not null out
5120b57cec5SDimitry Andric     // RTDyldMM: We still use it below, even though we don't own it.
5130b57cec5SDimitry Andric     builder.setMCJITMemoryManager(
5140b57cec5SDimitry Andric       std::unique_ptr<RTDyldMemoryManager>(RTDyldMM));
5150b57cec5SDimitry Andric   } else if (RemoteMCJIT) {
5160b57cec5SDimitry Andric     WithColor::error(errs(), argv[0])
5170b57cec5SDimitry Andric         << "remote process execution does not work with the interpreter.\n";
5180b57cec5SDimitry Andric     exit(1);
5190b57cec5SDimitry Andric   }
5200b57cec5SDimitry Andric 
5210b57cec5SDimitry Andric   builder.setOptLevel(getOptLevel());
5220b57cec5SDimitry Andric 
523e8d8bef9SDimitry Andric   TargetOptions Options =
524e8d8bef9SDimitry Andric       codegen::InitTargetOptionsFromCodeGenFlags(Triple(TargetTriple));
5255ffd83dbSDimitry Andric   if (codegen::getFloatABIForCalls() != FloatABI::Default)
5265ffd83dbSDimitry Andric     Options.FloatABIType = codegen::getFloatABIForCalls();
5270b57cec5SDimitry Andric 
5280b57cec5SDimitry Andric   builder.setTargetOptions(Options);
5290b57cec5SDimitry Andric 
5300b57cec5SDimitry Andric   std::unique_ptr<ExecutionEngine> EE(builder.create());
5310b57cec5SDimitry Andric   if (!EE) {
5320b57cec5SDimitry Andric     if (!ErrorMsg.empty())
5330b57cec5SDimitry Andric       WithColor::error(errs(), argv[0])
5340b57cec5SDimitry Andric           << "error creating EE: " << ErrorMsg << "\n";
5350b57cec5SDimitry Andric     else
5360b57cec5SDimitry Andric       WithColor::error(errs(), argv[0]) << "unknown error creating EE!\n";
5370b57cec5SDimitry Andric     exit(1);
5380b57cec5SDimitry Andric   }
5390b57cec5SDimitry Andric 
5400b57cec5SDimitry Andric   std::unique_ptr<LLIObjectCache> CacheManager;
5410b57cec5SDimitry Andric   if (EnableCacheManager) {
5420b57cec5SDimitry Andric     CacheManager.reset(new LLIObjectCache(ObjectCacheDir));
5430b57cec5SDimitry Andric     EE->setObjectCache(CacheManager.get());
5440b57cec5SDimitry Andric   }
5450b57cec5SDimitry Andric 
5460b57cec5SDimitry Andric   // Load any additional modules specified on the command line.
5470b57cec5SDimitry Andric   for (unsigned i = 0, e = ExtraModules.size(); i != e; ++i) {
5480b57cec5SDimitry Andric     std::unique_ptr<Module> XMod = parseIRFile(ExtraModules[i], Err, Context);
5490b57cec5SDimitry Andric     if (!XMod)
5500b57cec5SDimitry Andric       reportError(Err, argv[0]);
5510b57cec5SDimitry Andric     if (EnableCacheManager) {
5520b57cec5SDimitry Andric       std::string CacheName("file:");
5530b57cec5SDimitry Andric       CacheName.append(ExtraModules[i]);
5540b57cec5SDimitry Andric       XMod->setModuleIdentifier(CacheName);
5550b57cec5SDimitry Andric     }
5560b57cec5SDimitry Andric     EE->addModule(std::move(XMod));
5570b57cec5SDimitry Andric   }
5580b57cec5SDimitry Andric 
5590b57cec5SDimitry Andric   for (unsigned i = 0, e = ExtraObjects.size(); i != e; ++i) {
5600b57cec5SDimitry Andric     Expected<object::OwningBinary<object::ObjectFile>> Obj =
5610b57cec5SDimitry Andric         object::ObjectFile::createObjectFile(ExtraObjects[i]);
5620b57cec5SDimitry Andric     if (!Obj) {
5630b57cec5SDimitry Andric       // TODO: Actually report errors helpfully.
5640b57cec5SDimitry Andric       consumeError(Obj.takeError());
5650b57cec5SDimitry Andric       reportError(Err, argv[0]);
5660b57cec5SDimitry Andric     }
5670b57cec5SDimitry Andric     object::OwningBinary<object::ObjectFile> &O = Obj.get();
5680b57cec5SDimitry Andric     EE->addObjectFile(std::move(O));
5690b57cec5SDimitry Andric   }
5700b57cec5SDimitry Andric 
5710b57cec5SDimitry Andric   for (unsigned i = 0, e = ExtraArchives.size(); i != e; ++i) {
5720b57cec5SDimitry Andric     ErrorOr<std::unique_ptr<MemoryBuffer>> ArBufOrErr =
5730b57cec5SDimitry Andric         MemoryBuffer::getFileOrSTDIN(ExtraArchives[i]);
5740b57cec5SDimitry Andric     if (!ArBufOrErr)
5750b57cec5SDimitry Andric       reportError(Err, argv[0]);
5760b57cec5SDimitry Andric     std::unique_ptr<MemoryBuffer> &ArBuf = ArBufOrErr.get();
5770b57cec5SDimitry Andric 
5780b57cec5SDimitry Andric     Expected<std::unique_ptr<object::Archive>> ArOrErr =
5790b57cec5SDimitry Andric         object::Archive::create(ArBuf->getMemBufferRef());
5800b57cec5SDimitry Andric     if (!ArOrErr) {
5810b57cec5SDimitry Andric       std::string Buf;
5820b57cec5SDimitry Andric       raw_string_ostream OS(Buf);
5830b57cec5SDimitry Andric       logAllUnhandledErrors(ArOrErr.takeError(), OS);
5840b57cec5SDimitry Andric       OS.flush();
5850b57cec5SDimitry Andric       errs() << Buf;
5860b57cec5SDimitry Andric       exit(1);
5870b57cec5SDimitry Andric     }
5880b57cec5SDimitry Andric     std::unique_ptr<object::Archive> &Ar = ArOrErr.get();
5890b57cec5SDimitry Andric 
5900b57cec5SDimitry Andric     object::OwningBinary<object::Archive> OB(std::move(Ar), std::move(ArBuf));
5910b57cec5SDimitry Andric 
5920b57cec5SDimitry Andric     EE->addArchive(std::move(OB));
5930b57cec5SDimitry Andric   }
5940b57cec5SDimitry Andric 
5950b57cec5SDimitry Andric   // If the target is Cygwin/MingW and we are generating remote code, we
5960b57cec5SDimitry Andric   // need an extra module to help out with linking.
5970b57cec5SDimitry Andric   if (RemoteMCJIT && Triple(Mod->getTargetTriple()).isOSCygMing()) {
5980b57cec5SDimitry Andric     addCygMingExtraModule(*EE, Context, Mod->getTargetTriple());
5990b57cec5SDimitry Andric   }
6000b57cec5SDimitry Andric 
6010b57cec5SDimitry Andric   // The following functions have no effect if their respective profiling
6020b57cec5SDimitry Andric   // support wasn't enabled in the build configuration.
6030b57cec5SDimitry Andric   EE->RegisterJITEventListener(
6040b57cec5SDimitry Andric                 JITEventListener::createOProfileJITEventListener());
6050b57cec5SDimitry Andric   EE->RegisterJITEventListener(
6060b57cec5SDimitry Andric                 JITEventListener::createIntelJITEventListener());
6070b57cec5SDimitry Andric   if (!RemoteMCJIT)
6080b57cec5SDimitry Andric     EE->RegisterJITEventListener(
6090b57cec5SDimitry Andric                 JITEventListener::createPerfJITEventListener());
6100b57cec5SDimitry Andric 
6110b57cec5SDimitry Andric   if (!NoLazyCompilation && RemoteMCJIT) {
6120b57cec5SDimitry Andric     WithColor::warning(errs(), argv[0])
6130b57cec5SDimitry Andric         << "remote mcjit does not support lazy compilation\n";
6140b57cec5SDimitry Andric     NoLazyCompilation = true;
6150b57cec5SDimitry Andric   }
6160b57cec5SDimitry Andric   EE->DisableLazyCompilation(NoLazyCompilation);
6170b57cec5SDimitry Andric 
6180b57cec5SDimitry Andric   // If the user specifically requested an argv[0] to pass into the program,
6190b57cec5SDimitry Andric   // do it now.
6200b57cec5SDimitry Andric   if (!FakeArgv0.empty()) {
6210b57cec5SDimitry Andric     InputFile = static_cast<std::string>(FakeArgv0);
6220b57cec5SDimitry Andric   } else {
6230b57cec5SDimitry Andric     // Otherwise, if there is a .bc suffix on the executable strip it off, it
6240b57cec5SDimitry Andric     // might confuse the program.
6255f757f3fSDimitry Andric     if (StringRef(InputFile).ends_with(".bc"))
6260b57cec5SDimitry Andric       InputFile.erase(InputFile.length() - 3);
6270b57cec5SDimitry Andric   }
6280b57cec5SDimitry Andric 
6290b57cec5SDimitry Andric   // Add the module's name to the start of the vector of arguments to main().
6300b57cec5SDimitry Andric   InputArgv.insert(InputArgv.begin(), InputFile);
6310b57cec5SDimitry Andric 
6320b57cec5SDimitry Andric   // Call the main function from M as if its signature were:
6330b57cec5SDimitry Andric   //   int main (int argc, char **argv, const char **envp)
6340b57cec5SDimitry Andric   // using the contents of Args to determine argc & argv, and the contents of
6350b57cec5SDimitry Andric   // EnvVars to determine envp.
6360b57cec5SDimitry Andric   //
6370b57cec5SDimitry Andric   Function *EntryFn = Mod->getFunction(EntryFunc);
6380b57cec5SDimitry Andric   if (!EntryFn) {
6390b57cec5SDimitry Andric     WithColor::error(errs(), argv[0])
6400b57cec5SDimitry Andric         << '\'' << EntryFunc << "\' function not found in module.\n";
6410b57cec5SDimitry Andric     return -1;
6420b57cec5SDimitry Andric   }
6430b57cec5SDimitry Andric 
6440b57cec5SDimitry Andric   // Reset errno to zero on entry to main.
6450b57cec5SDimitry Andric   errno = 0;
6460b57cec5SDimitry Andric 
6470b57cec5SDimitry Andric   int Result = -1;
6480b57cec5SDimitry Andric 
6490b57cec5SDimitry Andric   // Sanity check use of remote-jit: LLI currently only supports use of the
6500b57cec5SDimitry Andric   // remote JIT on Unix platforms.
6510b57cec5SDimitry Andric   if (RemoteMCJIT) {
6520b57cec5SDimitry Andric #ifndef LLVM_ON_UNIX
6530b57cec5SDimitry Andric     WithColor::warning(errs(), argv[0])
6540b57cec5SDimitry Andric         << "host does not support external remote targets.\n";
6550b57cec5SDimitry Andric     WithColor::note() << "defaulting to local execution\n";
6560b57cec5SDimitry Andric     return -1;
6570b57cec5SDimitry Andric #else
6580b57cec5SDimitry Andric     if (ChildExecPath.empty()) {
6590b57cec5SDimitry Andric       WithColor::error(errs(), argv[0])
6600b57cec5SDimitry Andric           << "-remote-mcjit requires -mcjit-remote-process.\n";
6610b57cec5SDimitry Andric       exit(1);
6620b57cec5SDimitry Andric     } else if (!sys::fs::can_execute(ChildExecPath)) {
6630b57cec5SDimitry Andric       WithColor::error(errs(), argv[0])
6640b57cec5SDimitry Andric           << "unable to find usable child executable: '" << ChildExecPath
6650b57cec5SDimitry Andric           << "'\n";
6660b57cec5SDimitry Andric       return -1;
6670b57cec5SDimitry Andric     }
6680b57cec5SDimitry Andric #endif
6690b57cec5SDimitry Andric   }
6700b57cec5SDimitry Andric 
6710b57cec5SDimitry Andric   if (!RemoteMCJIT) {
6720b57cec5SDimitry Andric     // If the program doesn't explicitly call exit, we will need the Exit
6730b57cec5SDimitry Andric     // function later on to make an explicit call, so get the function now.
6740b57cec5SDimitry Andric     FunctionCallee Exit = Mod->getOrInsertFunction(
6750b57cec5SDimitry Andric         "exit", Type::getVoidTy(Context), Type::getInt32Ty(Context));
6760b57cec5SDimitry Andric 
6770b57cec5SDimitry Andric     // Run static constructors.
6780b57cec5SDimitry Andric     if (!ForceInterpreter) {
6790b57cec5SDimitry Andric       // Give MCJIT a chance to apply relocations and set page permissions.
6800b57cec5SDimitry Andric       EE->finalizeObject();
6810b57cec5SDimitry Andric     }
6820b57cec5SDimitry Andric     EE->runStaticConstructorsDestructors(false);
6830b57cec5SDimitry Andric 
6840b57cec5SDimitry Andric     // Trigger compilation separately so code regions that need to be
6850b57cec5SDimitry Andric     // invalidated will be known.
6860b57cec5SDimitry Andric     (void)EE->getPointerToFunction(EntryFn);
6870b57cec5SDimitry Andric     // Clear instruction cache before code will be executed.
6880b57cec5SDimitry Andric     if (RTDyldMM)
6890b57cec5SDimitry Andric       static_cast<SectionMemoryManager*>(RTDyldMM)->invalidateInstructionCache();
6900b57cec5SDimitry Andric 
6910b57cec5SDimitry Andric     // Run main.
6920b57cec5SDimitry Andric     Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
6930b57cec5SDimitry Andric 
6940b57cec5SDimitry Andric     // Run static destructors.
6950b57cec5SDimitry Andric     EE->runStaticConstructorsDestructors(true);
6960b57cec5SDimitry Andric 
6970b57cec5SDimitry Andric     // If the program didn't call exit explicitly, we should call it now.
6980b57cec5SDimitry Andric     // This ensures that any atexit handlers get called correctly.
6990b57cec5SDimitry Andric     if (Function *ExitF =
7000b57cec5SDimitry Andric             dyn_cast<Function>(Exit.getCallee()->stripPointerCasts())) {
7010b57cec5SDimitry Andric       if (ExitF->getFunctionType() == Exit.getFunctionType()) {
7020b57cec5SDimitry Andric         std::vector<GenericValue> Args;
7030b57cec5SDimitry Andric         GenericValue ResultGV;
7040b57cec5SDimitry Andric         ResultGV.IntVal = APInt(32, Result);
7050b57cec5SDimitry Andric         Args.push_back(ResultGV);
7060b57cec5SDimitry Andric         EE->runFunction(ExitF, Args);
7070b57cec5SDimitry Andric         WithColor::error(errs(), argv[0])
7080b57cec5SDimitry Andric             << "exit(" << Result << ") returned!\n";
7090b57cec5SDimitry Andric         abort();
7100b57cec5SDimitry Andric       }
7110b57cec5SDimitry Andric     }
7120b57cec5SDimitry Andric     WithColor::error(errs(), argv[0]) << "exit defined with wrong prototype!\n";
7130b57cec5SDimitry Andric     abort();
7140b57cec5SDimitry Andric   } else {
7150b57cec5SDimitry Andric     // else == "if (RemoteMCJIT)"
71606c3fb27SDimitry Andric     std::unique_ptr<orc::ExecutorProcessControl> EPC = ExitOnErr(launchRemote());
7170b57cec5SDimitry Andric 
7180b57cec5SDimitry Andric     // Remote target MCJIT doesn't (yet) support static constructors. No reason
7190b57cec5SDimitry Andric     // it couldn't. This is a limitation of the LLI implementation, not the
7200b57cec5SDimitry Andric     // MCJIT itself. FIXME.
7210b57cec5SDimitry Andric 
7220b57cec5SDimitry Andric     // Create a remote memory manager.
723349cc55cSDimitry Andric     auto RemoteMM = ExitOnErr(
724349cc55cSDimitry Andric         orc::EPCGenericRTDyldMemoryManager::CreateWithDefaultBootstrapSymbols(
725349cc55cSDimitry Andric             *EPC));
7260b57cec5SDimitry Andric 
7270b57cec5SDimitry Andric     // Forward MCJIT's memory manager calls to the remote memory manager.
7280b57cec5SDimitry Andric     static_cast<ForwardingMemoryManager*>(RTDyldMM)->setMemMgr(
7290b57cec5SDimitry Andric       std::move(RemoteMM));
7300b57cec5SDimitry Andric 
7310b57cec5SDimitry Andric     // Forward MCJIT's symbol resolution calls to the remote.
7320b57cec5SDimitry Andric     static_cast<ForwardingMemoryManager *>(RTDyldMM)->setResolver(
733349cc55cSDimitry Andric         ExitOnErr(RemoteResolver::Create(*EPC)));
7340b57cec5SDimitry Andric     // Grab the target address of the JIT'd main function on the remote and call
7350b57cec5SDimitry Andric     // it.
7360b57cec5SDimitry Andric     // FIXME: argv and envp handling.
737349cc55cSDimitry Andric     auto Entry =
738349cc55cSDimitry Andric         orc::ExecutorAddr(EE->getFunctionAddress(EntryFn->getName().str()));
7390b57cec5SDimitry Andric     EE->finalizeObject();
7400b57cec5SDimitry Andric     LLVM_DEBUG(dbgs() << "Executing '" << EntryFn->getName() << "' at 0x"
741349cc55cSDimitry Andric                       << format("%llx", Entry.getValue()) << "\n");
742349cc55cSDimitry Andric     Result = ExitOnErr(EPC->runAsMain(Entry, {}));
7430b57cec5SDimitry Andric 
7440b57cec5SDimitry Andric     // Like static constructors, the remote target MCJIT support doesn't handle
7450b57cec5SDimitry Andric     // this yet. It could. FIXME.
7460b57cec5SDimitry Andric 
7470b57cec5SDimitry Andric     // Delete the EE - we need to tear it down *before* we terminate the session
7480b57cec5SDimitry Andric     // with the remote, otherwise it'll crash when it tries to release resources
7490b57cec5SDimitry Andric     // on a remote that has already been disconnected.
7500b57cec5SDimitry Andric     EE.reset();
7510b57cec5SDimitry Andric 
7520b57cec5SDimitry Andric     // Signal the remote target that we're done JITing.
753349cc55cSDimitry Andric     ExitOnErr(EPC->disconnect());
7540b57cec5SDimitry Andric   }
7550b57cec5SDimitry Andric 
7560b57cec5SDimitry Andric   return Result;
7570b57cec5SDimitry Andric }
7580b57cec5SDimitry Andric 
7598bcb0991SDimitry Andric static std::function<void(Module &)> createDebugDumper() {
7600b57cec5SDimitry Andric   switch (OrcDumpKind) {
7610b57cec5SDimitry Andric   case DumpKind::NoDump:
7628bcb0991SDimitry Andric     return [](Module &M) {};
7630b57cec5SDimitry Andric 
7640b57cec5SDimitry Andric   case DumpKind::DumpFuncsToStdOut:
7658bcb0991SDimitry Andric     return [](Module &M) {
7660b57cec5SDimitry Andric       printf("[ ");
7670b57cec5SDimitry Andric 
7688bcb0991SDimitry Andric       for (const auto &F : M) {
7690b57cec5SDimitry Andric         if (F.isDeclaration())
7700b57cec5SDimitry Andric           continue;
7710b57cec5SDimitry Andric 
7720b57cec5SDimitry Andric         if (F.hasName()) {
7735ffd83dbSDimitry Andric           std::string Name(std::string(F.getName()));
7740b57cec5SDimitry Andric           printf("%s ", Name.c_str());
7750b57cec5SDimitry Andric         } else
7760b57cec5SDimitry Andric           printf("<anon> ");
7770b57cec5SDimitry Andric       }
7780b57cec5SDimitry Andric 
7790b57cec5SDimitry Andric       printf("]\n");
7800b57cec5SDimitry Andric     };
7810b57cec5SDimitry Andric 
7820b57cec5SDimitry Andric   case DumpKind::DumpModsToStdOut:
7838bcb0991SDimitry Andric     return [](Module &M) {
7848bcb0991SDimitry Andric       outs() << "----- Module Start -----\n" << M << "----- Module End -----\n";
7850b57cec5SDimitry Andric     };
7860b57cec5SDimitry Andric 
7870b57cec5SDimitry Andric   case DumpKind::DumpModsToDisk:
7888bcb0991SDimitry Andric     return [](Module &M) {
7890b57cec5SDimitry Andric       std::error_code EC;
790fe6060f1SDimitry Andric       raw_fd_ostream Out(M.getModuleIdentifier() + ".ll", EC,
791fe6060f1SDimitry Andric                          sys::fs::OF_TextWithCRLF);
7920b57cec5SDimitry Andric       if (EC) {
7938bcb0991SDimitry Andric         errs() << "Couldn't open " << M.getModuleIdentifier()
7940b57cec5SDimitry Andric                << " for dumping.\nError:" << EC.message() << "\n";
7950b57cec5SDimitry Andric         exit(1);
7960b57cec5SDimitry Andric       }
7978bcb0991SDimitry Andric       Out << M;
7980b57cec5SDimitry Andric     };
7990b57cec5SDimitry Andric   }
8000b57cec5SDimitry Andric   llvm_unreachable("Unknown DumpKind");
8010b57cec5SDimitry Andric }
8020b57cec5SDimitry Andric 
8035ffd83dbSDimitry Andric Error loadDylibs() {
8045ffd83dbSDimitry Andric   for (const auto &Dylib : Dylibs) {
8055ffd83dbSDimitry Andric     std::string ErrMsg;
8065ffd83dbSDimitry Andric     if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
8075ffd83dbSDimitry Andric       return make_error<StringError>(ErrMsg, inconvertibleErrorCode());
8085ffd83dbSDimitry Andric   }
8095ffd83dbSDimitry Andric 
8105ffd83dbSDimitry Andric   return Error::success();
8115ffd83dbSDimitry Andric }
8125ffd83dbSDimitry Andric 
8130b57cec5SDimitry Andric static void exitOnLazyCallThroughFailure() { exit(1); }
8140b57cec5SDimitry Andric 
8155ffd83dbSDimitry Andric Expected<orc::ThreadSafeModule>
8165ffd83dbSDimitry Andric loadModule(StringRef Path, orc::ThreadSafeContext TSCtx) {
8175ffd83dbSDimitry Andric   SMDiagnostic Err;
8185ffd83dbSDimitry Andric   auto M = parseIRFile(Path, Err, *TSCtx.getContext());
8195ffd83dbSDimitry Andric   if (!M) {
8205ffd83dbSDimitry Andric     std::string ErrMsg;
8215ffd83dbSDimitry Andric     {
8225ffd83dbSDimitry Andric       raw_string_ostream ErrMsgStream(ErrMsg);
8235ffd83dbSDimitry Andric       Err.print("lli", ErrMsgStream);
8245ffd83dbSDimitry Andric     }
8255ffd83dbSDimitry Andric     return make_error<StringError>(std::move(ErrMsg), inconvertibleErrorCode());
8265ffd83dbSDimitry Andric   }
8275ffd83dbSDimitry Andric 
8285ffd83dbSDimitry Andric   if (EnableCacheManager)
8295ffd83dbSDimitry Andric     M->setModuleIdentifier("file:" + M->getModuleIdentifier());
8305ffd83dbSDimitry Andric 
8315ffd83dbSDimitry Andric   return orc::ThreadSafeModule(std::move(M), std::move(TSCtx));
8325ffd83dbSDimitry Andric }
8335ffd83dbSDimitry Andric 
83406c3fb27SDimitry Andric int mingw_noop_main(void) {
83506c3fb27SDimitry Andric   // Cygwin and MinGW insert calls from the main function to the runtime
83606c3fb27SDimitry Andric   // function __main. The __main function is responsible for setting up main's
83706c3fb27SDimitry Andric   // environment (e.g. running static constructors), however this is not needed
83806c3fb27SDimitry Andric   // when running under lli: the executor process will have run non-JIT ctors,
83906c3fb27SDimitry Andric   // and ORC will take care of running JIT'd ctors. To avoid a missing symbol
84006c3fb27SDimitry Andric   // error we just implement __main as a no-op.
84106c3fb27SDimitry Andric   //
84206c3fb27SDimitry Andric   // FIXME: Move this to ORC-RT (and the ORC-RT substitution library once it
84306c3fb27SDimitry Andric   //        exists). That will allow it to work out-of-process, and for all
84406c3fb27SDimitry Andric   //        ORC tools (the problem isn't lli specific).
84506c3fb27SDimitry Andric   return 0;
84606c3fb27SDimitry Andric }
84706c3fb27SDimitry Andric 
8485f757f3fSDimitry Andric // Try to enable debugger support for the given instance.
8495f757f3fSDimitry Andric // This alway returns success, but prints a warning if it's not able to enable
8505f757f3fSDimitry Andric // debugger support.
8515f757f3fSDimitry Andric Error tryEnableDebugSupport(orc::LLJIT &J) {
8525f757f3fSDimitry Andric   if (auto Err = enableDebuggerSupport(J)) {
8535f757f3fSDimitry Andric     [[maybe_unused]] std::string ErrMsg = toString(std::move(Err));
8545f757f3fSDimitry Andric     LLVM_DEBUG(dbgs() << "lli: " << ErrMsg << "\n");
8555f757f3fSDimitry Andric   }
8565f757f3fSDimitry Andric   return Error::success();
8575f757f3fSDimitry Andric }
8585f757f3fSDimitry Andric 
859fe6060f1SDimitry Andric int runOrcJIT(const char *ProgName) {
8600b57cec5SDimitry Andric   // Start setting up the JIT environment.
8610b57cec5SDimitry Andric 
8620b57cec5SDimitry Andric   // Parse the main module.
8638bcb0991SDimitry Andric   orc::ThreadSafeContext TSCtx(std::make_unique<LLVMContext>());
8645ffd83dbSDimitry Andric   auto MainModule = ExitOnErr(loadModule(InputFile, TSCtx));
8650b57cec5SDimitry Andric 
8665ffd83dbSDimitry Andric   // Get TargetTriple and DataLayout from the main module if they're explicitly
8675ffd83dbSDimitry Andric   // set.
868bdd1243dSDimitry Andric   std::optional<Triple> TT;
869bdd1243dSDimitry Andric   std::optional<DataLayout> DL;
8705ffd83dbSDimitry Andric   MainModule.withModuleDo([&](Module &M) {
8715ffd83dbSDimitry Andric       if (!M.getTargetTriple().empty())
8725ffd83dbSDimitry Andric         TT = Triple(M.getTargetTriple());
8735ffd83dbSDimitry Andric       if (!M.getDataLayout().isDefault())
8745ffd83dbSDimitry Andric         DL = M.getDataLayout();
8755ffd83dbSDimitry Andric     });
8765ffd83dbSDimitry Andric 
8770b57cec5SDimitry Andric   orc::LLLazyJITBuilder Builder;
8780b57cec5SDimitry Andric 
8790b57cec5SDimitry Andric   Builder.setJITTargetMachineBuilder(
8805ffd83dbSDimitry Andric       TT ? orc::JITTargetMachineBuilder(*TT)
8815ffd83dbSDimitry Andric          : ExitOnErr(orc::JITTargetMachineBuilder::detectHost()));
8820b57cec5SDimitry Andric 
8835ffd83dbSDimitry Andric   TT = Builder.getJITTargetMachineBuilder()->getTargetTriple();
8845ffd83dbSDimitry Andric   if (DL)
8855ffd83dbSDimitry Andric     Builder.setDataLayout(DL);
8865ffd83dbSDimitry Andric 
8875ffd83dbSDimitry Andric   if (!codegen::getMArch().empty())
8885ffd83dbSDimitry Andric     Builder.getJITTargetMachineBuilder()->getTargetTriple().setArchName(
8895ffd83dbSDimitry Andric         codegen::getMArch());
8900b57cec5SDimitry Andric 
8910b57cec5SDimitry Andric   Builder.getJITTargetMachineBuilder()
8925ffd83dbSDimitry Andric       ->setCPU(codegen::getCPUStr())
8935ffd83dbSDimitry Andric       .addFeatures(codegen::getFeatureList())
8945ffd83dbSDimitry Andric       .setRelocationModel(codegen::getExplicitRelocModel())
8955ffd83dbSDimitry Andric       .setCodeModel(codegen::getExplicitCodeModel());
8960b57cec5SDimitry Andric 
89706c3fb27SDimitry Andric   // Link process symbols unless NoProcessSymbols is set.
89806c3fb27SDimitry Andric   Builder.setLinkProcessSymbolsByDefault(!NoProcessSymbols);
89906c3fb27SDimitry Andric 
900fe6060f1SDimitry Andric   // FIXME: Setting a dummy call-through manager in non-lazy mode prevents the
901fe6060f1SDimitry Andric   // JIT builder to instantiate a default (which would fail with an error for
902fe6060f1SDimitry Andric   // unsupported architectures).
903fe6060f1SDimitry Andric   if (UseJITKind != JITKind::OrcLazy) {
904fe6060f1SDimitry Andric     auto ES = std::make_unique<orc::ExecutionSession>(
905fe6060f1SDimitry Andric         ExitOnErr(orc::SelfExecutorProcessControl::Create()));
906fe6060f1SDimitry Andric     Builder.setLazyCallthroughManager(
90706c3fb27SDimitry Andric         std::make_unique<orc::LazyCallThroughManager>(*ES, orc::ExecutorAddr(),
90806c3fb27SDimitry Andric                                                       nullptr));
909fe6060f1SDimitry Andric     Builder.setExecutionSession(std::move(ES));
910fe6060f1SDimitry Andric   }
911fe6060f1SDimitry Andric 
9120b57cec5SDimitry Andric   Builder.setLazyCompileFailureAddr(
91381ad6265SDimitry Andric       orc::ExecutorAddr::fromPtr(exitOnLazyCallThroughFailure));
9140b57cec5SDimitry Andric   Builder.setNumCompileThreads(LazyJITCompileThreads);
9150b57cec5SDimitry Andric 
9165ffd83dbSDimitry Andric   // If the object cache is enabled then set a custom compile function
9175ffd83dbSDimitry Andric   // creator to use the cache.
9185ffd83dbSDimitry Andric   std::unique_ptr<LLIObjectCache> CacheManager;
9195ffd83dbSDimitry Andric   if (EnableCacheManager) {
9205ffd83dbSDimitry Andric 
9215ffd83dbSDimitry Andric     CacheManager = std::make_unique<LLIObjectCache>(ObjectCacheDir);
9225ffd83dbSDimitry Andric 
9235ffd83dbSDimitry Andric     Builder.setCompileFunctionCreator(
9245ffd83dbSDimitry Andric       [&](orc::JITTargetMachineBuilder JTMB)
9255ffd83dbSDimitry Andric             -> Expected<std::unique_ptr<orc::IRCompileLayer::IRCompiler>> {
9265ffd83dbSDimitry Andric         if (LazyJITCompileThreads > 0)
9275ffd83dbSDimitry Andric           return std::make_unique<orc::ConcurrentIRCompiler>(std::move(JTMB),
9285ffd83dbSDimitry Andric                                                         CacheManager.get());
9295ffd83dbSDimitry Andric 
9305ffd83dbSDimitry Andric         auto TM = JTMB.createTargetMachine();
9315ffd83dbSDimitry Andric         if (!TM)
9325ffd83dbSDimitry Andric           return TM.takeError();
9335ffd83dbSDimitry Andric 
9345ffd83dbSDimitry Andric         return std::make_unique<orc::TMOwningSimpleCompiler>(std::move(*TM),
9355ffd83dbSDimitry Andric                                                         CacheManager.get());
9365ffd83dbSDimitry Andric       });
9375ffd83dbSDimitry Andric   }
9385ffd83dbSDimitry Andric 
9395f757f3fSDimitry Andric   // Enable debugging of JIT'd code (only works on JITLink for ELF and MachO).
9405f757f3fSDimitry Andric   Builder.setPrePlatformSetup(tryEnableDebugSupport);
9415f757f3fSDimitry Andric 
9425ffd83dbSDimitry Andric   // Set up LLJIT platform.
9435ffd83dbSDimitry Andric   LLJITPlatform P = Platform;
94406c3fb27SDimitry Andric   if (P == LLJITPlatform::Auto)
94506c3fb27SDimitry Andric     P = OrcRuntime.empty() ? LLJITPlatform::GenericIR
94606c3fb27SDimitry Andric                            : LLJITPlatform::ExecutorNative;
94706c3fb27SDimitry Andric 
9485ffd83dbSDimitry Andric   switch (P) {
94906c3fb27SDimitry Andric   case LLJITPlatform::ExecutorNative: {
95006c3fb27SDimitry Andric     Builder.setPlatformSetUp(orc::ExecutorNativePlatform(OrcRuntime));
95181ad6265SDimitry Andric     break;
95206c3fb27SDimitry Andric   }
9535ffd83dbSDimitry Andric   case LLJITPlatform::GenericIR:
9545ffd83dbSDimitry Andric     // Nothing to do: LLJITBuilder will use this by default.
9555ffd83dbSDimitry Andric     break;
956fe6060f1SDimitry Andric   case LLJITPlatform::Inactive:
957fe6060f1SDimitry Andric     Builder.setPlatformSetUp(orc::setUpInactivePlatform);
9585ffd83dbSDimitry Andric     break;
9595ffd83dbSDimitry Andric   default:
9605ffd83dbSDimitry Andric     llvm_unreachable("Unrecognized platform value");
9615ffd83dbSDimitry Andric   }
9625ffd83dbSDimitry Andric 
963fe6060f1SDimitry Andric   std::unique_ptr<orc::ExecutorProcessControl> EPC = nullptr;
964fe6060f1SDimitry Andric   if (JITLinker == JITLinkerKind::JITLink) {
965fe6060f1SDimitry Andric     EPC = ExitOnErr(orc::SelfExecutorProcessControl::Create(
966fe6060f1SDimitry Andric         std::make_shared<orc::SymbolStringPool>()));
967fe6060f1SDimitry Andric 
968*1db9f3b2SDimitry Andric     Builder.getJITTargetMachineBuilder()
969*1db9f3b2SDimitry Andric         ->setRelocationModel(Reloc::PIC_)
970*1db9f3b2SDimitry Andric         .setCodeModel(CodeModel::Small);
971*1db9f3b2SDimitry Andric     Builder.setObjectLinkingLayerCreator([&P](orc::ExecutionSession &ES,
97281ad6265SDimitry Andric                                               const Triple &TT) {
973*1db9f3b2SDimitry Andric       auto L = std::make_unique<orc::ObjectLinkingLayer>(ES);
97406c3fb27SDimitry Andric       if (P != LLJITPlatform::ExecutorNative)
975fe6060f1SDimitry Andric         L->addPlugin(std::make_unique<orc::EHFrameRegistrationPlugin>(
976fe6060f1SDimitry Andric             ES, ExitOnErr(orc::EPCEHFrameRegistrar::Create(ES))));
977fe6060f1SDimitry Andric       return L;
978fe6060f1SDimitry Andric     });
979fe6060f1SDimitry Andric   }
980fe6060f1SDimitry Andric 
9810b57cec5SDimitry Andric   auto J = ExitOnErr(Builder.create());
9820b57cec5SDimitry Andric 
983fe6060f1SDimitry Andric   auto *ObjLayer = &J->getObjLinkingLayer();
98406c3fb27SDimitry Andric   if (auto *RTDyldObjLayer = dyn_cast<orc::RTDyldObjectLinkingLayer>(ObjLayer)) {
985fe6060f1SDimitry Andric     RTDyldObjLayer->registerJITEventListener(
9865ffd83dbSDimitry Andric         *JITEventListener::createGDBRegistrationListener());
98706c3fb27SDimitry Andric #if LLVM_USE_OPROFILE
98806c3fb27SDimitry Andric     RTDyldObjLayer->registerJITEventListener(
98906c3fb27SDimitry Andric         *JITEventListener::createOProfileJITEventListener());
99006c3fb27SDimitry Andric #endif
99106c3fb27SDimitry Andric #if LLVM_USE_INTEL_JITEVENTS
99206c3fb27SDimitry Andric     RTDyldObjLayer->registerJITEventListener(
99306c3fb27SDimitry Andric         *JITEventListener::createIntelJITEventListener());
99406c3fb27SDimitry Andric #endif
99506c3fb27SDimitry Andric #if LLVM_USE_PERF
99606c3fb27SDimitry Andric     RTDyldObjLayer->registerJITEventListener(
99706c3fb27SDimitry Andric         *JITEventListener::createPerfJITEventListener());
99806c3fb27SDimitry Andric #endif
99906c3fb27SDimitry Andric   }
10005ffd83dbSDimitry Andric 
10010b57cec5SDimitry Andric   if (PerModuleLazy)
10020b57cec5SDimitry Andric     J->setPartitionFunction(orc::CompileOnDemandLayer::compileWholeModule);
10030b57cec5SDimitry Andric 
10040b57cec5SDimitry Andric   auto Dump = createDebugDumper();
10050b57cec5SDimitry Andric 
10065ffd83dbSDimitry Andric   J->getIRTransformLayer().setTransform(
10075ffd83dbSDimitry Andric       [&](orc::ThreadSafeModule TSM,
10080b57cec5SDimitry Andric           const orc::MaterializationResponsibility &R) {
10098bcb0991SDimitry Andric         TSM.withModuleDo([&](Module &M) {
10108bcb0991SDimitry Andric           if (verifyModule(M, &dbgs())) {
10118bcb0991SDimitry Andric             dbgs() << "Bad module: " << &M << "\n";
10120b57cec5SDimitry Andric             exit(1);
10130b57cec5SDimitry Andric           }
10148bcb0991SDimitry Andric           Dump(M);
10150b57cec5SDimitry Andric         });
10168bcb0991SDimitry Andric         return TSM;
10178bcb0991SDimitry Andric       });
10180b57cec5SDimitry Andric 
101906c3fb27SDimitry Andric   if (GenerateBuiltinFunctions.size() > 0) {
102006c3fb27SDimitry Andric     // Add LLI builtins.
10210b57cec5SDimitry Andric     orc::MangleAndInterner Mangle(J->getExecutionSession(), J->getDataLayout());
1022fe6060f1SDimitry Andric     J->getMainJITDylib().addGenerator(
1023fe6060f1SDimitry Andric         std::make_unique<LLIBuiltinFunctionGenerator>(GenerateBuiltinFunctions,
1024fe6060f1SDimitry Andric                                                       Mangle));
102506c3fb27SDimitry Andric   }
1026fe6060f1SDimitry Andric 
102706c3fb27SDimitry Andric   // If this is a Mingw or Cygwin executor then we need to alias __main to
102806c3fb27SDimitry Andric   // orc_rt_int_void_return_0.
102906c3fb27SDimitry Andric   if (J->getTargetTriple().isOSCygMing())
103006c3fb27SDimitry Andric     ExitOnErr(J->getProcessSymbolsJITDylib()->define(
103106c3fb27SDimitry Andric         orc::absoluteSymbols({{J->mangleAndIntern("__main"),
103206c3fb27SDimitry Andric                                {orc::ExecutorAddr::fromPtr(mingw_noop_main),
103306c3fb27SDimitry Andric                                 JITSymbolFlags::Exported}}})));
103481ad6265SDimitry Andric 
1035fe6060f1SDimitry Andric   // Regular modules are greedy: They materialize as a whole and trigger
1036fe6060f1SDimitry Andric   // materialization for all required symbols recursively. Lazy modules go
1037fe6060f1SDimitry Andric   // through partitioning and they replace outgoing calls with reexport stubs
1038fe6060f1SDimitry Andric   // that resolve on call-through.
1039fe6060f1SDimitry Andric   auto AddModule = [&](orc::JITDylib &JD, orc::ThreadSafeModule M) {
1040fe6060f1SDimitry Andric     return UseJITKind == JITKind::OrcLazy ? J->addLazyIRModule(JD, std::move(M))
1041fe6060f1SDimitry Andric                                           : J->addIRModule(JD, std::move(M));
1042fe6060f1SDimitry Andric   };
1043fe6060f1SDimitry Andric 
10440b57cec5SDimitry Andric   // Add the main module.
1045fe6060f1SDimitry Andric   ExitOnErr(AddModule(J->getMainJITDylib(), std::move(MainModule)));
10460b57cec5SDimitry Andric 
10470b57cec5SDimitry Andric   // Create JITDylibs and add any extra modules.
10480b57cec5SDimitry Andric   {
10490b57cec5SDimitry Andric     // Create JITDylibs, keep a map from argument index to dylib. We will use
10500b57cec5SDimitry Andric     // -extra-module argument indexes to determine what dylib to use for each
10510b57cec5SDimitry Andric     // -extra-module.
10520b57cec5SDimitry Andric     std::map<unsigned, orc::JITDylib *> IdxToDylib;
10530b57cec5SDimitry Andric     IdxToDylib[0] = &J->getMainJITDylib();
10540b57cec5SDimitry Andric     for (auto JDItr = JITDylibs.begin(), JDEnd = JITDylibs.end();
10550b57cec5SDimitry Andric          JDItr != JDEnd; ++JDItr) {
10560b57cec5SDimitry Andric       orc::JITDylib *JD = J->getJITDylibByName(*JDItr);
10575ffd83dbSDimitry Andric       if (!JD) {
10585ffd83dbSDimitry Andric         JD = &ExitOnErr(J->createJITDylib(*JDItr));
10595ffd83dbSDimitry Andric         J->getMainJITDylib().addToLinkOrder(*JD);
10605ffd83dbSDimitry Andric         JD->addToLinkOrder(J->getMainJITDylib());
10615ffd83dbSDimitry Andric       }
10620b57cec5SDimitry Andric       IdxToDylib[JITDylibs.getPosition(JDItr - JITDylibs.begin())] = JD;
10630b57cec5SDimitry Andric     }
10640b57cec5SDimitry Andric 
10650b57cec5SDimitry Andric     for (auto EMItr = ExtraModules.begin(), EMEnd = ExtraModules.end();
10660b57cec5SDimitry Andric          EMItr != EMEnd; ++EMItr) {
10675ffd83dbSDimitry Andric       auto M = ExitOnErr(loadModule(*EMItr, TSCtx));
10680b57cec5SDimitry Andric 
10690b57cec5SDimitry Andric       auto EMIdx = ExtraModules.getPosition(EMItr - ExtraModules.begin());
10700b57cec5SDimitry Andric       assert(EMIdx != 0 && "ExtraModule should have index > 0");
10710b57cec5SDimitry Andric       auto JDItr = std::prev(IdxToDylib.lower_bound(EMIdx));
10720b57cec5SDimitry Andric       auto &JD = *JDItr->second;
1073fe6060f1SDimitry Andric       ExitOnErr(AddModule(JD, std::move(M)));
10740b57cec5SDimitry Andric     }
10758bcb0991SDimitry Andric 
10768bcb0991SDimitry Andric     for (auto EAItr = ExtraArchives.begin(), EAEnd = ExtraArchives.end();
10778bcb0991SDimitry Andric          EAItr != EAEnd; ++EAItr) {
10788bcb0991SDimitry Andric       auto EAIdx = ExtraArchives.getPosition(EAItr - ExtraArchives.begin());
10798bcb0991SDimitry Andric       assert(EAIdx != 0 && "ExtraArchive should have index > 0");
10808bcb0991SDimitry Andric       auto JDItr = std::prev(IdxToDylib.lower_bound(EAIdx));
10818bcb0991SDimitry Andric       auto &JD = *JDItr->second;
108206c3fb27SDimitry Andric       ExitOnErr(J->linkStaticLibraryInto(JD, EAItr->c_str()));
10838bcb0991SDimitry Andric     }
10840b57cec5SDimitry Andric   }
10850b57cec5SDimitry Andric 
10860b57cec5SDimitry Andric   // Add the objects.
10870b57cec5SDimitry Andric   for (auto &ObjPath : ExtraObjects) {
10880b57cec5SDimitry Andric     auto Obj = ExitOnErr(errorOrToExpected(MemoryBuffer::getFile(ObjPath)));
10890b57cec5SDimitry Andric     ExitOnErr(J->addObjectFile(std::move(Obj)));
10900b57cec5SDimitry Andric   }
10910b57cec5SDimitry Andric 
10920b57cec5SDimitry Andric   // Run any static constructors.
10935ffd83dbSDimitry Andric   ExitOnErr(J->initialize(J->getMainJITDylib()));
10940b57cec5SDimitry Andric 
10950b57cec5SDimitry Andric   // Run any -thread-entry points.
10960b57cec5SDimitry Andric   std::vector<std::thread> AltEntryThreads;
10970b57cec5SDimitry Andric   for (auto &ThreadEntryPoint : ThreadEntryPoints) {
10980b57cec5SDimitry Andric     auto EntryPointSym = ExitOnErr(J->lookup(ThreadEntryPoint));
10990b57cec5SDimitry Andric     typedef void (*EntryPointPtr)();
110081ad6265SDimitry Andric     auto EntryPoint = EntryPointSym.toPtr<EntryPointPtr>();
11010b57cec5SDimitry Andric     AltEntryThreads.push_back(std::thread([EntryPoint]() { EntryPoint(); }));
11020b57cec5SDimitry Andric   }
11030b57cec5SDimitry Andric 
1104fe6060f1SDimitry Andric   // Resolve and run the main function.
110581ad6265SDimitry Andric   auto MainAddr = ExitOnErr(J->lookup(EntryFunc));
1106fe6060f1SDimitry Andric   int Result;
11070b57cec5SDimitry Andric 
1108fe6060f1SDimitry Andric   if (EPC) {
1109fe6060f1SDimitry Andric     // ExecutorProcessControl-based execution with JITLink.
111081ad6265SDimitry Andric     Result = ExitOnErr(EPC->runAsMain(MainAddr, InputArgv));
1111fe6060f1SDimitry Andric   } else {
1112fe6060f1SDimitry Andric     // Manual in-process execution with RuntimeDyld.
1113fe6060f1SDimitry Andric     using MainFnTy = int(int, char *[]);
111481ad6265SDimitry Andric     auto MainFn = MainAddr.toPtr<MainFnTy *>();
1115fe6060f1SDimitry Andric     Result = orc::runAsMain(MainFn, InputArgv, StringRef(InputFile));
1116fe6060f1SDimitry Andric   }
11170b57cec5SDimitry Andric 
11180b57cec5SDimitry Andric   // Wait for -entry-point threads.
11190b57cec5SDimitry Andric   for (auto &AltEntryThread : AltEntryThreads)
11200b57cec5SDimitry Andric     AltEntryThread.join();
11210b57cec5SDimitry Andric 
11220b57cec5SDimitry Andric   // Run destructors.
11235ffd83dbSDimitry Andric   ExitOnErr(J->deinitialize(J->getMainJITDylib()));
11240b57cec5SDimitry Andric 
11250b57cec5SDimitry Andric   return Result;
11260b57cec5SDimitry Andric }
11270b57cec5SDimitry Andric 
11280b57cec5SDimitry Andric void disallowOrcOptions() {
11290b57cec5SDimitry Andric   // Make sure nobody used an orc-lazy specific option accidentally.
11300b57cec5SDimitry Andric 
11310b57cec5SDimitry Andric   if (LazyJITCompileThreads != 0) {
11320b57cec5SDimitry Andric     errs() << "-compile-threads requires -jit-kind=orc-lazy\n";
11330b57cec5SDimitry Andric     exit(1);
11340b57cec5SDimitry Andric   }
11350b57cec5SDimitry Andric 
11360b57cec5SDimitry Andric   if (!ThreadEntryPoints.empty()) {
11370b57cec5SDimitry Andric     errs() << "-thread-entry requires -jit-kind=orc-lazy\n";
11380b57cec5SDimitry Andric     exit(1);
11390b57cec5SDimitry Andric   }
11400b57cec5SDimitry Andric 
11410b57cec5SDimitry Andric   if (PerModuleLazy) {
11420b57cec5SDimitry Andric     errs() << "-per-module-lazy requires -jit-kind=orc-lazy\n";
11430b57cec5SDimitry Andric     exit(1);
11440b57cec5SDimitry Andric   }
11450b57cec5SDimitry Andric }
11460b57cec5SDimitry Andric 
1147349cc55cSDimitry Andric Expected<std::unique_ptr<orc::ExecutorProcessControl>> launchRemote() {
11480b57cec5SDimitry Andric #ifndef LLVM_ON_UNIX
11490b57cec5SDimitry Andric   llvm_unreachable("launchRemote not supported on non-Unix platforms");
11500b57cec5SDimitry Andric #else
11510b57cec5SDimitry Andric   int PipeFD[2][2];
11520b57cec5SDimitry Andric   pid_t ChildPID;
11530b57cec5SDimitry Andric 
11540b57cec5SDimitry Andric   // Create two pipes.
11550b57cec5SDimitry Andric   if (pipe(PipeFD[0]) != 0 || pipe(PipeFD[1]) != 0)
11560b57cec5SDimitry Andric     perror("Error creating pipe: ");
11570b57cec5SDimitry Andric 
11580b57cec5SDimitry Andric   ChildPID = fork();
11590b57cec5SDimitry Andric 
11600b57cec5SDimitry Andric   if (ChildPID == 0) {
11610b57cec5SDimitry Andric     // In the child...
11620b57cec5SDimitry Andric 
11630b57cec5SDimitry Andric     // Close the parent ends of the pipes
11640b57cec5SDimitry Andric     close(PipeFD[0][1]);
11650b57cec5SDimitry Andric     close(PipeFD[1][0]);
11660b57cec5SDimitry Andric 
11670b57cec5SDimitry Andric 
11680b57cec5SDimitry Andric     // Execute the child process.
11690b57cec5SDimitry Andric     std::unique_ptr<char[]> ChildPath, ChildIn, ChildOut;
11700b57cec5SDimitry Andric     {
11710b57cec5SDimitry Andric       ChildPath.reset(new char[ChildExecPath.size() + 1]);
11720b57cec5SDimitry Andric       std::copy(ChildExecPath.begin(), ChildExecPath.end(), &ChildPath[0]);
11730b57cec5SDimitry Andric       ChildPath[ChildExecPath.size()] = '\0';
11740b57cec5SDimitry Andric       std::string ChildInStr = utostr(PipeFD[0][0]);
11750b57cec5SDimitry Andric       ChildIn.reset(new char[ChildInStr.size() + 1]);
11760b57cec5SDimitry Andric       std::copy(ChildInStr.begin(), ChildInStr.end(), &ChildIn[0]);
11770b57cec5SDimitry Andric       ChildIn[ChildInStr.size()] = '\0';
11780b57cec5SDimitry Andric       std::string ChildOutStr = utostr(PipeFD[1][1]);
11790b57cec5SDimitry Andric       ChildOut.reset(new char[ChildOutStr.size() + 1]);
11800b57cec5SDimitry Andric       std::copy(ChildOutStr.begin(), ChildOutStr.end(), &ChildOut[0]);
11810b57cec5SDimitry Andric       ChildOut[ChildOutStr.size()] = '\0';
11820b57cec5SDimitry Andric     }
11830b57cec5SDimitry Andric 
11840b57cec5SDimitry Andric     char * const args[] = { &ChildPath[0], &ChildIn[0], &ChildOut[0], nullptr };
11850b57cec5SDimitry Andric     int rc = execv(ChildExecPath.c_str(), args);
11860b57cec5SDimitry Andric     if (rc != 0)
11870b57cec5SDimitry Andric       perror("Error executing child process: ");
11880b57cec5SDimitry Andric     llvm_unreachable("Error executing child process");
11890b57cec5SDimitry Andric   }
11900b57cec5SDimitry Andric   // else we're the parent...
11910b57cec5SDimitry Andric 
11920b57cec5SDimitry Andric   // Close the child ends of the pipes
11930b57cec5SDimitry Andric   close(PipeFD[0][0]);
11940b57cec5SDimitry Andric   close(PipeFD[1][1]);
11950b57cec5SDimitry Andric 
1196349cc55cSDimitry Andric   // Return a SimpleRemoteEPC instance connected to our end of the pipes.
1197349cc55cSDimitry Andric   return orc::SimpleRemoteEPC::Create<orc::FDSimpleRemoteEPCTransport>(
1198349cc55cSDimitry Andric       std::make_unique<llvm::orc::InPlaceTaskDispatcher>(),
1199349cc55cSDimitry Andric       llvm::orc::SimpleRemoteEPC::Setup(), PipeFD[1][0], PipeFD[0][1]);
12000b57cec5SDimitry Andric #endif
12010b57cec5SDimitry Andric }
120206c3fb27SDimitry Andric 
120306c3fb27SDimitry Andric // For MinGW environments, manually export the __chkstk function from the lli
120406c3fb27SDimitry Andric // executable.
120506c3fb27SDimitry Andric //
120606c3fb27SDimitry Andric // Normally, this function is provided by compiler-rt builtins or libgcc.
120706c3fb27SDimitry Andric // It is named "_alloca" on i386, "___chkstk_ms" on x86_64, and "__chkstk" on
120806c3fb27SDimitry Andric // arm/aarch64. In MSVC configurations, it's named "__chkstk" in all
120906c3fb27SDimitry Andric // configurations.
121006c3fb27SDimitry Andric //
121106c3fb27SDimitry Andric // When Orc tries to resolve symbols at runtime, this succeeds in MSVC
121206c3fb27SDimitry Andric // configurations, somewhat by accident/luck; kernelbase.dll does export a
121306c3fb27SDimitry Andric // symbol named "__chkstk" which gets found by Orc, even if regular applications
121406c3fb27SDimitry Andric // never link against that function from that DLL (it's linked in statically
121506c3fb27SDimitry Andric // from a compiler support library).
121606c3fb27SDimitry Andric //
121706c3fb27SDimitry Andric // The MinGW specific symbol names aren't available in that DLL though.
121806c3fb27SDimitry Andric // Therefore, manually export the relevant symbol from lli, to let it be
121906c3fb27SDimitry Andric // found at runtime during tests.
122006c3fb27SDimitry Andric //
122106c3fb27SDimitry Andric // For real JIT uses, the real compiler support libraries should be linked
122206c3fb27SDimitry Andric // in, somehow; this is a workaround to let tests pass.
122306c3fb27SDimitry Andric //
12244542f901SDimitry Andric // We need to make sure that this symbol actually is linked in when we
12254542f901SDimitry Andric // try to export it; if no functions allocate a large enough stack area,
12264542f901SDimitry Andric // nothing would reference it. Therefore, manually declare it and add a
12274542f901SDimitry Andric // reference to it. (Note, the declarations of _alloca/___chkstk_ms/__chkstk
12284542f901SDimitry Andric // are somewhat bogus, these functions use a different custom calling
12294542f901SDimitry Andric // convention.)
12304542f901SDimitry Andric //
123106c3fb27SDimitry Andric // TODO: Move this into libORC at some point, see
123206c3fb27SDimitry Andric // https://github.com/llvm/llvm-project/issues/56603.
123306c3fb27SDimitry Andric #ifdef __MINGW32__
123406c3fb27SDimitry Andric // This is a MinGW version of #pragma comment(linker, "...") that doesn't
123506c3fb27SDimitry Andric // require compiling with -fms-extensions.
123606c3fb27SDimitry Andric #if defined(__i386__)
12374542f901SDimitry Andric #undef _alloca
12384542f901SDimitry Andric extern "C" void _alloca(void);
12394542f901SDimitry Andric static __attribute__((used)) void (*const ref_func)(void) = _alloca;
124006c3fb27SDimitry Andric static __attribute__((section(".drectve"), used)) const char export_chkstk[] =
124106c3fb27SDimitry Andric     "-export:_alloca";
124206c3fb27SDimitry Andric #elif defined(__x86_64__)
12434542f901SDimitry Andric extern "C" void ___chkstk_ms(void);
12444542f901SDimitry Andric static __attribute__((used)) void (*const ref_func)(void) = ___chkstk_ms;
124506c3fb27SDimitry Andric static __attribute__((section(".drectve"), used)) const char export_chkstk[] =
124606c3fb27SDimitry Andric     "-export:___chkstk_ms";
124706c3fb27SDimitry Andric #else
12484542f901SDimitry Andric extern "C" void __chkstk(void);
12494542f901SDimitry Andric static __attribute__((used)) void (*const ref_func)(void) = __chkstk;
125006c3fb27SDimitry Andric static __attribute__((section(".drectve"), used)) const char export_chkstk[] =
125106c3fb27SDimitry Andric     "-export:__chkstk";
125206c3fb27SDimitry Andric #endif
125306c3fb27SDimitry Andric #endif
1254