blob: 7bbc5dc97bfc4864f4e50ac3b98cb0f834cc5249 [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
Jim Grosbach0f435d02012-09-05 16:50:34 +000016#define DEBUG_TYPE "lli"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000017#include "llvm/IR/LLVMContext.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"
26#include "llvm/ExecutionEngine/JIT.h"
27#include "llvm/ExecutionEngine/JITEventListener.h"
Jim Grosbachbf570b92012-01-11 21:12:51 +000028#include "llvm/ExecutionEngine/JITMemoryManager.h"
Daniel Dunbar7e5d8a72010-11-17 16:06:43 +000029#include "llvm/ExecutionEngine/MCJIT.h"
Lang Hames173c69f2014-01-08 04:09:09 +000030#include "llvm/ExecutionEngine/ObjectCache.h"
Andrew Kaylor58365b92012-11-27 19:49:00 +000031#include "llvm/ExecutionEngine/SectionMemoryManager.h"
Andrew Kaylor1ca510e2013-10-29 01:29:56 +000032#include "llvm/IR/IRBuilder.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000033#include "llvm/IR/Module.h"
34#include "llvm/IR/Type.h"
Andrew Kaylor1ca510e2013-10-29 01:29:56 +000035#include "llvm/IR/TypeBuilder.h"
Chandler Carruthe60e57b2013-03-26 02:25:37 +000036#include "llvm/IRReader/IRReader.h"
Lang Hames173c69f2014-01-08 04:09:09 +000037#include "llvm/Object/Archive.h"
38#include "llvm/Object/ObjectFile.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000039#include "llvm/Support/CommandLine.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000040#include "llvm/Support/Debug.h"
41#include "llvm/Support/DynamicLibrary.h"
42#include "llvm/Support/Format.h"
Chris Lattner76d46322006-12-06 01:18:01 +000043#include "llvm/Support/ManagedStatic.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000044#include "llvm/Support/MathExtras.h"
45#include "llvm/Support/Memory.h"
Chris Lattner2785bdb2007-05-06 04:58:26 +000046#include "llvm/Support/MemoryBuffer.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
Chris Lattnera0d7b082002-12-23 23:59:41 +000067namespace {
68 cl::opt<std::string>
Gabor Greife16561c2007-07-05 17:07:56 +000069 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
Chris Lattnerf5cad152002-07-22 02:10:13 +000070
Chris Lattnera0d7b082002-12-23 23:59:41 +000071 cl::list<std::string>
72 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
Chris Lattnerf5cad152002-07-22 02:10:13 +000073
Chris Lattnera0d7b082002-12-23 23:59:41 +000074 cl::opt<bool> ForceInterpreter("force-interpreter",
Misha Brukmanc2186e32003-09-25 18:10:34 +000075 cl::desc("Force interpretation: disable JIT"),
76 cl::init(false));
Evan Cheng06d988e2008-08-08 08:12:06 +000077
Daniel Dunbar70ff8b02010-11-17 16:06:37 +000078 cl::opt<bool> UseMCJIT(
79 "use-mcjit", cl::desc("Enable use of the MC-based JIT (if available)"),
80 cl::init(false));
81
Daniel Maleaa960c542013-06-28 19:11:40 +000082 cl::opt<bool> DebugIR(
83 "debug-ir", cl::desc("Generate debug information to allow debugging IR."),
84 cl::init(false));
85
Jim Grosbach0f435d02012-09-05 16:50:34 +000086 // The MCJIT supports building for a target address space separate from
87 // the JIT compilation process. Use a forked process and a copying
88 // memory manager with IPC to execute using this functionality.
89 cl::opt<bool> RemoteMCJIT("remote-mcjit",
90 cl::desc("Execute MCJIT'ed code in a separate process."),
91 cl::init(false));
92
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +000093 // Manually specify the child process for remote execution. This overrides
94 // the simulated remote execution that allocates address space for child
Andrew Kaylor89352582013-10-29 01:33:14 +000095 // execution. The child process will be executed and will communicate with
96 // lli via stdin/stdout pipes.
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +000097 cl::opt<std::string>
Alp Tokera1186382014-01-22 21:52:35 +000098 ChildExecPath("mcjit-remote-process",
99 cl::desc("Specify the filename of the process to launch "
100 "for remote MCJIT execution. If none is specified,"
101 "\n\tremote execution will be simulated in-process."),
102 cl::value_desc("filename"), cl::init(""));
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000103
Evan Cheng09bd0b12009-05-04 23:05:19 +0000104 // Determine optimization level.
105 cl::opt<char>
106 OptLevel("O",
107 cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
108 "(default = '-O2')"),
109 cl::Prefix,
110 cl::ZeroOrMore,
111 cl::init(' '));
Evan Cheng06d988e2008-08-08 08:12:06 +0000112
Chris Lattner76766cb2005-12-16 05:00:21 +0000113 cl::opt<std::string>
Chris Lattner78e9e102005-12-16 05:19:18 +0000114 TargetTriple("mtriple", cl::desc("Override target triple for module"));
Evan Cheng61582542008-11-05 23:21:52 +0000115
116 cl::opt<std::string>
Jeffrey Yasskin31faeff2010-02-05 16:19:36 +0000117 MArch("march",
118 cl::desc("Architecture to generate assembly for (see --version)"));
119
120 cl::opt<std::string>
121 MCPU("mcpu",
122 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
123 cl::value_desc("cpu-name"),
124 cl::init(""));
125
126 cl::list<std::string>
127 MAttrs("mattr",
128 cl::CommaSeparated,
129 cl::desc("Target specific attributes (-mattr=help for details)"),
130 cl::value_desc("a1,+a2,-a3,..."));
131
132 cl::opt<std::string>
Evan Cheng61582542008-11-05 23:21:52 +0000133 EntryFunc("entry-function",
134 cl::desc("Specify the entry function (default = 'main') "
135 "of the executable"),
136 cl::value_desc("function"),
137 cl::init("main"));
Eli Bendersky4c647582012-01-16 08:56:09 +0000138
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000139 cl::list<std::string>
Andrew Kaylor4404eb42013-10-28 21:58:15 +0000140 ExtraModules("extra-module",
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000141 cl::desc("Extra modules to be loaded"),
Alp Toker0a09ebf2013-10-28 22:51:25 +0000142 cl::value_desc("input bitcode"));
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000143
Lang Hames173c69f2014-01-08 04:09:09 +0000144 cl::list<std::string>
145 ExtraObjects("extra-object",
146 cl::desc("Extra object files to be loaded"),
147 cl::value_desc("input object"));
148
149 cl::list<std::string>
150 ExtraArchives("extra-archive",
151 cl::desc("Extra archive files to be loaded"),
152 cl::value_desc("input archive"));
153
154 cl::opt<bool>
155 EnableCacheManager("enable-cache-manager",
Lang Hames1ddecc02014-01-09 05:24:05 +0000156 cl::desc("Use cache manager to save/load mdoules"),
Lang Hames173c69f2014-01-08 04:09:09 +0000157 cl::init(false));
158
Chris Lattner55644062003-10-28 22:51:44 +0000159 cl::opt<std::string>
Lang Hames1ddecc02014-01-09 05:24:05 +0000160 ObjectCacheDir("object-cache-dir",
161 cl::desc("Directory to store cached object files "
162 "(must be user writable)"),
163 cl::init(""));
164
165 cl::opt<std::string>
Chris Lattner55644062003-10-28 22:51:44 +0000166 FakeArgv0("fake-argv0",
167 cl::desc("Override the 'argv[0]' value passed into the executing"
168 " program"), cl::value_desc("executable"));
Eli Bendersky4c647582012-01-16 08:56:09 +0000169
Chris Lattner3f0ffd32006-09-14 06:17:09 +0000170 cl::opt<bool>
171 DisableCoreFiles("disable-core-files", cl::Hidden,
172 cl::desc("Disable emission of core files if possible"));
Evan Cheng0422bef2008-04-22 06:51:41 +0000173
174 cl::opt<bool>
Evan Cheng16f036c2008-05-21 18:20:21 +0000175 NoLazyCompilation("disable-lazy-compilation",
Evan Cheng0422bef2008-04-22 06:51:41 +0000176 cl::desc("Disable JIT lazy compilation"),
177 cl::init(false));
Evan Cheng2129f592011-07-19 06:37:02 +0000178
179 cl::opt<Reloc::Model>
180 RelocModel("relocation-model",
181 cl::desc("Choose relocation model"),
182 cl::init(Reloc::Default),
183 cl::values(
184 clEnumValN(Reloc::Default, "default",
185 "Target default relocation model"),
186 clEnumValN(Reloc::Static, "static",
187 "Non-relocatable code"),
188 clEnumValN(Reloc::PIC_, "pic",
189 "Fully relocatable, position independent code"),
190 clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic",
191 "Relocatable external references, non-relocatable code"),
192 clEnumValEnd));
Evan Chengefd9b422011-07-20 07:51:56 +0000193
194 cl::opt<llvm::CodeModel::Model>
195 CMModel("code-model",
196 cl::desc("Choose code model"),
197 cl::init(CodeModel::JITDefault),
198 cl::values(clEnumValN(CodeModel::JITDefault, "default",
199 "Target default JIT code model"),
200 clEnumValN(CodeModel::Small, "small",
201 "Small code model"),
202 clEnumValN(CodeModel::Kernel, "kernel",
203 "Kernel code model"),
204 clEnumValN(CodeModel::Medium, "medium",
205 "Medium code model"),
206 clEnumValN(CodeModel::Large, "large",
207 "Large code model"),
208 clEnumValEnd));
209
Nick Lewyckyb0e97892012-04-18 08:34:12 +0000210 cl::opt<bool>
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000211 GenerateSoftFloatCalls("soft-float",
212 cl::desc("Generate software floating point library calls"),
213 cl::init(false));
214
215 cl::opt<llvm::FloatABI::ABIType>
216 FloatABIForCalls("float-abi",
217 cl::desc("Choose float ABI type"),
218 cl::init(FloatABI::Default),
219 cl::values(
220 clEnumValN(FloatABI::Default, "default",
221 "Target default float ABI type"),
222 clEnumValN(FloatABI::Soft, "soft",
223 "Soft float ABI (implied by -soft-float)"),
224 clEnumValN(FloatABI::Hard, "hard",
225 "Hard float ABI (uses FP registers)"),
226 clEnumValEnd));
227 cl::opt<bool>
Nick Lewyckyb0e97892012-04-18 08:34:12 +0000228// In debug builds, make this default to true.
229#ifdef NDEBUG
230#define EMIT_DEBUG false
231#else
232#define EMIT_DEBUG true
233#endif
234 EmitJitDebugInfo("jit-emit-debug",
235 cl::desc("Emit debug information to debugger"),
236 cl::init(EMIT_DEBUG));
237#undef EMIT_DEBUG
238
239 static cl::opt<bool>
240 EmitJitDebugInfoToDisk("jit-emit-debug-to-disk",
241 cl::Hidden,
242 cl::desc("Emit debug info objfiles to disk"),
243 cl::init(false));
Chris Lattnera0d7b082002-12-23 23:59:41 +0000244}
Chris Lattner009f8102001-10-27 08:43:52 +0000245
Lang Hames173c69f2014-01-08 04:09:09 +0000246//===----------------------------------------------------------------------===//
247// Object cache
248//
Lang Hames1ddecc02014-01-09 05:24:05 +0000249// This object cache implementation writes cached objects to disk to the
250// directory specified by CacheDir, using a filename provided in the module
251// descriptor. The cache tries to load a saved object using that path if the
252// file exists. CacheDir defaults to "", in which case objects are cached
NAKAMURA Takumif462f9c2014-01-10 10:38:28 +0000253// alongside their originating bitcodes.
Lang Hames173c69f2014-01-08 04:09:09 +0000254//
255class LLIObjectCache : public ObjectCache {
256public:
Lang Hames1ddecc02014-01-09 05:24:05 +0000257 LLIObjectCache(const std::string& CacheDir) : CacheDir(CacheDir) {
258 // Add trailing '/' to cache dir if necessary.
Lang Hamesf9dd8fd2014-01-09 05:29:59 +0000259 if (!this->CacheDir.empty() &&
260 this->CacheDir[this->CacheDir.size() - 1] != '/')
NAKAMURA Takumif462f9c2014-01-10 10:38:28 +0000261 this->CacheDir += '/';
Lang Hames1ddecc02014-01-09 05:24:05 +0000262 }
Lang Hames173c69f2014-01-08 04:09:09 +0000263 virtual ~LLIObjectCache() {}
264
265 virtual void notifyObjectCompiled(const Module *M, const MemoryBuffer *Obj) {
266 const std::string ModuleID = M->getModuleIdentifier();
267 std::string CacheName;
268 if (!getCacheFilename(ModuleID, CacheName))
269 return;
Lang Hameseecd2dc2014-01-09 00:47:54 +0000270 std::string errStr;
NAKAMURA Takumi390e0602014-01-10 10:38:34 +0000271 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 }
Rafael Espindola90c7f1c2014-02-24 18:20:12 +0000276 raw_fd_ostream outfile(CacheName.c_str(), errStr, sys::fs::F_None);
Lang Hames173c69f2014-01-08 04:09:09 +0000277 outfile.write(Obj->getBufferStart(), Obj->getBufferSize());
278 outfile.close();
279 }
280
281 virtual MemoryBuffer* getObject(const Module* M) {
282 const std::string ModuleID = M->getModuleIdentifier();
283 std::string CacheName;
284 if (!getCacheFilename(ModuleID, CacheName))
285 return NULL;
286 // Load the object from the cache filename
287 OwningPtr<MemoryBuffer> IRObjectBuffer;
288 MemoryBuffer::getFile(CacheName.c_str(), IRObjectBuffer, -1, false);
289 // If the file isn't there, that's OK.
290 if (!IRObjectBuffer)
291 return NULL;
292 // MCJIT will want to write into this buffer, and we don't want that
293 // because the file has probably just been mmapped. Instead we make
294 // a copy. The filed-based buffer will be released when it goes
295 // out of scope.
296 return MemoryBuffer::getMemBufferCopy(IRObjectBuffer->getBuffer());
297 }
298
299private:
Lang Hames1ddecc02014-01-09 05:24:05 +0000300 std::string CacheDir;
301
Lang Hames173c69f2014-01-08 04:09:09 +0000302 bool getCacheFilename(const std::string &ModID, std::string &CacheName) {
303 std::string Prefix("file:");
304 size_t PrefixLength = Prefix.length();
305 if (ModID.substr(0, PrefixLength) != Prefix)
306 return false;
NAKAMURA Takumid7fd6d92014-01-10 10:38:40 +0000307 std::string CacheSubdir = ModID.substr(PrefixLength);
308#if defined(_WIN32)
309 // Transform "X:\foo" => "/X\foo" for convenience.
310 if (isalpha(CacheSubdir[0]) && CacheSubdir[1] == ':') {
311 CacheSubdir[1] = CacheSubdir[0];
312 CacheSubdir[0] = '/';
313 }
314#endif
315 CacheName = CacheDir + CacheSubdir;
Lang Hames173c69f2014-01-08 04:09:09 +0000316 size_t pos = CacheName.rfind('.');
317 CacheName.replace(pos, CacheName.length() - pos, ".o");
318 return true;
319 }
320};
321
Reid Spencere586f2e2007-03-03 18:21:44 +0000322static ExecutionEngine *EE = 0;
Lang Hames173c69f2014-01-08 04:09:09 +0000323static LLIObjectCache *CacheManager = 0;
Reid Spencere586f2e2007-03-03 18:21:44 +0000324
325static void do_shutdown() {
NAKAMURA Takumi15304872010-10-22 14:53:59 +0000326 // Cygwin-1.5 invokes DLL's dtors before atexit handler.
327#ifndef DO_NOTHING_ATEXIT
Reid Spencere586f2e2007-03-03 18:21:44 +0000328 delete EE;
Lang Hames173c69f2014-01-08 04:09:09 +0000329 if (CacheManager)
330 delete CacheManager;
Reid Spencere586f2e2007-03-03 18:21:44 +0000331 llvm_shutdown();
NAKAMURA Takumi15304872010-10-22 14:53:59 +0000332#endif
Reid Spencere586f2e2007-03-03 18:21:44 +0000333}
334
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000335// On Mingw and Cygwin, an external symbol named '__main' is called from the
336// generated 'main' function to allow static intialization. To avoid linking
337// problems with remote targets (because lli's remote target support does not
338// currently handle external linking) we add a secondary module which defines
339// an empty '__main' function.
340static void addCygMingExtraModule(ExecutionEngine *EE,
341 LLVMContext &Context,
342 StringRef TargetTripleStr) {
343 IRBuilder<> Builder(Context);
344 Triple TargetTriple(TargetTripleStr);
345
346 // Create a new module.
347 Module *M = new Module("CygMingHelper", Context);
348 M->setTargetTriple(TargetTripleStr);
349
350 // Create an empty function named "__main".
351 Function *Result;
352 if (TargetTriple.isArch64Bit()) {
353 Result = Function::Create(
354 TypeBuilder<int64_t(void), false>::get(Context),
355 GlobalValue::ExternalLinkage, "__main", M);
356 } else {
357 Result = Function::Create(
358 TypeBuilder<int32_t(void), false>::get(Context),
359 GlobalValue::ExternalLinkage, "__main", M);
360 }
361 BasicBlock *BB = BasicBlock::Create(Context, "__main", Result);
362 Builder.SetInsertPoint(BB);
363 Value *ReturnVal;
364 if (TargetTriple.isArch64Bit())
365 ReturnVal = ConstantInt::get(Context, APInt(64, 0));
366 else
367 ReturnVal = ConstantInt::get(Context, APInt(32, 0));
368 Builder.CreateRet(ReturnVal);
369
370 // Add this new module to the ExecutionEngine.
371 EE->addModule(M);
372}
373
374
Chris Lattnerd7ff5782001-08-23 17:05:04 +0000375//===----------------------------------------------------------------------===//
Chris Lattnerd7ff5782001-08-23 17:05:04 +0000376// main Driver function
377//
Misha Brukman5b255e52003-10-14 21:39:53 +0000378int main(int argc, char **argv, char * const *envp) {
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000379 sys::PrintStackTraceOnErrorSignal();
380 PrettyStackTraceProgram X(argc, argv);
Eli Bendersky4c647582012-01-16 08:56:09 +0000381
Owen Anderson19251ec2009-07-15 22:16:10 +0000382 LLVMContext &Context = getGlobalContext();
Reid Spencere586f2e2007-03-03 18:21:44 +0000383 atexit(do_shutdown); // Call llvm_shutdown() on exit.
Daniel Dunbar3d92d932009-07-16 02:04:54 +0000384
385 // If we have a native target, initialize it to ensure it is linked in and
386 // usable by the JIT.
387 InitializeNativeTarget();
Jim Grosbach7b162492011-03-18 22:48:41 +0000388 InitializeNativeTargetAsmPrinter();
Jim Grosbach2cce3f92012-11-05 19:06:05 +0000389 InitializeNativeTargetAsmParser();
Daniel Dunbar3d92d932009-07-16 02:04:54 +0000390
Chris Lattner2785bdb2007-05-06 04:58:26 +0000391 cl::ParseCommandLineOptions(argc, argv,
Dan Gohman2c6a8212007-10-08 15:45:12 +0000392 "llvm interpreter & dynamic compiler\n");
Reid Spencer996ec722004-12-30 05:36:08 +0000393
Chris Lattner2785bdb2007-05-06 04:58:26 +0000394 // If the user doesn't want core files, disable them.
395 if (DisableCoreFiles)
396 sys::Process::PreventCoreFiles();
Eli Bendersky4c647582012-01-16 08:56:09 +0000397
Gabor Greife16561c2007-07-05 17:07:56 +0000398 // Load the bitcode...
Daniel Dunbar9589bf82010-11-13 00:28:01 +0000399 SMDiagnostic Err;
400 Module *Mod = ParseIRFile(InputFile, Err, Context);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000401 if (!Mod) {
Chris Lattnera3a06812011-10-16 04:47:35 +0000402 Err.print(argv[0], errs());
Daniel Dunbar9589bf82010-11-13 00:28:01 +0000403 return 1;
Chris Lattner2785bdb2007-05-06 04:58:26 +0000404 }
405
Lang Hames173c69f2014-01-08 04:09:09 +0000406 if (EnableCacheManager) {
407 if (UseMCJIT) {
408 std::string CacheName("file:");
409 CacheName.append(InputFile);
410 Mod->setModuleIdentifier(CacheName);
411 } else
412 errs() << "warning: -enable-cache-manager can only be used with MCJIT.";
413 }
414
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000415 // If not jitting lazily, load the whole bitcode file eagerly too.
416 if (NoLazyCompilation) {
Rafael Espindolae9fab9b2014-01-14 23:51:27 +0000417 if (error_code EC = Mod->materializeAllPermanently()) {
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000418 errs() << argv[0] << ": bitcode didn't read correctly.\n";
Rafael Espindolae9fab9b2014-01-14 23:51:27 +0000419 errs() << "Reason: " << EC.message() << "\n";
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000420 exit(1);
421 }
Evan Cheng0422bef2008-04-22 06:51:41 +0000422 }
Chris Lattner2785bdb2007-05-06 04:58:26 +0000423
Daniel Maleaa960c542013-06-28 19:11:40 +0000424 if (DebugIR) {
425 if (!UseMCJIT) {
426 errs() << "warning: -debug-ir used without -use-mcjit. Only partial debug"
427 << " information will be emitted by the non-MC JIT engine. To see full"
428 << " source debug information, enable the flag '-use-mcjit'.\n";
429
430 }
431 ModulePass *DebugIRPass = createDebugIRPass();
432 DebugIRPass->runOnModule(*Mod);
433 }
434
Rafael Espindolae9fab9b2014-01-14 23:51:27 +0000435 std::string ErrorMsg;
Jeffrey Yasskin091217b2010-01-27 20:34:15 +0000436 EngineBuilder builder(Mod);
Jeffrey Yasskin31faeff2010-02-05 16:19:36 +0000437 builder.setMArch(MArch);
438 builder.setMCPU(MCPU);
439 builder.setMAttrs(MAttrs);
Evan Cheng2129f592011-07-19 06:37:02 +0000440 builder.setRelocationModel(RelocModel);
Evan Chengefd9b422011-07-20 07:51:56 +0000441 builder.setCodeModel(CMModel);
Daniel Dunbara78d8092009-07-18 08:07:13 +0000442 builder.setErrorStr(&ErrorMsg);
443 builder.setEngineKind(ForceInterpreter
Reid Klecknerfc8a2d52009-07-18 00:42:18 +0000444 ? EngineKind::Interpreter
445 : EngineKind::JIT);
446
Chris Lattner2785bdb2007-05-06 04:58:26 +0000447 // If we are supposed to override the target triple, do so now.
448 if (!TargetTriple.empty())
Duncan Sands3bd97fe2010-08-28 01:30:02 +0000449 Mod->setTargetTriple(Triple::normalize(TargetTriple));
Evan Cheng0422bef2008-04-22 06:51:41 +0000450
Eli Bendersky4c647582012-01-16 08:56:09 +0000451 // Enable MCJIT if desired.
Filip Pizlo9bc53e82013-05-14 19:29:00 +0000452 RTDyldMemoryManager *RTDyldMM = 0;
Eli Bendersky4c647582012-01-16 08:56:09 +0000453 if (UseMCJIT && !ForceInterpreter) {
Daniel Dunbar70ff8b02010-11-17 16:06:37 +0000454 builder.setUseMCJIT(true);
Jim Grosbach0f435d02012-09-05 16:50:34 +0000455 if (RemoteMCJIT)
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000456 RTDyldMM = new RemoteMemoryManager();
Jim Grosbach0f435d02012-09-05 16:50:34 +0000457 else
Filip Pizlo9bc53e82013-05-14 19:29:00 +0000458 RTDyldMM = new SectionMemoryManager();
459 builder.setMCJITMemoryManager(RTDyldMM);
Benjamin Kramer76004e62012-05-20 17:24:08 +0000460 } else {
Jim Grosbach0f435d02012-09-05 16:50:34 +0000461 if (RemoteMCJIT) {
462 errs() << "error: Remote process execution requires -use-mcjit\n";
463 exit(1);
464 }
Benjamin Kramer76004e62012-05-20 17:24:08 +0000465 builder.setJITMemoryManager(ForceInterpreter ? 0 :
466 JITMemoryManager::CreateDefaultMemManager());
Eli Bendersky4c647582012-01-16 08:56:09 +0000467 }
Daniel Dunbar70ff8b02010-11-17 16:06:37 +0000468
Evan Cheng09bd0b12009-05-04 23:05:19 +0000469 CodeGenOpt::Level OLvl = CodeGenOpt::Default;
470 switch (OptLevel) {
471 default:
Dan Gohmand8db3762009-07-15 16:35:29 +0000472 errs() << argv[0] << ": invalid optimization level.\n";
Evan Cheng09bd0b12009-05-04 23:05:19 +0000473 return 1;
474 case ' ': break;
475 case '0': OLvl = CodeGenOpt::None; break;
Evan Cheng5a286382009-10-16 21:02:20 +0000476 case '1': OLvl = CodeGenOpt::Less; break;
Evan Cheng09bd0b12009-05-04 23:05:19 +0000477 case '2': OLvl = CodeGenOpt::Default; break;
478 case '3': OLvl = CodeGenOpt::Aggressive; break;
479 }
Reid Klecknerfc8a2d52009-07-18 00:42:18 +0000480 builder.setOptLevel(OLvl);
481
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000482 TargetOptions Options;
483 Options.UseSoftFloat = GenerateSoftFloatCalls;
484 if (FloatABIForCalls != FloatABI::Default)
485 Options.FloatABIType = FloatABIForCalls;
486 if (GenerateSoftFloatCalls)
487 FloatABIForCalls = FloatABI::Soft;
488
Jim Grosbach0f435d02012-09-05 16:50:34 +0000489 // Remote target execution doesn't handle EH or debug registration.
490 if (!RemoteMCJIT) {
Jim Grosbach0f435d02012-09-05 16:50:34 +0000491 Options.JITEmitDebugInfo = EmitJitDebugInfo;
492 Options.JITEmitDebugInfoToDisk = EmitJitDebugInfoToDisk;
Jim Grosbach0f435d02012-09-05 16:50:34 +0000493 }
Nick Lewyckyb0e97892012-04-18 08:34:12 +0000494
Tim Northoverd4a2f5b2012-10-12 09:55:13 +0000495 builder.setTargetOptions(Options);
496
Reid Klecknerfc8a2d52009-07-18 00:42:18 +0000497 EE = builder.create();
Chris Lattnerf840ed72009-07-07 18:31:09 +0000498 if (!EE) {
499 if (!ErrorMsg.empty())
Dan Gohmand8db3762009-07-15 16:35:29 +0000500 errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
Chris Lattnerf840ed72009-07-07 18:31:09 +0000501 else
Dan Gohmand8db3762009-07-15 16:35:29 +0000502 errs() << argv[0] << ": unknown error creating EE!\n";
Chris Lattner2785bdb2007-05-06 04:58:26 +0000503 exit(1);
504 }
505
Lang Hames173c69f2014-01-08 04:09:09 +0000506 if (EnableCacheManager) {
Lang Hames1ddecc02014-01-09 05:24:05 +0000507 CacheManager = new LLIObjectCache(ObjectCacheDir);
Lang Hames173c69f2014-01-08 04:09:09 +0000508 EE->setObjectCache(CacheManager);
509 }
510
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000511 // Load any additional modules specified on the command line.
512 for (unsigned i = 0, e = ExtraModules.size(); i != e; ++i) {
513 Module *XMod = ParseIRFile(ExtraModules[i], Err, Context);
514 if (!XMod) {
515 Err.print(argv[0], errs());
516 return 1;
517 }
Lang Hames173c69f2014-01-08 04:09:09 +0000518 if (EnableCacheManager) {
519 if (UseMCJIT) {
520 std::string CacheName("file:");
521 CacheName.append(ExtraModules[i]);
522 XMod->setModuleIdentifier(CacheName);
523 }
524 // else, we already printed a warning above.
525 }
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000526 EE->addModule(XMod);
527 }
528
Lang Hames173c69f2014-01-08 04:09:09 +0000529 for (unsigned i = 0, e = ExtraObjects.size(); i != e; ++i) {
Rafael Espindola51cc3602014-01-22 00:14:49 +0000530 ErrorOr<object::ObjectFile *> Obj =
531 object::ObjectFile::createObjectFile(ExtraObjects[i]);
Lang Hames173c69f2014-01-08 04:09:09 +0000532 if (!Obj) {
533 Err.print(argv[0], errs());
534 return 1;
535 }
Rafael Espindola51cc3602014-01-22 00:14:49 +0000536 EE->addObjectFile(Obj.get());
Lang Hames173c69f2014-01-08 04:09:09 +0000537 }
538
539 for (unsigned i = 0, e = ExtraArchives.size(); i != e; ++i) {
540 OwningPtr<MemoryBuffer> ArBuf;
541 error_code ec;
542 ec = MemoryBuffer::getFileOrSTDIN(ExtraArchives[i], ArBuf);
543 if (ec) {
544 Err.print(argv[0], errs());
545 return 1;
546 }
Ahmed Charles96c9d952014-03-05 10:19:29 +0000547 object::Archive *Ar = new object::Archive(ArBuf.release(), ec);
Lang Hames173c69f2014-01-08 04:09:09 +0000548 if (ec || !Ar) {
549 Err.print(argv[0], errs());
550 return 1;
551 }
552 EE->addArchive(Ar);
553 }
554
Andrew Kaylor1ca510e2013-10-29 01:29:56 +0000555 // If the target is Cygwin/MingW and we are generating remote code, we
556 // need an extra module to help out with linking.
557 if (RemoteMCJIT && Triple(Mod->getTargetTriple()).isOSCygMing()) {
558 addCygMingExtraModule(EE, Context, Mod->getTargetTriple());
559 }
560
Eli Bendersky5262ad22012-03-13 08:33:15 +0000561 // The following functions have no effect if their respective profiling
562 // support wasn't enabled in the build configuration.
563 EE->RegisterJITEventListener(
564 JITEventListener::createOProfileJITEventListener());
565 EE->RegisterJITEventListener(
566 JITEventListener::createIntelJITEventListener());
Jeffrey Yasskin0b08f3d2009-06-25 02:04:04 +0000567
Jim Grosbach0f435d02012-09-05 16:50:34 +0000568 if (!NoLazyCompilation && RemoteMCJIT) {
569 errs() << "warning: remote mcjit does not support lazy compilation\n";
570 NoLazyCompilation = true;
571 }
Jeffrey Yasskinaa8814a2009-10-27 22:39:42 +0000572 EE->DisableLazyCompilation(NoLazyCompilation);
Evan Cheng0422bef2008-04-22 06:51:41 +0000573
Chris Lattner2785bdb2007-05-06 04:58:26 +0000574 // If the user specifically requested an argv[0] to pass into the program,
575 // do it now.
576 if (!FakeArgv0.empty()) {
577 InputFile = FakeArgv0;
578 } else {
579 // Otherwise, if there is a .bc suffix on the executable strip it off, it
580 // might confuse the program.
Benjamin Kramera944a9a2010-04-15 11:33:14 +0000581 if (StringRef(InputFile).endswith(".bc"))
Chris Lattner2785bdb2007-05-06 04:58:26 +0000582 InputFile.erase(InputFile.length() - 3);
583 }
584
585 // Add the module's name to the start of the vector of arguments to main().
586 InputArgv.insert(InputArgv.begin(), InputFile);
587
588 // Call the main function from M as if its signature were:
589 // int main (int argc, char **argv, const char **envp)
590 // using the contents of Args to determine argc & argv, and the contents of
591 // EnvVars to determine envp.
592 //
Evan Cheng61582542008-11-05 23:21:52 +0000593 Function *EntryFn = Mod->getFunction(EntryFunc);
594 if (!EntryFn) {
Dan Gohmand8db3762009-07-15 16:35:29 +0000595 errs() << '\'' << EntryFunc << "\' function not found in module.\n";
Chris Lattner2785bdb2007-05-06 04:58:26 +0000596 return -1;
597 }
598
Chris Lattner2785bdb2007-05-06 04:58:26 +0000599 // Reset errno to zero on entry to main.
600 errno = 0;
Eli Bendersky4c647582012-01-16 08:56:09 +0000601
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000602 int Result;
603
Andrew Kaylor58365b92012-11-27 19:49:00 +0000604 if (!RemoteMCJIT) {
Andrew Kaylor6587bcf2013-10-11 22:47:10 +0000605 // If the program doesn't explicitly call exit, we will need the Exit
606 // function later on to make an explicit call, so get the function now.
607 Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
608 Type::getInt32Ty(Context),
609 NULL);
610
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000611 // Run static constructors.
Andrew Kaylorea395922013-10-01 01:47:35 +0000612 if (UseMCJIT && !ForceInterpreter) {
613 // Give MCJIT a chance to apply relocations and set page permissions.
614 EE->finalizeObject();
615 }
616 EE->runStaticConstructorsDestructors(false);
Evan Cheng0422bef2008-04-22 06:51:41 +0000617
Andrew Kaylorea395922013-10-01 01:47:35 +0000618 if (!UseMCJIT && NoLazyCompilation) {
619 for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
620 Function *Fn = &*I;
621 if (Fn != EntryFn && !Fn->isDeclaration())
622 EE->getPointerToFunction(Fn);
623 }
Evan Cheng0422bef2008-04-22 06:51:41 +0000624 }
Evan Cheng0422bef2008-04-22 06:51:41 +0000625
NAKAMURA Takumi87e08802013-12-07 11:21:42 +0000626 // Trigger compilation separately so code regions that need to be
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000627 // invalidated will be known.
628 (void)EE->getPointerToFunction(EntryFn);
629 // Clear instruction cache before code will be executed.
630 if (RTDyldMM)
631 static_cast<SectionMemoryManager*>(RTDyldMM)->invalidateInstructionCache();
632
633 // Run main.
634 Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
635
636 // Run static destructors.
637 EE->runStaticConstructorsDestructors(true);
638
639 // If the program didn't call exit explicitly, we should call it now.
640 // This ensures that any atexit handlers get called correctly.
641 if (Function *ExitF = dyn_cast<Function>(Exit)) {
642 std::vector<GenericValue> Args;
643 GenericValue ResultGV;
644 ResultGV.IntVal = APInt(32, Result);
645 Args.push_back(ResultGV);
646 EE->runFunction(ExitF, Args);
647 errs() << "ERROR: exit(" << Result << ") returned!\n";
648 abort();
649 } else {
650 errs() << "ERROR: exit defined with wrong prototype!\n";
651 abort();
652 }
653 } else {
654 // else == "if (RemoteMCJIT)"
655
656 // Remote target MCJIT doesn't (yet) support static constructors. No reason
657 // it couldn't. This is a limitation of the LLI implemantation, not the
658 // MCJIT itself. FIXME.
659 //
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000660 RemoteMemoryManager *MM = static_cast<RemoteMemoryManager*>(RTDyldMM);
Jim Grosbach0f435d02012-09-05 16:50:34 +0000661 // Everything is prepared now, so lay out our program for the target
662 // address space, assign the section addresses to resolve any relocations,
663 // and send it to the target.
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000664
665 OwningPtr<RemoteTarget> Target;
Alp Tokera1186382014-01-22 21:52:35 +0000666 if (!ChildExecPath.empty()) { // Remote execution on a child process
Alp Tokerce4ab592014-01-23 19:57:16 +0000667#ifndef LLVM_ON_UNIX
668 // FIXME: Remove this pointless fallback mode which causes tests to "pass"
669 // on platforms where they should XFAIL.
670 errs() << "Warning: host does not support external remote targets.\n"
671 << " Defaulting to simulated remote execution\n";
672 Target.reset(new RemoteTarget);
673#else
674 if (!sys::fs::can_execute(ChildExecPath)) {
675 errs() << "Unable to find usable child executable: '" << ChildExecPath
676 << "'\n";
677 return -1;
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000678 }
Alp Tokerce4ab592014-01-23 19:57:16 +0000679 Target.reset(new RemoteTargetExternal(ChildExecPath));
680#endif
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000681 } else {
682 // No child process name provided, use simulated remote execution.
Alp Tokerce4ab592014-01-23 19:57:16 +0000683 Target.reset(new RemoteTarget);
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000684 }
685
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000686 // Give the memory manager a pointer to our remote target interface object.
687 MM->setRemoteTarget(Target.get());
688
689 // Create the remote target.
Renato Golin695895c2014-01-14 22:43:43 +0000690 if (!Target->create()) {
691 errs() << "ERROR: " << Target->getErrorMsg() << "\n";
692 return EXIT_FAILURE;
693 }
Jim Grosbach748b9472012-08-28 23:22:30 +0000694
Jim Grosbach0f435d02012-09-05 16:50:34 +0000695 // Since we're executing in a (at least simulated) remote address space,
696 // we can't use the ExecutionEngine::runFunctionAsMain(). We have to
697 // grab the function address directly here and tell the remote target
698 // to execute the function.
Andrew Kaylor1b2cfb62013-10-04 00:49:38 +0000699 //
700 // Our memory manager will map generated code into the remote address
701 // space as it is loaded and copy the bits over during the finalizeMemory
702 // operation.
703 //
Jim Grosbach0f435d02012-09-05 16:50:34 +0000704 // FIXME: argv and envp handling.
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000705 uint64_t Entry = EE->getFunctionAddress(EntryFn->getName().str());
Jim Grosbach0f435d02012-09-05 16:50:34 +0000706
Tim Northover79ab7f72013-05-19 09:55:06 +0000707 DEBUG(dbgs() << "Executing '" << EntryFn->getName() << "' at 0x"
708 << format("%llx", Entry) << "\n");
Jim Grosbach0f435d02012-09-05 16:50:34 +0000709
Renato Golin695895c2014-01-14 22:43:43 +0000710 if (!Target->executeCode(Entry, Result))
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000711 errs() << "ERROR: " << Target->getErrorMsg() << "\n";
Jim Grosbach0f435d02012-09-05 16:50:34 +0000712
Andrew Kaylorc87c3472013-10-02 18:04:40 +0000713 // Like static constructors, the remote target MCJIT support doesn't handle
714 // this yet. It could. FIXME.
715
716 // Stop the remote target
Andrew Kaylorc2ebf3f2013-10-02 17:12:36 +0000717 Target->stop();
Chris Lattner2785bdb2007-05-06 04:58:26 +0000718 }
Jim Grosbach0f435d02012-09-05 16:50:34 +0000719
Jim Grosbach0f435d02012-09-05 16:50:34 +0000720 return Result;
Chris Lattnerd7ff5782001-08-23 17:05:04 +0000721}