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