tools/lli/lli.cpp

   1 //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This utility provides a simple wrapper around the LLVM Execution Engines,
  11 // which allow the direct execution of LLVM programs through a Just-In-Time
  12 // compiler, or through an interpreter if no JIT is available for this platform.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/IR/LLVMContext.h"
  17 #include "RemoteMemoryManager.h"
  18 #include "RemoteTarget.h"
  19 #include "RemoteTargetExternal.h"
  20 #include "llvm/ADT/Triple.h"
  21 #include "llvm/Bitcode/ReaderWriter.h"
  22 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  23 #include "llvm/ExecutionEngine/GenericValue.h"
  24 #include "llvm/ExecutionEngine/Interpreter.h"
  25 #include "llvm/ExecutionEngine/JITEventListener.h"
  26 #include "llvm/ExecutionEngine/MCJIT.h"
  27 #include "llvm/ExecutionEngine/ObjectCache.h"
  28 #include "llvm/ExecutionEngine/OrcMCJITReplacement.h"
  29 #include "llvm/ExecutionEngine/SectionMemoryManager.h"
  30 #include "llvm/IR/IRBuilder.h"
  31 #include "llvm/IR/Module.h"
  32 #include "llvm/IR/Type.h"
  33 #include "llvm/IR/TypeBuilder.h"
  34 #include "llvm/IRReader/IRReader.h"
  35 #include "llvm/Object/Archive.h"
  36 #include "llvm/Object/ObjectFile.h"
  37 #include "llvm/Support/CommandLine.h"
  38 #include "llvm/Support/Debug.h"
  39 #include "llvm/Support/DynamicLibrary.h"
  40 #include "llvm/Support/Format.h"
  41 #include "llvm/Support/ManagedStatic.h"
  42 #include "llvm/Support/MathExtras.h"
  43 #include "llvm/Support/Memory.h"
  44 #include "llvm/Support/MemoryBuffer.h"
  45 #include "llvm/Support/Path.h"
  46 #include "llvm/Support/PluginLoader.h"
  47 #include "llvm/Support/PrettyStackTrace.h"
  48 #include "llvm/Support/Process.h"
  49 #include "llvm/Support/Program.h"
  50 #include "llvm/Support/Signals.h"
  51 #include "llvm/Support/SourceMgr.h"
  52 #include "llvm/Support/TargetSelect.h"
  53 #include "llvm/Support/raw_ostream.h"
  54 #include "llvm/Transforms/Instrumentation.h"
  55 #include <cerrno>
  56
  57 #ifdef __CYGWIN__
  58 #include <cygwin/version.h>
  59 #if defined(CYGWIN_VERSION_DLL_MAJOR) && CYGWIN_VERSION_DLL_MAJOR<1007
  60 #define DO_NOTHING_ATEXIT 1
  61 #endif
  62 #endif
  63
  64 using namespace llvm;
  65
  66 #define DEBUG_TYPE "lli"
  67
  68 namespace {
  69   cl::opt<std::string>
  70   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
  71
  72   cl::list<std::string>
  73   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
  74
  75   cl::opt<bool> ForceInterpreter("force-interpreter",
  76                                  cl::desc("Force interpretation: disable JIT"),
  77                                  cl::init(false));
  78
  79   cl::opt<bool> UseOrcMCJITReplacement("use-orcmcjit",
  80                                        cl::desc("Use the experimental "
  81                                                 "OrcMCJITReplacement as a "
  82                                                 "drop-in replacement for "
  83                                                 "MCJIT."),
  84                                        cl::init(false));
  85
  86   // The MCJIT supports building for a target address space separate from
  87   // the JIT compilation process. Use a forked process and a copying
  88   // memory manager with IPC to execute using this functionality.
  89   cl::opt<bool> RemoteMCJIT("remote-mcjit",
  90     cl::desc("Execute MCJIT'ed code in a separate process."),
  91     cl::init(false));
  92
  93   // Manually specify the child process for remote execution. This overrides
  94   // the simulated remote execution that allocates address space for child
  95   // execution. The child process will be executed and will communicate with
  96   // lli via stdin/stdout pipes.
  97   cl::opt<std::string>
  98   ChildExecPath("mcjit-remote-process",
  99                 cl::desc("Specify the filename of the process to launch "
 100                          "for remote MCJIT execution.  If none is specified,"
 101                          "\n\tremote execution will be simulated in-process."),
 102                 cl::value_desc("filename"), cl::init(""));
 103
 104   // Determine optimization level.
 105   cl::opt<char>
 106   OptLevel("O",
 107            cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
 108                     "(default = '-O2')"),
 109            cl::Prefix,
 110            cl::ZeroOrMore,
 111            cl::init(' '));
 112
 113   cl::opt<std::string>
 114   TargetTriple("mtriple", cl::desc("Override target triple for module"));
 115
 116   cl::opt<std::string>
 117   MArch("march",
 118         cl::desc("Architecture to generate assembly for (see --version)"));
 119
 120   cl::opt<std::string>
 121   MCPU("mcpu",
 122        cl::desc("Target a specific cpu type (-mcpu=help for details)"),
 123        cl::value_desc("cpu-name"),
 124        cl::init(""));
 125
 126   cl::list<std::string>
 127   MAttrs("mattr",
 128          cl::CommaSeparated,
 129          cl::desc("Target specific attributes (-mattr=help for details)"),
 130          cl::value_desc("a1,+a2,-a3,..."));
 131
 132   cl::opt<std::string>
 133   EntryFunc("entry-function",
 134             cl::desc("Specify the entry function (default = 'main') "
 135                      "of the executable"),
 136             cl::value_desc("function"),
 137             cl::init("main"));
 138
 139   cl::list<std::string>
 140   ExtraModules("extra-module",
 141          cl::desc("Extra modules to be loaded"),
 142          cl::value_desc("input bitcode"));
 143
 144   cl::list<std::string>
 145   ExtraObjects("extra-object",
 146          cl::desc("Extra object files to be loaded"),
 147          cl::value_desc("input object"));
 148
 149   cl::list<std::string>
 150   ExtraArchives("extra-archive",
 151          cl::desc("Extra archive files to be loaded"),
 152          cl::value_desc("input archive"));
 153
 154   cl::opt<bool>
 155   EnableCacheManager("enable-cache-manager",
 156         cl::desc("Use cache manager to save/load mdoules"),
 157         cl::init(false));
 158
 159   cl::opt<std::string>
 160   ObjectCacheDir("object-cache-dir",
 161                   cl::desc("Directory to store cached object files "
 162                            "(must be user writable)"),
 163                   cl::init(""));
 164
 165   cl::opt<std::string>
 166   FakeArgv0("fake-argv0",
 167             cl::desc("Override the 'argv[0]' value passed into the executing"
 168                      " program"), cl::value_desc("executable"));
 169
 170   cl::opt<bool>
 171   DisableCoreFiles("disable-core-files", cl::Hidden,
 172                    cl::desc("Disable emission of core files if possible"));
 173
 174   cl::opt<bool>
 175   NoLazyCompilation("disable-lazy-compilation",
 176                   cl::desc("Disable JIT lazy compilation"),
 177                   cl::init(false));
 178
 179   cl::opt<Reloc::Model>
 180   RelocModel("relocation-model",
 181              cl::desc("Choose relocation model"),
 182              cl::init(Reloc::Default),
 183              cl::values(
 184             clEnumValN(Reloc::Default, "default",
 185                        "Target default relocation model"),
 186             clEnumValN(Reloc::Static, "static",
 187                        "Non-relocatable code"),
 188             clEnumValN(Reloc::PIC_, "pic",
 189                        "Fully relocatable, position independent code"),
 190             clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic",
 191                        "Relocatable external references, non-relocatable code"),
 192             clEnumValEnd));
 193
 194   cl::opt<llvm::CodeModel::Model>
 195   CMModel("code-model",
 196           cl::desc("Choose code model"),
 197           cl::init(CodeModel::JITDefault),
 198           cl::values(clEnumValN(CodeModel::JITDefault, "default",
 199                                 "Target default JIT code model"),
 200                      clEnumValN(CodeModel::Small, "small",
 201                                 "Small code model"),
 202                      clEnumValN(CodeModel::Kernel, "kernel",
 203                                 "Kernel code model"),
 204                      clEnumValN(CodeModel::Medium, "medium",
 205                                 "Medium code model"),
 206                      clEnumValN(CodeModel::Large, "large",
 207                                 "Large code model"),
 208                      clEnumValEnd));
 209
 210   cl::opt<bool>
 211   GenerateSoftFloatCalls("soft-float",
 212     cl::desc("Generate software floating point library calls"),
 213     cl::init(false));
 214
 215   cl::opt<llvm::FloatABI::ABIType>
 216   FloatABIForCalls("float-abi",
 217                    cl::desc("Choose float ABI type"),
 218                    cl::init(FloatABI::Default),
 219                    cl::values(
 220                      clEnumValN(FloatABI::Default, "default",
 221                                 "Target default float ABI type"),
 222                      clEnumValN(FloatABI::Soft, "soft",
 223                                 "Soft float ABI (implied by -soft-float)"),
 224                      clEnumValN(FloatABI::Hard, "hard",
 225                                 "Hard float ABI (uses FP registers)"),
 226                      clEnumValEnd));
 227   cl::opt<bool>
 228 // In debug builds, make this default to true.
 229 #ifdef NDEBUG
 230 #define EMIT_DEBUG false
 231 #else
 232 #define EMIT_DEBUG true
 233 #endif
 234   EmitJitDebugInfo("jit-emit-debug",
 235     cl::desc("Emit debug information to debugger"),
 236     cl::init(EMIT_DEBUG));
 237 #undef EMIT_DEBUG
 238
 239   static cl::opt<bool>
 240   EmitJitDebugInfoToDisk("jit-emit-debug-to-disk",
 241     cl::Hidden,
 242     cl::desc("Emit debug info objfiles to disk"),
 243     cl::init(false));
 244 }
 245
 246 //===----------------------------------------------------------------------===//
 247 // Object cache
 248 //
 249 // This object cache implementation writes cached objects to disk to the
 250 // directory specified by CacheDir, using a filename provided in the module
 251 // descriptor. The cache tries to load a saved object using that path if the
 252 // file exists. CacheDir defaults to "", in which case objects are cached
 253 // alongside their originating bitcodes.
 254 //
 255 class LLIObjectCache : public ObjectCache {
 256 public:
 257   LLIObjectCache(const std::string& CacheDir) : CacheDir(CacheDir) {
 258     // Add trailing '/' to cache dir if necessary.
 259     if (!this->CacheDir.empty() &&
 260         this->CacheDir[this->CacheDir.size() - 1] != '/')
 261       this->CacheDir += '/';
 262   }
 263   virtual ~LLIObjectCache() {}
 264
 265   void notifyObjectCompiled(const Module *M, MemoryBufferRef Obj) override {
 266     const std::string ModuleID = M->getModuleIdentifier();
 267     std::string CacheName;
 268     if (!getCacheFilename(ModuleID, CacheName))
 269       return;
 270     if (!CacheDir.empty()) { // Create user-defined cache dir.
 271       SmallString<128> dir(CacheName);
 272       sys::path::remove_filename(dir);
 273       sys::fs::create_directories(Twine(dir));
 274     }
 275     std::error_code EC;
 276     raw_fd_ostream outfile(CacheName, EC, sys::fs::F_None);
 277     outfile.write(Obj.getBufferStart(), Obj.getBufferSize());
 278     outfile.close();
 279   }
 280
 281   std::unique_ptr<MemoryBuffer> getObject(const Module* M) override {
 282     const std::string ModuleID = M->getModuleIdentifier();
 283     std::string CacheName;
 284     if (!getCacheFilename(ModuleID, CacheName))
 285       return nullptr;
 286     // Load the object from the cache filename
 287     ErrorOr<std::unique_ptr<MemoryBuffer>> IRObjectBuffer =
 288         MemoryBuffer::getFile(CacheName.c_str(), -1, false);
 289     // If the file isn't there, that's OK.
 290     if (!IRObjectBuffer)
 291       return nullptr;
 292     // MCJIT will want to write into this buffer, and we don't want that
 293     // because the file has probably just been mmapped.  Instead we make
 294     // a copy.  The filed-based buffer will be released when it goes
 295     // out of scope.
 296     return MemoryBuffer::getMemBufferCopy(IRObjectBuffer.get()->getBuffer());
 297   }
 298
 299 private:
 300   std::string CacheDir;
 301
 302   bool getCacheFilename(const std::string &ModID, std::string &CacheName) {
 303     std::string Prefix("file:");
 304     size_t PrefixLength = Prefix.length();
 305     if (ModID.substr(0, PrefixLength) != Prefix)
 306       return false;
 307         std::string CacheSubdir = ModID.substr(PrefixLength);
 308 #if defined(_WIN32)
 309         // Transform "X:\foo" => "/X\foo" for convenience.
 310         if (isalpha(CacheSubdir[0]) && CacheSubdir[1] == ':') {
 311           CacheSubdir[1] = CacheSubdir[0];
 312           CacheSubdir[0] = '/';
 313         }
 314 #endif
 315     CacheName = CacheDir + CacheSubdir;
 316     size_t pos = CacheName.rfind('.');
 317     CacheName.replace(pos, CacheName.length() - pos, ".o");
 318     return true;
 319   }
 320 };
 321
 322 static ExecutionEngine *EE = nullptr;
 323 static LLIObjectCache *CacheManager = nullptr;
 324
 325 static void do_shutdown() {
 326   // Cygwin-1.5 invokes DLL's dtors before atexit handler.
 327 #ifndef DO_NOTHING_ATEXIT
 328   delete EE;
 329   if (CacheManager)
 330     delete CacheManager;
 331   llvm_shutdown();
 332 #endif
 333 }
 334
 335 // On Mingw and Cygwin, an external symbol named '__main' is called from the
 336 // generated 'main' function to allow static intialization.  To avoid linking
 337 // problems with remote targets (because lli's remote target support does not
 338 // currently handle external linking) we add a secondary module which defines
 339 // an empty '__main' function.
 340 static void addCygMingExtraModule(ExecutionEngine *EE,
 341                                   LLVMContext &Context,
 342                                   StringRef TargetTripleStr) {
 343   IRBuilder<> Builder(Context);
 344   Triple TargetTriple(TargetTripleStr);
 345
 346   // Create a new module.
 347   std::unique_ptr<Module> M = make_unique<Module>("CygMingHelper", Context);
 348   M->setTargetTriple(TargetTripleStr);
 349
 350   // Create an empty function named "__main".
 351   Function *Result;
 352   if (TargetTriple.isArch64Bit()) {
 353     Result = Function::Create(
 354       TypeBuilder<int64_t(void), false>::get(Context),
 355       GlobalValue::ExternalLinkage, "__main", M.get());
 356   } else {
 357     Result = Function::Create(
 358       TypeBuilder<int32_t(void), false>::get(Context),
 359       GlobalValue::ExternalLinkage, "__main", M.get());
 360   }
 361   BasicBlock *BB = BasicBlock::Create(Context, "__main", Result);
 362   Builder.SetInsertPoint(BB);
 363   Value *ReturnVal;
 364   if (TargetTriple.isArch64Bit())
 365     ReturnVal = ConstantInt::get(Context, APInt(64, 0));
 366   else
 367     ReturnVal = ConstantInt::get(Context, APInt(32, 0));
 368   Builder.CreateRet(ReturnVal);
 369
 370   // Add this new module to the ExecutionEngine.
 371   EE->addModule(std::move(M));
 372 }
 373
 374
 375 //===----------------------------------------------------------------------===//
 376 // main Driver function
 377 //
 378 int main(int argc, char **argv, char * const *envp) {
 379   sys::PrintStackTraceOnErrorSignal();
 380   PrettyStackTraceProgram X(argc, argv);
 381
 382   LLVMContext &Context = getGlobalContext();
 383   atexit(do_shutdown);  // Call llvm_shutdown() on exit.
 384
 385   // If we have a native target, initialize it to ensure it is linked in and
 386   // usable by the JIT.
 387   InitializeNativeTarget();
 388   InitializeNativeTargetAsmPrinter();
 389   InitializeNativeTargetAsmParser();
 390
 391   cl::ParseCommandLineOptions(argc, argv,
 392                               "llvm interpreter & dynamic compiler\n");
 393
 394   // If the user doesn't want core files, disable them.
 395   if (DisableCoreFiles)
 396     sys::Process::PreventCoreFiles();
 397
 398   // Load the bitcode...
 399   SMDiagnostic Err;
 400   std::unique_ptr<Module> Owner = parseIRFile(InputFile, Err, Context);
 401   Module *Mod = Owner.get();
 402   if (!Mod) {
 403     Err.print(argv[0], errs());
 404     return 1;
 405   }
 406
 407   if (EnableCacheManager) {
 408     std::string CacheName("file:");
 409     CacheName.append(InputFile);
 410     Mod->setModuleIdentifier(CacheName);
 411   }
 412
 413   // If not jitting lazily, load the whole bitcode file eagerly too.
 414   if (NoLazyCompilation) {
 415     if (std::error_code EC = Mod->materializeAllPermanently()) {
 416       errs() << argv[0] << ": bitcode didn't read correctly.\n";
 417       errs() << "Reason: " << EC.message() << "\n";
 418       exit(1);
 419     }
 420   }
 421
 422   std::string ErrorMsg;
 423   EngineBuilder builder(std::move(Owner));
 424   builder.setMArch(MArch);
 425   builder.setMCPU(MCPU);
 426   builder.setMAttrs(MAttrs);
 427   builder.setRelocationModel(RelocModel);
 428   builder.setCodeModel(CMModel);
 429   builder.setErrorStr(&ErrorMsg);
 430   builder.setEngineKind(ForceInterpreter
 431                         ? EngineKind::Interpreter
 432                         : EngineKind::JIT);
 433   builder.setUseOrcMCJITReplacement(UseOrcMCJITReplacement);
 434
 435   // If we are supposed to override the target triple, do so now.
 436   if (!TargetTriple.empty())
 437     Mod->setTargetTriple(Triple::normalize(TargetTriple));
 438
 439   // Enable MCJIT if desired.
 440   RTDyldMemoryManager *RTDyldMM = nullptr;
 441   if (!ForceInterpreter) {
 442     if (RemoteMCJIT)
 443       RTDyldMM = new RemoteMemoryManager();
 444     else
 445       RTDyldMM = new SectionMemoryManager();
 446
 447     // Deliberately construct a temp std::unique_ptr to pass in. Do not null out
 448     // RTDyldMM: We still use it below, even though we don't own it.
 449     builder.setMCJITMemoryManager(
 450       std::unique_ptr<RTDyldMemoryManager>(RTDyldMM));
 451   } else if (RemoteMCJIT) {
 452     errs() << "error: Remote process execution does not work with the "
 453               "interpreter.\n";
 454     exit(1);
 455   }
 456
 457   CodeGenOpt::Level OLvl = CodeGenOpt::Default;
 458   switch (OptLevel) {
 459   default:
 460     errs() << argv[0] << ": invalid optimization level.\n";
 461     return 1;
 462   case ' ': break;
 463   case '0': OLvl = CodeGenOpt::None; break;
 464   case '1': OLvl = CodeGenOpt::Less; break;
 465   case '2': OLvl = CodeGenOpt::Default; break;
 466   case '3': OLvl = CodeGenOpt::Aggressive; break;
 467   }
 468   builder.setOptLevel(OLvl);
 469
 470   TargetOptions Options;
 471   Options.UseSoftFloat = GenerateSoftFloatCalls;
 472   if (FloatABIForCalls != FloatABI::Default)
 473     Options.FloatABIType = FloatABIForCalls;
 474   if (GenerateSoftFloatCalls)
 475     FloatABIForCalls = FloatABI::Soft;
 476
 477   // Remote target execution doesn't handle EH or debug registration.
 478   if (!RemoteMCJIT) {
 479     Options.JITEmitDebugInfo = EmitJitDebugInfo;
 480     Options.JITEmitDebugInfoToDisk = EmitJitDebugInfoToDisk;
 481   }
 482
 483   builder.setTargetOptions(Options);
 484
 485   EE = builder.create();
 486   if (!EE) {
 487     if (!ErrorMsg.empty())
 488       errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
 489     else
 490       errs() << argv[0] << ": unknown error creating EE!\n";
 491     exit(1);
 492   }
 493
 494   if (EnableCacheManager) {
 495     CacheManager = new LLIObjectCache(ObjectCacheDir);
 496     EE->setObjectCache(CacheManager);
 497   }
 498
 499   // Load any additional modules specified on the command line.
 500   for (unsigned i = 0, e = ExtraModules.size(); i != e; ++i) {
 501     std::unique_ptr<Module> XMod = parseIRFile(ExtraModules[i], Err, Context);
 502     if (!XMod) {
 503       Err.print(argv[0], errs());
 504       return 1;
 505     }
 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     ErrorOr<object::OwningBinary<object::ObjectFile>> Obj =
 516         object::ObjectFile::createObjectFile(ExtraObjects[i]);
 517     if (!Obj) {
 518       Err.print(argv[0], errs());
 519       return 1;
 520     }
 521     object::OwningBinary<object::ObjectFile> &O = Obj.get();
 522     EE->addObjectFile(std::move(O));
 523   }
 524
 525   for (unsigned i = 0, e = ExtraArchives.size(); i != e; ++i) {
 526     ErrorOr<std::unique_ptr<MemoryBuffer>> ArBufOrErr =
 527         MemoryBuffer::getFileOrSTDIN(ExtraArchives[i]);
 528     if (!ArBufOrErr) {
 529       Err.print(argv[0], errs());
 530       return 1;
 531     }
 532     std::unique_ptr<MemoryBuffer> &ArBuf = ArBufOrErr.get();
 533
 534     ErrorOr<std::unique_ptr<object::Archive>> ArOrErr =
 535         object::Archive::create(ArBuf->getMemBufferRef());
 536     if (std::error_code EC = ArOrErr.getError()) {
 537       errs() << EC.message();
 538       return 1;
 539     }
 540     std::unique_ptr<object::Archive> &Ar = ArOrErr.get();
 541
 542     object::OwningBinary<object::Archive> OB(std::move(Ar), std::move(ArBuf));
 543
 544     EE->addArchive(std::move(OB));
 545   }
 546
 547   // If the target is Cygwin/MingW and we are generating remote code, we
 548   // need an extra module to help out with linking.
 549   if (RemoteMCJIT && Triple(Mod->getTargetTriple()).isOSCygMing()) {
 550     addCygMingExtraModule(EE, Context, Mod->getTargetTriple());
 551   }
 552
 553   // The following functions have no effect if their respective profiling
 554   // support wasn't enabled in the build configuration.
 555   EE->RegisterJITEventListener(
 556                 JITEventListener::createOProfileJITEventListener());
 557   EE->RegisterJITEventListener(
 558                 JITEventListener::createIntelJITEventListener());
 559
 560   if (!NoLazyCompilation && RemoteMCJIT) {
 561     errs() << "warning: remote mcjit does not support lazy compilation\n";
 562     NoLazyCompilation = true;
 563   }
 564   EE->DisableLazyCompilation(NoLazyCompilation);
 565
 566   // If the user specifically requested an argv[0] to pass into the program,
 567   // do it now.
 568   if (!FakeArgv0.empty()) {
 569     InputFile = static_cast<std::string>(FakeArgv0);
 570   } else {
 571     // Otherwise, if there is a .bc suffix on the executable strip it off, it
 572     // might confuse the program.
 573     if (StringRef(InputFile).endswith(".bc"))
 574       InputFile.erase(InputFile.length() - 3);
 575   }
 576
 577   // Add the module's name to the start of the vector of arguments to main().
 578   InputArgv.insert(InputArgv.begin(), InputFile);
 579
 580   // Call the main function from M as if its signature were:
 581   //   int main (int argc, char **argv, const char **envp)
 582   // using the contents of Args to determine argc & argv, and the contents of
 583   // EnvVars to determine envp.
 584   //
 585   Function *EntryFn = Mod->getFunction(EntryFunc);
 586   if (!EntryFn) {
 587     errs() << '\'' << EntryFunc << "\' function not found in module.\n";
 588     return -1;
 589   }
 590
 591   // Reset errno to zero on entry to main.
 592   errno = 0;
 593
 594   int Result;
 595
 596   if (!RemoteMCJIT) {
 597     // If the program doesn't explicitly call exit, we will need the Exit
 598     // function later on to make an explicit call, so get the function now.
 599     Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
 600                                                       Type::getInt32Ty(Context),
 601                                                       nullptr);
 602
 603     // Run static constructors.
 604     if (!ForceInterpreter) {
 605       // Give MCJIT a chance to apply relocations and set page permissions.
 606       EE->finalizeObject();
 607     }
 608     EE->runStaticConstructorsDestructors(false);
 609
 610     // Trigger compilation separately so code regions that need to be
 611     // invalidated will be known.
 612     (void)EE->getPointerToFunction(EntryFn);
 613     // Clear instruction cache before code will be executed.
 614     if (RTDyldMM)
 615       static_cast<SectionMemoryManager*>(RTDyldMM)->invalidateInstructionCache();
 616
 617     // Run main.
 618     Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
 619
 620     // Run static destructors.
 621     EE->runStaticConstructorsDestructors(true);
 622
 623     // If the program didn't call exit explicitly, we should call it now.
 624     // This ensures that any atexit handlers get called correctly.
 625     if (Function *ExitF = dyn_cast<Function>(Exit)) {
 626       std::vector<GenericValue> Args;
 627       GenericValue ResultGV;
 628       ResultGV.IntVal = APInt(32, Result);
 629       Args.push_back(ResultGV);
 630       EE->runFunction(ExitF, Args);
 631       errs() << "ERROR: exit(" << Result << ") returned!\n";
 632       abort();
 633     } else {
 634       errs() << "ERROR: exit defined with wrong prototype!\n";
 635       abort();
 636     }
 637   } else {
 638     // else == "if (RemoteMCJIT)"
 639
 640     // Remote target MCJIT doesn't (yet) support static constructors. No reason
 641     // it couldn't. This is a limitation of the LLI implemantation, not the
 642     // MCJIT itself. FIXME.
 643     //
 644     RemoteMemoryManager *MM = static_cast<RemoteMemoryManager*>(RTDyldMM);
 645     // Everything is prepared now, so lay out our program for the target
 646     // address space, assign the section addresses to resolve any relocations,
 647     // and send it to the target.
 648
 649     std::unique_ptr<RemoteTarget> Target;
 650     if (!ChildExecPath.empty()) { // Remote execution on a child process
 651 #ifndef LLVM_ON_UNIX
 652       // FIXME: Remove this pointless fallback mode which causes tests to "pass"
 653       // on platforms where they should XFAIL.
 654       errs() << "Warning: host does not support external remote targets.\n"
 655              << "  Defaulting to simulated remote execution\n";
 656       Target.reset(new RemoteTarget);
 657 #else
 658       if (!sys::fs::can_execute(ChildExecPath)) {
 659         errs() << "Unable to find usable child executable: '" << ChildExecPath
 660                << "'\n";
 661         return -1;
 662       }
 663       Target.reset(new RemoteTargetExternal(ChildExecPath));
 664 #endif
 665     } else {
 666       // No child process name provided, use simulated remote execution.
 667       Target.reset(new RemoteTarget);
 668     }
 669
 670     // Give the memory manager a pointer to our remote target interface object.
 671     MM->setRemoteTarget(Target.get());
 672
 673     // Create the remote target.
 674     if (!Target->create()) {
 675       errs() << "ERROR: " << Target->getErrorMsg() << "\n";
 676       return EXIT_FAILURE;
 677     }
 678
 679     // Since we're executing in a (at least simulated) remote address space,
 680     // we can't use the ExecutionEngine::runFunctionAsMain(). We have to
 681     // grab the function address directly here and tell the remote target
 682     // to execute the function.
 683     //
 684     // Our memory manager will map generated code into the remote address
 685     // space as it is loaded and copy the bits over during the finalizeMemory
 686     // operation.
 687     //
 688     // FIXME: argv and envp handling.
 689     uint64_t Entry = EE->getFunctionAddress(EntryFn->getName().str());
 690
 691     DEBUG(dbgs() << "Executing '" << EntryFn->getName() << "' at 0x"
 692                  << format("%llx", Entry) << "\n");
 693
 694     if (!Target->executeCode(Entry, Result))
 695       errs() << "ERROR: " << Target->getErrorMsg() << "\n";
 696
 697     // Like static constructors, the remote target MCJIT support doesn't handle
 698     // this yet. It could. FIXME.
 699
 700     // Stop the remote target
 701     Target->stop();
 702   }
 703
 704   return Result;
 705 }