blob: 057841f0ad604d4389aa73ae1822ad0dea361bed [file] [log] [blame]
Chris Lattnera0d7b082002-12-23 23:59:41 +00001//===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
Misha Brukman650ba8e2005-04-22 00:00:37 +00002//
John Criswell09344dc2003-10-20 17:47:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner345353d2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman650ba8e2005-04-22 00:00:37 +00007//
John Criswell09344dc2003-10-20 17:47:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerd7ff5782001-08-23 17:05:04 +00009//
Chris Lattner141ea3a2003-12-26 05:07:35 +000010// 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
Torok Edwinf011f282009-07-03 12:11:32 +000012// compiler, or through an interpreter if no JIT is available for this platform.
Chris Lattnerd7ff5782001-08-23 17:05:04 +000013//
14//===----------------------------------------------------------------------===//
15
Chandler Carruth9fb823b2013-01-02 11:36:10 +000016#include "llvm/IR/LLVMContext.h"
Lang Hames9528bba2015-03-25 12:11:48 +000017#include "OrcLazyJIT.h"
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +000018#include "RemoteMemoryManager.h"
Jim Grosbach0f435d02012-09-05 16:50:34 +000019#include "RemoteTarget.h"
Alp Tokerce4ab592014-01-23 19:57:16 +000020#include "RemoteTargetExternal.h"
Duncan Sands3bd97fe2010-08-28 01:30:02 +000021#include "llvm/ADT/Triple.h"
Chris Lattner2785bdb2007-05-06 04:58:26 +000022#include "llvm/Bitcode/ReaderWriter.h"
Chris Lattner5af6a3f2006-08-01 22:34:35 +000023#include "llvm/CodeGen/LinkAllCodegenComponents.h"
Brian Gaekee99ca442003-09-05 19:42:34 +000024#include "llvm/ExecutionEngine/GenericValue.h"
Jeffrey Yasskin0b08f3d2009-06-25 02:04:04 +000025#include "llvm/ExecutionEngine/Interpreter.h"
Jeffrey Yasskin0b08f3d2009-06-25 02:04:04 +000026#include "llvm/ExecutionEngine/JITEventListener.h"
Daniel Dunbar7e5d8a72010-11-17 16:06:43 +000027#include "llvm/ExecutionEngine/MCJIT.h"
Lang Hames173c69f2014-01-08 04:09:09 +000028#include "llvm/ExecutionEngine/ObjectCache.h"
Lang Hames93de2a12015-01-23 21:25:00 +000029#include "llvm/ExecutionEngine/OrcMCJITReplacement.h"
Andrew Kaylor58365b92012-11-27 19:49:00 +000030#include "llvm/ExecutionEngine/SectionMemoryManager.h"
Andrew Kaylor1ca510e2013-10-29 01:29:56 +000031#include "llvm/IR/IRBuilder.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000032#include "llvm/IR/Module.h"
33#include "llvm/IR/Type.h"
Andrew Kaylor1ca510e2013-10-29 01:29:56 +000034#include "llvm/IR/TypeBuilder.h"
Chandler Carruthe60e57b2013-03-26 02:25:37 +000035#include "llvm/IRReader/IRReader.h"
Lang Hames173c69f2014-01-08 04:09:09 +000036#include "llvm/Object/Archive.h"
37#include "llvm/Object/ObjectFile.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000038#include "llvm/Support/CommandLine.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000039#include "llvm/Support/Debug.h"
40#include "llvm/Support/DynamicLibrary.h"
41#include "llvm/Support/Format.h"
Chris Lattner76d46322006-12-06 01:18:01 +000042#include "llvm/Support/ManagedStatic.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000043#include "llvm/Support/MathExtras.h"
44#include "llvm/Support/Memory.h"
Chris Lattner2785bdb2007-05-06 04:58:26 +000045#include "llvm/Support/MemoryBuffer.h"
Benjamin Kramer16132e62015-03-23 18:07:13 +000046#include "llvm/Support/Path.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000047#include "llvm/Support/PluginLoader.h"
Chris Lattnere3fc2d12009-03-06 05:34:10 +000048#include "llvm/Support/PrettyStackTrace.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000049#include "llvm/Support/Process.h"
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +000050#include "llvm/Support/Program.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000051#include "llvm/Support/Signals.h"
Chandler Carruthe60e57b2013-03-26 02:25:37 +000052#include "llvm/Support/SourceMgr.h"
Evan Cheng2bb40352011-08-24 18:08:43 +000053#include "llvm/Support/TargetSelect.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000054#include "llvm/Support/raw_ostream.h"
Daniel Maleaa960c542013-06-28 19:11:40 +000055#include "llvm/Transforms/Instrumentation.h"
Chris Lattner4c522b92007-04-27 17:02:33 +000056#include <cerrno>
NAKAMURA Takumi15304872010-10-22 14:53:59 +000057
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
Brian Gaeke960707c2003-11-11 22:41:34 +000065using namespace llvm;
66
Chandler Carruthf98597a2014-04-22 03:10:36 +000067#define DEBUG_TYPE "lli"
68
Chris Lattnera0d7b082002-12-23 23:59:41 +000069namespace {
Lang Hames9528bba2015-03-25 12:11:48 +000070
71 enum class JITKind { MCJIT, OrcMCJITReplacement, OrcLazy };
72
Chris Lattnera0d7b082002-12-23 23:59:41 +000073 cl::opt<std::string>
Gabor Greife16561c2007-07-05 17:07:56 +000074 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
Chris Lattnerf5cad152002-07-22 02:10:13 +000075
Chris Lattnera0d7b082002-12-23 23:59:41 +000076 cl::list<std::string>
77 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
Chris Lattnerf5cad152002-07-22 02:10:13 +000078
Chris Lattnera0d7b082002-12-23 23:59:41 +000079 cl::opt<bool> ForceInterpreter("force-interpreter",
Misha Brukmanc2186e32003-09-25 18:10:34 +000080 cl::desc("Force interpretation: disable JIT"),
81 cl::init(false));
Evan Cheng06d988e2008-08-08 08:12:06 +000082
Lang Hames9528bba2015-03-25 12:11:48 +000083 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));
Lang Hames93de2a12015-01-23 21:25:00 +000096
Jim Grosbach0f435d02012-09-05 16:50:34 +000097 // 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
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000104 // Manually specify the child process for remote execution. This overrides
105 // the simulated remote execution that allocates address space for child
Andrew Kaylor89352582013-10-29 01:33:14 +0000106 // execution. The child process will be executed and will communicate with
107 // lli via stdin/stdout pipes.
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000108 cl::opt<std::string>
Alp Tokera1186382014-01-22 21:52:35 +0000109 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(""));
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000114
Evan Cheng09bd0b12009-05-04 23:05:19 +0000115 // 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(' '));
Evan Cheng06d988e2008-08-08 08:12:06 +0000123
Chris Lattner76766cb2005-12-16 05:00:21 +0000124 cl::opt<std::string>
Chris Lattner78e9e102005-12-16 05:19:18 +0000125 TargetTriple("mtriple", cl::desc("Override target triple for module"));
Evan Cheng61582542008-11-05 23:21:52 +0000126
127 cl::opt<std::string>
Jeffrey Yasskin31faeff2010-02-05 16:19:36 +0000128 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>
Evan Cheng61582542008-11-05 23:21:52 +0000144 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"));
Eli Bendersky4c647582012-01-16 08:56:09 +0000149
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000150 cl::list<std::string>
Andrew Kaylor4404eb42013-10-28 21:58:15 +0000151 ExtraModules("extra-module",
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000152 cl::desc("Extra modules to be loaded"),
Alp Toker0a09ebf2013-10-28 22:51:25 +0000153 cl::value_desc("input bitcode"));
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000154
Lang Hames173c69f2014-01-08 04:09:09 +0000155 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",
Lang Hames1ddecc02014-01-09 05:24:05 +0000167 cl::desc("Use cache manager to save/load mdoules"),
Lang Hames173c69f2014-01-08 04:09:09 +0000168 cl::init(false));
169
Chris Lattner55644062003-10-28 22:51:44 +0000170 cl::opt<std::string>
Lang Hames1ddecc02014-01-09 05:24:05 +0000171 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>
Chris Lattner55644062003-10-28 22:51:44 +0000177 FakeArgv0("fake-argv0",
178 cl::desc("Override the 'argv[0]' value passed into the executing"
179 " program"), cl::value_desc("executable"));
Eli Bendersky4c647582012-01-16 08:56:09 +0000180
Chris Lattner3f0ffd32006-09-14 06:17:09 +0000181 cl::opt<bool>
182 DisableCoreFiles("disable-core-files", cl::Hidden,
183 cl::desc("Disable emission of core files if possible"));
Evan Cheng0422bef2008-04-22 06:51:41 +0000184
185 cl::opt<bool>
Evan Cheng16f036c2008-05-21 18:20:21 +0000186 NoLazyCompilation("disable-lazy-compilation",
Evan Cheng0422bef2008-04-22 06:51:41 +0000187 cl::desc("Disable JIT lazy compilation"),
188 cl::init(false));
Evan Cheng2129f592011-07-19 06:37:02 +0000189
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));
Evan Chengefd9b422011-07-20 07:51:56 +0000204
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
Nick Lewyckyb0e97892012-04-18 08:34:12 +0000221 cl::opt<bool>
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000222 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));
Chris Lattnera0d7b082002-12-23 23:59:41 +0000238}
Chris Lattner009f8102001-10-27 08:43:52 +0000239
Lang Hames173c69f2014-01-08 04:09:09 +0000240//===----------------------------------------------------------------------===//
241// Object cache
242//
Lang Hames1ddecc02014-01-09 05:24:05 +0000243// This object cache implementation writes cached objects to disk to the
244// directory specified by CacheDir, using a filename provided in the module
245// descriptor. The cache tries to load a saved object using that path if the
246// file exists. CacheDir defaults to "", in which case objects are cached
NAKAMURA Takumif462f9c2014-01-10 10:38:28 +0000247// alongside their originating bitcodes.
Lang Hames173c69f2014-01-08 04:09:09 +0000248//
249class LLIObjectCache : public ObjectCache {
250public:
Lang Hames1ddecc02014-01-09 05:24:05 +0000251 LLIObjectCache(const std::string& CacheDir) : CacheDir(CacheDir) {
252 // Add trailing '/' to cache dir if necessary.
Lang Hamesf9dd8fd2014-01-09 05:29:59 +0000253 if (!this->CacheDir.empty() &&
254 this->CacheDir[this->CacheDir.size() - 1] != '/')
NAKAMURA Takumif462f9c2014-01-10 10:38:28 +0000255 this->CacheDir += '/';
Lang Hames1ddecc02014-01-09 05:24:05 +0000256 }
Alexander Kornienkof817c1c2015-04-11 02:11:45 +0000257 ~LLIObjectCache() override {}
Lang Hames173c69f2014-01-08 04:09:09 +0000258
Rafael Espindola48af1c22014-08-19 18:44:46 +0000259 void notifyObjectCompiled(const Module *M, MemoryBufferRef Obj) override {
Lang Hames173c69f2014-01-08 04:09:09 +0000260 const std::string ModuleID = M->getModuleIdentifier();
261 std::string CacheName;
262 if (!getCacheFilename(ModuleID, CacheName))
263 return;
NAKAMURA Takumi390e0602014-01-10 10:38:34 +0000264 if (!CacheDir.empty()) { // Create user-defined cache dir.
265 SmallString<128> dir(CacheName);
266 sys::path::remove_filename(dir);
267 sys::fs::create_directories(Twine(dir));
268 }
Rafael Espindola3fd1e992014-08-25 18:16:47 +0000269 std::error_code EC;
270 raw_fd_ostream outfile(CacheName, EC, sys::fs::F_None);
Rafael Espindola48af1c22014-08-19 18:44:46 +0000271 outfile.write(Obj.getBufferStart(), Obj.getBufferSize());
Lang Hames173c69f2014-01-08 04:09:09 +0000272 outfile.close();
273 }
274
Rafael Espindola5f2bb7d2014-08-13 18:49:01 +0000275 std::unique_ptr<MemoryBuffer> getObject(const Module* M) override {
Lang Hames173c69f2014-01-08 04:09:09 +0000276 const std::string ModuleID = M->getModuleIdentifier();
277 std::string CacheName;
278 if (!getCacheFilename(ModuleID, CacheName))
Craig Toppere6cb63e2014-04-25 04:24:47 +0000279 return nullptr;
Lang Hames173c69f2014-01-08 04:09:09 +0000280 // Load the object from the cache filename
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000281 ErrorOr<std::unique_ptr<MemoryBuffer>> IRObjectBuffer =
282 MemoryBuffer::getFile(CacheName.c_str(), -1, false);
Lang Hames173c69f2014-01-08 04:09:09 +0000283 // If the file isn't there, that's OK.
284 if (!IRObjectBuffer)
Craig Toppere6cb63e2014-04-25 04:24:47 +0000285 return nullptr;
Lang Hames173c69f2014-01-08 04:09:09 +0000286 // MCJIT will want to write into this buffer, and we don't want that
287 // because the file has probably just been mmapped. Instead we make
288 // a copy. The filed-based buffer will be released when it goes
289 // out of scope.
Rafael Espindola3560ff22014-08-27 20:03:13 +0000290 return MemoryBuffer::getMemBufferCopy(IRObjectBuffer.get()->getBuffer());
Lang Hames173c69f2014-01-08 04:09:09 +0000291 }
292
293private:
Lang Hames1ddecc02014-01-09 05:24:05 +0000294 std::string CacheDir;
295
Lang Hames173c69f2014-01-08 04:09:09 +0000296 bool getCacheFilename(const std::string &ModID, std::string &CacheName) {
297 std::string Prefix("file:");
298 size_t PrefixLength = Prefix.length();
299 if (ModID.substr(0, PrefixLength) != Prefix)
300 return false;
NAKAMURA Takumid7fd6d92014-01-10 10:38:40 +0000301 std::string CacheSubdir = ModID.substr(PrefixLength);
302#if defined(_WIN32)
303 // Transform "X:\foo" => "/X\foo" for convenience.
304 if (isalpha(CacheSubdir[0]) && CacheSubdir[1] == ':') {
305 CacheSubdir[1] = CacheSubdir[0];
306 CacheSubdir[0] = '/';
307 }
308#endif
309 CacheName = CacheDir + CacheSubdir;
Lang Hames173c69f2014-01-08 04:09:09 +0000310 size_t pos = CacheName.rfind('.');
311 CacheName.replace(pos, CacheName.length() - pos, ".o");
312 return true;
313 }
314};
315
Craig Toppere6cb63e2014-04-25 04:24:47 +0000316static ExecutionEngine *EE = nullptr;
317static LLIObjectCache *CacheManager = nullptr;
Reid Spencere586f2e2007-03-03 18:21:44 +0000318
319static void do_shutdown() {
NAKAMURA Takumi15304872010-10-22 14:53:59 +0000320 // Cygwin-1.5 invokes DLL's dtors before atexit handler.
321#ifndef DO_NOTHING_ATEXIT
Reid Spencere586f2e2007-03-03 18:21:44 +0000322 delete EE;
Lang Hames173c69f2014-01-08 04:09:09 +0000323 if (CacheManager)
324 delete CacheManager;
Reid Spencere586f2e2007-03-03 18:21:44 +0000325 llvm_shutdown();
NAKAMURA Takumi15304872010-10-22 14:53:59 +0000326#endif
Reid Spencere586f2e2007-03-03 18:21:44 +0000327}
328
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000329// On Mingw and Cygwin, an external symbol named '__main' is called from the
330// generated 'main' function to allow static intialization. To avoid linking
331// problems with remote targets (because lli's remote target support does not
332// currently handle external linking) we add a secondary module which defines
333// an empty '__main' function.
334static void addCygMingExtraModule(ExecutionEngine *EE,
335 LLVMContext &Context,
336 StringRef TargetTripleStr) {
337 IRBuilder<> Builder(Context);
338 Triple TargetTriple(TargetTripleStr);
339
340 // Create a new module.
Rafael Espindola2a8a2792014-08-19 04:04:25 +0000341 std::unique_ptr<Module> M = make_unique<Module>("CygMingHelper", Context);
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000342 M->setTargetTriple(TargetTripleStr);
343
344 // Create an empty function named "__main".
345 Function *Result;
346 if (TargetTriple.isArch64Bit()) {
347 Result = Function::Create(
348 TypeBuilder<int64_t(void), false>::get(Context),
Rafael Espindola2a8a2792014-08-19 04:04:25 +0000349 GlobalValue::ExternalLinkage, "__main", M.get());
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000350 } else {
351 Result = Function::Create(
352 TypeBuilder<int32_t(void), false>::get(Context),
Rafael Espindola2a8a2792014-08-19 04:04:25 +0000353 GlobalValue::ExternalLinkage, "__main", M.get());
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000354 }
355 BasicBlock *BB = BasicBlock::Create(Context, "__main", Result);
356 Builder.SetInsertPoint(BB);
357 Value *ReturnVal;
358 if (TargetTriple.isArch64Bit())
359 ReturnVal = ConstantInt::get(Context, APInt(64, 0));
360 else
361 ReturnVal = ConstantInt::get(Context, APInt(32, 0));
362 Builder.CreateRet(ReturnVal);
363
364 // Add this new module to the ExecutionEngine.
Rafael Espindola2a8a2792014-08-19 04:04:25 +0000365 EE->addModule(std::move(M));
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000366}
367
Lang Hames1899d0c2015-06-09 02:43:27 +0000368CodeGenOpt::Level getOptLevel() {
369 switch (OptLevel) {
370 default:
371 errs() << "lli: Invalid optimization level.\n";
372 exit(1);
373 case '0': return CodeGenOpt::None;
374 case '1': return CodeGenOpt::Less;
375 case ' ':
376 case '2': return CodeGenOpt::Default;
377 case '3': return CodeGenOpt::Aggressive;
378 }
379 llvm_unreachable("Unrecognized opt level.");
380}
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000381
Chris Lattnerd7ff5782001-08-23 17:05:04 +0000382//===----------------------------------------------------------------------===//
Chris Lattnerd7ff5782001-08-23 17:05:04 +0000383// main Driver function
384//
Misha Brukman5b255e52003-10-14 21:39:53 +0000385int main(int argc, char **argv, char * const *envp) {
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000386 sys::PrintStackTraceOnErrorSignal();
387 PrettyStackTraceProgram X(argc, argv);
Eli Bendersky4c647582012-01-16 08:56:09 +0000388
Owen Anderson19251ec2009-07-15 22:16:10 +0000389 LLVMContext &Context = getGlobalContext();
Reid Spencere586f2e2007-03-03 18:21:44 +0000390 atexit(do_shutdown); // Call llvm_shutdown() on exit.
Daniel Dunbar3d92d932009-07-16 02:04:54 +0000391
392 // If we have a native target, initialize it to ensure it is linked in and
393 // usable by the JIT.
394 InitializeNativeTarget();
Jim Grosbach7b162492011-03-18 22:48:41 +0000395 InitializeNativeTargetAsmPrinter();
Jim Grosbach2cce3f92012-11-05 19:06:05 +0000396 InitializeNativeTargetAsmParser();
Daniel Dunbar3d92d932009-07-16 02:04:54 +0000397
Chris Lattner2785bdb2007-05-06 04:58:26 +0000398 cl::ParseCommandLineOptions(argc, argv,
Dan Gohman2c6a8212007-10-08 15:45:12 +0000399 "llvm interpreter & dynamic compiler\n");
Reid Spencer996ec722004-12-30 05:36:08 +0000400
Chris Lattner2785bdb2007-05-06 04:58:26 +0000401 // If the user doesn't want core files, disable them.
402 if (DisableCoreFiles)
403 sys::Process::PreventCoreFiles();
Eli Bendersky4c647582012-01-16 08:56:09 +0000404
Gabor Greife16561c2007-07-05 17:07:56 +0000405 // Load the bitcode...
Daniel Dunbar9589bf82010-11-13 00:28:01 +0000406 SMDiagnostic Err;
Rafael Espindolad233b062014-08-26 17:29:46 +0000407 std::unique_ptr<Module> Owner = parseIRFile(InputFile, Err, Context);
Rafael Espindola2a8a2792014-08-19 04:04:25 +0000408 Module *Mod = Owner.get();
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000409 if (!Mod) {
Chris Lattnera3a06812011-10-16 04:47:35 +0000410 Err.print(argv[0], errs());
Daniel Dunbar9589bf82010-11-13 00:28:01 +0000411 return 1;
Chris Lattner2785bdb2007-05-06 04:58:26 +0000412 }
413
Lang Hames9528bba2015-03-25 12:11:48 +0000414 if (UseJITKind == JITKind::OrcLazy)
415 return runOrcLazyJIT(std::move(Owner), argc, argv);
416
Lang Hames173c69f2014-01-08 04:09:09 +0000417 if (EnableCacheManager) {
Eric Christopher79cc1e32014-09-02 22:28:02 +0000418 std::string CacheName("file:");
419 CacheName.append(InputFile);
420 Mod->setModuleIdentifier(CacheName);
Lang Hames173c69f2014-01-08 04:09:09 +0000421 }
422
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000423 // If not jitting lazily, load the whole bitcode file eagerly too.
424 if (NoLazyCompilation) {
Rafael Espindola4453e42942014-06-13 03:07:50 +0000425 if (std::error_code EC = Mod->materializeAllPermanently()) {
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000426 errs() << argv[0] << ": bitcode didn't read correctly.\n";
Rafael Espindolae9fab9b2014-01-14 23:51:27 +0000427 errs() << "Reason: " << EC.message() << "\n";
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000428 exit(1);
429 }
Evan Cheng0422bef2008-04-22 06:51:41 +0000430 }
Chris Lattner2785bdb2007-05-06 04:58:26 +0000431
Rafael Espindolae9fab9b2014-01-14 23:51:27 +0000432 std::string ErrorMsg;
Rafael Espindola2a8a2792014-08-19 04:04:25 +0000433 EngineBuilder builder(std::move(Owner));
Jeffrey Yasskin31faeff2010-02-05 16:19:36 +0000434 builder.setMArch(MArch);
435 builder.setMCPU(MCPU);
436 builder.setMAttrs(MAttrs);
Evan Cheng2129f592011-07-19 06:37:02 +0000437 builder.setRelocationModel(RelocModel);
Evan Chengefd9b422011-07-20 07:51:56 +0000438 builder.setCodeModel(CMModel);
Daniel Dunbara78d8092009-07-18 08:07:13 +0000439 builder.setErrorStr(&ErrorMsg);
440 builder.setEngineKind(ForceInterpreter
Reid Klecknerfc8a2d52009-07-18 00:42:18 +0000441 ? EngineKind::Interpreter
442 : EngineKind::JIT);
Lang Hames9528bba2015-03-25 12:11:48 +0000443 builder.setUseOrcMCJITReplacement(UseJITKind == JITKind::OrcMCJITReplacement);
Reid Klecknerfc8a2d52009-07-18 00:42:18 +0000444
Chris Lattner2785bdb2007-05-06 04:58:26 +0000445 // If we are supposed to override the target triple, do so now.
446 if (!TargetTriple.empty())
Duncan Sands3bd97fe2010-08-28 01:30:02 +0000447 Mod->setTargetTriple(Triple::normalize(TargetTriple));
Evan Cheng0422bef2008-04-22 06:51:41 +0000448
Eli Bendersky4c647582012-01-16 08:56:09 +0000449 // Enable MCJIT if desired.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000450 RTDyldMemoryManager *RTDyldMM = nullptr;
Eric Christopher79cc1e32014-09-02 22:28:02 +0000451 if (!ForceInterpreter) {
Jim Grosbach0f435d02012-09-05 16:50:34 +0000452 if (RemoteMCJIT)
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000453 RTDyldMM = new RemoteMemoryManager();
Jim Grosbach0f435d02012-09-05 16:50:34 +0000454 else
Filip Pizlo9bc53e82013-05-14 19:29:00 +0000455 RTDyldMM = new SectionMemoryManager();
Lang Hames4a5697e2014-12-03 00:51:19 +0000456
457 // Deliberately construct a temp std::unique_ptr to pass in. Do not null out
458 // RTDyldMM: We still use it below, even though we don't own it.
459 builder.setMCJITMemoryManager(
460 std::unique_ptr<RTDyldMemoryManager>(RTDyldMM));
Lang Hames0f154902014-09-23 16:56:02 +0000461 } else if (RemoteMCJIT) {
462 errs() << "error: Remote process execution does not work with the "
463 "interpreter.\n";
464 exit(1);
Eli Bendersky4c647582012-01-16 08:56:09 +0000465 }
Daniel Dunbar70ff8b02010-11-17 16:06:37 +0000466
Lang Hames1899d0c2015-06-09 02:43:27 +0000467 builder.setOptLevel(getOptLevel());
Reid Klecknerfc8a2d52009-07-18 00:42:18 +0000468
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000469 TargetOptions Options;
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000470 if (FloatABIForCalls != FloatABI::Default)
471 Options.FloatABIType = FloatABIForCalls;
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000472
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000473 builder.setTargetOptions(Options);
474
Reid Klecknerfc8a2d52009-07-18 00:42:18 +0000475 EE = builder.create();
Chris Lattnerf840ed72009-07-07 18:31:09 +0000476 if (!EE) {
477 if (!ErrorMsg.empty())
Dan Gohmand8db3762009-07-15 16:35:29 +0000478 errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
Chris Lattnerf840ed72009-07-07 18:31:09 +0000479 else
Dan Gohmand8db3762009-07-15 16:35:29 +0000480 errs() << argv[0] << ": unknown error creating EE!\n";
Chris Lattner2785bdb2007-05-06 04:58:26 +0000481 exit(1);
482 }
483
Lang Hames173c69f2014-01-08 04:09:09 +0000484 if (EnableCacheManager) {
Lang Hames1ddecc02014-01-09 05:24:05 +0000485 CacheManager = new LLIObjectCache(ObjectCacheDir);
Lang Hames173c69f2014-01-08 04:09:09 +0000486 EE->setObjectCache(CacheManager);
487 }
488
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000489 // Load any additional modules specified on the command line.
490 for (unsigned i = 0, e = ExtraModules.size(); i != e; ++i) {
Rafael Espindolad233b062014-08-26 17:29:46 +0000491 std::unique_ptr<Module> XMod = parseIRFile(ExtraModules[i], Err, Context);
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000492 if (!XMod) {
493 Err.print(argv[0], errs());
494 return 1;
495 }
Lang Hames173c69f2014-01-08 04:09:09 +0000496 if (EnableCacheManager) {
Eric Christopher79cc1e32014-09-02 22:28:02 +0000497 std::string CacheName("file:");
498 CacheName.append(ExtraModules[i]);
499 XMod->setModuleIdentifier(CacheName);
Lang Hames173c69f2014-01-08 04:09:09 +0000500 }
Rafael Espindola2a8a2792014-08-19 04:04:25 +0000501 EE->addModule(std::move(XMod));
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000502 }
503
Lang Hames173c69f2014-01-08 04:09:09 +0000504 for (unsigned i = 0, e = ExtraObjects.size(); i != e; ++i) {
Rafael Espindola48af1c22014-08-19 18:44:46 +0000505 ErrorOr<object::OwningBinary<object::ObjectFile>> Obj =
Rafael Espindola51cc3602014-01-22 00:14:49 +0000506 object::ObjectFile::createObjectFile(ExtraObjects[i]);
Lang Hames173c69f2014-01-08 04:09:09 +0000507 if (!Obj) {
508 Err.print(argv[0], errs());
509 return 1;
510 }
Rafael Espindola061beab2014-08-20 15:19:37 +0000511 object::OwningBinary<object::ObjectFile> &O = Obj.get();
Rafael Espindola7271c192014-08-26 21:04:04 +0000512 EE->addObjectFile(std::move(O));
Lang Hames173c69f2014-01-08 04:09:09 +0000513 }
514
515 for (unsigned i = 0, e = ExtraArchives.size(); i != e; ++i) {
Rafael Espindola48af1c22014-08-19 18:44:46 +0000516 ErrorOr<std::unique_ptr<MemoryBuffer>> ArBufOrErr =
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000517 MemoryBuffer::getFileOrSTDIN(ExtraArchives[i]);
Rafael Espindola48af1c22014-08-19 18:44:46 +0000518 if (!ArBufOrErr) {
Lang Hames173c69f2014-01-08 04:09:09 +0000519 Err.print(argv[0], errs());
520 return 1;
521 }
Rafael Espindola48af1c22014-08-19 18:44:46 +0000522 std::unique_ptr<MemoryBuffer> &ArBuf = ArBufOrErr.get();
Rafael Espindolae1923412014-08-01 18:31:17 +0000523
524 ErrorOr<std::unique_ptr<object::Archive>> ArOrErr =
Rafael Espindola48af1c22014-08-19 18:44:46 +0000525 object::Archive::create(ArBuf->getMemBufferRef());
Rafael Espindolae1923412014-08-01 18:31:17 +0000526 if (std::error_code EC = ArOrErr.getError()) {
527 errs() << EC.message();
Lang Hames173c69f2014-01-08 04:09:09 +0000528 return 1;
529 }
Rafael Espindola48af1c22014-08-19 18:44:46 +0000530 std::unique_ptr<object::Archive> &Ar = ArOrErr.get();
531
532 object::OwningBinary<object::Archive> OB(std::move(Ar), std::move(ArBuf));
533
534 EE->addArchive(std::move(OB));
Lang Hames173c69f2014-01-08 04:09:09 +0000535 }
536
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000537 // If the target is Cygwin/MingW and we are generating remote code, we
538 // need an extra module to help out with linking.
539 if (RemoteMCJIT && Triple(Mod->getTargetTriple()).isOSCygMing()) {
540 addCygMingExtraModule(EE, Context, Mod->getTargetTriple());
541 }
542
Eli Bendersky5262ad22012-03-13 08:33:15 +0000543 // The following functions have no effect if their respective profiling
544 // support wasn't enabled in the build configuration.
545 EE->RegisterJITEventListener(
546 JITEventListener::createOProfileJITEventListener());
547 EE->RegisterJITEventListener(
548 JITEventListener::createIntelJITEventListener());
Jeffrey Yasskin0b08f3d2009-06-25 02:04:04 +0000549
Jim Grosbach0f435d02012-09-05 16:50:34 +0000550 if (!NoLazyCompilation && RemoteMCJIT) {
551 errs() << "warning: remote mcjit does not support lazy compilation\n";
552 NoLazyCompilation = true;
553 }
Jeffrey Yasskinaa8814a2009-10-27 22:39:42 +0000554 EE->DisableLazyCompilation(NoLazyCompilation);
Evan Cheng0422bef2008-04-22 06:51:41 +0000555
Chris Lattner2785bdb2007-05-06 04:58:26 +0000556 // If the user specifically requested an argv[0] to pass into the program,
557 // do it now.
558 if (!FakeArgv0.empty()) {
Chris Bienemane71fb5c2015-01-22 01:49:59 +0000559 InputFile = static_cast<std::string>(FakeArgv0);
Chris Lattner2785bdb2007-05-06 04:58:26 +0000560 } else {
561 // Otherwise, if there is a .bc suffix on the executable strip it off, it
562 // might confuse the program.
Benjamin Kramera944a9a2010-04-15 11:33:14 +0000563 if (StringRef(InputFile).endswith(".bc"))
Chris Lattner2785bdb2007-05-06 04:58:26 +0000564 InputFile.erase(InputFile.length() - 3);
565 }
566
567 // Add the module's name to the start of the vector of arguments to main().
568 InputArgv.insert(InputArgv.begin(), InputFile);
569
570 // Call the main function from M as if its signature were:
571 // int main (int argc, char **argv, const char **envp)
572 // using the contents of Args to determine argc & argv, and the contents of
573 // EnvVars to determine envp.
574 //
Evan Cheng61582542008-11-05 23:21:52 +0000575 Function *EntryFn = Mod->getFunction(EntryFunc);
576 if (!EntryFn) {
Dan Gohmand8db3762009-07-15 16:35:29 +0000577 errs() << '\'' << EntryFunc << "\' function not found in module.\n";
Chris Lattner2785bdb2007-05-06 04:58:26 +0000578 return -1;
579 }
580
Chris Lattner2785bdb2007-05-06 04:58:26 +0000581 // Reset errno to zero on entry to main.
582 errno = 0;
Eli Bendersky4c647582012-01-16 08:56:09 +0000583
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000584 int Result;
585
Andrew Kaylor58365b92012-11-27 19:49:00 +0000586 if (!RemoteMCJIT) {
Andrew Kaylor6587bcf2013-10-11 22:47:10 +0000587 // If the program doesn't explicitly call exit, we will need the Exit
588 // function later on to make an explicit call, so get the function now.
589 Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
590 Type::getInt32Ty(Context),
David Majnemer6539ed72015-02-26 01:10:49 +0000591 nullptr);
Andrew Kaylor6587bcf2013-10-11 22:47:10 +0000592
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000593 // Run static constructors.
Eric Christopher79cc1e32014-09-02 22:28:02 +0000594 if (!ForceInterpreter) {
Andrew Kaylorea395922013-10-01 01:47:35 +0000595 // Give MCJIT a chance to apply relocations and set page permissions.
596 EE->finalizeObject();
597 }
598 EE->runStaticConstructorsDestructors(false);
Evan Cheng0422bef2008-04-22 06:51:41 +0000599
NAKAMURA Takumi87e08802013-12-07 11:21:42 +0000600 // Trigger compilation separately so code regions that need to be
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000601 // invalidated will be known.
602 (void)EE->getPointerToFunction(EntryFn);
603 // Clear instruction cache before code will be executed.
604 if (RTDyldMM)
605 static_cast<SectionMemoryManager*>(RTDyldMM)->invalidateInstructionCache();
606
607 // Run main.
608 Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
609
610 // Run static destructors.
611 EE->runStaticConstructorsDestructors(true);
612
613 // If the program didn't call exit explicitly, we should call it now.
614 // This ensures that any atexit handlers get called correctly.
615 if (Function *ExitF = dyn_cast<Function>(Exit)) {
616 std::vector<GenericValue> Args;
617 GenericValue ResultGV;
618 ResultGV.IntVal = APInt(32, Result);
619 Args.push_back(ResultGV);
620 EE->runFunction(ExitF, Args);
621 errs() << "ERROR: exit(" << Result << ") returned!\n";
622 abort();
623 } else {
624 errs() << "ERROR: exit defined with wrong prototype!\n";
625 abort();
626 }
627 } else {
628 // else == "if (RemoteMCJIT)"
629
630 // Remote target MCJIT doesn't (yet) support static constructors. No reason
631 // it couldn't. This is a limitation of the LLI implemantation, not the
632 // MCJIT itself. FIXME.
633 //
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000634 RemoteMemoryManager *MM = static_cast<RemoteMemoryManager*>(RTDyldMM);
Jim Grosbach0f435d02012-09-05 16:50:34 +0000635 // Everything is prepared now, so lay out our program for the target
636 // address space, assign the section addresses to resolve any relocations,
637 // and send it to the target.
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000638
Ahmed Charles56440fd2014-03-06 05:51:42 +0000639 std::unique_ptr<RemoteTarget> Target;
Alp Tokera1186382014-01-22 21:52:35 +0000640 if (!ChildExecPath.empty()) { // Remote execution on a child process
Alp Tokerce4ab592014-01-23 19:57:16 +0000641#ifndef LLVM_ON_UNIX
642 // FIXME: Remove this pointless fallback mode which causes tests to "pass"
643 // on platforms where they should XFAIL.
644 errs() << "Warning: host does not support external remote targets.\n"
645 << " Defaulting to simulated remote execution\n";
646 Target.reset(new RemoteTarget);
647#else
648 if (!sys::fs::can_execute(ChildExecPath)) {
649 errs() << "Unable to find usable child executable: '" << ChildExecPath
650 << "'\n";
651 return -1;
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000652 }
Alp Tokerce4ab592014-01-23 19:57:16 +0000653 Target.reset(new RemoteTargetExternal(ChildExecPath));
654#endif
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000655 } else {
656 // No child process name provided, use simulated remote execution.
Alp Tokerce4ab592014-01-23 19:57:16 +0000657 Target.reset(new RemoteTarget);
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000658 }
659
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000660 // Give the memory manager a pointer to our remote target interface object.
661 MM->setRemoteTarget(Target.get());
662
663 // Create the remote target.
Renato Golin695895c2014-01-14 22:43:43 +0000664 if (!Target->create()) {
665 errs() << "ERROR: " << Target->getErrorMsg() << "\n";
666 return EXIT_FAILURE;
667 }
Jim Grosbach748b9472012-08-28 23:22:30 +0000668
Jim Grosbach0f435d02012-09-05 16:50:34 +0000669 // Since we're executing in a (at least simulated) remote address space,
670 // we can't use the ExecutionEngine::runFunctionAsMain(). We have to
671 // grab the function address directly here and tell the remote target
672 // to execute the function.
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000673 //
674 // Our memory manager will map generated code into the remote address
675 // space as it is loaded and copy the bits over during the finalizeMemory
676 // operation.
677 //
Jim Grosbach0f435d02012-09-05 16:50:34 +0000678 // FIXME: argv and envp handling.
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000679 uint64_t Entry = EE->getFunctionAddress(EntryFn->getName().str());
Jim Grosbach0f435d02012-09-05 16:50:34 +0000680
Tim Northover79ab7f72013-05-19 09:55:06 +0000681 DEBUG(dbgs() << "Executing '" << EntryFn->getName() << "' at 0x"
682 << format("%llx", Entry) << "\n");
Jim Grosbach0f435d02012-09-05 16:50:34 +0000683
Renato Golin695895c2014-01-14 22:43:43 +0000684 if (!Target->executeCode(Entry, Result))
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000685 errs() << "ERROR: " << Target->getErrorMsg() << "\n";
Jim Grosbach0f435d02012-09-05 16:50:34 +0000686
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000687 // Like static constructors, the remote target MCJIT support doesn't handle
688 // this yet. It could. FIXME.
689
690 // Stop the remote target
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000691 Target->stop();
Chris Lattner2785bdb2007-05-06 04:58:26 +0000692 }
Jim Grosbach0f435d02012-09-05 16:50:34 +0000693
Jim Grosbach0f435d02012-09-05 16:50:34 +0000694 return Result;
Chris Lattnerd7ff5782001-08-23 17:05:04 +0000695}