llvm/tools/lli/lli.cpp

   1 //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
   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 utility provides a simple wrapper around the LLVM Execution Engines,
  10 // which allow the direct execution of LLVM programs through a Just-In-Time
  11 // compiler, or through an interpreter if no JIT is available for this platform.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "RemoteJITUtils.h"
  16 #include "llvm/ADT/StringExtras.h"
  17 #include "llvm/ADT/Triple.h"
  18 #include "llvm/Bitcode/BitcodeReader.h"
  19 #include "llvm/CodeGen/CommandFlags.h"
  20 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  21 #include "llvm/Config/llvm-config.h"
  22 #include "llvm/ExecutionEngine/GenericValue.h"
  23 #include "llvm/ExecutionEngine/Interpreter.h"
  24 #include "llvm/ExecutionEngine/JITEventListener.h"
  25 #include "llvm/ExecutionEngine/MCJIT.h"
  26 #include "llvm/ExecutionEngine/ObjectCache.h"
  27 #include "llvm/ExecutionEngine/Orc/DebugUtils.h"
  28 #include "llvm/ExecutionEngine/Orc/ExecutionUtils.h"
  29 #include "llvm/ExecutionEngine/Orc/JITTargetMachineBuilder.h"
  30 #include "llvm/ExecutionEngine/Orc/LLJIT.h"
  31 #include "llvm/ExecutionEngine/Orc/MachOPlatform.h"
  32 #include "llvm/ExecutionEngine/Orc/OrcRemoteTargetClient.h"
  33 #include "llvm/ExecutionEngine/Orc/RTDyldObjectLinkingLayer.h"
  34 #include "llvm/ExecutionEngine/OrcMCJITReplacement.h"
  35 #include "llvm/ExecutionEngine/SectionMemoryManager.h"
  36 #include "llvm/IR/IRBuilder.h"
  37 #include "llvm/IR/LLVMContext.h"
  38 #include "llvm/IR/Module.h"
  39 #include "llvm/IR/Type.h"
  40 #include "llvm/IR/Verifier.h"
  41 #include "llvm/IRReader/IRReader.h"
  42 #include "llvm/Object/Archive.h"
  43 #include "llvm/Object/ObjectFile.h"
  44 #include "llvm/Support/CommandLine.h"
  45 #include "llvm/Support/Debug.h"
  46 #include "llvm/Support/DynamicLibrary.h"
  47 #include "llvm/Support/Format.h"
  48 #include "llvm/Support/InitLLVM.h"
  49 #include "llvm/Support/ManagedStatic.h"
  50 #include "llvm/Support/MathExtras.h"
  51 #include "llvm/Support/Memory.h"
  52 #include "llvm/Support/MemoryBuffer.h"
  53 #include "llvm/Support/Path.h"
  54 #include "llvm/Support/PluginLoader.h"
  55 #include "llvm/Support/Process.h"
  56 #include "llvm/Support/Program.h"
  57 #include "llvm/Support/SourceMgr.h"
  58 #include "llvm/Support/TargetSelect.h"
  59 #include "llvm/Support/WithColor.h"
  60 #include "llvm/Support/raw_ostream.h"
  61 #include "llvm/Transforms/Instrumentation.h"
  62 #include <cerrno>
  63
  64 #ifdef __CYGWIN__
  65 #include <cygwin/version.h>
  66 #if defined(CYGWIN_VERSION_DLL_MAJOR) && CYGWIN_VERSION_DLL_MAJOR<1007
  67 #define DO_NOTHING_ATEXIT 1
  68 #endif
  69 #endif
  70
  71 using namespace llvm;
  72
  73 static codegen::RegisterCodeGenFlags CGF;
  74
  75 #define DEBUG_TYPE "lli"
  76
  77 namespace {
  78
  79   enum class JITKind { MCJIT, OrcMCJITReplacement, OrcLazy };
  80
  81   cl::opt<std::string>
  82   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
  83
  84   cl::list<std::string>
  85   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
  86
  87   cl::opt<bool> ForceInterpreter("force-interpreter",
  88                                  cl::desc("Force interpretation: disable JIT"),
  89                                  cl::init(false));
  90
  91   cl::opt<JITKind> UseJITKind(
  92       "jit-kind", cl::desc("Choose underlying JIT kind."),
  93       cl::init(JITKind::MCJIT),
  94       cl::values(clEnumValN(JITKind::MCJIT, "mcjit", "MCJIT"),
  95                  clEnumValN(JITKind::OrcMCJITReplacement, "orc-mcjit",
  96                             "Orc-based MCJIT replacement "
  97                             "(deprecated)"),
  98                  clEnumValN(JITKind::OrcLazy, "orc-lazy",
  99                             "Orc-based lazy JIT.")));
 100
 101   cl::opt<unsigned>
 102   LazyJITCompileThreads("compile-threads",
 103                         cl::desc("Choose the number of compile threads "
 104                                  "(jit-kind=orc-lazy only)"),
 105                         cl::init(0));
 106
 107   cl::list<std::string>
 108   ThreadEntryPoints("thread-entry",
 109                     cl::desc("calls the given entry-point on a new thread "
 110                              "(jit-kind=orc-lazy only)"));
 111
 112   cl::opt<bool> PerModuleLazy(
 113       "per-module-lazy",
 114       cl::desc("Performs lazy compilation on whole module boundaries "
 115                "rather than individual functions"),
 116       cl::init(false));
 117
 118   cl::list<std::string>
 119       JITDylibs("jd",
 120                 cl::desc("Specifies the JITDylib to be used for any subsequent "
 121                          "-extra-module arguments."));
 122
 123   cl::list<std::string>
 124     Dylibs("dlopen", cl::desc("Dynamic libraries to load before linking"),
 125            cl::ZeroOrMore);
 126
 127   // The MCJIT supports building for a target address space separate from
 128   // the JIT compilation process. Use a forked process and a copying
 129   // memory manager with IPC to execute using this functionality.
 130   cl::opt<bool> RemoteMCJIT("remote-mcjit",
 131     cl::desc("Execute MCJIT'ed code in a separate process."),
 132     cl::init(false));
 133
 134   // Manually specify the child process for remote execution. This overrides
 135   // the simulated remote execution that allocates address space for child
 136   // execution. The child process will be executed and will communicate with
 137   // lli via stdin/stdout pipes.
 138   cl::opt<std::string>
 139   ChildExecPath("mcjit-remote-process",
 140                 cl::desc("Specify the filename of the process to launch "
 141                          "for remote MCJIT execution.  If none is specified,"
 142                          "\n\tremote execution will be simulated in-process."),
 143                 cl::value_desc("filename"), cl::init(""));
 144
 145   // Determine optimization level.
 146   cl::opt<char>
 147   OptLevel("O",
 148            cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
 149                     "(default = '-O2')"),
 150            cl::Prefix,
 151            cl::ZeroOrMore,
 152            cl::init(' '));
 153
 154   cl::opt<std::string>
 155   TargetTriple("mtriple", cl::desc("Override target triple for module"));
 156
 157   cl::opt<std::string>
 158   EntryFunc("entry-function",
 159             cl::desc("Specify the entry function (default = 'main') "
 160                      "of the executable"),
 161             cl::value_desc("function"),
 162             cl::init("main"));
 163
 164   cl::list<std::string>
 165   ExtraModules("extra-module",
 166          cl::desc("Extra modules to be loaded"),
 167          cl::value_desc("input bitcode"));
 168
 169   cl::list<std::string>
 170   ExtraObjects("extra-object",
 171          cl::desc("Extra object files to be loaded"),
 172          cl::value_desc("input object"));
 173
 174   cl::list<std::string>
 175   ExtraArchives("extra-archive",
 176          cl::desc("Extra archive files to be loaded"),
 177          cl::value_desc("input archive"));
 178
 179   cl::opt<bool>
 180   EnableCacheManager("enable-cache-manager",
 181         cl::desc("Use cache manager to save/load modules"),
 182         cl::init(false));
 183
 184   cl::opt<std::string>
 185   ObjectCacheDir("object-cache-dir",
 186                   cl::desc("Directory to store cached object files "
 187                            "(must be user writable)"),
 188                   cl::init(""));
 189
 190   cl::opt<std::string>
 191   FakeArgv0("fake-argv0",
 192             cl::desc("Override the 'argv[0]' value passed into the executing"
 193                      " program"), cl::value_desc("executable"));
 194
 195   cl::opt<bool>
 196   DisableCoreFiles("disable-core-files", cl::Hidden,
 197                    cl::desc("Disable emission of core files if possible"));
 198
 199   cl::opt<bool>
 200   NoLazyCompilation("disable-lazy-compilation",
 201                   cl::desc("Disable JIT lazy compilation"),
 202                   cl::init(false));
 203
 204   cl::opt<bool>
 205   GenerateSoftFloatCalls("soft-float",
 206     cl::desc("Generate software floating point library calls"),
 207     cl::init(false));
 208
 209   cl::opt<bool> NoProcessSymbols(
 210       "no-process-syms",
 211       cl::desc("Do not resolve lli process symbols in JIT'd code"),
 212       cl::init(false));
 213
 214   enum class LLJITPlatform { DetectHost, GenericIR, MachO };
 215
 216   cl::opt<LLJITPlatform>
 217       Platform("lljit-platform", cl::desc("Platform to use with LLJIT"),
 218                cl::init(LLJITPlatform::DetectHost),
 219                cl::values(clEnumValN(LLJITPlatform::DetectHost, "DetectHost",
 220                                      "Select based on JIT target triple"),
 221                           clEnumValN(LLJITPlatform::GenericIR, "GenericIR",
 222                                      "Use LLJITGenericIRPlatform"),
 223                           clEnumValN(LLJITPlatform::MachO, "MachO",
 224                                      "Use LLJITMachOPlatform")),
 225                cl::Hidden);
 226
 227   enum class DumpKind {
 228     NoDump,
 229     DumpFuncsToStdOut,
 230     DumpModsToStdOut,
 231     DumpModsToDisk
 232   };
 233
 234   cl::opt<DumpKind> OrcDumpKind(
 235       "orc-lazy-debug", cl::desc("Debug dumping for the orc-lazy JIT."),
 236       cl::init(DumpKind::NoDump),
 237       cl::values(clEnumValN(DumpKind::NoDump, "no-dump",
 238                             "Don't dump anything."),
 239                  clEnumValN(DumpKind::DumpFuncsToStdOut, "funcs-to-stdout",
 240                             "Dump function names to stdout."),
 241                  clEnumValN(DumpKind::DumpModsToStdOut, "mods-to-stdout",
 242                             "Dump modules to stdout."),
 243                  clEnumValN(DumpKind::DumpModsToDisk, "mods-to-disk",
 244                             "Dump modules to the current "
 245                             "working directory. (WARNING: "
 246                             "will overwrite existing files).")),
 247       cl::Hidden);
 248
 249   ExitOnError ExitOnErr;
 250 }
 251
 252 //===----------------------------------------------------------------------===//
 253 // Object cache
 254 //
 255 // This object cache implementation writes cached objects to disk to the
 256 // directory specified by CacheDir, using a filename provided in the module
 257 // descriptor. The cache tries to load a saved object using that path if the
 258 // file exists. CacheDir defaults to "", in which case objects are cached
 259 // alongside their originating bitcodes.
 260 //
 261 class LLIObjectCache : public ObjectCache {
 262 public:
 263   LLIObjectCache(const std::string& CacheDir) : CacheDir(CacheDir) {
 264     // Add trailing '/' to cache dir if necessary.
 265     if (!this->CacheDir.empty() &&
 266         this->CacheDir[this->CacheDir.size() - 1] != '/')
 267       this->CacheDir += '/';
 268   }
 269   ~LLIObjectCache() override {}
 270
 271   void notifyObjectCompiled(const Module *M, MemoryBufferRef Obj) override {
 272     const std::string &ModuleID = M->getModuleIdentifier();
 273     std::string CacheName;
 274     if (!getCacheFilename(ModuleID, CacheName))
 275       return;
 276     if (!CacheDir.empty()) { // Create user-defined cache dir.
 277       SmallString<128> dir(sys::path::parent_path(CacheName));
 278       sys::fs::create_directories(Twine(dir));
 279     }
 280
 281     std::error_code EC;
 282     raw_fd_ostream outfile(CacheName, EC, sys::fs::OF_None);
 283     outfile.write(Obj.getBufferStart(), Obj.getBufferSize());
 284     outfile.close();
 285   }
 286
 287   std::unique_ptr<MemoryBuffer> getObject(const Module* M) override {
 288     const std::string &ModuleID = M->getModuleIdentifier();
 289     std::string CacheName;
 290     if (!getCacheFilename(ModuleID, CacheName))
 291       return nullptr;
 292     // Load the object from the cache filename
 293     ErrorOr<std::unique_ptr<MemoryBuffer>> IRObjectBuffer =
 294         MemoryBuffer::getFile(CacheName, -1, false);
 295     // If the file isn't there, that's OK.
 296     if (!IRObjectBuffer)
 297       return nullptr;
 298     // MCJIT will want to write into this buffer, and we don't want that
 299     // because the file has probably just been mmapped.  Instead we make
 300     // a copy.  The filed-based buffer will be released when it goes
 301     // out of scope.
 302     return MemoryBuffer::getMemBufferCopy(IRObjectBuffer.get()->getBuffer());
 303   }
 304
 305 private:
 306   std::string CacheDir;
 307
 308   bool getCacheFilename(const std::string &ModID, std::string &CacheName) {
 309     std::string Prefix("file:");
 310     size_t PrefixLength = Prefix.length();
 311     if (ModID.substr(0, PrefixLength) != Prefix)
 312       return false;
 313
 314     std::string CacheSubdir = ModID.substr(PrefixLength);
 315 #if defined(_WIN32)
 316     // Transform "X:\foo" => "/X\foo" for convenience.
 317     if (isalpha(CacheSubdir[0]) && CacheSubdir[1] == ':') {
 318       CacheSubdir[1] = CacheSubdir[0];
 319       CacheSubdir[0] = '/';
 320     }
 321 #endif
 322
 323     CacheName = CacheDir + CacheSubdir;
 324     size_t pos = CacheName.rfind('.');
 325     CacheName.replace(pos, CacheName.length() - pos, ".o");
 326     return true;
 327   }
 328 };
 329
 330 // On Mingw and Cygwin, an external symbol named '__main' is called from the
 331 // generated 'main' function to allow static initialization.  To avoid linking
 332 // problems with remote targets (because lli's remote target support does not
 333 // currently handle external linking) we add a secondary module which defines
 334 // an empty '__main' function.
 335 static void addCygMingExtraModule(ExecutionEngine &EE, LLVMContext &Context,
 336                                   StringRef TargetTripleStr) {
 337   IRBuilder<> Builder(Context);
 338   Triple TargetTriple(TargetTripleStr);
 339
 340   // Create a new module.
 341   std::unique_ptr<Module> M = std::make_unique<Module>("CygMingHelper", Context);
 342   M->setTargetTriple(TargetTripleStr);
 343
 344   // Create an empty function named "__main".
 345   Type *ReturnTy;
 346   if (TargetTriple.isArch64Bit())
 347     ReturnTy = Type::getInt64Ty(Context);
 348   else
 349     ReturnTy = Type::getInt32Ty(Context);
 350   Function *Result =
 351       Function::Create(FunctionType::get(ReturnTy, {}, false),
 352                        GlobalValue::ExternalLinkage, "__main", M.get());
 353
 354   BasicBlock *BB = BasicBlock::Create(Context, "__main", Result);
 355   Builder.SetInsertPoint(BB);
 356   Value *ReturnVal = ConstantInt::get(ReturnTy, 0);
 357   Builder.CreateRet(ReturnVal);
 358
 359   // Add this new module to the ExecutionEngine.
 360   EE.addModule(std::move(M));
 361 }
 362
 363 CodeGenOpt::Level getOptLevel() {
 364   switch (OptLevel) {
 365   default:
 366     WithColor::error(errs(), "lli") << "invalid optimization level.\n";
 367     exit(1);
 368   case '0': return CodeGenOpt::None;
 369   case '1': return CodeGenOpt::Less;
 370   case ' ':
 371   case '2': return CodeGenOpt::Default;
 372   case '3': return CodeGenOpt::Aggressive;
 373   }
 374   llvm_unreachable("Unrecognized opt level.");
 375 }
 376
 377 LLVM_ATTRIBUTE_NORETURN
 378 static void reportError(SMDiagnostic Err, const char *ProgName) {
 379   Err.print(ProgName, errs());
 380   exit(1);
 381 }
 382
 383 Error loadDylibs();
 384 int runOrcLazyJIT(const char *ProgName);
 385 void disallowOrcOptions();
 386
 387 //===----------------------------------------------------------------------===//
 388 // main Driver function
 389 //
 390 int main(int argc, char **argv, char * const *envp) {
 391   InitLLVM X(argc, argv);
 392
 393   if (argc > 1)
 394     ExitOnErr.setBanner(std::string(argv[0]) + ": ");
 395
 396   // If we have a native target, initialize it to ensure it is linked in and
 397   // usable by the JIT.
 398   InitializeNativeTarget();
 399   InitializeNativeTargetAsmPrinter();
 400   InitializeNativeTargetAsmParser();
 401
 402   cl::ParseCommandLineOptions(argc, argv,
 403                               "llvm interpreter & dynamic compiler\n");
 404
 405   // If the user doesn't want core files, disable them.
 406   if (DisableCoreFiles)
 407     sys::Process::PreventCoreFiles();
 408
 409   ExitOnErr(loadDylibs());
 410
 411   if (UseJITKind == JITKind::OrcLazy)
 412     return runOrcLazyJIT(argv[0]);
 413   else
 414     disallowOrcOptions();
 415
 416   LLVMContext Context;
 417
 418   // Load the bitcode...
 419   SMDiagnostic Err;
 420   std::unique_ptr<Module> Owner = parseIRFile(InputFile, Err, Context);
 421   Module *Mod = Owner.get();
 422   if (!Mod)
 423     reportError(Err, argv[0]);
 424
 425   if (EnableCacheManager) {
 426     std::string CacheName("file:");
 427     CacheName.append(InputFile);
 428     Mod->setModuleIdentifier(CacheName);
 429   }
 430
 431   // If not jitting lazily, load the whole bitcode file eagerly too.
 432   if (NoLazyCompilation) {
 433     // Use *argv instead of argv[0] to work around a wrong GCC warning.
 434     ExitOnError ExitOnErr(std::string(*argv) +
 435                           ": bitcode didn't read correctly: ");
 436     ExitOnErr(Mod->materializeAll());
 437   }
 438
 439   std::string ErrorMsg;
 440   EngineBuilder builder(std::move(Owner));
 441   builder.setMArch(codegen::getMArch());
 442   builder.setMCPU(codegen::getCPUStr());
 443   builder.setMAttrs(codegen::getFeatureList());
 444   if (auto RM = codegen::getExplicitRelocModel())
 445     builder.setRelocationModel(RM.getValue());
 446   if (auto CM = codegen::getExplicitCodeModel())
 447     builder.setCodeModel(CM.getValue());
 448   builder.setErrorStr(&ErrorMsg);
 449   builder.setEngineKind(ForceInterpreter
 450                         ? EngineKind::Interpreter
 451                         : EngineKind::JIT);
 452   builder.setUseOrcMCJITReplacement(AcknowledgeORCv1Deprecation,
 453                                     UseJITKind == JITKind::OrcMCJITReplacement);
 454
 455   // If we are supposed to override the target triple, do so now.
 456   if (!TargetTriple.empty())
 457     Mod->setTargetTriple(Triple::normalize(TargetTriple));
 458
 459   // Enable MCJIT if desired.
 460   RTDyldMemoryManager *RTDyldMM = nullptr;
 461   if (!ForceInterpreter) {
 462     if (RemoteMCJIT)
 463       RTDyldMM = new ForwardingMemoryManager();
 464     else
 465       RTDyldMM = new SectionMemoryManager();
 466
 467     // Deliberately construct a temp std::unique_ptr to pass in. Do not null out
 468     // RTDyldMM: We still use it below, even though we don't own it.
 469     builder.setMCJITMemoryManager(
 470       std::unique_ptr<RTDyldMemoryManager>(RTDyldMM));
 471   } else if (RemoteMCJIT) {
 472     WithColor::error(errs(), argv[0])
 473         << "remote process execution does not work with the interpreter.\n";
 474     exit(1);
 475   }
 476
 477   builder.setOptLevel(getOptLevel());
 478
 479   TargetOptions Options = codegen::InitTargetOptionsFromCodeGenFlags();
 480   if (codegen::getFloatABIForCalls() != FloatABI::Default)
 481     Options.FloatABIType = codegen::getFloatABIForCalls();
 482
 483   builder.setTargetOptions(Options);
 484
 485   std::unique_ptr<ExecutionEngine> EE(builder.create());
 486   if (!EE) {
 487     if (!ErrorMsg.empty())
 488       WithColor::error(errs(), argv[0])
 489           << "error creating EE: " << ErrorMsg << "\n";
 490     else
 491       WithColor::error(errs(), argv[0]) << "unknown error creating EE!\n";
 492     exit(1);
 493   }
 494
 495   std::unique_ptr<LLIObjectCache> CacheManager;
 496   if (EnableCacheManager) {
 497     CacheManager.reset(new LLIObjectCache(ObjectCacheDir));
 498     EE->setObjectCache(CacheManager.get());
 499   }
 500
 501   // Load any additional modules specified on the command line.
 502   for (unsigned i = 0, e = ExtraModules.size(); i != e; ++i) {
 503     std::unique_ptr<Module> XMod = parseIRFile(ExtraModules[i], Err, Context);
 504     if (!XMod)
 505       reportError(Err, argv[0]);
 506     if (EnableCacheManager) {
 507       std::string CacheName("file:");
 508       CacheName.append(ExtraModules[i]);
 509       XMod->setModuleIdentifier(CacheName);
 510     }
 511     EE->addModule(std::move(XMod));
 512   }
 513
 514   for (unsigned i = 0, e = ExtraObjects.size(); i != e; ++i) {
 515     Expected<object::OwningBinary<object::ObjectFile>> Obj =
 516         object::ObjectFile::createObjectFile(ExtraObjects[i]);
 517     if (!Obj) {
 518       // TODO: Actually report errors helpfully.
 519       consumeError(Obj.takeError());
 520       reportError(Err, argv[0]);
 521     }
 522     object::OwningBinary<object::ObjectFile> &O = Obj.get();
 523     EE->addObjectFile(std::move(O));
 524   }
 525
 526   for (unsigned i = 0, e = ExtraArchives.size(); i != e; ++i) {
 527     ErrorOr<std::unique_ptr<MemoryBuffer>> ArBufOrErr =
 528         MemoryBuffer::getFileOrSTDIN(ExtraArchives[i]);
 529     if (!ArBufOrErr)
 530       reportError(Err, argv[0]);
 531     std::unique_ptr<MemoryBuffer> &ArBuf = ArBufOrErr.get();
 532
 533     Expected<std::unique_ptr<object::Archive>> ArOrErr =
 534         object::Archive::create(ArBuf->getMemBufferRef());
 535     if (!ArOrErr) {
 536       std::string Buf;
 537       raw_string_ostream OS(Buf);
 538       logAllUnhandledErrors(ArOrErr.takeError(), OS);
 539       OS.flush();
 540       errs() << Buf;
 541       exit(1);
 542     }
 543     std::unique_ptr<object::Archive> &Ar = ArOrErr.get();
 544
 545     object::OwningBinary<object::Archive> OB(std::move(Ar), std::move(ArBuf));
 546
 547     EE->addArchive(std::move(OB));
 548   }
 549
 550   // If the target is Cygwin/MingW and we are generating remote code, we
 551   // need an extra module to help out with linking.
 552   if (RemoteMCJIT && Triple(Mod->getTargetTriple()).isOSCygMing()) {
 553     addCygMingExtraModule(*EE, Context, Mod->getTargetTriple());
 554   }
 555
 556   // The following functions have no effect if their respective profiling
 557   // support wasn't enabled in the build configuration.
 558   EE->RegisterJITEventListener(
 559                 JITEventListener::createOProfileJITEventListener());
 560   EE->RegisterJITEventListener(
 561                 JITEventListener::createIntelJITEventListener());
 562   if (!RemoteMCJIT)
 563     EE->RegisterJITEventListener(
 564                 JITEventListener::createPerfJITEventListener());
 565
 566   if (!NoLazyCompilation && RemoteMCJIT) {
 567     WithColor::warning(errs(), argv[0])
 568         << "remote mcjit does not support lazy compilation\n";
 569     NoLazyCompilation = true;
 570   }
 571   EE->DisableLazyCompilation(NoLazyCompilation);
 572
 573   // If the user specifically requested an argv[0] to pass into the program,
 574   // do it now.
 575   if (!FakeArgv0.empty()) {
 576     InputFile = static_cast<std::string>(FakeArgv0);
 577   } else {
 578     // Otherwise, if there is a .bc suffix on the executable strip it off, it
 579     // might confuse the program.
 580     if (StringRef(InputFile).endswith(".bc"))
 581       InputFile.erase(InputFile.length() - 3);
 582   }
 583
 584   // Add the module's name to the start of the vector of arguments to main().
 585   InputArgv.insert(InputArgv.begin(), InputFile);
 586
 587   // Call the main function from M as if its signature were:
 588   //   int main (int argc, char **argv, const char **envp)
 589   // using the contents of Args to determine argc & argv, and the contents of
 590   // EnvVars to determine envp.
 591   //
 592   Function *EntryFn = Mod->getFunction(EntryFunc);
 593   if (!EntryFn) {
 594     WithColor::error(errs(), argv[0])
 595         << '\'' << EntryFunc << "\' function not found in module.\n";
 596     return -1;
 597   }
 598
 599   // Reset errno to zero on entry to main.
 600   errno = 0;
 601
 602   int Result = -1;
 603
 604   // Sanity check use of remote-jit: LLI currently only supports use of the
 605   // remote JIT on Unix platforms.
 606   if (RemoteMCJIT) {
 607 #ifndef LLVM_ON_UNIX
 608     WithColor::warning(errs(), argv[0])
 609         << "host does not support external remote targets.\n";
 610     WithColor::note() << "defaulting to local execution\n";
 611     return -1;
 612 #else
 613     if (ChildExecPath.empty()) {
 614       WithColor::error(errs(), argv[0])
 615           << "-remote-mcjit requires -mcjit-remote-process.\n";
 616       exit(1);
 617     } else if (!sys::fs::can_execute(ChildExecPath)) {
 618       WithColor::error(errs(), argv[0])
 619           << "unable to find usable child executable: '" << ChildExecPath
 620           << "'\n";
 621       return -1;
 622     }
 623 #endif
 624   }
 625
 626   if (!RemoteMCJIT) {
 627     // If the program doesn't explicitly call exit, we will need the Exit
 628     // function later on to make an explicit call, so get the function now.
 629     FunctionCallee Exit = Mod->getOrInsertFunction(
 630         "exit", Type::getVoidTy(Context), Type::getInt32Ty(Context));
 631
 632     // Run static constructors.
 633     if (!ForceInterpreter) {
 634       // Give MCJIT a chance to apply relocations and set page permissions.
 635       EE->finalizeObject();
 636     }
 637     EE->runStaticConstructorsDestructors(false);
 638
 639     // Trigger compilation separately so code regions that need to be
 640     // invalidated will be known.
 641     (void)EE->getPointerToFunction(EntryFn);
 642     // Clear instruction cache before code will be executed.
 643     if (RTDyldMM)
 644       static_cast<SectionMemoryManager*>(RTDyldMM)->invalidateInstructionCache();
 645
 646     // Run main.
 647     Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
 648
 649     // Run static destructors.
 650     EE->runStaticConstructorsDestructors(true);
 651
 652     // If the program didn't call exit explicitly, we should call it now.
 653     // This ensures that any atexit handlers get called correctly.
 654     if (Function *ExitF =
 655             dyn_cast<Function>(Exit.getCallee()->stripPointerCasts())) {
 656       if (ExitF->getFunctionType() == Exit.getFunctionType()) {
 657         std::vector<GenericValue> Args;
 658         GenericValue ResultGV;
 659         ResultGV.IntVal = APInt(32, Result);
 660         Args.push_back(ResultGV);
 661         EE->runFunction(ExitF, Args);
 662         WithColor::error(errs(), argv[0])
 663             << "exit(" << Result << ") returned!\n";
 664         abort();
 665       }
 666     }
 667     WithColor::error(errs(), argv[0]) << "exit defined with wrong prototype!\n";
 668     abort();
 669   } else {
 670     // else == "if (RemoteMCJIT)"
 671
 672     // Remote target MCJIT doesn't (yet) support static constructors. No reason
 673     // it couldn't. This is a limitation of the LLI implementation, not the
 674     // MCJIT itself. FIXME.
 675
 676     // Lanch the remote process and get a channel to it.
 677     std::unique_ptr<FDRawChannel> C = launchRemote();
 678     if (!C) {
 679       WithColor::error(errs(), argv[0]) << "failed to launch remote JIT.\n";
 680       exit(1);
 681     }
 682
 683     // Create a remote target client running over the channel.
 684     llvm::orc::ExecutionSession ES;
 685     ES.setErrorReporter([&](Error Err) { ExitOnErr(std::move(Err)); });
 686     typedef orc::remote::OrcRemoteTargetClient MyRemote;
 687     auto R = ExitOnErr(MyRemote::Create(*C, ES));
 688
 689     // Create a remote memory manager.
 690     auto RemoteMM = ExitOnErr(R->createRemoteMemoryManager());
 691
 692     // Forward MCJIT's memory manager calls to the remote memory manager.
 693     static_cast<ForwardingMemoryManager*>(RTDyldMM)->setMemMgr(
 694       std::move(RemoteMM));
 695
 696     // Forward MCJIT's symbol resolution calls to the remote.
 697     static_cast<ForwardingMemoryManager *>(RTDyldMM)->setResolver(
 698         orc::createLambdaResolver(
 699             AcknowledgeORCv1Deprecation,
 700             [](const std::string &Name) { return nullptr; },
 701             [&](const std::string &Name) {
 702               if (auto Addr = ExitOnErr(R->getSymbolAddress(Name)))
 703                 return JITSymbol(Addr, JITSymbolFlags::Exported);
 704               return JITSymbol(nullptr);
 705             }));
 706
 707     // Grab the target address of the JIT'd main function on the remote and call
 708     // it.
 709     // FIXME: argv and envp handling.
 710     JITTargetAddress Entry = EE->getFunctionAddress(EntryFn->getName().str());
 711     EE->finalizeObject();
 712     LLVM_DEBUG(dbgs() << "Executing '" << EntryFn->getName() << "' at 0x"
 713                       << format("%llx", Entry) << "\n");
 714     Result = ExitOnErr(R->callIntVoid(Entry));
 715
 716     // Like static constructors, the remote target MCJIT support doesn't handle
 717     // this yet. It could. FIXME.
 718
 719     // Delete the EE - we need to tear it down *before* we terminate the session
 720     // with the remote, otherwise it'll crash when it tries to release resources
 721     // on a remote that has already been disconnected.
 722     EE.reset();
 723
 724     // Signal the remote target that we're done JITing.
 725     ExitOnErr(R->terminateSession());
 726   }
 727
 728   return Result;
 729 }
 730
 731 static std::function<void(Module &)> createDebugDumper() {
 732   switch (OrcDumpKind) {
 733   case DumpKind::NoDump:
 734     return [](Module &M) {};
 735
 736   case DumpKind::DumpFuncsToStdOut:
 737     return [](Module &M) {
 738       printf("[ ");
 739
 740       for (const auto &F : M) {
 741         if (F.isDeclaration())
 742           continue;
 743
 744         if (F.hasName()) {
 745           std::string Name(std::string(F.getName()));
 746           printf("%s ", Name.c_str());
 747         } else
 748           printf("<anon> ");
 749       }
 750
 751       printf("]\n");
 752     };
 753
 754   case DumpKind::DumpModsToStdOut:
 755     return [](Module &M) {
 756       outs() << "----- Module Start -----\n" << M << "----- Module End -----\n";
 757     };
 758
 759   case DumpKind::DumpModsToDisk:
 760     return [](Module &M) {
 761       std::error_code EC;
 762       raw_fd_ostream Out(M.getModuleIdentifier() + ".ll", EC, sys::fs::OF_Text);
 763       if (EC) {
 764         errs() << "Couldn't open " << M.getModuleIdentifier()
 765                << " for dumping.\nError:" << EC.message() << "\n";
 766         exit(1);
 767       }
 768       Out << M;
 769     };
 770   }
 771   llvm_unreachable("Unknown DumpKind");
 772 }
 773
 774 Error loadDylibs() {
 775   for (const auto &Dylib : Dylibs) {
 776     std::string ErrMsg;
 777     if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
 778       return make_error<StringError>(ErrMsg, inconvertibleErrorCode());
 779   }
 780
 781   return Error::success();
 782 }
 783
 784 static void exitOnLazyCallThroughFailure() { exit(1); }
 785
 786 Expected<orc::ThreadSafeModule>
 787 loadModule(StringRef Path, orc::ThreadSafeContext TSCtx) {
 788   SMDiagnostic Err;
 789   auto M = parseIRFile(Path, Err, *TSCtx.getContext());
 790   if (!M) {
 791     std::string ErrMsg;
 792     {
 793       raw_string_ostream ErrMsgStream(ErrMsg);
 794       Err.print("lli", ErrMsgStream);
 795     }
 796     return make_error<StringError>(std::move(ErrMsg), inconvertibleErrorCode());
 797   }
 798
 799   if (EnableCacheManager)
 800     M->setModuleIdentifier("file:" + M->getModuleIdentifier());
 801
 802   return orc::ThreadSafeModule(std::move(M), std::move(TSCtx));
 803 }
 804
 805 int runOrcLazyJIT(const char *ProgName) {
 806   // Start setting up the JIT environment.
 807
 808   // Parse the main module.
 809   orc::ThreadSafeContext TSCtx(std::make_unique<LLVMContext>());
 810   auto MainModule = ExitOnErr(loadModule(InputFile, TSCtx));
 811
 812   // Get TargetTriple and DataLayout from the main module if they're explicitly
 813   // set.
 814   Optional<Triple> TT;
 815   Optional<DataLayout> DL;
 816   MainModule.withModuleDo([&](Module &M) {
 817       if (!M.getTargetTriple().empty())
 818         TT = Triple(M.getTargetTriple());
 819       if (!M.getDataLayout().isDefault())
 820         DL = M.getDataLayout();
 821     });
 822
 823   orc::LLLazyJITBuilder Builder;
 824
 825   Builder.setJITTargetMachineBuilder(
 826       TT ? orc::JITTargetMachineBuilder(*TT)
 827          : ExitOnErr(orc::JITTargetMachineBuilder::detectHost()));
 828
 829   TT = Builder.getJITTargetMachineBuilder()->getTargetTriple();
 830   if (DL)
 831     Builder.setDataLayout(DL);
 832
 833   if (!codegen::getMArch().empty())
 834     Builder.getJITTargetMachineBuilder()->getTargetTriple().setArchName(
 835         codegen::getMArch());
 836
 837   Builder.getJITTargetMachineBuilder()
 838       ->setCPU(codegen::getCPUStr())
 839       .addFeatures(codegen::getFeatureList())
 840       .setRelocationModel(codegen::getExplicitRelocModel())
 841       .setCodeModel(codegen::getExplicitCodeModel());
 842
 843   Builder.setLazyCompileFailureAddr(
 844       pointerToJITTargetAddress(exitOnLazyCallThroughFailure));
 845   Builder.setNumCompileThreads(LazyJITCompileThreads);
 846
 847   // If the object cache is enabled then set a custom compile function
 848   // creator to use the cache.
 849   std::unique_ptr<LLIObjectCache> CacheManager;
 850   if (EnableCacheManager) {
 851
 852     CacheManager = std::make_unique<LLIObjectCache>(ObjectCacheDir);
 853
 854     Builder.setCompileFunctionCreator(
 855       [&](orc::JITTargetMachineBuilder JTMB)
 856             -> Expected<std::unique_ptr<orc::IRCompileLayer::IRCompiler>> {
 857         if (LazyJITCompileThreads > 0)
 858           return std::make_unique<orc::ConcurrentIRCompiler>(std::move(JTMB),
 859                                                         CacheManager.get());
 860
 861         auto TM = JTMB.createTargetMachine();
 862         if (!TM)
 863           return TM.takeError();
 864
 865         return std::make_unique<orc::TMOwningSimpleCompiler>(std::move(*TM),
 866                                                         CacheManager.get());
 867       });
 868   }
 869
 870   // Set up LLJIT platform.
 871   {
 872     LLJITPlatform P = Platform;
 873     if (P == LLJITPlatform::DetectHost) {
 874       if (TT->isOSBinFormatMachO())
 875         P = LLJITPlatform::MachO;
 876       else
 877         P = LLJITPlatform::GenericIR;
 878     }
 879
 880     switch (P) {
 881     case LLJITPlatform::GenericIR:
 882       // Nothing to do: LLJITBuilder will use this by default.
 883       break;
 884     case LLJITPlatform::MachO:
 885       Builder.setPlatformSetUp(orc::setUpMachOPlatform);
 886       ExitOnErr(orc::enableObjCRegistration("libobjc.dylib"));
 887       break;
 888     default:
 889       llvm_unreachable("Unrecognized platform value");
 890     }
 891   }
 892
 893   auto J = ExitOnErr(Builder.create());
 894
 895   if (TT->isOSBinFormatELF())
 896     static_cast<llvm::orc::RTDyldObjectLinkingLayer &>(J->getObjLinkingLayer())
 897         .registerJITEventListener(
 898             *JITEventListener::createGDBRegistrationListener());
 899
 900   if (PerModuleLazy)
 901     J->setPartitionFunction(orc::CompileOnDemandLayer::compileWholeModule);
 902
 903   auto Dump = createDebugDumper();
 904
 905   J->getIRTransformLayer().setTransform(
 906       [&](orc::ThreadSafeModule TSM,
 907           const orc::MaterializationResponsibility &R) {
 908         TSM.withModuleDo([&](Module &M) {
 909           if (verifyModule(M, &dbgs())) {
 910             dbgs() << "Bad module: " << &M << "\n";
 911             exit(1);
 912           }
 913           Dump(M);
 914         });
 915         return TSM;
 916       });
 917
 918   orc::MangleAndInterner Mangle(J->getExecutionSession(), J->getDataLayout());
 919
 920   // Unless they've been explicitly disabled, make process symbols available to
 921   // JIT'd code.
 922   if (!NoProcessSymbols)
 923     J->getMainJITDylib().addGenerator(
 924         ExitOnErr(orc::DynamicLibrarySearchGenerator::GetForCurrentProcess(
 925             J->getDataLayout().getGlobalPrefix(),
 926             [MainName = Mangle("main")](const orc::SymbolStringPtr &Name) {
 927               return Name != MainName;
 928             })));
 929
 930   // Add the main module.
 931   ExitOnErr(J->addLazyIRModule(std::move(MainModule)));
 932
 933   // Create JITDylibs and add any extra modules.
 934   {
 935     // Create JITDylibs, keep a map from argument index to dylib. We will use
 936     // -extra-module argument indexes to determine what dylib to use for each
 937     // -extra-module.
 938     std::map<unsigned, orc::JITDylib *> IdxToDylib;
 939     IdxToDylib[0] = &J->getMainJITDylib();
 940     for (auto JDItr = JITDylibs.begin(), JDEnd = JITDylibs.end();
 941          JDItr != JDEnd; ++JDItr) {
 942       orc::JITDylib *JD = J->getJITDylibByName(*JDItr);
 943       if (!JD) {
 944         JD = &ExitOnErr(J->createJITDylib(*JDItr));
 945         J->getMainJITDylib().addToLinkOrder(*JD);
 946         JD->addToLinkOrder(J->getMainJITDylib());
 947       }
 948       IdxToDylib[JITDylibs.getPosition(JDItr - JITDylibs.begin())] = JD;
 949     }
 950
 951     for (auto EMItr = ExtraModules.begin(), EMEnd = ExtraModules.end();
 952          EMItr != EMEnd; ++EMItr) {
 953       auto M = ExitOnErr(loadModule(*EMItr, TSCtx));
 954
 955       auto EMIdx = ExtraModules.getPosition(EMItr - ExtraModules.begin());
 956       assert(EMIdx != 0 && "ExtraModule should have index > 0");
 957       auto JDItr = std::prev(IdxToDylib.lower_bound(EMIdx));
 958       auto &JD = *JDItr->second;
 959       ExitOnErr(J->addLazyIRModule(JD, std::move(M)));
 960     }
 961
 962     for (auto EAItr = ExtraArchives.begin(), EAEnd = ExtraArchives.end();
 963          EAItr != EAEnd; ++EAItr) {
 964       auto EAIdx = ExtraArchives.getPosition(EAItr - ExtraArchives.begin());
 965       assert(EAIdx != 0 && "ExtraArchive should have index > 0");
 966       auto JDItr = std::prev(IdxToDylib.lower_bound(EAIdx));
 967       auto &JD = *JDItr->second;
 968       JD.addGenerator(ExitOnErr(orc::StaticLibraryDefinitionGenerator::Load(
 969           J->getObjLinkingLayer(), EAItr->c_str(), *TT)));
 970     }
 971   }
 972
 973   // Add the objects.
 974   for (auto &ObjPath : ExtraObjects) {
 975     auto Obj = ExitOnErr(errorOrToExpected(MemoryBuffer::getFile(ObjPath)));
 976     ExitOnErr(J->addObjectFile(std::move(Obj)));
 977   }
 978
 979   // Run any static constructors.
 980   ExitOnErr(J->initialize(J->getMainJITDylib()));
 981
 982   // Run any -thread-entry points.
 983   std::vector<std::thread> AltEntryThreads;
 984   for (auto &ThreadEntryPoint : ThreadEntryPoints) {
 985     auto EntryPointSym = ExitOnErr(J->lookup(ThreadEntryPoint));
 986     typedef void (*EntryPointPtr)();
 987     auto EntryPoint =
 988       reinterpret_cast<EntryPointPtr>(static_cast<uintptr_t>(EntryPointSym.getAddress()));
 989     AltEntryThreads.push_back(std::thread([EntryPoint]() { EntryPoint(); }));
 990   }
 991
 992   // Run main.
 993   auto MainSym = ExitOnErr(J->lookup("main"));
 994
 995   typedef int (*MainFnPtr)(int, char *[]);
 996   auto Result = orc::runAsMain(
 997       jitTargetAddressToFunction<MainFnPtr>(MainSym.getAddress()), InputArgv,
 998       StringRef(InputFile));
 999
1000   // Wait for -entry-point threads.
1001   for (auto &AltEntryThread : AltEntryThreads)
1002     AltEntryThread.join();
1003
1004   // Run destructors.
1005   ExitOnErr(J->deinitialize(J->getMainJITDylib()));
1006
1007   return Result;
1008 }
1009
1010 void disallowOrcOptions() {
1011   // Make sure nobody used an orc-lazy specific option accidentally.
1012
1013   if (LazyJITCompileThreads != 0) {
1014     errs() << "-compile-threads requires -jit-kind=orc-lazy\n";
1015     exit(1);
1016   }
1017
1018   if (!ThreadEntryPoints.empty()) {
1019     errs() << "-thread-entry requires -jit-kind=orc-lazy\n";
1020     exit(1);
1021   }
1022
1023   if (PerModuleLazy) {
1024     errs() << "-per-module-lazy requires -jit-kind=orc-lazy\n";
1025     exit(1);
1026   }
1027 }
1028
1029 std::unique_ptr<FDRawChannel> launchRemote() {
1030 #ifndef LLVM_ON_UNIX
1031   llvm_unreachable("launchRemote not supported on non-Unix platforms");
1032 #else
1033   int PipeFD[2][2];
1034   pid_t ChildPID;
1035
1036   // Create two pipes.
1037   if (pipe(PipeFD[0]) != 0 || pipe(PipeFD[1]) != 0)
1038     perror("Error creating pipe: ");
1039
1040   ChildPID = fork();
1041
1042   if (ChildPID == 0) {
1043     // In the child...
1044
1045     // Close the parent ends of the pipes
1046     close(PipeFD[0][1]);
1047     close(PipeFD[1][0]);
1048
1049
1050     // Execute the child process.
1051     std::unique_ptr<char[]> ChildPath, ChildIn, ChildOut;
1052     {
1053       ChildPath.reset(new char[ChildExecPath.size() + 1]);
1054       std::copy(ChildExecPath.begin(), ChildExecPath.end(), &ChildPath[0]);
1055       ChildPath[ChildExecPath.size()] = '\0';
1056       std::string ChildInStr = utostr(PipeFD[0][0]);
1057       ChildIn.reset(new char[ChildInStr.size() + 1]);
1058       std::copy(ChildInStr.begin(), ChildInStr.end(), &ChildIn[0]);
1059       ChildIn[ChildInStr.size()] = '\0';
1060       std::string ChildOutStr = utostr(PipeFD[1][1]);
1061       ChildOut.reset(new char[ChildOutStr.size() + 1]);
1062       std::copy(ChildOutStr.begin(), ChildOutStr.end(), &ChildOut[0]);
1063       ChildOut[ChildOutStr.size()] = '\0';
1064     }
1065
1066     char * const args[] = { &ChildPath[0], &ChildIn[0], &ChildOut[0], nullptr };
1067     int rc = execv(ChildExecPath.c_str(), args);
1068     if (rc != 0)
1069       perror("Error executing child process: ");
1070     llvm_unreachable("Error executing child process");
1071   }
1072   // else we're the parent...
1073
1074   // Close the child ends of the pipes
1075   close(PipeFD[0][0]);
1076   close(PipeFD[1][1]);
1077
1078   // Return an RPC channel connected to our end of the pipes.
1079   return std::make_unique<FDRawChannel>(PipeFD[1][0], PipeFD[0][1]);
1080 #endif
1081 }