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